Skip to content

cliplugin: semver, add tests for hash func encoding#1948

Merged
Hayden-IO merged 59 commits intosigstore:mainfrom
ramonpetgrave64:ramonpetgrave64-kms-plugin-cli-hashencoding
Feb 6, 2025
Merged

cliplugin: semver, add tests for hash func encoding#1948
Hayden-IO merged 59 commits intosigstore:mainfrom
ramonpetgrave64:ramonpetgrave64-kms-plugin-cli-hashencoding

Conversation

@ramonpetgrave64
Copy link
Copy Markdown
Contributor

Summary

pending #1947, branch diff: ramonpetgrave64/sigstore@ramonpetgrave64-kms-plugin-cli-context...ramonpetgrave64:sigstore:ramonpetgrave64-kms-plugin-cli-hashencoding

Adds tests against know hash func and their JSON encoding.
The current set of hash funcs and their encoding has not changed in ~8 years, but they might change in the future, since they are ordered by iota.

This PR

  • adds a test that can give us a warning if and when they do change, and we would likely need a major version bump of the protocol version.
  • adds semver to the plugin protocol version at "v1.0.0".

Release Note

The plugin protocol version now uses semver at "v1.0.0".

Documentation

No new documentation changes

Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
…monpetgrave64-kms-plugin-cli-cryptosigner

Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
…monpetgrave64-kms-plugin-cli-cryptosigner

Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
This reverts commit 80f74bc.

Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
This reverts commit fb9bb93.

Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
This reverts commit 768bc6b.

Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
@ramonpetgrave64 ramonpetgrave64 force-pushed the ramonpetgrave64-kms-plugin-cli-hashencoding branch from 0862508 to ca8d65c Compare January 28, 2025 18:41
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
@ramonpetgrave64 ramonpetgrave64 force-pushed the ramonpetgrave64-kms-plugin-cli-hashencoding branch from ca8d65c to 1384652 Compare January 28, 2025 18:43
…working

Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
…to ramonpetgrave64-kms-plugin-cli-context

Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
…ave64-kms-plugin-cli-hashencoding

Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
@ramonpetgrave64 ramonpetgrave64 marked this pull request as ready for review February 5, 2025 18:09
@ramonpetgrave64 ramonpetgrave64 requested a review from a team as a code owner February 5, 2025 18:09
// Plugin authors may choose to be backwards compatible with older versions.
// TODO: change this to be semver compatible, like v1, or v1.0.0.
ProtocolVersion = "1"
ProtocolVersion = "v1.0.0"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this amount of semver specificity is overkill and a single major version should be sufficient. Clients don't need to be aware of non-breaking changes to the protocol.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changed

Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
Copy link
Copy Markdown
Contributor

@Hayden-IO Hayden-IO left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just needs rebase

Signed-off-by: Ramon Petgrave <ramon.petgrave64@gmail.com>
@Hayden-IO Hayden-IO merged commit 67bd820 into sigstore:main Feb 6, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants