aboutsummaryrefslogtreecommitdiffstats
path: root/sonar-scanner-engine/src/main/java/org/sonar/scanner/bootstrap/GlobalAnalysisMode.java
blob: 26aced1fb60216620f68d1967cb40b059fe4172c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
/*
 * SonarQube
 * Copyright (C) 2009-2019 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program 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.
 *
 * This program 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.scanner.bootstrap;

import java.util.Arrays;
import javax.annotation.concurrent.Immutable;
import org.apache.commons.lang.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sonar.api.CoreProperties;

@Immutable
public class GlobalAnalysisMode {
  public static final String MEDIUM_TEST_ENABLED = "sonar.mediumTest.enabled";
  private static final Logger LOG = LoggerFactory.getLogger(GlobalAnalysisMode.class);
  private static final String[] VALID_MODES = {CoreProperties.ANALYSIS_MODE_PREVIEW, CoreProperties.ANALYSIS_MODE_PUBLISH, CoreProperties.ANALYSIS_MODE_ISSUES};

  protected boolean preview;
  protected boolean issues;
  protected boolean mediumTestMode;

  public GlobalAnalysisMode(RawScannerProperties props) {
    String mode = props.property(CoreProperties.ANALYSIS_MODE);
    validate(mode);
    issues = CoreProperties.ANALYSIS_MODE_ISSUES.equals(mode) || CoreProperties.ANALYSIS_MODE_PREVIEW.equals(mode);
    mediumTestMode = "true".equals(props.property(MEDIUM_TEST_ENABLED));
    if (preview) {
      LOG.info("Preview mode");
      LOG.warn("The use of the preview mode (sonar.analysis.mode=preview) is deprecated. This mode will be dropped in the future.");
    } else if (issues) {
      LOG.info("Issues mode");
      LOG.warn("The use of the issues mode (sonar.analysis.mode=issues) is deprecated. This mode will be dropped in the future.");
    }
    if (mediumTestMode) {
      LOG.info("Medium test mode");
    }
  }

  public boolean isPreview() {
    return preview;
  }

  public boolean isIssues() {
    return issues;
  }

  public boolean isPublish() {
    return !preview && !issues;
  }

  public boolean isMediumTest() {
    return mediumTestMode;
  }

  protected static void validate(String mode) {
    if (StringUtils.isEmpty(mode)) {
      return;
    }

    if (!Arrays.asList(VALID_MODES).contains(mode)) {
      throw new IllegalStateException("Invalid analysis mode: " + mode + ".");
    }

  }
}