rubyjobbuilderdsl 0.0.0

data/docs/overview.md

@@ -0,0 +1,74 @@
+## Overview
+
+The Openstack Job Builder python project use YAML as input for job creation. It is huge step from creating job using XML or even worse UI.
+However YAML has limitation lacking of both composition and abstraction causing repetitive work and maintenance issue . It may well suit for
+creating of dozen of jobs but not hundreds similar jobs. This is driving factor for creation of Ruby Job Builder DSL.
+
+Ruby Jobs Builder DSL is ruby internal DSL, so it offers full fledged programming experience at the same time concise, focused vocabulary
+for job creation.
+
+Ruby Jobs Builder DSL can
+
+* generate Jenkins XML job configuration files
+* deploy jobs directly into Jenkins Server
+
+## Example
+
+Step 1 - Create a ruby  file e.g. hello-world.rb with the following content
+
+    # hello-world.rb
+    require 'rubyjobbuilderdsl'
+    builder = JenkinsJob::Builder.new
+    builder.freestyle 'hello-world' do
+      shell 'echo hello world'
+    end
+    JenkinsJob::Deployer.new(builder).run
+
+
+Step 2 - Run it
+
+    $bundle exec ruby hello-world.rb
+    Usage:
+    hello-world.rb [--xml --output-dir=.|--deploy --config-file=localhost.ini]
+
+Step 3 - Create XML
+
+
+    sh-3.1$ bundle exec ruby hello_world.rb --xml --output-dir=.
+    creating hello-world
+    sh-3.1$ cat hello-world.xml
+    <project>
+      <actions/>
+      <description>&lt;!-- Managed by Jenkins Job Builder --&gt;</description>
+      <keepDependencies>false</keepDependencies>
+      <blockBuildWhenDownstreamBuilding>false</blockBuildWhenDownstreamBuilding>
+      <blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>
+      <concurrentBuild>false</concurrentBuild>
+      <canRoam>true</canRoam>
+      <properties/>
+      <scm class="hudson.scm.NullSCM"/>
+      <publishers/>
+      <buildWrappers/>
+      <builders>
+        <hudson.tasks.Shell>
+          <command>echo hello world</command>
+        </hudson.tasks.Shell>
+      </builders>
+    </project>
+
+Step 4 - Upload the created job to your Jenkins server
+
+    sh-3.1$ cat localhost.ini
+    [jenkins]
+    url=http://localhost:8080/
+    user=jenkins-jobs
+    password=7bb352e4f3da683c17247f3abf88f47c
+
+    sh-3.1$ bundle exec ruby hello_world.rb --deploy ----config-file=localhost.ini
+    deploying hello-world
+
+## References
+
+* http://ci.openstack.org/jenkins-job-builder/
+* https://github.com/jenkinsci/jenkins.rb
+* https://github.com/jenkinsci/job-dsl-plugin/wiki/Job-DSL-Commands

data/docs/postbuild.md

