Diff metadata #75

stesee · 2025-11-30T08:14:55Z

Support to compare image metadata (exif, ...) added:

var imageCompare= new ImageCompare(compareMetadata: true);
var result = imageCompare.ImagesAreEqual("image.jpg","imageWithStrippedMetadata.jpg");
Console.Writeline(result);
# False

Introduces metadata comparison to SkiaSharpCompare, allowing image comparisons to include differences in metadata as well as pixel data. Adds new classes for metadata extraction and comparison, updates interfaces and result DTOs, and extends ImageCompare and SkiaSharpCompare APIs to support the new functionality. Includes new tests and test data for metadata comparison.

Introduces a new SkiaSharpCompare.Cli project with programmatic and console entry points for file and directory image comparison. Adds SkiaSharpCompare.Cli.Tests with NUnit-based tests for CLI logic. Updates the GitHub Actions workflow to build, publish, and upload CLI artifacts for multiple platforms, and includes CLI artifacts in release assets. Updates the solution file to include the new projects.

Introduces a --meta option to the CLI for displaying image metadata. Enhances MetadataExtractorAdapter with improved documentation, normalization, and duplicate key handling. Also adds null checks in CalcDiff and updates ImageCompare constructor documentation.

Updated file name extraction in CliRunner to filter out nulls before casting to string, preventing possible exceptions. In SkiaSharpCompare.cs, moved and reordered the CalcDiffInternal method without functional changes.

Enhanced the metadata comparison test to log actual and expected metadata differences using a new FormatMetadata helper. This aids in diagnosing test failures by providing detailed output in test run logs.

Artifacts are now uploaded and named per OS using matrix.os, and downloads attach all CLI artifacts regardless of OS. This improves release creation by ensuring all relevant artifacts are included.

Added [SetCulture("en-US")] to ensure consistent formatting in test assertions. Updated expected metadata values to use periods as decimal separators and periods in time stamps, matching en-US culture.

Renamed imageWithMetadataA.jpg to imageWithoutGpsMetadata.jpg and imageWithMetadataB.jpg to imageWithGpsMetadata.jpg for clarity. Updated all references in SkiaSharpCompareMetaDataTests.cs and TestFiles.cs to use the new names, and adjusted file paths in TestFiles.cs to use './' prefix for consistency.

Updated the file paths for colorShift1 and colorShift2 to use the correct case, ensuring compatibility with case-sensitive file systems.

Copilot

Pull request overview

This PR adds support for comparing image metadata (EXIF, GPS, etc.) in addition to pixel-level comparison. The implementation integrates the MetadataExtractor library to extract and compare metadata from images. The PR also includes significant refactoring of test files to centralize test file path constants and introduces a new CLI project for command-line image comparison.

Key Changes:

Added metadata comparison capability via new compareMetadata parameter in comparison APIs
Introduced MetadataExtractorAdapter and MetadataComparer classes for metadata handling
Created a new CLI project (SkiaSharpCompare.Cli) with directory and file comparison support
Refactored test files to use centralized TestFiles.cs for test data paths
Updated package versions and added MetadataExtractor dependency

Reviewed changes

Copilot reviewed 21 out of 23 changed files in this pull request and generated 18 comments.

Show a summary per file

File	Description
SkiaSharpCompare/MetadataExtractorAdapter.cs	New adapter class for extracting metadata from images using MetadataExtractor library
SkiaSharpCompare/MetadataComparer.cs	New internal class implementing metadata comparison logic
SkiaSharpCompare/SkiaSharpCompare.cs	Added `compareMetadata` parameter to static comparison methods with early-exit logic
SkiaSharpCompare/ImageCompare.cs	Added `CompareMetadata` property and integrated metadata comparison into instance methods
SkiaSharpCompare/ICompareResult.cs	Added `MetadataDifferences` property to expose metadata comparison results
SkiaSharpCompare/CompareResult.cs	Updated to include metadata differences using primary constructor syntax
SkiaSharpCompare/CompareResultWithMetadata.cs	New wrapper class for combining pixel and metadata comparison results
SkiaSharpCompareTestNunit/TestFiles.cs	New centralized test file constants to eliminate duplication
SkiaSharpCompareTestNunit/SkiaSharpStaticCompareTests.cs	Refactored to use TestFiles constants and renamed parameters for clarity
SkiaSharpCompareTestNunit/SkiaSharpCompareTests.cs	Refactored to use TestFiles constants
SkiaSharpCompareTestNunit/SkiaSharpCompareMetaDataTests.cs	New comprehensive tests for metadata comparison feature
SkiaSharpCompare.Cli/Program.cs	New CLI entry point supporting file/directory comparison and metadata display
SkiaSharpCompare.Cli/CliRunner.cs	New helper class providing programmatic API for CLI operations
SkiaSharpCompare.Cli.Tests/SkiaSharpCompareCliTests.cs	New tests for CLI functionality
.github/workflows/dotnet.yml	Updated to build and publish CLI artifacts for multiple platforms

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

