View Javadoc
1   /*
2    * The MIT License (MIT)
3    *
4    * Copyright (c) 2013 - 2023, Tapio Rautonen
5    *
6    * Permission is hereby granted, free of charge, to any person obtaining a copy
7    * of this software and associated documentation files (the "Software"), to deal
8    * in the Software without restriction, including without limitation the rights
9    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10   * copies of the Software, and to permit persons to whom the Software is
11   * furnished to do so, subject to the following conditions:
12   *
13   * The above copyright notice and this permission notice shall be included in
14   * all copies or substantial portions of the Software.
15   *
16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22   * THE SOFTWARE.
23   */
24  package org.eluder.coveralls.maven.plugin.service;
25  
26  import java.util.Map;
27  import java.util.Properties;
28  
29  /**
30   * Service implementation for CircleCI.
31   * <p>
32   * https://circleci.com/
33   */
34  public class Circle extends AbstractServiceSetup {
35  
36      public static final String CIRCLE_NAME = "circleci";
37      public static final String CIRCLE = "CIRCLECI";
38      public static final String CIRCLE_BUILD_NUMBER  = "CIRCLE_BUILD_NUM";
39      public static final String CIRCLE_BRANCH = "CIRCLE_BRANCH";
40      public static final String CIRCLE_COMMIT = "CIRCLE_SHA1";
41  
42      public Circle(final Map<String, String> env) {
43          super(env);
44      }
45  
46      @Override
47      public boolean isSelected() {
48          return getProperty(CIRCLE) != null;
49      }
50  
51      @Override
52      public String getName() {
53          return CIRCLE_NAME;
54      }
55  
56      @Override
57      public String getBuildNumber() {
58          return getProperty(CIRCLE_BUILD_NUMBER);
59      }
60  
61      @Override
62      public String getBranch() {
63          return getProperty(CIRCLE_BRANCH);
64      }
65  
66      @Override
67      public Properties getEnvironment() {
68          Properties environment = new Properties();
69          addProperty(environment, "circleci_build_num", getProperty(CIRCLE_BUILD_NUMBER));
70          addProperty(environment, "branch", getProperty(CIRCLE_BRANCH));
71          addProperty(environment, "commit_sha", getProperty(CIRCLE_COMMIT));
72          return environment;
73      }
74  }