sonarqube/server/sonar-server-common/src/test/java/org/sonar/server/plugins/ServerExtensionInstallerTest.java

/*
 * SonarQube
 * Copyright (C) 2009-2019 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.server.plugins;

import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExpectedException;
import org.sonar.api.Plugin;
import org.sonar.api.SonarEdition;
import org.sonar.api.SonarQubeSide;
import org.sonar.api.SonarRuntime;
import org.sonar.api.internal.SonarRuntimeImpl;
import org.sonar.api.server.ServerSide;
import org.sonar.api.utils.MessageException;
import org.sonar.api.utils.Version;
import org.sonar.core.platform.ComponentContainer;
import org.sonar.core.platform.PluginInfo;
import org.sonar.core.platform.PluginRepository;

import static java.util.Collections.singleton;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;

public class ServerExtensionInstallerTest {

  @Rule
  public ExpectedException expectedException = ExpectedException.none();

  private SonarRuntime sonarRuntime = SonarRuntimeImpl.forSonarQube(Version.parse("8.0"), SonarQubeSide.SERVER, SonarEdition.COMMUNITY);
  private TestPluginRepository pluginRepository = new TestPluginRepository();

  private TestServerExtensionInstaller underTest = new TestServerExtensionInstaller(sonarRuntime, pluginRepository);

  @Test
  public void add_plugin_to_container() {
    PluginInfo fooPluginInfo = newPlugin("foo", "Foo");
    Plugin fooPlugin = mock(Plugin.class);
    pluginRepository.add(fooPluginInfo, fooPlugin);
    ComponentContainer componentContainer = new ComponentContainer();

    underTest.installExtensions(componentContainer);

    assertThat(componentContainer.getPicoContainer().getComponents()).contains(fooPlugin);
  }

  @Test
  public void fail_when_detecting_github_auth_plugin() {
    PluginInfo foo = newPlugin("authgithub", "GitHub Auth");
    pluginRepository.add(foo, mock(Plugin.class));
    ComponentContainer componentContainer = new ComponentContainer();

    expectedException.expect(MessageException.class);
    expectedException.expectMessage("Plugins 'GitHub Auth' are no more compatible with SonarQube");

    underTest.installExtensions(componentContainer);
  }

  @Test
  public void fail_when_detecting_auth_plugins() {
    pluginRepository.add(newPlugin("authgitlab", "GitLab Auth"), mock(Plugin.class));
    pluginRepository.add(newPlugin("authsaml", "SAML Auth"), mock(Plugin.class));
    pluginRepository.add(newPlugin("ldap", "LDAP"), mock(Plugin.class));
    ComponentContainer componentContainer = new ComponentContainer();

    expectedException.expect(MessageException.class);
    expectedException.expectMessage("Plugins 'GitLab Auth, LDAP, SAML Auth' are no more compatible with SonarQube");

    underTest.installExtensions(componentContainer);
  }

  @Test
  public void fail_when_detecting_saml_auth_plugin() {
    PluginInfo foo = newPlugin("authsaml", "SAML Auth");
    pluginRepository.add(foo, mock(Plugin.class));
    ComponentContainer componentContainer = new ComponentContainer();

    expectedException.expect(MessageException.class);
    expectedException.expectMessage("Plugins 'SAML Auth' are no more compatible with SonarQube");

    underTest.installExtensions(componentContainer);
  }

  @Test
  public void fail_when_detecting_ldap_auth_plugin() {
    PluginInfo foo = newPlugin("ldap", "LDAP");
    pluginRepository.add(foo, mock(Plugin.class));
    ComponentContainer componentContainer = new ComponentContainer();

    expectedException.expect(MessageException.class);
    expectedException.expectMessage("Plugins 'LDAP' are no more compatible with SonarQube");

    underTest.installExtensions(componentContainer);
  }

  private static PluginInfo newPlugin(String key, String name) {
    PluginInfo plugin = mock(PluginInfo.class);
    when(plugin.getKey()).thenReturn(key);
    when(plugin.getName()).thenReturn(name);
    return plugin;
  }

  private static class TestPluginRepository implements PluginRepository {
    private final Map<String, PluginInfo> pluginsInfoMap = new HashMap<>();
    private final Map<String, Plugin> pluginsMap = new HashMap<>();

    void add(PluginInfo pluginInfo, Plugin plugin) {
      pluginsInfoMap.put(pluginInfo.getKey(), pluginInfo);
      pluginsMap.put(pluginInfo.getKey(), plugin);
    }

    @Override
    public Collection<PluginInfo> getPluginInfos() {
      return pluginsInfoMap.values();
    }

    @Override
    public PluginInfo getPluginInfo(String key) {
      if (!pluginsMap.containsKey(key)) {
        throw new IllegalArgumentException();
      }
      return pluginsInfoMap.get(key);
    }

    @Override
    public Plugin getPluginInstance(String key) {
      if (!pluginsMap.containsKey(key)) {
        throw new IllegalArgumentException();
      }
      return pluginsMap.get(key);
    }

    @Override
    public boolean hasPlugin(String key) {
      return pluginsMap.containsKey(key);
    }
  }

  private static class TestServerExtensionInstaller extends ServerExtensionInstaller {

    protected TestServerExtensionInstaller(SonarRuntime sonarRuntime, PluginRepository pluginRepository) {
      super(sonarRuntime, pluginRepository, singleton(ServerSide.class));
    }
  }

}