javaposse.jobdsl.dsl.DslScriptLoader Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of job-dsl-core Show documentation
Javaposse jenkins job-dsl-core
There is a newer version: 1.22-rxd-2
package javaposse.jobdsl.dsl;

import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
import groovy.lang.Binding;
import groovy.lang.GroovyClassLoader;
import groovy.lang.Script;
import groovy.util.GroovyScriptEngine;
import org.codehaus.groovy.control.CompilerConfiguration;
import org.codehaus.groovy.control.customizers.ImportCustomizer;
import org.codehaus.groovy.runtime.InvokerHelper;

import java.io.File;
import java.io.IOException;
import java.io.PrintWriter;
import java.net.URL;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * Runs provided DSL scripts via an external JObManager
 */
public class DslScriptLoader {
    private static final Logger LOGGER = Logger.getLogger(DslScriptLoader.class.getName());

    public static JobParent runDslEngineForParent(ScriptRequest scriptRequest, JobManagement jobManagement) throws IOException {
        ClassLoader parentClassLoader = DslScriptLoader.class.getClassLoader();
        CompilerConfiguration config = createCompilerConfiguration(jobManagement);

        // Otherwise baseScript won't take effect
        GroovyClassLoader cl = new GroovyClassLoader(parentClassLoader, config);

        // Add static imports of a few common types, like JobType
        ImportCustomizer icz = new ImportCustomizer();
        icz.addStaticStars("javaposse.jobdsl.dsl.JobType");
        icz.addStaticStars("javaposse.jobdsl.dsl.helpers.common.MavenContext.LocalRepositoryLocation");
        config.addCompilationCustomizers(icz);

        GroovyScriptEngine engine = //scriptRequest.resourceConnector!=null?
                //new GroovyScriptEngine(scriptRequest.resourceConnector, parentClassLoader):
                new GroovyScriptEngine(new URL[] { scriptRequest.urlRoot } , cl);

        engine.setConfig(config);

        Binding binding = createBinding(jobManagement);

        JobParent jp;
        try {
            Script script;
            if (scriptRequest.body != null) {
                Class cls = engine.getGroovyClassLoader().parseClass(scriptRequest.body);
                script = InvokerHelper.createScript(cls, binding);
            } else {
                script = engine.createScript(scriptRequest.location, binding);
            }
            assert script instanceof JobParent;

            jp = (JobParent) script;
            jp.setJm(jobManagement);

            binding.setVariable("jobFactory", jp);

            script.run();
        } catch (Exception e) { // ResourceException or ScriptException
            if(e instanceof RuntimeException) {
                throw ((RuntimeException) e);
            } else {
                throw new IOException("Unable to run script", e);
            }
        }
        return jp;
    }

    /**
     * For testing a string directly.
     * @param scriptBody
     * @param jobManagement
     * @return
     * @throws IOException
     */
    static Set runDslEngine(String scriptBody, JobManagement jobManagement) throws IOException {
        ScriptRequest scriptRequest = new ScriptRequest(null, scriptBody, new File(".").toURL() );
        return runDslEngine(scriptRequest, jobManagement);
    }

    public static Set runDslEngine(ScriptRequest scriptRequest, JobManagement jobManagement) throws IOException {
        JobParent jp = runDslEngineForParent(scriptRequest, jobManagement);
        LOGGER.log(Level.FINE, String.format("Ran script and got back %s", jp));

        Set generatedJobs = extractGeneratedJobs(jp, scriptRequest.ignoreExisting);

        scheduleJobsToRun(jp.getQueueToBuild(), jobManagement);

        return generatedJobs;
    }

    private static Set extractGeneratedJobs(JobParent jp, boolean ignoreExisting) {
        // Iterate jobs which were setup, save them, and convert to a serializable form
        Set generatedJobs = Sets.newLinkedHashSet();
        if (jp != null) {
            List refJobs = Lists.newArrayList(jp.getReferencedJobs()); // As List
            Collections.sort(refJobs, new Comparator() {
                // Sort by the job type, so that normal (Maven and Freeform) are done before Multijob
                @Override
                public int compare(Job o1, Job o2) {
                    return o1.getType().ordinal() - o2.getType().ordinal();
                }
            });
            for(Job job: refJobs) {
                try {
                    String xml = job.getXml();
                    LOGGER.log(Level.FINE, String.format("Saving job %s as %s", job.getName(), xml));
                    boolean created = jp.getJm().createOrUpdateConfig(job.getName(), xml, ignoreExisting);
                    GeneratedJob gj = new GeneratedJob(job.getTemplateName(), job.getName(), created);
                    generatedJobs.add(gj);
                } catch( Exception e) {  // org.xml.sax.SAXException, java.io.IOException
                    if (e instanceof RuntimeException) {
                        throw ((RuntimeException) e);
                    } else {
                        throw new RuntimeException(e);
                    }
                }
            }
        }
        return generatedJobs;
    }

    static void scheduleJobsToRun(List jobNames, JobManagement jobManagement) {
        Map exceptions = Maps.newHashMap();
        for(String jobName: jobNames) {
            try {
                jobManagement.queueJob(jobName);
            } catch(Exception e) {
                exceptions.put(jobName, e);
            }
        }
        if(!exceptions.isEmpty()) {
            LOGGER.warning("Trouble schedule some jobs");
            for(Map.Entry entry: exceptions.entrySet()) {
                LOGGER.throwing("DslScriptLoader", entry.getKey(), entry.getValue());
            }
        }
    }
    private static Binding createBinding(JobManagement jobManagement) {
        Binding binding = new Binding();
        binding.setVariable("out", jobManagement.getOutputStream() ); // Works for println, but not System.out

        Map params = jobManagement.getParameters();
        for(Map.Entry entry: params.entrySet()) {
            LOGGER.fine(String.format("Binding %s to %s", entry.getKey(), entry.getValue()));
            binding.setVariable(entry.getKey(), entry.getValue());
        }
        return binding;
    }

    private static CompilerConfiguration createCompilerConfiguration(JobManagement jobManagement) {
        CompilerConfiguration config = new CompilerConfiguration(CompilerConfiguration.DEFAULT);
        config.setScriptBaseClass("javaposse.jobdsl.dsl.JobParent");

        // Import some of our helper classes so that user doesn't have to.
        ImportCustomizer icz = new ImportCustomizer();
        icz.addImports("javaposse.jobdsl.dsl.helpers.Permissions");
        icz.addImports("javaposse.jobdsl.dsl.helpers.publisher.PublisherContext.Behavior");
        config.addCompilationCustomizers(icz);

        config.setOutput( new PrintWriter(jobManagement.getOutputStream())); // This seems to do nothing
        return config;
    }

}