@@ -0,0 +1,266 @@
+## Configure post build activities
+
+**allow_broken_build_claiming**
+
+Description: Allow developer to claim for broken build
+
+Multiple: Override
+
+Example
+
+    builder.freestyle 'hello_world-build' do
+     postbuild do
+       allow_broken_build_claiming
+     end
+    end
+
+**archive**
+
+Description: Archive artifacts
+
+Multiple: Override
+
+Example
+
+    builder.freestyle 'hello_world-master' do
+      postbuild do
+        archive do
+          file 'package/**',
+             'output/**',
+             'dependencies/lib/**'
+          latest_only true
+        end
+      end
+    end
+
+**chucknorris**
+
+Description: Show Chuck Norris Image
+
+Multiple: Override
+
+Example
+
+    builder.freestyle 'hello_world-build' do
+      postbuild do
+        chucknorris
+      end
+    end
+
+**game**
+
+Description: Enable CI Game
+
+Multiple: Override
+
+Example
+
+    builder.freestyle 'hello_world-build' do
+      postbuild do
+        game
+      end
+    end
+
+**groovy**
+
+Description: Run groovy script
+
+Multiple: Override
+
+Example
+
+    builder.freestyle 'hello_world-build' do
+      postbuild do
+        groovy <<EOS
+    def logger = manager.listener.logger
+    logger.println("--- Hello World")
+    EOS
+      end
+    end
+
+**logparser**
+
+Description: Parse console log to highlight errors
+
+Multiple: Override
+
+Example
+
+    builder.freestyle 'hello_world-build' do
+      postbuild do
+        logparser '/var/lib/jenkins/build_parsing_rules' do
+          fail_on_error
+        end
+      end
+    end
+
+**pubish_pmd**
+
+Description: Publish PMD analysis
+
+Multiple: Override
+
+Example
+
+    builder.freestyle 'hello_world' do
+      postbuild do
+        publish_pmd do
+          pmd_results 'build/phppmd.txt'
+        end
+      end
+    end
+
+**publish_cloverphp**
+
+Description: Publish clover php analysis
+
+Multiple: Override
+
+Example
+
+    builder.freestyle 'hello_world' do
+      postbuild do
+        publish_cloverphp do
+          xml_location 'build/coverage_clover.xml'
+          html_report_dir 'build/coverage'
+          healthy_target :method => 70, :statement => 80
+        end
+      end
+    end
+
+**publish_html**
+
+Description: Publish html report
+
+Multiple: Override
+
+Example
+
+    builder.freestyle 'hello_world-servicetest' do
+      postbuild do
+        publish_html 'Test Report' do
+          dir '$BUILD_NUMBER\\Reports'
+          file 'test-report.html'
+          keep_all false
+          allow_missing true
+        end
+      end
+    end
+
+**publish_javadoc**
+
+Description: Publish javadoc
+
+Multiple: Override
+
+Example
+
+    builder.freestyle 'hello_world-build' do
+      postbuild do
+        publish_javadoc do
+          doc_dir 'build/doc'
+          keep_all
+        end
+       end
+    end
+
+**publish_nunit_report**
+
+Description: Publish NUnit test results.
+
+Multiple: Override
+
+Example
+
+    builder.freestyle 'hello_world-build' do
+      postbuild do
+        publish_nunit_report 'foo\\bar\\*.xml'
+      end
+    end
+
+**publish_tap**
+
+Description: Publish TAP test result
+
+Multiple: Override
+
+Example
+
+    builder.freestyle 'hello_world-build' do
+      postbuild do
+        publish_tap 'TestResultsInTapFormat.tap' do
+          verbose true
+          require_plan true
+        end
+      end
+    end
+
+**publish_xunit_report**
+
+Description: Publish XUnit test results
+
+Multiple: Override
+
+Example
+
+    builder.freestyle 'hello_world-build' do
+      postbuild do
+        publish_xunit_report 'foo\\bar\\*.xml' do
+          failed_threshold :total_failed_tests => 0, :new_failed_tests => 0
+          unstable_threshold :total_skipped_tests => 0, :new_skipped_tests => 0
+        end
+      end
+    end
+
+**send_email**
+
+Description: Send notification via email
+
+Multiple: Override
+
+Example
+
+    builder.freestyle 'hello_world-build' do
+      postbuild do
+        send_email 'test@example.com' do
+          notify_every_unstable_build false
+          send_to_individuals true
+        end
+      end
+    end
+
+**shell**
+
+Description: Run shell command in as a post build action
+
+Multiple: Override
+
+Example
+
+    builder.freestyle 'hello_world-build' do
+      postbuild do
+        shell 'cd Reports && mv $(ls *.xml) merge.xml'
+      end
+    end
+
+**trigger**
+
+Description: Trigger other job when this build succeeds
+
+Multiple: Override
+
+Example
+
+    builder.freestyle 'hello_world-build' do
+      postbuild do
+        trigger 'foo-build', 'bar-build' do
+          fail_on_missing true
+          current_parameters true
+          file 'env.properties'
+          predefined_parameters 'BUILD_NUM' => '${BUILD_NUMBER}',
+                                'PACKAGE_VERSION' => '${PACKAGE_VERSION}'
+        end
+      end
+    end
+
+

data/docs/view.md

@@ -0,0 +1,13 @@
+## Create view
+
+**view**
+
+Description: create a list view
+
+Multiple: Add
+
+Example
+
+    builder.view 'test' do
+      job 'test-.*'
+    end

