@rancher/shell 0.5.3 → 1.2.1

package/models/__tests__/provisioning.cattle.io.cluster.test.ts

@@ -1,241 +0,0 @@
-import ProvCluster from '@shell/models/provisioning.cattle.io.cluster';
-
-describe('class ProvCluster', () => {
-  const importedClusterInfo = {
-    clusterName: 'test', provisioner: 'imported', mgmt: { spec: { gkeConfig: {} } }, spec: {}
-  };
-  const importedGkeClusterInfo = {
-    clusterName: 'test', provisioner: 'rke2', mgmt: { spec: { gkeConfig: { imported: true } } }
-  };
-  const importedAksClusterInfo = {
-    clusterName: 'test', provisioner: 'rke2', mgmt: { spec: { aksConfig: { imported: true } } }
-  };
-  const importedEksClusterInfo = {
-    clusterName: 'test', provisioner: 'rke2', mgmt: { spec: { eksConfig: { imported: true } } }
-  };
-  const notImportedGkeClusterInfo = {
-    clusterName: 'test', provisioner: 'rke2', mgmt: { spec: { gkeConfig: { imported: false } }, rkeConfig: {} }
-  };
-  const importedClusterInfoWithProviderForEmberParam = {
-    clusterName: 'test', provisioner: 'rke2', mgmt: { providerForEmberParam: 'import' }
-  };
-  const localClusterInfo = {
-    clusterName: 'test', provisioner: 'imported', mgmt: { isLocal: true, spec: { gkeConfig: {} } }, spec: {}
-  };
-  const doRke2Info = {
-    clusterName: 'test', provisioner: 'rke2', mgmt: { isLocal: false, providerForEmberParam: 'import' }, spec: { rkeConfig: {} }
-  };
-
-  const gkeClusterWithPrivateEndpoint = {
-    clusterName: 'test',
-    provisioner: 'GKE',
-    spec:        { rkeConfig: {} },
-    mgmt:        { spec: { gkeConfig: { privateClusterConfig: { enablePrivateEndpoint: true } } } }
-  };
-
-  const eksClusterWithPrivateEndpoint = {
-    clusterName: 'test',
-    provisioner: 'EKS',
-    spec:        { rkeConfig: {} },
-    mgmt:        { spec: { eksConfig: { privateAccess: true } } }
-  };
-
-  const aksClusterWithPrivateEndpoint = {
-    clusterName: 'test',
-    provisioner: 'AKS',
-    spec:        { rkeConfig: {} },
-    mgmt:        { spec: { aksConfig: { privateCluster: true } } }
-  };
-
-  // Related to https://github.com/rancher/dashboard/issues/9402
-  describe('isHostedKubernetesProvider + isPrivateHostedProvider', () => {
-    const testCases = [
-      [gkeClusterWithPrivateEndpoint, true],
-      [eksClusterWithPrivateEndpoint, true],
-      [aksClusterWithPrivateEndpoint, true],
-    ];
-    const resetMocks = () => {
-      // Clear all mock function calls:
-      jest.clearAllMocks();
-    };
-
-    it.each(testCases)('should return the isHostedKubernetesProvider and isPrivateHostedProvider values properly based on the props data', (clusterData: Object, expected: Boolean) => {
-      const cluster = new ProvCluster({ spec: clusterData.spec });
-
-      jest.spyOn(cluster, 'mgmt', 'get').mockReturnValue(
-        clusterData.mgmt
-      );
-      jest.spyOn(cluster, 'provisioner', 'get').mockReturnValue(
-        clusterData.provisioner
-      );
-
-      expect(cluster.isRke2).toBe(expected);
-      expect(cluster.isHostedKubernetesProvider).toBe(expected);
-      expect(cluster.isPrivateHostedProvider).toBe(expected);
-      resetMocks();
-    });
-  });
-
-  describe('isImported', () => {
-    const testCases = [
-      [importedClusterInfo, true],
-      [importedGkeClusterInfo, true],
-      [importedAksClusterInfo, true],
-      [importedEksClusterInfo, true],
-      [notImportedGkeClusterInfo, false],
-      [importedClusterInfoWithProviderForEmberParam, true],
-      [localClusterInfo, false],
-      [doRke2Info, false],
-      [{}, false],
-    ];
-    const resetMocks = () => {
-      // Clear all mock function calls:
-      jest.clearAllMocks();
-    };
-
-    it.each(testCases)('should return the isImported value properly based on the props data', (clusterData: Object, expected: Boolean) => {
-      const cluster = new ProvCluster({ spec: clusterData.spec });
-
-      jest.spyOn(cluster, 'mgmt', 'get').mockReturnValue(
-        clusterData.mgmt
-      );
-      jest.spyOn(cluster, 'provisioner', 'get').mockReturnValue(
-        clusterData.provisioner
-      );
-
-      expect(cluster.isImported).toBe(expected);
-      resetMocks();
-    }
-    );
-  });
-
-  describe('mgmt', () => {
-    const testCases = [
-      [importedClusterInfo, importedClusterInfo.mgmt],
-      [importedGkeClusterInfo, importedGkeClusterInfo.mgmt],
-      [importedAksClusterInfo, importedAksClusterInfo.mgmt],
-      [importedEksClusterInfo, importedEksClusterInfo.mgmt],
-      [notImportedGkeClusterInfo, notImportedGkeClusterInfo.mgmt],
-      [importedClusterInfoWithProviderForEmberParam, importedClusterInfoWithProviderForEmberParam.mgmt],
-      [localClusterInfo, localClusterInfo.mgmt],
-      [doRke2Info, doRke2Info.mgmt],
-      [{}, null],
-    ];
-
-    const resetMocks = () => {
-      // Clear all mock function calls:
-      jest.clearAllMocks();
-    };
-
-    it.each(testCases)('should return the isImported value properly based on the props data', (clusterData: Object, expected: Object) => {
-      const clusterMock = jest.fn(() => clusterData.mgmt);
-      const ctx = { rootGetters: { 'management/byId': clusterMock } };
-      const cluster = new ProvCluster({ status: { clusterName: clusterData.clusterName } }, ctx);
-
-      expect(cluster.mgmt).toBe(expected);
-      resetMocks();
-    });
-  });
-
-  describe('hasError', () => {
-    const conditionsWithoutError = [
-      {
-        error:          false,
-        lastUpdateTime: '2022-10-17T23:09:15Z',
-        status:         'True',
-        transitioning:  false,
-        type:           'Ready'
-      },
-    ];
-
-    const conditionsWithoutReady = [
-      {
-        error:          true,
-        lastUpdateTime: '2022-10-17T23:09:15Z',
-        status:         'False',
-        message:        'some-error-message',
-        transitioning:  false,
-        type:           'Pending'
-      },
-    ];
-
-    const noConditions:[] = [];
-
-    const conditionsWithReadyLatest = [
-      {
-        error:          true,
-        lastUpdateTime: '2022-10-17T23:09:15Z',
-        status:         'False',
-        message:        'some-error-message',
-        transitioning:  false,
-        type:           'Pending'
-      },
-      {
-        error:          false,
-        lastUpdateTime: '2023-10-17T23:09:15Z',
-        status:         'True',
-        transitioning:  false,
-        type:           'Ready'
-      }
-    ];
-
-    const conditionsWithErrorLatest = [
-      {
-        error:          false,
-        lastUpdateTime: '2022-10-17T23:09:15Z',
-        status:         'True',
-        transitioning:  false,
-        type:           'Ready'
-      },
-      {
-        error:          true,
-        lastUpdateTime: '2023-10-17T23:09:15Z',
-        status:         'False',
-        message:        'some-error-message',
-        transitioning:  false,
-        type:           'Pending'
-      }
-    ];
-
-    const conditionsWithProblemInLastUpdateTimeProp = [
-      {
-        error:          true,
-        lastUpdateTime: '',
-        status:         'False',
-        message:        'some-error-message',
-        transitioning:  false,
-        type:           'Pending'
-      },
-      {
-        error:          false,
-        lastUpdateTime: '2023-10-17T23:09:15Z',
-        status:         'True',
-        transitioning:  false,
-        type:           'Ready'
-      }
-    ];
-
-    const testCases = [
-      ['conditionsWithoutError', conditionsWithoutError, false],
-      ['conditionsWithoutReady', conditionsWithoutReady, true],
-      ['noConditions', noConditions, false],
-      ['conditionsWithReadyLatest', conditionsWithReadyLatest, false],
-      ['conditionsWithErrorLatest', conditionsWithErrorLatest, true],
-      ['conditionsWithProblemInLastUpdateTimeProp', conditionsWithProblemInLastUpdateTimeProp, false],
-    ];
-
-    const resetMocks = () => {
-      // Clear all mock function calls
-      jest.clearAllMocks();
-    };
-
-    it.each(testCases)('should return the hasError value properly based on the "status.conditions" props data for testcase %p', (testName: string, conditions: Array, expected: Boolean) => {
-      const ctx = { rootGetters: { 'management/byId': jest.fn() } };
-      const cluster = new ProvCluster({ status: { conditions } }, ctx);
-
-      expect(cluster.hasError).toBe(expected);
-      resetMocks();
-    }
-    );
-  });
-});

