rubyjobbuilderdsl 0.0.4 → 0.0.5

data/docs/overview.md

@@ -1,74 +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
+## 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

@@ -1,266 +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
-
-
+## 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
+
+