PA-752: Checking domain name already exists when creating a website. by Nina & Sam

Author: SamBoyd

pythonanywhere_core/website.py

@@ -1,8 +1,10 @@
+import os
 import getpass
+from snakesay import snakesay
+from textwrap import dedent
 
 from pythonanywhere_core.base import call_api, get_api_endpoint
-from pythonanywhere_core.exceptions import PythonAnywhereApiException
-
+from pythonanywhere_core.exceptions import SanityException, PythonAnywhereApiException
 
 
 class Website:
@@ -27,6 +29,35 @@ 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) -> dict:
         """Creates new website with ``domain_name`` and ``command``.
 

tests/test_website.py

@@ -7,6 +7,7 @@
 from pythonanywhere_core.base import get_api_endpoint
 from pythonanywhere_core.exceptions import PythonAnywhereApiException
 from pythonanywhere_core.website import Website
+from pythonanywhere_core.exceptions import SanityException, PythonAnywhereApiException
 
 
 pytestmark = pytest.mark.usefixtures("api_token")
@@ -159,3 +160,31 @@ 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)