org.sonar.scanner.scan.InputModuleHierarchyProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-scanner-engine Show documentation
Open source platform for continuous inspection of code quality
There is a newer version: 24.12.0.100206
/*
 * SonarQube
 * Copyright (C) 2009-2024 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 java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import org.sonar.api.batch.bootstrap.ProjectDefinition;
import org.sonar.api.batch.fs.internal.DefaultInputModule;
import org.sonar.api.batch.fs.internal.DefaultInputProject;
import org.sonar.api.utils.log.Logger;
import org.sonar.api.utils.log.Loggers;
import org.sonar.scanner.scan.filesystem.ScannerComponentIdGenerator;
import org.springframework.context.annotation.Bean;

public class InputModuleHierarchyProvider {

  private static final Logger LOG = Loggers.get(InputModuleHierarchyProvider.class);

  @Bean("DefaultInputModuleHierarchy")
  public DefaultInputModuleHierarchy provide(ScannerComponentIdGenerator scannerComponentIdGenerator, WorkDirectoriesInitializer workDirectoriesInit, DefaultInputProject project) {
    LOG.debug("Creating module hierarchy");
    DefaultInputModule root = createModule(project.definition(), project.scannerId());
    Map parents = createChildren(root, scannerComponentIdGenerator, new HashMap<>());
    DefaultInputModuleHierarchy inputModuleHierarchy;
    if (parents.isEmpty()) {
      inputModuleHierarchy = new DefaultInputModuleHierarchy(root);
    } else {
      inputModuleHierarchy = new DefaultInputModuleHierarchy(root, parents);
    }
    workDirectoriesInit.execute(inputModuleHierarchy);
    return inputModuleHierarchy;
  }

  private static Map createChildren(DefaultInputModule parent, ScannerComponentIdGenerator scannerComponentIdGenerator,
    Map parents) {
    for (ProjectDefinition def : parent.definition().getSubProjects()) {
      DefaultInputModule child = createModule(def, scannerComponentIdGenerator.getAsInt());
      parents.put(child, parent);
      createChildren(child, scannerComponentIdGenerator, parents);
    }
    return parents;
  }

  private static DefaultInputModule createModule(ProjectDefinition def, int scannerComponentId) {
    LOG.debug("  Init module '{}'", def.getName());
    DefaultInputModule module = new DefaultInputModule(def, scannerComponentId);
    LOG.debug("    Base dir: {}", module.getBaseDir().toAbsolutePath().toString());
    LOG.debug("    Working dir: {}", module.getWorkDir().toAbsolutePath().toString());
    LOG.debug("    Module global encoding: {}, default locale: {}", module.getEncoding().displayName(), Locale.getDefault());
    return module;
  }

}