feat: add info command #101

rebornplusplus · 2023-10-19T07:13:05Z

This PR adds a new info command which shows detailed information about package slices.

It accepts a white-space-separated list of strings. The list can be composed of package names, slice names, or a combination of both. The default output format is YAML. When multiple package or slice names are provided, the output is a list of YAML documents, separated by three dashes (“---”).

Slice definitions are shown verbatim according to their definition in the Chisel releases. For example, "globs" are not expanded.

Usage:
  chisel info [info-OPTIONS] [<pkg|slice>...]

[info command options]
      --release=<branch|dir>      Chisel release branch or directory

Expand to see full specification

Command

chisel info

Usage

chisel info [info-OPTIONS] [<pkg|slice>...]

Description

The info command shows detailed information about package slices in a Chisel release. It accepts a white-space separated list of strings. The list can be composed of package names, slice names, or a combination of both.The package slices are then looked for within the upstream chisel-releases repository.

The default output format is YAML. When multiple package/slice names are provided, the output is a list of YAML documents, separated by three dashes (“---”).

If no pkgs/slices are provided, it returns an error. At least one pkg/slicename is required.
If one or more pkgs/slices are provided, it returns a list of their slice definitions.
For slice names, it returns the corresponding package’s SDF, excluding any other package slices which have not been requested.
If multiple slices of the same package are provided, it returns the corresponding package’s SDF just once (i.e. the output can only have one YAML document per package, regardless of how many slices are specified).
If not all pkgs/slices can be found, it returns a list with slice definitions AND an error (to stderr), listing the pkgs/slices that could not be found.
If no packages can be found, it returns an error.
Slice definitions are shown verbatim according to their definition in the Chisel releases. E.g. expressions like globs are not expanded.

[info-OPTIONS]

--release <ubuntu-release|dir>

(Optional) The --release option filters the search. It behaves similar to the --release option to chisel cut. If unspecified, the ubuntu release will be parsed from the host OS. If an ubuntu-release is passed as the argument, the find command only searches for slices in that release branch. If a path to a chisel-release directory is passed as the argument, it parses the directory as a chisel-release and only searches for available slices in that directory.

Examples

$ chisel info openssl_config libssl3_libs 2>/dev/null
package: openssl
archive: ubuntu
slices:
    config:
        contents:
            /etc/ssl/openssl.cnf: {}
            /etc/ssl/private/: {}
            /usr/lib/ssl/certs: {}
            /usr/lib/ssl/openssl.cnf: {}
            /usr/lib/ssl/private: {}
---
package: libssl3
archive: ubuntu
slices:
    libs:
        essential:
            - libc6_libs
        contents:
            /usr/lib/*-linux-*/engines-3/afalg.so: {}
            /usr/lib/*-linux-*/engines-3/loader_attic.so: {}
            /usr/lib/*-linux-*/engines-3/padlock.so: {}
            /usr/lib/*-linux-*/libcrypto.so.*: {}
            /usr/lib/*-linux-*/libssl.so.*: {}
            /usr/lib/*-linux-*/ossl-modules/legacy.so: {}

$ chisel info foo_bar
2023/10/20 11:48:23 Consulting release repository...
2023/10/20 11:48:24 Cached ubuntu-22.04 release is still up-to-date.
2023/10/20 11:48:24 Processing ubuntu-22.04 release...
error: no slice definitions found for: "foo_bar"

Additional information

Changes introduced in 944cd6c are also present in feat: add find command #99.

Have you signed the CLA?

Previously, release info (setup.Release) parsing/reading logic was written in cmd/chisel/cmd_cut.go file. Being the only operation command before, it made sense to have it there. But, since there are incoming new commands, it is likely that this logic will be re-used. Thus, move it to a function, ``getRelease()``.

This commit adds functionalities to produce YAML outputs for ``setup.Package`` and ``setup.Slice`` objects.

This commit adds a new ``info`` command which shows detailed information about package slices. It accepts a white-space separated list of strings. The list can be composed of package names, slice names, or a combination of both. The default output format is YAML. When multiple package or slice names are provided, the output is a list of YAML documents, separated by three dashes (“---”). Slice definitions are shown verbatim according to their definition in the Chisel releases. For example, "globs" are not expanded. --- Usage: chisel info [info-OPTIONS] [<pkg|slice>...] [info command options] --release=<branch|dir> Chisel release branch or directory

