feat: SBOM Aliases #129

lmphil · 2024-08-14T22:14:30Z

Pull Request

Description

This change adds support for SBOM aliases and tags.

The following commands have been added:

alias set
alias remove
alias list
tag clear
tag add
tag remove
tag list

The following options were added to the fetch command:

alias
tag

The following options were added to the import command:

alias
tag

The following option was added to the list command:

tag

The following option was added to the merge command:

alias
tag

Additionally, the export, list, fetch, merge, and push commands were modified to also use aliases as IDs.

Fixes #65

Type of change

[ x] New feature (non-breaking change which adds functionality)
[ x] This change requires a documentation update

How Has This Been Tested?

Manually tested each command with different input.

Checklist

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
Any dependent changes have been merged and published in downstream modules
I have checked my code and corrected any misspellings

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

cmd/list.go

cmd/fetch.go

cmd/list.go

cmd/alias.go

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

cmd/alias.go

cmd/list.go

cmd/tag.go

cmd/alias.go

cmd/tag.go

jhoward-lm · 2024-08-22T13:08:08Z

Please change PR title to start with feat: to work with changelog generation

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

…aliases Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

cmd/tag.go

internal/pkg/db/db.go

cmd/tag.go

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

jhoward-lm · 2024-09-01T17:15:37Z

With upcoming changes to protobom/storage and #68, let's add constants in db.go such as

const (
    BomctlAnnotationAlias string = "bomctl_annotation_alias"
    BomctlAnnotationLabel string = "bomctl_annotation_label"
)

idunbarh · 2024-09-04T01:06:06Z

Please update the README.md that includes the command instructions.

internal/pkg/options/options.go

internal/pkg/db/db.go

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

lmphil · 2024-09-12T00:50:17Z

In the README.md file, I'm not sure if the "Merge" item in the "Roadmap" section is still needed or if it was fully covered by the PR that added the Merge command.

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

resolved

internal/pkg/fetch/fetch.go

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

ashearin

I would like to see the width of bomctl list be dynamic to allow it to show the entirety of the alias, but that is work for a future issue.

lmphil · 2024-09-12T21:04:54Z

I would like to see the width of bomctl list be dynamic to allow it to show the entirety of the alias, but that is work for a future issue.

I agree. In the meantime, with this change we have an ellipsis as a visual indicator when aliases get truncated inside the list table, and an alias list command that will always display complete aliases and their corresponding document IDs.

jhoward-lm

I think we should probably merge #157 first, but in general we need to start putting a blank line between header and package declaration. We also need to come up with a way to translate backslashes to forward slashes in header paths

cmd/errors.go

cmd/alias.go

cmd/tag.go

cmd/errors.go

cmd/alias.go

…aliases

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

cmd/tag.go

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

ashearin

Looks great!

…aliases Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

resolved

jhoward-lm

Good work, thanks!

alias and tags changes (wip)

14af883

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

idunbarh reviewed Aug 15, 2024

View reviewed changes

cmd/list.go Outdated Show resolved Hide resolved

jhoward-lm requested changes Aug 15, 2024

View reviewed changes

ashearin assigned lmphil Aug 15, 2024

lmphil added 3 commits August 15, 2024 21:30

Merge branch 'main' into 65-sbom-aliases

f63d862

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

fix linting errors

a29ef55

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

fix linting errors

6808b0c

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

jhoward-lm requested changes Aug 22, 2024

View reviewed changes

lmphil changed the title ~~SBOM Aliases~~ Feat: SBOM Aliases Aug 22, 2024

lmphil added 2 commits August 22, 2024 14:02

fix linting errors

75d5540

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

Merge branch 'main' of https://github.com/bomctl/bomctl into 65-sbom-…

ba28136

…aliases Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

lmphil changed the title ~~Feat: SBOM Aliases~~ feat: SBOM Aliases Aug 22, 2024

lmphil added 11 commits August 22, 2024 16:22

fix linting errors and refactor a bit

9cb4048

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

refactor a bit

a97bec0

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

