fix(openshift-image-registry): fix #596: Add mock data for test page and cleanup some small code smells (#1024)

fix #596: Add mock data for test page and cleanup some small code smells

Author: christoph-jerolimov

plugins/openshift-image-registry/README.md

@@ -4,6 +4,30 @@ The OpenShift Image Registry plugin displays all ImageStreams in an Openshift cl
 
 ## For administrators
 
+### Prerequisites
+
+The OpenShift Image Registry plugin requires read access to **_all_** `ImageStreams` and `ImageStreamTags` on a cluster. (Currently only a single cluster is supported.)
+
+You can create a `ServiceAccount`, `ClusterRole` and `ClusterRoleBinding` with this commands.
+
+Please notice that the ServiceAccount will be created in your current namespace while the `ClusterRole` and `ClusterRoleBinding` giving access to all namespaces are cluster-wide resources.
+
+Additional information on these commands could be found in the [OpenShift Container Platform authentication and authorization documentation](https://docs.openshift.com/container-platform/latest/authentication/index.html).
+
+```console
+oc create serviceaccount janus-idp-openshift-image-registry-reader
+
+oc create clusterrole janus-idp-openshift-image-registry-reader --verb=get,watch,list --resource=imagestreams --resource=imagestreamtags
+
+oc adm policy add-cluster-role-to-user janus-idp-openshift-image-registry-reader -z janus-idp-openshift-image-registry-reader
+```
+
+And finally you can use this command to create a token that is valid for one week:
+
+```console
+oc create token --duration=168h janus-idp-openshift-image-registry-reader
+```
+
 ### Installation
 
 Run the following command to install the OpenShift Image Registry plugin:
@@ -46,7 +70,7 @@ yarn workspace app add @janus-idp/backstage-plugin-openshift-image-registry
              to="openshift-image-registry"
              text="Image Registry"
            />
-           ;{/* highlight-add-end */}
+           {/* highlight-add-end */}
          </SidebarGroup>
          {/* ... */}
        </Sidebar>

plugins/openshift-image-registry/dev/index.tsx

@@ -1,17 +1,97 @@
 import React from 'react';
 
 import { createDevApp } from '@backstage/dev-utils';
+import { TestApiProvider } from '@backstage/test-utils';
 
+import {
+  openshiftImageRegistryApiRef,
+  OpenshiftImageRegistryApiV1,
+} from '../src/api';
 import {
   OpenshiftImageRegistryPage,
   openshiftImageRegistryPlugin,
 } from '../src/plugin';
+// Contains just the openshift namespace for now
+import namespaces from './namespaces.json';
+// Extracted from an OpenShift 4.13 cluster, reduced to Go, Java, Node.js and Python entries
+// oc get -n openshift \
+//   imagestream/golang \
+//   imagestream/java \
+//   imagestream/nodejs \
+//   imagestream/python \
+//   -o json | jq . \
+//   > plugins/openshift-image-registry/dev/openshift-imagestreams.json
+import openshiftImageStreams from './openshift-imagestreams.json';
+// The origin list view doesn't contain all neccessary infomation, so this list view
+// is build from three API calls to match the data in openshift-imagestreams.json
+//
+// oc get -n openshift \
+//   imagestreamtag/golang:1.18-ubi7 \
+//   imagestreamtag/java:11 \
+//   imagestreamtag/nodejs:14-ubi7 \
+//   imagestreamtag/python:2.7-ubi8 \
+//   -o json | jq . \
+//   > plugins/openshift-image-registry/dev/openshift-imagestreamtags.json
+import openshiftImageStreamTags from './openshift-imagestreamtags.json';
+
+class MockOpenshiftImageRegistryApi implements OpenshiftImageRegistryApiV1 {
+  async getAllImageStreams(): Promise<any> {
+    return openshiftImageStreams.items;
+  }
+  async getImageStreams(ns: string): Promise<any> {
+    return openshiftImageStreams.items.filter(
+      item => item.metadata.namespace === ns,
+    );
+  }
+  async getImageStream(ns: string, imageName: string): Promise<any> {
+    return openshiftImageStreams.items.find(
+      item =>
+        item.metadata.namespace === ns && item.metadata.name === imageName,
+    );
+  }
+  async getImageStreamTags(ns: string, imageName: string): Promise<any> {
+    if (imageName.includes(':')) {
+      return openshiftImageStreamTags.items.find(
+        item =>
+          item.metadata.namespace === ns && item.metadata.name === imageName,
+      );
+    }
+    return openshiftImageStreamTags.items.find(
+      item =>
+        item.metadata.namespace === ns &&
+        (item.metadata.name === imageName ||
+          item.metadata.name.startsWith(`${imageName}:`)),
+    );
+  }
+  async getImageStreamTag(
+    ns: string,
+    imageName: string,
+    tag: string,
+  ): Promise<any> {
+    return openshiftImageStreamTags.items.find(
+      item =>
+        item.metadata.namespace === ns &&
+        item.metadata.name === `${imageName}:${tag}`,
+    );
+  }
+  async getNamespaces(): Promise<any> {
+    return namespaces.items;
+  }
+}
 
 createDevApp()
   .registerPlugin(openshiftImageRegistryPlugin)
   .addPage({
-    element: <OpenshiftImageRegistryPage />,
-    title: 'Root Page',
+    element: (
+      <TestApiProvider
+        apis={[
+          [openshiftImageRegistryApiRef, new MockOpenshiftImageRegistryApi()],
+        ]}
+      >
+        <OpenshiftImageRegistryPage />
+      </TestApiProvider>
+    ),
+    title: 'Image Registry',
     path: '/openshift-image-registry',
   })
   .render();

plugins/openshift-image-registry/dev/namespaces.json

@@ -0,0 +1,26 @@
+{
+  "kind": "NamespaceList",
+  "apiVersion": "v1",
+  "metadata": {
+    "resourceVersion": "81626349"
+  },
+  "items": [
+    {
+      "metadata": {
+        "name": "openshift",
+        "uid": "e9c1249f-b300-4b43-8c10-cd8473280844",
+        "resourceVersion": "75916512",
+        "creationTimestamp": "2023-07-26T18:44:09Z",
+        "labels": {
+          "kubernetes.io/metadata.name": "openshift"
+        }
+      },
+      "spec": {
+        "finalizers": ["kubernetes"]
+      },
+      "status": {
+        "phase": "Active"
+      }
+    }
+  ]
+}