SkiaSharpCompare/ImageCompare.cs

SkiaSharpCompare/SkiaSharpCompare.cs

.github/workflows/dotnet.yml

SkiaSharpCompare/ImageCompare.cs

SkiaSharpCompare/SkiaSharpCompare.cs

SkiaSharpCompare/ImageCompare.cs

Copilot · 2025-11-30T08:20:27Z

SkiaSharpCompare/ImageCompare.cs

+        /// <param name="PathPic2"></param>
        /// <returns></returns>
-        public SKBitmap CalcDiffMaskImage(string absolutePathPic1, string absolutePathPic2)
+        public SKBitmap CalcDiffMaskImage(string PathPic1, string PathPic2)


Inconsistent parameter naming: Parameter PathPic1 uses PascalCase, which is inconsistent with C# naming conventions for parameters (should be camelCase: pathPic1). Note that the method body uses this in PascalCase on line 181, which should also be corrected.

SkiaSharpCompare/MetadataExtractorAdapter.cs

Copilot · 2025-11-30T15:31:00Z

@stesee I've opened a new pull request, #76, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot · 2025-11-30T15:31:06Z

@stesee I've opened a new pull request, #77, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot · 2025-11-30T15:31:13Z

@stesee I've opened a new pull request, #78, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot · 2025-11-30T15:31:39Z

@stesee I've opened a new pull request, #79, to work on those changes. Once the pull request is ready, I'll request review from you.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot · 2025-11-30T15:32:17Z

@stesee I've opened a new pull request, #80, to work on those changes. Once the pull request is ready, I'll request review from you.

Introduced a DecodeStream helper to centralize SKBitmap decoding from streams, improving reliability and code reuse. Updated ImageCompare and SkiaSharpCompare to use this helper and ensure streams are reset as needed. Added new NUnit tests for metadata comparison using SKBitmap and Stream inputs, and renamed SkiaSharpCompareMetaDataTests to SkiaSharpCompareMetaData_PathTests for clarity.

Renamed method parameters in ImageCompare.cs and SkiaSharpCompare.cs to use more descriptive and consistent names (e.g., image1, image2, pathImage1, pathImage2) instead of ambiguous names like pic1, actual, or expected. This improves code readability and aligns parameter naming across the codebase.

Added 'github-actions[bot]' and 'copilot[bot]' to the CLA workflow allowlist to ensure these bots are not blocked by the CLA check. contributor-assistant/github-action#169

Introduces SkiaSharpCompareCliIntegrationTests to verify CLI execution and output. Also removes unused usings from SkiaSharpCompareCliTests.cs and Program.cs for improved code clarity.

Replaced explicit addition with the '+=' operator for absoluteError and sum variables to improve code readability and consistency.

Refactored CompareResultWithMetadata to use a C# primary constructor and auto-property initializers. Split CalcDiff into CalcDiff and CalcDiffInternal to separate mask-based and non-mask-based image comparison logic, and moved DecodeStream to a more appropriate location. Improved code clarity and maintainability by reorganizing methods and updating parameter handling.

Copilot · 2025-12-06T13:22:24Z

@stesee I've opened a new pull request, #82, to work on those changes. Once the pull request is ready, I'll request review from you.

Co-authored-by: stesee <168659+stesee@users.noreply.github.com>

Zip CLI artifacts directory for release attachments

github-actions · 2025-12-06T14:35:22Z

Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.

I have read the CLA Document and I hereby sign the CLA

_{You can retrigger this bot by commenting recheck in this Pull Request.}_{Posted by the CLA Assistant Lite bot.}

stesee added 9 commits November 29, 2025 17:37

Fix null handling in file name extraction and reorder method

