chore: Adding version info for gk, opa, and frameworks in gator cmd #2338

JaydipGabani · 2022-10-14T01:00:16Z

Signed-off-by: Jaydip Gabani gabanijaydip@gmail.com

What this PR does / why we need it:
Adds more information in output of gator --version

Which issue(s) this PR fixes (optional, using fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when the PR gets merged):
Fixes #1643

Special notes for your reviewer:

Result:

gator --version
gator version 
Gator & Gatekeeper version: v3.10.0-beta.2, OPA version: 0.44.0, Framework Version v0.0.0-20221006234738-a3d297b3152f

sozercan · 2022-10-14T17:11:46Z

@JaydipGabani looks like tests are failing

JaydipGabani · 2022-10-14T18:15:07Z

@sozercan we are good to go for reviews!

sozercan · 2022-10-14T18:53:36Z

go.mod

@@ -27,6 +27,7 @@ require (
 	github.com/onsi/gomega v1.19.0
 	github.com/open-policy-agent/cert-controller v0.4.0
 	github.com/open-policy-agent/frameworks/constraint v0.0.0-20221006234738-a3d297b3152f
+	github.com/open-policy-agent/opa v0.44.0


we don't want to add opa version here but get the dependency through frameworks

So fetch the version from mod file similar to frameworks/constraint ?

sozercan · 2022-10-14T18:54:01Z

gator.Dockerfile

@@ -22,7 +22,7 @@ COPY . /tmp/gatekeeper

 WORKDIR /tmp/gatekeeper/cmd/gator

-RUN go build -mod vendor -a -ldflags "${LDFLAGS:--X github.com/open-policy-agent/gatekeeper/pkg/version.Version=latest}" -o /gator
+RUN go build -mod vendor -a -ldflags "${LDFLAGS}" -o /gator


let's keep the default if LDFLAGS is not passed

sozercan · 2022-10-14T18:56:15Z

Makefile

@@ -22,6 +22,7 @@ BATS_TESTS_FILE ?= test/bats/test.bats
 HELM_VERSION ?= 3.7.2
 NODE_VERSION ?= 16-bullseye-slim
 YQ_VERSION ?= 4.2.0
+FRAMEWORK_VERSION ?= $(shell go list -f '{{ .Version }}' -m github.com/open-policy-agent/frameworks/constraint)


Suggested change

FRAMEWORK_VERSION ?= $(shell go list -f '{{ .Version }}' -m github.com/open-policy-agent/frameworks/constraint)

FRAMEWORKS_VERSION ?= $(shell go list -f '{{ .Version }}' -m github.com/open-policy-agent/frameworks/constraint)

sozercan · 2022-10-14T18:57:45Z

Makefile

@@ -45,6 +46,8 @@ LDFLAGS := "-X github.com/open-policy-agent/gatekeeper/pkg/version.Version=$(VER
 	-X github.com/open-policy-agent/gatekeeper/pkg/version.Timestamp=$(BUILD_TIMESTAMP) \
 	-X github.com/open-policy-agent/gatekeeper/pkg/version.Hostname=$(BUILD_HOSTNAME)"

+GTRFLAGS := ${LDFLAGS} "-X main.frameworkVersion=$(FRAMEWORK_VERSION)" 


i think we can add frameworksVersion to LDFLAGS as it applies there too

sozercan · 2022-10-14T18:59:47Z

cmd/gator/gator.go

 	"github.com/spf13/cobra"
 )

-const version = "alpha"
+var frameworkVersion = "v0.0.0-20221006234738-a3d297b3152f"


how does this get set? can we skip hardcoding this?

codecov-commenter · 2022-10-14T23:56:20Z

Codecov Report

Base: 53.45% // Head: 53.50% // Increases project coverage by +0.04% 🎉

Coverage data is based on head (3923ef0) compared to base (07c6d25).
Patch has no changes to coverable lines.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2338      +/-   ##
==========================================
+ Coverage   53.45%   53.50%   +0.04%     
==========================================
  Files         116      116              
  Lines       10174    10174              
==========================================
+ Hits         5439     5444       +5     
+ Misses       4317     4313       -4     
+ Partials      418      417       -1