package/models/__tests__/secret.test.ts

@@ -1,37 +0,0 @@
-import Secret from '@shell/models/secret';
-
-describe('class Secret', () => {
-  it('should contains the type attribute if cleanForDownload', async() => {
-    const secret = new Secret({});
-    const yaml = `apiVersion: v1
-kind: Secret
-metadata:
-  name: my-secret
-type: Opaque
-`;
-    const cleanYaml = await secret.cleanForDownload(yaml);
-
-    expect(cleanYaml).toBe(yaml);
-  });
-
-  it('should remove id, links and actions keys if cleanForDownload', async() => {
-    const secret = new Secret({});
-    const expectedYamlStr = `apiVersion: v1
-kind: Secret
-metadata:
-  name: my-secret
-  namespace: default
-type: Opaque
-`;
-    const part = `id: test_id
-links:
-  view: https://example.com
-actions:
-  remove: https://example.com`;
-    const yaml = `${ expectedYamlStr }
-${ part }`;
-    const cleanYaml = await secret.cleanForDownload(yaml);
-
-    expect(cleanYaml).toBe(expectedYamlStr);
-  });
-});

package/models/__tests__/storage.k8s.io.storageclass.test.ts

@@ -1,22 +0,0 @@
-import StorageClass, { PROVISIONER_OPTIONS } from '@shell/models/storage.k8s.io.storageclass';
-
-describe('class StorageClass', () => {
-  describe('checking if provisionerDisplay', () => {
-    it.each([
-      ['kubernetes.io/azure-disk', true],
-      ['kubernetes.io/portworx-volume', true],
-      ['rancher.io/local-path', false],
-      ['some-random-string-as-provisioner', false],
-    ])('should NOT show a suffix IF they are built-in (on the PROVISIONER_OPTIONS list)', (provisioner, expectation) => {
-      const storageClass = new StorageClass({
-        metadata: {},
-        spec:     {},
-        provisioner
-      });
-
-      jest.spyOn(storageClass, '$rootGetters', 'get').mockReturnValue({ 'i18n/t': jest.fn() });
-
-      expect(!!PROVISIONER_OPTIONS.find((opt) => opt.value === provisioner)).toBe(expectation);
-    });
-  });
-});

