source.dussan.org Git - sonarqube.git/blob

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2023 SonarSource SA
   4  * mailto:info AT sonarsource DOT com
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 3 of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  */
  20
  21 import userEvent from '@testing-library/user-event';
  22 import React from 'react';
  23 import selectEvent from 'react-select-event';
  24 import UserTokensMock from '../../../../api/mocks/UserTokensMock';
  25 import {
  26   mockAlmSettingsInstance,
  27   mockProjectAlmBindingResponse,
  28 } from '../../../../helpers/mocks/alm-settings';
  29 import { mockComponent } from '../../../../helpers/mocks/component';
  30 import { mockLanguage, mockLoggedInUser } from '../../../../helpers/testMocks';
  31 import { renderApp, RenderContext } from '../../../../helpers/testReactTestingUtils';
  32 import { AlmKeys } from '../../../../types/alm-settings';
  33 import { Feature } from '../../../../types/features';
  34 import {
  35   getCommonNodes,
  36   getCopyToClipboardValue,
  37   getTutorialActionButtons,
  38   getTutorialBuildButtons,
  39 } from '../../test-utils';
  40 import { TutorialModes } from '../../types';
  41 import GitHubActionTutorial, { GitHubActionTutorialProps } from '../GitHubActionTutorial';
  42
  43 jest.mock('../../../../api/user-tokens');
  44
  45 jest.mock('../../../../api/settings', () => ({
  46   getAllValues: jest.fn().mockResolvedValue([]),
  47 }));
  48
  49 const tokenMock = new UserTokensMock();
  50
  51 afterEach(() => {
  52   tokenMock.reset();
  53 });
  54
  55 const ui = {
  56   ...getCommonNodes(TutorialModes.GitHubActions),
  57   ...getTutorialActionButtons(),
  58   ...getTutorialBuildButtons(),
  59 };
  60
  61 it('should follow and complete all steps', async () => {
  62   const user = userEvent.setup();
  63   renderGithubActionTutorial();
  64
  65   expect(await ui.secretsStepTitle.find()).toBeInTheDocument();
  66
  67   // Env variables step
  68   expect(getCopyToClipboardValue()).toMatchSnapshot('sonar token key');
  69   expect(getCopyToClipboardValue(1)).toMatchSnapshot('sonarqube host url key');
  70   expect(getCopyToClipboardValue(2)).toMatchSnapshot('sonarqube host url value');
  71   await user.click(ui.continueButton.get());
  72
  73   // Create/update configuration file step
  74   // Maven
  75   await user.click(ui.mavenBuildButton.get());
  76   expect(getCopyToClipboardValue(1)).toMatchSnapshot('Maven: .github/workflows/build.yml');
  77
  78   // Gradle
  79   await user.click(ui.gradleBuildButton.get());
  80   expect(getCopyToClipboardValue(1)).toMatchSnapshot('Gradle: build.gradle');
  81   expect(getCopyToClipboardValue(3)).toMatchSnapshot('Gradle: .github/workflows/build.yml');
  82
  83   // .NET
  84   await user.click(ui.dotnetBuildButton.get());
  85   expect(getCopyToClipboardValue(1)).toMatchSnapshot('.NET: .github/workflows/build.yml');
  86
  87   // CFamily
  88   await user.click(ui.cFamilyBuildButton.get());
  89   expect(getCopyToClipboardValue()).toMatchSnapshot('CFamily: sonar-project.properties');
  90   await user.click(ui.linuxButton.get());
  91   expect(getCopyToClipboardValue(2)).toMatchSnapshot('CFamily Linux: .github/workflows/build.yml');
  92   await user.click(ui.windowsButton.get());
  93   expect(getCopyToClipboardValue(2)).toMatchSnapshot(
  94     'CFamily Windows: .github/workflows/build.yml'
  95   );
  96   await user.click(ui.macosButton.get());
  97   expect(getCopyToClipboardValue(2)).toMatchSnapshot('CFamily MacOS: .github/workflows/build.yml');
  98
  99   // Other
 100   await user.click(ui.otherBuildButton.get());
 101   expect(getCopyToClipboardValue()).toMatchSnapshot('Other: sonar-project.properties');
 102   expect(getCopyToClipboardValue(2)).toMatchSnapshot('Other: .github/workflows/build.yml');
 103
 104   await user.click(ui.finishTutorialButton.get());
 105   expect(ui.allSetSentence.get()).toBeInTheDocument();
 106 });
 107
 108 it('should generate/delete a new token or use existing one', async () => {
 109   const user = userEvent.setup();
 110   renderGithubActionTutorial();
 111
 112   expect(await ui.secretsStepTitle.find()).toBeInTheDocument();
 113
 114   // Generate token
 115   await user.click(ui.genTokenDialogButton.get());
 116   await user.click(ui.generateTokenButton.get());
 117   expect(getCopyToClipboardValue(3)).toEqual('generatedtoken2');
 118
 119   // Revoke current token and create new one
 120   await user.click(ui.deleteTokenButton.get());
 121   await user.type(ui.tokenNameInput.get(), 'newtoken');
 122   await selectEvent.select(ui.expiresInSelect.get(), 'users.tokens.expiration.365');
 123   await user.click(ui.generateTokenButton.get());
 124   expect(ui.tokenValue.get()).toBeInTheDocument();
 125   await user.click(ui.continueButton.getAll()[1]);
 126   expect(ui.tokenValue.query()).not.toBeInTheDocument();
 127 });
 128
 129 it('navigates between steps', async () => {
 130   const user = userEvent.setup();
 131   renderGithubActionTutorial({
 132     almBinding: mockAlmSettingsInstance({
 133       alm: AlmKeys.GitHub,
 134       url: 'http://localhost/qube',
 135     }),
 136     projectBinding: mockProjectAlmBindingResponse({ alm: AlmKeys.GitHub }),
 137   });
 138
 139   // If project is bound, link to repo is visible
 140   expect(await ui.linkToRepo.find()).toBeInTheDocument();
 141
 142   await user.click(await ui.continueButton.find());
 143   await user.click(ui.mavenBuildButton.get());
 144   await user.click(ui.finishTutorialButton.get());
 145   expect(ui.allSetSentence.get()).toBeInTheDocument();
 146
 147   await user.click(ui.ymlFileStepTitle.get());
 148   expect(ui.mavenBuildButton.get()).toBeInTheDocument();
 149   await user.click(ui.secretsStepTitle.get());
 150   expect(ui.genTokenDialogButton.get()).toBeInTheDocument();
 151 });
 152
 153 function renderGithubActionTutorial(
 154   overrides: Partial<GitHubActionTutorialProps> = {},
 155   { languages = { c: mockLanguage({ key: 'c' }) } }: RenderContext = {}
 156 ) {
 157   return renderApp(
 158     '/',
 159     <GitHubActionTutorial
 160       baseUrl="http://localhost:9000"
 161       mainBranchName="main"
 162       component={mockComponent()}
 163       currentUser={mockLoggedInUser()}
 164       {...overrides}
 165     />,
 166     { languages, featureList: [Feature.BranchSupport] }
 167   );
 168 }