Flag	Coverage Δ
unittests	`53.50% <ø> (+0.04%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...onstrainttemplate/constrainttemplate_controller.go	`57.65% <0.00%> (+1.19%)`	⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

nilekhc · 2022-10-17T17:31:31Z

Makefile

 		-t ${GATOR_REPOSITORY}:${DEV_TAG} \
 		-t ${GATOR_REPOSITORY}:dev \
-		-f gator.Dockerfile . --push
+		-f gator.Dockerfile . --load


Do we want to revert this change?

Good catch!! I missed this

nilekhc · 2022-10-17T17:35:25Z

Makefile

@@ -367,10 +371,10 @@ docker-buildx-crds-release: build-crds docker-buildx-builder

 # Build gator image
 docker-buildx-gator-dev: docker-buildx-builder
-	docker buildx build --build-arg LDFLAGS=${LDFLAGS} --platform "linux/amd64,linux/arm64,linux/arm/v6"\


Were these platform versions removed for local testing? If so should we add this back?

Good catch!! I missed this

sozercan · 2022-10-17T18:20:46Z

cmd/gator/gator.go

@@ -24,7 +28,7 @@ func init() {
 var rootCmd = &cobra.Command{
 	Use:     "gator subcommand",
 	Short:   "gator is a suite of authorship tools for Gatekeeper",
-	Version: version,
+	Version: fmt.Sprintf("\nGator & Gatekeeper version: %s, OPA version: %s, Framework version: %s", version.Version, opaVersion, frameworksVersion),


Suggested change

Version: fmt.Sprintf("\nGator & Gatekeeper version: %s, OPA version: %s, Framework version: %s", version.Version, opaVersion, frameworksVersion),

Version: fmt.Sprintf("\nGator version: %s (Feature State: %s), OPA version: %s, Framework version: %s", version.Version, state, opaVersion, frameworksVersion),

state is alpha

sozercan · 2022-10-17T18:22:13Z

cmd/gator/gator.go

+var frameworksVersion string
+
+var opaVersion string


Suggested change

var frameworksVersion string

var opaVersion string

var (

frameworksVersion string

opaVersion string

)

Signed-off-by: Jaydip Gabani <gabanijaydip@gmail.com>

sozercan

Thank you! LGTM

maxsmythe

LGTM, thank you for the PR!

JaydipGabani force-pushed the master branch from f58962b to 17561c7 Compare October 14, 2022 18:04

sozercan requested changes Oct 14, 2022

View reviewed changes

JaydipGabani force-pushed the master branch from 17561c7 to 3923ef0 Compare October 14, 2022 23:49

JaydipGabani requested a review from sozercan October 14, 2022 23:50

JaydipGabani force-pushed the master branch from 3923ef0 to b3e875c Compare October 17, 2022 15:54

nilekhc reviewed Oct 17, 2022

View reviewed changes

JaydipGabani force-pushed the master branch from b3e875c to 201cce7 Compare October 17, 2022 18:00

JaydipGabani requested review from nilekhc and sozercan and removed request for sozercan and nilekhc October 17, 2022 18:00

sozercan reviewed Oct 17, 2022

View reviewed changes

JaydipGabani force-pushed the master branch from 201cce7 to 6598c4b Compare October 17, 2022 19:52

JaydipGabani closed this Oct 17, 2022

JaydipGabani force-pushed the master branch from 6598c4b to 0a06222 Compare October 17, 2022 19:55

JaydipGabani reopened this Oct 17, 2022

chore: Adding version info for gk, opa, and frameworks in gator cmd

e6cd2b2

Signed-off-by: Jaydip Gabani <gabanijaydip@gmail.com>

JaydipGabani force-pushed the master branch from bf2f985 to e6cd2b2 Compare October 17, 2022 20:12

sozercan approved these changes Oct 17, 2022

View reviewed changes

sozercan requested a review from maxsmythe October 17, 2022 20:24

maxsmythe approved these changes Oct 17, 2022

View reviewed changes

maxsmythe merged commit 3ce399a into open-policy-agent:master Oct 17, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Adding version info for gk, opa, and frameworks in gator cmd #2338

chore: Adding version info for gk, opa, and frameworks in gator cmd #2338

JaydipGabani commented Oct 14, 2022 •

edited

sozercan commented Oct 14, 2022

JaydipGabani commented Oct 14, 2022

sozercan Oct 14, 2022

JaydipGabani Oct 14, 2022

sozercan Oct 14, 2022

sozercan Oct 14, 2022

sozercan Oct 14, 2022

sozercan Oct 14, 2022

codecov-commenter commented Oct 14, 2022

nilekhc Oct 17, 2022

JaydipGabani Oct 17, 2022

nilekhc Oct 17, 2022

JaydipGabani Oct 17, 2022

sozercan Oct 17, 2022

sozercan Oct 17, 2022

sozercan left a comment

maxsmythe left a comment

	FRAMEWORK_VERSION ?= $(shell go list -f '{{ .Version }}' -m github.com/open-policy-agent/frameworks/constraint)
	FRAMEWORKS_VERSION ?= $(shell go list -f '{{ .Version }}' -m github.com/open-policy-agent/frameworks/constraint)

	Version: fmt.Sprintf("\nGator & Gatekeeper version: %s, OPA version: %s, Framework version: %s", version.Version, opaVersion, frameworksVersion),
	Version: fmt.Sprintf("\nGator version: %s (Feature State: %s), OPA version: %s, Framework version: %s", version.Version, state, opaVersion, frameworksVersion),

chore: Adding version info for gk, opa, and frameworks in gator cmd #2338

chore: Adding version info for gk, opa, and frameworks in gator cmd #2338

Conversation

JaydipGabani commented Oct 14, 2022 • edited

sozercan commented Oct 14, 2022

JaydipGabani commented Oct 14, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-commenter commented Oct 14, 2022

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sozercan left a comment

Choose a reason for hiding this comment

maxsmythe left a comment

Choose a reason for hiding this comment

JaydipGabani commented Oct 14, 2022 •

edited