rubyjobbuilderdsl 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eac6041f8878316fe6dc9b31efe8c10e7e9a5052
+  data.tar.gz: bb0098789a8d93682b6124dead0368e0c8562682
+SHA512:
+  metadata.gz: 0dfd698fdef592c9298c20d11fee0c067e7298e8c21d5bb4cae081d237158dd839876b9a38f83a7d63ee89e213e9f157ce1da5c98de124b1046189a343e60202
+  data.tar.gz: 6d4816f9cc97473da9369642618ba143d32fd575626aefbb1108b7dc98385116562dc27aced26436f22f2fa9f223e151e533d3d69d0503c2225e698b18e90a97

data/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+
+gem 'rubocop'
+gem 'builder'
+gem 'nokogiri'
+gem 'rake'

data/Gemfile.lock

@@ -0,0 +1,33 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
+    builder (3.2.2)
+    mini_portile (0.6.0)
+    nokogiri (1.6.3.1)
+      mini_portile (= 0.6.0)
+    parser (2.2.0.pre.4)
+      ast (>= 1.1, < 3.0)
+      slop (~> 3.4, >= 3.4.5)
+    powerpack (0.0.9)
+    rainbow (2.0.0)
+    rake (0.9.6)
+    rubocop (0.26.0)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.0.pre.4, < 3.0)
+      powerpack (~> 0.0.6)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.5.1)
+    slop (3.6.0)
+
+PLATFORMS
+  x86-mingw32
+
+DEPENDENCIES
+  builder
+  nokogiri
+  rake
+  rubocop

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2014 Wonga
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+
+RuboCop::RakeTask.new
+
+task :default => [:rubocop, :test]

data/docs/common.md

