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

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2021 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.ce.task.projectanalysis.measure;
  21
  22 import org.sonar.api.ExtensionPoint;
  23 import org.sonar.api.ce.ComputeEngineSide;
  24 import org.sonar.ce.task.projectanalysis.analysis.AnalysisMetadataHolder;
  25
  26 /**
  27  * Extension point that is called during processing of a task
  28  * by {@link PostMeasuresComputationChecksStep}.
  29  *
  30  * It is stateless, the same instance is reused for all tasks.
  31  * As a consequence Compute Engine task components can't be injected
  32  * as dependencies.
  33  */
  34 @ComputeEngineSide
  35 @ExtensionPoint
  36 public interface PostMeasuresComputationCheck {
  37
  38   /**
  39    * This method can make the task fail by throwing a {@link RuntimeException}
  40    */
  41   void onCheck(Context context);
  42
  43   interface Context {
  44
  45     /**
  46      * Return the project UUID, as returned by {@link AnalysisMetadataHolder#getProject()#getUuid()}.
  47      *
  48      * It means that when analyzing a non main-branch, it will be the UUID of the project, not the UUId of the branch/pull-request.
  49      */
  50     String getProjectUuid();
  51
  52     /**
  53      * Return the ncloc computed for the current analysis
  54      */
  55     int getNcloc();
  56
  57   }
  58 }