rebornplusplus · 2023-10-19T07:23:09Z

ping @cjdcordeiro @woky @niemeyer

woky

Can't find anything to nitpick on. LGTM.

benhoyt

Looks good. Just a few very nitty comments/suggestions.

cmd/chisel/cmd_info.go

internal/setup/setup.go

cjdcordeiro

Noice :)

It lgtm but I'm just leaving a bunch of nitpicks :p

cmd/chisel/cmd_help.go

cmd/chisel/cmd_info.go

cmd/chisel/cmd_info_test.go

cjdcordeiro

Great, thanks for the changes. it lgtm

letFunny

Code looks very good. I left some small, mostly nitpicky, comments.

cmd/chisel/cmd_info.go

cmd/chisel/cmd_cut.go

cmd/chisel/cmd_info.go

cmd/chisel/cmd_info_test.go

internal/setup/setup.go

internal/setup/setup_test.go

internal/setup/setup.go

cmd/chisel/helpers.go

Instead of checking if the output YAML equals exactly to the expected YAML by string checking, parse both YAMLs instead. Then compare to see if they are equal.

letFunny

Some more minor comments

internal/setup/setup.go

Use meaningful paths in slices.

letFunny

Thanks for this Rafid, LGTM, only a couple of nitpicks based on the latest changes and what we discussed.

tests/info/task.yaml

cmd/chisel/cmd_info_test.go

internal/setup/setup.go

cmd/chisel/cmd_info.go

internal/setup/setup.go

canonical#101 (review)

niemeyer

Thank you all. This is looking pretty good already, but a few details need addressing:

cmd/chisel/cmd_info.go

internal/setup/setup.go

internal/setup/setup_test.go

internal/setup/setup.go

niemeyer

This is looking good. Only remaining question is the mutability question that was already in the previous review. It changed, but it's not clear what is the real intention or the current state yet.

internal/setup/setup.go

internal/setup/setup_test.go

letFunny

Thanks Rafid, one minor thing.

internal/setup/setup.go

internal/setup/setup_test.go

letFunny

Last minor things in the same spirit as one of the comments by Gustavo

internal/setup/setup_test.go

niemeyer

LGTM, thank you both.

rebornplusplus added 4 commits October 16, 2023 17:55

feat: add YAML marshalling logic for Package, Slice

58e47df

This commit adds functionalities to produce YAML outputs for ``setup.Package`` and ``setup.Slice`` objects.

test(cmd/info): add tests for the info command

8e28abb

cjdcordeiro requested review from woky, niemeyer and cjdcordeiro October 19, 2023 07:26

woky assigned niemeyer Oct 19, 2023

woky approved these changes Oct 19, 2023

View reviewed changes

benhoyt reviewed Oct 19, 2023

View reviewed changes

fix: change long names and address feedback from Ben

b886f47

rebornplusplus requested a review from benhoyt October 20, 2023 05:42

benhoyt approved these changes Oct 20, 2023

View reviewed changes

cjdcordeiro requested changes Oct 20, 2023

View reviewed changes

cjdcordeiro mentioned this pull request Oct 20, 2023

feat: add find command #99

Merged

1 task

fix: address feedback from Cris

c866c95

rebornplusplus requested a review from cjdcordeiro October 20, 2023 09:13

cjdcordeiro approved these changes Oct 20, 2023

View reviewed changes

cjdcordeiro mentioned this pull request Oct 23, 2023

status of database and effort? canonical/chisel-releases#34

Closed

cjdcordeiro added the Priority Look at me first label Oct 26, 2023

letFunny reviewed Nov 14, 2023

View reviewed changes

cjdcordeiro mentioned this pull request Nov 16, 2023

Have we considered moving this function outside of cmd_cut now that cmd_info also relies on it? #103

Open

fix: address feedback from Alberto

5161cc2

rebornplusplus requested a review from letFunny November 28, 2023 07:34

letFunny reviewed Nov 28, 2023

View reviewed changes

cmd/chisel/helpers.go Outdated Show resolved Hide resolved

rebornplusplus added 2 commits November 29, 2023 12:32

test(cmd/info): compare YAMLs after parsing

5ca6ac8

Instead of checking if the output YAML equals exactly to the expected YAML by string checking, parse both YAMLs instead. Then compare to see if they are equal.

