Use realistic webapp API responses in Django integration tests.

Author: filiplajszczak

tests/conftest.py

@@ -87,6 +87,25 @@ def api_responses(monkeypatch):
         yield r
 
 
+@pytest.fixture
+def webapp_api(api_responses):
+    """HTTP contract for the webapp used by Django setup integration tests."""
+    from pythonanywhere_core.webapp import Webapp
+
+    webapp = Webapp("mydomain.com")
+    api_responses.add(responses.GET, webapp.domain_url, status=404)
+    api_responses.add(responses.POST, webapp.webapps_url, status=201, json={"status": "OK"})
+    api_responses.add(responses.PATCH, webapp.domain_url, status=200, json={})
+    api_responses.add(responses.DELETE, webapp.domain_url, status=204)
+    api_responses.add(responses.POST, f"{webapp.domain_url}static_files/", status=201, json={})
+    api_responses.add(responses.POST, f"{webapp.domain_url}reload/", status=200, json={"status": "OK"})
+    # DELETE is only used by the replacement test; the other routes may repeat.
+    api_responses.assert_all_requests_are_fired = False
+    # These tests also GET the local Django development server.
+    api_responses.add_passthru("http://localhost:8000/")
+    return api_responses
+
+
 @pytest.fixture(scope="function")
 def api_token():
     old_token = os.environ.get("API_TOKEN")

tests/test_cli_django.py

@@ -23,11 +23,6 @@ def mock_update_wsgi_file(mocker):
     return mocker.patch("cli.django.DjangoProject.update_wsgi_file")
 
 
-@pytest.fixture
-def mock_call_api(mocker):
-    return mocker.patch("pythonanywhere_core.webapp.call_api")
-
-
 @pytest.fixture
 def running_python_version():
     return ".".join(python_version().split(".")[:2])
