tests: fixing the tests

Signed-off-by: blam <ben@blam.sh>
2023-11-14 09:48:25 +01:00
parent d7b057458b
commit 108bbb7858
3 changed files with 153 additions and 7 deletions
@@ -14,12 +14,21 @@
 * limitations under the License.
 */

-import { renderHook } from '@testing-library/react-hooks';
+import { renderHook } from '@testing-library/react';
 import { useFilteredSchemaProperties } from './useFilteredSchemaProperties';
 import { TemplateParameterSchema } from '../../types';
+import { TestApiProvider } from '@backstage/test-utils';
+import React from 'react';
+import { featureFlagsApiRef } from '@backstage/core-plugin-api';
+
+const mockFeatureFlagApi = {
+  isActive: jest.fn(),
+};

 describe('useFilteredSchemaProperties', () => {
-  it('should hide "Fill in some steps" from steps of template', () => {
+  it('should return the same manifest if no feature flag is set', () => {
+    mockFeatureFlagApi.isActive.mockReturnValue(true);
+
    const manifest: TemplateParameterSchema = {
      title: 'Test Action template',
      description: 'scaffolder v1beta3 template demo',
@@ -55,8 +64,147 @@ describe('useFilteredSchemaProperties', () => {
      ],
    };

-    const sortedManifest = renderHook(() =>
-      useFilteredSchemaProperties(manifest),
+    const filteredManifest = renderHook(
+      () => useFilteredSchemaProperties(manifest),
+      {
+        wrapper: ({ children }) => (
+          <TestApiProvider apis={[[featureFlagsApiRef, mockFeatureFlagApi]]}>
+            {children}
+          </TestApiProvider>
+        ),
+      },
+    );
+
+    expect(filteredManifest.result.current).toEqual(manifest);
+  });
+
+  it('should hide individual fields from steps of template', () => {
+    mockFeatureFlagApi.isActive.mockReturnValue(false);
+
+    const manifest: TemplateParameterSchema = {
+      title: 'Test Action template',
+      description: 'scaffolder v1beta3 template demo',
+      steps: [
+        {
+          title: 'Fill in some steps',
+          schema: {
+            type: 'object',
+            properties: {
+              name: {
+                description: 'Unique name of the component',
+                title: 'Name',
+                type: 'string',
+                'ui:autofocus': true,
+              },
+            },
+          },
+        },
+        {
+          title: 'Choose a location',
+          schema: {
+            type: 'object',
+            properties: {
+              repoUrl: {
+                type: 'string',
+                title: 'Repository Location',
+                'ui:field': 'RepoUrlPicker',
+                'backstage:featureFlag': 'experimental-feature',
+              },
+            },
+          },
+        },
+      ],
+    };
+
+    const filteredManifest = renderHook(
+      () => useFilteredSchemaProperties(manifest),
+      {
+        wrapper: ({ children }) => (
+          <TestApiProvider apis={[[featureFlagsApiRef, mockFeatureFlagApi]]}>
+            {children}
+          </TestApiProvider>
+        ),
+      },
+    );
+
+    const expectedManifest: TemplateParameterSchema = {
+      title: 'Test Action template',
+      description: 'scaffolder v1beta3 template demo',
+      steps: [
+        {
+          title: 'Fill in some steps',
+          schema: {
+            type: 'object',
+            properties: {
+              name: {
+                description: 'Unique name of the component',
+                title: 'Name',
+                type: 'string',
+                'ui:autofocus': true,
+              },
+            },
+          },
+        },
+        {
+          title: 'Choose a location',
+          schema: {
+            type: 'object',
+            properties: {},
+          },
+        },
+      ],
+    };
+
+    expect(filteredManifest.result.current).toEqual(expectedManifest);
+  });
+
+  it('should hide "Fill in some steps" from steps of template', () => {
+    mockFeatureFlagApi.isActive.mockReturnValue(false);
+
+    const manifest: TemplateParameterSchema = {
+      title: 'Test Action template',
+      description: 'scaffolder v1beta3 template demo',
+      steps: [
+        {
+          title: 'Fill in some steps',
+          schema: {
+            type: 'object',
+            'backstage:featureFlag': 'experimental-feature',
+            properties: {
+              name: {
+                description: 'Unique name of the component',
+                title: 'Name',
+                type: 'string',
+                'ui:autofocus': true,
+              },
+            },
+          },
+        },
+        {
+          title: 'Choose a location',
+          schema: {
+            type: 'object',
+            properties: {
+              repoUrl: {
+                type: 'string',
+                title: 'Repository Location',
+                'ui:field': 'RepoUrlPicker',
+              },
+            },
+          },
+        },
+      ],
+    };
+
+    const filteredManifest = renderHook(
+      () => useFilteredSchemaProperties(manifest),
+      {
+        wrapper: ({ children }) => (
+          <TestApiProvider apis={[[featureFlagsApiRef, mockFeatureFlagApi]]}>
+            {children}
+          </TestApiProvider>
+        ),
+      },
    );

    const expectedManifest: TemplateParameterSchema = {
@@ -79,6 +227,6 @@ describe('useFilteredSchemaProperties', () => {
      ],
    };

-    expect(sortedManifest).toEqual(expectedManifest);
+    expect(filteredManifest.result.current).toEqual(expectedManifest);
  });
 });