rubyjobbuilderdsl 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05072639c80e948ce5e1053b87ff7a258b5e58f5
-  data.tar.gz: bab165330d687fb8c1db43b5782b8eae7f6bee06
+  metadata.gz: a9ca43bb91affb15bc21bb6dcd6e5be58b932dd4
+  data.tar.gz: 04aba44512f2e06cfa04a3c1689a331c086f4b5c
 SHA512:
-  metadata.gz: befedbce30b57352b1a84c32e67826383f3efa835c92bd07d8c5052a0dbd96dd6cd88f88e9c0d277a34f7052785461419f1bcd1c1a3d9133cf49436077da6bad
-  data.tar.gz: 2d42861a395233ac4595d12ea5c02fd8528d01b1b300de844453d8ef434896a4886675d3ca92be54e0b52b01bd19ff7deb4f0fd6cf748a1b2b5195af417e86a3
+  metadata.gz: 5821b92c5e7885e546ad2d4ed8043db09ef9cfb8fa03c65d78ebcec889d5a5ca97972e2740b2dd4c7f3adb85782c2c9d0bf2b6693d5a3594968c30b6b54f93a3
+  data.tar.gz: 03007ca1e39ce387888488b084d863a4510f36dc22caea38c3a1555cce596ffc4447b3f6502e822e5e1dd7f5059400ee370705091f57df4fbe2229f69767dd76

data/Readme.md

@@ -0,0 +1,61 @@
+# Introduction
+
+The rubyjobbuilderdsl project lets you treat the configuration of your jenkins server jobs as software in its own right.
+
+You can store the configuration of your jenkins server in git so you can restore it anytime you like.
+
+In our experience continuous integration projects consists of the following kinds of things:
+
+* software build
+* software test
+* software deploy
+
+If you have well structured code the following will happen:
+
+1. all of the software build jobs will follow the same templates
+2. all of the software test jobs will be the same but specify a different group of tests
+3. all of the software deploys will be the same but specify a different target
+
+Rubyjobbuilderdsl will help you with this as you can specify each job type once.
+
+You can then use ruby to help you generate all the different jenkins jobs you need.
+We have done this using arrays or hashes that contain all the items we wish to build, test and deploy.
+By iterating over the arrays we can create all the jenkins jobs we require.
+
+At Wonga we used this to create many 100's if not 1000's of jobs in numerous jenkins servers and it gave us a level of control we never had before.
+
+# How does Rubyjobbuilderdsl work?
+
+if you look at any job in jenkins and add /config.xml to the url you will see the raw xml that defines the job.
+
+rubyjobbuilderdsl works with models and xml generators to generate this xml.
+
+If you post this xml to the jenkins api it lets you create and modify the jobs giving you control over your jobs.
+
+Each jenkins feature/addin has a section in this xml.
+rubyjobbuilderdsl has a model for each addin that we have used so far (more can be added as and when required)
+The xmlgenerator step converts the model to the xml.
+The xml from all of the models are combined together and then posted to the jenkins api to create the jenkins jobs.
+
+NOTE: if you want to add new features/add ins to rubyjobbuilderdsl you will need to extend it and tests to prove that it still works.
+
+# Index of rubyjobbuilderdsl functionality
+
+* [Common features](docs/common.md)
+* [flow based build jobs](docs/flow.md)
+* [freestyle build jobs](docs/freestyle.md)
+* [gerrit based build jobs](docs/gerrit.md)
+* [git based build jobs](docs/git.md)
+* [multi jobs - a job type that lets you link many jobs together](docs/multi.md)
+* [postbuild functionality](docs/postbuild.md)
+* [jenkins views](docs/view.md)
+
+# Is there a simple example to get me started?
+
+* [Overview](docs/overview.md)
+
+# 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/index.md

@@ -5,6 +5,7 @@
 * [FreeStyle](freestyle.md)
 * [Flow](flow.md)
 * [Multi](multi.md)
+* [Pipeline](pipeline.md)
 * [View](view.md)
 * [Gerrit](gerrit.md)
 * [Git](git.md)

data/docs/overview.md

@@ -34,7 +34,7 @@ Step 2 - Run it
 Step 3 - Create XML
 
 
