Jenkins.java

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2013-2026 The Coveralls Maven Plugin Project Contributors:
 *     https://github.com/hazendaz/coveralls-maven-plugin/graphs/contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.eluder.coveralls.maven.plugin.service;

import java.util.Map;
import java.util.Properties;

/**
 * Service implementation for Jenkins.
 * <p>
 * https://jenkins-ci.org/
 */
public class Jenkins extends AbstractServiceSetup {

    /** The Constant JENKINS_NAME. */
    public static final String JENKINS_NAME = "jenkins";

    /** The Constant JENKINS_URL. */
    public static final String JENKINS_URL = "JENKINS_URL";

    /** The Constant JENKINS_BUILD_NUMBER. */
    public static final String JENKINS_BUILD_NUMBER = "BUILD_NUMBER";

    /** The Constant JENKINS_BUILD_URL. */
    public static final String JENKINS_BUILD_URL = "BUILD_URL";

    /** The Constant JENKINS_BRANCH. */
    public static final String JENKINS_BRANCH = "GIT_BRANCH";

    /** The Constant JENKINS_COMMIT. */
    public static final String JENKINS_COMMIT = "GIT_COMMIT";

    /**
     * Instantiates a new jenkins.
     *
     * @param env
     *            the env
     */
    public Jenkins(final Map<String, String> env) {
        super(env);
    }

    @Override
    public boolean isSelected() {
        return this.getProperty(Jenkins.JENKINS_URL) != null;
    }

    @Override
    public String getName() {
        return Jenkins.JENKINS_NAME;
    }

    @Override
    public String getBuildNumber() {
        return this.getProperty(Jenkins.JENKINS_BUILD_NUMBER);
    }

    @Override
    public String getBuildUrl() {
        return this.getProperty(Jenkins.JENKINS_BUILD_URL);
    }

    @Override
    public String getBranch() {
        return this.getProperty(Jenkins.JENKINS_BRANCH);
    }

    @Override
    public Properties getEnvironment() {
        final var environment = new Properties();
        this.addProperty(environment, "jenkins_build_num", this.getProperty(Jenkins.JENKINS_BUILD_NUMBER));
        this.addProperty(environment, "jenkins_build_url", this.getProperty(Jenkins.JENKINS_BUILD_URL));
        this.addProperty(environment, "branch", this.getProperty(Jenkins.JENKINS_BRANCH));
        this.addProperty(environment, "commit_sha", this.getProperty(Jenkins.JENKINS_COMMIT));
        return environment;
    }
}