Files
akyldash/infra/deploy/test_release_manifest.py

170 lines
8.2 KiB
Python

import json
import os
import shutil
import subprocess
import tempfile
import unittest
from pathlib import Path
from create_release_manifest import create
from validate_release import validate_manifest
ROOT = Path(__file__).resolve().parents[2]
REPOSITORIES = {
"backend": ["git.vakanaut.ru/admin/akyldash/backend"],
"opensearch": ["git.vakanaut.ru/admin/akyldash/opensearch"],
}
BUILDER = {"name": "Kaniko", "image": "ghcr.io/osscontainertools/kaniko:v1.28.5-debug@sha256:c73ca67a3b494bce79a8fb6090c4f73c18997ab272d80bffc460a62343aeb412"}
class ReleaseManifestTests(unittest.TestCase):
def setUp(self):
self.policy = {"schema_version": 1, "repositories": REPOSITORIES}
self.manifest = {
"schema_version": 4,
"source_ref": "refs/heads/main",
"repository": "admin/akyldash",
"commit": "a" * 40,
"workflow": ".gitea/workflows/release-images.yaml",
"run_id": "49",
"source_run_id": "48",
"builder": BUILDER,
"images": {
"backend": "git.vakanaut.ru/admin/akyldash/backend@sha256:" + "b" * 64,
"opensearch": "git.vakanaut.ru/admin/akyldash/opensearch@sha256:" + "c" * 64,
},
}
def test_accepts_both_policy_pinned_images(self):
self.assertEqual(validate_manifest(self.manifest, self.policy), self.manifest)
def test_rejects_untrusted_ref(self):
self.manifest["source_ref"] = "refs/pull/12/head"
with self.assertRaisesRegex(ValueError, "source_ref"):
validate_manifest(self.manifest, self.policy)
def test_rejects_old_manifest_schema_with_unavailable_run_attempt(self):
self.manifest["schema_version"] = 2
with self.assertRaisesRegex(ValueError, "schema_version"):
validate_manifest(self.manifest, self.policy)
def test_rejects_tag_instead_of_digest(self):
self.manifest["images"]["backend"] = "git.vakanaut.ru/admin/akyldash/backend:latest"
with self.assertRaisesRegex(ValueError, "sha256"):
validate_manifest(self.manifest, self.policy)
def test_rejects_empty_image_reference(self):
self.manifest["images"]["backend"] = ""
with self.assertRaisesRegex(ValueError, "sha256"):
validate_manifest(self.manifest, self.policy)
def test_rejects_invalid_commit(self):
self.manifest["commit"] = "not-a-commit"
with self.assertRaisesRegex(ValueError, "commit"):
validate_manifest(self.manifest, self.policy)
def test_rejects_manifest_from_another_repository(self):
self.manifest["repository"] = "admin/other"
with self.assertRaisesRegex(ValueError, "repository must be admin/akyldash"):
validate_manifest(self.manifest, self.policy)
def test_rejects_repository_outside_policy(self):
self.manifest["images"]["backend"] = "git.vakanaut.ru/other/backend@sha256:" + "b" * 64
with self.assertRaisesRegex(ValueError, "not allowed"):
validate_manifest(self.manifest, self.policy)
def test_rejects_missing_or_extra_images(self):
self.manifest["images"].pop("opensearch")
with self.assertRaisesRegex(ValueError, "exactly backend and opensearch"):
validate_manifest(self.manifest, self.policy)
self.manifest["images"]["opensearch"] = "registry.invalid/akyldash/opensearch@sha256:" + "c" * 64
self.manifest["images"]["extra"] = "registry.invalid/akyldash/extra@sha256:" + "d" * 64
with self.assertRaisesRegex(ValueError, "exactly backend and opensearch"):
validate_manifest(self.manifest, self.policy)
def test_rejects_duplicate_json_keys(self):
with tempfile.TemporaryDirectory() as directory:
manifest_path = Path(directory) / "manifest.json"
policy_path = Path(directory) / "policy.json"
manifest_path.write_text(
'{"schema_version":4,"source_ref":"refs/heads/main","repository":"admin/akyldash","commit":"' + "a" * 40
+ '","workflow":".gitea/workflows/release-images.yaml","run_id":"49","source_run_id":"48","builder":{},"images":{"backend":"first","backend":"second","opensearch":"third"}}',
encoding="utf-8",
)
policy_path.write_text(json.dumps(self.policy), encoding="utf-8")
command = [
"python3", str(ROOT / "infra/deploy/validate_release.py"), str(manifest_path),
"--policy", str(policy_path),
]
result = subprocess.run(command, text=True, capture_output=True)
self.assertEqual(result.returncode, 1)
self.assertIn("duplicate JSON key: backend", result.stderr)
def test_rejects_malformed_json(self):
with tempfile.TemporaryDirectory() as directory:
manifest_path = Path(directory) / "manifest.json"
policy_path = Path(directory) / "policy.json"
manifest_path.write_text('{"schema_version":', encoding="utf-8")
policy_path.write_text(json.dumps(self.policy), encoding="utf-8")
result = subprocess.run(
["python3", str(ROOT / "infra/deploy/validate_release.py"), str(manifest_path), "--policy", str(policy_path)],
text=True,
capture_output=True,
)
self.assertEqual(result.returncode, 1)
self.assertIn("cannot read valid JSON", result.stderr)
@unittest.skipUnless(shutil.which("docker"), "Docker CLI is unavailable")
def test_compose_override_renders_digest_images_and_preserves_build(self):
backend = "git.vakanaut.ru/admin/akyldash/backend@sha256:" + "b" * 64
opensearch = "git.vakanaut.ru/admin/akyldash/opensearch@sha256:" + "c" * 64
with tempfile.TemporaryDirectory() as directory:
temp = Path(directory)
secret = temp / "review_secret"
secret.touch()
override = temp / "release-override.json"
override.write_text(json.dumps({"services": {
"backend": {"image": backend},
"opensearch": {"image": opensearch},
}}), encoding="utf-8")
command = [
"docker", "compose", "--env-file", str(ROOT / "deploy/production/.env.example"),
"-f", str(ROOT / "deploy/production/compose.yaml"), "-f", str(override),
"config", "--format", "json",
]
result = subprocess.run(
command, text=True, capture_output=True,
env={**os.environ, "REVIEW_SECRET_FILE": str(secret)},
)
self.assertEqual(result.returncode, 0, result.stderr)
services = json.loads(result.stdout)["services"]
self.assertEqual(services["backend"]["image"], backend)
self.assertEqual(services["opensearch"]["image"], opensearch)
self.assertIn("build", services["backend"])
self.assertIn("build", services["opensearch"])
def test_creates_commit_and_builder_traceability_from_kaniko_digests(self):
with tempfile.TemporaryDirectory() as directory:
backend, opensearch = Path(directory) / "backend", Path(directory) / "opensearch"
backend.write_text("sha256:" + "b" * 64, encoding="ascii")
opensearch.write_text("sha256:" + "c" * 64, encoding="ascii")
result = create("admin/akyldash", "a" * 40, "48", "49", backend, opensearch)
self.assertEqual(validate_manifest(result, self.policy), result)
self.assertEqual(result["workflow"], ".gitea/workflows/release-images.yaml")
self.assertEqual(result["builder"], BUILDER)
self.assertEqual(result["run_id"], "49")
self.assertEqual(result["source_run_id"], "48")
self.assertNotIn("run_attempt", result)
def test_manifest_creation_rejects_missing_digest(self):
with tempfile.TemporaryDirectory() as directory:
backend, opensearch = Path(directory) / "backend", Path(directory) / "opensearch"
backend.write_text("", encoding="ascii")
opensearch.write_text("sha256:" + "c" * 64, encoding="ascii")
with self.assertRaisesRegex(ValueError, "invalid Kaniko digest"):
create("admin/akyldash", "a" * 40, "48", "49", backend, opensearch)
if __name__ == "__main__":
unittest.main()