-    sh-3.1$ bundle exec ruby hello_world.rb --xml --output-dir=.
+    sh-3.1$ bundle exec ruby hello-world.rb --xml --output-dir=.
     creating hello-world
     sh-3.1$ cat hello-world.xml
     <project>
@@ -64,7 +64,7 @@ Step 4 - Upload the created job to your Jenkins server
     user=jenkins-jobs
     password=7bb352e4f3da683c17247f3abf88f47c
 
-    sh-3.1$ bundle exec ruby hello_world.rb --deploy ----config-file=localhost.ini
+    sh-3.1$ bundle exec ruby hello-world.rb --deploy ----config-file=localhost.ini
     deploying hello-world
 
 ## References

data/docs/pipeline.md

@@ -0,0 +1,26 @@
+## Create pipeline style project
+
+Description: Create a pipeline job which can run a specified groovy script at a particular time
+
+Example
+
+    builder.pipeline 'Schedule-sample-pipeline' do
+        schedule '0 15 * * *'
+        groovy <<EOS
+
+    def date = new Date()
+    def release = date.format('yyyy.MM.dd')
+    def releaseManifest = release + ".0400"
+    println releaseManifest
+
+    build job: 'CreateRelease-gen3', 
+        parameters: [
+                string(name: 'OctopusServer', value: 'https://OctopusServerSomewhere.com'), 
+                string(name: 'OctopusKey', value: 'An API Key'), 
+                string(name: 'DeploySpecificPackages', value: 'false'), 
+                string(name: 'ReleaseNumber', value: '63'), 
+                string(name: 'ReleaseManifest', value: releaseManifest), 
+                string(name: 'Channel', value: 'Release Channel')]
+    EOS
+
+    end

data/lib/rubyjobbuilderdsl/builder.rb

@@ -1,5 +1,6 @@
 require_relative 'freestyle'
 require_relative 'flow'
+require_relative 'pipeline'
 require_relative 'multijob'
 require_relative 'view'
 require_relative 'xml_generator'
@@ -40,6 +41,16 @@ module JenkinsJob
       @jobs[name].instance_eval(&block)
     end
 
+    def pipeline(name, &block)
+      @jobs[name] = Pipeline.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)
 

data/lib/rubyjobbuilderdsl/pipeline.rb

@@ -0,0 +1,19 @@
+module JenkinsJob
+  class Pipeline < Common::Common
+    attr_reader :name, :groovy_ , :schedule_
+
+    def initialize(name, builder)
+      super(builder)
+      @name = name
+    end
+
+    def groovy(value)
+      @groovy_ = value
+    end
+
+    def schedule(value)
+      @schedule_ = value
+    end
+
+  end
+end

data/lib/rubyjobbuilderdsl/xml_generator.rb

