feat: Migrate EDPComponent to QuickLink (#157)

Jira: EPMDEDP-13245
Related: #157
Change-Id: I4df3b65229d9ccc732343c243c01fe374c221b73

Author: callmevladik

src/components/EDPComponentLink/index.tsx src/components/QuickLink/index.tsx

@@ -2,15 +2,15 @@ import { Link } from '@kinvolk/headlamp-plugin/lib/CommonComponents';
 import { Grid } from '@mui/material';
 import React from 'react';
 import { ResourceIconLink } from '../ResourceIconLink';
-import { EDPComponentExternalLinkProps } from './types';
+import { QuickLinkExternalLinkProps } from './types';
 
-export const EDPComponentLink = ({
+export const QuickLink = ({
   name,
   icon,
   externalLink,
   enabledText = `Open in ${name.label}`,
   configurationLink,
-}: EDPComponentExternalLinkProps) => {
+}: QuickLinkExternalLinkProps) => {
   return externalLink ? (
     <ResourceIconLink icon={icon} tooltipTitle={enabledText} link={externalLink} />
   ) : (

src/components/EDPComponentLink/types.ts src/components/QuickLink/types.ts

@@ -1,4 +1,4 @@
-export interface EDPComponentExternalLinkProps {
+export interface QuickLinkExternalLinkProps {
   icon: string;
   externalLink: string;
   name?: {

src/hooks/useResourceCRUDMutation/data.mock.ts

@@ -1,6 +1,6 @@
 export const mutationDataMock = {
   apiVersion: 'v1.edp.epam.com/v1',
-  kind: 'EDPComponent',
+  kind: 'QuickLink',
   metadata: {
     creationTimestamp: '2023-05-16T13:17:33Z',
     name: 'tekton',

src/hooks/useResourceCRUDMutation/index.test.tsx

@@ -7,7 +7,7 @@ import { act, renderHook } from '@testing-library/react-hooks';
 import React, { ReactNode } from 'react';
 import { QueryClient, QueryClientProvider } from 'react-query';
 import { CRUD_TYPES } from '../../constants/crudTypes';
-import { EDPComponentKubeObject } from '../../k8s/EDPComponent';
+import { QuickLinkKubeObject } from '../../k8s/QuickLink';
 import { mutationDataMock } from './data.mock';
 import { useResourceCRUDMutation } from './index';
 
@@ -44,12 +44,12 @@ const wrapper = ({ children }: { children: ReactNode }) => (
 
 describe('testing useResourceCRUDMutation hook', () => {
   it('Request resolve scenario: the hook renders successfully, useMutation.mutate fn works correctly, notification callbacks are firing', async () => {
-    jest.spyOn(EDPComponentKubeObject.apiEndpoint, 'post').mockResolvedValue(mutationDataMock);
+    jest.spyOn(QuickLinkKubeObject.apiEndpoint, 'post').mockResolvedValue(mutationDataMock);
 
     await act(async () => {
       console.log('Before renderHook');
       const { result } = renderHook(
-        () => useResourceCRUDMutation('test', EDPComponentKubeObject, CRUD_TYPES.CREATE),
+        () => useResourceCRUDMutation('test', QuickLinkKubeObject, CRUD_TYPES.CREATE),
         {
           wrapper: wrapper,
         }
@@ -77,12 +77,12 @@ describe('testing useResourceCRUDMutation hook', () => {
     });
   });
   it('Request reject scenario: the hook renders successfully, useMutation.mutate fn works correctly, notification callbacks are firing', async () => {
-    jest.spyOn(EDPComponentKubeObject.apiEndpoint, 'put').mockRejectedValue({ error: 'error' });
+    jest.spyOn(QuickLinkKubeObject.apiEndpoint, 'put').mockRejectedValue({ error: 'error' });
 
     await act(async () => {
       console.log('Before renderHook');
       const { result } = renderHook(
-        () => useResourceCRUDMutation('test', EDPComponentKubeObject, CRUD_TYPES.EDIT),
+        () => useResourceCRUDMutation('test', QuickLinkKubeObject, CRUD_TYPES.EDIT),
         {
           wrapper: wrapper,
         }

src/k8s/EDPComponent/config.ts

@@ -0,0 +1,11 @@
+import { KubeObjectConfig } from '../../types/configs/k8s';
+
+export const QuickLinkKubeObjectConfig: KubeObjectConfig = {
+  kind: 'QuickLink',
+  name: {
+    singularForm: 'quicklink',
+    pluralForm: 'quicklinks',
+  },
+  group: 'v2.edp.epam.com',
+  version: 'v1',
+};

src/k8s/EDPComponent/constants.ts

@@ -0,0 +1,39 @@
+export const SYSTEM_QUICK_LINKS = {
+  // must be equal to QuickLink.metadata.name
+
+  GERRIT: 'gerrit',
+  GITLAB: 'gitlab',
+  GITHUB: 'github',
+  TEKTON: 'tekton',
+  ARGOCD: 'argocd',
+  DEFECT_DOJO: 'defectdojo',
+  DEPENDENCY_TRACK: 'dependency-track',
+  DOCKER_REGISTRY: 'docker-registry',
+  GRAFANA: 'grafana',
+  KIBANA: 'kibana',
+  NEXUS: 'nexus',
+  SONAR: 'sonar',
+} as const;
+
+export const SYSTEM_QUICK_LINKS_WITH_CONFIGURATION = [
+  SYSTEM_QUICK_LINKS.NEXUS,
+  SYSTEM_QUICK_LINKS.ARGOCD,
+  SYSTEM_QUICK_LINKS.SONAR,
+  SYSTEM_QUICK_LINKS.DEFECT_DOJO,
+  SYSTEM_QUICK_LINKS.DEPENDENCY_TRACK,
+] as const;
+
+export const SYSTEM_QUICK_LINKS_LABELS = {
+  [SYSTEM_QUICK_LINKS.GERRIT]: 'Gerrit',
+  [SYSTEM_QUICK_LINKS.GITLAB]: 'GitLab',
+  [SYSTEM_QUICK_LINKS.GITHUB]: 'GitHub',
+  [SYSTEM_QUICK_LINKS.TEKTON]: 'Tekton',
+  [SYSTEM_QUICK_LINKS.ARGOCD]: 'Argo CD',
+  [SYSTEM_QUICK_LINKS.DEFECT_DOJO]: 'DefectDojo',
+  [SYSTEM_QUICK_LINKS.DEPENDENCY_TRACK]: 'DependencyTrack',
+  [SYSTEM_QUICK_LINKS.DOCKER_REGISTRY]: 'DockerRegistry',
+  [SYSTEM_QUICK_LINKS.GRAFANA]: 'Grafana',
+  [SYSTEM_QUICK_LINKS.KIBANA]: 'Kibana',
+  [SYSTEM_QUICK_LINKS.NEXUS]: 'Nexus',
+  [SYSTEM_QUICK_LINKS.SONAR]: 'Sonar',
+} as const;

src/k8s/EDPComponent/hooks/useEDPComponentCRUD.ts

@@ -0,0 +1,69 @@
+import React from 'react';
+import { CRUD_TYPES } from '../../../constants/crudTypes';
+import { useResourceCRUDMutation } from '../../../hooks/useResourceCRUDMutation';
+import { QuickLinkKubeObject } from '../index';
+import { QuickLinkKubeObjectInterface } from '../types';
+
+interface CreateQuickLinkProps {
+  QuickLinkData: QuickLinkKubeObjectInterface;
+}
+
+interface EditQuickLinkProps {
+  QuickLinkData: QuickLinkKubeObjectInterface;
+}
+
+export const useQuickLinkCRUD = ({
+  onSuccess,
+  onError,
+}: {
+  onSuccess?: () => void;
+  onError?: () => void;
+}) => {
+  const invokeOnSuccessCallback = React.useCallback(() => onSuccess && onSuccess(), [onSuccess]);
+  const invokeOnErrorCallback = React.useCallback(() => onError && onError(), [onError]);
+
+  const QuickLinkCreateMutation = useResourceCRUDMutation<
+    QuickLinkKubeObjectInterface,
+    CRUD_TYPES.CREATE
+  >('QuickLinkCreateMutation', QuickLinkKubeObject, CRUD_TYPES.CREATE);
+
+  const QuickLinkEditMutation = useResourceCRUDMutation<
+    QuickLinkKubeObjectInterface,
+    CRUD_TYPES.EDIT
+  >('QuickLinkEditMutation', QuickLinkKubeObject, CRUD_TYPES.EDIT);
+
+  const createQuickLink = React.useCallback(
+    async ({ QuickLinkData }: CreateQuickLinkProps) => {
+      QuickLinkCreateMutation.mutate(QuickLinkData, {
+        onSuccess: () => {
+          invokeOnSuccessCallback();
+        },
+        onError: () => {
+          invokeOnErrorCallback();
+        },
+      });
+    },
+    [QuickLinkCreateMutation, invokeOnErrorCallback, invokeOnSuccessCallback]
+  );
+
+  const editQuickLink = React.useCallback(
+    async ({ QuickLinkData }: EditQuickLinkProps) => {
+      QuickLinkEditMutation.mutate(QuickLinkData, {
+        onSuccess: () => {
+          invokeOnSuccessCallback();
+        },
+        onError: () => {
+          invokeOnErrorCallback();
+        },
+      });
+    },
+    [QuickLinkEditMutation, invokeOnErrorCallback, invokeOnSuccessCallback]
+  );
+
+  const mutations = {
+    QuickLinkCreateMutation,
+    QuickLinkEditMutation,
+  };
+
+  return { createQuickLink, editQuickLink, mutations };
+};