add EmbeddedScaffolderWorkflow test

Signed-off-by: Paul Cowan <paul.cowan@cutting.scot>
2022-12-12 17:46:49 +00:00
parent 405a8502ff
commit 880ee2f353
1 changed files with 129 additions and 1 deletions
@@ -13,6 +13,134 @@
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
+
+import { ApiProvider } from '@backstage/core-app-api';
+import {
+  MockAnalyticsApi,
+  renderInTestApp,
+  TestApiRegistry,
+} from '@backstage/test-utils';
+import { act, fireEvent } from '@testing-library/react';
+import React from 'react';
+import { EmbeddedScaffolderWorkflow } from './EmbeddedScaffolderWorkflow';
+import { scaffolderApiRef } from '../../api';
+import { ScaffolderApi } from '../../types';
+import { analyticsApiRef } from '@backstage/core-plugin-api';
+
+const scaffolderApiMock: jest.Mocked<ScaffolderApi> = {
+  scaffold: jest.fn(),
+  getTemplateParameterSchema: jest.fn(),
+  getIntegrationsList: jest.fn(),
+  getTask: jest.fn(),
+  streamLogs: jest.fn(),
+  listActions: jest.fn(),
+  listTasks: jest.fn(),
+};
+
+const analyticsMock = new MockAnalyticsApi();
+const apis = TestApiRegistry.from(
+  [scaffolderApiRef, scaffolderApiMock],
+  [analyticsApiRef, analyticsMock],
+);
+
 describe('<EmbeddedScaffolderWorkflow />', () => {
-  it('should embed workflow inside another component', () => {});
+  it('should embed workflow inside another component', async () => {
+    const onComplete = jest.fn();
+    const onError = jest.fn();
+    scaffolderApiMock.scaffold.mockResolvedValue({ taskId: 'xyz' });
+
+    scaffolderApiMock.getTemplateParameterSchema.mockResolvedValue({
+      steps: [
+        {
+          title: 'Step 1',
+          schema: {
+            properties: {
+              name: {
+                type: 'string',
+              },
+            },
+          },
+        },
+      ],
+      title: 'React JSON Schema Form Test',
+    });
+
+    const { getByRole, getAllByRole, getByText } = await renderInTestApp(
+      <ApiProvider apis={apis}>
+        <EmbeddedScaffolderWorkflow
+          title="Different title than template"
+          description={`
+      ## This is markdown
+      - overriding the template description
+            `}
+          onComplete={onComplete}
+          onError={onError}
+          namespace="default"
+          templateName="docs-template"
+          initialFormState={{
+            name: 'prefilled-name',
+          }}
+          frontPage={
+            <>
+              <h1>Security Insights</h1>
+              <p>
+                Security insights actionable advice to improve security posture
+                of your application
+              </p>
+              <p>
+                You must complete on-boarding process to activate security
+                insights on this project.
+              </p>
+            </>
+          }
+          finishPage={
+            <>
+              <h1>Congratulations, this application is complete!</h1>
+            </>
+          }
+          ReviewStateWrapper={() => (
+            <h1>This is a different wrapper for the review page</h1>
+          )}
+        />
+      </ApiProvider>,
+    );
+
+    // frontPage is rendered
+    expect(getByRole('heading').innerHTML).toBe('Security Insights');
+
+    // move to workflow
+    await act(async () => {
+      fireEvent.click(getByRole('button'));
+    });
+
+    // Test template title is overriden
+    expect(getByRole('heading').innerHTML).toBe(
+      'Different title than template',
+    );
+
+    expect(getByRole('textbox').innerHTML).toBeDefined();
+
+    const input = getByRole('textbox') as HTMLInputElement;
+
+    // The initial state of the form can be set
+    expect(input.value).toBe('prefilled-name');
+
+    await act(async () => {
+      fireEvent.click(getAllByRole('button')[1] as HTMLButtonElement);
+    });
+
+    // Can supply a different Review wrapper
+    expect(
+      getByText('This is a different wrapper for the review page'),
+    ).toBeDefined();
+
+    await act(async () => {
+      fireEvent.click(getAllByRole('button')[1] as HTMLButtonElement);
+    });
+
+    // the final page is inserted after the workflow
+    expect(
+      getByText('Congratulations, this application is complete!'),
+    ).toBeDefined();
+  });
 });