data/lib/rubyjobbuilderdsl/builder.rb

@@ -0,0 +1,69 @@
+require_relative 'freestyle'
+require_relative 'flow'
+require_relative 'multijob'
+require_relative 'view'
+require_relative 'xml_generator'
+
+module JenkinsJob
+  # dsl methods for job builder
+  class Builder
+    attr_reader :jobs, :views
+
+    def initialize(&block)
+      @default_setting = []
+      @default_setting << block if block_given?
+      @jobs = {}
+      @views = {}
+    end
+
+    def add_extension(&block)
+      @default_setting << block if block_given?
+    end
+
+    def freestyle(name, &block)
+      @jobs[name] = FreeStyle.new(name, self)
+
+      @default_setting.each do |extension|
+        @jobs[name].instance_eval(&extension)
+      end
+
+      @jobs[name].instance_eval(&block)
+    end
+
+    def flow(name, &block)
+      @jobs[name] = Flow.new(name, self)
+
+      @default_setting.each do |extension|
+        @jobs[name].instance_eval(&extension)
+      end
+
+      @jobs[name].instance_eval(&block)
+    end
+
+    def multi(name, &block)
+      @jobs[name] = MultiJob.new(name, self)
+
+      @default_setting.each do |extension|
+        @jobs[name].instance_eval(&extension)
+      end
+
+      @jobs[name].instance_eval(&block)
+    end
+
+    def view(name, &block)
+      @views[name] = View.new(name, self)
+      @views[name].instance_eval(&block)
+    end
+
+    def generate_xml
+      return unless block_given?
+      generator = XmlGenerator.new
+      @jobs.each do |name, job|
+        yield name, generator.generate(job), :job
+      end
+      @views.each do |name, job|
+        yield name, generator.generate(job), :view
+      end
+    end
+  end
+end

data/lib/rubyjobbuilderdsl/buildstep/ant.rb

@@ -0,0 +1,29 @@
+module JenkinsJob
+  module BuildStep
+    class Ant < BasicObject
+      attr_reader :targets_, :buildfile_, :properties_, :java_opts_
+
+      def initialize
+        @targets_ = []
+        @properties_ = {}
+        @java_opts_ = []
+      end
+
+      def target(*value)
+        @targets_ = value
+      end
+
+      def buildfile(value)
+        @buildfile_ = value
+      end
+
+      def property(value)
+        @properties_ = value
+      end
+
+      def java_opts(*value)
+        @java_opts_ = value
+      end
+    end
+  end
+end

data/lib/rubyjobbuilderdsl/buildstep/copyartifact.rb

@@ -0,0 +1,23 @@
+module JenkinsJob
+  module BuildStep
+    class CopyArtifact < BasicObject
+      attr_reader :project_, :filter_, :target_, :build_number_
+
+      def initialize(artifact_job)
+        @project_ = artifact_job
+      end
+
+      def file(*files)
+        @filter_ = files.join(',')
+      end
+
+      def to(dir)
+        @target_ = dir
+      end
+
+      def build_number(value = nil)
+        @build_number_ = value
+      end
+    end
+  end
+end

data/lib/rubyjobbuilderdsl/buildstep/inject_env.rb

@@ -0,0 +1,18 @@
+module JenkinsJob
+  module BuildStep
+    class InjectEnv < BasicObject
+      attr_reader :properties_content_, :properties_file_
+
+      def initialize
+      end
+
+      def properties_content(value)
+        @properties_content_ = value
+      end
+
+      def properties_file(value)
+        @properties_file_ = value
+      end
+    end
+  end
+end

data/lib/rubyjobbuilderdsl/buildstep/phase.rb

@@ -0,0 +1,19 @@
+module JenkinsJob
+  module BuildStep
+    class Phase < BasicObject
+      attr_reader :name, :jobs_
+
+      def initialize(name)
+        @name = name
+        @jobs_ = []
+      end
+
+      def job(name, &block)
+        job = PhaseJob.new(name)
+        job.instance_eval(&block) if block
+
+        @jobs_ << job
+      end
+    end
+  end
+end

data/lib/rubyjobbuilderdsl/buildstep/phase_job.rb