package/models/__tests__/workload.test.ts

@@ -1,91 +0,0 @@
-import Workload from '@shell/models/workload.js';
-import { steveClassJunkObject } from '@shell/plugins/steve/__tests__/utils/steve-mocks';
-
-describe('class: Workload', () => {
-  describe('given custom workload keys', () => {
-    const customContainerImage = 'image';
-    const customContainer = {
-      image:    customContainerImage,
-      __active: 'whatever',
-      active:   'whatever',
-      _init:    'whatever',
-      error:    'whatever',
-    };
-    const customWorkload = {
-      ...steveClassJunkObject,
-      type:        '123abv',
-      __rehydrate: 'whatever',
-      __clone:     'whatever',
-      spec:        {
-        template: {
-          spec: {
-            containers:     [customContainer],
-            initContainers: [customContainer],
-          }
-        }
-      }
-    };
-
-    customWorkload.metadata.name = 'abc';
-
-    it('should keep internal keys', () => {
-      const workload = new Workload(customWorkload, {
-        getters:     { schemaFor: () => ({ linkFor: jest.fn() }) },
-        dispatch:    jest.fn(),
-        rootGetters: { 'i18n/t': jest.fn() },
-      });
-
-      expect({ ...workload }).toStrictEqual(customWorkload);
-    });
-
-    describe('method: save', () => {
-      it('should remove all the internal keys', async() => {
-        const dispatch = jest.fn();
-        const workload = new Workload(customWorkload, {
-          getters:     { schemaFor: () => ({ linkFor: jest.fn() }) },
-          dispatch,
-          rootGetters: {
-            'i18n/t':      jest.fn(),
-            'i18n/exists': () => true,
-          },
-        });
-        const expectation = {
-          metadata: {
-            name:                       'abc',
-            fields:                     'whatever',
-            resourceVersion:            'whatever',
-            clusterName:                'whatever',
-            deletionGracePeriodSeconds: 'whatever',
-            generateName:               'whatever',
-          },
-          spec: {
-            template: {
-              spec: {
-                containers:     [{ image: customContainerImage }],
-                initContainers: [{ image: customContainerImage }]
-              }
-            }
-          }
-        };
-
-        await workload.save();
-
-        const opt = {
-          data:    expectation,
-          headers: {
-            accept:         'application/json',
-            'content-type': 'application/json',
-          },
-          method: 'post',
-          url:    undefined,
-        };
-
-        // Data sent should have been cleaned
-        expect(dispatch).toHaveBeenCalledWith('request', { opt, type: customWorkload.type });
-
-        // Original workload model should remain unchanged
-        expect({ ...workload }).toStrictEqual(customWorkload);
-      });
-    });
-  });
-});

