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