Add CLI tests for Go

Author: ikretz

tests/package_managers/test_go.py

@@ -17,18 +17,17 @@ class GoProject:
     """
     A representation of a Go project and its local environment.
     """
-    def __init__(self, go_dir: str, directory: str, env: dict):
+    def __init__(self, go_dir: Path, directory: Path, env: dict):
         self.go_dir = go_dir
         self.directory = directory
         self.env = env
 
-
     def get_go_dir_contents(self) -> str:
         """
         List the contents in the go directory.
 
-        Note that this only looks at the name and path of the filesm ignoring
-        their actual contents!
+        Note that this only looks at the name and path of the files, ignoring
+        their actual contents.
         """
         h = hashlib.new("md5")
         for root, _, files in os.walk(self.go_dir):
@@ -65,7 +64,13 @@ def test_go_no_change(new_go_project):
     Test that certain `go` commands relied on by Supply-Chain Firewall
     not to error or modify the local installation state indeed have these properties.
     """
-    def _test_go_no_change(project: GoProject, base_go: GoProject, local_init_state: str, global_init_state: str, command: list) -> bool:
+    def _test_go_no_change(
+            project: GoProject,
+            base_go: GoProject,
+            local_init_state: str,
+            global_init_state: str,
+            command: list
+        ) -> bool:
         """
         Tests that a given Poetry command does not encounter any errors and does not
         modify the local installation state when run in the context of a given project.
@@ -76,16 +81,19 @@ def _test_go_no_change(project: GoProject, base_go: GoProject, local_init_state:
         return go_show(project) == local_init_state and base_go.get_go_dir_contents() == global_init_state
 
     test_cases = []
-    for command in ["build", "generate", "get", "install", "mod", "run"]:
-        for param in ["-h", "-help"]:
+    for command in {"build", "generate", "get", "install", "mod", "run"}:
+        for param in {"-h", "-help"}:
             test_cases.append(["go", command, param])
 
-    base_go = GoProject(get_gopath(), "", {})
+    base_go = GoProject(get_gopath(), Path(""), {})
     global_init_state = base_go.get_go_dir_contents()
 
     local_init_state = go_show(new_go_project)
 
-    assert all(_test_go_no_change(new_go_project, base_go, local_init_state, global_init_state, command) for command in test_cases)
+    assert all(
+        _test_go_no_change(new_go_project, base_go, local_init_state, global_init_state, command)
+        for command in test_cases
+    )
 
 
 def go_show(project: GoProject) -> str:
@@ -103,15 +111,15 @@ def go_show(project: GoProject) -> str:
     return go_show.stdout.lower()
 
 
-def get_gopath() -> str:
+def get_gopath() -> Path:
     """
     Retrieve the default path where go install packages.
     """
     gopath = subprocess.run(["go", "env", "GOPATH"], check=True, text=True, capture_output=True)
-    return gopath.stdout.strip()
+    return Path(gopath.stdout.strip())
 
 
-def _init_go_env(directory) -> (Path, dict):
+def _init_go_env(directory) -> tuple[Path, dict]:
     """
     Initialize a fresh Go environment in `directory` and return both the path
     used by go and the environment variables that should be provided to

tests/package_managers/test_go_class.py

@@ -10,7 +10,7 @@
 import subprocess
 import textwrap
 
-from .test_go import GoProject, get_gopath, go_show, new_go_project
+from .test_go import GoProject, get_gopath, go_show
 
 PACKAGE_MANAGER = Go()
 """
@@ -33,7 +33,7 @@ def test_go_command_would_install_remote(new_go_project):
         ["go", "run", f"{TARGET}@latest"],
     ]
 
-    base_go = GoProject(get_gopath(), "", {})
+    base_go = GoProject(get_gopath(), Path(""), {})
     global_init_state = base_go.get_go_dir_contents()
 
     local_init_state = go_show(new_go_project)
@@ -64,7 +64,7 @@ def test_go_command_would_install_local(new_go_project):
         ["go", "install", "."],
     ]
 
-    base_go = GoProject(get_gopath(), "", {})
+    base_go = GoProject(get_gopath(), Path(""), {})
     global_init_state = base_go.get_go_dir_contents()
 
     _install_target(new_go_project)

tests/test_cli.py

@@ -36,7 +36,7 @@ def test_cli_incorrect_subcommand():
 
 @pytest.mark.parametrize(
         "target",
-        ["npm", "pip", "poetry"]
+        ["go", "npm", "pip", "poetry"]
 )
 def test_cli_audit_basic_usage(target: str):
     """
@@ -83,7 +83,7 @@ def test_cli_audit_unknown_package_manager():
 
 @pytest.mark.parametrize(
         "target",
-        ["npm", "pip", "poetry"]
+        ["go", "npm", "pip", "poetry"]
 )
 def test_cli_audit_all_options_package_manager(target: str):
     """
@@ -113,6 +113,7 @@ def test_cli_configure_basic_usage():
     assert args.log_level == _DEFAULT_LOG_LEVEL
 
     assert not args.remove
+    assert not args.alias_go
     assert not args.alias_npm
     assert not args.alias_pip
     assert not args.alias_poetry
@@ -125,6 +126,7 @@ def test_cli_configure_basic_usage():
 @pytest.mark.parametrize(
         "option",
         [
+            ["--alias-go"],
             ["--alias-npm"],
             ["--alias-pip"],
             ["--alias-poetry"],
@@ -146,6 +148,7 @@ def test_cli_configure_removal(option: list[str]):
 @pytest.mark.parametrize(
         "command",
         [
+            ["go", "get", "github.com/aws/aws-sdk-go-v2"],
             ["npm", "install", "react"],
             ["pip", "install", "requests"],
             ["poetry", "add", "requests"],
@@ -182,6 +185,7 @@ def test_cli_run_all_options_no_command():
 @pytest.mark.parametrize(
         "command",
         [
+            ["go", "get", "github.com/aws/aws-sdk-go-v2"],
             ["npm", "install", "react"],
             ["pip", "install", "requests"],
             ["poetry", "add", "requests"],
@@ -209,6 +213,7 @@ def test_cli_run_all_options_command(command: list[str]):
 @pytest.mark.parametrize(
         "command",
         [
+            ["go", "get", "github.com/aws/aws-sdk-go-v2"],
             ["npm", "install", "react"],
             ["pip", "install", "requests"],
             ["poetry", "install", "requests"],
@@ -235,10 +240,16 @@ def test_cli_run_package_manager_dry_run(command: list[str]):
 @pytest.mark.parametrize(
         "target,test",
         [
+            ("go", "npm"),
+            ("go", "pip"),
+            ("go", "poetry"),
+            ("npm", "go"),
             ("npm", "pip"),
             ("npm", "poetry"),
+            ("pip", "go"),
             ("pip", "npm"),
             ("pip", "poetry"),
+            ("poetry", "go"),
             ("poetry", "npm"),
             ("poetry", "pip"),
         ]