@@ -80,7 +75,7 @@ def test_autoconfigure_calls_all_stuff_in_right_order(mock_django_project):
 @pytest.mark.slowtest
 def test_autoconfigure_actually_works_against_example_repo(
     mocker,
-    mock_call_api,
+    webapp_api,
     mock_update_wsgi_file,
     fake_home,
     virtualenvs_folder,
@@ -94,7 +89,7 @@ def test_autoconfigure_actually_works_against_example_repo(
     repo = "https://github.com/pythonanywhere/example-django-project.git"
     domain = "mydomain.com"
 
-    runner.invoke(
+    result = runner.invoke(
         app,
         [
             "autoconfigure",
@@ -108,6 +103,8 @@ def test_autoconfigure_actually_works_against_example_repo(
         ],
     )
 
+    assert result.exit_code == 0, result.exception
+
     expected_virtualenv = virtualenvs_folder / domain
     expected_project_path = fake_home / domain
     django_project_name = "myproject"
@@ -180,15 +177,15 @@ def test_start_calls_all_stuff_in_right_order(mock_django_project):
 
 @pytest.mark.slowtest
 def test_start_actually_creates_django_project_in_virtualenv_with_hacked_settings_and_static_files(
-    mock_call_api,
+    webapp_api,
     mock_update_wsgi_file,
     fake_home,
     virtualenvs_folder,
     api_token,
     running_python_version,
     new_django_version,
 ):
-    runner.invoke(
+    result = runner.invoke(
         app,
         [
             "start",
@@ -200,6 +197,7 @@ def test_start_actually_creates_django_project_in_virtualenv_with_hacked_setting
             running_python_version,
         ],
     )
+    assert result.exit_code == 0, result.exception
 
     django_version = (
         subprocess.check_output(
@@ -223,7 +221,7 @@ def test_start_actually_creates_django_project_in_virtualenv_with_hacked_setting
 
 @pytest.mark.slowtest
 def test_nuke_option_lets_you_run_twice(
-    mock_call_api,
+    webapp_api,
     mock_update_wsgi_file,
     fake_home,
     virtualenvs_folder,
@@ -232,7 +230,7 @@ def test_nuke_option_lets_you_run_twice(
     old_django_version,
     new_django_version,
 ):
-    runner.invoke(
+    result = runner.invoke(
         app,
         [
             "start",
@@ -244,7 +242,8 @@ def test_nuke_option_lets_you_run_twice(
             running_python_version,
         ],
     )
-    runner.invoke(
+    assert result.exit_code == 0, result.exception
+    result = runner.invoke(
         app,
         [
             "start",
@@ -257,6 +256,7 @@ def test_nuke_option_lets_you_run_twice(
             "--nuke",
         ],
     )
+    assert result.exit_code == 0, result.exception
 
     django_version = (
         subprocess.check_output(

tests/test_pa_autoconfigure_django.py

@@ -33,21 +33,20 @@ def test_calls_all_stuff_in_right_order(self):
 
     @pytest.mark.slowtest
     def test_actually_works_against_example_repo(
-        self, fake_home, virtualenvs_folder, api_token, process_killer, running_python_version, new_django_version
+        self, fake_home, virtualenvs_folder, api_token, process_killer, running_python_version, new_django_version, webapp_api
     ):
         git_ref = "non-nested-old" if running_python_version in ["3.8", "3.9"] else "master"
         repo = 'https://github.com/pythonanywhere/example-django-project.git'
         domain = 'mydomain.com'
         with patch('scripts.pa_autoconfigure_django.DjangoProject.update_wsgi_file'):
             with patch('scripts.pa_autoconfigure_django.DjangoProject.start_bash'):
-                with patch('pythonanywhere_core.webapp.call_api'):
-                    main(
-                        repo_url=repo,
-                        branch=git_ref,
-                        domain=domain,
-                        python_version=running_python_version,
-                        nuke=False
-                    )
+                main(
+                    repo_url=repo,
+                    branch=git_ref,
+                    domain=domain,
+                    python_version=running_python_version,
+                    nuke=False
+                )
 
         expected_virtualenv = virtualenvs_folder / domain
         expected_project_path = fake_home / domain

tests/test_pa_start_django_webapp_with_virtualenv.py

@@ -30,11 +30,10 @@ def test_calls_all_stuff_in_right_order(mocker):
 
 @pytest.mark.slowtest
 def test_actually_creates_django_project_in_virtualenv_with_hacked_settings_and_static_files(
-    fake_home, virtualenvs_folder, api_token, running_python_version, new_django_version
+    fake_home, virtualenvs_folder, api_token, running_python_version, new_django_version, webapp_api
 ):
     with patch("scripts.pa_start_django_webapp_with_virtualenv.DjangoProject.update_wsgi_file"):
-        with patch("pythonanywhere_core.webapp.call_api"):
-            main("mydomain.com", new_django_version, running_python_version, nuke=False)
+        main("mydomain.com", new_django_version, running_python_version, nuke=False)
 
     output_django_version = (
         subprocess.check_output(
@@ -57,13 +56,12 @@ def test_actually_creates_django_project_in_virtualenv_with_hacked_settings_and_
 
 @pytest.mark.slowtest
 def test_nuke_option_lets_you_run_twice(
-        fake_home, virtualenvs_folder, api_token, running_python_version, new_django_version, old_django_version
+        fake_home, virtualenvs_folder, api_token, running_python_version, new_django_version, old_django_version, webapp_api
 ):
 
     with patch("scripts.pa_start_django_webapp_with_virtualenv.DjangoProject.update_wsgi_file"):
-        with patch("pythonanywhere_core.webapp.call_api"):
-            main("mydomain.com", old_django_version, running_python_version, nuke=False)
-            main("mydomain.com", new_django_version, running_python_version, nuke=True)
+        main("mydomain.com", old_django_version, running_python_version, nuke=False)
+        main("mydomain.com", new_django_version, running_python_version, nuke=True)
 
     django_version = (
         subprocess.check_output(