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

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2017 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.server.computation.task.projectanalysis.component;
  21
  22 import java.util.Optional;
  23 import javax.annotation.Nullable;
  24 import org.sonar.api.utils.MessageException;
  25 import org.sonar.core.component.ComponentKeys;
  26 import org.sonar.db.component.BranchType;
  27 import org.sonar.scanner.protocol.output.ScannerReport;
  28 import org.sonar.server.computation.task.projectanalysis.analysis.Branch;
  29
  30 import static java.lang.String.format;
  31 import static org.apache.commons.lang.StringUtils.isEmpty;
  32 import static org.apache.commons.lang.StringUtils.trimToNull;
  33
  34 /**
  35  * The default (and legacy) implementation of {@link Branch}. It is used
  36  * when scanner is configured with parameter "sonar.branch" or when no branch is provided and the branch plugin is not installed.
  37  * A legacy branch is implemented as a fork of the project, so any branch
  38  * is considered as "main".
  39  */
  40 public class DefaultBranchImpl implements Branch {
  41
  42   @Nullable
  43   private final String branchName;
  44
  45   public DefaultBranchImpl() {
  46     this(null);
  47   }
  48
  49   public DefaultBranchImpl(@Nullable String name) {
  50     this.branchName = name;
  51     if (name != null && !ComponentKeys.isValidBranch(name)) {
  52       throw MessageException.of(format("\"%s\" is not a valid branch name. "
  53         + "Allowed characters are alphanumeric, '-', '_', '.' and '/'.", name));
  54     }
  55   }
  56
  57   @Override
  58   public BranchType getType() {
  59     return BranchType.LONG;
  60   }
  61
  62   @Override
  63   public boolean isMain() {
  64     return true;
  65   }
  66
  67   @Override
  68   public Optional<String> getMergeBranchUuid() {
  69     return Optional.empty();
  70   }
  71
  72   @Override
  73   public boolean isLegacyFeature() {
  74     return true;
  75   }
  76
  77   @Override
  78   public Optional<String> getName() {
  79     return Optional.ofNullable(branchName);
  80   }
  81
  82   @Override
  83   public boolean supportsCrossProjectCpd() {
  84     // only on regular project, not on branches
  85     return branchName == null;
  86   }
  87
  88   @Override
  89   public String generateKey(ScannerReport.Component module, @Nullable ScannerReport.Component fileOrDir) {
  90     String moduleWithBranch =  ComponentKeys.createKey(module.getKey(), branchName);
  91     if (fileOrDir == null || isEmpty(fileOrDir.getPath())) {
  92       return moduleWithBranch;
  93     }
  94     return ComponentKeys.createEffectiveKey(moduleWithBranch, trimToNull(fileOrDir.getPath()));
  95   }
  96 }