org.sonar.scanner.scan.DeprecatedPropertiesWarningGenerator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-scanner-engine Show documentation

Open source platform for continuous inspection of code quality

There is a newer version: 24.12.0.100206

/*
 * SonarQube
 * Copyright (C) 2009-2024 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.scan;

import com.google.common.annotations.VisibleForTesting;
import java.util.Optional;
import org.sonar.api.CoreProperties;
import org.sonar.api.config.Configuration;
import org.sonar.api.notifications.AnalysisWarnings;
import org.sonar.api.utils.log.Logger;
import org.sonar.api.utils.log.Loggers;

public class DeprecatedPropertiesWarningGenerator {
  private static final Logger LOG = Loggers.get(DeprecatedPropertiesWarningGenerator.class);

  @VisibleForTesting
  public static final String PASSWORD_WARN_MESSAGE = "Property '" + CoreProperties.PASSWORD + "' is deprecated. It will not be supported " +
    "in the future. Please instead use the 'sonar.login' parameter with a token.";

  private final Configuration configuration;
  private final AnalysisWarnings analysisWarnings;

  public DeprecatedPropertiesWarningGenerator(Configuration configuration, AnalysisWarnings analysisWarnings) {
    this.configuration = configuration;
    this.analysisWarnings = analysisWarnings;
  }

  public void execute() {
    Optional password = configuration.get(CoreProperties.PASSWORD);
    if (password.isPresent()) {
      LOG.warn(PASSWORD_WARN_MESSAGE);
      analysisWarnings.addUnique(PASSWORD_WARN_MESSAGE);
    }
  }

}