@@ -0,0 +1,313 @@
+## Common vocabulary
+
+Common keywords are applicable for both freestyle job and flow job.
+
+**artifactory**
+
+Description: Deploy artifacts to jfrog artifactory server
+
+Multiple: Override
+
+Example
+
+    builder.freestyle 'hello_world-build' do
+      artifactory do
+        server 'artifactory.acme.com'
+        repository 'dev'
+        deploy 'hello_world-1.0.$BUILD_NUMBER.zip'
+      end
+    end
+
+**blocked_by**
+
+Description: Block build if certain specified jobs are running
+
+Multiple: Add
+
+Example
+
+    builder.freestyle 'hello_world-deploy' do
+      blocked_by 'hello_world-sevicetest'
+    end
+
+**Builder**
+
+Description: We create builder instance that will be used later to build jobs
+
+Multiple: N/A
+
+Example
+
+    require 'rubyjobbuilderdsl'
+    builder = JenkinsJob::Builder.new
+
+**concurrent**
+
+Description: Specify condition for multiple builds of the same job to run concurrently across all nodes of the same category
+
+Multiple: Override
+
+Example
+
+    builder.freestyle 'hello_world-servicetest' do
+      concurrent do
+        max_per_node 1
+        max_total 0
+        category 'servicetest'
+      end
+    end
+
+**concurrent**
+
+Description: Specify condition for multiple builds of the same job to run concurrently across all nodes of the same project
+
+Multiple: Override
+
+Example
+
+    builder.freestyle 'hello_world-build' do
+      concurrent do
+        max_per_node 2
+        max_total 0
+      end
+    end
+
+**Deployer**
+
+Description: We create deployer instance that will be used to generate/deploy jobs config
+
+Multiple: N/A
+
+Example
+
+    require 'rubyjobbuilderdsl'
+    check_builder = JenkinsJob::Builder.new
+    worker_builder = JenkinsJob::Builder.new
+    JenkinsJob::Deployer.new(check_builder, worker_builder).run
+
+
+**Desc**
+
+Description: Specify project's description
+
+Multiple: Override
+
+Example
+
+    builder.freestyle 'hello_world-build' do
+      desc 'this is a hello world project'
+    end
+
+**flow**
+
+Description: Add Create a flow job
+
+Multiple: Add
+
+Example
+
+    builder.flow 'hello_world-check' do
+    end
+
+**freestyle**
+
+Description: Add Create a freestyle job
+
+Multiple: Add
+
+Example
+
+    builder.freestyle 'hello_world-build' do
+    end
+
+**gerrit**
+
+Description: trigger the job on Gerrit event
+
+Multiple: Override
+
+Example
+
+    builder.flow 'hello_world-post' do
+      gerrit do
+      end
+    end
+
+
+**git**
+
+Description: Configure Git version as SCM
+
+Multiple: Override
+
+Example:
+
+    builder.freestyle 'hello_world-master' do
+      git do
+      end
+    end
+
+**logrotate**
+
+Description: Rotate/discard old builds
+
+Multiple: Override
+
+Example:
+
+    builder.freestyle 'hello_world-master' do
+      logrotate do
+        days_to_keep 14
+        num_to_keep -1
+        artifact_days_to_keep 2
+        artifact_num_to_keep -1
+      end
+    end
+
+**node**
+
+Description: Run a job on specific node or kind of nodes
+
+Multiple: Override
+
+Example:
+
+    builder.freestyle 'hello_world-build' do
+      node 'windows'
+    end
+
+**parameter**
+
+Description: Create parameter for a job
+
+Multiple: Add
+
+Example:
+
+    builder.freestyle 'hello_world-check' do
+      parameter 'GERRIT_BRANCH' do
+        default 'master'
+      end
+      parameter 'GERRIT_REFSPEC' do
+        default 'refs/heads/${GERRIT_BRANCH}'
+      end
+    end
+
+**password**
+
+Description: Specify password encrypted by jenkins, that is decrypted when being retrieved via environment variable
+
+Multiple: Override
+
+Example:
+
+    builder.freestyle 'hello_world-deploy' do
+      password 'ADMIN', 'PhxHFCjgSiXR2umXhALLq+RzqJBxODDJT4t9Tw5JXbI='
+    end
+
+**password_parameter**
+
+Description: Create a parameter for password for a job
+
+Multiple: Add
+
+Example:
+
+    builder.freestyle 'hello_world-check' do
+      password_parameter 'PASS' do
+        default 'xyz#'
+      end
+    end
+
+**pollscm**
+
+Description: Specify SCM polling frequency in crontab format
+
+Multiple: Override
+
+Example:
+
+    builder.freestyle 'hello_world-master' do
+      pollscm '*/5 * * * *'
+    end
+
+**postbuild**
+
+Description: Create post build actions freestyle/flow
+
+Multiple: Merged
+
+Example:
+
+    builder.freestyle 'hello_world-master' do
+      postbuild do
+      end
+    end
+
+**quiet_period**
+
+Description: Wait a specified period in seconds before running freestyle/flow
+
+Multiple: Override
+
+Example:
+
+    builder.freestyle 'hello_world-build' do
+      quiet_period 5
+    end
+
+**scms**
+
+Description: Configure multiple SCM's
+
+Multiple: Override
+
+Example:
+
+    builder.freestyle 'hello_world-master' do
+      scms do
+        git do
+        end
+        git do
+        end
+      end
+    end
+
+**timed**
+
+Description: Specify frequency to run a build in crontab format  freestyle/flow
+
+Multiple: Override
+
+Example:
+
+    builder.freestyle 'hello_world-master' do
+      timed '*/5 * * * *'
+    end
+
+**timeout**
+
+Description: Specify elastic timeout as percentage of last 3 successful builds or absolute value in minutes if they are not available
+
+Multiple: Override
+
+Example:
+
+    builder.freestyle 'hello_world-build' do
+      timeout 'elastic' do
+        elastic_percentage 200
+        elastic_default_timeout 30
+      end
+    end
+
+**timestamps**
+
+Description: Show time stamp for build's console log
+
+Multiple: Override
+
+Example:
+
+    builder.freestyle 'hello_world-build' do
+      timestamps
+    end

data/docs/flow.md

