123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289 |
- /*
- * SonarQube
- * Copyright (C) 2009-2021 SonarSource SA
- * mailto:info AT sonarsource DOT com
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 3 of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- */
- package org.sonar.scanner.report;
-
- import com.google.common.collect.ImmutableMap;
- import com.tngtech.java.junit.dataprovider.DataProvider;
- import com.tngtech.java.junit.dataprovider.DataProviderRunner;
- import com.tngtech.java.junit.dataprovider.UseDataProvider;
- import java.io.File;
- import java.io.IOException;
- import java.nio.file.Files;
- import java.nio.file.Path;
- import java.nio.file.Paths;
- import java.time.Instant;
- import java.util.Collections;
- import java.util.Date;
- import java.util.Optional;
- import javax.annotation.Nullable;
- import org.junit.Before;
- import org.junit.Rule;
- import org.junit.Test;
- import org.junit.rules.TemporaryFolder;
- import org.junit.runner.RunWith;
- import org.sonar.api.batch.bootstrap.ProjectDefinition;
- import org.sonar.api.batch.fs.internal.DefaultInputModule;
- import org.sonar.api.batch.fs.internal.TestInputFileBuilder;
- import org.sonar.api.batch.scm.ScmProvider;
- import org.sonar.scanner.ProjectInfo;
- import org.sonar.scanner.bootstrap.ScannerPlugin;
- import org.sonar.scanner.bootstrap.ScannerPluginRepository;
- import org.sonar.scanner.cpd.CpdSettings;
- import org.sonar.scanner.fs.InputModuleHierarchy;
- import org.sonar.scanner.protocol.output.ScannerReport;
- import org.sonar.scanner.protocol.output.ScannerReportReader;
- import org.sonar.scanner.protocol.output.ScannerReportWriter;
- import org.sonar.scanner.repository.ForkDateSupplier;
- import org.sonar.scanner.rule.QProfile;
- import org.sonar.scanner.rule.QualityProfiles;
- import org.sonar.scanner.scan.branch.BranchConfiguration;
- import org.sonar.scanner.scan.branch.BranchType;
- import org.sonar.scanner.scan.filesystem.InputComponentStore;
- import org.sonar.scanner.scm.ScmConfiguration;
- import org.sonar.scanner.scm.ScmRevision;
-
- import static java.util.Collections.emptyMap;
- import static org.apache.commons.lang.RandomStringUtils.randomAlphabetic;
- import static org.assertj.core.api.Assertions.assertThat;
- import static org.assertj.core.api.Assertions.entry;
- import static org.mockito.ArgumentMatchers.any;
- import static org.mockito.Mockito.mock;
- import static org.mockito.Mockito.when;
-
- @RunWith(DataProviderRunner.class)
- public class MetadataPublisherTest {
-
- @Rule
- public TemporaryFolder temp = new TemporaryFolder();
-
- private MetadataPublisher underTest;
- private final QualityProfiles qProfiles = mock(QualityProfiles.class);
- private final ProjectInfo projectInfo = mock(ProjectInfo.class);
- private final CpdSettings cpdSettings = mock(CpdSettings.class);
- private final ForkDateSupplier forkDateSupplier = mock(ForkDateSupplier.class);
- private final ScannerPluginRepository pluginRepository = mock(ScannerPluginRepository.class);
- private BranchConfiguration branches;
- private ScmConfiguration scmConfiguration;
- private final ScmProvider scmProvider = mock(ScmProvider.class);
- private final ScmRevision scmRevision = mock(ScmRevision.class);
- private final InputComponentStore componentStore = mock(InputComponentStore.class);
-
- @Before
- public void prepare() throws IOException {
- when(projectInfo.getAnalysisDate()).thenReturn(new Date(1234567L));
- when(scmProvider.relativePathFromScmRoot(any(Path.class))).thenReturn(Paths.get("dummy/path"));
- when(scmProvider.revisionId(any(Path.class))).thenReturn("dummy-sha1");
-
- createPublisher(ProjectDefinition.create());
- when(pluginRepository.getPluginsByKey()).thenReturn(emptyMap());
- }
-
- private void createPublisher(ProjectDefinition def) throws IOException {
- Path rootBaseDir = temp.newFolder().toPath();
- Path moduleBaseDir = rootBaseDir.resolve("moduleDir");
- Files.createDirectory(moduleBaseDir);
- DefaultInputModule rootModule = new DefaultInputModule(def
- .setBaseDir(rootBaseDir.toFile())
- .setKey("root")
- .setWorkDir(temp.newFolder()), TestInputFileBuilder.nextBatchId());
- InputModuleHierarchy inputModuleHierarchy = mock(InputModuleHierarchy.class);
- when(inputModuleHierarchy.root()).thenReturn(rootModule);
- DefaultInputModule child = new DefaultInputModule(ProjectDefinition.create()
- .setKey("module")
- .setBaseDir(moduleBaseDir.toFile())
- .setWorkDir(temp.newFolder()), TestInputFileBuilder.nextBatchId());
- when(inputModuleHierarchy.children(rootModule)).thenReturn(Collections.singletonList(child));
- when(inputModuleHierarchy.relativePathToRoot(child)).thenReturn("modulePath");
- when(inputModuleHierarchy.relativePathToRoot(rootModule)).thenReturn("");
- branches = mock(BranchConfiguration.class);
- scmConfiguration = mock(ScmConfiguration.class);
- when(scmConfiguration.provider()).thenReturn(scmProvider);
- underTest = new MetadataPublisher(projectInfo, inputModuleHierarchy, qProfiles, cpdSettings,
- pluginRepository, branches, scmRevision, forkDateSupplier, componentStore, scmConfiguration);
- }
-
- @Test
- public void write_metadata() throws Exception {
- Date date = new Date();
- when(forkDateSupplier.get()).thenReturn(Instant.ofEpochMilli(123456789L));
- when(qProfiles.findAll()).thenReturn(Collections.singletonList(new QProfile("q1", "Q1", "java", date)));
- when(pluginRepository.getPluginsByKey()).thenReturn(ImmutableMap.of(
- "java", new ScannerPlugin("java", 12345L, null),
- "php", new ScannerPlugin("php", 45678L, null)));
- File outputDir = temp.newFolder();
- ScannerReportWriter writer = new ScannerReportWriter(outputDir);
-
- underTest.publish(writer);
-
- ScannerReportReader reader = new ScannerReportReader(outputDir);
- ScannerReport.Metadata metadata = reader.readMetadata();
- assertThat(metadata.getForkDate()).isEqualTo(123456789L);
- assertThat(metadata.getAnalysisDate()).isEqualTo(1234567L);
- assertThat(metadata.getProjectKey()).isEqualTo("root");
- assertThat(metadata.getModulesProjectRelativePathByKeyMap()).containsOnly(entry("module", "modulePath"), entry("root", ""));
- assertThat(metadata.getProjectVersion()).isEmpty();
- assertThat(metadata.getNotAnalyzedFilesByLanguageCount()).isZero();
- assertThat(metadata.getQprofilesPerLanguageMap()).containsOnly(entry("java", org.sonar.scanner.protocol.output.ScannerReport.Metadata.QProfile.newBuilder()
- .setKey("q1")
- .setName("Q1")
- .setLanguage("java")
- .setRulesUpdatedAt(date.getTime())
- .build()));
- assertThat(metadata.getPluginsByKey()).containsOnly(entry("java", org.sonar.scanner.protocol.output.ScannerReport.Metadata.Plugin.newBuilder()
- .setKey("java")
- .setUpdatedAt(12345)
- .build()),
- entry("php", org.sonar.scanner.protocol.output.ScannerReport.Metadata.Plugin.newBuilder()
- .setKey("php")
- .setUpdatedAt(45678)
- .build()));
- }
-
- @Test
- public void write_not_analysed_file_counts() throws Exception {
- when(componentStore.getNotAnalysedFilesByLanguage()).thenReturn(ImmutableMap.of("c", 10, "cpp", 20));
-
- File outputDir = temp.newFolder();
- ScannerReportWriter writer = new ScannerReportWriter(outputDir);
-
- underTest.publish(writer);
-
- ScannerReportReader reader = new ScannerReportReader(outputDir);
- ScannerReport.Metadata metadata = reader.readMetadata();
- assertThat(metadata.getNotAnalyzedFilesByLanguageMap()).contains(entry("c", 10), entry("cpp", 20));
- }
-
- @Test
- @UseDataProvider("projectVersions")
- public void write_project_version(@Nullable String projectVersion, String expected) throws Exception {
- when(projectInfo.getProjectVersion()).thenReturn(Optional.ofNullable(projectVersion));
-
- File outputDir = temp.newFolder();
- ScannerReportWriter writer = new ScannerReportWriter(outputDir);
-
- underTest.publish(writer);
-
- ScannerReportReader reader = new ScannerReportReader(outputDir);
- ScannerReport.Metadata metadata = reader.readMetadata();
- assertThat(metadata.getProjectVersion()).isEqualTo(expected);
- }
-
- @DataProvider
- public static Object[][] projectVersions() {
- String version = randomAlphabetic(15);
- return new Object[][] {
- {null, ""},
- {"", ""},
- {"5.6.3", "5.6.3"},
- {version, version}
- };
- }
-
- @Test
- @UseDataProvider("buildStrings")
- public void write_buildString(@Nullable String buildString, String expected) throws Exception {
- when(projectInfo.getBuildString()).thenReturn(Optional.ofNullable(buildString));
-
- File outputDir = temp.newFolder();
- ScannerReportWriter writer = new ScannerReportWriter(outputDir);
-
- underTest.publish(writer);
-
- ScannerReportReader reader = new ScannerReportReader(outputDir);
- ScannerReport.Metadata metadata = reader.readMetadata();
- assertThat(metadata.getBuildString()).isEqualTo(expected);
- }
-
- @DataProvider
- public static Object[][] buildStrings() {
- String randomBuildString = randomAlphabetic(15);
- return new Object[][] {
- {null, ""},
- {"", ""},
- {"5.6.3", "5.6.3"},
- {randomBuildString, randomBuildString}
- };
- }
-
- @Test
- public void write_branch_info() throws Exception {
- String branchName = "name";
- String targetName = "target";
-
- when(branches.branchName()).thenReturn(branchName);
- when(branches.branchType()).thenReturn(BranchType.BRANCH);
- when(branches.targetBranchName()).thenReturn(targetName);
-
- File outputDir = temp.newFolder();
- underTest.publish(new ScannerReportWriter(outputDir));
-
- ScannerReportReader reader = new ScannerReportReader(outputDir);
- ScannerReport.Metadata metadata = reader.readMetadata();
- assertThat(metadata.getBranchName()).isEqualTo(branchName);
- assertThat(metadata.getBranchType()).isEqualTo(ScannerReport.Metadata.BranchType.BRANCH);
- assertThat(metadata.getReferenceBranchName()).isEmpty();
- assertThat(metadata.getTargetBranchName()).isEqualTo(targetName);
- }
-
- @Test
- public void write_project_basedir() throws Exception {
- String path = "some/dir";
- Path relativePathFromScmRoot = Paths.get(path);
- when(scmProvider.relativePathFromScmRoot(any(Path.class))).thenReturn(relativePathFromScmRoot);
-
- File outputDir = temp.newFolder();
- underTest.publish(new ScannerReportWriter(outputDir));
-
- ScannerReportReader reader = new ScannerReportReader(outputDir);
- ScannerReport.Metadata metadata = reader.readMetadata();
- assertThat(metadata.getRelativePathFromScmRoot()).isEqualTo(path);
- }
-
- @Test
- public void write_revision_id() throws Exception {
- String revisionId = "some-sha1";
- when(scmRevision.get()).thenReturn(Optional.of(revisionId));
-
- File outputDir = temp.newFolder();
- underTest.publish(new ScannerReportWriter(outputDir));
-
- ScannerReportReader reader = new ScannerReportReader(outputDir);
- ScannerReport.Metadata metadata = reader.readMetadata();
- assertThat(metadata.getScmRevisionId()).isEqualTo(revisionId);
- }
-
- @Test
- public void should_not_crash_when_scm_provider_does_not_support_relativePathFromScmRoot() throws IOException {
- ScmProvider fakeScmProvider = new ScmProvider() {
- @Override
- public String key() {
- return "foo";
- }
- };
- when(scmConfiguration.provider()).thenReturn(fakeScmProvider);
-
- File outputDir = temp.newFolder();
- underTest.publish(new ScannerReportWriter(outputDir));
-
- ScannerReportReader reader = new ScannerReportReader(outputDir);
- ScannerReport.Metadata metadata = reader.readMetadata();
- assertThat(metadata.getRelativePathFromScmRoot()).isEmpty();
- }
- }
|