Add more unit tests

Author: gpeacock

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "c2pa-python"
-version = "0.2.0"
+version = "0.2.1"
 edition = "2021"
 authors = ["Gavin Peacock <[email protected]"]
 

README.md

@@ -9,7 +9,7 @@ This library enables you to read and validate C2PA data in supported media files
 Install from PyPI by entering this command:
 
 ```
-pip install c2pa-python
+pip install -U c2pa-python
 ```
 
 ## Usage
@@ -19,15 +19,15 @@ pip install c2pa-python
 Import the C2PA module as follows:
 
 ```py
-import c2pa-python as c2pa
+import c2pa_python as c2pa
 ```
 
 ### Read and validate C2PA data in a file
 
 Use the `verify_from_file_json` function to read C2PA data from the specified file:
 
 ```py
-json_store = c2pa.verify_from_file_json("path/to/media_file.jpg", data_dir)
+json_store = c2pa.verify_from_file_json("path/to/media_file.jpg", "path/to/data_dir")
 ```
 
 This function examines the specified media file for C2PA data and generates a JSON report of any data it finds. If there are validation errors, the report includes a `validation_status` field.  For a summary of supported media types, see [Supported file formats](#supported-file-formats).
@@ -57,7 +57,7 @@ The parameters (in order) are:
 - `sign_info`, a `SignerInfo` object instance; see [Generating SignerInfo](#generating-signerinfo) below.
 - `data_dir` optionally specifies a directory path from which to load resource files referenced in the manifest JSON identifier fields; for example, thumbnails, icons, and manifest data for ingredients.
 
-### Generating SignerInfo
+### Create a SignerInfo Instance
 
 A `SignerInfo` object contains information about a signature.  To create an instance of `SignerInfo`, first set up the signer information from the public and private key `.pem` files as follows:
 

tests/example.py

@@ -0,0 +1,34 @@
+# Copyright 2023 Adobe. All rights reserved.
+# This file is licensed to you under the Apache License,
+# Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
+# or the MIT license (http://opensource.org/licenses/MIT),
+# at your option.
+# Unless required by applicable law or agreed to in writing,
+# this software is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR REPRESENTATIONS OF ANY KIND, either express or
+# implied. See the LICENSE-MIT and LICENSE-APACHE files for the
+# specific language governing permissions and limitations under
+# each license.
+
+# This example shows how to add a do not train assertion to an asset and then verify it
+
+import json
+import os
+import sys
+import c2pa_python as c2pa;
+
+# set up paths to the files we we are using
+PROJECT_PATH = os.getcwd()
+testFile = os.path.join(PROJECT_PATH,"tests","fixtures","A.jpg")
+pemFile = os.path.join(PROJECT_PATH,"tests","fixtures","es256_certs.pem")
+keyFile = os.path.join(PROJECT_PATH,"tests","fixtures","es256_private.key")
+testOutputFile = os.path.join(PROJECT_PATH,"target","dnt.jpg")
+
+# a little helper function to get a value from a nested dictionary
+from functools import reduce
+import operator
+def getitem(d, key):
+    return reduce(operator.getitem, key, d)
+
+print("version = " + c2pa.version())
+

tests/test_c2pa.py

@@ -13,9 +13,18 @@
 
 import c2pa_python as c2pa
 import pytest
+import json
+import tempfile
+import shutil
+
+# a little helper function to get a value from a nested dictionary
+from functools import reduce
+import operator
+def getitem(d, key):
+    return reduce(operator.getitem, key, d)
 
 def test_version():
-    assert c2pa.version() == "0.2.0"
+    assert c2pa.version() == "0.2.1"
 
 def test_sdk_version():
     assert c2pa.sdk_version() == "0.26.0"
@@ -29,4 +38,113 @@ def test_verify_from_file_no_store():
     with pytest.raises(c2pa.Error.Sdk) as err:  
         json_store = c2pa.verify_from_file_json("tests/fixtures/A.jpg", None) 
     assert str(err.value) == "no JUMBF data found"  
- 
+
+def test_verify_from_file_get_thumbnail():
+    with tempfile.TemporaryDirectory() as data_dir:
+        store_json = c2pa.verify_from_file_json("tests/fixtures/C.jpg", data_dir)
+        manifest_store = json.loads(store_json)
+        manifest = manifest_store["manifests"][manifest_store["active_manifest"]]
+        print (store_json)
+        assert "make_test_images" in manifest["claim_generator"]
+        assert manifest["title"]== "C.jpg"
+        assert manifest,["format"] == "image/jpeg"
+        # There should be no validation status errors
+        assert manifest.get("validation_status") == None
+        # read creative work assertion (author name)
+        assert getitem(manifest,("assertions",0,"label")) == "stds.schema-org.CreativeWork"
+        assert getitem(manifest,("assertions",0,"data","author",0,"name")) == "Adobe make_test"
+        # read Actions assertion
+        assert getitem(manifest,("assertions",1,"label")) == "c2pa.actions"
+        assert getitem(manifest,("assertions",1,"data","actions",0,"action")) == "c2pa.created"
+        # read signature info
+        assert getitem(manifest,("signature_info","issuer")) == "C2PA Test Signing Cert"
+        # read thumbnail data from file
+        assert getitem(manifest,("thumbnail","format")) == "image/jpeg"
+        thumb_name = getitem(manifest,("thumbnail","identifier"))
+        with open(data_dir + "/" + thumb_name, "rb") as thumb_file:
+            thumb_data = thumb_file.read()
+    assert len(thumb_data) == 31608
+
+def test_ingredient_from_file_get_thumbnail():
+    with tempfile.TemporaryDirectory() as data_dir:
+        ingredient_json = c2pa.ingredient_from_file_json("tests/fixtures/C.jpg", data_dir)
+        ingredient = json.loads(ingredient_json)
+        assert ingredient["title"]== "C.jpg"
+        assert ingredient,["format"] == "image/jpeg"
+        # read thumbnail data from file
+        assert getitem(ingredient,("thumbnail","format")) == "image/jpeg"
+        thumb_name = getitem(ingredient,("thumbnail","identifier"))
+        with open(data_dir + "/" + thumb_name, "rb") as thumb_file:
+            thumb_data = thumb_file.read()
+        assert len(thumb_data) == 31608
+        #read c2pa data from file
+        assert getitem(ingredient,("manifest_data","format")) == "c2pa"
+        data_name = getitem(ingredient,("manifest_data","identifier"))
+        with open(data_dir + "/" + data_name, "rb") as c2pa_file:
+            c2pa_data = c2pa_file.read()
+        assert len(c2pa_data) == 51240        
+
+def test_sign_info():
+          # set up the signer info loading the pem and key files
+        test_pem = open("tests/fixtures/es256_certs.pem","rb").read()
+        test_key = open("tests/fixtures/es256_private.key","rb").read()
+        sign_info = c2pa.SignerInfo(test_pem, test_key, "es256", "http://timestamp.digicert.com")
+        assert sign_info.alg == "es256"
+        assert sign_info.tsa_url == "http://timestamp.digicert.com"
+
+def test_add_manifest_to_file():
+    # define a source folder for any assets we need to read
+    data_dir = "tests/fixtures"
+
+    # create temp folder for writing things
+    with tempfile.TemporaryDirectory() as output_dir:
+        # define a manifest with the do not train assertion
+        manifest_json = json.dumps({
+            "claim_generator": "python_test/0.1",
+            "title": "My Title",
+            "thumbnail": {
+                "format": "image/jpeg",
+                "identifier": "A.jpg"
+            },
+            "assertions": [
+            {
+                    "label": "c2pa.training-mining",
+                    "data": {
+                        "entries": {
+                        "c2pa.ai_generative_training": { "use": "notAllowed" },
+                        "c2pa.ai_inference": { "use": "notAllowed" },
+                        "c2pa.ai_training": { "use": "notAllowed" },
+                        "c2pa.data_mining": { "use": "notAllowed" }
+                        }
+                    }
+                }
+            ]
+        })
+
+        # set up the signer info loading the pem and key files
+        test_pem = open("tests/fixtures/es256_certs.pem","rb").read()
+        test_key = open("tests/fixtures/es256_private.key","rb").read()
+        sign_info = c2pa.SignerInfo(test_pem, test_key, "es256", "http://timestamp.digicert.com")
+
+        # add the manifest to the asset
+        c2pa_data = c2pa.add_manifest_to_file_json(data_dir + "/A.jpg", output_dir+"/out.jpg", manifest_json, sign_info, data_dir)
+        assert len(c2pa_data) == 75860 #check the size of returned c2pa_manifest data
+
+        # verify the asset and check the manifest has what we expect
+        store_json = c2pa.verify_from_file_json(output_dir + "/out.jpg", output_dir)
+        manifest_store = json.loads(store_json)
+        manifest = manifest_store["manifests"][manifest_store["active_manifest"]]
+        print (store_json)
+        assert "python_test" in manifest["claim_generator"]
+        # check custom title and format
+        assert manifest["title"]== "My Title" 
+        assert manifest,["format"] == "image/jpeg"
+        # There should be no validation status errors
+        assert manifest.get("validation_status") == None
+        # check the thumbnail data
+        thumb_name = getitem(manifest,("thumbnail","identifier"))
+        with open(output_dir + "/" + thumb_name, "rb") as thumb_file:
+            thumb_data = thumb_file.read()
+        assert len(thumb_data) == 61720
+
+