scorecard: make config a componentconfig, scaffold config kustomization on `init` #3490

estroz · 2020-07-22T16:11:21Z

Description of the change:

internal/plugins/scorecard: implement scorecard config scaffolds as a (pseudo) phase 2 plugin
internal/plugins/{go/v2,helm/v1}/init.go: add config/scorecard kustomize scaffolds
pkg/apis/scorecard/v1alpha3: add ScorecardConfiguration types that map to the original Config's types
internal/scorecard: replace Config type with v1alpha3.ScorecardConfiguration and related types

Motivation for the change: This PR modifies the scorecard config to be a componentconfig versioned with other scorecard APIs in pkg/apis/scorecard/v1alpha3. It also adds config/scorecard kustomize scaffolds to init, which writes componentconfig bases and patches to config/scorecard. generate kustomize manifests will add the scorecard kustomize path to the manifests kustomization.yaml, and generate bundle will write the scorecard config to bundle/tests/scorecard/config.yaml

/cc @jmccormick2001

/kind feature

Checklist

If the pull request includes user-facing changes, extra documentation is required:

Add a new changelog fragment in changelog/fragments (see changelog/fragments/00-template.yaml)
Add or update relevant sections of the docs website in website/content/en/docs

jmccormick2001

happy path testing shows it working.

joelanford

