Collect OpenStackVersion CRs

Red Hat's openstack-operator in addition to the OpenStackControlPlane
and OpenStackDataPlane CRs uses also additonal CR 'openstackversions'
which reports version of the openstack(s) deployed in the OCP cluster.
This patch adds support for gathering also this CRs from the cluster if
they exists.

Related: #OSPRH-5904

Author: slawqo

docs/gathered-data.md

@@ -1627,6 +1627,30 @@ None
 
 ### Changes
 None
+ 
+
+## Openstackversions
+
+Collects `openstackversion.core.openstack.org`
+resources from all namespaces
+
+### API Reference
+None
+
+### Sample data
+- [docs/insights-archive-sample/namespaces/openstack/core.openstack.org/openstackversions/openstack-galera-network-isolation.json](./insights-archive-sample/namespaces/openstack/core.openstack.org/openstackversions/openstack-galera-network-isolation.json)
+
+### Location in archive
+- `namespaces/{namespace}/core.openstack.org/openstackversions/{name}.json`
+
+### Config ID
+`clusterconfig/openstack_version`
+
+### Released version
+- 4.17
+
+### Changes
+None
 
 
 ## PodDefinition

docs/insights-archive-sample/insights-operator/gathers.json

@@ -153,6 +153,14 @@
       "warnings": null,
       "panic": null
     },
