further testing

Author: gdams

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+ignore = 
+   # E501 line too long
+    E501

.github/workflows/linter.yml

@@ -59,3 +59,5 @@ jobs:
           FILTER_REGEX_EXCLUDE: .github/ISSUE_TEMPLATE/*
           # Lots of shellcheck errors - need fixing
           VALIDATE_BASH: false
+          # Disable isort
+          VALIDATE_PYTHON_ISORT: false

.github/workflows/test.yml

@@ -23,4 +23,4 @@ jobs:
       run: pip install -r requirements.txt
 
     - name: Run Python Tests
-      run: python -m unittest test
+      run: python -m unittest discover tests

skaraMirror.md

@@ -46,3 +46,11 @@ Mirror the JDK 8 repository from a specific repository and branch:
 ```bash
 ./skaraMirror.py jdk8u [email protected]:custom_org custom_branch
 ```
+
+## Running tests
+
+The tests for this codebase live in `/tests`. If you want to run them you can use the following command:
+
+```bash
+python -m unittest discover tests
+```

skaraMirror.py

@@ -79,6 +79,11 @@ def add_skara_upstream(workspace, jdk_version, skara_repo, branch):
         # Fetch origin
         repo.remotes.origin.fetch()
 
+        # Check if the remote named 'skara' exists, add if not
+        if "skara" not in [remote.name for remote in repo.remotes]:
+            print(f"Initial setup of: {skara_repo}")
+            repo.create_remote("skara", skara_repo)
+
         # Check out the specified branch
         if branch in repo.heads:
             # Branch exists locally, just check it out
@@ -98,11 +103,6 @@ def add_skara_upstream(workspace, jdk_version, skara_repo, branch):
             # Create master branch
             repo.create_head(branch, f"skara/{branch}").checkout()
 
-        # Check if the remote named 'skara' exists, add if not
-        if "skara" not in [remote.name for remote in repo.remotes]:
-            print(f"Initial setup of: {skara_repo}")
-            repo.create_remote("skara", skara_repo)
-
     except GitCommandError as error:
         print(f"Git command failed: {error}")
         exit(1)
@@ -233,7 +233,9 @@ def perform_merge_into_release_from_master(workspace, github_repo, branch):
                 )
                 print(f"Tagging {tag} as {tag}_adopt")
                 adoptTag = f"{tag}_adopt"
-                repo.create_tag(adoptTag, ref=tag, message=f"Merged {tag} into release")
+                repo.create_tag(
+                    adoptTag, ref="release", message=f"Merged {tag} into release"
+                )
                 newAdoptTags.append(adoptTag)
 
         if repo.git.rev_parse(
@@ -274,6 +276,7 @@ def perform_merge_into_release_from_master(workspace, github_repo, branch):
 
                 if repo.git.tag("-l", prevReleaseAdoptTag):
                     if not repo.git.tag("-l", currentReleaseAdoptTag):
+                        print("here")
                         print(
                             f"Tagging new current release tag {currentReleaseAdoptTag} "
                             + f"which is same commit as the previous {prevReleaseAdoptTag}"

test.py

@@ -0,0 +1,12 @@
+import io
+import sys
+
+
+class SuppressPrint:
+    def __enter__(self):
+        self._original_stdout = sys.stdout
+        sys.stdout = io.StringIO()
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        sys.stdout = self._original_stdout

tests/__init__.py

@@ -0,0 +1,45 @@
+import unittest
+from unittest.mock import patch, MagicMock
+
+from skaraMirror import add_skara_upstream
+from tests.supress_print import SuppressPrint
+
+
+class TestAddSkaraUpstream(unittest.TestCase):
+    @patch("skaraMirror.Repo")
+    def test_add_skara_remote_not_exist(self, mock_repo):
+        # Setup: Configure the mock repo object
+        mock_repo.return_value.remotes = MagicMock()
+        mock_repo.return_value.remotes.__iter__.return_value = []
+
+        # Define your function parameters
+        workspace = "/tmp/workspace"
+        jdk_version = "jdk11u"
+        skara_repo = "https://github.com/openjdk/skara"
+        branch = "master"
+
+        # Execute the function
+        with SuppressPrint():
+            add_skara_upstream(workspace, jdk_version, skara_repo, branch)
+
+        # Assertions: Check if the remote was added
+        mock_repo.return_value.create_remote.assert_called_once_with(
+            "skara", skara_repo
+        )
+
+    @patch("skaraMirror.Repo")
+    def test_skara_remote_already_exists(self, mock_repo):
+        # Setup: Simulate existing 'skara' remote
+        mock_remote = MagicMock()
+        mock_remote.name = "skara"
+        mock_repo.return_value.remotes = MagicMock()
+        mock_repo.return_value.remotes.__iter__.return_value = [mock_remote]
+
+        # Execute the function with the same parameters as before
+        with SuppressPrint():
+            add_skara_upstream(
+                "/tmp/workspace", "jdk11u", "https://github.com/openjdk/skara", "master"
+            )
+
+        # Assertions: Ensure create_remote was not called since 'skara' exists
+        mock_repo.return_value.create_remote.assert_not_called()

tests/supress_print.py

@@ -0,0 +1,20 @@
+import unittest
+from unittest.mock import patch
+
+from skaraMirror import check_args
+
+
+class TestCheckArgs(unittest.TestCase):
+    @patch("sys.argv", ["script_name", "jdk8u", "https://example.com/repo", "dev"])
+    def test_with_full_arguments(self):
+        args = check_args()
+        self.assertEqual(args.jdk_version, "jdk8u")
+        self.assertEqual(args.repo_url, "https://example.com/repo")
+        self.assertEqual(args.branch, "dev")
+
+    @patch("sys.argv", ["script_name", "jdk11u"])
+    def test_with_minimum_arguments(self):
+        args = check_args()
+        self.assertEqual(args.jdk_version, "jdk11u")
+        self.assertEqual(args.repo_url, "[email protected]:adoptium")
+        self.assertEqual(args.branch, "master")