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.function.Function;
  23 import javax.annotation.CheckForNull;
  24 import javax.annotation.Nullable;
  25 import org.sonar.db.component.SnapshotDto;
  26 import org.sonar.scanner.protocol.output.ScannerReport;
  27 import org.sonar.scanner.protocol.output.ScannerReport.Component.FileStatus;
  28 import org.sonar.server.computation.task.projectanalysis.analysis.Project;
  29
  30 import static com.google.common.base.MoreObjects.firstNonNull;
  31 import static com.google.common.base.Preconditions.checkArgument;
  32 import static java.lang.String.format;
  33 import static org.apache.commons.lang.StringUtils.trimToNull;
  34
  35 public class ComponentTreeBuilder {
  36
  37   private static final String DEFAULT_PROJECT_VERSION = "not provided";
  38
  39   private final ComponentKeyGenerator keyGenerator;
  40   private final ComponentKeyGenerator publicKeyGenerator;
  41   /**
  42    * Will supply the UUID for any component in the tree, given it's key.
  43    * <p>
  44    * The String argument of the {@link Function#apply(Object)} method is the component's key.
  45    * </p>
  46    */
  47   private final Function<String, String> uuidSupplier;
  48
  49   /**
  50    * Will supply the {@link ScannerReport.Component} of all the components in the component tree as we crawl it from the
  51    * root.
  52    * <p>
  53    * The Integer argument of the {@link Function#apply(Object)} method is the component's ref.
  54    * </p>
  55    */
  56   private final Function<Integer, ScannerReport.Component> scannerComponentSupplier;
  57
  58   private final Project project;
  59
  60   @Nullable
  61   private final SnapshotDto baseAnalysis;
  62
  63   public ComponentTreeBuilder(
  64     ComponentKeyGenerator keyGenerator,
  65     ComponentKeyGenerator publicKeyGenerator,
  66     Function<String, String> uuidSupplier,
  67     Function<Integer, ScannerReport.Component> scannerComponentSupplier,
  68     Project project,
  69     @Nullable SnapshotDto baseAnalysis) {
  70
  71     this.keyGenerator = keyGenerator;
  72     this.publicKeyGenerator = publicKeyGenerator;
  73     this.uuidSupplier = uuidSupplier;
  74     this.scannerComponentSupplier = scannerComponentSupplier;
  75     this.project = project;
  76     this.baseAnalysis = baseAnalysis;
  77   }
  78
  79   public Component buildProject(ScannerReport.Component project) {
  80     return buildComponent(project, project);
  81   }
  82
  83   private Component[] buildChildren(ScannerReport.Component component, ScannerReport.Component parentModule) {
  84     return component.getChildRefList()
  85       .stream()
  86       .map(scannerComponentSupplier::apply)
  87       .map(c -> buildComponent(c, parentModule))
  88       .toArray(Component[]::new);
  89   }
  90
  91   private ComponentImpl buildComponent(ScannerReport.Component component, ScannerReport.Component closestModule) {
  92     switch (component.getType()) {
  93       case PROJECT:
  94         String projectKey = keyGenerator.generateKey(component, null);
  95         String uuid = uuidSupplier.apply(projectKey);
  96         return ComponentImpl.builder(Component.Type.PROJECT)
  97           .setUuid(uuid)
  98           .setKey(projectKey)
  99           .setPublicKey(publicKeyGenerator.generateKey(component, null))
 100           .setName(nameOfProject(component))
 101           .setStatus(convertStatus(component.getStatus()))
 102           .setDescription(trimToNull(component.getDescription()))
 103           .setReportAttributes(createAttributesBuilder(component)
 104             .setVersion(createProjectVersion(component))
 105             .build())
 106           .addChildren(buildChildren(component, component))
 107           .build();
 108
 109       case MODULE:
 110         String moduleKey = keyGenerator.generateKey(component, null);
 111         return ComponentImpl.builder(Component.Type.MODULE)
 112           .setUuid(uuidSupplier.apply(moduleKey))
 113           .setKey(moduleKey)
 114           .setPublicKey(publicKeyGenerator.generateKey(component, null))
 115           .setName(nameOfOthers(component, moduleKey))
 116           .setStatus(convertStatus(component.getStatus()))
 117           .setDescription(trimToNull(component.getDescription()))
 118           .setReportAttributes(createAttributesBuilder(component).build())
 119           .addChildren(buildChildren(component, component))
 120           .build();
 121
 122       case DIRECTORY:
 123       case FILE:
 124         String key = keyGenerator.generateKey(closestModule, component);
 125         return ComponentImpl.builder(convertDirOrFileType(component.getType()))
 126           .setUuid(uuidSupplier.apply(key))
 127           .setKey(key)
 128           .setPublicKey(publicKeyGenerator.generateKey(closestModule, component))
 129           .setName(nameOfOthers(component, key))
 130           .setStatus(convertStatus(component.getStatus()))
 131           .setDescription(trimToNull(component.getDescription()))
 132           .setReportAttributes(createAttributesBuilder(component).build())
 133           .setFileAttributes(createFileAttributes(component))
 134           .addChildren(buildChildren(component, closestModule))
 135           .build();
 136
 137       default:
 138         throw new IllegalArgumentException(format("Unsupported component type '%s'", component.getType()));
 139     }
 140   }
 141
 142   private static Component.Status convertStatus(FileStatus status) {
 143     switch(status) {
 144       case ADDED:
 145         return Component.Status.ADDED;
 146       case SAME:
 147         return Component.Status.SAME;
 148       case CHANGED:
 149         return Component.Status.CHANGED;
 150       case UNAVAILABLE:
 151         return Component.Status.UNAVAILABLE;
 152       case UNRECOGNIZED:
 153       default:
 154         throw new IllegalArgumentException("Unsupported ComponentType value " + status);
 155     }
 156   }
 157
 158   private String nameOfProject(ScannerReport.Component component) {
 159     String name = trimToNull(component.getName());
 160     if (name != null) {
 161       return name;
 162     }
 163     return project.getName();
 164   }
 165
 166   private static String nameOfOthers(ScannerReport.Component reportComponent, String defaultName) {
 167     String name = trimToNull(reportComponent.getName());
 168     return name == null ? defaultName : name;
 169   }
 170
 171   private String createProjectVersion(ScannerReport.Component component) {
 172     String version = trimToNull(component.getVersion());
 173     if (version != null) {
 174       return version;
 175     }
 176     if (baseAnalysis != null) {
 177       return firstNonNull(baseAnalysis.getVersion(), DEFAULT_PROJECT_VERSION);
 178     }
 179     return DEFAULT_PROJECT_VERSION;
 180   }
 181
 182   private static ReportAttributes.Builder createAttributesBuilder(ScannerReport.Component component) {
 183     return ReportAttributes.newBuilder(component.getRef())
 184       .setVersion(trimToNull(component.getVersion()))
 185       .setPath(trimToNull(component.getPath()));
 186   }
 187
 188   @CheckForNull
 189   private static FileAttributes createFileAttributes(ScannerReport.Component component) {
 190     if (component.getType() != ScannerReport.Component.ComponentType.FILE) {
 191       return null;
 192     }
 193
 194     checkArgument(component.getLines() > 0, "File '%s' has no line", component.getPath());
 195     return new FileAttributes(
 196       component.getIsTest(),
 197       trimToNull(component.getLanguage()),
 198       component.getLines());
 199   }
 200
 201   private static Component.Type convertDirOrFileType(ScannerReport.Component.ComponentType type) {
 202     switch (type) {
 203       case DIRECTORY:
 204         return Component.Type.DIRECTORY;
 205       case FILE:
 206         return Component.Type.FILE;
 207       default:
 208         throw new IllegalArgumentException("Unsupported ComponentType value " + type);
 209     }
 210   }
 211 }