Extracts common script code.

As a side effect it removes a bug in
pa_create_webapp_with_virtualenv.py that would fail on
eu.pythonanywhere.com site.

Author: filiplajszczak

pythonanywhere/utils.py

@@ -0,0 +1,11 @@
+import getpass
+import os
+
+
+def ensure_domain(domain):
+    if domain == "your-username.pythonanywhere.com":
+        username = getpass.getuser().lower()
+        pa_domain = os.environ.get("PYTHONANYWHERE_DOMAIN", "pythonanywhere.com")
+        return "{username}.{pa_domain}".format(username=username, pa_domain=pa_domain)
+    else:
+        return domain

pythonanywhere/utils.pyi

@@ -0,0 +1 @@
+def ensure_domain(domain: str) -> str: ...

scripts/pa_autoconfigure_django.py

@@ -17,19 +17,14 @@
 """
 
 from docopt import docopt
-import getpass
-import os
 
 from pythonanywhere.django_project import DjangoProject
 from pythonanywhere.snakesay import snakesay
+from pythonanywhere.utils import ensure_domain
 
 
 def main(repo_url, domain, python_version, nuke):
-    if domain == 'your-username.pythonanywhere.com':
-        username = getpass.getuser().lower()
-        pa_domain = os.environ.get('PYTHONANYWHERE_DOMAIN', 'pythonanywhere.com')
-        domain = '{username}.{pa_domain}'.format(username=username, pa_domain=pa_domain)
-
+    domain = ensure_domain(domain)
     project = DjangoProject(domain, python_version)
     project.sanity_checks(nuke=nuke)
     project.download_repo(repo_url, nuke=nuke),

scripts/pa_create_webapp_with_virtualenv.py

@@ -21,13 +21,11 @@
 
 from pythonanywhere.project import Project
 from pythonanywhere.snakesay import snakesay
+from pythonanywhere.utils import ensure_domain
 
 
 def main(domain, python_version, nuke):
-    if domain == 'your-username.pythonanywhere.com':
-        username = getpass.getuser().lower()
-        domain = '{username}.pythonanywhere.com'.format(username=username)
-
+    domain = ensure_domain(domain)
     project = Project(domain, python_version)
     project.sanity_checks(nuke=nuke)
     project.virtualenv.create(nuke=nuke)
@@ -42,7 +40,7 @@ def main(domain, python_version, nuke):
         - Your web app config screen is here: https://www.pythonanywhere.com/user/{username}/webapps/{mangled_domain}
         '''.format(
             domain=domain,
-            username=username,
+            username=getpass.getuser().lower(),
             mangled_domain=domain.replace('.', '_')
         )
     )))

scripts/pa_delete_webapp_logs.py

@@ -19,15 +19,11 @@
 
 from pythonanywhere.api import Webapp
 from pythonanywhere.snakesay import snakesay
+from pythonanywhere.utils import ensure_domain
 
 
 def main(domain, log_type, log_index):
-    if domain == 'your-username.pythonanywhere.com':
-        username = getpass.getuser().lower()
-        pa_domain = os.environ.get('PYTHONANYWHERE_DOMAIN', 'pythonanywhere.com')
-        domain = '{username}.{pa_domain}'.format(username=username, pa_domain=pa_domain)
-
-    webapp = Webapp(domain)
+    webapp = Webapp(ensure_domain(domain))
     log_types = ["access", "error", "server"]
     logs = webapp.get_log_info()
     if log_type == "all" and log_index == "all":

scripts/pa_start_django_webapp_with_virtualenv.py

@@ -13,19 +13,14 @@
 """
 
 from docopt import docopt
-import getpass
-import os
 
 from pythonanywhere.snakesay import snakesay
 from pythonanywhere.django_project import DjangoProject
+from pythonanywhere.utils import ensure_domain
 
 
 def main(domain, django_version, python_version, nuke):
-    if domain == 'your-username.pythonanywhere.com':
-        username = getpass.getuser().lower()
-        pa_domain = os.environ.get('PYTHONANYWHERE_DOMAIN', 'pythonanywhere.com')
-        domain = '{username}.{pa_domain}'.format(username=username, pa_domain=pa_domain)
-
+    domain = ensure_domain(domain)
     project = DjangoProject(domain, python_version)
     project.sanity_checks(nuke=nuke)
     project.create_virtualenv(django_version, nuke=nuke)
