support json and yaml format outputs #31

ykakarap · 2021-03-02T02:59:20Z

What type of PR is this?

/kind feature
/kind api-change

What this PR does / why we need it:

This PR add support for formatted outputs.
The following formats are supported:

JSON
YAML
LOG (Default)

Zeitgiest can be used by other systems, like build systems, to form further actions on the outputs.
Providing machine readable outputs allows zeitgeitst's outputs to be consumed by downstream settings.

Adds --output-format to specify the format of the output. Supported values are yaml, json and log (default).
Adds --output-file to specify the file if format is yaml or json. Defaults to dependencies_output.(yaml|json).

Which issue(s) this PR fixes:

Special notes for your reviewer:

Does this PR introduce a user-facing change?

Yes

Support for machine readable outputs. Supports JSON and YAML

ykakarap · 2021-03-02T04:19:39Z

/cc @cpanato
/cc @justaugustus

chlunde · 2021-03-02T09:03:00Z

dependencies/versions.go

@@ -21,6 +21,12 @@ import (
 	"github.com/pkg/errors"
 )

+type VersionUpdate struct {


Maybe add a note that this is also the external schema for the JSON/YAML output.

cpanato · 2021-03-02T12:00:01Z

testdata/remote-dummy-with-update.yaml

+    version: 0.0.1
+    upstream:
+      flavour: dummy
+      url: example/example


nit: new line

cpanato · 2021-03-02T12:01:22Z

cmd/validate.go

+	}
+
+	if o.outputFile != "" && o.outputFormat == "" {
+		logrus.Warnf("ignoring --output-file as not --output-format is not specified")


but we can output to a file the log format or not?

Good catch.
As mentioned in the description of the --output-file flag, it is only used if the output format is yaml or json.
If the output-format is log it will print the output to stdout (as before).

cpanato

a few nits and comments
thanks for doing this!

dependencies/versions.go

justaugustus · 2021-03-09T00:57:55Z

/hold for #36 and #38

EDIT: Both PRs have merged. We can cancel the hold once this has been rebased and adds the export command, as discussed w/ @ykakarap on Slack.

ykakarap · 2021-03-11T21:25:10Z

/test pull-zeitgeist-verify

This command support formatted output. Supports JSON and YAML.

ykakarap · 2021-03-11T21:38:48Z

@justaugustus rebased and now implements the logic under a new export command.

justaugustus · 2021-03-11T23:12:27Z

@ykakarap -- Thanks so much for this functionality!
I have some microscopic nits here, but as mentioned on Slack, I'm going to work them into the next refactor.

/hold cancel
/lgtm
/approve

k8s-ci-robot · 2021-03-11T23:12:34Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: justaugustus, ykakarap

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [justaugustus]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot added kind/feature Categorizes issue or PR as related to a new feature. kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API labels Mar 2, 2021

k8s-ci-robot requested review from cpanato and n3wscott March 2, 2021 02:59

k8s-ci-robot added sig/release Categorizes an issue or PR as relevant to SIG Release. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 2, 2021

ykakarap changed the title ~~support json and yaml format outputs~~ [WIP] support json and yaml format outputs Mar 2, 2021

k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 2, 2021

ykakarap force-pushed the formatted_output branch from 8ad23cd to a510490 Compare March 2, 2021 03:57

ykakarap changed the title ~~[WIP] support json and yaml format outputs~~ support json and yaml format outputs Mar 2, 2021

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 2, 2021

k8s-ci-robot requested a review from justaugustus March 2, 2021 04:19

chlunde reviewed Mar 2, 2021

View reviewed changes

cpanato reviewed Mar 2, 2021

View reviewed changes

testdata/remote-dummy-with-update.yaml Outdated

version: 0.0.1

upstream:

flavour: dummy

url: example/example

Copy link

Member

cpanato Mar 2, 2021

Choose a reason for hiding this comment

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

nit: new line

cpanato reviewed Mar 2, 2021

View reviewed changes

cpanato requested changes Mar 2, 2021

View reviewed changes

k8s-ci-robot assigned cpanato Mar 2, 2021

ykakarap force-pushed the formatted_output branch from a510490 to eda4add Compare March 3, 2021 00:29

chlunde reviewed Mar 3, 2021

View reviewed changes

dependencies/versions.go Outdated Show resolved Hide resolved

ykakarap force-pushed the formatted_output branch from eda4add to cc65793 Compare March 7, 2021 21:20

justaugustus mentioned this pull request Mar 9, 2021

commands: Init importable package for zeitgeist commands #36

Merged

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 9, 2021

justaugustus mentioned this pull request Mar 9, 2021

dependencies.yaml: Update zeitgeist to v0.3.0 kubernetes/release#1933

Merged

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 9, 2021

justaugustus added this to In progress in Release Engineering (k-sigs) via automation Mar 9, 2021

ykakarap force-pushed the formatted_output branch 2 times, most recently from 5180d62 to cd910d8 Compare March 11, 2021 21:21

add export command to list 'latest' upstream versions

31b73b8

This command support formatted output. Supports JSON and YAML.

ykakarap force-pushed the formatted_output branch from cd910d8 to 31b73b8 Compare March 11, 2021 21:34

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 11, 2021

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 11, 2021

k8s-ci-robot assigned justaugustus Mar 11, 2021

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 11, 2021

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 11, 2021

k8s-ci-robot merged commit 53633f7 into kubernetes-sigs:master Mar 11, 2021

Release Engineering (k-sigs) automation moved this from In progress to Done Mar 11, 2021

This was referenced May 31, 2021

JSON output for extensibility #21

Closed

Formatted output for extensibility #30

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

support json and yaml format outputs #31

support json and yaml format outputs #31

ykakarap commented Mar 2, 2021 •

edited

ykakarap commented Mar 2, 2021

chlunde Mar 2, 2021

cpanato Mar 2, 2021

ykakarap Mar 3, 2021

cpanato Mar 2, 2021

cpanato Mar 2, 2021

ykakarap Mar 3, 2021

cpanato left a comment

justaugustus commented Mar 9, 2021 •

edited

ykakarap commented Mar 11, 2021

ykakarap commented Mar 11, 2021

justaugustus commented Mar 11, 2021

k8s-ci-robot commented Mar 11, 2021

support json and yaml format outputs #31

support json and yaml format outputs #31

Conversation

ykakarap commented Mar 2, 2021 • edited

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for your reviewer:

Does this PR introduce a user-facing change?

ykakarap commented Mar 2, 2021

chlunde Mar 2, 2021

Choose a reason for hiding this comment

cpanato Mar 2, 2021

Choose a reason for hiding this comment

ykakarap Mar 3, 2021

Choose a reason for hiding this comment

cpanato Mar 2, 2021

Choose a reason for hiding this comment

cpanato Mar 2, 2021

Choose a reason for hiding this comment

ykakarap Mar 3, 2021

Choose a reason for hiding this comment

cpanato left a comment

Choose a reason for hiding this comment

justaugustus commented Mar 9, 2021 • edited

ykakarap commented Mar 11, 2021

ykakarap commented Mar 11, 2021

justaugustus commented Mar 11, 2021

k8s-ci-robot commented Mar 11, 2021

ykakarap commented Mar 2, 2021 •

edited

justaugustus commented Mar 9, 2021 •

edited