actions/validate-inputs/tests/test_docker_validator.py

"""Tests for the DockerValidator module."""

import sys
from pathlib import Path

# Add the parent directory to the path
sys.path.insert(0, str(Path(__file__).parent.parent))

from validators.docker import DockerValidator


class TestDockerValidator:
    """Test cases for DockerValidator."""

    def setup_method(self):
        """Set up test environment."""
        self.validator = DockerValidator()

    def test_initialization(self):
        """Test validator initialization."""
        assert self.validator.errors == []
        rules = self.validator.get_validation_rules()
        assert "image_name" in rules
        assert "tag" in rules
        assert "architectures" in rules

    def test_validate_docker_image_valid(self):
        """Test Docker image name validation with valid names.

        Tests comprehensive Docker image name formats including simple names,
        names with separators, and full registry paths.
        """
        valid_names = [
            # Simple names
            "myapp",
            "app123",
            "nginx",
            "ubuntu",
            "node",
            "python",
            # Names with separators
            "my-app",
            "my_app",
            "my.app",  # Dots allowed (regression test for \. fix)
            "my-app_v2",  # Mixed separators
            "app.with.dots",  # Multiple dots in image name (regression test)
            # Registry paths (dots in domain names)
            "registry.example.com/myapp",  # Registry with dots and namespace
            "docker.io/library/nginx",  # Multi-part registry path
            "ghcr.io/owner/repo",  # GitHub Container Registry
            "gcr.io/project-id/image",  # Google Container Registry
            "quay.io/organization/app",  # Quay.io registry
            "harbor.example.com/project/image",  # Harbor registry
            "nexus.company.local/docker/app",  # Nexus registry
            # Complex paths with dots
            "my.registry.local/app.name",  # Dots in both registry and image
            "registry.example.com/namespace/app.name",  # Complex path with dots
            "gcr.io/my-project/my.app.name",  # GCR with dots in image
            # Multiple namespace levels
            "registry.io/org/team/project/app",  # Deep namespace hierarchy
        ]

        for name in valid_names:
            self.validator.errors = []
            result = self.validator.validate_docker_image_name(name)
            assert result is True, f"Should accept image name: {name}"

    def test_validate_docker_image_invalid(self):
        """Test Docker image name validation with invalid names."""
        invalid_names = [
            # Uppercase not allowed
            "MyApp",
            "NGINX",
            "Ubuntu",
            # Spaces not allowed
            "my app",
            "app name",
            # Invalid separators/positions
            "-myapp",  # Leading dash
            "myapp-",  # Trailing dash
            "_myapp",  # Leading underscore
            "myapp_",  # Trailing underscore
            ".myapp",  # Leading dot
            "myapp.",  # Trailing dot
            # Note: Double dash (app--name) and double underscore (app__name) are allowed by Docker
            # Invalid paths
            "/myapp",  # Leading slash
            "myapp/",  # Trailing slash
            "registry/",  # Trailing slash after registry
            "/registry/app",  # Leading slash
            "registry//app",  # Double slash
            # Special characters
            "app@latest",  # @ not allowed in name
            "app:tag",  # : not allowed in name
            "app#1",  # # not allowed
            "app$name",  # $ not allowed
            # Empty or whitespace
            "",  # Empty (may be optional)
            "   ",  # Whitespace only
        ]

        for name in invalid_names:
            self.validator.errors = []
            result = self.validator.validate_docker_image_name(name)
            if name == "" or name.strip() == "":  # Empty might be allowed (optional field)
                assert isinstance(result, bool), f"Empty/whitespace handling for: {name}"
            else:
                assert result is False, f"Should reject image name: {name}"

    def test_validate_docker_tag_valid(self):
        """Test Docker tag validation with valid tags."""
        valid_tags = [
            "latest",
            "v1.0.0",
            "1.0.0",
            "main",
            "master",
            "develop",
            "feature-branch",
            "release-1.0",
            "2024.3.1",
            "alpha",
            "beta",
            "rc1",
            "stable",
            "edge",
        ]

        for tag in valid_tags:
            self.validator.errors = []
            result = self.validator.validate_docker_tag(tag)
            assert result is True, f"Should accept tag: {tag}"

    def test_validate_docker_tag_invalid(self):
        """Test Docker tag validation with invalid tags."""
        invalid_tags = [
            "",  # Empty tag
            "my tag",  # Space not allowed
            "tag@latest",  # @ not allowed
            "tag#1",  # # not allowed
            ":tag",  # Leading colon
            "tag:",  # Trailing colon
        ]

        for tag in invalid_tags:
            self.validator.errors = []
            result = self.validator.validate_docker_tag(tag)
            # Some characters might be valid in Docker tags depending on implementation
            if tag == "" or " " in tag:
                assert result is False, f"Should reject tag: {tag}"
            else:
                # Other tags might be valid depending on Docker's rules
                assert isinstance(result, bool)

    def test_validate_architectures_valid(self):
        """Test architecture validation with valid values."""
        valid_archs = [
            "linux/amd64",
            "linux/arm64",
            "linux/arm/v7",
            "linux/arm/v6",
            "linux/386",
            "linux/ppc64le",
            "linux/s390x",
            "linux/amd64,linux/arm64",  # Multiple architectures
            "linux/amd64,linux/arm64,linux/arm/v7",  # Three architectures
        ]

        for arch in valid_archs:
            self.validator.errors = []
            result = self.validator.validate_architectures(arch)
            assert result is True, f"Should accept architecture: {arch}"

    def test_validate_architectures_invalid(self):
        """Test architecture validation with invalid values."""
        invalid_archs = [
            "windows/amd64",  # Windows not typically supported in Docker build
            "linux/invalid",  # Invalid architecture
            "amd64",  # Missing OS prefix
            "linux",  # Missing architecture
            "linux/",  # Incomplete
            "/amd64",  # Missing OS
            "linux/amd64,",  # Trailing comma
            ",linux/arm64",  # Leading comma
        ]

        for arch in invalid_archs:
            self.validator.errors = []
            result = self.validator.validate_architectures(arch)
            assert result is False, f"Should reject architecture: {arch}"

    def test_validate_namespace_with_lookahead_valid(self):
        """Test namespace validation with lookahead."""
        valid_namespaces = [
            "user",
            "my-org",
            "company123",
            "docker",
            "library",
            "test-namespace",
            "a" * 30,  # Long but valid
        ]

        for namespace in valid_namespaces:
            self.validator.errors = []
            result = self.validator.validate_namespace_with_lookahead(namespace)
            assert result is True, f"Should accept namespace: {namespace}"

    def test_validate_namespace_with_lookahead_invalid(self):
        """Test namespace validation with invalid values."""
        invalid_namespaces = [
            "",  # Empty
            "user-",  # Trailing dash
            "-user",  # Leading dash
            "user--name",  # Double dash
            "User",  # Uppercase
            "user name",  # Space
            "a" * 256,  # Too long
        ]

        for namespace in invalid_namespaces:
            self.validator.errors = []
            result = self.validator.validate_namespace_with_lookahead(namespace)
            if namespace == "":
                # Empty might be allowed
                assert isinstance(result, bool)
            else:
                assert result is False, f"Should reject namespace: {namespace}"

    def test_validate_prefix_valid(self):
        """Test prefix validation with valid values."""
        valid_prefixes = [
            "",  # Empty prefix is often valid
            "v",
            "version-",
            "release-",
            "tag_",
            "prefix.",
            "1.0.",
        ]

        for prefix in valid_prefixes:
            self.validator.errors = []
            result = self.validator.validate_prefix(prefix)
            assert result is True, f"Should accept prefix: {prefix}"

    def test_validate_prefix_invalid(self):
        """Test prefix validation with invalid values."""
        invalid_prefixes = [
            "pre fix",  # Space not allowed
            "prefix@",  # @ not allowed
            "prefix#",  # # not allowed
            "prefix:",  # : not allowed
        ]

        for prefix in invalid_prefixes:
            self.validator.errors = []
            result = self.validator.validate_prefix(prefix)
            assert result is False, f"Should reject prefix: {prefix}"

    def test_validate_inputs_docker_keywords(self):
        """Test validation of inputs with Docker-related keywords."""
        inputs = {
            "image": "myapp",
            "tag": "v1.0.0",
            "dockerfile": "Dockerfile",
            "context": ".",
            "platforms": "linux/amd64,linux/arm64",
            "registry": "docker.io",
            "namespace": "myorg",
            "prefix": "v",
        }

        result = self.validator.validate_inputs(inputs)
        assert isinstance(result, bool)

    def test_validate_registry_valid(self):
        """Test registry enum validation with valid values."""
        valid_registries = [
            "dockerhub",
            "github",
            "both",
        ]

        for registry in valid_registries:
            self.validator.errors = []
            result = self.validator.validate_registry(registry)
            assert result is True, f"Should accept registry: {registry}"

    def test_validate_registry_invalid(self):
        """Test registry enum validation with invalid values."""
        invalid_registries = [
            "",  # Empty
            "   ",  # Whitespace only
            "docker",  # Wrong value (should be dockerhub)
            "hub",  # Wrong value
            "ghcr",  # Wrong value
            "gcr",  # Wrong value
            "both,github",  # Comma-separated not allowed
            "DOCKERHUB",  # Uppercase
            "DockerHub",  # Mixed case
            "docker hub",  # Space
            "github.com",  # Full URL not allowed
        ]

        for registry in invalid_registries:
            self.validator.errors = []
            result = self.validator.validate_registry(registry)
            assert result is False, f"Should reject registry: {registry}"

    def test_validate_sbom_format_valid(self):
        """Test SBOM format validation with valid values."""
        valid_formats = [
            "spdx-json",
            "cyclonedx-json",
            "",  # Empty is optional
        ]

        for sbom_format in valid_formats:
            self.validator.errors = []
            result = self.validator.validate_sbom_format(sbom_format)
            assert result is True, f"Should accept SBOM format: {sbom_format}"

    def test_validate_sbom_format_invalid(self):
        """Test SBOM format validation with invalid values."""
        invalid_formats = [
            "spdx",  # Missing -json suffix
            "cyclonedx",  # Missing -json suffix
            "json",  # Just json
            "spdx-xml",  # Wrong format
            "cyclonedx-xml",  # Wrong format
            "SPDX-JSON",  # Uppercase
            "spdx json",  # Space
            "invalid",  # Invalid value
        ]

        for sbom_format in invalid_formats:
            self.validator.errors = []
            result = self.validator.validate_sbom_format(sbom_format)
            assert result is False, f"Should reject SBOM format: {sbom_format}"

    def test_empty_values_handling(self):
        """Test that empty values are handled appropriately."""
        # Some Docker fields might be required, others optional
        assert isinstance(self.validator.validate_docker_image_name(""), bool)
        assert isinstance(self.validator.validate_docker_tag(""), bool)
        assert isinstance(self.validator.validate_architectures(""), bool)
        assert isinstance(self.validator.validate_prefix(""), bool)
        # Registry should reject empty values
        assert self.validator.validate_registry("") is False