jenkins_pipeline_builder 0.10.1 → 0.10.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OWM0OWI1ZDRjYjQxYWZmYThlYmIxZmY3ODhkNjA1ZDI3MTRhYzYyZA==
+    NjdkNzhhMGU3MGUyYmJhMWE4N2Y0MTJlZDFhZjNiNzg0NmQ0ZDA0Mw==
   data.tar.gz: !binary |-
-    YzUyNWQyM2NlOWJlMTEzZjQzMzM0ZTAwYzkzNzFlNWI2MDA5ZGEzMg==
+    MDdkYTU4ODk2OGU5MTU1MjMwN2ZhZDU3NjU3NWY2YzVhZmM0MDc5Ng==
 SHA512:
   metadata.gz: !binary |-
-    ZWU4ODMxYjA0YTMwNWVkODkyNjk2NDA1MjIwNTMxNjg3Yzg2NDY2NTU3M2Q4
-    ODU2MmQ1ZjJkMmRkMTNjOWQyYWY5YzI1MjY5Y2NhMzg5OWQ4NzEzMTUzZTBh
-    ODcwOGQ3N2E2MzFjNTIxYzQyZThjYmM3YzI3OGU0ZDdhZmJlYjc=
+    NGI2OGRjZDVkZGFiODU0YTlkYWFkZjFmYmNjY2QwZGZhN2MwZWJhOTQwYzQ3
+    MDBiNGZhYmQ1NmNmNTlkZjUzNWYyOTAwMjA1MDEzM2Q1YmIzOWRmZGNiMzNh
+    OTEzOTk5YjFkZDNkNjM4YjA2M2JiYzNjYWNkMjlkYWM5YmQyNzM=
   data.tar.gz: !binary |-
-    MjA1MTMwMTE3MjU1ZTZjNzlmZDMwZmY0Mzc1NzY0OTdjYWVlY2VkZGE3ODgz
-    NzcwMTY0ZGFmNDVlNWY5NGEwNjY2ZjZjZmMxMTk0Y2YyMWU3OGY5NTk2NTZi
-    OTdlYjIyMDdjNDA4NWMyYTgzMzhlZmFlOWRmYjAwNWY0ZjYwODg=
+    MjczZDM1N2IwNDZhNGQ0OGRkMzQwZTMwYjlmZDc3ZjdlZGVkZjYyYjZmZDkz
+    ZDEwODQzZjI3NjY4MDZhYmI4MWIwMGRkZTA5OWY3OTliNWMyNTE0M2Q0OWI1
+    ZGRkNDViM2RiYThkOGZmYjJjNTI0YjA0ZDEzMDgxYTg4YjcwMjI=

data/.gitignore

@@ -2,4 +2,5 @@
 out
 Gemfile.lock
 *.gem
-.DS_Store
+.DS_Store
+.idea

data/README.md

@@ -87,273 +87,7 @@ The pipeline builder now suppots json for config and pipeline files instead of o
 DSL:
 ----
 
