Describe cataloger capabilities via test observations #4318
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Alex Goodman <[email protected]>
| // file digests observation | ||
| if hasFileDigests(p.Metadata) { | ||
| obs.FileDigests.Found = true | ||
| obs.FileDigests.Count++ |
Contributor
There was a problem hiding this comment.
Why are we counting files with digests? At first I thought the digests were going to be for detecting whether capabilities changed, but now it looks like they're just being counted?
Contributor
Author
There was a problem hiding this comment.
yeah, this part is kinda silly, as long as we have something that can detect "present or not" that would be good enough. I'll leave this for now since it's not operationally affecting anything and will make subsequent PRs a little easier too (I'll probably remove it in a future PR).
willmurphyscode
approved these changes
Oct 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This rigs the
pkgtesthelpers to be able to describe what catalogers are seen and what elements are output during the test. Observations are written out to thetest-fixtures/test-observations.jsonfile relative to the test in question.Here's example output:
{ "package": "debian", "updated_at": "2025-10-29T17:56:49.081895Z", "catalogers": { "deb-archive-cataloger": { "metadata_types": [ "pkg.DpkgArchiveEntry" ], "package_types": [ "deb" ], "observations": { "license": true, "relationships": { "found": false, "count": 0 }, "file_listing": { "found": false, "count": 0 }, "file_digests": { "found": true, "count": 1 }, "integrity_hash": { "found": false, "count": 0 } } }, "dpkg-db-cataloger": { "metadata_types": [ "pkg.DpkgDBEntry" ], "package_types": [ "deb" ], "observations": { "license": true, "relationships": { "found": false, "count": 0 }, "file_listing": { "found": true, "count": 18 }, "file_digests": { "found": true, "count": 3 }, "integrity_hash": { "found": false, "count": 0 } } } }, "parsers": { "parseDpkgDB": { "metadata_types": [ "pkg.DpkgDBEntry" ], "package_types": [ "deb" ], "observations": { "license": false, "relationships": { "found": false, "count": 0 }, "file_listing": { "found": false, "count": 0 }, "file_digests": { "found": false, "count": 0 }, "integrity_hash": { "found": false, "count": 0 } } } } }This is work that was carved out of #4317