refactor: move GetRelease to setup package

7f4f48b

rebornplusplus requested a review from letFunny December 4, 2023 10:00

letFunny reviewed Dec 4, 2023

View reviewed changes

internal/setup/setup.go Outdated Show resolved Hide resolved

rebornplusplus added 4 commits August 1, 2024 17:49

test(info): re-structure cmd_info tests

e9e23b3

Use meaningful paths in slices.

test: fix typo on chisel bin path

fda125b

test: install yq as a dep in spread test

c7a8546

test: download yq binary instead of go install

e8639dd

letFunny approved these changes Aug 5, 2024

View reviewed changes

fix: address review comments

b85eb2a

canonical#101 (review)

letFunny removed the Blocked Waiting for something external label Aug 6, 2024

rebornplusplus added 2 commits August 6, 2024 15:35

empty commit

e7cf89e

Merge remote-tracking branch 'upstream/main'

72ffb2d

rebornplusplus added the Priority Look at me first label Aug 30, 2024

Merge remote-tracking branch 'upstream/main'

c3afbd4

niemeyer requested changes Sep 14, 2024

View reviewed changes

letFunny reviewed Sep 17, 2024

View reviewed changes

internal/setup/setup.go Show resolved Hide resolved

letFunny added the Blocked Waiting for something external label Sep 17, 2024

rebornplusplus added 3 commits September 19, 2024 14:19

fix: minor changes regarding docs and order per review

41a9777

fix: address review comments

25e11ba

empty commit to trigger the workflows

35cee63

letFunny approved these changes Sep 20, 2024

View reviewed changes

letFunny removed the Blocked Waiting for something external label Sep 20, 2024

niemeyer requested changes Sep 23, 2024

View reviewed changes

internal/setup/setup.go Outdated Show resolved Hide resolved

internal/setup/setup_test.go Outdated Show resolved Hide resolved

internal/setup/setup_test.go Outdated Show resolved Hide resolved

letFunny added the Blocked Waiting for something external label Sep 24, 2024

fix: address review comments

3d792c1

letFunny suggested changes Sep 24, 2024

View reviewed changes

internal/setup/setup.go Outdated Show resolved Hide resolved

internal/setup/setup_test.go Outdated Show resolved Hide resolved

fix: minor changes requested by Alberto

939cbd6

letFunny approved these changes Sep 25, 2024

View reviewed changes

internal/setup/setup_test.go Outdated Show resolved Hide resolved

internal/setup/setup_test.go Outdated Show resolved Hide resolved

fix: avoid unnecessary type casting

ed480dd

letFunny removed the Blocked Waiting for something external label Sep 25, 2024

letFunny requested a review from niemeyer September 26, 2024 16:08

niemeyer approved these changes Sep 27, 2024

View reviewed changes

niemeyer merged commit 247bdb9 into canonical:main Sep 27, 2024
14 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add info command #101

feat: add info command #101

rebornplusplus commented Oct 19, 2023 •

edited

Loading

rebornplusplus commented Oct 19, 2023

woky left a comment

benhoyt left a comment

cjdcordeiro left a comment

cjdcordeiro left a comment

letFunny left a comment

letFunny left a comment

letFunny left a comment

niemeyer left a comment

niemeyer left a comment

letFunny left a comment

letFunny left a comment

niemeyer left a comment

feat: add info command #101

feat: add info command #101

Conversation

rebornplusplus commented Oct 19, 2023 • edited Loading

Command

Usage

Description

[info-OPTIONS]

Examples

Additional information

rebornplusplus commented Oct 19, 2023

woky left a comment

Choose a reason for hiding this comment

benhoyt left a comment

Choose a reason for hiding this comment

cjdcordeiro left a comment

Choose a reason for hiding this comment

cjdcordeiro left a comment

Choose a reason for hiding this comment

letFunny left a comment

Choose a reason for hiding this comment

letFunny left a comment

Choose a reason for hiding this comment

letFunny left a comment

Choose a reason for hiding this comment

niemeyer left a comment

Choose a reason for hiding this comment

niemeyer left a comment

Choose a reason for hiding this comment

letFunny left a comment

Choose a reason for hiding this comment

letFunny left a comment

Choose a reason for hiding this comment

niemeyer left a comment

Choose a reason for hiding this comment

rebornplusplus commented Oct 19, 2023 •

edited

Loading