From 37052c8c3fa91ddca612c801ae8e7eff44d7043b Mon Sep 17 00:00:00 2001 From: Wouter Admiraal Date: Thu, 29 Sep 2022 11:02:00 +0200 Subject: [PATCH] SONAR-17188 Improve tests --- .../BranchAnalysisStepContent.tsx | 12 +- .../ExtensionInstallationStepContent.tsx | 2 +- .../ServiceEndpointStepContent.tsx | 2 +- .../__tests__/AzurePipelinesTutorial-it.tsx | 133 +- .../AzurePipelinesTutorial-it.tsx.snap | 3334 +---------------- .../tutorials/components/AllSetStep.tsx | 2 +- 6 files changed, 78 insertions(+), 3407 deletions(-) diff --git a/server/sonar-web/src/main/js/components/tutorials/azure-pipelines/BranchAnalysisStepContent.tsx b/server/sonar-web/src/main/js/components/tutorials/azure-pipelines/BranchAnalysisStepContent.tsx index 0579b592fa6..70200e4d080 100644 --- a/server/sonar-web/src/main/js/components/tutorials/azure-pipelines/BranchAnalysisStepContent.tsx +++ b/server/sonar-web/src/main/js/components/tutorials/azure-pipelines/BranchAnalysisStepContent.tsx @@ -58,13 +58,11 @@ export function BranchAnalysisStepContent(props: BranchesAnalysisStepProps) { optionLabelKey="onboarding.build" options={buildToolsList} /> -
- -
+ ); } diff --git a/server/sonar-web/src/main/js/components/tutorials/azure-pipelines/ExtensionInstallationStepContent.tsx b/server/sonar-web/src/main/js/components/tutorials/azure-pipelines/ExtensionInstallationStepContent.tsx index 2b6271bc5d8..eff9bb3e535 100644 --- a/server/sonar-web/src/main/js/components/tutorials/azure-pipelines/ExtensionInstallationStepContent.tsx +++ b/server/sonar-web/src/main/js/components/tutorials/azure-pipelines/ExtensionInstallationStepContent.tsx @@ -24,7 +24,7 @@ import Link from '../../common/Link'; export default function ExtensionInstallationStepContent() { return ( - + -
    +
    1. { + await clickButton(user, `onboarding.build.other.os.${os}`); + assertCFamilyStepIsCorrectlyRendered(os); + }); //// Analysis step: Other await clickButton(user, 'onboarding.build.other'); @@ -171,45 +162,12 @@ it('should not offer CFamily analysis if the language is not available', async ( ).not.toBeInTheDocument(); }); -function renderAzurePipelinesTutorial( - props: Partial = {}, - { - appState = mockAppState({ branchesEnabled: true }), - languages = { c: mockLanguage({ key: 'c' }) } - }: RenderContext = {} -) { - return renderApp( - '/', - , - { appState, languages } - ); -} - -async function clickButton(user: UserEvent, name: string, context?: HTMLElement) { - if (context) { - await user.click(within(context).getByRole('button', { name })); - } else { - await user.click(screen.getByRole('button', { name })); - } -} - -async function goToNextStep(user: UserEvent) { - await clickButton(user, 'continue'); -} - function assertDefaultStepIsCorrectlyRendered() { expect( screen.getByRole('heading', { name: 'onboarding.tutorial.with.azure_pipelines.ExtensionInstallation.title' }) ).toBeInTheDocument(); - expect(screen.getByTestId('azure-tutorial__extension')).toMatchSnapshot('extension step'); } function assertServiceEndpointStepIsCorrectlyRendered() { @@ -218,10 +176,7 @@ function assertServiceEndpointStepIsCorrectlyRendered() { name: 'onboarding.tutorial.with.azure_pipelines.ServiceEndpoint.title' }) ).toBeInTheDocument(); - expect(screen.getByTestId('azure-tutorial__service-endpoint')).toMatchSnapshot( - 'service endpoint step' - ); - expect(screen.getByRole('button', { name: 'copy_to_clipboard' })).toBeInTheDocument(); + expect(getCopyToClipboardValue()).toBe('https://sonarqube.example.com/'); expect( screen.getByRole('button', { name: 'onboarding.token.generate.long' }) ).toBeInTheDocument(); @@ -233,45 +188,26 @@ function assertDotNetStepIsCorrectlyRendered() { name: 'onboarding.tutorial.with.azure_pipelines.BranchAnalysis.title' }) ).toBeInTheDocument(); - - expect(screen.getByTestId('azure-tutorial__analysis-command')).toMatchSnapshot('dotnet step'); - expect(screen.getByRole('button', { name: 'copy_to_clipboard' })).toBeInTheDocument(); + expect(getCopyToClipboardValue()).toBe('foo'); } function assertMavenStepIsCorrectlyRendered() { - expect(screen.getByTestId('azure-tutorial__analysis-command')).toMatchSnapshot('maven step'); - expect(screen.getByRole('button', { name: 'copy_to_clipboard' })).toBeInTheDocument(); + expect(getCopyToClipboardValue()).toMatchSnapshot('maven, copy additional properties'); } function assertGradleStepIsCorrectlyRendered() { - expect(screen.getByTestId('azure-tutorial__analysis-command')).toMatchSnapshot('gradle step'); - expect(screen.getByRole('button', { name: 'copy_to_clipboard' })).toBeInTheDocument(); + expect(getCopyToClipboardValue()).toMatchSnapshot('gradle, copy additional properties'); } -function assertCFamilyLinuxStepIsCorrectlyRendered() { - expect(screen.getByTestId('azure-tutorial__analysis-command')).toMatchSnapshot( - 'cfamily linux step' - ); - expect(screen.getAllByRole('button', { name: 'copy_to_clipboard' })).toHaveLength(4); -} - -function assertCFamilyWindowsStepIsCorrectlyRendered() { - expect(screen.getByTestId('azure-tutorial__analysis-command')).toMatchSnapshot( - 'cfamily windows step' - ); - expect(screen.getAllByRole('button', { name: 'copy_to_clipboard' })).toHaveLength(4); -} - -function assertCFamilyMacOSStepIsCorrectlyRendered() { - expect(screen.getByTestId('azure-tutorial__analysis-command')).toMatchSnapshot( - 'cfamily macos step' - ); - expect(screen.getAllByRole('button', { name: 'copy_to_clipboard' })).toHaveLength(4); +function assertCFamilyStepIsCorrectlyRendered(os: string) { + expect(getCopyToClipboardValue(0)).toMatchSnapshot(`cfamily ${os}, copy shell script`); + expect(getCopyToClipboardValue(1)).toBe('foo'); + expect(getCopyToClipboardValue(2)).toMatchSnapshot(`cfamily ${os}, copy additional properties`); + expect(getCopyToClipboardValue(3)).toMatchSnapshot(`cfamily ${os}, copy build-wrapper command`); } function assertOtherStepIsCorrectlyRendered() { - expect(screen.getByTestId('azure-tutorial__analysis-command')).toMatchSnapshot('other step'); - expect(screen.getByRole('button', { name: 'copy_to_clipboard' })).toBeInTheDocument(); + expect(getCopyToClipboardValue()).toBe('foo'); } function assertFinishStepIsCorrectlyRendered() { @@ -280,5 +216,40 @@ function assertFinishStepIsCorrectlyRendered() { name: 'onboarding.tutorial.ci_outro.all_set.title' }) ).toBeInTheDocument(); - expect(screen.getByTestId('azure-tutorial__all-set')).toMatchSnapshot('all set step'); +} + +function renderAzurePipelinesTutorial( + props: Partial = {}, + { + appState = mockAppState({ branchesEnabled: true }), + languages = { c: mockLanguage({ key: 'c' }) } + }: RenderContext = {} +) { + return renderApp( + '/', + , + { appState, languages } + ); +} + +async function clickButton(user: UserEvent, name: string, context?: HTMLElement) { + if (context) { + await user.click(within(context).getByRole('button', { name })); + } else { + await user.click(screen.getByRole('button', { name })); + } +} + +async function goToNextStep(user: UserEvent) { + await clickButton(user, 'continue'); +} + +function getCopyToClipboardValue(i = 0, name = 'copy_to_clipboard') { + return screen.getAllByRole('button', { name })[i].getAttribute('data-clipboard-text'); } diff --git a/server/sonar-web/src/main/js/components/tutorials/azure-pipelines/__tests__/__snapshots__/AzurePipelinesTutorial-it.tsx.snap b/server/sonar-web/src/main/js/components/tutorials/azure-pipelines/__tests__/__snapshots__/AzurePipelinesTutorial-it.tsx.snap index 8d91963a5b3..f02fe7b9621 100644 --- a/server/sonar-web/src/main/js/components/tutorials/azure-pipelines/__tests__/__snapshots__/AzurePipelinesTutorial-it.tsx.snap +++ b/server/sonar-web/src/main/js/components/tutorials/azure-pipelines/__tests__/__snapshots__/AzurePipelinesTutorial-it.tsx.snap @@ -1,3340 +1,42 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP -exports[`should render correctly and allow navigating between the different steps: all set step 1`] = ` -
      -
      -

      - onboarding.tutorial.ci_outro.all_set.sentence - - onboarding.tutorial.ci_outro.all_set.sentence.all_set - -

      -
      -
      - -
      -
      -

      - - onboarding.tutorial.ci_outro.commit - -

      -

      - onboarding.tutorial.ci_outro.commit.why.azure -

      -
      -
      -
      -
      - -
      -
      -

      - - onboarding.tutorial.ci_outro.refresh - -

      -

      - onboarding.tutorial.ci_outro.refresh.why -

      -
      -
      -
      -
      -