PA-752: Handle errors during website creation. by Filip, Nina

Author: Nina Kahr

pythonanywhere_core/exceptions.py

@@ -12,3 +12,7 @@ class PythonAnywhereApiException(Exception):
 
 class NoTokenError(PythonAnywhereApiException):
     pass
+
+
+class DomainAlreadyExistsException(PythonAnywhereApiException):
+    pass

pythonanywhere_core/website.py

@@ -4,7 +4,7 @@
 from textwrap import dedent
 
 from pythonanywhere_core.base import call_api, get_api_endpoint
-from pythonanywhere_core.exceptions import SanityException, PythonAnywhereApiException
+from pythonanywhere_core.exceptions import DomainAlreadyExistsException, PythonAnywhereApiException
 
 
 class Website:
@@ -29,44 +29,14 @@ def __init__(self) -> None:
         self.websites_base_url = get_api_endpoint(username=getpass.getuser(), flavor="websites")
         self.domains_base_url = get_api_endpoint(username=getpass.getuser(), flavor="domains")
 
-    def sanity_check(self, domain_name: str, nuke: bool = False) -> None:
-        """Check that we have a token, and that we don't already have a webapp for this domain"""
-        print(snakesay("Running API sanity checks"))
-        token = os.environ.get("API_TOKEN")
-        if not token:
-            raise SanityException(
-                dedent(
-                    """
-                Could not find your API token.
-                You may need to create it on the Accounts page?
-                You will also need to close this console and open a new one once you've done that.
-                """
-                )
-            )
-
-        if nuke:
-            return
 
-        response = call_api(
-            f"{self.websites_base_url}{domain_name}/",
-             "get"
-        )
-
-        if response.status_code == 200:
-            raise SanityException(
-                f"You already have a webapp for {domain_name}.\n\nUse the --nuke option if you want to replace it."
-            )
-
-
-    def create(self, domain_name: str, command: str, nuke: bool = False) -> dict:
+    def create(self, domain_name: str, command: str) -> dict:
         """Creates new website with ``domain_name`` and ``command``.
 
         :param domain_name: domain name for new website
         :param command: command for new website
         :returns: dictionary with created website info"""
 
-        self.sanity_check(domain_name, nuke)
-
         response = call_api(
             self.websites_base_url,
             "post",
@@ -76,6 +46,12 @@ def create(self, domain_name: str, command: str, nuke: bool = False) -> dict:
                 "webapp": {"command": command}
             }
         )
+        if response.status_code == 400 and "domain with this domain name already exists" in response.text:
+            raise DomainAlreadyExistsException
+
+        if not response.ok:
+            raise PythonAnywhereApiException(f"POST to create website failed with status code {response.status_code} and error message: {response.text}")
+
         return response.json()
 
     def get(self, domain_name: str) -> dict:

tests/test_website.py

@@ -6,9 +6,8 @@
 from unittest.mock import patch
 
 from pythonanywhere_core.base import get_api_endpoint
-from pythonanywhere_core.exceptions import PythonAnywhereApiException
+from pythonanywhere_core.exceptions import PythonAnywhereApiException, DomainAlreadyExistsException
 from pythonanywhere_core.website import Website
-from pythonanywhere_core.exceptions import SanityException, PythonAnywhereApiException
 
 
 pytestmark = pytest.mark.usefixtures("api_token")
@@ -77,6 +76,39 @@ def test_create_returns_json_with_created_website_info(
     )
 
 
+def test_create_raises_when_domain_name_already_exists(
+    api_responses,
+    websites_base_url,
+    domain_name,
+    command
+):
+    with pytest.raises(DomainAlreadyExistsException):
+        api_responses.add(
+            responses.POST,
+            url=websites_base_url,
+            status=400,
+            body=json.dumps({"domain_name":["domain with this domain name already exists."]})
+        )
+        Website().create(domain_name=domain_name, command=command)
+
+def test_raises_with_api_error_message_for_any_other_error(
+    api_responses,
+    websites_base_url,
+    domain_name,
+    command
+):
+    with pytest.raises(PythonAnywhereApiException) as e:
+        api_responses.add(
+            responses.POST,
+            url=websites_base_url,
+            status=400,
+            body=json.dumps({"message":["Something went wrong."]})
+        )
+        Website().create(domain_name=domain_name, command=command)
+
+    assert "Something went wrong." in str(e)
+
+
 def test_get_returns_json_with_info_for_given_domain(
         api_responses, websites_base_url, website_info, domain_name
 ):
@@ -161,39 +193,3 @@ def test_raises_if_ssl_info_does_not_return_200(api_responses, domain_name, doma
 
     assert "GET SSL details via API failed, got" in str(e.value)
     assert "nope" in str(e.value)
-
-
-def test_website_sanity_check_domain_already_exists(api_responses, websites_base_url, website_info, domain_name):
-    api_responses.add(
-        responses.GET,
-        url=f"{websites_base_url}{domain_name}/",
-        status=200,
-        body=json.dumps(website_info)
-    )
-
-    with pytest.raises(SanityException) as e:
-        Website().sanity_check(domain_name=domain_name, nuke=False)
-
-
-def test_website_sanity_check_can_be_bypassed_with_nuke_option(api_responses, websites_base_url, website_info, domain_name):
-    # Test that the sanity check does not raise an exception
-    Website().sanity_check(domain_name=domain_name, nuke=True)
-
-
-def test_website_sanity_check_tests_api_token_present(api_responses, websites_base_url, website_info, domain_name):
-    import os 
-    del os.environ["API_TOKEN"]
-
-    # Test that the sanity check does not raise an exception
-    with pytest.raises(SanityException) as e:
-        Website().sanity_check(domain_name=domain_name, nuke=False)
-    
-    assert "Could not find your API token" in str(e.value)
-
-
-@patch('pythonanywhere_core.website.Website.sanity_check')
-def test_create_website_calls_sanity_check(mock_sanity_check, api_responses, websites_base_url, website_info, domain_name, command):
-    mock_sanity_check.side_effect = SanityException('Boom!')
-
-    with pytest.raises(SanityException):
-        Website().create(domain_name=domain_name, command=command, nuke=False)