+    {
+      "name": "clusterconfig/openstack_version",
+      "duration_in_ms": 25,
+      "records_count": 1,
+      "errors": null,
+      "warnings": null,
+      "panic": null
+    },
     {
       "name": "clusterconfig/scheduler_logs",
       "duration_in_ms": 617,

docs/insights-archive-sample/namespaces/openstack/core.openstack.org/openstackversions/openstack-galera-network-isolation.json

@@ -69,6 +69,7 @@ var gatheringFunctions = map[string]gathererFuncPtr{
 	"openstack_controlplanes":           (*Gatherer).GatherOpenstackControlplanes,
 	"openstack_dataplanedeployments":    (*Gatherer).GatherOpenstackDataplaneDeployments,
 	"openstack_dataplanenodesets":       (*Gatherer).GatherOpenstackDataplaneNodeSets,
+	"openstack_version":                 (*Gatherer).GatherOpenstackVersions,
 	"operators":                         (*Gatherer).GatherClusterOperators,
 	"operators_pods_and_events":         (*Gatherer).GatherClusterOperatorPodsAndEvents,
 	"overlapping_namespace_uids":        (*Gatherer).GatherNamespacesWithOverlappingUIDs,

pkg/gatherers/clusterconfig/clusterconfig_gatherer.go

@@ -83,6 +83,9 @@ var (
 	osdpnsGroupVersionResource = schema.GroupVersionResource{
 		Group: "dataplane.openstack.org", Version: "v1beta1", Resource: "openstackdataplanenodesets",
 	}
+	osvGroupVersionResource = schema.GroupVersionResource{
+		Group: "core.openstack.org", Version: "v1beta1", Resource: "openstackversions",
+	}
 )
 
 func init() { //nolint: gochecknoinits

pkg/gatherers/clusterconfig/const.go

@@ -0,0 +1,66 @@
+// nolint: dupl
+package clusterconfig
+
+import (
+	"context"
+	"fmt"
+
+	"k8s.io/apimachinery/pkg/api/errors"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/client-go/dynamic"
+
+	"github.com/openshift/insights-operator/pkg/record"
+)
+
+// GatherOpenstackVersions Collects `openstackversion.core.openstack.org`
+// resources from all namespaces
+//
+// ### API Reference
+// None
+//
+// ### Sample data
+// - docs/insights-archive-sample/namespaces/openstack/core.openstack.org/openstackversion/openstack-galera-network-isolation.json
+//
+// ### Location in archive
+// - `namespaces/{namespace}/core.openstack.org/openstackversion/{name}.json`
+//
+// ### Config ID
+// `clusterconfig/openstack_version`
+//
+// ### Released version
+// - 4.17
+//
+// ### Changes
+// None
+func (g *Gatherer) GatherOpenstackVersions(ctx context.Context) ([]record.Record, []error) {
+	gatherDynamicClient, err := dynamic.NewForConfig(g.gatherKubeConfig)
+	if err != nil {
+		return nil, []error{err}
+	}
+
+	return GatherOpenstackVersions(ctx, gatherDynamicClient)
+}
+
+func GatherOpenstackVersions(ctx context.Context, dynamicClient dynamic.Interface) ([]record.Record, []error) {
+	openstackversionsList, err := dynamicClient.Resource(osvGroupVersionResource).List(ctx, metav1.ListOptions{})
+	if errors.IsNotFound(err) {
+		return nil, nil
+	}
+	if err != nil {
+		return nil, []error{err}
+	}
+
+	var records []record.Record
+	for i, osv := range openstackversionsList.Items {
+		records = append(records, record.Record{
+			Name: fmt.Sprintf("namespaces/%s/%s/%s/%s",
+				osv.GetNamespace(),
+				osvGroupVersionResource.Group,
+				osvGroupVersionResource.Resource,
+				osv.GetName()),
+			Item: record.ResourceMarshaller{Resource: &openstackversionsList.Items[i]},
+		})
+	}
+
+	return records, nil
+}

pkg/gatherers/clusterconfig/gather_openstackversions.go

@@ -0,0 +1,92 @@
+package clusterconfig
+
+import (
+	"context"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/apimachinery/pkg/runtime/schema"
+	"k8s.io/apimachinery/pkg/runtime/serializer/yaml"
+	dynamicfake "k8s.io/client-go/dynamic/fake"
+)
+
+func Test_OpenStackVersions_Gather(t *testing.T) {
+	tests := []struct {
+		name       string
+		namespaces []string
+		osvYAML    []string
+		exp        []string
+	}{
+		{
+			name:       "Test OpenStacVersions CR not exists",
+			namespaces: []string{"openstack"},
+			osvYAML:    []string{},
+			exp:        []string{},
+		},
+		{
+			name:       "Test single OpenStacVersions CR",
+			namespaces: []string{"openstack"},
+			osvYAML: []string{`
+apiVersion: core.openstack.org/v1beta1
+kind: OpenStackVersion
+metadata:
+  name: test-cr
+  namespace: openstack
+`},
+			exp: []string{"namespaces/openstack/core.openstack.org/openstackversions/test-cr"},
+		},
+		{
+			name:       "Test Multiple OpenStackVersions CR",
+			namespaces: []string{"openstack-1", "openstack-2"},
+			osvYAML: []string{`
+apiVersion: core.openstack.org/v1beta1
+kind: OpenStackVersion
+metadata:
+  name: test-cr-1
+  namespace: openstack-1
+`, `
+apiVersion: core.openstack.org/v1beta1
+kind: OpenStackVersion
+metadata:
+  name: test-cr-2
+  namespace: openstack-2
+`},
+			exp: []string{
+				"namespaces/openstack-1/core.openstack.org/openstackversions/test-cr-1",
+				"namespaces/openstack-2/core.openstack.org/openstackversions/test-cr-2",
+			},
+		},
+	}
+	for _, test := range tests {
+		test := test
+		t.Run(test.name, func(t *testing.T) {
+			t.Parallel()
+			dynamicClient := dynamicfake.NewSimpleDynamicClientWithCustomListKinds(runtime.NewScheme(), map[schema.GroupVersionResource]string{
+				osvGroupVersionResource: "openstackversionsList",
+			})
+			decUnstructured := yaml.NewDecodingSerializer(unstructured.UnstructuredJSONScheme)
+			testOsv := &unstructured.Unstructured{}
+			ctx := context.Background()
+
+			for i := range test.osvYAML {
+				_, _, err := decUnstructured.Decode([]byte(test.osvYAML[i]), nil, testOsv)
+				assert.NoError(t, err)
+				_, err = dynamicClient.Resource(osvGroupVersionResource).
+					Namespace(test.namespaces[i]).
+					Create(ctx, testOsv, metav1.CreateOptions{})
+				assert.NoError(t, err)
+			}
+
+			records, errs := GatherOpenstackVersions(ctx, dynamicClient)
+			assert.Emptyf(t, errs, "Unexpected errors: %#v", errs)
+			var recordNames []string
+			for i := range records {
+				recordNames = append(recordNames, records[i].Name)
+			}
+			assert.ElementsMatch(t, test.exp, recordNames)
+		})
+	}
+}