package/plugins/clean-html.js

@@ -1,53 +0,0 @@
-import DOMPurify from 'dompurify';
-import { uniq } from '@shell/utils/array';
-
-const ALLOWED_TAGS = [
-  'code',
-  'li',
-  'a',
-  'p',
-  'b',
-  'br',
-  'ul',
-  'pre',
-  'span',
-  'div',
-  'i',
-  'em',
-  'strong',
-  'h1',
-  'h2',
-  'h3',
-  'h4',
-  'h5',
-  'h6',
-  'table',
-  'thead',
-  'tr',
-  'th',
-  'tbody',
-  'td',
-  'blockquote'
-];
-
-// Allow 'A' tags to keep the target=_blank attribute if they have it
-DOMPurify.addHook('uponSanitizeAttribute', (node, data) => {
-  if (node.tagName === 'A' && data.attrName === 'target' && data.attrValue === '_blank') {
-    data.forceKeepAttr = true;
-  }
-});
-
-// Ensure if an 'A' tag has target=_blank that we add noopener, noreferrer and nofollow to the 'rel' attribute
-DOMPurify.addHook('afterSanitizeAttributes', (node) => {
-  if (node.tagName === 'A' && node?.target === '_blank') {
-    const rel = ['noopener', 'noreferrer', 'nofollow'];
-    const existingRel = node.rel?.length ? node.rel.split(' ') : [];
-    const combined = uniq([...rel, ...existingRel]);
-
-    node.setAttribute('rel', combined.join(' '));
-  }
-});
-
-export const purifyHTML = (value, options = { ALLOWED_TAGS }) => {
-  return DOMPurify.sanitize(value, options);
-};