@@ -11,6 +11,7 @@ module JenkinsJob
     GENERATOR_BY_CLASS = {
       FreeStyle => lambda { |generator, model, xml_node| generator.generate_freestyle(model, xml_node) },
       Flow => lambda { |generator, model, xml_node| generator.generate_flow(model, xml_node) },
+      Pipeline => lambda { |generator, model, xml_node| generator.generate_pipeline(model, xml_node) },
       MultiJob => lambda { |generator, model, xml_node| generator.generate_multi_job(model, xml_node) },
       View => lambda { |generator, model, xml_node| generator.generate_view(model, xml_node) },
       Common::Throttle => lambda { |generator, model, xml_node| generator.generate_throttle(model, xml_node) },
@@ -150,8 +151,34 @@ module JenkinsJob
     def generate_flow(model, root)
       result = root.tag!('com.cloudbees.plugins.flow.BuildFlow') do |project|
         project.buildNeedsWorkspace(true)
-        project.dsl(model.dsl_)
         generate_common(model, project)
+        project.dsl(model.dsl_)
+      end
+      result
+    end
+
+    def generate_pipeline(model, root)
+      result = root.tag!('flow-definition', :plugin => 'workflow-job@2.11') do |project|
+        project.actions
+        project.description
+        project.keepDependencies(false)
+        project.properties do |property|
+          property.tag!('org.jenkinsci.plugins.workflow.job.properties.PipelineTriggersJobProperty') do |stuff|
+            if model.schedule_
+              stuff.triggers do |hudsonTrigger|
+                hudsonTrigger.tag!('hudson.triggers.TimerTrigger') do |trigger|
+                  trigger.spec(model.schedule_) if model.schedule_
+                end
+              end
+            else
+              stuff.triggers
+            end
+          end
+        end
+        project.definition(:class => 'org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition', :plugin => 'workflow-cps@2.32') do |definition|
+          definition.script(model.groovy_)
+        end
+        project.disabled(false)
       end
       result
     end
@@ -689,6 +716,7 @@ module JenkinsJob
         cucumber.ignoreBadSteps(model.ignore_bad_tests_)
       end
     end
+
     def generate_logparser(model, publishers)
       publishers.tag!('hudson.plugins.logparser.LogParserPublisher') do |logparser|
         logparser.unstableOnWarning(model.unstable_on_warning_)

data/rubyjobbuilderdsl.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'rubyjobbuilderdsl'
-  s.version     = '0.0.2'
-  s.date        = '2015-11-25'
+  s.version     = '0.0.3'
+  s.date        = '2017-10-13'
   s.summary     = 'Ruby Internal DSL for creating Jenkins jobs'
   s.description = 'Ruby Internal DSL for creating Jenkins jobs'
   s.authors     = ['Huy Le']

data/sample/Schedule-sample-pipeline.xml

@@ -0,0 +1,28 @@
+<flow-definition plugin="workflow-job@2.11">
+  <actions/>
+  <description/>
+  <keepDependencies>false</keepDependencies>
+  <properties>
+    <org.jenkinsci.plugins.workflow.job.properties.PipelineTriggersJobProperty>
+      <triggers/>
+    </org.jenkinsci.plugins.workflow.job.properties.PipelineTriggersJobProperty>
+  </properties>
+  <definition class="org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition" plugin="workflow-cps@2.32">
+    <script>
+def date = new Date()
+def release = date.format('yyyy.MM.dd')
+def releaseManifest = release + ".0400"
+println releaseManifest
+
+build job: 'CreateRelease-gen3', 
+    parameters: [
+            string(name: 'OctopusServer', value: 'https://octopus.dev.oneviewhealthcare.com'), 
+            string(name: 'OctopusKey', value: 'API-9BSIB9H8ESGRLT0RX05QQNGE'), 
+            string(name: 'DeploySpecificPackages', value: 'false'), 
+            string(name: 'ReleaseNumber', value: '63'), 
+            string(name: 'ReleaseManifest', value: releaseManifest), 
+            string(name: 'Channel', value: 'Release Channel')]
+</script>
+  </definition>
+  <disabled>false</disabled>
+</flow-definition>

data/sample/local.ini

@@ -1,4 +1,4 @@
 [jenkins]
-url=http://172.30.255.24:8080/
-user=jonhurd
-password=muppet1
+url=http://localhost:8080/
+user=jenkins-jobs
+password=7bb352e4f3da683c17247f3abf88f47c

data/test/test_cucumber_json_publisher.rb

@@ -27,45 +27,4 @@ class TestCucumberPublisher < Test::Unit::TestCase
       assert_equal v, actual.xpath(path).text
     end
   end
-
-  def test_selenium_job
-
-    builder = JenkinsJob::Builder.new
-
-    builder.freestyle 'foo' do
-      node 'master'
-
-      parameter 'TEST_ENV' do
-        description 'The environment that the cucumber tests will be run against'
-        default 'PreRelease'
-      end
-   
-      git do
-        url 'git@github.com:ServiceFrame/webtests.git'
-        basedir 'webtests'
-        branches 'master'
-      end
-   
-      pollscm 'H/30 * * * *'
-   
-      xvfb do
-        install_name 'Xvfb'
-      end
-   
-      shell 'cd webtests && cucumber'
-
-      postbuild do
-        cucumber_json_publisher do
-          test_results 'cucumber/results.json'
-          ignore_bad_tests false
-        end
-      end
-  
-    end
-
-    actual = builder.config_as_xml_node('foo')
-
-    puts actual
-  end
 end
-