ensure branch in autoconfigure Django script. by Piotr and Filip

Author: filiplajszczak

pythonanywhere/django_project.py

@@ -11,12 +11,35 @@
 
 
 class DjangoProject(Project):
-
     def download_repo(self, repo, nuke):
         if nuke and self.project_path.exists():
             shutil.rmtree(str(self.project_path))
         subprocess.check_call(['git', 'clone', repo, str(self.project_path)])
 
+    def ensure_branch(self, branch):
+        output = subprocess.check_output(
+            ["git", "-C", str(self.project_path), "branch", "-r"]
+        ).decode().rstrip().split("\n")
+        branches = [x.strip().replace("origin/", "") for x in output if "->" not in x]
+        if branch == "None" and len(branches) == 1:
+            return
+        if branch == "None":
+            shutil.rmtree(str(self.project_path))
+            raise SanityException(
+                "There are many branches in your repo. "
+                "You need to specify which branch to use by adding "
+                "--branch=<branch> option to the command."
+            )
+        if branch not in branches:
+            shutil.rmtree(str(self.project_path))
+            raise SanityException(f"You do not have a {branch} branch in your repo")
+        #
+        current_branch = subprocess.check_output(
+            ["git", "-C", str(self.project_path), "rev-parse", "--abbrev-ref HEAD"]
+        ).decode().strip()
+
+        if current_branch != branch:
+            subprocess.check_call(["git", "-C", str(self.project_path), "checkout", branch])
 
     def create_virtualenv(self, django_version=None, nuke=False):
         self.virtualenv.create(nuke=nuke)

pythonanywhere/django_project.pyi

@@ -5,6 +5,7 @@ from typing import Optional
 
 class DjangoProject(Project):
     def download_repo(self, repo: str, nuke: bool) -> None: ...
+    def ensure_branch(self, branch: str) -> None: ...
     def create_virtualenv(self, django_version: Optional[str] = ..., nuke: bool = ...) -> None: ...
     def detect_requirements(self): ...
     def run_startproject(self, nuke: bool) -> None: ...

scripts/pa_autoconfigure_django.py

@@ -8,9 +8,10 @@
 - adds static files config
 
 Usage:
-  pa_autoconfigure_django.py <git-repo-url> [--domain=<domain> --python=<python-version>] [--nuke]
+  pa_autoconfigure_django.py <git-repo-url> [--branch=<branch> --domain=<domain> --python=<python-version>] [--nuke]
 
 Options:
+  --branch=<branch>         Branch name in case of multiple branches   [default: None]
   --domain=<domain>         Domain name, eg www.mydomain.com   [default: your-username.pythonanywhere.com]
   --python=<python-version> Python version, eg "3.8"    [default: 3.6]
   --nuke                    *Irrevocably* delete any existing web app config on this domain. Irrevocably.
@@ -23,11 +24,12 @@
 from pythonanywhere.utils import ensure_domain
 
 
-def main(repo_url, domain, python_version, nuke):
+def main(repo_url, branch, domain, python_version, nuke):
     domain = ensure_domain(domain)
     project = DjangoProject(domain, python_version)
     project.sanity_checks(nuke=nuke)
     project.download_repo(repo_url, nuke=nuke),
+    project.ensure_branch(branch),
     project.create_virtualenv(nuke=nuke)
     project.create_webapp(nuke=nuke)
     project.add_static_file_mappings()
@@ -44,4 +46,10 @@ def main(repo_url, domain, python_version, nuke):
 
 if __name__ == '__main__':
     arguments = docopt(__doc__)
-    main(arguments['<git-repo-url>'], arguments['--domain'], arguments['--python'], nuke=arguments.get('--nuke'))
+    main(
+        arguments['<git-repo-url>'],
+        arguments['--branch'],
+        arguments['--domain'],
+        arguments['--python'],
+        nuke=arguments.get('--nuke')
+    )

tests/test_cli_schedule.py

@@ -39,7 +39,6 @@ def mock_confirm(mocker):
     return mocker.patch("cli.schedule.typer.confirm")
 
 
-@pytest.mark.clischeduleset
 class TestSet:
     def test_calls_all_stuff_in_right_order(self, mocker):
         mock_logger = mocker.patch("cli.schedule.get_logger")
