| 1 |
from __future__ import absolute_import, division, print_function |
| 2 |
|
| 3 |
__metaclass__ = type |
| 4 |
|
| 5 |
import pytest |
| 6 |
|
| 7 |
from ansible_collections.containers.podman.plugins.module_utils.podman.podman_image_lib import ImageRepository |
| 8 |
|
| 9 |
|
| 10 |
class TestImageRepository: |
| 11 |
"""Unit tests for ImageRepository class - specifically testing issue #947 fix.""" |
| 12 |
|
| 13 |
@pytest.mark.parametrize( |
| 14 |
"name, tag, expected_full_name, expected_delimiter, description", |
| 15 |
[ |
| 16 |
# Issue #947 scenario: tag with version and digest should use : delimiter |
| 17 |
( |
| 18 |
"docker.io/valkey/valkey", |
| 19 |
"8-bookworm@sha256:fec42f399876eb6faf9e008570597741c87ff7662a54185593e74b09ce83d177", |
| 20 |
"docker.io/valkey/valkey:8-bookworm@sha256:fec42f399876eb6faf9e008570597741c87ff7662a54185593e74b09ce83d177", |
| 21 |
":", |
| 22 |
"Issue #947 - version@digest should use : delimiter", |
| 23 |
), |
| 24 |
# Pure digest should use @ delimiter |
| 25 |
( |
| 26 |
"docker.io/library/alpine", |
| 27 |
"sha256:abc123def456abc123def456abc123def456abc123def456abc123def456abc1", |
| 28 |
"docker.io/library/alpine@sha256:abc123def456abc123def456abc123def456abc123def456abc123def456abc1", |
| 29 |
"@", |
| 30 |
"Pure digest should use @ delimiter", |
| 31 |
), |
| 32 |
# Regular tag should use : delimiter |
| 33 |
( |
| 34 |
"docker.io/library/alpine", |
| 35 |
"3.19", |
| 36 |
"docker.io/library/alpine:3.19", |
| 37 |
":", |
| 38 |
"Regular tag should use : delimiter", |
| 39 |
), |
| 40 |
# Another version@digest combination |
| 41 |
( |
| 42 |
"quay.io/prometheus/prometheus", |
| 43 |
"v2.45.0@sha256:8d1dca1de3c9b6ba49e0e3a87e8e57c8fcb2e36e6f165f8969c0c9a48a80a9a2", |
| 44 |
"quay.io/prometheus/prometheus:v2.45.0@sha256:8d1dca1de3c9b6ba49e0e3a87e8e57c8fcb2e36e6f165f8969c0c9a48a80a9a2", |
| 45 |
":", |
| 46 |
"Complex registry with version@digest should use : delimiter", |
| 47 |
), |
| 48 |
# Edge case: tag starts with sha256 but is not pure digest |
| 49 |
( |
| 50 |
"docker.io/library/alpine", |
| 51 |
"sha256tag-v1.0", |
| 52 |
"docker.io/library/alpine:sha256tag-v1.0", |
| 53 |
":", |
| 54 |
"Tag starting with sha256 but not pure digest should use : delimiter", |
| 55 |
), |
| 56 |
# Default latest tag |
| 57 |
("alpine", "latest", "alpine:latest", ":", "Default latest tag should use : delimiter"), |
| 58 |
# Registry with port |
| 59 |
( |
| 60 |
"localhost:5000/test/image", |
| 61 |
"v1.0@sha256:deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef", |
| 62 |
"localhost:5000/test/image:v1.0@sha256:deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef", |
| 63 |
":", |
| 64 |
"Registry with port and version@digest should use : delimiter", |
| 65 |
), |
| 66 |
# Pure short digest |
| 67 |
("alpine", "sha256:abc123", "alpine@sha256:abc123", "@", "Short pure digest should use @ delimiter"), |
| 68 |
], |
| 69 |
) |
| 70 |
def test_image_repository_delimiter_selection(self, name, tag, expected_full_name, expected_delimiter, description): |
| 71 |
"""Test that ImageRepository selects the correct delimiter for different tag formats.""" |
| 72 |
repo = ImageRepository(name, tag) |
| 73 |
|
| 74 |
assert ( |
| 75 |
repo.full_name == expected_full_name |
| 76 |
), f"{description}: Expected {expected_full_name}, got {repo.full_name}" |
| 77 |
assert ( |
| 78 |
repo.delimiter == expected_delimiter |
| 79 |
), f"{description}: Expected delimiter '{expected_delimiter}', got '{repo.delimiter}'" |
| 80 |
assert repo.name == name, f"Name should be preserved: Expected {name}, got {repo.name}" |
| 81 |
assert repo.tag == tag, f"Tag should be preserved: Expected {tag}, got {repo.tag}" |
| 82 |
|
| 83 |
def test_issue_947_specific_scenario(self): |
| 84 |
"""Test the exact scenario reported in issue #947.""" |
| 85 |
name = "docker.io/valkey/valkey" |
| 86 |
tag = "8-bookworm@sha256:fec42f399876eb6faf9e008570597741c87ff7662a54185593e74b09ce83d177" |
| 87 |
|
| 88 |
repo = ImageRepository(name, tag) |
| 89 |
|
| 90 |
# Before the fix, this would have been: |
| 91 |
# docker.io/valkey/valkey@8-bookworm@sha256:fec42f399876eb6faf9e008570597741c87ff7662a54185593e74b09ce83d177 |
| 92 |
# After the fix, it should be: |
| 93 |
# docker.io/valkey/valkey:8-bookworm@sha256:fec42f399876eb6faf9e008570597741c87ff7662a54185593e74b09ce83d177 |
| 94 |
|
| 95 |
expected = ( |
| 96 |
"docker.io/valkey/valkey:8-bookworm@sha256:fec42f399876eb6faf9e008570597741c87ff7662a54185593e74b09ce83d177" |
| 97 |
) |
| 98 |
assert ( |
| 99 |
repo.full_name == expected |
| 100 |
), f"Issue #947 fix verification failed. Expected: {expected}, Got: {repo.full_name}" |
| 101 |
|
| 102 |
def test_repository_parsing(self): |
| 103 |
"""Test that repository name parsing works correctly with various formats.""" |
| 104 |
test_cases = [ |
| 105 |
# (input_name, expected_name, expected_parsed_tag) |
| 106 |
("alpine", "alpine", None), |
| 107 |
("alpine:3.19", "alpine", "3.19"), |
| 108 |
("alpine@sha256:abc123", "alpine", "sha256:abc123"), |
| 109 |
("registry.io/alpine:latest", "registry.io/alpine", "latest"), |
| 110 |
("localhost:5000/test:v1.0", "localhost:5000/test", "v1.0"), |
| 111 |
] |
| 112 |
|
| 113 |
for input_name, expected_name, expected_parsed_tag in test_cases: |
| 114 |
repo = ImageRepository(input_name, "latest") # default tag |
| 115 |
assert ( |
| 116 |
repo.name == expected_name |
| 117 |
), f"Name parsing failed for {input_name}: Expected {expected_name}, got {repo.name}" |
| 118 |
assert ( |
| 119 |
repo.parsed_tag == expected_parsed_tag |
| 120 |
), f"Tag parsing failed for {input_name}: Expected {expected_parsed_tag}, got {repo.parsed_tag}" |
| 121 |
|
| 122 |
def test_delimiter_logic_precision(self): |
| 123 |
"""Test the precise logic for delimiter selection.""" |
| 124 |
# Test cases that specifically target the delimiter selection logic |
| 125 |
test_cases = [ |
| 126 |
# Tag that starts with sha256: should use @ |
| 127 |
("image", "sha256:abc123", "@"), |
| 128 |
# Tag that contains sha256 but doesn't start with sha256: should use : |
| 129 |
("image", "v1.0-sha256-abc123", ":"), |
| 130 |
("image", "release-sha256:abc123", ":"), |
| 131 |
("image", "sha256suffix", ":"), |
| 132 |
# Version followed by digest should use : |
| 133 |
("image", "1.0@sha256:abc123", ":"), |
| 134 |
("image", "latest@sha256:abc123", ":"), |
| 135 |
] |
| 136 |
|
| 137 |
for name, tag, expected_delimiter in test_cases: |
| 138 |
repo = ImageRepository(name, tag) |
| 139 |
assert ( |
| 140 |
repo.delimiter == expected_delimiter |
| 141 |
), f"Delimiter selection failed for tag '{tag}': Expected '{expected_delimiter}', got '{repo.delimiter}'" |
| 142 |
|
| 143 |
def test_original_name_preservation(self): |
| 144 |
"""Test that original_name is always preserved.""" |
| 145 |
test_cases = [ |
| 146 |
"alpine", |
| 147 |
"alpine:3.19", |
| 148 |
"alpine@sha256:abc123", |
| 149 |
"registry.io/namespace/image:tag", |
| 150 |
] |
| 151 |
|
| 152 |
for original in test_cases: |
| 153 |
repo = ImageRepository(original, "latest") |
| 154 |
assert ( |
| 155 |
repo.original_name == original |
| 156 |
), f"Original name not preserved: Expected {original}, got {repo.original_name}" |