First pass (don't have time for a long review at the moment).

I saw some references to generate kustomize scorecard still. That's no longer in the PR, right?

pkg/apis/scorecard/v1alpha3/configuration_types.go

versioned with other scorecard APIs in `pkg/apis/scorecard/v1alpha3`. It also adds the `generate kustomize scorecard` subcommand, which scaffolds componentconfig bases and patches in `config/scorecard`. `generate kustomize manifests` will add the scorecard kustomize path to the manifests kustomization.yaml, and `generate bundle` will write the scorecard config to `bundle/tests/scorecard/config.yaml` cmd/operator-sdk/generate: add `kustomize scorecard` subcommand and modify `kustomize manifests` subcommand pkg/apis/scorecard/v1alpha3: add ScorecardConfiguration types that map to the original Config's types internal/scorecard: replace Config type with v1alpha3.ScorecardConfiguration and related types

internal/generate/collector/collect.go

internal/plugins/scorecard/init.go

internal/scorecard/testdata/bundle/tests/scorecard/config.yaml

pkg/apis/scorecard/v1alpha3/configuration_types.go

website/content/en/docs/advanced-topics/scorecard/custom-tests.md

website/content/en/docs/advanced-topics/scorecard/scorecard.md

cmd/operator-sdk/generate/bundle/bundle.go

internal/plugins/helm/v1/init.go

camilamacedo86 · 2020-07-23T17:35:30Z

internal/plugins/scorecard/init.go

@@ -0,0 +1,259 @@
+// Copyright 2020 The Operator-SDK Authors


IMO it should be with the other SDK customizations in operator-sdk/internal/util/plugins/

I'm hesitant to start throwing things into internal/util/plugins like we did with the bundle stuff. Eventually we'll have a bunch of unrelated phase 2-like plugin code in there, and have the mess we currently have in a bunch of internal/util subpackages. The scorecard config scaffold will eventually be its own phase 2 plugin I expect, so should live here.

I agree with @estroz's sentiment. Maybe as a follow-up we should move the "OLM"-like plugin stuff from operator-sdk/internal/util/plugins/ back into internal/plugins/olm

And then also try to refactor them to look as much like what we think phase 2 plugins will look like. Given that we're duplicating the kubebuilder machinery code, I think we could refactor these to use the scaffold and template interfaces.

with you will do olm, scorecard and etc .. then I am ok with. I just do not like the idea of each requirement be solved in a diff way.

camilamacedo86 · 2020-07-23T17:40:23Z

internal/plugins/scorecard/init.go

+patchesJson6902:
+{{- range $i, $patch := .JSONPatches }}
+- path: {{ $patch.Path }}
+  target:
+    group: {{ $patch.Target.Group }}
+    version: {{ $patch.Target.Version }}
+    kind: {{ $patch.Target.Kind }}
+    name: {{ $patch.Target.Name }}
+{{- end }}


Why we do not it as the watches and the other features in kb and helm as well?

IMO we should use the default kubebuilder markers instead of that. E.g # +kubebuilder:scaffold:scorecard. I do not think that is following the current design. Note that kb has a lot of helpers for the markers which indeed let us mock the tests which will not be possible to be used here.

Because we would be defining our own struct for a kustomize type. This type may exist in the kustomize codebase, but I'd rather not import kustomize libraries if we don't have to.

internal/plugins/scorecard/init.go

joelanford

/lgtm

after addressing above comment about the marker

openshift-ci-robot · 2020-07-23T20:10:43Z

New changes are detected. LGTM label has been removed.

openshift-ci-robot requested a review from jmccormick2001 July 22, 2020 16:11

openshift-ci-robot added the kind/feature Categorizes issue or PR as related to a new feature. label Jul 22, 2020

joelanford mentioned this pull request Jul 22, 2020

Operator SDK 1.0 Meta-issue #3327

Closed

92 tasks

estroz force-pushed the feature/scorecard-componentconfig branch 2 times, most recently from 9d6e509 to 10fd41d Compare July 22, 2020 16:43

jmccormick2001 approved these changes Jul 22, 2020

View reviewed changes

estroz force-pushed the feature/scorecard-componentconfig branch from 10fd41d to 16dee30 Compare July 22, 2020 20:41

joelanford reviewed Jul 22, 2020

View reviewed changes

pkg/apis/scorecard/v1alpha3/configuration_types.go Outdated Show resolved Hide resolved

pkg/apis/scorecard/v1alpha3/configuration_types.go Outdated Show resolved Hide resolved

pkg/apis/scorecard/v1alpha3/configuration_types.go Outdated Show resolved Hide resolved

estroz changed the title ~~scorecard: replace config with a componentconfig, add generate kustomize scorecard subcommand~~ scorecard: replace config with a componentconfig, add config scaffold to init Jul 22, 2020

estroz changed the title ~~scorecard: replace config with a componentconfig, add config scaffold to init~~ scorecard: make config a componentconfig, scaffold config kustomization on init Jul 22, 2020

estroz added 6 commits July 23, 2020 08:19

move config/scorecard scaffold to 'init' plugins

ff1c2b0

add changelog fragment

3187148

updates to config spec

22883b9

update scorecard docs

76c9817

update test bundle

3d7fdb5

estroz force-pushed the feature/scorecard-componentconfig branch from 27c2806 to 3d7fdb5 Compare July 23, 2020 15:21

joelanford requested changes Jul 23, 2020

View reviewed changes

camilamacedo86 reviewed Jul 23, 2020

View reviewed changes

cmd/operator-sdk/generate/bundle/bundle.go Outdated Show resolved Hide resolved

camilamacedo86 reviewed Jul 23, 2020

View reviewed changes

internal/plugins/helm/v1/init.go Outdated Show resolved Hide resolved

camilamacedo86 reviewed Jul 23, 2020

View reviewed changes

estroz force-pushed the feature/scorecard-componentconfig branch 2 times, most recently from 69916b7 to aaf7764 Compare July 23, 2020 19:38

estroz requested review from joelanford and camilamacedo86 July 23, 2020 19:42

joelanford reviewed Jul 23, 2020

View reviewed changes

internal/plugins/scorecard/init.go Outdated Show resolved Hide resolved

estroz force-pushed the feature/scorecard-componentconfig branch from aaf7764 to 5ece020 Compare July 23, 2020 20:01

joelanford approved these changes Jul 23, 2020

View reviewed changes

openshift-ci-robot assigned joelanford Jul 23, 2020

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Jul 23, 2020

updates based on PR comments

75b2dfc

estroz force-pushed the feature/scorecard-componentconfig branch from 5ece020 to 75b2dfc Compare July 23, 2020 20:10

openshift-ci-robot removed the lgtm Indicates that a PR is ready to be merged. label Jul 23, 2020

estroz merged commit ff73712 into operator-framework:master Jul 23, 2020

estroz deleted the feature/scorecard-componentconfig branch July 23, 2020 20:48

estroz mentioned this pull request Jul 25, 2020

cmd/operator-sdk,internal: remove legacy CLI, clean up utils #3533

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

scorecard: make config a componentconfig, scaffold config kustomization on `init` #3490

scorecard: make config a componentconfig, scaffold config kustomization on `init` #3490

estroz commented Jul 22, 2020 •

edited

Loading

jmccormick2001 left a comment

joelanford left a comment

camilamacedo86 Jul 23, 2020

estroz Jul 23, 2020

joelanford Jul 23, 2020

camilamacedo86 Jul 23, 2020

camilamacedo86 Jul 23, 2020

estroz Jul 23, 2020

joelanford left a comment •

edited

Loading

openshift-ci-robot commented Jul 23, 2020

scorecard: make config a componentconfig, scaffold config kustomization on init #3490

scorecard: make config a componentconfig, scaffold config kustomization on init #3490

Conversation

estroz commented Jul 22, 2020 • edited Loading

jmccormick2001 left a comment

Choose a reason for hiding this comment

joelanford left a comment

Choose a reason for hiding this comment

camilamacedo86 Jul 23, 2020

Choose a reason for hiding this comment

estroz Jul 23, 2020

Choose a reason for hiding this comment

joelanford Jul 23, 2020

Choose a reason for hiding this comment

camilamacedo86 Jul 23, 2020

Choose a reason for hiding this comment

camilamacedo86 Jul 23, 2020

Choose a reason for hiding this comment

estroz Jul 23, 2020

Choose a reason for hiding this comment

joelanford left a comment • edited Loading

Choose a reason for hiding this comment

openshift-ci-robot commented Jul 23, 2020

scorecard: make config a componentconfig, scaffold config kustomization on `init` #3490

scorecard: make config a componentconfig, scaffold config kustomization on `init` #3490

estroz commented Jul 22, 2020 •

edited

Loading

joelanford left a comment •

edited

Loading