sonarqube/sonar-plugin-api-impl/src/test/java/org/sonar/api/batch/sensor/internal/DefaultSensorDescriptorTest.java

/*
 * SonarQube
 * Copyright (C) 2009-2021 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.api.batch.sensor.internal;

import com.tngtech.java.junit.dataprovider.DataProvider;
import com.tngtech.java.junit.dataprovider.DataProviderRunner;
import com.tngtech.java.junit.dataprovider.UseDataProvider;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.sonar.api.batch.fs.InputFile;
import org.sonar.api.config.internal.MapSettings;

import static org.assertj.core.api.Assertions.assertThat;

@RunWith(DataProviderRunner.class)
public class DefaultSensorDescriptorTest {

  @Test
  public void describe_defaults() {
    DefaultSensorDescriptor descriptor = new DefaultSensorDescriptor();
    descriptor
            .name("Foo");

    assertThat(descriptor.name()).isEqualTo("Foo");
    assertThat(descriptor.languages()).isEmpty();
    assertThat(descriptor.type()).isNull();
    assertThat(descriptor.ruleRepositories()).isEmpty();
    assertThat(descriptor.isProcessesFilesIndependently()).isFalse();
  }

  @Test
  public void describe() {
    DefaultSensorDescriptor descriptor = new DefaultSensorDescriptor();
    descriptor
      .name("Foo")
      .onlyOnLanguage("java")
      .onlyOnFileType(InputFile.Type.MAIN)
      .onlyWhenConfiguration(c -> c.hasKey("sonar.foo.reportPath2") && c.hasKey("sonar.foo.reportPath"))
      .createIssuesForRuleRepository("squid-java")
      .processesFilesIndependently();

    assertThat(descriptor.name()).isEqualTo("Foo");
    assertThat(descriptor.languages()).containsOnly("java");
    assertThat(descriptor.type()).isEqualTo(InputFile.Type.MAIN);
    MapSettings settings = new MapSettings();
    settings.setProperty("sonar.foo.reportPath", "foo");
    assertThat(descriptor.configurationPredicate().test(settings.asConfig())).isFalse();
    settings.setProperty("sonar.foo.reportPath2", "foo");
    assertThat(descriptor.configurationPredicate().test(settings.asConfig())).isTrue();
    assertThat(descriptor.ruleRepositories()).containsOnly("squid-java");
    assertThat(descriptor.isProcessesFilesIndependently()).isTrue();
  }

  @Test
  @UseDataProvider("independentFilesSensors")
  public void describe_with_restricted_sensor(String sensorName) {
    DefaultSensorDescriptor descriptor = new DefaultSensorDescriptor();
    descriptor
      .name(sensorName);

    assertThat(descriptor.isProcessesFilesIndependently()).isTrue();
  }

  @Test
  @UseDataProvider("independentFilesSensors")
  public void describe_with_non_restricted_sensor(String sensorName) {
    DefaultSensorDescriptor descriptor = new DefaultSensorDescriptor();
    descriptor
      .name(sensorName + "other");

    assertThat(descriptor.isProcessesFilesIndependently()).isFalse();
  }

  @DataProvider
  public static Object[][] independentFilesSensors() {
    return new Object[][] {DefaultSensorDescriptor.HARDCODED_INDEPENDENT_FILE_SENSORS.toArray()};
  }

}