Add GenerateSigningPayloads command

dotnet / docker-tools

This is a repo to house some common tools for our various docker repos.

MIT License

122 stars 46 forks source link

Add GenerateSigningPayloads command #1381

Closed lbussell closed 1 month ago

lbussell commented 1 month ago

Changes:

New Command GenerateSigningPayloads
Rename OrasSerivce -> LifecycleMetadataService - since it contains "business logic" I think those methods should live outside the ORAS client class. For some reason Git did not pick those up as renames.
New OrasClient which only talks to ORAS CLI
Removed need for nullable annotations in ExecuteHelper methods
Rearranged models around Notary, ORAS, and OCI

Todo:

[x] Authenticate
[x] Validate payloads on-disk in tests
[x] Handle registry overrides - ~~not sure how those manifest in the image info file - will this even be important if we only use digests in this command~~
[ ] Write some additional tests
- [x] Images without manifest lists
- [ ] ...
[x] Double-check dry-run functionality - is it even needed

dotnet-issue-labeler[bot] commented 1 month ago

I couldn't figure out the best area label to add to this PR. If you have write-permissions please help me learn by adding exactly one area label.

dotnet-issue-labeler[bot] commented 1 month ago

I couldn't figure out the best area label to add to this PR. If you have write-permissions please help me learn by adding exactly one area label.

lbussell commented 1 month ago

Applying the RegistryOverrideOptions class to other commands is proving to be really involved and not really worth the ROI, so I'm going to stop that.

I am taking suggestions for other tests I could implement, but this command is pretty simple. So I think this is ready to review.

lbussell commented 1 month ago

For some reason when running ImageBuilder's help command, this command shows up at the bottom while the others are in alphabetical order:

Commands:
  annotateEolDigests <EolDigestsListPath> <AcrName> <RepoPrefix> <AnnotationDigestsOutputPath>
  build
  cleanAcrImages <RepoName> <Subscription> <ResourceGroup> <RegistryName>
  <snip>
  waitForMcrDocIngestion <CommitDigest>
  waitForMcrImageIngestion <ImageInfoPath>
  generateSigningPayloads <ImageInfoPath> <PayloadOutputDirectory>

lbussell commented 1 month ago

For some reason when running ImageBuilder's help command, this command shows up at the bottom while the others are in alphabetical order:

Oh, it must be because I put it in a separate namespace...