-## Job DSL
-Here's a high level overview of what's available:
-
-```yaml
-- job:
-    name: nameStr # Name of your Job
-    job_type: free_style # Optional  [free_style|multi_project|job_dsl|build_flow|pull_request_generator]
-    concurrent_build: true or false
-    discard_old: # Discard old builds after:
-      days: 1 # Optional, number of days after which the build is deleted
-      number: 2 # Optional, number of builds after which the build is deleted
-      artifact_days: 3 # Optional, number of days after which the artifact is deleted
-      artifact_number: 4 # Optional, number of builds after which the artifact is deleted
-    throttle: # Optional, throttles concurrent jobs
-      max_per_node: int
-      max_total: int
-      option: category or alone
-      category: string # Only used if option == category
-    prepare_environment:
-        properties_content: string
-        keep_environment: true
-        keep_build: true
-    parameters:
-      - name: param_name
-        type: string
-        default: default value
-        description: text
-    scm_provider: git # See more info on Jenkins Api Client
-    scm_url: git@github.com:your_url_here
-    scm_branch: master
-    scm_params:
-      excluded_users: user
-      local_branch: branch_name
-      recursive_update: true
-      wipe_workspace: true
-      skip_tag: true # Optional, defaults to false
-      excluded_regions: region
-      included_regions: region
-    shell_command: '. commit_build.sh'
-    inject_env_vars_pre_scm:
-      file: '${PARENT_WORKSPACE}/{{shared_job_settings_file}}'
-    promoted_builds:
-      - 'Stage Promotion'
-      - 'Prod Promotion'
-    hipchat:
-      room: room name here
-      start-notify: true
-    priority: # Optional
-        use_priority: true # true OR false
-        job_priority: 1 # Default value is -1
-    builders:
-      - multi_job:
-          phases:
-            "Phase One":
-              jobs:
-                - name: first
-                  exposed_scm: true
-                  current_params: true
-                  config:
-                    predefined_build_parameters: |
-                      PARAM_NAME_1: PARAM_VALUE_1
-                      PARAM_NAME_2: PARAM_VALUE_2
-                - name: second
-              continue_condition: COMPLETED
-            "Phase Two":
-              jobs:
-                - name: third
-      - inject_vars_file: build_job_info
-      - shell_command: |
-          echo 'Doing some work'
-          run command1
-      - maven3:
-          goals: -B clean
-          rootPom: path_to_pom
-          mavenName: maven-name # Optional
-      - remote_job:
-          server: 'Name of Server' # Name of the Remote Jenkins Server
-          job_name: name_of_remote_build
-          blocking: true # Block current job until remote job finishes
-          polling_interval: 10 # Optional, number of seconds between polls, defaults to 10
-          continue_on_remote_failure: false
-          parameters: # Optional, if both are specified only the file is used
-            file: 'foo.prop'
-            content: |
-              VAR1 = value_1
-              VAR2 = value_2
-          credentials: # Optional, if you want to override the server credentials
-            type: api_token or none
-            username: name_of_user
-            api_token: APITOKEN
-      - blocking_downstream:
-          project: nameStr
-          data:
-            - params: |
-                param1
-                param2
-          trigger_with_no_parameters: false
-          # Below is Optional, values can be SUCCESS, FAILURE, UNSTABLE, never
-          fail: FAILURE # Fail this build step if the triggered build is worse or equal to
-          mark_fail: SUCCESS # Mark this build as failure if the triggered build is worse or equal to
-          mark_unstable: UNSTABLE # Mark this build as unstable if the triggered build is worse or equal to
-      - copy_artifact:
-          project: nameStr # Name of the project
-          artifacts: 'artifact.txt' # Selector for artifacts
-          target_directory: 'artifacts' # Where the artifacts should go, blank for Workspace root
-          filter: 'test=true' # String of filters, PARAM1=VALUE1,PARAM2=VALUE2, Optional
-          fingerprint: true # Optional, true or false, defaults to true
-          flatten: false # Optional, true or false, defaults to false
-          optional: false # Optional, true or false, defaults to false
-          selector: # Optional
-            type: status # Defaults to status, options: status, saved, triggered, permalink, specific, workspace, parameter
-            stable: true # Use if type = 'status', true or false
-            fallback: true # Use if type = 'triggered', true or false
-            id: lastBuild # Use if type = 'permalink', options: lastBuild, lastStableBuild, lastSuccessfulBuild, lastFailedBuild, lastUnstableBuild, lastUnsucceessfulBuild
-            number: '123' # Use if type = 'specific', the number of the build to use
-            param: 'BUILD_SELECTOR' # Use if type = 'parameter', the build parameter name
-    wrappers:
-      - timestamp: true
-      - ansicolor: true
-      - artifactory:
-          url: 'https://url.com/path'
-          artifactory-name: 'key'
-          release-repo: release
-          snapshot-repo: snapshot
-          publish: 'pkg/*.gem'
-          publish-build-info: true # Optional
-          properties: key=value;key2=value2,value2.1
-      - maven3artifactory:
-          url: https://artifactory.com/artifactory
-          artifactory-name: name
-          release-repo: release
-          snapshot-repo: snapshot
-          publish-build-info: true # Optional
-      - inject_env_var:
-          file: 'foo.prop'
-          content: |
-            VAR1 = value_1
-            VAR2 = value_2
-      - inject_passwords:
-        - name: pwd_name
-          value: some_encrypted_password
-      - rvm: "ruby-version@ruby-gemset"
-    publishers:
-      - junit_result:
-          test_results: 'out/**/*.xml'
-      - git:
-          push-merge: true
-          push-only-if-success: false
-      - hipchat:
-          jenkinsUrl: 'https://jenkins_url/'
-          authToken: 'auth_token'
-          room: 'room name'
-      - coverage_result:
-          report_dir: out/coverage/rcov
-          total:
-            healthy: 80
-            unhealthy: 0
-            unstable: 0
-          code:
-            healthy: 80
-            unhealthy: 0
-            unstable: 0
-      - description_setter:
-          regexp: See the build details at (.*)
-          description: 'Build Details: <a href="\1">\1</a>'
-      - downstream:
-          project: project_name
-          data:
-            - params: |
-                PARAM1=value1
-                PARAM2=value2
-            - file: promote-job-params
-      - archive_artifact:
-          artifacts: 'artifact.txt' #Artifact include string/pattern
-          exclude: '' # Optional, exclude string/pattern
-          latest_only: false # Optional, true or false, defaults to false
-          allow_empty: false # Optional, true or false, defaults to false
-      - email_notifications:
-          recipients: 'test@example.com' # Whitepace-delimited list of recipients
-          send_if_unstable: false # Optional, default to true
-          send_to_individuals: true # Optional, default to false
-      - sonar_result:
-          branch: 'sonar-results-branch-name'
-          maven_installation_name: 'name'
-    triggers:
-      - git_push: true
-      - scm_polling: 'H/5 * * * *'
-      - periodic_build: 'H/15 * * * *'
-      - upstream: # Trigger this build after another build has completed
-          projects: project-name-here
-          status: failed, unstable, stable # Optional, stable by default
-    build_flow: |
-      guard {
-        build("job_name1", param1: params["param1"]);
-      } rescue {
-        build("job_name2", param1: build21.environment.get("some_var"))
-      }
-```
-
-NOTE: The *promoted_builds* plugin is not fully implemented. This plugin just helps you point to the jobs that you have in order to promote your build.
-You need to manually create your promotion rules. Using this plugin will help you regenerate your jobs without breaking your manual promotion jobs.
-
-### Enable Blocks
-Blocks can be enabled and disabled like so:
-
-Project.yaml
-```yaml
-- defaults:
-    name: global
-    description: DB Pipeline tooling
-    git_repo: git@github.roving.com:devops/DBPipeline.git
-    git_branch: master
-    excluded_user: buildmaster
-    hipchat_room: CD Builds
-    hipchat_auth_token: f3e98ed54605b36f56dd2c562e3775
-    discard_days: '30'
-    discard_number: '100'
-    maven_name: 'tools-maven-3.0.3'
-    hipchat_jenkins_url: 'https://cd-jenkins.ad.prodcc.net/'
-
-- project:
-    name: 'PushTest'
-    hipchat_jenkins_url: 'https://cd-jenkins.ad.prodcc.net/'
-    jobs:
-        - '{{name}}-build':
-            use: true
-```
-
-build.yaml
-```yaml
-- job:
-    name: '{{name}}-build'
-    project_name: '{{name}}'
-    builders:
-        - maven3:
-              enabled: '{{use}}'
-              parameters:
-                  rootPom: one
-```
-
-If use is true, the params are applied to the maven3 block as seen
-below:
-
-build.yaml
-```yaml
-- job:
-    name: '{{name}}-build'
-    project_name: '{{name}}'
-    builders:
-        - maven3:
-            rootPom: one
-```
-
-The above two build.yaml files are equivalent (for use: true)
-
-The block needs to have both an enabled and parameters key, and no other
-keys for the enables to work.  Also note that this will fail:
-
-```yaml
-enabled: {{use}}
-```
-
-While this will work:
-
-```yaml
-enabled: '{{use}}'
-```
+Please see the [DSL Wiki Page](https://github.com/constantcontact/jenkins_pipeline_builder/wiki/DSL)
 
 ### Pull Request Generator
 

data/example/pipeline/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.2

data/example/pipeline/Example-Commit.yaml

@@ -0,0 +1,16 @@
+- job:
+    name: '{{name}}-Commit'
+    scm_url: '{{git_repo}}'
+    scm_provider: git
+    scm_params:
+        excluded_users: jenkins
+        local_branch: '{{git_branch}}'
+        recursive_update: true
+        wipe_workspace: true
+    builders:
+        - shell_command: |
+            sleep 1
+    wrappers:
+      - timestamp: true
+      - ansicolor: true
+      - rvm: '{{rvm}}'

data/example/pipeline/Example-Pipeline.yaml

@@ -0,0 +1,27 @@
+- job:
+    name: '{{name}}-Pipeline'
+    description: 'Pipeline'
+    job_type: multi_project
+    wrappers:
+        - timestamp: true
+        - ansicolor: true
+        - rvm: '{{rvm}}'
+    builders:
+        - multi_job:
+            phases:
+                Commit:
+                    jobs:
+                        - name: '{{name}}-Commit'
+                    continue_condition: SUCCESSFUL
+                Acceptance:
+                    jobs:
+                        - name: '{{name}}-Acceptance'
+                    continue_condiction: SUCCESSFUL
+                Upgrade:
+                    jobs:
+                        - name: '{{name}}-Upgrade'
+                    continue_condiction: SUCCESSFUL
+                Release:
+                    jobs:
+                        - name: '{{name}}-Release'
+                    continue_condiction: SUCCESSFUL

data/example/pipeline/Example-PipelineGenerator.yaml

@@ -0,0 +1,20 @@
+- job:
+    name: '{{name}}-PipelineGenerator'
+    description: 'Generator for jobs'
+    scm_provider: git
+    scm_url: '{{git_repo}}'
+    scm_branch: '{{git_branch}}'
+    publishers:
+        - downstream:
+            project: '{{name}}-Pipeline'
+            condition: SUCCESS
+    builders:
+      - shell_command: |
+          cd example/pipeline # Change if you use this example as a template
+          bundle -v || gem install bundler
+          bundle install
+          bundle exec generate pipeline bootstrap pipeline/
+    wrappers:
+        - timestamp: true
+        - ansicolor: true
+        - rvm: '{{rvm}}'

data/example/pipeline/Example-Release.yaml

@@ -0,0 +1,16 @@
+- job:
+    name: '{{name}}-Release'
+    scm_url: '{{git_repo}}'
+    scm_provider: git
+    scm_params:
+        excluded_users: jenkins
+        local_branch: '{{git_branch}}'
+        recursive_update: true
+        wipe_workspace: true
+    builders:
+        - shell_command: |
+            sleep 60
+    wrappers:
+        - timestamp: true
+        - ansicolor: true
+        - rvm: '{{rvm}}'

data/example/pipeline/Example-Upgrade.yaml

@@ -0,0 +1,16 @@
+- job:
+    name: '{{name}}-Upgrade'
+    scm_url: '{{git_repo}}'
+    scm_provider: git
+    scm_params:
+        excluded_users: jenkins
+        local_branch: '{{git_branch}}'
+        recursive_update: true
+        wipe_workspace: true
+    builders:
+        - shell_command: |
+            sleep 1
+    wrappers:
+        - timestamp: true
+        - ansicolor: true
+        - rvm: '{{rvm}}'

data/example/pipeline/project.yaml

@@ -0,0 +1,26 @@
+- dependencies:
+    - source:
+        url: 'https://github.com/constantcontact/jenkins_pipeline_builder/archive/master.tar.gz'
+        templates:
+            - name: generator-template
+              version: 1
+              template_root: 'example/templates' # To keep tempaltes in this repo, we specify a folder
+
+- defaults:
+    name: global
+    description: Example Pipeline
+    git_repo: git@github.com:constantcontact/jenkins_pipeline_builder.git
+    git_branch: master
+    discard_days: '30'
+    discard_number: '100'
+    rvm: '`cat pipeline/.ruby-version`'
+
+- project:
+    name: 'ExamplePipeline'
+    jobs:
+        - '{{name}}-PipelineGenerator'
+        - '{{name}}-Pipeline'
+        - '{{name}}-Commit'
+        - '{{name}}-Acceptance' # from template (see dependencies section)
+        - '{{name}}-Upgrade'
+        - '{{name}}-Release'

data/example/templates/job-template/1/Acceptance.yaml

@@ -0,0 +1,16 @@
+- job:
+    name: '{{name}}-Acceptance'
+    scm_url: '{{git_repo}}'
+    scm_provider: git
+    scm_params:
+        excluded_users: jenkins
+        local_branch: '{{git_branch}}'
+        recursive_update: true
+        wipe_workspace: true
+    builders:
+        - shell_command: |
+            sleep 1
+    wrappers:
+        - timestamp: true
+        - ansicolor: true
+        - rvm: '{{rvm}}'

data/lib/jenkins_pipeline_builder/generator.rb

@@ -75,7 +75,7 @@ module JenkinsPipelineBuilder
       if projects.any?
         errors = publish_project(project_name)
       else
-        errors = publish_jobs(jobs)
+        errors = publish_jobs(standalone jobs)
       end
       errors.each do |k, v|
         logger.error "Encountered errors compiling: #{k}:"
@@ -125,6 +125,17 @@ module JenkinsPipelineBuilder
 
     private
 
+    # Converts standalone jobs to the format that they have when loaded as part of a project.
+    # This addresses an issue where #pubish_jobs assumes that each job will be wrapped
+    # with in a hash a referenced under a key called :result, which is what happens when
+    # it is loaded as part of a project.
+    #
+    # @return An array of jobs
+    #
+    def standalone(jobs)
+      jobs.map! { |job| { result: job } }
+    end
+
     def purge_pull_request_jobs(pull)
       pull.purge.each do |purge_job|
         jobs = client.job.list "#{purge_job}.*"
@@ -155,7 +166,7 @@ module JenkinsPipelineBuilder
         job = @job_collection[job.to_s]
         pull_job = job if job[:value][:job_type] == 'pull_request_generator'
       end
-      fail 'No Pull Request Job Found for Project' unless pull_job
+      fail 'No jobs of type pull_request_generator found' unless pull_job
       pull_job
     end
 

data/lib/jenkins_pipeline_builder/version.rb

@@ -21,5 +21,5 @@
 #
 
 module JenkinsPipelineBuilder
-  VERSION = '0.10.1'
+  VERSION = '0.10.2'
 end

data/spec/lib/jenkins_pipeline_builder/generator_spec.rb

@@ -1,5 +1,11 @@
 require File.expand_path('../spec_helper', __FILE__)
 
+def cleanup_compiled_xml(job_name)
+  Dir["#{job_name}*.xml"].each do |file|
+    File.delete(file)
+  end
+end
+
 describe JenkinsPipelineBuilder::Generator do
   after :each do
     JenkinsPipelineBuilder.registry.clear_versions
@@ -71,38 +77,37 @@ describe JenkinsPipelineBuilder::Generator do
       allow(JenkinsPipelineBuilder.client).to receive(:plugin).and_return double(
         list_installed: { 'description' => '20.0', 'git' => '20.0' })
     end
-    it 'produces no errors while creating pipeline SamplePipeline with view' do
+
+    def bootstrap(fixture_path, job_name)
       @generator.debug = true
-      job_name = 'SamplePipeline'
-      path = File.expand_path('../fixtures/generator_tests/sample_pipeline', __FILE__)
-      errors = @generator.bootstrap(path, job_name)
-      expect(errors.empty?).to be true
-      Dir["#{job_name}*.xml"].each do |file|
-        File.delete(file)
-      end
+      errors = @generator.bootstrap(fixture_path, job_name)
+      cleanup_compiled_xml(job_name)
+      errors
+    end
+
+    def fixture_path(fixture)
+      File.expand_path("../fixtures/generator_tests/#{fixture}", __FILE__)
+    end
+
+    it 'produces no errors while creating pipeline SamplePipeline with view' do
+      errors = bootstrap(fixture_path('sample_pipeline'), 'SamplePipeline')
+      expect(errors).to be_empty
+    end
+
+    it 'produces no errors while creating a single job' do
+      errors = bootstrap(fixture_path('sample_pipeline/SamplePipeline-10-Commit.yaml'), 'SamplePipeline-10-Commit')
+      expect(errors).to be_empty
     end
 
     it 'produces no errors while creating pipeline TemplatePipeline' do
-      @generator.debug = true
-      job_name = 'TemplatePipeline'
-      path = File.expand_path('../fixtures/generator_tests/template_pipeline', __FILE__)
-      errors = @generator.bootstrap(path, job_name)
-      expect(errors.empty?).to be true
-      Dir["#{job_name}*.xml"].each do |file|
-        File.delete(file)
-      end
+      errors = bootstrap(fixture_path('template_pipeline'), 'TemplatePipeline')
+      expect(errors).to be_empty
     end
 
     it 'loads extensions in remote dependencies' do
-      @generator.debug = true
-      job_name = 'TemplatePipeline'
-      path = File.expand_path('../fixtures/generator_tests/template_pipeline', __FILE__)
-      errors = @generator.bootstrap(path, job_name)
-      expect(errors.empty?).to be true
+      errors = bootstrap(fixture_path('template_pipeline'), 'TemplatePipeline')
+      expect(errors).to be_empty
       expect(@generator.module_registry.registry[:job][:wrappers].keys).to include :test_wrapper
-      Dir["#{job_name}*.xml"].each do |file|
-        File.delete(file)
-      end
       @generator.module_registry.registry[:job][:wrappers].delete(:test_wrapper)
     end
     # Things to check for:
@@ -155,9 +160,7 @@ describe JenkinsPipelineBuilder::Generator do
       )
       success = @generator.pull_request(path, job_name)
       expect(success).to be_truthy
-      Dir["#{job_name}*.xml"].each do |file|
-        File.delete(file)
-      end
+      cleanup_compiled_xml(job_name)
     end
     # Things to check for
     # Fail - no PR job type found

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jenkins_pipeline_builder
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.10.2
 platform: ruby
 authors:
 - Igor Moochnick
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-07 00:00:00.000000000 Z
+date: 2015-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -333,6 +333,14 @@ files:
 - bin/generate
 - commit_build.sh
 - config/login.yml
+- example/pipeline/.ruby-version
+- example/pipeline/Example-Commit.yaml
+- example/pipeline/Example-Pipeline.yaml
+- example/pipeline/Example-PipelineGenerator.yaml
+- example/pipeline/Example-Release.yaml
+- example/pipeline/Example-Upgrade.yaml
+- example/pipeline/project.yaml
+- example/templates/job-template/1/Acceptance.yaml
 - jenkins_pipeline_builder.gemspec
 - lib/jenkins_pipeline_builder.rb
 - lib/jenkins_pipeline_builder/cli/base.rb