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 Jenkins.
31   * <p>
32   * http://jenkins-ci.org/
33   */
34  public class Jenkins extends AbstractServiceSetup {
35  
36      public static final String JENKINS_NAME = "jenkins";
37      public static final String JENKINS_URL = "JENKINS_URL";
38      public static final String JENKINS_BUILD_NUMBER = "BUILD_NUMBER";
39      public static final String JENKINS_BUILD_URL = "BUILD_URL";
40      public static final String JENKINS_BRANCH = "GIT_BRANCH";
41      public static final String JENKINS_COMMIT = "GIT_COMMIT";
42  
43      public Jenkins(final Map<String, String> env) {
44          super(env);
45      }
46  
47      @Override
48      public boolean isSelected() {
49          return getProperty(JENKINS_URL) != null;
50      }
51  
52      @Override
53      public String getName() {
54          return JENKINS_NAME;
55      }
56  
57      @Override
58      public String getBuildNumber() {
59          return getProperty(JENKINS_BUILD_NUMBER);
60      }
61  
62      @Override
63      public String getBuildUrl() {
64          return getProperty(JENKINS_BUILD_URL);
65      }
66  
67      @Override
68      public String getBranch() {
69          return getProperty(JENKINS_BRANCH);
70      }
71  
72      @Override
73      public Properties getEnvironment() {
74          Properties environment = new Properties();
75          addProperty(environment, "jenkins_build_num", getProperty(JENKINS_BUILD_NUMBER));
76          addProperty(environment, "jenkins_build_url", getProperty(JENKINS_BUILD_URL));
77          addProperty(environment, "branch", getProperty(JENKINS_BRANCH));
78          addProperty(environment, "commit_sha", getProperty(JENKINS_COMMIT));
79          return environment;
80      }
81  }