fix alias error and alias arg in import

5e608e3

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

fix alias remove and tag remove

176acc9

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

remove unnecessary nolint directives

2a677f1

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

ignore complexity warning due to simple error handling

a3736c3

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

fix regression that removed search by alias

1e12765

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

rename method for clarity and edit get document log

9a5f925

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

sort commands

6849ee7

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

refactor

d19a311

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

slice usage optimization

5f59b37

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

jhoward-lm requested changes Aug 27, 2024

View reviewed changes

cmd/tag.go Outdated Show resolved Hide resolved

jhoward-lm requested changes Aug 27, 2024

View reviewed changes

internal/pkg/db/db.go Show resolved Hide resolved

cmd/tag.go Outdated Show resolved Hide resolved

lmphil added 2 commits August 27, 2024 11:32

change loop index usage to align with project conventions

2fe92b3

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

chore: update dependencies

341e8fb

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

ashearin reviewed Sep 10, 2024

View reviewed changes

internal/pkg/options/options.go Show resolved Hide resolved

ashearin reviewed Sep 10, 2024

View reviewed changes

internal/pkg/db/db.go Outdated Show resolved Hide resolved

lmphil added 5 commits September 10, 2024 23:10

add missing headers, refactor and update readme

6ebec95

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

add alias and tag options to merge and push commands, and refactor

7bccbd6

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

add alias capabilities to export command

79837e6

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

fix alias list showing documents with no alias

f3f6375

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

update readme

9835dec

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

lmphil added 2 commits September 11, 2024 20:54

add note about aliases to readme

ad57ee2

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

fix linter warnings

6bc8994

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

lmphil requested a review from jhoward-lm September 12, 2024 01:05

lmphil commented Sep 12, 2024

View reviewed changes

internal/pkg/fetch/fetch.go Outdated Show resolved Hide resolved

log non-fatal alias and tag errors instead of failing

88d366d

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

ashearin approved these changes Sep 12, 2024

View reviewed changes

jhoward-lm previously requested changes Sep 16, 2024

View reviewed changes

lmphil added 4 commits September 16, 2024 13:05

Merge branch 'main' of https://github.com/bomctl/bomctl into 65-sbom-…

94c8197

…aliases

update header formatting

b3e7490

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

update header separators

6cb7cac

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

update spdx header snippet

91d31a7

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

ashearin requested changes Sep 16, 2024

View reviewed changes

cmd/tag.go Outdated Show resolved Hide resolved

cmd/tag.go Outdated Show resolved Hide resolved

improve tag command descriptions

355c3bf

Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

ashearin approved these changes Sep 16, 2024

View reviewed changes

Merge branch 'main' of https://github.com/bomctl/bomctl into 65-sbom-…

9436198

…aliases Signed-off-by: Philippe <philippe.a.aviles@lmco.com>

lmphil requested a review from jhoward-lm September 17, 2024 02:50

jhoward-lm approved these changes Sep 17, 2024

View reviewed changes

jhoward-lm merged commit 45de959 into main Sep 17, 2024

jhoward-lm deleted the 65-sbom-aliases branch September 17, 2024 15:28

feat: SBOM Aliases #129

feat: SBOM Aliases #129

Uh oh!

Conversation

lmphil commented Aug 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request

Description

Type of change

How Has This Been Tested?

Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jhoward-lm commented Aug 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jhoward-lm commented Sep 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

idunbarh commented Sep 4, 2024

Uh oh!

Uh oh!

Uh oh!

lmphil commented Sep 12, 2024

Uh oh!

Uh oh!

ashearin left a comment

Choose a reason for hiding this comment

Uh oh!

lmphil commented Sep 12, 2024

Uh oh!

jhoward-lm left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ashearin left a comment

Choose a reason for hiding this comment

Uh oh!

jhoward-lm left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

lmphil commented Aug 14, 2024 •

edited

Loading

jhoward-lm commented Aug 22, 2024 •

edited

Loading

jhoward-lm commented Sep 1, 2024 •

edited

Loading