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