sonarqube/server/sonar-server/src/main/java/org/sonar/server/computation/step/ValidateProjectStep.java

/*
 * SonarQube, open source software quality management tool.
 * Copyright (C) 2008-2014 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * SonarQube 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.
 *
 * SonarQube 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.server.computation.step;

import com.google.common.base.Function;
import com.google.common.base.Joiner;
import com.google.common.collect.FluentIterable;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Map;
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import org.sonar.api.CoreProperties;
import org.sonar.api.config.Settings;
import org.sonar.api.utils.MessageException;
import org.sonar.batch.protocol.output.BatchReport;
import org.sonar.db.component.ComponentDto;
import org.sonar.core.component.ComponentKeys;
import org.sonar.db.component.SnapshotDto;
import org.sonar.db.DbSession;
import org.sonar.server.component.db.ComponentDao;
import org.sonar.server.computation.batch.BatchReportReader;
import org.sonar.server.computation.component.Component;
import org.sonar.server.computation.component.DepthTraversalTypeAwareVisitor;
import org.sonar.server.computation.component.TreeRootHolder;
import org.sonar.server.db.DbClient;

import static org.sonar.api.utils.DateUtils.formatDateTime;

/**
 * Validate project and modules. It will fail in the following cases :
 * <ol>
 * <li>property {@link org.sonar.api.CoreProperties#CORE_PREVENT_AUTOMATIC_PROJECT_CREATION} is set to true and project does not exists</li>
 * <li>branch is not valid</li>
 * <li>project or module key is not valid</li>
 * <li>module key already exists in another project (same module key cannot exists in different projects)</li>
 * <li>module key is already used as a project key</li>
 * <li>date of the analysis is before last analysis</li>
 * </ol>
 */
public class ValidateProjectStep implements ComputationStep {

  private static final Joiner MESSAGES_JOINER = Joiner.on("\n  o ");

  private final DbClient dbClient;
  private final Settings settings;
  private final BatchReportReader reportReader;
  private final TreeRootHolder treeRootHolder;

  public ValidateProjectStep(DbClient dbClient, Settings settings, BatchReportReader reportReader, TreeRootHolder treeRootHolder) {
    this.dbClient = dbClient;
    this.settings = settings;
    this.reportReader = reportReader;
    this.treeRootHolder = treeRootHolder;
  }

  @Override
  public void execute() {
    DbSession session = dbClient.openSession(false);
    try {
      List<ComponentDto> baseModules = dbClient.componentDao().selectModulesFromProjectKey(session, treeRootHolder.getRoot().getKey());
      Map<String, ComponentDto> baseModulesByKey = FluentIterable.from(baseModules).uniqueIndex(ComponentDtoToKey.INSTANCE);
      ValidateProjectsVisitor visitor = new ValidateProjectsVisitor(session, dbClient.componentDao(),
        settings.getBoolean(CoreProperties.CORE_PREVENT_AUTOMATIC_PROJECT_CREATION), baseModulesByKey);
      visitor.visit(treeRootHolder.getRoot());

      if (!visitor.validationMessages.isEmpty()) {
        throw MessageException.of("Validation of project failed:\n  o " + MESSAGES_JOINER.join(visitor.validationMessages));
      }
    } finally {
      session.close();
    }
  }

  @Override
  public String getDescription() {
    return "Validate project and modules keys";
  }

  private class ValidateProjectsVisitor extends DepthTraversalTypeAwareVisitor {
    private final DbSession session;
    private final ComponentDao componentDao;
    private final boolean preventAutomaticProjectCreation;
    private final Map<String, ComponentDto> baseModulesByKey;
    private final List<String> validationMessages = new ArrayList<>();

    private Component rawProject;

    public ValidateProjectsVisitor(DbSession session, ComponentDao componentDao, boolean preventAutomaticProjectCreation, Map<String, ComponentDto> baseModulesByKey) {
      super(Component.Type.MODULE, Order.PRE_ORDER);
      this.session = session;
      this.componentDao = componentDao;

      this.preventAutomaticProjectCreation = preventAutomaticProjectCreation;
      this.baseModulesByKey = baseModulesByKey;
    }

    @Override
    public void visitProject(Component rawProject) {
      this.rawProject = rawProject;
      validateBranch();
      validateBatchKey(rawProject);

      String rawProjectKey = rawProject.getKey();
      ComponentDto baseProject = loadBaseComponent(rawProjectKey);
      validateWhenProvisioningEnforced(baseProject, rawProjectKey);
      validateProjectKey(baseProject, rawProjectKey);
      validateAnalysisDate(baseProject);
    }

    private void validateWhenProvisioningEnforced(@Nullable ComponentDto baseProject, String rawProjectKey) {
      if (baseProject == null && preventAutomaticProjectCreation) {
        validationMessages.add(String.format("Unable to scan non-existing project '%s'", rawProjectKey));
      }
    }

