org.wso2.carbon.appfactory.tenant.build.integration.utils.JenkinsConfig.java Source code

Introduction

Here is the source code for org.wso2.carbon.appfactory.tenant.build.integration.utils.JenkinsConfig.java

Source

/*
 * Copyright (c) 2005-2011, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
 * 
 * WSO2 Inc. licenses this file to you under the Apache License,
 * Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.wso2.carbon.appfactory.tenant.build.integration.utils;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;

import javax.xml.stream.XMLStreamException;

import org.apache.axiom.om.OMElement;
import org.apache.axiom.om.impl.builder.StAXOMBuilder;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * Singleton Class represents the configurations related to Jenkins.
 */
public class JenkinsConfig {

    private static Log log = LogFactory.getLog(JenkinsConfig.class);

    private static final String TENANTS_FOLDER_NAME = "tenants";

    private final static String JENKINS_TENANT_HOME_ENV = "JENKINS_TENANT_HOME";

    /**
     * File name of default maven settins file used for a tenant. ( this file
     * will be bundle with this component)
     */
    private final static String MAVEN_SETTINGS_FILE_TEMPLATE = "default_maven_settings.xml";

    /**
     * default configuration file for maven plugin reside in jenkins ( points to
     * global maven settings file)
     */
    public final static String GLOBAL_MAVEN_CONFIG_FILE = "jenkins.mvn.GlobalMavenConfig.xml";

    private static JenkinsConfig INSTANCE = null;

    private final String jenkinsHome;

    private final String jenkinsTenantsLocation;

    /**
     * Constructor to initiate Jenkins configurations.
     * 
     * @exception NullPointerException
     *                if no JENKINS_TENANT_HOME can be found.
     * @throws IOException
     *             if unable to create jenkins tenant folder .
     */
    private JenkinsConfig() throws IOException {
        jenkinsHome = checkJenkinsTenantHome();
        jenkinsTenantsLocation = checkJenkinsTenantsLocation();
    }

    /**
     * Checks whether the JENKINS_TENANT_HOME is properly set as a env variable.
     * 
     * @exception NullPointerException
     *                if no JENKINS_TENANT_HOME can be found.
     * @return JENKINS_TENANT_HOME path
     */
    private String checkJenkinsTenantHome() {
        String home = System.getenv(JENKINS_TENANT_HOME_ENV);
        if (home == null) {
            String msg = JENKINS_TENANT_HOME_ENV + " cannot be found.";
            log.fatal(msg);
            throw new NullPointerException(msg);
        }
        return home;
    }

    /**
     * Checks whether the Jenkins tenant's folder exists. i.e
     * <JENKINS_HOME>/tenants If not creates the folder.
     * 
     * @return path to jenkin's tenants folder
     * @throws IOException
     *             - if unable to create jenkins tenant folder
     */
    private String checkJenkinsTenantsLocation() throws IOException {
        File tenantSpace = new File(jenkinsHome, TENANTS_FOLDER_NAME);
        if (!tenantSpace.exists()) {
            if (!tenantSpace.mkdirs()) {
                String message = "Problem creating tenant Location for Jenkins. " + tenantSpace.getAbsolutePath();
                log.fatal(message);
                throw new IOException(message);
            }
        }
        return tenantSpace.getAbsolutePath();
    }

    /**
     * Returns the common tenant location for Jenkins. This location holds
     * different JENKINS_HOME locations for different tenants.
     * 
     * @return path to jenkins tenant space.
     */
    public String getTenantsLocation() {
        return jenkinsTenantsLocation;
    }

    public synchronized static JenkinsConfig getInstance() throws IOException {
        if (INSTANCE == null) {
            INSTANCE = new JenkinsConfig();
        }
        return INSTANCE;
    }

    /**
     * Loads the content of default setting.xml file.
     * More information about settings.xml can be found at :
     * http://maven.apache.org/settings.html
     * @return {@link OMElement} representing the content
     */
    public OMElement loadMavenSettingsFileContent() {

        InputStream jobConfigTemplateInputStream = this.getClass()
                .getResourceAsStream(File.separatorChar + MAVEN_SETTINGS_FILE_TEMPLATE);
        if (jobConfigTemplateInputStream != null) {

            try {
                StAXOMBuilder builder = new StAXOMBuilder(jobConfigTemplateInputStream);
                OMElement mavenSettingsTemplate = builder.getDocumentElement();
                return mavenSettingsTemplate;
            } catch (XMLStreamException e) {
                throw new RuntimeException(e.getMessage(), e);
            }

        } else {
            throw new NullPointerException(
                    "Class loader is unable to find the maven settings configuration template");
        }

    }

    /**
     * Returns the configurations of maven plugin in jenkins.
     * 
     * @return {@link OMElement} representing the file content
     */
    public OMElement getGlobalMavenConfigFileContent() {

        InputStream globalMavenConfigTemplateInputStream = this.getClass()
                .getResourceAsStream(File.separatorChar + GLOBAL_MAVEN_CONFIG_FILE);
        if (globalMavenConfigTemplateInputStream != null) {

            try {
                StAXOMBuilder builder = new StAXOMBuilder(globalMavenConfigTemplateInputStream);
                OMElement globalMavenConfigTemplate = builder.getDocumentElement();

                return globalMavenConfigTemplate;

            } catch (XMLStreamException e) {
                throw new RuntimeException(e.getMessage(), e);
            }

        } else {
            throw new NullPointerException(
                    "Class loader is unable to find the maven settings configuration template");
        }

    }

}