djpbessems/ContainerImage.Pinniped
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #205 from mattmoyer/more-careful-categories

Browse Source 
Put all of our APIs into a "pinniped" category, and never use "all".
This commit is contained in:
Matt Moyer 2020-11-12 17:37:20 -06:00 committed by GitHub
commit e6f128e2a7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
28 changed files with 94 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
apis/concierge/authentication/v1alpha1/types_webhook.go.tmpl
View File

@ -30,7 +30,7 @@ type WebhookAuthenticatorSpec struct {
// WebhookAuthenticator describes the configuration of a webhook authenticator.
// +genclient
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +kubebuilder:resource:categories=all;authenticator;authenticators
// +kubebuilder:resource:categories=pinniped;pinniped-authenticator;pinniped-authenticators
// +kubebuilder:printcolumn:name="Endpoint",type=string,JSONPath=`.spec.endpoint`
type WebhookAuthenticator struct {
metav1.TypeMeta `json:",inline"`

3
apis/concierge/config/v1alpha1/types_credentialissuer.go.tmpl
View File

@ -68,7 +68,7 @@ type CredentialIssuerStrategy struct {
// Describes the configuration status of a Pinniped credential issuer.
// +genclient
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +kubebuilder:resource:categories=pinniped
type CredentialIssuer struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
@ -79,7 +79,6 @@ type CredentialIssuer struct {
// List of CredentialIssuer objects.
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
type CredentialIssuerList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`

1
apis/supervisor/config/v1alpha1/types_oidcprovider.go.tmpl
View File

@ -86,6 +86,7 @@ type OIDCProviderStatus struct {
// OIDCProvider describes the configuration of an OIDC provider.
// +genclient
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +kubebuilder:resource:categories=pinniped
type OIDCProvider struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`

6
deploy/concierge/authentication.concierge.pinniped.dev_webhookauthenticators.yaml
View File

@ -11,9 +11,9 @@ spec:
group: authentication.concierge.pinniped.dev
names:
categories:
- all
- authenticator
- authenticators
- pinniped
- pinniped-authenticator
- pinniped-authenticators
kind: WebhookAuthenticator
listKind: WebhookAuthenticatorList
plural: webhookauthenticators

3
deploy/concierge/config.concierge.pinniped.dev_credentialissuers.yaml
View File

@ -10,6 +10,8 @@ metadata:
spec:
group: config.concierge.pinniped.dev
names:
categories:
- pinniped
kind: CredentialIssuer
listKind: CredentialIssuerList
plural: credentialissuers
@ -19,6 +21,7 @@ spec:
- name: v1alpha1
schema:
openAPIV3Schema:
description: Describes the configuration status of a Pinniped credential issuer.
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation

2
deploy/supervisor/config.supervisor.pinniped.dev_oidcproviders.yaml
View File

@ -10,6 +10,8 @@ metadata:
spec:
group: config.supervisor.pinniped.dev
names:
categories:
- pinniped
kind: OIDCProvider
listKind: OIDCProviderList
plural: oidcproviders

2
generated/1.17/README.adoc generated
View File

@ -125,7 +125,7 @@ Package v1alpha1 is the v1alpha1 version of the Pinniped concierge configuration
[id="{anchor_prefix}-go-pinniped-dev-generated-1-17-apis-concierge-config-v1alpha1-credentialissuer"]
==== CredentialIssuer
Describes the configuration status of a Pinniped credential issuer.
.Appears In:
****

2
generated/1.17/apis/concierge/authentication/v1alpha1/types_webhook.go generated
View File

@ -30,7 +30,7 @@ type WebhookAuthenticatorSpec struct {
// WebhookAuthenticator describes the configuration of a webhook authenticator.
// +genclient
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +kubebuilder:resource:categories=all;authenticator;authenticators
// +kubebuilder:resource:categories=pinniped;pinniped-authenticator;pinniped-authenticators
// +kubebuilder:printcolumn:name="Endpoint",type=string,JSONPath=`.spec.endpoint`
type WebhookAuthenticator struct {
metav1.TypeMeta `json:",inline"`

3
generated/1.17/apis/concierge/config/v1alpha1/types_credentialissuer.go generated
View File

@ -68,7 +68,7 @@ type CredentialIssuerStrategy struct {
// Describes the configuration status of a Pinniped credential issuer.
// +genclient
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +kubebuilder:resource:categories=pinniped
type CredentialIssuer struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
@ -79,7 +79,6 @@ type CredentialIssuer struct {
// List of CredentialIssuer objects.
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
type CredentialIssuerList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`

1
generated/1.17/apis/supervisor/config/v1alpha1/types_oidcprovider.go generated
View File

@ -86,6 +86,7 @@ type OIDCProviderStatus struct {
// OIDCProvider describes the configuration of an OIDC provider.
// +genclient
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +kubebuilder:resource:categories=pinniped
type OIDCProvider struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`

6
generated/1.17/crds/authentication.concierge.pinniped.dev_webhookauthenticators.yaml generated
View File

@ -11,9 +11,9 @@ spec:
group: authentication.concierge.pinniped.dev
names:
categories:
- all
- authenticator
- authenticators
- pinniped
- pinniped-authenticator
- pinniped-authenticators
kind: WebhookAuthenticator
listKind: WebhookAuthenticatorList
plural: webhookauthenticators

3
generated/1.17/crds/config.concierge.pinniped.dev_credentialissuers.yaml generated
View File

@ -10,6 +10,8 @@ metadata:
spec:
group: config.concierge.pinniped.dev
names:
categories:
- pinniped
kind: CredentialIssuer
listKind: CredentialIssuerList
plural: credentialissuers
@ -19,6 +21,7 @@ spec:
- name: v1alpha1
schema:
openAPIV3Schema:
description: Describes the configuration status of a Pinniped credential issuer.
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation

2
generated/1.17/crds/config.supervisor.pinniped.dev_oidcproviders.yaml generated
View File

@ -10,6 +10,8 @@ metadata:
spec:
group: config.supervisor.pinniped.dev
names:
categories:
- pinniped
kind: OIDCProvider
listKind: OIDCProviderList
plural: oidcproviders

2
generated/1.18/README.adoc generated
View File

@ -125,7 +125,7 @@ Package v1alpha1 is the v1alpha1 version of the Pinniped concierge configuration
[id="{anchor_prefix}-go-pinniped-dev-generated-1-18-apis-concierge-config-v1alpha1-credentialissuer"]
==== CredentialIssuer
Describes the configuration status of a Pinniped credential issuer.
.Appears In:
****

2
generated/1.18/apis/concierge/authentication/v1alpha1/types_webhook.go generated
View File

@ -30,7 +30,7 @@ type WebhookAuthenticatorSpec struct {
// WebhookAuthenticator describes the configuration of a webhook authenticator.
// +genclient
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +kubebuilder:resource:categories=all;authenticator;authenticators
// +kubebuilder:resource:categories=pinniped;pinniped-authenticator;pinniped-authenticators
// +kubebuilder:printcolumn:name="Endpoint",type=string,JSONPath=`.spec.endpoint`
type WebhookAuthenticator struct {
metav1.TypeMeta `json:",inline"`

3
generated/1.18/apis/concierge/config/v1alpha1/types_credentialissuer.go generated
View File

@ -68,7 +68,7 @@ type CredentialIssuerStrategy struct {
// Describes the configuration status of a Pinniped credential issuer.
// +genclient
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +kubebuilder:resource:categories=pinniped
type CredentialIssuer struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
@ -79,7 +79,6 @@ type CredentialIssuer struct {
// List of CredentialIssuer objects.
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
type CredentialIssuerList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`

1
generated/1.18/apis/supervisor/config/v1alpha1/types_oidcprovider.go generated
View File

@ -86,6 +86,7 @@ type OIDCProviderStatus struct {
// OIDCProvider describes the configuration of an OIDC provider.
// +genclient
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +kubebuilder:resource:categories=pinniped
type OIDCProvider struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`

6
generated/1.18/crds/authentication.concierge.pinniped.dev_webhookauthenticators.yaml generated
View File

@ -11,9 +11,9 @@ spec:
group: authentication.concierge.pinniped.dev
names:
categories:
- all
- authenticator
- authenticators
- pinniped
- pinniped-authenticator
- pinniped-authenticators
kind: WebhookAuthenticator
listKind: WebhookAuthenticatorList
plural: webhookauthenticators

3
generated/1.18/crds/config.concierge.pinniped.dev_credentialissuers.yaml generated
View File

@ -10,6 +10,8 @@ metadata:
spec:
group: config.concierge.pinniped.dev
names:
categories:
- pinniped
kind: CredentialIssuer
listKind: CredentialIssuerList
plural: credentialissuers
@ -19,6 +21,7 @@ spec:
- name: v1alpha1
schema:
openAPIV3Schema:
description: Describes the configuration status of a Pinniped credential issuer.
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation

2
generated/1.18/crds/config.supervisor.pinniped.dev_oidcproviders.yaml generated
View File

@ -10,6 +10,8 @@ metadata:
spec:
group: config.supervisor.pinniped.dev
names:
categories:
- pinniped
kind: OIDCProvider
listKind: OIDCProviderList
plural: oidcproviders

2
generated/1.19/README.adoc generated
View File

@ -125,7 +125,7 @@ Package v1alpha1 is the v1alpha1 version of the Pinniped concierge configuration
[id="{anchor_prefix}-go-pinniped-dev-generated-1-19-apis-concierge-config-v1alpha1-credentialissuer"]
==== CredentialIssuer
Describes the configuration status of a Pinniped credential issuer.
.Appears In:
****

2
generated/1.19/apis/concierge/authentication/v1alpha1/types_webhook.go generated
View File

@ -30,7 +30,7 @@ type WebhookAuthenticatorSpec struct {
// WebhookAuthenticator describes the configuration of a webhook authenticator.
// +genclient
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +kubebuilder:resource:categories=all;authenticator;authenticators
// +kubebuilder:resource:categories=pinniped;pinniped-authenticator;pinniped-authenticators
// +kubebuilder:printcolumn:name="Endpoint",type=string,JSONPath=`.spec.endpoint`
type WebhookAuthenticator struct {
metav1.TypeMeta `json:",inline"`

3
generated/1.19/apis/concierge/config/v1alpha1/types_credentialissuer.go generated
View File

@ -68,7 +68,7 @@ type CredentialIssuerStrategy struct {
// Describes the configuration status of a Pinniped credential issuer.
// +genclient
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +kubebuilder:resource:categories=pinniped
type CredentialIssuer struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
@ -79,7 +79,6 @@ type CredentialIssuer struct {
// List of CredentialIssuer objects.
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
type CredentialIssuerList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`

1
generated/1.19/apis/supervisor/config/v1alpha1/types_oidcprovider.go generated
View File

@ -86,6 +86,7 @@ type OIDCProviderStatus struct {
// OIDCProvider describes the configuration of an OIDC provider.
// +genclient
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +kubebuilder:resource:categories=pinniped
type OIDCProvider struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`

6
generated/1.19/crds/authentication.concierge.pinniped.dev_webhookauthenticators.yaml generated
View File

@ -11,9 +11,9 @@ spec:
group: authentication.concierge.pinniped.dev
names:
categories:
- all
- authenticator
- authenticators
- pinniped
- pinniped-authenticator
- pinniped-authenticators
kind: WebhookAuthenticator
listKind: WebhookAuthenticatorList
plural: webhookauthenticators

3
generated/1.19/crds/config.concierge.pinniped.dev_credentialissuers.yaml generated
View File

@ -10,6 +10,8 @@ metadata:
spec:
group: config.concierge.pinniped.dev
names:
categories:
- pinniped
kind: CredentialIssuer
listKind: CredentialIssuerList
plural: credentialissuers
@ -19,6 +21,7 @@ spec:
- name: v1alpha1
schema:
openAPIV3Schema:
description: Describes the configuration status of a Pinniped credential issuer.
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation

2
generated/1.19/crds/config.supervisor.pinniped.dev_oidcproviders.yaml generated
View File

@ -10,6 +10,8 @@ metadata:
spec:
group: config.supervisor.pinniped.dev
names:
categories:
- pinniped
kind: OIDCProvider
listKind: OIDCProviderList
plural: oidcproviders

53
test/integration/kube_api_discovery_test.go
View File

@ -4,8 +4,10 @@
package integration
import (
"strings"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@ -45,11 +47,6 @@ func TestGetAPIResourceList(t *testing.T) {
Kind: "TokenCredentialRequest",
Verbs: []string{"create"},
Namespaced: true,
// This is currently an empty string in the response; maybe it should not be
// empty? Seems like no harm in keeping it like this for now, but feel free
// to update in the future if there is a compelling reason to do so.
SingularName: "",
},
},
},
@ -76,6 +73,7 @@ func TestGetAPIResourceList(t *testing.T) {
Namespaced: true,
Kind: "OIDCProvider",
Verbs: []string{"delete", "deletecollection", "get", "list", "patch", "create", "update", "watch"},
Categories: []string{"pinniped"},
},
},
},
@ -102,6 +100,7 @@ func TestGetAPIResourceList(t *testing.T) {
Namespaced: true,
Kind: "CredentialIssuer",
Verbs: []string{"delete", "deletecollection", "get", "list", "patch", "create", "update", "watch"},
Categories: []string{"pinniped"},
},
},
},
@ -128,16 +127,58 @@ func TestGetAPIResourceList(t *testing.T) {
Namespaced: true,
Kind: "WebhookAuthenticator",
Verbs: []string{"delete", "deletecollection", "get", "list", "patch", "create", "update", "watch"},
Categories: []string{"all", "authenticator", "authenticators"},
Categories: []string{"pinniped", "pinniped-authenticator", "pinniped-authenticators"},
},
},
},
},
}
t.Run("every Pinniped API has explicit test coverage", func(t *testing.T) {
t.Parallel()
testedGroups := map[string]bool{}
for _, tt := range tests {
testedGroups[tt.group.Name] = true
}
for _, g := range groups {
if !strings.Contains(g.Name, "pinniped.dev") {
continue
}
assert.Truef(t, testedGroups[g.Name], "expected group %q to have assertions defined", g.Name)
}
})
t.Run("every API categorized appropriately", func(t *testing.T) {
t.Parallel()
for _, r := range resources {
if !strings.Contains(r.GroupVersion, "pinniped.dev") {
continue
}
for _, a := range r.APIResources {
if a.Kind != "TokenCredentialRequest" {
assert.Containsf(t, a.Categories, "pinniped", "expected resource %q to be in the 'pinniped' category", a.Name)
}
assert.NotContainsf(t, a.Categories, "all", "expected resource %q not to be in the 'all' category", a.Name)
}
}
})
t.Run("Pinniped resources do not have short names", func(t *testing.T) {
t.Parallel()
for _, r := range resources {
if !strings.Contains(r.GroupVersion, "pinniped.dev") {
continue
}
for _, a := range r.APIResources {
assert.Empty(t, a.ShortNames, "expected resource %q not to have any short names", a.Name)
}
}
})
for _, tt := range tests {
tt := tt
t.Run(tt.group.Name, func(t *testing.T) {
t.Parallel()
require.Contains(t, groups, &tt.group)
for groupVersion, expectedResources := range tt.resourceByVersion {