JobScriptsSpec.groovy

package com.dslexample

import com.dslexample.support.TestUtil
import hudson.model.Item
import hudson.model.View
import javaposse.jobdsl.dsl.DslScriptLoader
import javaposse.jobdsl.dsl.GeneratedItems
import javaposse.jobdsl.dsl.GeneratedJob
import javaposse.jobdsl.dsl.GeneratedView
import javaposse.jobdsl.dsl.JobManagement
import javaposse.jobdsl.plugin.JenkinsJobManagement
import jenkins.model.Jenkins
import org.junit.ClassRule
import org.jvnet.hudson.test.JenkinsRule
import spock.lang.Shared
import spock.lang.Specification
import spock.lang.Unroll

/**
 * Tests that all dsl scripts in the jobs directory will compile. All config.xml's are written to build/debug-xml.
 *
 * This runs against the jenkins test harness. Plugins providing auto-generated DSL must be added to the build dependencies.
 */
class JobScriptsSpec extends Specification {

  @Shared
  @ClassRule
  private JenkinsRule jenkinsRule = new JenkinsRule()

  @Shared
  private File outputDir = new File('./build/debug-xml')

  def setupSpec() {
    outputDir.deleteDir()
  }

  @Unroll
  void 'test script #file.name'(File file) {
    given:
    JobManagement jm = new JenkinsJobManagement(System.out, [:], new File('.'))
    // must run the folders script first for testing
    // String folders = new File('src/jobs/folders.groovy').text
    // new DslScriptLoader(jm).runScript(folders)
    // must run the folders script first for testing
    String folders = new File('src/jobs/folders.groovy').text
    new DslScriptLoader(jm).runScript(folders)

    when:
    GeneratedItems items = new DslScriptLoader(jm).runScript(file.text)
    writeItems(items, outputDir)

    then:
    noExceptionThrown()

    where:
    file << TestUtil.getJobFiles()
  }

  /**
   * Write the config.xml for each generated job and view to the build dir.
   */
  private void writeItems(GeneratedItems items, File outputDir) {
    Jenkins jenkins = jenkinsRule.jenkins
    items.jobs.each { GeneratedJob generatedJob ->
      String jobName = generatedJob.jobName
      Item item = jenkins.getItemByFullName(jobName)
      String text = new URL(jenkins.rootUrl + item.url + 'config.xml').text
      TestUtil.writeFile(new File(outputDir, 'jobs'), jobName, text)
    }

    items.views.each { GeneratedView generatedView ->
      String viewName = generatedView.name
      View view = jenkins.getView(viewName)
      String text = new URL(jenkins.rootUrl + view.url + 'config.xml').text
      TestUtil.writeFile(new File(outputDir, 'views'), viewName, text)
    }
  }
}