✨ store all config info (go/v3-alpha)

[camilamacedo86]

Description

Store in the PROJECT file:

• webhooks data
• if has or not an api scaffolded
• if has or not a controller scaffolded
• API domain and endpoint when it is not the default form
• Plural form when it is not the default form

Refractories/Cleanups suggested:

• Rename Domain in the internal code for QualifiedGroup
• Rename Package for Endpoint
• Rename GVK to ResourceData since it does not return only the GKV
• Replace doResource with doAPI only for v3 internal code.

PS.: Note the plugin v2 internal code was changed/updated where only it would be mandatory in order to move forward with the changes. The idea is we ensure and not risk introduces breaking changes or bugs into it since we are closer to deprecated it.

Regards the tests:

• Add new tests to cover the config
• Add new api scaffolded in the testdata for multigroup projects to cover better the k8s core types option.

Example

Following an example with the edge cases and that cover nearly all scenarios.

domain: testproject.org
layout: go.kubebuilder.io/v3-alpha
multigroup: true
projectName: project-v3-multigroup
repo: sigs.k8s.io/kubebuilder/testdata/project-v3-multigroup
resources:
- controller: true
  domain: k8s.io
  endpoint: k8s.io/api/authentication/v1
  group: authentication
  kind: TokenReview
  version: v1
- api:
    crdVersion: v1
    namespaced: true
  controller: true
  domain: testproject.org
  kind: Lakers
  version: v1
  webhooks:
    defaulting: true
    validation: true
    webhookVersion: v1
version: 3-alpha

Motivation

• Allow we have all project config into the config which can, for example, grant we re-create the project based on it.
• keep the consistency across the project
• Allow we easily manage diff versions of apiVersions for webhooks and CRDs. See that the apiVersion fits very well as an attribute of its models. So, we could store the apiVersion which would allow how the tool should dealing with each case scenario. See: ⚠️ (go/v3-alpha) default to v1 CRDs and webhooks #1644 (comment)

Close: #1826

/hold

If we do not able o ve forward with #1869 instead of this one. Then, here would be required to do a few changes :

• Use the nomenclature Path instead of endpoint
• Do not store the domain when it is a core value.

[gabbifish]

I have some minor nits and a suggestion for an extra validity check, otherwise this looks great!! Your tests are so comprehensive 😍

[camilamacedo86]

/hold cancel

@gabbifish fell free to re-check

[gabbifish]

Some tiny nits for gkv->gvk--once those are done, I'll approve! :D

[camilamacedo86]

/hold

we are trying to reach a consensus to move forward here.

[estroz]

There seems to be a mismatch of data between config.ResourceData, resource.Resource, and resource.Options. The latter two are constructed by the plugin layer, which passes a resource.Resource to the scaffold layer to be used and updated. Therefore all of these structs should have the same field subset relating to a resource as an element of config.ResourceData.Resources.

[camilamacedo86]

/test pull-kubebuilder-e2e-k8s-1-18-0

[camilamacedo86]

/hold cancel

It has all suggested attrs in the format agreed as it is addressing all suggested made.

[camilamacedo86]

Close in favor of #1869