harbor/tests/apitests/python/test_notation_sign_artifact.py
Yang Jiao 4d2a8fbcf6
[cherry-pick]Add notation sign artifact API test case (#19550)
Add notation sign artifact  API test case

Fix #19545

Signed-off-by: Yang Jiao <jiaoya@vmware.com>
2023-11-07 08:32:16 +00:00

95 lines
4.2 KiB
Python

# -*- coding: utf-8 -*-
from __future__ import absolute_import
import unittest
from testutils import harbor_server, suppress_urllib3_warning
from library import notation
from testutils import ADMIN_CLIENT
from library.project import Project
from library.user import User
from library.repository import Repository
from library.repository import push_self_build_image_to_project
from library import docker_api
from library.artifact import Artifact
class TestNotation(unittest.TestCase):
@suppress_urllib3_warning
def setUp(self):
self.project= Project()
self.user= User()
self.artifact = Artifact()
self.repo = Repository()
self.image = "hello-world"
self.tag = "latest"
self.expect_accessory_type = "signature.notation"
def testNotationArtifact(self):
"""
Test case:
Notation Artifact
Test step and expected result:
1. Create a new user(UA);
2. Create a new project(PA) by user(UA);
3. Push a new image(IA) in project(PA) by user(UA);
4. Verify that the image (IA) is not signed by notation;
5. Sign image(IA) with notation;
6. Verify that the image (IA) is signed by notation;
"""
url = ADMIN_CLIENT["endpoint"]
user_password = "Aa123456"
# 1. Create user(UA)
_, user_name = self.user.create_user(user_password = user_password, **ADMIN_CLIENT)
user_client = dict(endpoint = url, username = user_name, password = user_password, with_accessory = True)
# 2. Create private project(PA) by user(UA)
_, project_name = self.project.create_project(metadata = {"public": "false"}, **user_client)
# 3. Push a new image(IA) in project(PA) by user(UA)
push_self_build_image_to_project(project_name, harbor_server, user_name, user_password, self.image, self.tag)
# 4.1. Verify list_artifacts API
artifact_list = self.artifact.list_artifacts(project_name, self.image, **user_client)
first_artifact = artifact_list[0]
artifact_reference = first_artifact.digest
self.assertTrue(len(artifact_list) == 1)
self.assertIsNone(artifact_list[0].accessories)
# 4.2. Verify get_reference_info API
artifact_info = self.artifact.get_reference_info(project_name, self.image, artifact_reference, **user_client)
self.assertIsNone(artifact_info.accessories)
# 4.3. Verify list_accessories API
accessory_list = self.artifact.list_accessories(project_name, self.image, artifact_reference, **user_client)
self.assertTrue(len(accessory_list) == 0)
# 5.1. Generate notation cert;
notation.generate_cert()
# 5.2. Generate cosign key pair;
docker_api.docker_login_cmd(harbor_server, user_name, user_password, enable_manifest = False)
notation.sign_artifact("{}/{}/{}:{}".format(harbor_server, project_name, self.image, self.tag))
# 6.1. Verify list_artifacts API;
artifact_list = self.artifact.list_artifacts(project_name, self.image, **user_client)
self.assertTrue(len(artifact_list) == 1)
first_artifact = artifact_list[0]
self.assertTrue(len(first_artifact.accessories) == 1)
first_accessory = first_artifact.accessories[0]
self.assertEqual(first_accessory.type, self.expect_accessory_type)
accessory_reference = first_accessory.digest
# 6.2. Verify get_reference_info API;
artifact_info = self.artifact.get_reference_info(project_name, self.image, artifact_reference, **user_client)
self.assertEqual(artifact_info.accessories[0].type, self.expect_accessory_type)
# 6.3. Verify list_accessories API;
accessory_list = self.artifact.list_accessories(project_name, self.image, artifact_reference, **user_client)
self.assertTrue(len(accessory_list) == 1)
self.assertEqual(accessory_list[0].type, self.expect_accessory_type)
# 6.4. Verify list_accessories API;
accessory_info = self.artifact.get_reference_info(project_name, self.image, accessory_reference, **user_client)
self.assertEqual(accessory_info.digest, accessory_reference)
if __name__ == '__main__':
unittest.main()