4dbf2c9

Updated file name extraction in CliRunner to filter out nulls before casting to string, preventing possible exceptions. In SkiaSharpCompare.cs, moved and reordered the CalcDiffInternal method without functional changes.

Add metadata diff logging to metadata comparison test

12044b2

Enhanced the metadata comparison test to log actual and expected metadata differences using a new FormatMetadata helper. This aids in diagnosing test failures by providing detailed output in test run logs.

Update artifact handling in dotnet workflow

e5ad35c

Artifacts are now uploaded and named per OS using matrix.os, and downloads attach all CLI artifacts regardless of OS. This improves release creation by ensuring all relevant artifacts are included.

Fix metadata test to use en-US decimal and time formats

7daf80b

Added [SetCulture("en-US")] to ensure consistent formatting in test assertions. Updated expected metadata values to use periods as decimal separators and periods in time stamps, matching en-US culture.

Fix case sensitivity in colorShift image paths

e4c8517

Updated the file paths for colorShift1 and colorShift2 to use the correct case, ensuring compatibility with case-sensitive file systems.

Copilot AI review requested due to automatic review settings November 30, 2025 08:14

Copilot started reviewing on behalf of stesee November 30, 2025 08:15 View session

Copilot finished reviewing on behalf of stesee November 30, 2025 08:18

Copilot AI reviewed Nov 30, 2025

View reviewed changes

Copilot AI mentioned this pull request Nov 30, 2025

Fix parameter naming from PascalCase to camelCase in ImageCompare.cs #76

Closed

Copilot AI mentioned this pull request Nov 30, 2025

Fix parameter naming conventions in ImageCompare.cs #77

Closed

Copilot AI mentioned this pull request Nov 30, 2025

Add XML documentation for compareMetadata parameter #78

Closed

Copilot AI mentioned this pull request Nov 30, 2025

Fix PascalCase parameter naming to follow C# conventions #79

Closed

Update SkiaSharpCompare/ImageCompare.cs

fad5e1e

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot AI mentioned this pull request Nov 30, 2025

Fix parameter naming to use camelCase in ImageCompare.cs #80

Closed

stesee added 6 commits December 1, 2025 09:01

Update CLA allowlist with additional bots

99ea054

Added 'github-actions[bot]' and 'copilot[bot]' to the CLA workflow allowlist to ensure these bots are not blocked by the CLA check. contributor-assistant/github-action#169

Add integration test for CLI and clean up usings

4f4a68d

Introduces SkiaSharpCompareCliIntegrationTests to verify CLI execution and output. Also removes unused usings from SkiaSharpCompareCliTests.cs and Program.cs for improved code clarity.

Refactor error accumulation to use '+=' operator

44ee34b

Replaced explicit addition with the '+=' operator for absoluteError and sum variables to improve code readability and consistency.

stesee and others added 2 commits December 6, 2025 13:40

Fix glob pattern for artifact release creation

e38a844

Initial plan

2921c01

Copilot AI mentioned this pull request Dec 6, 2025

Zip CLI artifacts directory for release attachments #82

Merged

Copilot AI and others added 3 commits December 6, 2025 13:25

Enable globstar for recursive artifact pattern matching

9f0bf45

Co-authored-by: stesee <168659+stesee@users.noreply.github.com>

Zip artifacts directory instead of using globstar patterns

33b6b5f

Co-authored-by: stesee <168659+stesee@users.noreply.github.com>

Merge pull request #82 from Codeuctivity/copilot/sub-pr-75

24e8006

Zip CLI artifacts directory for release attachments

stesee merged commit c15c8b5 into main Dec 6, 2025
5 of 6 checks passed

stesee deleted the DiffMetadata branch December 6, 2025 14:47

github-actions bot locked and limited conversation to collaborators Dec 6, 2025

Uh oh!

Diff metadata #75

Diff metadata #75

Uh oh!

Conversation

stesee commented Nov 30, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Key Changes:

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Nov 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI commented Nov 30, 2025

Uh oh!

Copilot AI commented Nov 30, 2025

Uh oh!

Copilot AI commented Nov 30, 2025

Uh oh!

Copilot AI commented Nov 30, 2025

Uh oh!

Copilot AI commented Nov 30, 2025

Uh oh!

Copilot AI commented Dec 6, 2025

Uh oh!

github-actions bot commented Dec 6, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants