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

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2019 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 package org.sonar.scanner.scan.filesystem;
  21
  22 import java.io.File;
  23 import java.nio.charset.Charset;
  24 import java.nio.file.Path;
  25 import java.util.ArrayList;
  26 import java.util.Iterator;
  27 import java.util.List;
  28 import java.util.Locale;
  29 import java.util.Optional;
  30 import javax.annotation.Nullable;
  31 import javax.annotation.concurrent.Immutable;
  32 import org.apache.commons.lang.StringUtils;
  33 import org.sonar.api.CoreProperties;
  34 import org.sonar.api.batch.ScannerSide;
  35 import org.sonar.api.batch.bootstrap.ProjectDefinition;
  36 import org.sonar.api.batch.fs.InputModule;
  37 import org.sonar.api.batch.fs.internal.AbstractProjectOrModule;
  38 import org.sonar.api.scan.filesystem.PathResolver;
  39 import org.sonar.api.utils.log.Logger;
  40 import org.sonar.api.utils.log.Loggers;
  41
  42 import static org.sonar.core.config.MultivalueProperty.parseAsCsv;
  43
  44 @ScannerSide
  45 @Immutable
  46 public class ModuleFileSystemInitializer {
  47
  48   private static final Logger LOG = Loggers.get(ModuleFileSystemInitializer.class);
  49
  50   private final List<Path> sourceDirsOrFiles;
  51   private final List<Path> testDirsOrFiles;
  52   private final Charset encoding;
  53
  54   public ModuleFileSystemInitializer(InputModule inputModule) {
  55     AbstractProjectOrModule inputModuleCasted = (AbstractProjectOrModule) inputModule;
  56     logDir("Base dir: ", inputModuleCasted.getBaseDir());
  57     logDir("Working dir: ", inputModuleCasted.getWorkDir());
  58     sourceDirsOrFiles = initSources(inputModuleCasted, ProjectDefinition.SOURCES_PROPERTY, "Source paths: ");
  59     testDirsOrFiles = initSources(inputModuleCasted, ProjectDefinition.TESTS_PROPERTY, "Test paths: ");
  60     encoding = initEncoding(inputModuleCasted);
  61   }
  62
  63   private static List<Path> initSources(AbstractProjectOrModule module, String propertyKey, String logLabel) {
  64     List<Path> result = new ArrayList<>();
  65     PathResolver pathResolver = new PathResolver();
  66     String srcPropValue = module.properties().get(propertyKey);
  67     if (srcPropValue != null) {
  68       for (String sourcePath : parseAsCsv(propertyKey, srcPropValue)) {
  69         File dirOrFile = pathResolver.relativeFile(module.getBaseDir().toFile(), sourcePath);
  70         if (dirOrFile.exists()) {
  71           result.add(dirOrFile.toPath());
  72         }
  73       }
  74     }
  75     logPaths(logLabel, module.getBaseDir(), result);
  76     return result;
  77   }
  78
  79   private static Charset initEncoding(AbstractProjectOrModule module) {
  80     String encodingStr = module.properties().get(CoreProperties.ENCODING_PROPERTY);
  81     Charset result;
  82     if (StringUtils.isNotEmpty(encodingStr)) {
  83       result = Charset.forName(StringUtils.trim(encodingStr));
  84       LOG.info("Source encoding: {}, default locale: {}", result.displayName(), Locale.getDefault());
  85     } else {
  86       result = Charset.defaultCharset();
  87       LOG.warn("Source encoding is platform dependent ({}), default locale: {}", result.displayName(), Locale.getDefault());
  88     }
  89     return result;
  90   }
  91
  92   List<Path> sources() {
  93     return sourceDirsOrFiles;
  94   }
  95
  96   List<Path> tests() {
  97     return testDirsOrFiles;
  98   }
  99
 100   public Charset defaultEncoding() {
 101     return encoding;
 102   }
 103
 104   private static void logPaths(String label, Path baseDir, List<Path> paths) {
 105     if (!paths.isEmpty()) {
 106       StringBuilder sb = new StringBuilder(label);
 107       for (Iterator<Path> it = paths.iterator(); it.hasNext(); ) {
 108         Path file = it.next();
 109         Optional<String> relativePathToBaseDir = PathResolver.relativize(baseDir, file);
 110         if (!relativePathToBaseDir.isPresent()) {
 111           sb.append(file);
 112         } else if (StringUtils.isBlank(relativePathToBaseDir.get())) {
 113           sb.append(".");
 114         } else {
 115           sb.append(relativePathToBaseDir.get());
 116         }
 117         if (it.hasNext()) {
 118           sb.append(", ");
 119         }
 120       }
 121       LOG.info(sb.toString());
 122     }
 123   }
 124
 125   private static void logDir(String label, @Nullable Path dir) {
 126     if (dir != null) {
 127       LOG.info(label + dir.toAbsolutePath().toString());
 128     }
 129   }
 130
 131 }