Files

126 lines
5.9 KiB
Python

import json
import subprocess
import sys
import tempfile
import unittest
from types import SimpleNamespace
from unittest.mock import patch
import rollback
import deployment_lock
import release_refs
import release_state
from rollback import (
image_restore_plan,
require_running_image_ids,
require_tag_rollback,
tag_previous_images,
verify_previous_images,
)
class RollbackPlanTests(unittest.TestCase):
def setUp(self):
self.manifest = {
"images": {
"backend": {"configured": "akyldash/backend:local", "image_id": "sha256:" + "a" * 64},
"opensearch": {"configured": "akyldash/opensearch:local", "image_id": "sha256:" + "b" * 64},
}
}
self.configured = {
"backend": "akyldash/backend:local",
"opensearch": "akyldash/opensearch:local",
}
def test_plans_only_recorded_local_images(self):
plan = image_restore_plan(self.manifest, self.configured)
self.assertEqual(plan["backend"][1], "akyldash/backend:local")
self.assertEqual(plan["opensearch"][1], "akyldash/opensearch:local")
def test_rollback_rejects_running_images_that_differ_from_restore_plan(self):
expected = {"backend": "sha256:" + "a" * 64, "opensearch": "sha256:" + "b" * 64}
actual = {**expected, "opensearch": "sha256:" + "c" * 64}
with self.assertRaisesRegex(ValueError, "rollback plan"):
require_running_image_ids(expected, actual, "rollback plan")
def test_refuses_changed_compose_image_reference(self):
with self.assertRaisesRegex(ValueError, "reference changed"):
image_restore_plan(self.manifest, {**self.configured, "backend": "other/backend:tag"})
def test_release_state_allows_guarded_digest_to_legacy_and_legacy_to_digest_restore(self):
previous = self.manifest["images"].copy()
self.configured["backend"] = "registry/backend@sha256:" + "d" * 64
plan = image_restore_plan(self.manifest, self.configured, previous)
self.assertEqual(plan["backend"][1], "akyldash/backend:local")
old_digest = "registry/backend@sha256:" + "c" * 64
self.manifest["images"]["backend"] = {
"configured": old_digest, "image_id": "sha256:" + "a" * 64
}
previous["backend"] = self.manifest["images"]["backend"]
self.configured["backend"] = "akyldash/backend:local"
plan = image_restore_plan(self.manifest, self.configured, previous)
self.assertEqual(plan["backend"][1], old_digest)
def test_refuses_digest_reference_that_cannot_be_retagged(self):
self.manifest["images"]["backend"]["configured"] = "registry/backend@sha256:" + "c" * 64
self.configured["backend"] = self.manifest["images"]["backend"]["configured"]
plan = image_restore_plan(self.manifest, self.configured)
self.assertEqual(plan["backend"], ("sha256:" + "a" * 64, self.configured["backend"]))
with self.assertRaisesRegex(ValueError, "not supported safely"):
require_tag_rollback(plan)
def test_refuses_malformed_digest_reference(self):
self.manifest["images"]["backend"]["configured"] = "registry/backend@sha256:xyz"
self.configured["backend"] = self.manifest["images"]["backend"]["configured"]
with self.assertRaisesRegex(ValueError, "invalid image reference"):
image_restore_plan(self.manifest, self.configured)
def test_refuses_invalid_recorded_image_id(self):
self.manifest["images"]["backend"]["image_id"] = "sha256:not-a-digest"
with self.assertRaisesRegex(ValueError, "invalid previous image ID"):
image_restore_plan(self.manifest, self.configured)
def test_digest_reference_must_resolve_to_recorded_image_id(self):
digest = "registry/backend@sha256:" + "c" * 64
self.manifest["images"]["backend"]["configured"] = digest
self.configured["backend"] = digest
plan = image_restore_plan(self.manifest, self.configured)
with patch("rollback.run", side_effect=["sha256:" + "a" * 64, "sha256:" + "a" * 64,
"sha256:" + "b" * 64]):
verify_previous_images(plan)
with patch("rollback.run", side_effect=["sha256:" + "a" * 64, "sha256:" + "d" * 64]):
with self.assertRaisesRegex(ValueError, "does not match its recorded image"):
verify_previous_images(plan)
def test_missing_previous_image_fails_closed(self):
plan = image_restore_plan(self.manifest, self.configured)
with patch("rollback.run", side_effect=subprocess.CalledProcessError(1, "docker")):
with self.assertRaisesRegex(ValueError, "previous image is unavailable"):
verify_previous_images(plan)
def test_digest_reference_is_restored_without_retagging(self):
digest = "registry/backend@sha256:" + "c" * 64
plan = {"backend": ("sha256:" + "a" * 64, digest)}
with patch("rollback.run") as run_mock:
tag_previous_images(plan)
run_mock.assert_not_called()
def test_local_vps_backup_path_is_disabled_without_docker_operations(self):
with patch("rollback.compose") as compose_mock, patch("rollback.run") as run_mock:
with self.assertRaisesRegex(ValueError, "local VPS backup paths are disabled"):
rollback.rollback(rollback.Path("/var/backups/akyldash/old.tar.gz"), data_compatible=True)
compose_mock.assert_not_called()
run_mock.assert_not_called()
def test_tag_rollback_keeps_existing_image_tag_operation(self):
plan = image_restore_plan(self.manifest, self.configured)
with patch("rollback.run") as run_mock:
tag_previous_images(plan)
self.assertEqual(run_mock.call_count, 2)
run_mock.assert_any_call(["docker", "image", "tag", "sha256:" + "a" * 64,
"akyldash/backend:local"])
if __name__ == "__main__":
unittest.main()