@@ -0,0 +1,18 @@
+## Create build flow style project
+
+**dsl**
+
+Description: Specify groovy DSL for a flow job
+
+Multiple: Override
+
+Example
+
+    builder.flow 'hello_world-post' do
+      dsl <<EOS
+    build("hello_worl-" + params["GERRIT_BRANCH"],
+     GERRIT_REFSPEC: "refs/heads/${params["GERRIT_BRANCH"]}",
+     GERRIT_BRANCH: params["GERRIT_BRANCH"])
+    EOS
+
+    end

data/docs/freestyle.md

@@ -0,0 +1,100 @@
+## Create free style project
+
+**ant**
+
+Description: Run ant task
+
+Multiple: Add
+
+Example
+
+    builder.freestyle 'hello_world-build' do
+      ant do
+        target 'clean', 'lint'
+        buildfile 'nightly.xml'
+        java_opts '-Xmx512m', '-Xms512m'
+        property 'skipTest' => 'false'
+      end
+    end
+
+**batch**
+
+Description: Run batch command
+
+Multiple: Add
+
+Example
+
+    builder.freestyle 'hello_world-master' do
+      batch 'sc.exe query'
+    end
+
+**copyartifact**
+
+Description: Copy artifact from other build
+
+Multiple: Add
+
+Example
+
+    builder.freestyle 'hello_world-servicetest' do
+      copyartifact '$ARTIFACT_JOB' do
+        build_number '$ARTIFACT_BUILD_NUMBER'
+        file 'package/**',
+             'output/**'
+        to '$BUILD_NUMBER'
+      end
+    end
+
+**inject_env**
+
+Description: Create environment variable that persists in the build
+
+Multiple: Add
+
+Example
+
+    builder.freestyle 'hello_world-build' do
+      inject_env do
+        properties_content 'EXAMPLE=foo'
+        properties_file 'env.prop'
+      end
+    end
+
+**powershell**
+
+Description: Run Powershell command
+
+Multiple: Add
+
+Example
+
+    builder.freestyle 'hello_world-master' do
+      powershell 'Get-Service MSQL* | foreach { sc.exe stop $_.Name }'
+    end
+
+**shell**
+
+Description: Run shell command
+
+Multiple: Add
+
+Example
+
+    builder.freestyle 'ops-master' do
+      shell 'rm -rf * || true'
+    end
+
+**workspace**
+
+Description: Set custom workspace for job
+
+Multiple:  Override
+
+Example
+
+    builder.freestyle 'ops-master' do
+      workspace 'ops-m'
+    end
+
+

data/docs/gerrit.md

@@ -0,0 +1,70 @@
+## Configure job to act on gerrit event
+
+**change_merged**
+
+Description: trigger the job on Gerrit change_merged event
+
+Multiple: Override
+
+Example
+
+    builder.flow 'hello_world-post' do
+      gerrit do
+        change_merged
+        project 'hello_world' do
+          branch 'master','release'
+        end
+      end
+    end
+
+**comment_added**
+
+Description: trigger the job on Gerrit comment_added event
+
+Multiple: Override
+
+Example
+
+    builder.flow 'hello_world-gate' do
+      gerrit do
+        comment_added 'Code-Review' => '2'
+        project 'hello_world' do
+          branch 'master','release'
+        end
+      end
+    end
+
+**patchset_uploaded**
+
+Description: trigger the job on Gerrit patchset_uploaded event
+
+Multiple: Override
+
+Example
+
+    builder.flow 'hello_world-build' do
+      gerrit do
+        patchset_uploaded
+        project 'hello_world' do
+          branch 'master','release'
+        end
+      end
+    end
+
+**project**
+
+Description: Specify a Gerrit event filter that trigger the job
+
+Multiple: Override
+
+Example
+
+    builder.flow 'salesforce-post' do
+      gerrit do
+        project 'poland/technicalcomponents' do
+          branch 'master','release'
+          file 'src/Salesforce/**',
+               'src/Db/Salesforce/**'
+        end
+      end
+    end

