org.sonarsource.scanner.maven.bootstrap.ScannerBootstrapperFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-maven-plugin Show documentation
Trigger SonarQube analysis on Maven projects
The newest version!
/*
 * SonarQube Scanner for Maven
 * Copyright (C) 2009-2025 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.maven.bootstrap;

import java.util.Arrays;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.stream.Collectors;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.plugin.MojoExecution;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.rtinfo.RuntimeInformation;
import org.apache.maven.settings.Proxy;
import org.sonarsource.scanner.lib.ScannerEngineBootstrapper;

public class ScannerBootstrapperFactory {
  private static final String UNKNOWN_PROXY_PROTOCOL_MESSAGE = "Setting proxy properties:" +
    " one or multiple protocols of the active proxy (id: %s) are not supported (protocols: %s).";

  private final RuntimeInformation runtimeInformation;
  private final MavenSession session;
  private final PropertyDecryptor propertyDecryptor;
  private final Map envProps;
  private final Log log;
  private final MojoExecution mojoExecution;

  public ScannerBootstrapperFactory(Log log, RuntimeInformation runtimeInformation, MojoExecution mojoExecution, MavenSession session,
    Map envProps, PropertyDecryptor propertyDecryptor) {
    this.log = log;
    this.runtimeInformation = runtimeInformation;
    this.mojoExecution = mojoExecution;
    this.session = session;
    this.envProps = envProps;
    this.propertyDecryptor = propertyDecryptor;
  }

  public ScannerEngineBootstrapper create() {
    setProxySystemProperties();
    ScannerEngineBootstrapper scanner = createScannerEngineBootstrapper("ScannerMaven", mojoExecution.getVersion() + "/" + runtimeInformation.getMavenVersion());
    scanner.addBootstrapProperties(createGlobalProperties());
    if (log.isDebugEnabled()) {
      scanner.setBootstrapProperty("sonar.verbose", "true");
    }

    return scanner;
  }

  ScannerEngineBootstrapper createScannerEngineBootstrapper(String app, String version) {
    return ScannerEngineBootstrapper.create(app, version);
  }

  public Map createGlobalProperties() {
    Map p = new HashMap<>();
    MavenUtils.putRelevant(session.getCurrentProject().getProperties(), p);
    p.putAll(envProps);
    MavenUtils.putRelevant(session.getSystemProperties(), p);
    MavenUtils.putRelevant(session.getUserProperties(), p);
    p.putAll(propertyDecryptor.decryptProperties(p));
    return p;
  }

  /**
   * Set proxy properties from Maven settings
   */
  public void setProxySystemProperties() {
    Proxy activeProxy = session.getSettings().getActiveProxy();
    if (activeProxy == null) {
      log.debug("Skipping proxy settings: No active proxy detected.");
      return;
    }

    String protocol = activeProxy.getProtocol();
    if (protocol == null) {
      log.warn("Skipping proxy settings: an active proxy was detected (id: " + activeProxy.getId() + ") but the protocol is null.");
      return;
    }

    Set protocols = Arrays.stream(activeProxy.getProtocol().trim().split("\\|"))
      .map(proto -> proto.trim().toLowerCase(Locale.ROOT))
      .filter(proto -> !proto.isEmpty())
      .collect(Collectors.toSet());

    if (protocols.isEmpty()) {
      log.warn("Skipping proxy settings: an active proxy was detected (id: " + activeProxy.getId() + ") but the protocol was not recognized.");
      return;
    }

    log.debug("Setting proxy properties");
    if (protocols.remove("http")) {
      System.setProperty("http.proxyHost", activeProxy.getHost());
      System.setProperty("http.proxyPort", String.valueOf(activeProxy.getPort()));
      setCommonHttpProperties(activeProxy);
    }
    if (protocols.remove("https")) {
      System.setProperty("https.proxyHost", activeProxy.getHost());
      System.setProperty("https.proxyPort", String.valueOf(activeProxy.getPort()));
      setCommonHttpProperties(activeProxy);
    }

    if (!protocols.isEmpty()) {
      String remainingProtocols = String.join(", ", protocols);
      log.warn(String.format(UNKNOWN_PROXY_PROTOCOL_MESSAGE, activeProxy.getId(), remainingProtocols));
    }
  }

  private static void setCommonHttpProperties(Proxy proxy) {
    System.setProperty("http.proxyUser", Objects.toString(proxy.getUsername(), ""));
    System.setProperty("http.proxyPassword", Objects.toString(proxy.getPassword(), ""));
    System.setProperty("http.nonProxyHosts", Objects.toString(proxy.getNonProxyHosts(), ""));
  }
}