@@ -43,7 +38,6 @@ def main(domain, django_version, python_version, nuke):
     print(snakesay('All done!  Your site is now live at https://{domain}'.format(domain=domain)))
 
 
-
 if __name__ == '__main__':
     arguments = docopt(__doc__)
     main(arguments['--domain'], arguments['--django'], arguments['--python'], nuke=arguments.get('--nuke'))

tests/test_pa_autoconfigure_django.py

@@ -31,27 +31,6 @@ def test_calls_all_stuff_in_right_order(self):
             call.start_bash(),
         ]
 
-
-    def test_domain_defaults_to_using_current_username_and_domain_from_env(self, monkeypatch):
-        username = getpass.getuser()
-        monkeypatch.setenv('PYTHONANYWHERE_DOMAIN', 'pythonanywhere.domain')
-        with patch('scripts.pa_autoconfigure_django.DjangoProject') as mock_DjangoProject:
-            main('a-repo', 'your-username.pythonanywhere.com', 'python.version', nuke=False)
-        assert mock_DjangoProject.call_args == call(
-            username + '.pythonanywhere.domain', 'python.version'
-        )
-
-
-    def test_lowercases_username(self):
-        with patch('scripts.pa_autoconfigure_django.getpass') as mock_getpass:
-            mock_getpass.getuser.return_value = 'UserName1'
-            with patch('scripts.pa_autoconfigure_django.DjangoProject') as mock_DjangoProject:
-                main('a-url', 'your-username.pythonanywhere.com', 'python.version', 'nukey')
-            assert mock_DjangoProject.call_args == call(
-                'username1.pythonanywhere.com', 'python.version'
-            )
-
-
     @pytest.mark.slowtest
     def test_actually_works_against_example_repo(
         self, fake_home, virtualenvs_folder, api_token, process_killer

tests/test_pa_start_django_webapp_with_virtualenv.py

@@ -26,20 +26,6 @@ def test_calls_all_stuff_in_right_order(self):
             call.webapp.reload(),
         ]
 
-    def test_domain_defaults_to_using_current_username_and_domain_from_env(self, monkeypatch):
-        username = getpass.getuser()
-        monkeypatch.setenv("PYTHONANYWHERE_DOMAIN", "pythonanywhere.domain")
-        with patch("scripts.pa_start_django_webapp_with_virtualenv.DjangoProject") as mock_DjangoProject:
-            main("your-username.pythonanywhere.com", "django.version", "python.version", nuke=False)
-        assert mock_DjangoProject.call_args == call(username + ".pythonanywhere.domain", "python.version")
-
-    def test_lowercases_username(self):
-        with patch("scripts.pa_start_django_webapp_with_virtualenv.getpass") as mock_getpass:
-            mock_getpass.getuser.return_value = "UserName1"
-            with patch("scripts.pa_start_django_webapp_with_virtualenv.DjangoProject") as mock_DjangoProject:
-                main("your-username.pythonanywhere.com", "django.version", "python.version", "nukey")
-            assert mock_DjangoProject.call_args == call("username1.pythonanywhere.com", "python.version")
-
     @pytest.mark.slowtest
     def test_actually_creates_django_project_in_virtualenv_with_hacked_settings_and_static_files(
         self, fake_home, virtualenvs_folder, api_token

tests/test_utils.py

@@ -0,0 +1,31 @@
+import getpass
+from unittest.mock import patch
+
+from pythonanywhere.utils import ensure_domain
+
+
+class TestEnsureDomain:
+    def test_domain_defaults_to_using_current_username_and_domain_from_env(
+        self, monkeypatch
+    ):
+        username = getpass.getuser()
+        monkeypatch.setenv("PYTHONANYWHERE_DOMAIN", "pythonanywhere.domain")
+
+        result = ensure_domain("your-username.pythonanywhere.com")
+
+        assert result == "{}.pythonanywhere.domain".format(username)
+
+    def test_lowercases_username(self, monkeypatch):
+        with patch('pythonanywhere.utils.getpass') as mock_getpass:
+            mock_getpass.getuser.return_value = 'UserName1'
+
+            result = ensure_domain("your-username.pythonanywhere.com")
+
+        assert result == 'username1.pythonanywhere.com'
+
+    def test_custom_domain_remains_unchanged(self):
+        custom_domain = "foo.bar.baz"
+
+        result = ensure_domain(custom_domain)
+
+        assert result == custom_domain