package/plugins/dashboard-store/__tests__/resource-class.test.ts

@@ -1,49 +0,0 @@
-import Resource from '@shell/plugins/dashboard-store/resource-class.js';
-import { resourceClassJunkObject } from '@shell/plugins/dashboard-store/__tests__/utils/store-mocks';
-
-describe('class: Resource', () => {
-  describe('given custom resource keys', () => {
-    const customResource = resourceClassJunkObject;
-
-    it('should keep internal keys', () => {
-      const resource = new Resource(customResource, {
-        getters:     { schemaFor: () => ({ linkFor: jest.fn() }) },
-        dispatch:    jest.fn(),
-        rootGetters: { 'i18n/t': jest.fn() },
-      });
-
-      expect({ ...resource }).toStrictEqual(customResource);
-    });
-
-    describe('method: save', () => {
-      it('should remove all the internal keys', async() => {
-        const dispatch = jest.fn();
-        const resource = new Resource(customResource, {
-          getters:     { schemaFor: () => ({ linkFor: jest.fn() }) },
-          dispatch,
-          rootGetters: { 'i18n/t': jest.fn() },
-        });
-
-        const expectation = { type: customResource.type };
-
-        await resource.save();
-
-        const opt = {
-          data:    expectation,
-          headers: {
-            accept:         'application/json',
-            'content-type': 'application/json',
-          },
-          method: 'post',
-          url:    undefined,
-        };
-
-        // Data sent should have been cleaned
-        expect(dispatch).toHaveBeenCalledWith('request', { opt, type: customResource.type });
-
-        // Original workload model should remain unchanged
-        expect({ ...resource }).toStrictEqual(customResource);
-      });
-    });
-  });
-});

package/plugins/dashboard-store/__tests__/utils/store-mocks.ts

@@ -1,7 +0,0 @@
-const customType = 'dsaf';
-
-export const resourceClassJunkObject = {
-  type:        customType,
-  __rehydrate: 'whatever',
-  __clone:     'whatever',
-};

package/plugins/index.js

@@ -1,11 +0,0 @@
-/**
- * Load the directives
- *
- * These are included in a function that can be explictly called, so that we can be sure
- * of the execution order, rather than importing them at the top of a file.
- */
-export function loadDirectives() {
-  import('./clean-html-directive');
-  import('./clean-tooltip-directive');
-  import('./directives');
-}

package/plugins/steve/__tests__/resource-utils.test.ts

