Skip to content

Commit 0382e6d

Browse files
author
Ricardo Lüders
committed
refactor: renaming gather after review
1 parent e3a49ae commit 0382e6d

File tree

4 files changed

+37
-37
lines changed

4 files changed

+37
-37
lines changed

docs/gathered-data.md

+26-26
Original file line numberDiff line numberDiff line change
@@ -542,32 +542,6 @@ None
542542
None
543543

544544

545-
## ClusterStorageClasses
546-
547-
Collects the cluster `StorageClass` available in cluster.
548-
549-
### API Reference
550-
- https://docs.openshift.com/container-platform/4.13/rest_api/storage_apis/storageclass-storage-k8s-io-v1.html
551-
552-
### Sample data
553-
- [docs/insights-archive-sample/config/storage/storageclasses/standard-csi.json](./insights-archive-sample/config/storage/storageclasses/standard-csi.json)
554-
555-
### Location in archive
556-
- `config/storage/storageclasses/{name}.json`
557-
558-
### Config ID
559-
`clusterconfig/storage_classes`
560-
561-
### Released version
562-
- 4.15
563-
564-
### Backported versions
565-
None
566-
567-
### Changes
568-
None
569-
570-
571545
## ClusterVersion
572546

573547
Collects the `ClusterVersion` (including the cluster ID) with the name
@@ -1910,6 +1884,32 @@ None
19101884
None
19111885

19121886

1887+
## StorageClasses
1888+
1889+
Collects the cluster `StorageClass` available in cluster.
1890+
1891+
### API Reference
1892+
- https://docs.openshift.com/container-platform/4.13/rest_api/storage_apis/storageclass-storage-k8s-io-v1.html
1893+
1894+
### Sample data
1895+
- [docs/insights-archive-sample/config/storage/storageclasses/standard-csi.json](./insights-archive-sample/config/storage/storageclasses/standard-csi.json)
1896+
1897+
### Location in archive
1898+
- `config/storage/storageclasses/{name}.json`
1899+
1900+
### Config ID
1901+
`clusterconfig/storage_classes`
1902+
1903+
### Released version
1904+
- 4.15
1905+
1906+
### Backported versions
1907+
None
1908+
1909+
### Changes
1910+
None
1911+
1912+
19131913
## StorageCluster
19141914

19151915
Collects `storageclusters.ocs.openshift.io` resources

pkg/gatherers/clusterconfig/clusterconfig_gatherer.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ var gatheringFunctions = map[string]gathererFuncPtr{
8282
"scheduler_logs": (*Gatherer).GatherSchedulerLogs,
8383
"service_accounts": (*Gatherer).GatherServiceAccounts,
8484
"silenced_alerts": (*Gatherer).GatherSilencedAlerts,
85-
"storage_classes": (*Gatherer).GatherClusterStorageClasses,
85+
"storage_classes": (*Gatherer).GatherStorageClasses,
8686
"storage_cluster": (*Gatherer).GatherStorageCluster,
8787
"support_secret": (*Gatherer).GatherSupportSecret,
8888
"tsdb_status": (*Gatherer).GatherPrometheusTSDBStatus,

pkg/gatherers/clusterconfig/gather_cluster_storageclass.go pkg/gatherers/clusterconfig/gather_storageclass.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import (
1212
"k8s.io/client-go/kubernetes"
1313
)
1414

15-
// GatherClusterStorageClasses Collects the cluster `StorageClass` available in cluster.
15+
// GatherStorageClasses Collects the cluster `StorageClass` available in cluster.
1616
//
1717
// ### API Reference
1818
// - https://docs.openshift.com/container-platform/4.13/rest_api/storage_apis/storageclass-storage-k8s-io-v1.html
@@ -34,16 +34,16 @@ import (
3434
//
3535
// ### Changes
3636
// None
37-
func (g *Gatherer) GatherClusterStorageClasses(ctx context.Context) ([]record.Record, []error) {
37+
func (g *Gatherer) GatherStorageClasses(ctx context.Context) ([]record.Record, []error) {
3838
kubeClient, err := kubernetes.NewForConfig(g.gatherKubeConfig)
3939
if err != nil {
4040
return nil, []error{err}
4141
}
4242

43-
return gatherClusterStorageClasses(ctx, kubeClient.StorageV1())
43+
return gatherStorageClasses(ctx, kubeClient.StorageV1())
4444
}
4545

46-
func gatherClusterStorageClasses(ctx context.Context, storageClient v1.StorageV1Interface) ([]record.Record, []error) {
46+
func gatherStorageClasses(ctx context.Context, storageClient v1.StorageV1Interface) ([]record.Record, []error) {
4747
storageClasses, err := listStorageClasses(ctx, storageClient.StorageClasses())
4848
if err != nil {
4949
return nil, []error{err}

pkg/gatherers/clusterconfig/gather_cluster_storageclass_test.go pkg/gatherers/clusterconfig/gather_storageclass_test.go

+6-6
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ import (
1111
"k8s.io/client-go/kubernetes/fake"
1212
)
1313

14-
func TestGatherClusterStorageClasses(t *testing.T) {
14+
func TestGatherStorageClasses(t *testing.T) {
1515
tests := []struct {
1616
name string
1717
storageClasses []storagev1.StorageClass
1818
wantRecords []record.Record
1919
wantErrCount int
2020
}{
2121
{
22-
name: "Successful retrieval of cluster storage classes",
22+
name: "Successful retrieval of storageclasses",
2323
storageClasses: []storagev1.StorageClass{
2424
{
2525
ObjectMeta: metav1.ObjectMeta{Name: "standard-csi"},
@@ -48,10 +48,10 @@ func TestGatherClusterStorageClasses(t *testing.T) {
4848
wantErrCount: 0,
4949
},
5050
{
51-
name: "Failed retrieval of cluster storage classes",
51+
name: "Retrieval empty list of storageclasses",
5252
storageClasses: nil, // Simulating an error scenario with an empty list
5353
wantRecords: nil,
54-
wantErrCount: 1,
54+
wantErrCount: 0, // The fake test client doesn't provide any error
5555
},
5656
}
5757

@@ -62,8 +62,8 @@ func TestGatherClusterStorageClasses(t *testing.T) {
6262
Items: tt.storageClasses,
6363
})
6464

65-
// Call the gatherClusterStorageClasses function with the fake client
66-
records, errs := gatherClusterStorageClasses(context.TODO(), kubeClient.StorageV1())
65+
// Call the gatherStorageClasses function with the fake client
66+
records, errs := gatherStorageClasses(context.TODO(), kubeClient.StorageV1())
6767

6868
// Verify the results
6969
assert.Equal(t, tt.wantRecords, records)

0 commit comments

Comments
 (0)