sonarqube/sonar-ws/src/testFixtures/java/org/sonarqube/ws/tester/SettingTester.java

/*
 * SonarQube
 * Copyright (C) 2009-2023 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.sonarqube.ws.tester;

import com.google.common.collect.ImmutableSet;
import java.util.Arrays;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import javax.annotation.Nullable;
import org.sonarqube.ws.Settings;
import org.sonarqube.ws.Settings.Setting;
import org.sonarqube.ws.client.settings.ListDefinitionsRequest;
import org.sonarqube.ws.client.settings.ResetRequest;
import org.sonarqube.ws.client.settings.SetRequest;
import org.sonarqube.ws.client.settings.SettingsService;
import org.sonarqube.ws.client.settings.ValuesRequest;

import static java.util.Arrays.asList;

public class SettingTester {

  private static final Set<String> EMAIL_SETTINGS = ImmutableSet.of("email.smtp_host.secured", "email.smtp_port.secured", "email.smtp_secure_connection.secured",
    "email.smtp_username.secured", "email.smtp_password.secured", "email.from", "email.prefix");

  private final TesterSession session;

  SettingTester(TesterSession session) {
    this.session = session;
  }

  public SettingsService service() {
    return session.wsClient().settings();
  }

  public void deleteAll() {
    List<String> settingKeys = Stream.concat(
      session.wsClient().settings().listDefinitions(new ListDefinitionsRequest()).getDefinitionsList()
        .stream()
        .filter(def -> def.getType() != Settings.Type.LICENSE)
        .map(Settings.Definition::getKey)
        .filter(key -> !key.equals(Tester.FORCE_AUTHENTICATION_PROPERTY_NAME)),
      EMAIL_SETTINGS.stream())
      .collect(Collectors.toList());
    session.wsClient().settings().reset(new ResetRequest().setKeys(settingKeys));
  }

  public void resetSettings(String... keys) {
    session.wsClient().settings().reset(new ResetRequest().setKeys(asList(keys)));
  }

  public List<Setting> getGlobalSettings(String... keys) {
    return session.wsClient().settings().values(new ValuesRequest().setKeys(asList(keys)))
        .getSettingsList();
  }

  public void resetProjectSettings(String projectKey, String... keys) {
    session.wsClient().settings().reset(new ResetRequest().setComponent(projectKey).setKeys(asList(keys)));
  }

  public void setGlobalSetting(String key, @Nullable String value) {
    setSetting(null, key, value);
  }

  public void setMultiValuesGlobalSetting(String key, String... values) {
    session.wsClient().settings().set(new SetRequest()
      .setKey(key)
      .setValues(Arrays.asList(values))
      .setComponent(null));
  }

  public void setGlobalSettings(String... keyValues) {
    for (int i = 0; i < keyValues.length; i += 2) {
      setSetting(null, keyValues[i], keyValues[i + 1]);
    }
  }

  public void setProjectSetting(String componentKey, String key, @Nullable String value) {
    setSetting(componentKey, key, value);
  }

  public void setProjectSettings(String componentKey, String... properties) {
    for (int i = 0; i < properties.length; i += 2) {
      setSetting(componentKey, properties[i], properties[i + 1]);
    }
  }

  private void setSetting(@Nullable String componentKey, String key, @Nullable String value) {
    if (value == null) {
      session.wsClient().settings().reset(new ResetRequest().setKeys(asList(key)).setComponent(componentKey));
    } else {
      session.wsClient().settings().set(new SetRequest().setKey(key).setValue(value).setComponent(componentKey));
    }
  }

}