@@ -1,159 +0,0 @@
-import { steveCleanForDownload } from '@shell/plugins/steve/resource-utils';
-
-describe('steve: ressource-utils', () => {
-  it('should do nothing if the yaml is not passed', () => {
-    const r = steveCleanForDownload();
-
-    expect(r).toBeUndefined();
-  });
-  it('should remove all default rootKeys', () => {
-    const expectedYamlStr = `apiVersion: v1
-kind: ConfigMap
-metadata:
-  name: my-configmap
-`;
-    const yamlStr = `
-id: test_id
-links: 
-  view: https://example.com2
-type: test_type
-actions:
-  remove: https://example.com
-${ expectedYamlStr }
-`;
-    const cleanedYamlStr = steveCleanForDownload(yamlStr);
-
-    expect(cleanedYamlStr).toBe(expectedYamlStr);
-  });
-  it('should remove all the specified root keys', () => {
-    const part = `apiVersion: v1
-kind: Secret
-metadata:
-  name: my-secret`;
-
-    const rootKeyToYamlStringMap = {
-      id:    'id: test_id',
-      links: `links:
-  view: https://example.com`,
-      actions: `actions:
-  remove: https://example.com`,
-      type: 'type: Opaque'
-    };
-
-    const entries = Object.entries(rootKeyToYamlStringMap);
-    const yamlStr = `${ part }
-${ entries.map(([_, str]) => str).join('\n') }`;
-
-    entries.forEach(([key, str]) => {
-      const expectedYamlStr = `${ part }
-${ entries.filter(([k]) => k !== key).map(([_, str]) => str).join('\n') }\n`;
-      const cleanedYamlStr = steveCleanForDownload(yamlStr, { rootKeys: [key] });
-
-      expect(cleanedYamlStr).toBe(expectedYamlStr);
-    });
-  });
-  it('should remove all default metadata keys', () => {
-    const expectedYamlStr = `apiVersion: v1
-kind: ConfigMap
-metadata:
-  name: my-configmap
-`;
-    const yamlStr = `apiVersion: v1
-kind: ConfigMap
-metadata:
-  name: my-configmap
-  fields: 
-    - kube-root-ca.crt
-    - 1
-    - 7d23h
-  relationships:
-    - rel: 'owner'
-  state: 'active'
-`;
-    const cleanedYamlStr = steveCleanForDownload(yamlStr);
-
-    expect(cleanedYamlStr).toBe(expectedYamlStr);
-  });
-
-  it('should remove all the specified metadata keys', () => {
-    const part = `apiVersion: v1
-kind: ConfigMap
-metadata:
-  name: my-configmap`;
-
-    const metadataKeyToYamlStringMap = {
-      fields:
-`  fields:
-    - kube-root-ca.crt
-    - 1
-    - 7d23h`,
-      relationships:
-`  relationships:
-    - rel: owner`,
-      state: `  state: active`
-    };
-
-    const entries = Object.entries(metadataKeyToYamlStringMap);
-    const yamlStr = `${ part }
-${ entries.map(([_, str]) => str).join('\n') }`;
-
-    entries.forEach(([key, str]) => {
-      const expectedYamlStr = `${ part }
-${ entries.filter(([k]) => k !== key).map(([_, str]) => str).join('\n') }\n`;
-      const cleanedYamlStr = steveCleanForDownload(yamlStr, { metadataKeys: [key] });
-
-      expect(cleanedYamlStr).toBe(expectedYamlStr);
-    });
-  });
-  it('should remove all defalut condition keys', () => {
-    const expectedYamlStr = `apiVersion: v1
-kind: ConfigMap
-metadata:
-  name: my-configmap
-status:
-  conditions:
-    - {}
-    - {}
-    - message: message
-`;
-    const yamlStr = `apiVersion: v1
-kind: ConfigMap
-metadata:
-  name: my-configmap
-status:
-  conditions:
-    - error: 'error'
-    - transitioning: false
-    - message: message
-`;
-    const cleanedYamlStr = steveCleanForDownload(yamlStr);
-
-    expect(cleanedYamlStr).toBe(expectedYamlStr);
-  });
-  it('should remove all the specified condition keys', () => {
-    const part = `apiVersion: v1
-kind: ConfigMap
-metadata:
-  name: my-configmap
-status:
-  conditions:
-    - message: message`;
-
-    const conditionKeyToYamlStringMap = {
-      error:         '    - error: error',
-      transitioning: '    - transitioning: false'
-    };
-
-    const entries = Object.entries(conditionKeyToYamlStringMap);
-    const yamlStr = `${ part }
-${ entries.map(([_, str]) => str).join('\n') }`;
-
-    entries.forEach(([key, str]) => {
-      const expectedYamlStr = `${ part }
-${ entries.map(([k, str]) => k === key ? '    - {}' : str).join('\n') }\n`;
-      const cleanedYamlStr = steveCleanForDownload(yamlStr, { conditionKeys: [key] });
-
-      expect(cleanedYamlStr).toBe(expectedYamlStr);
-    });
-  });
-});