/* * SonarQube * 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.sonar.scanner.scan; import java.io.IOException; import java.nio.file.Path; import java.util.Optional; import org.junit.Before; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; import org.sonar.api.batch.fs.internal.DefaultInputProject; import org.sonar.api.config.internal.MapSettings; import org.sonar.api.utils.MessageException; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatThrownBy; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class ScanPropertiesTest { private final MapSettings settings = new MapSettings(); private final DefaultInputProject project = mock(DefaultInputProject.class); private final ScanProperties underTest = new ScanProperties(settings.asConfig(), project); @Rule public TemporaryFolder temp = new TemporaryFolder(); @Before public void setUp() throws IOException { when(project.getBaseDir()).thenReturn(temp.newFolder().toPath()); when(project.getWorkDir()).thenReturn(temp.newFolder().toPath()); } @Test public void defaults_if_no_setting_defined() { assertThat(underTest.branch()).isEmpty(); assertThat(underTest.preloadFileMetadata()).isFalse(); assertThat(underTest.shouldKeepReport()).isFalse(); assertThat(underTest.metadataFilePath()).isEqualTo(project.getWorkDir().resolve("report-task.txt")); underTest.validate(); } @Test public void should_define_branch_name() { settings.setProperty("sonar.branch.name", "name"); assertThat(underTest.branch()).isEqualTo(Optional.of("name")); } @Test public void should_define_report_publish_timeout() { assertThat(underTest.reportPublishTimeout()).isEqualTo(60); settings.setProperty("sonar.ws.report.timeout", "10"); assertThat(underTest.reportPublishTimeout()).isEqualTo(10); } @Test public void should_define_preload_file_metadata() { settings.setProperty("sonar.preloadFileMetadata", "true"); assertThat(underTest.preloadFileMetadata()).isTrue(); } @Test public void should_define_keep_report() { settings.setProperty("sonar.scanner.keepReport", "true"); assertThat(underTest.shouldKeepReport()).isTrue(); } @Test public void should_define_metadata_file_path() throws IOException { Path path = temp.newFolder().toPath().resolve("report"); settings.setProperty("sonar.scanner.metadataFilePath", path.toString()); assertThat(underTest.metadataFilePath()).isEqualTo(path); } @Test public void validate_fails_if_metadata_file_location_is_not_absolute() { settings.setProperty("sonar.scanner.metadataFilePath", "relative"); assertThatThrownBy(underTest::validate) .isInstanceOf(MessageException.class) .hasMessage("Property 'sonar.scanner.metadataFilePath' must point to an absolute path: relative"); } @Test public void validate_fails_if_sonar_branch_is_set() { settings.setProperty("sonar.branch", "anything"); assertThatThrownBy(underTest::validate) .isInstanceOf(MessageException.class) .hasMessage("The 'sonar.branch' parameter is no longer supported. You should stop using it. " + "Branch analysis is available in Developer Edition and above. See https://www.sonarsource.com/plans-and-pricing/developer/ for more information."); } @Test public void validate_fails_if_sonar_password_is_set() { settings.setProperty("sonar.password", "anything"); assertThatThrownBy(underTest::validate) .isInstanceOf(MessageException.class) .hasMessage("The property 'sonar.password' is no longer supported. " + "Please pass a token with the 'sonar.token' property instead."); } }