aboutsummaryrefslogtreecommitdiffstats
path: root/sonar-scanner-engine/src/test/java/org/sonar/scanner/bootstrap/ScannerPluginInstallerTest.java
blob: 210c5228bd9bde5edbfefd8e6f47c46d7393f027 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
/*
 * 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.bootstrap;

import java.io.File;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.StringReader;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.jar.Attributes;
import java.util.jar.JarOutputStream;
import java.util.jar.Manifest;
import org.apache.commons.io.FileUtils;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
import org.sonar.scanner.WsTestUtil;
import org.sonar.scanner.http.DefaultScannerWsClient;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.mockito.ArgumentMatchers.argThat;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.mock;

public class ScannerPluginInstallerTest {

  @Rule
  public TemporaryFolder temp = new TemporaryFolder();

  private PluginFiles pluginFiles = mock(PluginFiles.class);
  private DefaultScannerWsClient wsClient = mock(DefaultScannerWsClient.class);
  private ScannerPluginInstaller underTest = new ScannerPluginInstaller(pluginFiles, wsClient);

  @Test
  public void download_installed_plugins() throws IOException {
    WsTestUtil.mockReader(wsClient, "api/plugins/installed",
      new InputStreamReader(getClass().getResourceAsStream("ScannerPluginInstallerTest/installed-plugins-ws.json")));
    enqueueDownload("scmgit", "abc");
    enqueueDownload("java", "def");

    Map<String, ScannerPlugin> result = underTest.installRequiredPlugins();

    assertThat(result.keySet()).containsExactlyInAnyOrder("scmgit");
    ScannerPlugin gitPlugin = result.get("scmgit");
    assertThat(gitPlugin.getKey()).isEqualTo("scmgit");
    assertThat(gitPlugin.getInfo().getNonNullJarFile()).exists().isFile();
    assertThat(gitPlugin.getUpdatedAt()).isEqualTo(100L);

    Map<String, ScannerPlugin> result2 = underTest.installPluginsForLanguages(new HashSet<>(List.of("java")));

    assertThat(result2.keySet()).containsExactlyInAnyOrder("java");
    ScannerPlugin javaPlugin = result2.get("java");
    assertThat(javaPlugin.getKey()).isEqualTo("java");
    assertThat(javaPlugin.getInfo().getNonNullJarFile()).exists().isFile();
    assertThat(javaPlugin.getUpdatedAt()).isEqualTo(200L);
  }

  @Test
  public void download_all_plugins() throws IOException {
    WsTestUtil.mockReader(wsClient, "api/plugins/installed",
      new InputStreamReader(getClass().getResourceAsStream("ScannerPluginInstallerTest/installed-plugins-ws.json")));
    enqueueDownload("scmgit", "abc");
    enqueueDownload("java", "def");

    Map<String, ScannerPlugin> result = underTest.installAllPlugins();

    assertThat(result.keySet()).containsExactlyInAnyOrder("scmgit", "java");
    ScannerPlugin gitPlugin = result.get("scmgit");
    assertThat(gitPlugin.getKey()).isEqualTo("scmgit");
    assertThat(gitPlugin.getInfo().getNonNullJarFile()).exists().isFile();
    assertThat(gitPlugin.getUpdatedAt()).isEqualTo(100L);

    ScannerPlugin javaPlugin = result.get("java");
    assertThat(javaPlugin.getKey()).isEqualTo("java");
    assertThat(javaPlugin.getInfo().getNonNullJarFile()).exists().isFile();
    assertThat(javaPlugin.getUpdatedAt()).isEqualTo(200L);
  }

  @Test
  public void fail_if_json_of_installed_plugins_is_not_valid() {
    WsTestUtil.mockReader(wsClient, "api/plugins/installed", new StringReader("not json"));

    assertThatThrownBy(() -> underTest.installRequiredPlugins())
      .isInstanceOf(IllegalStateException.class)
      .hasMessage("Fail to parse response of api/plugins/installed");
  }

  @Test
  public void reload_list_if_plugin_uninstalled_during_blue_green_switch() throws IOException {
    WsTestUtil.mockReader(wsClient, "api/plugins/installed",
      new InputStreamReader(getClass().getResourceAsStream("ScannerPluginInstallerTest/blue-installed.json")),
      new InputStreamReader(getClass().getResourceAsStream("ScannerPluginInstallerTest/green-installed.json")));
    enqueueNotFoundDownload("scmgit", "abc");
    enqueueDownload("java", "def");
    enqueueDownload("cobol", "ghi");

    Map<String, ScannerPlugin> result = underTest.installRequiredPlugins();

    assertThat(result.keySet()).containsExactlyInAnyOrder("java", "cobol");
  }

  @Test
  public void fail_if_plugin_not_found_two_times() throws IOException {
    WsTestUtil.mockReader(wsClient, "api/plugins/installed",
      new InputStreamReader(getClass().getResourceAsStream("ScannerPluginInstallerTest/blue-installed.json")),
      new InputStreamReader(getClass().getResourceAsStream("ScannerPluginInstallerTest/green-installed.json")));
    enqueueDownload("scmgit", "abc");
    enqueueDownload("cobol", "ghi");
    enqueueNotFoundDownload("java", "def");

    assertThatThrownBy(() -> underTest.installRequiredPlugins())
      .isInstanceOf(IllegalStateException.class)
      .hasMessage("Fail to download plugin [java]. Not found.");
  }

  @Test
  public void installLocals_always_returns_empty() {
    // this method is used only by medium tests
    assertThat(underTest.installLocals()).isEmpty();
  }

  private void enqueueDownload(String pluginKey, String pluginHash) throws IOException {
    File jar = temp.newFile();
    Manifest manifest = new Manifest();
    manifest.getMainAttributes().put(Attributes.Name.MANIFEST_VERSION, "1.0");
    manifest.getMainAttributes().putValue("Plugin-Key", pluginKey);
    try (JarOutputStream output = new JarOutputStream(FileUtils.openOutputStream(jar), manifest)) {

    }
    doReturn(Optional.of(jar)).when(pluginFiles).get(argThat(p -> pluginKey.equals(p.key) && pluginHash.equals(p.hash)));
  }

  private void enqueueNotFoundDownload(String pluginKey, String pluginHash) {
    doReturn(Optional.empty()).when(pluginFiles).get(argThat(p -> pluginKey.equals(p.key) && pluginHash.equals(p.hash)));
  }
}