@@ -0,0 +1,26 @@
+module JenkinsJob
+  module BuildStep
+    class PhaseJob < BasicObject
+      attr_reader :name, :ignore_result_, :retries_, :abort_others_
+
+      def initialize(name)
+        @name = name
+        @ignore_result_ = false
+        @retries_ = 0
+        @abort_others_ = false
+      end
+
+      def ignore_result(value = true)
+        @ignore_result_ = value
+      end
+
+      def retries(value)
+        @retries_ = value
+      end
+
+      def abort_others(value = true)
+        @abort_others_ = value
+      end
+    end
+  end
+end

data/lib/rubyjobbuilderdsl/buildstep/shell.rb

@@ -0,0 +1,24 @@
+module JenkinsJob
+  module BuildStep
+    class Shell < BasicObject
+      attr_reader :cmd_
+      def initialize(cmd)
+        @cmd_ = cmd
+      end
+    end
+
+    class Batch < BasicObject
+      attr_reader :cmd_
+      def initialize(cmd)
+        @cmd_ = cmd
+      end
+    end
+
+    class Powershell < BasicObject
+      attr_reader :cmd_
+      def initialize(cmd)
+        @cmd_ = cmd
+      end
+    end
+  end
+end

data/lib/rubyjobbuilderdsl/common/artifactory.rb

@@ -0,0 +1,33 @@
+module JenkinsJob
+  module Common
+    class Artifactory < BasicObject
+      attr_reader :server_, :repository_, :deploy_, :resolve_, :build_info_
+
+      def initialize
+        @deploy_ = []
+        @resolve_  = []
+        @build_info_  = false
+      end
+
+      def server(value)
+        @server_ = value
+      end
+
+      def repository(value)
+        @repository_ = value
+      end
+
+      def deploy(*value)
+        @deploy_ = value
+      end
+
+      def resolve(*value)
+        @resolve_ = value
+      end
+
+      def build_info(value = true)
+        @build_info_ = value
+      end
+    end
+  end
+end

data/lib/rubyjobbuilderdsl/common/blocking_job.rb

@@ -0,0 +1,11 @@
+module JenkinsJob
+  module Common
+    class BlockingJob < BasicObject
+      attr_reader :jobs_
+
+      def initialize(*value)
+        @jobs_  = value
+      end
+    end
+  end
+end

data/lib/rubyjobbuilderdsl/common/build_timeout.rb

@@ -0,0 +1,23 @@
+module JenkinsJob
+  module Common
+    class BuildTimeout < BasicObject
+      attr_reader :type_, :timeout_, :elastic_percentage_, :elastic_default_timeout_
+
+      def initialize(type)
+        @type_ = type
+      end
+
+      def timeout(value)
+        @timeout_ = value
+      end
+
+      def elastic_percentage(value)
+        @elastic_percentage_ = value
+      end
+
+      def elastic_default_timeout(value)
+        @elastic_default_timeout_ = value
+      end
+    end
+  end
+end

data/lib/rubyjobbuilderdsl/common/gerrit.rb

@@ -0,0 +1,53 @@
+module JenkinsJob
+  module Common
+    class Gerrit < BasicObject
+      attr_reader :change_merged_, :patchset_uploaded_, :comment_added_, :projects_
+
+      def initialize
+        @comment_added_ = []
+        @projects_ = []
+      end
+
+      def change_merged(value = true)
+        @change_merged_ = value
+      end
+
+      def patchset_uploaded(value = true)
+        @patchset_uploaded_ = value
+      end
+
+      def comment_added(param = {})
+        param.each do |k, v|
+          @comment_added_ << {
+            :approval_category => k,
+            :approval_value => v
+          }
+        end
+      end
+
+      def project(project, &block)
+        project = GerritProject.new(project)
+        project.instance_eval(&block)
+
+        @projects_ << project
+      end
+    end
+
+    class GerritProject < BasicObject
+      attr_reader :project_, :branches_, :files_
+
+      def initialize(project)
+        @project_ = project
+        @branches_ = ['**']
+      end
+
+      def branch(*value)
+        @branches_ = value
+      end
+
+      def file(*value)
+        @files_ = value
+      end
+    end
+  end
+end