Updates structure and imports of api interface and fixes tests.

filiplajszczak · filiplajszczak · commit bcd9dad27924 · 2020-02-27T15:28:02.000Z
As a side effect of change of test run order it was uncovered that virtualenvs_folder fixture was
leaking environment variable between tests. Fix uncovered that that
fixture is required in many other tests.
diff --git a/pythonanywhere/api/schedule.py b/pythonanywhere/api/schedule.py
@@ -3,7 +3,7 @@
 
 import getpass
 
-from pythonanywhere.api import call_api, get_api_endpoint
+from pythonanywhere.api.base import call_api, get_api_endpoint
 
 
 class Schedule:
diff --git a/pythonanywhere/api/schedule.pyi b/pythonanywhere/api/schedule.pyi
diff --git a/pythonanywhere/project.py b/pythonanywhere/project.py
@@ -1,7 +1,7 @@
 from pathlib import Path
 import uuid
 
-from pythonanywhere.api import Webapp
+from pythonanywhere.api.webapp import Webapp
 from pythonanywhere.exceptions import SanityException
 from pythonanywhere.virtualenvs import Virtualenv
 from pythonanywhere.launch_bash_in_virtualenv import launch_bash_in_virtualenv
diff --git a/pythonanywhere/project.pyi b/pythonanywhere/project.pyi
@@ -1,6 +1,6 @@
 from pathlib import Path
 
-from pythonanywhere.api import Webapp
+from pythonanywhere.api.webapp import Webapp
 from pythonanywhere.virtualenvs import Virtualenv
 
 class Project:
diff --git a/pythonanywhere/task.py b/pythonanywhere/task.py
@@ -4,7 +4,7 @@
 
 import logging
 
-from pythonanywhere.schedule_api import Schedule
+from pythonanywhere.api.schedule import Schedule
 from pythonanywhere.snakesay import snakesay
 
 logger = logging.getLogger(name=__name__)
@@ -33,7 +33,7 @@ class Task:
     defined by user.
 
     `Task` class is API agnostic meaning all API calls are made using the
-    `pythonanywhere.schedule_api.Schedule` interface via `Task.schedule`
+    `pythonanywhere.api.schedule.Schedule` interface via `Task.schedule`
     attribute."""
 
     def __init__(self):
diff --git a/pythonanywhere/task.pyi b/pythonanywhere/task.pyi
@@ -2,7 +2,7 @@ from typing import List, Optional, Type, TypeVar, Union
 
 from typing_extensions import Literal
 
-from pythonanywhere.schedule_api import Schedule
+from pythonanywhere.api.schedule import Schedule
 
 T = TypeVar("T", bound="Task")
 
diff --git a/scripts/pa_delete_webapp_logs.py b/scripts/pa_delete_webapp_logs.py
@@ -14,10 +14,8 @@
 """
 
 from docopt import docopt
-import getpass
-import os
 
-from pythonanywhere.api import Webapp
+from pythonanywhere.api.webapp import Webapp
 from pythonanywhere.snakesay import snakesay
 from pythonanywhere.utils import ensure_domain
 
diff --git a/scripts/pa_install_webapp_letsencrypt_ssl.py b/scripts/pa_install_webapp_letsencrypt_ssl.py
@@ -17,7 +17,7 @@
 import os
 import sys
 
-from pythonanywhere.api import Webapp
+from pythonanywhere.api.webapp import Webapp
 from pythonanywhere.snakesay import snakesay
 
 
diff --git a/scripts/pa_install_webapp_ssl.py b/scripts/pa_install_webapp_ssl.py
@@ -19,7 +19,7 @@
 import os
 import sys
 
-from pythonanywhere.api import Webapp
+from pythonanywhere.api.webapp import Webapp
 from pythonanywhere.snakesay import snakesay
 
 
diff --git a/scripts/pa_reload_webapp.py b/scripts/pa_reload_webapp.py
@@ -9,10 +9,8 @@
 """
 
 from docopt import docopt
-import os
-import sys
 
-from pythonanywhere.api import Webapp
+from pythonanywhere.api.webapp import Webapp
 from pythonanywhere.snakesay import snakesay
 
 
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -60,6 +60,8 @@ def virtualenvs_folder():
     yield tempdir
     if old_workon:
         os.environ["WORKON_HOME"] = old_workon
+    else:
+        del os.environ["WORKON_HOME"]
     shutil.rmtree(str(tempdir))
 
     if actual_virtualenvs.is_dir():
diff --git a/tests/test_api_base.py b/tests/test_api_base.py
@@ -0,0 +1,45 @@
+from unittest.mock import patch
+
+import pytest
+import responses
+
+from pythonanywhere.api.base import AuthenticationError, call_api, get_api_endpoint
+
+
+class TestGetAPIEndpoint:
+
+    def test_defaults_to_pythonanywhere_dot_com_if_no_environment_variables(self):
+        assert get_api_endpoint() == "https://www.pythonanywhere.com/api/v0/user/{username}/{flavor}/"
+
+    def test_gets_domain_from_pythonanywhere_site_and_ignores_pythonanywhere_domain_if_both_set(self, monkeypatch):
+        monkeypatch.setenv("PYTHONANYWHERE_SITE", "www.foo.com")
+        monkeypatch.setenv("PYTHONANYWHERE_DOMAIN", "wibble.com")
+        assert get_api_endpoint() == "https://www.foo.com/api/v0/user/{username}/{flavor}/"
+
+    def test_gets_domain_from_pythonanywhere_domain_and_adds_on_www_if_set_but_no_pythonanywhere_site(
+        self, monkeypatch
+    ):
+        monkeypatch.setenv("PYTHONANYWHERE_DOMAIN", "foo.com")
+        assert get_api_endpoint() == "https://www.foo.com/api/v0/user/{username}/{flavor}/"
+
+
+class TestCallAPI:
+    def test_raises_on_401(self, api_token, api_responses):
+        url = "https://foo.com/"
+        api_responses.add(responses.POST, url, status=401, body="nope")
+        with pytest.raises(AuthenticationError) as e:
+            call_api(url, "post")
+        assert str(e.value) == "Authentication error 401 calling API: nope"
+
+    def test_passes_verify_from_environment(self, api_token, monkeypatch):
+        monkeypatch.setenv("PYTHONANYWHERE_INSECURE_API", "true")
+        with patch("pythonanywhere.api.base.requests") as mock_requests:
+            call_api("url", "post", foo="bar")
+        args, kwargs = mock_requests.request.call_args
+        assert kwargs["verify"] is False
+
+    def test_verify_is_true_if_env_not_set(self, api_token):
+        with patch("pythonanywhere.api.base.requests") as mock_requests:
+            call_api("url", "post", foo="bar")
+        args, kwargs = mock_requests.request.call_args
+        assert kwargs["verify"] is True
diff --git a/tests/test_api_schedule.py b/tests/test_api_schedule.py
@@ -1,12 +1,11 @@
 import getpass
 import json
-from unittest.mock import call
 
 import pytest
 import responses
 
-from pythonanywhere.api import get_api_endpoint
-from pythonanywhere.schedule_api import Schedule
+from pythonanywhere.api.base import get_api_endpoint
+from pythonanywhere.api.schedule import Schedule
 
 
 @pytest.fixture
diff --git a/tests/test_api_webapp.py b/tests/test_api_webapp.py
diff --git a/tests/test_django_project.py b/tests/test_django_project.py
diff --git a/tests/test_project.py b/tests/test_project.py
diff --git a/tests/test_task.py b/tests/test_task.py
