chore: Upgrade testing infrastructure

.github/workflows/ci.yml

@@ -19,19 +19,47 @@ jobs:
         rust_version: [stable, 1.74.0]
 
     steps:
+      - name: Disable core.autocrlf
+        run: git config --global core.autocrlf false
+
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install Rust toolchain
         uses: dtolnay/rust-toolchain@master
         with:
           toolchain: ${{ matrix.rust_version }}
+          components: llvm-tools-preview
 
       - name: Cache Rust dependencies
         uses: Swatinem/rust-cache@v2
 
-      - name: Run unit tests
-        run: cargo test --all-features --verbose
+      - name: Install cargo-llvm-cov
+        uses: taiki-e/install-action@cargo-llvm-cov
+
+      - name: Generate code coverage
+        id: run_tests
+        env:
+          RUST_BACKTRACE: 1
+          CARGO_TERM_COLOR: always
+          CLICOLOR_FORCE: 1
+          INSTA_UPDATE: new
+        run: cargo llvm-cov --tests --bins --all-features --lcov --output-path lcov.info
+
+      # https://insta.rs/docs/patterns/
+      - name: Upload snapshots of failed tests
+        if: ${{ failure() && steps.run_tests.outcome == 'failure' }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: failed-snapshots
+          path: "**/snapshots/*.snap.new"
+
+      - name: Upload code coverage results
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: true
+          verbose: true
 
   tests-cross:
     name: Unit tests
@@ -44,8 +72,11 @@ jobs:
         rust_version: [stable, 1.74.0]
 
     steps:
+      - name: Disable core.autocrlf
+        run: git config --global core.autocrlf false
+
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install Rust toolchain
         uses: dtolnay/rust-toolchain@master
@@ -72,7 +103,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install Rust toolchain
         uses: dtolnay/rust-toolchain@stable
@@ -94,8 +125,11 @@ jobs:
         os: [windows-latest, macos-latest, ubuntu-latest]
 
     steps:
+      - name: Disable core.autocrlf
+        run: git config --global core.autocrlf false
+
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install Rust toolchain
         uses: dtolnay/rust-toolchain@nightly
@@ -120,7 +154,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install Rust toolchain
         uses: dtolnay/rust-toolchain@master
@@ -139,7 +173,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install Rust toolchain
         uses: dtolnay/rust-toolchain@stable
@@ -163,7 +197,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install stable toolchain
         uses: dtolnay/rust-toolchain@nightly
@@ -178,7 +212,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install nightly Rust toolchain
         # Nightly is used here because the docs.rs build
@@ -193,7 +227,7 @@ jobs:
         # documentation build on docs.rs.
         run: cargo +nightly doc --all-features --no-deps
         env:
-          RUSTDOCFLAGS: --cfg docsrs
+          RUSTDOCFLAGS: "--cfg docsrs -D warnings"
           DOCS_RS: 1
 
   cargo-deny:
@@ -212,7 +246,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Audit crate dependencies
         uses: EmbarkStudios/cargo-deny-action@v1
@@ -224,7 +258,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install Rust toolchain
         uses: dtolnay/rust-toolchain@nightly
@@ -241,9 +275,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
+        uses: actions/checkout@v4
 
       - name: Install Rust toolchain
         uses: dtolnay/rust-toolchain@stable

.github/workflows/nightly.yml

@@ -13,7 +13,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         fetch-depth: 0
         token: ${{ secrets.GH_ADMIN_COMMIT_TOKEN }}
@@ -82,7 +82,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: nightly
 
@@ -107,7 +107,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: nightly
 

.github/workflows/publish.yml

@@ -4,13 +4,43 @@ on:
   workflow_dispatch:
 
 jobs:
+  compat-snapshot:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Create compat snapshot
+        run: cargo run -p c2pa-compat
+
+      - name: Get latest existing tag
+        uses: WyriHaximus/github-action-get-previous-tag@v1
+        id: get-latest-tag
+
+      - name: Send compat PR
+        uses: peter-evans/create-pull-request@v6
+        with:
+          title: "Create compat snapshot for ${{ steps.get-latest-tag.outputs.tag }}"
+          labels: compat-snapshot
+          commit-message: "Create compat snapshot for ${{ steps.get-latest-tag.outputs.tag }}"
+          branch: "compat-snapshot-${{ steps.get-latest-tag.outputs.tag }}"
+          add-paths: sdk/tests/fixtures
+          base: ${{ github.head_ref }}
+
   publish:
     concurrency: publish-mutex
     runs-on: ubuntu-latest
     steps:
+    - name: Disable core.autocrlf
+      run: git config --global core.autocrlf false
 
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         fetch-depth: 0
         token: ${{ secrets.GH_ADMIN_COMMIT_TOKEN }}

Cargo.toml

@@ -1,3 +1,8 @@
 [workspace]
 resolver = "2"
-members = ["sdk", "export_schema", "make_test_images"]
+members = ["sdk", "export_schema", "make_test_images", "c2pa-compat"]
+
+# https://insta.rs/docs/quickstart/
+[profile.dev.package]
+insta.opt-level = 3
+similar.opt-level = 3

c2pa-compat/Cargo.toml

@@ -0,0 +1,19 @@
+[package]
+name = "c2pa-compat"
+version = "0.1.0"
+edition = "2021"
+rust-version = "1.74.0"
+license = "MIT OR Apache-2.0"
+
+[dependencies]
+c2pa = { path = "../sdk", features = [
+  "unstable_api",
+  "openssl_sign",
+  "file_io",
+] }
+serde = { version = "1.0.197", features = ["derive"] }
+serde_json = "1.0.117"
+ed25519-dalek = "2.1.1"
+pem = "3.0.2"
+bsdiff = "0.2.0"
+lz4_flex = "0.11.3"

c2pa-compat/README.md

@@ -0,0 +1,6 @@
+# `c2pa-compat`
+A tool for generating a compatibility snapshot of all asset types with remote and embedded manifests.
+
+These snapshots are typically created every release and saved to `sdk/tests/fixtures/compat/<VERSION>` for each c2pa-rs version. They are used in the compatibility tests found in `sdk/tests/compat.rs`.
+
+`src/full-manifest.json` should always contain every possible manifest feature for every release.

c2pa-compat/src/full-manifest.json

@@ -0,0 +1,123 @@
+{
+  "title": "extensive-version-snapshot",
+  "format": "TODO",
+  "instance_id": "TOOD",
+  "claim_generator_info": [
+    {
+      "name": "My claim generator",
+      "version": "0.1.0",
+      "icon": {
+        "format": "image/svg+xml",
+        "identifier": "sample1.svg"
+      }
+    }
+  ],
+  "metadata": [
+    {
+      "reviews": [
+        {
+          "explanation": "Some explanation",
+          "code": "ingredient.notVisible",
+          "value": 2
+        }
+      ],
+      "dateTime": "1985-04-12T23:20:50.52Z",
+      "dataSource": {
+        "type": "humanEntry.identified",
+        "details": "Some details",
+        "actors": [
+          {
+            "identifier": "Some identifier"
+          }
+        ]
+      },
+      "my_custom_metadata": "my custom metatdata value"
+    }
+  ],
+  "thumbnail": {
+    "format": "image/jpeg",
+    "identifier": "C.jpg",
+    "data_types": [
+      {
+        "type": "c2pa.types.classifier",
+        "version": "0.1.0"
+      }
+    ]
+  },
+  "assertions": [
+    {
+      "label": "TODO: add every single type of assertion, v1 + v2 + vX",
+      "data": {
+        "TODO": "TODO: are assertions validated? are they all treated the same, just a blob?"
+      }
+    }
+  ],
+  "ingredients": [
+    {
+      "title": "CA.jpg",
+      "format": "image/jpeg",
+      "document_id": "xmp.did:813ee422-9736-4cdc-9be6-4e35ed8e41cb",
+      "relationship": "parentOf",
+      "thumbnail": {
+        "format": "image/png",
+        "identifier": "fixtures/png/exp-test1.png",
+        "data_types": [
+          {
+            "type": "c2pa.types.classifier",
+            "version": "0.1.0"
+          }
+        ]
+      },
+      "validation_status": [
+        {
+          "code": "claimSignature.validated",
+          "url": "TODO",
+          "explanation": "Some explanation"
+        }
+      ],
+      "description": "Some description",
+      "informational_URI": "google.com",
+      "metadata": {
+        "reviews": [
+          {
+            "explanation": "Some explanation",
+            "code": "ingredient.notVisible",
+            "value": 2
+          }
+        ],
+        "dateTime": "1985-04-12T23:20:50.52Z",
+        "dataSource": {
+          "type": "humanEntry.identified",
+          "details": "Some details",
+          "actors": [
+            {
+              "identifier": "Some identifier"
+            }
+          ]
+        },
+        "my_custom_metadata": "my custom metatdata value"
+      },
+      "data_types": [
+        {
+          "type": "c2pa.types.classifier",
+          "version": "0.1.0"
+        }
+      ]
+    },
+    {
+      "title": "prompt",
+      "format": "text/plain",
+      "relationship": "inputTo",
+      "data": {
+        "format": "text/plain",
+        "identifier": "prompt.txt",
+        "data_types": [
+          {
+            "type": "c2pa.types.generator.prompt"
+          }
+        ]
+      }
+    }
+  ],
+  "redactions": ["TODO"]
+}