aboutsummaryrefslogtreecommitdiffstats
path: root/sonar-scanner-engine/src/test/java/org/sonar/scanner/ci/CiConfigurationProviderTest.java
blob: f301b8016035442ea515b791f6b3d821062426ae (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
/*
 * SonarQube
 * Copyright (C) 2009-2020 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.ci;

import org.junit.Test;
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.catchThrowable;

public class CiConfigurationProviderTest {

  private MapSettings cli = new MapSettings();
  private CiConfigurationProvider underTest = new CiConfigurationProvider();

  @Test
  public void empty_configuration_if_no_ci_vendors() {
    CiConfiguration CiConfiguration = underTest.provide(cli.asConfig(), new CiVendor[0]);

    assertThat(CiConfiguration.getScmRevision()).isEmpty();
  }

  @Test
  public void empty_configuration_if_no_ci_detected() {
    CiConfiguration ciConfiguration = underTest.provide(cli.asConfig(), new CiVendor[] {new DisabledCiVendor("vendor1"), new DisabledCiVendor("vendor2")});

    assertThat(ciConfiguration.getScmRevision()).isEmpty();
  }

  @Test
  public void configuration_defined_by_ci_vendor() {
    CiConfiguration ciConfiguration = underTest.provide(cli.asConfig(), new CiVendor[] {new DisabledCiVendor("vendor1"), new EnabledCiVendor("vendor2")});

    assertThat(ciConfiguration.getScmRevision()).hasValue(EnabledCiVendor.SHA);
  }

  @Test
  public void fail_if_multiple_ci_vendor_are_detected() {
    Throwable thrown = catchThrowable(() -> underTest.provide(cli.asConfig(), new CiVendor[] {new EnabledCiVendor("vendor1"), new EnabledCiVendor("vendor2")}));

    assertThat(thrown)
      .isInstanceOf(MessageException.class)
      .hasMessage("Multiple CI environments are detected: [vendor1, vendor2]. Please check environment variables or set property sonar.ci.autoconfig.disabled to true.");
  }

  @Test
  public void empty_configuration_if_auto_configuration_is_disabled() {
    cli.setProperty("sonar.ci.autoconfig.disabled", true);
    CiConfiguration ciConfiguration = underTest.provide(cli.asConfig(), new CiVendor[] {new EnabledCiVendor("vendor1")});

    assertThat(ciConfiguration.getScmRevision()).isEmpty();
  }

  private static class DisabledCiVendor implements CiVendor {
    private final String name;

    private DisabledCiVendor(String name) {
      this.name = name;
    }

    @Override
    public String getName() {
      return name;
    }

    @Override
    public boolean isDetected() {
      return false;
    }

    @Override
    public CiConfiguration loadConfiguration() {
      throw new IllegalStateException("should not be called");
    }
  }

  private static class EnabledCiVendor implements CiVendor {
    private static final String SHA = "abc12df";
    private final String name;

    private EnabledCiVendor(String name) {
      this.name = name;
    }

    @Override
    public String getName() {
      return name;
    }

    @Override
    public boolean isDetected() {
      return true;
    }

    @Override
    public CiConfiguration loadConfiguration() {
      return new CiConfigurationImpl(SHA);
    }
  }
}