-
Notifications
You must be signed in to change notification settings - Fork 19
docs: ADR-0006 sbom merge #111
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
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: Patrick Kwiatkowski <patrick.r.kwiatkowski@lmco.com>
Signed-off-by: Patrick Kwiatkowski <patrick.r.kwiatkowski@lmco.com>
jhoward-lm
requested changes
Jul 29, 2024
idunbarh
reviewed
Jul 30, 2024
Contributor
|
Just to document here for whoever ends up working on this, I think an implementation using a Go generic interface would be a clean way to do it. Basic examplepackage main
import (
"fmt"
"github.com/protobom/protobom/pkg/sbom"
)
type (
Merger[T any] interface {
Merge(*T) error
}
MergerBase[T any] struct {
Base *T
}
)
func (*MergerBase[T]) Merge(t *T) error {
switch any(t).(type) {
case *sbom.Metadata:
fmt.Println("Merging metadata")
case *sbom.Node:
if _, ok := any(m.Base).(*sbom.Node); !ok {
// return error
}
fmt.Println("Merging nodes")
case *sbom.NodeList:
fmt.Println("Merging node lists")
case *sbom.Person:
fmt.Println("Merging persons")
case *sbom.Tool:
fmt.Println("Merging tools")
default:
// return error
}
return nil
}
func NewMerger[T any](data *T) *MergerBase[T] {
return &MergerBase[T]{Base: data}
}
// Enforce implementation of interface at compile time
var _ Merger[sbom.Node] = (*MergerBase[sbom.Node])(nil)
func main() {
merger := NewMerger(&sbom.Node{})
merger.Merge(&sbom.Node{})
} |
Signed-off-by: Patrick Kwiatkowski <patrick.r.kwiatkowski@lmco.com>
Closed
Signed-off-by: Allen Shearin <allen.p.shearin@gmail.com>
ashearin
approved these changes
Oct 23, 2024
jhoward-lm
approved these changes
Oct 23, 2024
Signed-off-by: Patrick Kwiatkowski <patrick.r.kwiatkowski@lmco.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
adr
Architecture Decision Records use to decide architecture or implementation details of `bomctl`
documentation
Improvements or additions to documentation
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.
6. Merge subcommand
Date: 2024-07-29
Status
Accepted
Context
SBOM merge capability should be supported.
Decision
Ability to take one or more SBOMs in different formats into a singular sbom
Ability to take a flag to “flatten” any externally referenced SBOMs
Consequences
These changes allow end users to easily consolidate multiple SBOMs from a variety of different sources into one while still being agnostic of the SBOM format being used.