data/docs/git.md

@@ -0,0 +1,88 @@
+## Configure Git SCM
+
+**git**
+
+Description: Configure Git version as SCM
+
+Multiple: Override
+
+Example
+
+    builder.freestyle 'hello_world-master' do
+      git do
+        url 'ssh://builduser@gerrit.acme.com:29418/hello_world'
+        basedir 'hello_world'
+        reference_repo '$HOME/hello_world.git'
+        branches '$GERRIT_BRANCH'
+        refspec '$GERRIT_REFSPEC'
+        choosing_strategy 'gerrit'
+        git_config_name 'foo'
+        git_config_email 'foo@acme.com'
+      end
+    end
+
+**jgit**
+
+Description: Configure Git version as SCM using jgit. Credentials must be created with the specified id using groovy script
+
+Multiple: Override
+
+Example
+
+    builder.freestyle 'hello_world-master' do
+      git do
+        url 'ssh://builduser@gerrit.acme.com:29418/hello_world'
+        basedir 'hello_world'
+        reference_repo '$HOME/hello_world.git'
+        branches '$GERRIT_BRANCH'
+        refspec '$GERRIT_REFSPEC'
+        choosing_strategy 'gerrit'
+        git_config_name 'foo'
+        git_config_email 'foo@acme.com'
+        jgit
+        credentials 'foo'
+      end
+    end
+
+Example of creating credentials
+
+    import jenkins.model.*
+    import hudson.plugins.sshslaves.*
+    import com.cloudbees.plugins.credentials.*
+    import com.cloudbees.plugins.credentials.common.*
+    import com.cloudbees.plugins.credentials.domains.*
+    import com.cloudbees.jenkins.plugins.sshcredentials.impl.*
+
+    domain = Domain.global()
+    store = Jenkins.instance.getExtensionList(
+      'com.cloudbees.plugins.credentials.SystemCredentialsProvider'
+    )[0].getStore()
+
+    username = credentialsId = 'foo'
+    passphrase = description = null
+
+    privateKey = """
+    -----BEGIN RSA PRIVATE KEY-----
+    MIIEoQIBAAKCAQEAyTsKNPUc4GkfZjNlLmLpuS+wecpCQOJs7MubPoNGk5F0cK4Q
+    ...
+    -----END RSA PRIVATE KEY-----
+    """
+
+    credentials = new BasicSSHUserPrivateKey(
+      CredentialsScope.GLOBAL,
+      credentialsId,
+      username,
+      new BasicSSHUserPrivateKey.DirectEntryPrivateKeySource(privateKey),
+      passphrase,
+      description
+    )
+
+    existing = store.getCredentials(domain).find { it.id == credentialsId }
+    if (existing) {
+      println "removing ${credentialsId}"
+      store.removeCredentials(domain, existing)
+    }
+
+    println "adding ${credentialsId}"
+    store.addCredentials(domain, credentials)
+

data/docs/index.md

@@ -0,0 +1,11 @@
+## Ruby Job Builder DSL
+
+* [Overview](overview.md)
+* [Common](common.md)
+* [FreeStyle](freestyle.md)
+* [Flow](flow.md)
+* [Multi](multi.md)
+* [View](view.md)
+* [Gerrit](gerrit.md)
+* [Git](git.md)
+* [Postbuild](postbuild.md)

data/docs/multi.md

@@ -0,0 +1,27 @@
+## Create multi job project
+
+**phase**
+
+Description: Run a job phase. Phases are executed sequentially, however jobs within a phase run in parallel.
+
+Multiple: Add
+
+Example
+
+    builder.multi 'hello_world-deploy' do
+      phase 'hello_world-db-deploy' do
+        job 'foo-db'
+
+        job 'bar-db' do
+          ignore_result true
+        end
+      end
+
+      phase 'hello_world-service-deploy' do
+        job 'foo-service' do
+          retries 1
+          abort_others false
+        end
+        job 'bar-service'
+      end
+    end