123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395 |
- /*
- * SonarQube
- * Copyright (C) 2009-2022 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.scan;
-
- import javax.annotation.Nullable;
- import javax.annotation.Priority;
- import org.sonar.api.batch.fs.internal.DefaultInputModule;
- import org.sonar.api.batch.fs.internal.FileMetadata;
- import org.sonar.api.batch.fs.internal.SensorStrategy;
- import org.sonar.api.batch.rule.CheckFactory;
- import org.sonar.api.batch.sensor.issue.internal.DefaultNoSonarFilter;
- import org.sonar.api.resources.ResourceTypes;
- import org.sonar.api.scan.filesystem.PathResolver;
- import org.sonar.api.utils.MessageException;
- import org.sonar.api.utils.log.Logger;
- import org.sonar.api.utils.log.Loggers;
- import org.sonar.core.config.ScannerProperties;
- import org.sonar.core.extension.CoreExtensionsInstaller;
- import org.sonar.core.language.LanguagesProvider;
- import org.sonar.core.metric.ScannerMetrics;
- import org.sonar.core.platform.SpringComponentContainer;
- import org.sonar.scanner.DefaultFileLinesContextFactory;
- import org.sonar.scanner.ProjectInfo;
- import org.sonar.scanner.analysis.AnalysisTempFolderProvider;
- import org.sonar.scanner.bootstrap.ExtensionInstaller;
- import org.sonar.scanner.bootstrap.ExtensionMatcher;
- import org.sonar.scanner.bootstrap.GlobalAnalysisMode;
- import org.sonar.scanner.bootstrap.PostJobExtensionDictionary;
- import org.sonar.scanner.cache.AnalysisCacheEnabled;
- import org.sonar.scanner.cache.DefaultAnalysisCacheLoader;
- import org.sonar.scanner.cache.AnalysisCacheMemoryStorage;
- import org.sonar.scanner.cache.AnalysisCacheProvider;
- import org.sonar.scanner.ci.CiConfigurationProvider;
- import org.sonar.scanner.ci.vendors.AppVeyor;
- import org.sonar.scanner.ci.vendors.AwsCodeBuild;
- import org.sonar.scanner.ci.vendors.AzureDevops;
- import org.sonar.scanner.ci.vendors.Bamboo;
- import org.sonar.scanner.ci.vendors.BitbucketPipelines;
- import org.sonar.scanner.ci.vendors.Bitrise;
- import org.sonar.scanner.ci.vendors.Buildkite;
- import org.sonar.scanner.ci.vendors.CircleCi;
- import org.sonar.scanner.ci.vendors.CirrusCi;
- import org.sonar.scanner.ci.vendors.CodeMagic;
- import org.sonar.scanner.ci.vendors.DroneCi;
- import org.sonar.scanner.ci.vendors.GithubActions;
- import org.sonar.scanner.ci.vendors.GitlabCi;
- import org.sonar.scanner.ci.vendors.Jenkins;
- import org.sonar.scanner.ci.vendors.SemaphoreCi;
- import org.sonar.scanner.ci.vendors.TravisCi;
- import org.sonar.scanner.cpd.CpdExecutor;
- import org.sonar.scanner.cpd.CpdSettings;
- import org.sonar.scanner.cpd.index.SonarCpdBlockIndex;
- import org.sonar.scanner.fs.InputModuleHierarchy;
- import org.sonar.scanner.issue.IssueFilters;
- import org.sonar.scanner.issue.IssuePublisher;
- import org.sonar.scanner.issue.ignore.EnforceIssuesFilter;
- import org.sonar.scanner.issue.ignore.IgnoreIssuesFilter;
- import org.sonar.scanner.issue.ignore.pattern.IssueExclusionPatternInitializer;
- import org.sonar.scanner.issue.ignore.pattern.IssueInclusionPatternInitializer;
- import org.sonar.scanner.issue.ignore.scanner.IssueExclusionsLoader;
- import org.sonar.scanner.mediumtest.AnalysisObservers;
- import org.sonar.scanner.postjob.DefaultPostJobContext;
- import org.sonar.scanner.postjob.PostJobOptimizer;
- import org.sonar.scanner.postjob.PostJobsExecutor;
- import org.sonar.scanner.qualitygate.QualityGateCheck;
- import org.sonar.scanner.report.ActiveRulesPublisher;
- import org.sonar.scanner.report.AnalysisContextReportPublisher;
- import org.sonar.scanner.report.AnalysisWarningsPublisher;
- import org.sonar.scanner.report.CeTaskReportDataHolder;
- import org.sonar.scanner.report.ChangedLinesPublisher;
- import org.sonar.scanner.report.ComponentsPublisher;
- import org.sonar.scanner.report.ContextPropertiesPublisher;
- import org.sonar.scanner.report.MetadataPublisher;
- import org.sonar.scanner.report.AnalysisCachePublisher;
- import org.sonar.scanner.report.ReportPublisher;
- import org.sonar.scanner.report.SourcePublisher;
- import org.sonar.scanner.report.TestExecutionPublisher;
- import org.sonar.scanner.repository.ContextPropertiesCache;
- import org.sonar.scanner.repository.DefaultProjectRepositoriesLoader;
- import org.sonar.scanner.repository.DefaultQualityProfileLoader;
- import org.sonar.scanner.repository.ProjectRepositoriesProvider;
- import org.sonar.scanner.repository.QualityProfilesProvider;
- import org.sonar.scanner.repository.ReferenceBranchSupplier;
- import org.sonar.scanner.repository.language.DefaultLanguagesRepository;
- import org.sonar.scanner.repository.settings.DefaultProjectSettingsLoader;
- import org.sonar.scanner.rule.ActiveRulesProvider;
- import org.sonar.scanner.rule.DefaultActiveRulesLoader;
- import org.sonar.scanner.rule.DefaultRulesLoader;
- import org.sonar.scanner.rule.QProfileVerifier;
- import org.sonar.scanner.rule.RulesProvider;
- import org.sonar.scanner.scan.branch.BranchConfiguration;
- import org.sonar.scanner.scan.branch.BranchConfigurationProvider;
- import org.sonar.scanner.scan.branch.BranchType;
- import org.sonar.scanner.scan.branch.ProjectBranchesProvider;
- import org.sonar.scanner.scan.branch.ProjectPullRequestsProvider;
- import org.sonar.scanner.scan.filesystem.DefaultProjectFileSystem;
- import org.sonar.scanner.scan.filesystem.FileIndexer;
- import org.sonar.scanner.scan.filesystem.InputComponentStore;
- import org.sonar.scanner.scan.filesystem.LanguageDetection;
- import org.sonar.scanner.scan.filesystem.MetadataGenerator;
- import org.sonar.scanner.scan.filesystem.ProjectCoverageAndDuplicationExclusions;
- import org.sonar.scanner.scan.filesystem.ProjectExclusionFilters;
- import org.sonar.scanner.scan.filesystem.ProjectFileIndexer;
- import org.sonar.scanner.scan.filesystem.ScannerComponentIdGenerator;
- import org.sonar.scanner.scan.filesystem.StatusDetection;
- import org.sonar.scanner.scan.measure.DefaultMetricFinder;
- import org.sonar.scanner.scm.ScmChangedFilesProvider;
- import org.sonar.scanner.scm.ScmConfiguration;
- import org.sonar.scanner.scm.ScmPublisher;
- import org.sonar.scanner.scm.ScmRevisionImpl;
- import org.sonar.scanner.sensor.DefaultSensorStorage;
- import org.sonar.scanner.sensor.ProjectSensorContext;
- import org.sonar.scanner.sensor.ProjectSensorExtensionDictionary;
- import org.sonar.scanner.sensor.ProjectSensorOptimizer;
- import org.sonar.scanner.sensor.ProjectSensorsExecutor;
- import org.sonar.scm.git.GitScmSupport;
- import org.sonar.scm.svn.SvnScmSupport;
-
- import static org.sonar.api.batch.InstantiationStrategy.PER_BATCH;
- import static org.sonar.api.utils.Preconditions.checkNotNull;
- import static org.sonar.core.extension.CoreExtensionsInstaller.noExtensionFilter;
- import static org.sonar.scanner.bootstrap.ExtensionUtils.isDeprecatedScannerSide;
- import static org.sonar.scanner.bootstrap.ExtensionUtils.isInstantiationStrategy;
- import static org.sonar.scanner.bootstrap.ExtensionUtils.isScannerSide;
-
- @Priority(2)
- public class SpringProjectScanContainer extends SpringComponentContainer {
- private static final Logger LOG = Loggers.get(SpringProjectScanContainer.class);
-
- public SpringProjectScanContainer(SpringComponentContainer globalContainer) {
- super(globalContainer);
- }
-
- @Override
- protected void doBeforeStart() {
- addScannerExtensions();
- addScannerComponents();
- }
-
- private void addScannerComponents() {
- add(
- ScanProperties.class,
- ProjectReactorBuilder.class,
- WorkDirectoriesInitializer.class,
- new MutableProjectReactorProvider(),
- ProjectBuildersExecutor.class,
- ProjectLock.class,
- ResourceTypes.class,
- ProjectReactorValidator.class,
- ProjectInfo.class,
- new RulesProvider(),
- new BranchConfigurationProvider(),
- new ProjectBranchesProvider(),
- new ProjectPullRequestsProvider(),
- ProjectRepositoriesProvider.class,
- new ProjectServerSettingsProvider(),
- AnalysisCacheEnabled.class,
-
- // temp
- new AnalysisTempFolderProvider(),
-
- // file system
- ModuleIndexer.class,
- InputComponentStore.class,
- PathResolver.class,
- new InputProjectProvider(),
- new InputModuleHierarchyProvider(),
- ScannerComponentIdGenerator.class,
- new ScmChangedFilesProvider(),
- StatusDetection.class,
- LanguageDetection.class,
- MetadataGenerator.class,
- FileMetadata.class,
- FileIndexer.class,
- ProjectFileIndexer.class,
- ProjectExclusionFilters.class,
-
- // rules
- new ActiveRulesProvider(),
- new QualityProfilesProvider(),
- CheckFactory.class,
- QProfileVerifier.class,
-
- // issues
- DefaultNoSonarFilter.class,
- IssueFilters.class,
- IssuePublisher.class,
-
- // metrics
- DefaultMetricFinder.class,
-
- // lang
- LanguagesProvider.class,
- DefaultLanguagesRepository.class,
-
- // issue exclusions
- IssueInclusionPatternInitializer.class,
- IssueExclusionPatternInitializer.class,
- IssueExclusionsLoader.class,
- EnforceIssuesFilter.class,
- IgnoreIssuesFilter.class,
-
- // context
- ContextPropertiesCache.class,
- ContextPropertiesPublisher.class,
-
- SensorStrategy.class,
-
- MutableProjectSettings.class,
- ScannerProperties.class,
- new ProjectConfigurationProvider(),
-
- ProjectCoverageAndDuplicationExclusions.class,
-
- // Plugin cache
- AnalysisCacheProvider.class,
- AnalysisCacheMemoryStorage.class,
- DefaultAnalysisCacheLoader.class,
-
- // Report
- ReferenceBranchSupplier.class,
- ScannerMetrics.class,
- ReportPublisher.class,
- AnalysisContextReportPublisher.class,
- MetadataPublisher.class,
- ActiveRulesPublisher.class,
- AnalysisWarningsPublisher.class,
- ComponentsPublisher.class,
- AnalysisCachePublisher.class,
- TestExecutionPublisher.class,
- SourcePublisher.class,
- ChangedLinesPublisher.class,
-
- CeTaskReportDataHolder.class,
-
- // QualityGate check
- QualityGateCheck.class,
-
- // Cpd
- CpdExecutor.class,
- CpdSettings.class,
- SonarCpdBlockIndex.class,
-
- // PostJobs
- PostJobsExecutor.class,
- PostJobOptimizer.class,
- DefaultPostJobContext.class,
- PostJobExtensionDictionary.class,
-
- // SCM
- ScmConfiguration.class,
- ScmPublisher.class,
- ScmRevisionImpl.class,
-
- // Sensors
- DefaultSensorStorage.class,
- DefaultFileLinesContextFactory.class,
- ProjectSensorContext.class,
- ProjectSensorOptimizer.class,
- ProjectSensorsExecutor.class,
- ProjectSensorExtensionDictionary.class,
-
- // Filesystem
- DefaultProjectFileSystem.class,
-
- // CI
- new CiConfigurationProvider(),
- AppVeyor.class,
- AwsCodeBuild.class,
- AzureDevops.class,
- Bamboo.class,
- BitbucketPipelines.class,
- Bitrise.class,
- Buildkite.class,
- CircleCi.class,
- CirrusCi.class,
- DroneCi.class,
- GithubActions.class,
- CodeMagic.class,
- GitlabCi.class,
- Jenkins.class,
- SemaphoreCi.class,
- TravisCi.class,
-
- AnalysisObservers.class);
-
- add(GitScmSupport.getObjects());
- add(SvnScmSupport.getObjects());
-
- add(DefaultProjectSettingsLoader.class,
- DefaultRulesLoader.class,
- DefaultActiveRulesLoader.class,
- DefaultQualityProfileLoader.class,
- DefaultProjectRepositoriesLoader.class);
- }
-
- private void addScannerExtensions() {
- checkNotNull(getParent());
- getParent().getComponentByType(CoreExtensionsInstaller.class)
- .install(this, noExtensionFilter(), extension -> getScannerProjectExtensionsFilter().accept(extension));
- getParent().getComponentByType(ExtensionInstaller.class)
- .install(this, getScannerProjectExtensionsFilter());
- }
-
- static ExtensionMatcher getScannerProjectExtensionsFilter() {
- return extension -> {
- if (isDeprecatedScannerSide(extension)) {
- return isInstantiationStrategy(extension, PER_BATCH);
- }
- return isScannerSide(extension);
- };
- }
-
- @Override
- protected void doAfterStart() {
- getComponentByType(ProjectLock.class).tryLock();
- GlobalAnalysisMode analysisMode = getComponentByType(GlobalAnalysisMode.class);
- InputModuleHierarchy tree = getComponentByType(InputModuleHierarchy.class);
- ScanProperties properties = getComponentByType(ScanProperties.class);
- properties.validate();
-
- properties.get("sonar.branch").ifPresent(deprecatedBranch -> {
- throw MessageException.of("The 'sonar.branch' parameter is no longer supported. You should stop using it. " +
- "Branch analysis is available in Developer Edition and above. See https://redirect.sonarsource.com/editions/developer.html for more information.");
- });
-
- BranchConfiguration branchConfig = getComponentByType(BranchConfiguration.class);
- if (branchConfig.branchType() == BranchType.PULL_REQUEST) {
- LOG.info("Pull request {} for merge into {} from {}", branchConfig.pullRequestKey(), pullRequestBaseToDisplayName(branchConfig.targetBranchName()),
- branchConfig.branchName());
- } else if (branchConfig.branchName() != null) {
- LOG.info("Branch name: {}", branchConfig.branchName());
- }
-
- getComponentByType(ProjectFileIndexer.class).index();
-
- // Log detected languages and their profiles after FS is indexed and languages detected
- getComponentByType(QProfileVerifier.class).execute();
-
- scanRecursively(tree, tree.root());
-
- LOG.info("------------- Run sensors on project");
- getComponentByType(ProjectSensorsExecutor.class).execute();
-
- getComponentByType(ScmPublisher.class).publish();
-
- getComponentByType(CpdExecutor.class).execute();
- getComponentByType(ReportPublisher.class).execute();
-
- if (properties.shouldWaitForQualityGate()) {
- LOG.info("------------- Check Quality Gate status");
- getComponentByType(QualityGateCheck.class).await();
- }
-
- getComponentByType(PostJobsExecutor.class).execute();
-
- if (analysisMode.isMediumTest()) {
- getComponentByType(AnalysisObservers.class).notifyEndOfScanTask();
- }
- }
-
- private static String pullRequestBaseToDisplayName(@Nullable String pullRequestBase) {
- return pullRequestBase != null ? pullRequestBase : "default branch";
- }
-
- private void scanRecursively(InputModuleHierarchy tree, DefaultInputModule module) {
- for (DefaultInputModule child : tree.children(module)) {
- scanRecursively(tree, child);
- }
- LOG.info("------------- Run sensors on module {}", module.definition().getName());
- scan(module);
- }
-
- void scan(DefaultInputModule module) {
- new SpringModuleScanContainer(this, module).execute();
- }
-
- }
|