@@ -93,7 +92,6 @@ def test_logs_warning_when_create_schedule_raises(self, mocker):
         assert mock_logger.warning.call_args == call(mock_snakesay.return_value)
 
 
-@pytest.mark.clischeduledeleteall
 class TestDeleteAllTasks:
     def test_deletes_all_tasks_with_user_permission(self, task_list, mock_confirm):
         mock_confirm.return_value = True
@@ -130,7 +128,6 @@ def test_sets_logging_to_info(self, mocker):
         assert mock_logger.call_args == call(set_info=True)
 
 
-@pytest.mark.clischeduledelete
 class TestDeleteTaskById:
     def test_deletes_one_task(self, mocker):
         mock_task_from_id = mocker.patch("cli.schedule.get_task_from_id")
@@ -184,7 +181,6 @@ def task_from_id(mocker):
     yield task
 
 
-@pytest.mark.clischeduleget
 class TestGet:
     def test_logs_all_task_specs_using_tabulate(self, mocker, task_from_id):
         mock_tabulate = mocker.patch("cli.schedule.tabulate")
@@ -256,7 +252,6 @@ def test_complains_when_no_id_provided(self):
         assert "Missing argument 'id'" in result.stdout
 
 
-@pytest.mark.clischedulelist
 class TestList:
     def test_logs_table_with_correct_headers_and_values(self, mocker, task_list):
         mock_logger = mocker.patch("cli.schedule.get_logger")
@@ -300,7 +295,6 @@ def test_warns_when_wrong_format_provided(self, mocker, task_list):
         assert "Table format has to be one of" in result.stdout
 
 
-@pytest.mark.clischeduleupdate
 class TestUpdate:
     def test_enables_task_and_sets_porcelain(self, mocker):
         mock_task_from_id = mocker.patch("cli.schedule.get_task_from_id")

tests/test_django_project.py

