test: docker build tool tests

Signed-off-by: Tim Yarkov <[email protected]>

Author: timyarkov

tests/conftest.py

@@ -10,6 +10,7 @@
 from macaron.config.defaults import create_defaults, defaults, load_defaults
 from macaron.database.table_definitions import Analysis, Component, Repository
 from macaron.slsa_analyzer.analyze_context import AnalyzeContext
+from macaron.slsa_analyzer.build_tool.docker import Docker
 from macaron.slsa_analyzer.build_tool.gradle import Gradle
 from macaron.slsa_analyzer.build_tool.maven import Maven
 from macaron.slsa_analyzer.build_tool.pip import Pip
@@ -148,6 +149,25 @@ def pip_tool(setup_test) -> Pip:  # type: ignore # pylint: disable=unused-argume
     return pip
 
 
+@pytest.fixture(autouse=True)
+def docker_tool(setup_test) -> Docker:  # type: ignore # pylint: disable=unused-argument
+    """Create a Docker tool instance.
+
+    Parameters
+    ----------
+    setup_test
+        Depends on setup_test fixture.
+
+    Returns
+    -------
+    Docker
+        The Docker instance.
+    """
+    docker = Docker()
+    docker.load_defaults()
+    return docker
+
+
 class MockGitHubActions(GitHubActions):
     """Mock the GitHubActions class."""
 

tests/slsa_analyzer/build_tool/__snapshots__/test_docker.ambr

@@ -0,0 +1,36 @@
+# serializer version: 1
+# name: test_get_build_dirs[mock_repo0]
+  list([
+    PosixPath('.'),
+  ])
+# ---
+# name: test_get_build_dirs[mock_repo1]
+  list([
+    PosixPath('project'),
+  ])
+# ---
+# name: test_get_build_dirs[mock_repo2]
+  list([
+    PosixPath('.'),
+  ])
+# ---
+# name: test_get_build_dirs[mock_repo3]
+  list([
+    PosixPath('.'),
+  ])
+# ---
+# name: test_get_build_dirs[mock_repo4]
+  list([
+  ])
+# ---
+
+
+
+
+
+
+# name: test_get_build_dirs[mock_repo0]
+  list([
+    PosixPath('.'),
+  ])
+# ---

tests/slsa_analyzer/build_tool/mock_repos/docker_repos/nested_dockerfile/project/Dockerfile

@@ -0,0 +1,7 @@
+# Copyright (c) 2023 - 2023, Oracle and/or its affiliates. All rights reserved.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/.
+
+# syntax=docker/dockerfile:1
+
+FROM node:18-alpine
+CMD ["echo", "Hello!"]

tests/slsa_analyzer/build_tool/mock_repos/docker_repos/root_dockerfile/Dockerfile

@@ -0,0 +1,7 @@
+# Copyright (c) 2023 - 2023, Oracle and/or its affiliates. All rights reserved.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/.
+
+# syntax=docker/dockerfile:1
+
+FROM node:18-alpine
+CMD ["echo", "Hello!"]

tests/slsa_analyzer/build_tool/mock_repos/docker_repos/root_dockerfile_wildcard/Dockerfile.final

@@ -0,0 +1,7 @@
+# Copyright (c) 2023 - 2023, Oracle and/or its affiliates. All rights reserved.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/.
+
+# syntax=docker/dockerfile:1
+
+FROM node:18-alpine
+CMD ["echo", "Hello!"]

tests/slsa_analyzer/build_tool/mock_repos/docker_repos/root_wildcard_dockerfile/final.Dockerfile

@@ -0,0 +1,7 @@
+# Copyright (c) 2023 - 2023, Oracle and/or its affiliates. All rights reserved.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/.
+
+# syntax=docker/dockerfile:1
+
+FROM node:18-alpine
+CMD ["echo", "Hello!"]

tests/slsa_analyzer/build_tool/test_docker.py

@@ -0,0 +1,43 @@
+# Copyright (c) 2023 - 2023, Oracle and/or its affiliates. All rights reserved.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/.
+
+"""This module tests the Docker build functions."""
+
+from pathlib import Path
+
+import pytest
+
+from macaron.slsa_analyzer.build_tool.docker import Docker
+from tests.slsa_analyzer.mock_git_utils import prepare_repo_for_testing
+
+
+@pytest.mark.parametrize(
+    "mock_repo",
+    [
+        Path(__file__).parent.joinpath("mock_repos", "docker_repos", "root_dockerfile"),
+        Path(__file__).parent.joinpath("mock_repos", "docker_repos", "nested_dockerfile"),
+        Path(__file__).parent.joinpath("mock_repos", "docker_repos", "root_wildcard_dockerfile"),
+        Path(__file__).parent.joinpath("mock_repos", "docker_repos", "root_dockerfile_wildcard"),
+        Path(__file__).parent.joinpath("mock_repos", "docker_repos", "no_docker"),
+    ],
+)
+def test_get_build_dirs(snapshot: list, docker_tool: Docker, mock_repo: Path) -> None:
+    """Test discovering build directories."""
+    assert list(docker_tool.get_build_dirs(str(mock_repo))) == snapshot
+
+
+@pytest.mark.parametrize(
+    ("mock_repo", "expected_value"),
+    [
+        (Path(__file__).parent.joinpath("mock_repos", "docker_repos", "root_dockerfile"), True),
+        (Path(__file__).parent.joinpath("mock_repos", "docker_repos", "nested_dockerfile"), True),
+        (Path(__file__).parent.joinpath("mock_repos", "docker_repos", "root_wildcard_dockerfile"), True),
+        (Path(__file__).parent.joinpath("mock_repos", "docker_repos", "root_dockerfile_wildcard"), True),
+        (Path(__file__).parent.joinpath("mock_repos", "docker_repos", "no_docker"), False),
+    ],
+)
+def test_docker_build_tool(docker_tool: Docker, macaron_path: str, mock_repo: str, expected_value: bool) -> None:
+    """Test the Gradle build tool."""
+    base_dir = Path(__file__).parent
+    ctx = prepare_repo_for_testing(mock_repo, macaron_path, base_dir)
+    assert docker_tool.is_detected(ctx.component.repository.fs_path) == expected_value