    private void validateProjectKey(@Nullable ComponentDto baseProject, String rawProjectKey) {
      if (baseProject != null && !baseProject.projectUuid().equals(baseProject.uuid())) {
        // Project key is already used as a module of another project
        ComponentDto anotherBaseProject = componentDao.selectByUuid(session, baseProject.projectUuid());
        validationMessages.add(String.format("The project \"%s\" is already defined in SonarQube but as a module of project \"%s\". "
          + "If you really want to stop directly analysing project \"%s\", please first delete it from SonarQube and then relaunch the analysis of project \"%s\".",
          rawProjectKey, anotherBaseProject.key(), anotherBaseProject.key(), rawProjectKey));
      }
    }

    private void validateAnalysisDate(@Nullable ComponentDto baseProject) {
      if (baseProject != null) {
        SnapshotDto snapshotDto = dbClient.snapshotDao().selectLastSnapshotByComponentId(session, baseProject.getId());
        long currentAnalysisDate = reportReader.readMetadata().getAnalysisDate();
        Long lastAnalysisDate = snapshotDto != null ? snapshotDto.getCreatedAt() : null;
        if (lastAnalysisDate != null && currentAnalysisDate <= snapshotDto.getCreatedAt()) {
          validationMessages.add(String.format("Date of analysis cannot be older than the date of the last known analysis on this project. Value: \"%s\". " +
            "Latest analysis: \"%s\". It's only possible to rebuild the past in a chronological order.",
            formatDateTime(new Date(currentAnalysisDate)), formatDateTime(new Date(lastAnalysisDate))));
        }
      }
    }

    @Override
    public void visitModule(Component rawModule) {
      String rawProjectKey = rawProject.getKey();
      String rawModuleKey = rawModule.getKey();
      validateBatchKey(rawModule);

      ComponentDto baseModule = loadBaseComponent(rawModuleKey);
      if (baseModule == null) {
        return;
      }

      validateModuleIsNotAlreadyUsedAsProject(baseModule, rawProjectKey, rawModuleKey);
      validateModuleKeyIsNotAlreadyUsedInAnotherProject(baseModule, rawModuleKey);
    }

    private void validateModuleIsNotAlreadyUsedAsProject(ComponentDto baseModule, String rawProjectKey, String rawModuleKey) {
      if (baseModule.projectUuid().equals(baseModule.uuid())) {
        // module is actually a project
        validationMessages.add(String.format("The project \"%s\" is already defined in SonarQube but not as a module of project \"%s\". "
          + "If you really want to stop directly analysing project \"%s\", please first delete it from SonarQube and then relaunch the analysis of project \"%s\".",
          rawModuleKey, rawProjectKey, rawModuleKey, rawProjectKey));
      }
    }

    private void validateModuleKeyIsNotAlreadyUsedInAnotherProject(ComponentDto baseModule, String rawModuleKey) {
      if (!baseModule.projectUuid().equals(baseModule.uuid()) && !baseModule.projectUuid().equals(rawProject.getUuid())) {
        ComponentDto projectModule = componentDao.selectByUuid(session, baseModule.projectUuid());
        validationMessages.add(String.format("Module \"%s\" is already part of project \"%s\"", rawModuleKey, projectModule.key()));
      }
    }

    private void validateBatchKey(Component rawComponent) {
      String batchKey = reportReader.readComponent(rawComponent.getRef()).getKey();
      if (!ComponentKeys.isValidModuleKey(batchKey)) {
        validationMessages.add(String.format("\"%s\" is not a valid project or module key. "
          + "Allowed characters are alphanumeric, '-', '_', '.' and ':', with at least one non-digit.", batchKey));
      }
    }

    @CheckForNull
    private void validateBranch() {
      BatchReport.Metadata metadata = reportReader.readMetadata();
      if (!metadata.hasBranch()) {
        return;
      }
      String branch = metadata.getBranch();
      if (!ComponentKeys.isValidBranch(branch)) {
        validationMessages.add(String.format("\"%s\" is not a valid branch name. "
          + "Allowed characters are alphanumeric, '-', '_', '.' and '/'.", branch));
      }
    }

    private ComponentDto loadBaseComponent(String rawComponentKey) {
      ComponentDto baseComponent = baseModulesByKey.get(rawComponentKey);
      if (baseComponent == null) {
        // Load component from key to be able to detect issue (try to analyze a module, etc.)
        return componentDao.selectNullableByKey(session, rawComponentKey);
      }
      return baseComponent;
    }
  }

  private enum ComponentDtoToKey implements Function<ComponentDto, String> {
    INSTANCE;

    @Override
    public String apply(@Nonnull ComponentDto input) {
      return input.key();
    }
  }
}