@@ -36,7 +36,7 @@ def test_nuke_option_deletes_directory_first(self, mock_subprocess, fake_home, v
         mock_subprocess.check_call.side_effect = lambda *_, **__: Path(project.project_path).mkdir()
 
         project.download_repo("repo", nuke=True)
-        assert "old-thing.txt" not in project.project_path.iterdir()
+        assert (project.project_path / "old-thing.txt") not in project.project_path.iterdir()
 
     def test_nuke_option_ignores_directory_doesnt_exist(self, mock_subprocess, fake_home, virtualenvs_folder):
         project = DjangoProject("www.a.domain.com", "py.version")
@@ -47,6 +47,92 @@ def test_nuke_option_ignores_directory_doesnt_exist(self, mock_subprocess, fake_
         assert project.project_path.is_dir()
 
 
+class TestEnsureBranch:
+    def test_checks_happy_path_with_one_branch(self, mock_subprocess, fake_home, virtualenvs_folder):
+        project = DjangoProject("www.a.domain.com", "py.version")
+        mock_subprocess.check_output.side_effect = [
+            b"  origin/HEAD -> origin/bar\n  origin/bar\n", b"bar\n"
+        ]
+        project.ensure_branch("None")  # should not raise
+
+    def test_checks_if_branch_exists(self, mock_subprocess, fake_home, virtualenvs_folder):
+        project = DjangoProject("www.a.domain.com", "py.version")
+        mock_subprocess.check_output.side_effect = [
+            b"  origin/HEAD -> origin/bar\n  origin/foo\n  origin/bar\n  origin/baz\n", b"bar\n"
+        ]
+        project.ensure_branch("foo")  # should not raise
+
+    def test_checks_if_branch_exists(self, mock_subprocess, fake_home, virtualenvs_folder):
+        project = DjangoProject("www.a.domain.com", "py.version")
+        mock_subprocess.check_output.side_effect = [
+            b"  origin/HEAD -> origin/bar\n  origin/foo\n  origin/bar\n  origin/baz\n", b"bar\n"
+        ]
+
+        project.ensure_branch("foo")  # should not raise
+
+    def test_deletes_directory_if_branch_does_not_exist(self, mock_subprocess, fake_home, virtualenvs_folder):
+        project = DjangoProject("www.a.domain.com", "py.version")
+        project.project_path.mkdir()
+        mock_subprocess.check_output.return_value = b"  origin/HEAD -> origin/bar\n  origin/bar\n  origin/baz\n"
+
+        with pytest.raises(SanityException):
+            project.ensure_branch("foo")
+
+        assert not project.project_path.exists()
+
+    def test_program_raises_if_branch_does_not_exist(self, mock_subprocess, fake_home, virtualenvs_folder):
+        project = DjangoProject("www.a.domain.com", "py.version")
+        project.project_path.mkdir()
+        mock_subprocess.check_output.return_value = b"  origin/HEAD -> origin/bar\n  origin/bar\n  origin/baz\n"
+
+        with pytest.raises(SanityException) as e:
+            project.ensure_branch("foo")
+
+        assert "You do not have a foo branch in your repo" in str(e.value)
+
+    def test_deletes_directory_if_multiple_branches(self,  mock_subprocess, fake_home, virtualenvs_folder):
+        project = DjangoProject("www.a.domain.com", "py.version")
+        project.project_path.mkdir()
+        mock_subprocess.check_output.return_value = b"  origin/HEAD -> origin/bar\n  origin/foo\n  origin/bar\n  origin/baz\n"
+
+        with pytest.raises(SanityException) as e:
+            project.ensure_branch("None")
+
+        assert not project.project_path.exists()
+
+    def test_raises_if_multiple_branches(self,  mock_subprocess, fake_home, virtualenvs_folder):
+        project = DjangoProject("www.a.domain.com", "py.version")
+        project.project_path.mkdir()
+        mock_subprocess.check_output.return_value = b"  origin/HEAD -> origin/bar\n  origin/foo\n  origin/bar\n  origin/baz\n"
+
+        with pytest.raises(SanityException) as e:
+            project.ensure_branch("None")
+
+        assert "There are many branches in your repo." in str(e.value)
+
+    def test_checkouts_branch_if_not_current_head(self,  mock_subprocess, fake_home, virtualenvs_folder):
+        project = DjangoProject("www.a.domain.com", "py.version")
+        mock_subprocess.check_output.side_effect = [
+            b"  origin/HEAD -> origin/bar\n  origin/foo\n  origin/bar\n  origin/baz\n", b"bar\n"
+        ]
+
+        project.ensure_branch("baz")
+
+        assert mock_subprocess.check_call.call_args == call(
+            ["git", "-C", str(project.project_path), "checkout", "baz"]
+        )
+
+    def test_does_not_checkouts_branch_if_current_head(self,  mock_subprocess, fake_home, virtualenvs_folder):
+        project = DjangoProject("www.a.domain.com", "py.version")
+        mock_subprocess.check_output.side_effect = [
+            b"  origin/HEAD -> origin/bar\n  origin/foo\n  origin/bar\n  origin/baz\n", b"bar\n"
+        ]
+
+        project.ensure_branch("bar")
+
+        assert mock_subprocess.check_call.call_count == 0
+
+
 class TestDetectDjangoVersion:
     def test_is_versionless_django_by_default(self, fake_home, virtualenvs_folder):
         project = DjangoProject("mydomain.com", "python.version")

tests/test_pa_autoconfigure_django.py

@@ -13,11 +13,12 @@ class TestMain:
 
     def test_calls_all_stuff_in_right_order(self):
         with patch('scripts.pa_autoconfigure_django.DjangoProject') as mock_DjangoProject:
-            main('repo.url', 'www.domain.com', 'python.version', nuke='nuke option')
+            main('repo.url', 'foo', 'www.domain.com', 'python.version',  nuke='nuke option')
         assert mock_DjangoProject.call_args == call('www.domain.com', 'python.version')
         assert mock_DjangoProject.return_value.method_calls == [
             call.sanity_checks(nuke='nuke option'),
             call.download_repo('repo.url', nuke='nuke option'),
+            call.ensure_branch("foo"),
             call.create_virtualenv(nuke='nuke option'),
             call.create_webapp(nuke='nuke option'),
             call.add_static_file_mappings(),
@@ -40,7 +41,7 @@ def test_actually_works_against_example_repo(
         with patch('scripts.pa_autoconfigure_django.DjangoProject.update_wsgi_file'):
             with patch('scripts.pa_autoconfigure_django.DjangoProject.start_bash'):
                 with patch('pythonanywhere.api.webapp.call_api'):
-                    main(repo, domain, running_python_version, nuke=False)
+                    main(repo, "None", domain, running_python_version, nuke=False)
 
         expected_django_version = '3.0.6'
         expected_virtualenv = virtualenvs_folder / domain