- /*
- * SonarQube Scanner
- * Copyright (C) 2011-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.sonarsource.scanner.cli;
-
- import java.util.Map;
- import java.util.Properties;
- import org.sonarsource.scanner.api.EmbeddedScanner;
- import org.sonarsource.scanner.api.ScanProperties;
-
- /**
- * Arguments :
- * <ul>
- * <li>scanner.home: optional path to Scanner home (root directory with sub-directories bin, lib and conf)</li>
- * <li>scanner.settings: optional path to runner global settings, usually ${scanner.home}/conf/sonar-scanner.properties.
- * This property is used only if ${scanner.home} is not defined</li>
- * <li>project.home: path to project root directory. If not set, then it's supposed to be the directory where the runner is executed</li>
- * <li>project.settings: optional path to project settings. Default value is ${project.home}/sonar-project.properties.</li>
- * </ul>
- *
- * @since 1.0
- */
- public class Main {
- private static final String SEPARATOR = "------------------------------------------------------------------------";
- private final Exit exit;
- private final Cli cli;
- private final Conf conf;
- private EmbeddedScanner runner;
- private ScannerFactory runnerFactory;
- private Logs logger;
-
- Main(Exit exit, Cli cli, Conf conf, ScannerFactory runnerFactory, Logs logger) {
- this.exit = exit;
- this.cli = cli;
- this.conf = conf;
- this.runnerFactory = runnerFactory;
- this.logger = logger;
- }
-
- public static void main(String[] args) {
- Logs logs = new Logs(System.out, System.err);
- Exit exit = new Exit();
- Cli cli = new Cli(exit, logs).parse(args);
- Main main = new Main(exit, cli, new Conf(cli, logs, System.getenv()), new ScannerFactory(logs), logs);
- main.execute();
- }
-
- void execute() {
- Stats stats = new Stats(logger).start();
-
- int status = Exit.INTERNAL_ERROR;
- try {
- Properties p = conf.properties();
- checkSkip(p);
- configureLogging(p);
- init(p);
- runner.start();
- logger.info("SonarQube server " + runner.serverVersion());
- execute(stats, p);
- status = Exit.SUCCESS;
- } catch (Throwable e) {
- displayExecutionResult(stats, "FAILURE");
- showError("Error during SonarQube Scanner execution", e, cli.isDebugEnabled());
- status = isUserError(e) ? Exit.USER_ERROR : Exit.INTERNAL_ERROR;
- } finally {
- exit.exit(status);
- }
-
- }
-
- private void checkSkip(Properties properties) {
- if ("true".equalsIgnoreCase(properties.getProperty(ScanProperties.SKIP))) {
- logger.info("SonarQube Scanner analysis skipped");
- exit.exit(Exit.SUCCESS);
- }
- }
-
- private void init(Properties p) {
- SystemInfo.print(logger);
- if (cli.isDisplayVersionOnly()) {
- exit.exit(Exit.SUCCESS);
- }
-
- runner = runnerFactory.create(p);
- }
-
- private void configureLogging(Properties props) {
- if ("true".equals(props.getProperty("sonar.verbose"))
- || "DEBUG".equalsIgnoreCase(props.getProperty("sonar.log.level"))
- || "TRACE".equalsIgnoreCase(props.getProperty("sonar.log.level"))) {
- logger.setDebugEnabled(true);
- }
- }
-
- private void execute(Stats stats, Properties p) {
- runner.execute((Map) p);
- displayExecutionResult(stats, "SUCCESS");
- }
-
- private void displayExecutionResult(Stats stats, String resultMsg) {
- logger.info(SEPARATOR);
- logger.info("EXECUTION " + resultMsg);
- logger.info(SEPARATOR);
- stats.stop();
- logger.info(SEPARATOR);
- }
-
- private void showError(String message, Throwable e, boolean debug) {
- if (debug && !isUserError(e)) {
- logger.error(message, e);
- } else {
- logger.error(message);
- logger.error(e.getMessage());
- String previousMsg = "";
- for (Throwable cause = e.getCause(); cause != null
- && cause.getMessage() != null
- && !cause.getMessage().equals(previousMsg); cause = cause.getCause()) {
- logger.error("Caused by: " + cause.getMessage());
- previousMsg = cause.getMessage();
- }
- }
-
- if (!cli.isDebugEnabled()) {
- logger.error("");
- suggestDebugMode();
- }
- }
-
- private static boolean isUserError(Throwable e) {
- // class not available at compile time (loaded by isolated classloader)
- return "org.sonar.api.utils.MessageException".equals(e.getClass().getName());
- }
-
- private void suggestDebugMode() {
- if (!cli.isEmbedded()) {
- logger.error("Re-run SonarQube Scanner using the -X switch to enable full debug logging.");
- }
- }
-
- }
|