crd testdata: add example files and description

Author: chrischdi

pkg/customresourcestate/generate/generator/testdata/README.md

@@ -0,0 +1,55 @@
+# Testdata for generator tests
+
+The files in this directory are used for testing the `kube-state-metrics generate` command and to provide an example.
+
+## foo-config.yaml
+
+This file is used in the test at [generate_integration_test.go](../generate_integration_test.go) to verify that the resulting configuration does not change during changes in the codebase.
+
+If there are intended changes this file needs to get regenerated to make the test succeed again.
+This could be done via:
+
+```sh
+go run generate \
+  ./pkg/customresourcestate/generate/generator/testdata/ \
+  > ./pkg/customresourcestate/generate/generator/testdata/foo-config.yaml
+```
+
+Or by using the go:generate marker inside [foo_types.go](foo_types.go):
+
+```sh
+go generate ./pkg/customresourcestate/generate/generator/testdata/
+```
+
+## Example files: foo-cr-example.yaml and foo-cr-example-metrics.txt
+
+There is also an example CR ([foo-cr-example.yaml](foo-cr-example.yaml)) and resulting example metrics ([foo-cr-example-metrics.txt](foo-cr-example-metrics.txt)).
+
+The example metrics file got created by:
+
+1. Generating a CustomResourceDefinition yaml by using [controller-gen](https://github.com/kubernetes-sigs/kubebuilder/blob/master/docs/book/src/reference/controller-gen.md):
+
+    ```sh
+    controller-gen crd paths=./pkg/customresourcestate/generate/generator/testdata/ output:dir=./pkg/customresourcestate/generate/generator/testdata/
+    ```
+
+2. Creating a cluster using [kind](https://kind.sigs.k8s.io/)
+3. Applying the CRD and example CR to the cluster:
+
+    ```sh
+    kubectl apply -f /pkg/customresourcestate/generate/generator/testdata/bar.example.com_foos.yaml
+    kubectl apply -f /pkg/customresourcestate/generate/generator/testdata/foo-cr-example.yaml
+    ```
+
+4. Running kube-state-metrics with the provided configuration file:
+
+    ```sh
+    go run ./ --kubeconfig $HOME/.kube/config --custom-resource-state-only \
+    --custom-resource-state-config-file pkg/customresourcestate/generate/generator/testdata/foo-config.yaml
+    ```
+
+5. Querying the metrics endpoint in a second terminal:
+
+    ```sh
+    curl localhost:8080/metrics > ./pkg/customresourcestate/generate/generator/testdata/foo-cr-example-metrics.txt
+    ```

pkg/customresourcestate/generate/generator/testdata/foo-cr-example-metrics.txt

@@ -0,0 +1,18 @@
+# HELP foo_created Unix creation timestamp.
+# TYPE foo_created gauge
+foo_created{customresource_group="bar.example.com",customresource_kind="Foo",customresource_version="foo",name="bar"} 1.697543739e+09
+# HELP foo_owner Owner references.
+# TYPE foo_owner info
+foo_owner{customresource_group="bar.example.com",customresource_kind="Foo",customresource_version="foo",name="bar",owner_is_controller="true",owner_kind="foo",owner_name="foo",owner_uid="someuid"} 1
+# HELP foo_status_condition The condition of a foo.
+# TYPE foo_status_condition stateset
+foo_status_condition{customresource_group="bar.example.com",customresource_kind="Foo",customresource_version="foo",name="bar",status="False",type="AnotherType"} 1
+foo_status_condition{customresource_group="bar.example.com",customresource_kind="Foo",customresource_version="foo",name="bar",status="False",type="SomeType"} 0
+foo_status_condition{customresource_group="bar.example.com",customresource_kind="Foo",customresource_version="foo",name="bar",status="True",type="AnotherType"} 0
+foo_status_condition{customresource_group="bar.example.com",customresource_kind="Foo",customresource_version="foo",name="bar",status="True",type="SomeType"} 1
+foo_status_condition{customresource_group="bar.example.com",customresource_kind="Foo",customresource_version="foo",name="bar",status="Unknown",type="AnotherType"} 0
+foo_status_condition{customresource_group="bar.example.com",customresource_kind="Foo",customresource_version="foo",name="bar",status="Unknown",type="SomeType"} 0
+# HELP foo_status_condition_last_transition_time The condition last transition time of a foo.
+# TYPE foo_status_condition_last_transition_time gauge
+foo_status_condition_last_transition_time{customresource_group="bar.example.com",customresource_kind="Foo",customresource_version="foo",name="bar",status="False",type="AnotherType"} 1.697119142e+09
+foo_status_condition_last_transition_time{customresource_group="bar.example.com",customresource_kind="Foo",customresource_version="foo",name="bar",status="True",type="SomeType"} 1.697119142e+09

pkg/customresourcestate/generate/generator/testdata/foo-cr-example.yaml

@@ -0,0 +1,21 @@
+---
+apiVersion: bar.example.com/foo
+kind: Foo
+metadata:
+  name: bar
+  ownerReferences:
+  - apiVersion: v1
+    kind: foo
+    controller: true
+    name: foo
+    uid: someuid
+spec:
+  someString: test
+status:
+  conditions:
+  - lastTransitionTime: "2023-10-12T13:59:02Z"
+    status: "True"
+    type: SomeType
+  - lastTransitionTime: "2023-10-12T13:59:02Z"
+    status: "False"
+    type: AnotherType

pkg/customresourcestate/generate/generator/testdata/foo_types.go

@@ -20,6 +20,7 @@ limitations under the License.
 // the following command:
 // $ go generate ./pkg/customresourcestate/generate/generator/testdata
 //go:generate sh -c "go run ../../../../../ generate ./... > foo-config.yaml"
+//go:generate sh -c "controller-gen crd paths=./ output:stdout > foo-crd.yaml"
 
 // +groupName=bar.example.com
 package foo
@@ -30,16 +31,15 @@ import (
 
 // FooSpec is the spec of Foo.
 type FooSpec struct {
-	// This tests that defaulted fields are stripped for v1beta1,
-	// but not for v1
-	DefaultedString string `json:"defaultedString"`
+	// SomeString is a string.
+	SomeString string `json:"someString"`
 }
 
 // FooStatus is the status of Foo.
 type FooStatus struct {
 	// +Metrics:stateset:name="status_condition",help="The condition of a foo.",labelName="status",JSONPath=".status",list={"True","False","Unknown"},labelsFromPath={"type":".type"}
 	// +Metrics:gauge:name="status_condition_last_transition_time",help="The condition last transition time of a foo.",valueFrom=.lastTransitionTime,labelsFromPath={"type":".type","status":".status"}
-	Conditions Condition `json:"conditions,omitempty"`
+	Conditions []Condition `json:"conditions,omitempty"`
 }
 
 // Foo is a test object.