Skip to content

Commit

Permalink
WIP: ZDU finalize Collection Version sha256
Browse files Browse the repository at this point in the history
[noissue]
  • Loading branch information
mdellweg committed Oct 24, 2024
1 parent 0b6280d commit 534cd73
Show file tree
Hide file tree
Showing 7 changed files with 74 additions and 77 deletions.
7 changes: 7 additions & 0 deletions CHANGES/+sha256_uniqueness.removal
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Added the final migration to make the sha256 of the collection version artifact the uniqueness
constraint. This allows users to serve their own interpretation of the content in their private
repositories.
The migration will only succeed if all the content has been adjusted. To account for content that
was not migrated by the migration shipped with 0.22.0, you can run the content repair command
``datarepair-ansible-collection-sha256`` prior to upgrading.
This version removed the content repair command.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Generated by Django 3.2.14 on 2022-07-21 23:05

from django.db import migrations, models
from pulpcore.plugin.migrations import RequireVersion


class Migration(migrations.Migration):

dependencies = [
('ansible', '0057_collectionversion_sha256_migrate'),
('core', '0110_apiappstatus'),
]

operations = [
# TODO adjust this version!!!
RequireVersion("ansible", "0.22.0"),
migrations.AlterField(
model_name='collectionversion',
name='sha256',
field=models.CharField(db_index=True, max_length=64, null=False),
),
migrations.AlterUniqueTogether(
name='collectionversion',
unique_together={('sha256',)},
),
]
4 changes: 2 additions & 2 deletions pulp_ansible/app/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ class CollectionVersion(Content):
namespace = models.CharField(max_length=64, editable=False)
repository = models.CharField(default="", blank=True, max_length=2000, editable=False)
requires_ansible = models.CharField(null=True, max_length=255)
sha256 = models.CharField(max_length=64, null=True, blank=False)
sha256 = models.CharField(max_length=64, db_index=True, null=False, blank=False)

version = models.CharField(max_length=128, db_collation="pulp_ansible_semver")
version_major = models.IntegerField()
Expand Down Expand Up @@ -231,7 +231,7 @@ def __str__(self):

class Meta:
default_related_name = "%(app_label)s_%(model_name)s"
unique_together = (("namespace", "name", "version"), ("sha256",))
unique_together = ("sha256",)
constraints = [
UniqueConstraint(
fields=("collection", "is_highest"),
Expand Down
20 changes: 1 addition & 19 deletions pulp_ansible/app/serializers.py
Original file line number Diff line number Diff line change
Expand Up @@ -518,30 +518,12 @@ def deferred_validate(self, data):
# repository field clashes
collection_info["origin_repository"] = collection_info.pop("repository", None)
data.update(collection_info)
# `retrieve` needs artifact, but it won't be in validated_data because of `get_artifacts`
self.context["artifact"] = artifact

return data

def retrieve(self, validated_data):
"""Reuse existing CollectionVersion if provided artifact matches."""
namespace = validated_data["namespace"]
name = validated_data["name"]
version = validated_data["version"]
artifact = self.context["artifact"]
# TODO switch this check to use digest when ColVersion uniqueness constraint is changed
col = CollectionVersion.objects.filter(
namespace=namespace, name=name, version=version
).first()
if col:
if col._artifacts.get() != artifact:
raise ValidationError(
_("Collection {}.{}-{} already exists with a different artifact").format(
namespace, name, version
)
)

return col
return CollectionVersion.objects.filter(sha256=validated_data["sha256"]).first()

def create(self, validated_data):
"""Final step in creating the CollectionVersion."""
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
"""Tests related to sync ansible plugin collection content type."""

import hashlib
from pathlib import Path

import pytest

from orionutils.generator import randstr
Expand Down Expand Up @@ -100,3 +103,32 @@ def test_content_unit_lifecycle(ansible_bindings, build_and_upload_collection, m
ansible_bindings.ContentCollectionVersionsApi.create(file=collection_artifact.filename).task
)
assert content_unit_href in create_task.created_resources


@pytest.mark.parallel
def test_duplicate_collection_key(
ansible_bindings,
ansible_repo_factory,
build_and_upload_collection,
monitor_task,
):
"""Create two content units with the same name but different artifacts."""
repository1 = ansible_repo_factory()
repository2 = ansible_repo_factory()

attrs = {"namespace": randstr(), "name": "squeezer", "version": "0.0.9"}
collection_artifact1, content_unit_href1 = build_and_upload_collection(
repository1, config=attrs
)
collection_artifact2, content_unit_href2 = build_and_upload_collection(
repository2, config=attrs
)

sha256_1 = hashlib.sha256(Path(collection_artifact1.filename).read_bytes()).hexdigest()
sha256_2 = hashlib.sha256(Path(collection_artifact2.filename).read_bytes()).hexdigest()
assert sha256_1 != sha256_2

content_unit_1 = ansible_bindings.ContentCollectionVersionsApi.read(content_unit_href1)
assert content_unit_1.sha256 == sha256_1
content_unit_2 = ansible_bindings.ContentCollectionVersionsApi.read(content_unit_href2)
assert content_unit_2.sha256 == sha256_2
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,9 @@ def test_collection_version_sha256_migrate(migrate):

cv = CollectionVersion.objects.get(pk=cv.pk)
assert cv.sha256 == "SENTINEL"

apps = migrate([("ansible", "0058_collectionversion_unique_sha256")])
CollectionVersion = apps.get_model("ansible", "CollectionVersion")

cv = CollectionVersion.objects.get(pk=cv.pk)
assert cv.sha256 == "SENTINEL"

0 comments on commit 534cd73

Please sign in to comment.