jenkins_pipeline_builder 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ca15662c8969eb3344f177fcb31ab60d00d6b22
-  data.tar.gz: 8f65fdb0f74e18c8f301db3d7002fe842ca9f972
+  metadata.gz: 9cc9e61ea35987e7d0f6d0504fb55378c755df1b
+  data.tar.gz: c74fa0ad124aa3a4b41b941593836846cb608437
 SHA512:
-  metadata.gz: 439d16077649cd6bcf6ab257c59ff1fe4703275a9eb25bbc43b4579ec867e579230761edbb30ef14420f32ab2bc4d0063e5c4e02555e000569242c83cb70dedd
-  data.tar.gz: 8f8f450ac270775f331038742d3c7390ae521339a4ef846197c1c8110a124f5d7e14565c5b2d2f959b39e9881d104a2a563ea895ba74371b135613167d89066a
+  metadata.gz: 59cf44be2dff1d951273e2a026708cb354bfcb6581daa164b64c058593d7add78b8c7a6a34253272019c2886fbd664ce2545bf3bd2e371fd7c44c6769b4dcd7b
+  data.tar.gz: e86d64a7cae810430373278a39990c3046e2c247f2af2c5c8c887f51073c322974cb529f779643c30cf772d00024e1735bb57cdadfd940e282fc1891ff71d4e9

data/README.md

@@ -4,15 +4,20 @@ jenkins-pipeline-builder
 YAML driven CI Jenkins Pipeline Builder enabling to version your artifact pipelines alongside with the artifact source itself.
 
 
-# JenkinsPipeline::Generator
+# Background
+
+This project is inspired by a great work done by Arangamani with [jenkins_api_client](https://github.com/arangamani/jenkins_api_client) and
+amazing progress done by the Open Stack community with their [jenkins-job-builder](http://ci.openstack.org/jenkins-job-builder/)
 
-TODO: Write a gem description
+The YAML structure very closely resembles the OpenStack Job Builder, but, in comparison to Python version, is 100%
+pure Ruby and uses Jenkins API Client and has additional functionlity of building different types of Jenkins views.
 
-This is how you can bootstrap a pipeline:
+# JenkinsPipeline::Generator
 
-    generate pipeline -d -c config/login.yml bootstrap ./pipeline-archetype
+USAGE:
+------
 
-## Installation
+### Installation
 
 Add this line to your application's Gemfile:
 
@@ -30,17 +35,43 @@ Or install it yourself as:
     [optional] brew link libxml2 libxslt
     gem install nokogiri
 
-## Usage
+### Authentication
+
+For more info see [jenkins_api_client](https://github.com/arangamani/jenkins_api_client).
+Supplying credentials to the client is optional, as not all Jenkins instances
+require authentication. This project supports two types of password-based
+authentication. You can just you the plain password by using <tt>password</tt>
+parameter. If you don't prefer leaving plain passwords in the credentials file,
+you can encode your password in base64 format and use <tt>password_base64</tt>
+parameter to specify the password either in the arguments or in the credentials
+file. To use the client without credentials, just leave out the
+<tt>username</tt> and <tt>password</tt> parameters. The <tt>password</tt>
+parameter is only required if <tt>username</tt> is specified.
+
+#### Using with Open ID
+
+For more info see [jenkins_api_client](https://github.com/arangamani/jenkins_api_client).
+It is very simple to authenticate with your Jenkins server that has Open ID
+authentication enabled. You will have to obtain your API token and use the API
+token as the password. For obtaining the API token, go to your user configuration
+page and click 'Show API Token'. Use this token for the `password` parameter when
+initializing the client.
+
+### Basic usage
+
+Create all your Job description files in a folder (Ex.: ./pipeline). Follow the Job/View/Project DSL.
+Try to extract the reusable values out of jobs into the project.
 
-TODO: Write usage instructions here
+Put the right information about the location of your Jenkins server and the appropriate credentials
+in a config file (ex: config.login.yml)
 
-## Contributing
+Now you ready to bootstrap a pipeline:
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+    generate pipeline -d -c config/login.yml bootstrap ./pipeline
+
+
+DSL:
+----
 
 ## Job DSL
 Here's a high level overview of what's available:
@@ -134,3 +165,60 @@ Here's a high level overview of what's available:
         build("job_name2", param1: build21.environment.get("some_var"))
       }
 ```
+
+### View DSL
+```yaml
+- view:
+    name: 'view name'
+    type: 'listview' # Optional: listview [default], myview, nestedView, categorizedView, dashboardView, multijobView
+    description: 'description'
+    regex: '.*'
+    groupingRules:
+      - groupRegex: "1.*"
+        namingRule: "sub view"
+```
+
+### Project DSL
+```yaml
+- project:
+    name: Your project name
+    jobs:
+      - Job1
+      - Job2
+          param1: value1
+      - JobTemplate1
+```
+
+### Default Settings Section
+
+The defaults section mimics behavior of [jenkins-job-builder Defaults](http://ci.openstack.org/jenkins-job-builder/configuration.html#defaults)
+If a set of Defaults is specified with the name global, that will be used by all Job (and Job Template) definitions.
+
+```yaml
+- defaults:
+    name: global
+    param1: 'value 1'
+```
+
+
+CONTRIBUTING:
+----------------
+
+If you would like to contribute to this project, just do the following:
+
+1. Fork the repo on Github.
+2. Add your features and make commits to your forked repo.
+3. Make a pull request to this repo.
+4. Review will be done and changes will be requested.
+5. Once changes are done or no changes are required, pull request will be merged.
+6. The next release will have your changes in it.
+
+Please take a look at the issues page if you want to get started.
+
+FEATURE REQUEST:
+----------------
+
+If you use this gem for your project and you think it would be nice to have a
+particular feature that is presently not implemented, I would love to hear that
+and consider working on it. Just open an issue in Github as a feature request.
+

data/bin/generate

@@ -23,6 +23,6 @@
 #!/usr/bin/env ruby
 
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
-require 'jenksin_pipeline_builder'
+require 'jenkins_pipeline_builder'
 JenkinsPipelineBuilder::CLI::Base.start
 

data/commit_build.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+bundle --version || gem install bundler --no-ri --no-rdoc
+bundle install
+rm -f *.gem
+bundle exec rake spec || exit $?
+bundle exec gem build jenkins_pipeline_builder.gemspec || exit $?
+bundle exec gem bump

data/jenkins_pipeline_builder.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'jenksin_pipeline_builder/version'
+require 'jenkins_pipeline_builder/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'jenkins_pipeline_builder'

data/lib/{jenksin_pipeline_builder.rb → jenkins_pipeline_builder.rb}

@@ -20,20 +20,20 @@
 # THE SOFTWARE.
 #
 
-require 'jenksin_pipeline_builder/version'
-require 'jenksin_pipeline_builder/utils'
-require 'jenksin_pipeline_builder/xml_helper'
-require 'jenksin_pipeline_builder/compiler'
-require 'jenksin_pipeline_builder/job_builder'
-require 'jenksin_pipeline_builder/module_registry'
-require 'jenksin_pipeline_builder/builders'
-require 'jenksin_pipeline_builder/wrappers'
-require 'jenksin_pipeline_builder/triggers'
-require 'jenksin_pipeline_builder/publishers'
-require 'jenksin_pipeline_builder/view'
-require 'jenksin_pipeline_builder/generator'
+require 'jenkins_pipeline_builder/version'
+require 'jenkins_pipeline_builder/utils'
+require 'jenkins_pipeline_builder/xml_helper'
+require 'jenkins_pipeline_builder/compiler'
+require 'jenkins_pipeline_builder/job_builder'
+require 'jenkins_pipeline_builder/module_registry'
+require 'jenkins_pipeline_builder/builders'
+require 'jenkins_pipeline_builder/wrappers'
+require 'jenkins_pipeline_builder/triggers'
+require 'jenkins_pipeline_builder/publishers'
+require 'jenkins_pipeline_builder/view'
+require 'jenkins_pipeline_builder/generator'
 
-require 'jenksin_pipeline_builder/cli/helper'
-require 'jenksin_pipeline_builder/cli/view'
-require 'jenksin_pipeline_builder/cli/pipeline'
-require 'jenksin_pipeline_builder/cli/base'
+require 'jenkins_pipeline_builder/cli/helper'
+require 'jenkins_pipeline_builder/cli/view'
+require 'jenkins_pipeline_builder/cli/pipeline'
+require 'jenkins_pipeline_builder/cli/base'

data/lib/{jenksin_pipeline_builder → jenkins_pipeline_builder}/cli/helper.rb

@@ -41,8 +41,9 @@ module JenkinsPipelineBuilder
           creds = options
         elsif options[:creds_file]
           creds = YAML.load_file(
+              File.expand_path(options[:creds_file])
               #File.expand_path(options[:creds_file], __FILE__)
-              options[:creds_file]
+              #options[:creds_file]
           )
         elsif File.exist?("#{ENV['HOME']}/.jenkins_api_client/login.yml")
           creds = YAML.load_file(

data/lib/{jenksin_pipeline_builder → jenkins_pipeline_builder}/generator.rb

@@ -110,7 +110,7 @@ module JenkinsPipelineBuilder
     def load_collection_from_path(path, recursively = false)
       if File.directory?(path)
         @logger.info "Generating from folder #{path}"
-        Dir.glob(File.join(path, '/*.yaml')).each do |file|
+        Dir[File.join(path, '/*.yaml'), File.join(path, '/*.yml')].each do |file|
           if File.directory?(file)
             if recursively
               load_collection_from_path(File.join(path, file), recursively)
@@ -194,30 +194,46 @@ module JenkinsPipelineBuilder
       return result
     end
 
+    def jobs
+      result = []
+      @job_collection.values.each do |item|
+        result << item if item[:type] == :job
+      end
+      return result
+    end
+
     def bootstrap(path)
       @logger.info "Bootstrapping pipeline from path #{path}"
       load_collection_from_path(path)
 
-      projects.each do |project|
-        compiled_project = resolve_project(project)
-        pp compiled_project
-
-        if compiled_project[:value][:jobs]
-          compiled_project[:value][:jobs].each do |i|
-            job = i[:result]
-            xml = compile_job_to_xml(job)
-            create_or_update(job, xml)
-          end
+      # Publish all the jobs if the projects are not found
+      if projects.count == 0
+        jobs.each do |i|
+          job = i[:value]
+          xml = compile_job_to_xml(job)
+          create_or_update(job, xml)
         end
+      else
+        projects.each do |project|
+          compiled_project = resolve_project(project)
+          #pp compiled_project
+
+          if compiled_project[:value][:jobs]
+            compiled_project[:value][:jobs].each do |i|
+              job = i[:result]
+              xml = compile_job_to_xml(job)
+              create_or_update(job, xml)
+            end
+          end
 
-        if compiled_project[:value][:views]
-          compiled_project[:value][:views].each do |v|
-            _view = v[:result]
-            view.create(_view)
+          if compiled_project[:value][:views]
+            compiled_project[:value][:views].each do |v|
+              _view = v[:result]
+              view.create(_view)
+            end
           end
         end
       end
-
     end
 
     def dump(job_name)

data/lib/{jenksin_pipeline_builder → jenkins_pipeline_builder}/version.rb

@@ -21,5 +21,5 @@
 #
 
 module JenkinsPipelineBuilder
-  VERSION = "0.1.3"
+  VERSION = "0.1.5"
 end

data/spec/func_tests/spec_helper.rb

@@ -6,7 +6,7 @@ require 'simplecov-rcov'
 
 SimpleCov.start if ENV["COVERAGE"]
 
-require File.expand_path('../../../lib/jenksin_pipeline_builder', __FILE__)
+require File.expand_path('../../../lib/jenkins_pipeline_builder', __FILE__)
 
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true

data/spec/unit_tests/fixtures/files/project.yaml

@@ -3,7 +3,7 @@
     description: 'Do not edit this job through the web!'
     hipchat_room: HipChat Room Name
     os_username: admin
-    os_priv_key: /home/user/qa-oskey.priv
+    os_priv_key: /home/user/key.priv
     os_password: some_encrypted_password
 
 - project:

data/spec/unit_tests/fixtures/templates/external_job.yaml

@@ -0,0 +1,4 @@
+- job:
+    name: foo-test
+    builders:
+      - shell: 'make test'

data/spec/unit_tests/fixtures/templates/project_with_jobs.yaml

@@ -0,0 +1,25 @@
+- job-template:
+    name: '{{name}}-unit-tests'
+    builders:
+      - shell: unittest
+    publishers:
+      - email:
+          recipients: '{{mail-to}}'
+
+- job-template:
+    name: '{{name}}-perf-tests'
+    builders:
+      - shell: perftest
+    publishers:
+      - email:
+          recipients: '{{mail-to}}'
+
+- project:
+    name: project-name
+    db: my_own_db
+    jobs:
+      - '{{name}}-unit-tests':
+          mail-to: developer@nowhere.net
+      - '{{name}}-perf-tests':
+          mail-to: projmanager@nowhere.net
+      - foo-test

data/spec/unit_tests/resolve_dependencies_spec.rb

@@ -208,7 +208,7 @@ describe 'Templates resolver' do
   end
 
   it 'shoult resolve job template into a job' do
-    file = 'project_simple'
+    file = 'project_with_jobs'
     path = File.expand_path('../fixtures/templates/' + file, __FILE__)
     project = YAML.load_file(path + '.yaml')
 

data/spec/unit_tests/spec_helper.rb

@@ -5,7 +5,7 @@ require 'simplecov'
 require 'simplecov-rcov'
 
 SimpleCov.profiles.define 'spec' do
-  add_group 'jenksin_pipeline_builder', '/lib/'
+  add_group 'jenkins_pipeline_builder', '/lib/'
   coverage_dir 'out/coverage'
   formatter SimpleCov::Formatter::MultiFormatter[
                 SimpleCov::Formatter::Console,
@@ -21,7 +21,7 @@ end
 
 SimpleCov.start 'spec' #if ENV["COVERAGE"]
 
-require File.expand_path('../../../lib/jenksin_pipeline_builder', __FILE__)
+require File.expand_path('../../../lib/jenkins_pipeline_builder', __FILE__)
 
 RSpec.configure do |config|
   config.before(:each) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jenkins_pipeline_builder
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Igor Moochnick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-05 00:00:00.000000000 Z
+date: 2014-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -265,25 +265,26 @@ files:
 - README.md
 - Rakefile
 - bin/generate
+- commit_build.sh
 - config/login.yml
 - jenkins_pipeline_builder.gemspec
-- lib/jenksin_pipeline_builder.rb
-- lib/jenksin_pipeline_builder/builders.rb
-- lib/jenksin_pipeline_builder/cli/base.rb
-- lib/jenksin_pipeline_builder/cli/helper.rb
-- lib/jenksin_pipeline_builder/cli/pipeline.rb
-- lib/jenksin_pipeline_builder/cli/view.rb
-- lib/jenksin_pipeline_builder/compiler.rb
-- lib/jenksin_pipeline_builder/generator.rb
-- lib/jenksin_pipeline_builder/job_builder.rb
-- lib/jenksin_pipeline_builder/module_registry.rb
-- lib/jenksin_pipeline_builder/publishers.rb
-- lib/jenksin_pipeline_builder/triggers.rb
-- lib/jenksin_pipeline_builder/utils.rb
-- lib/jenksin_pipeline_builder/version.rb
-- lib/jenksin_pipeline_builder/view.rb
-- lib/jenksin_pipeline_builder/wrappers.rb
-- lib/jenksin_pipeline_builder/xml_helper.rb
+- lib/jenkins_pipeline_builder.rb
+- lib/jenkins_pipeline_builder/builders.rb
+- lib/jenkins_pipeline_builder/cli/base.rb
+- lib/jenkins_pipeline_builder/cli/helper.rb
+- lib/jenkins_pipeline_builder/cli/pipeline.rb
+- lib/jenkins_pipeline_builder/cli/view.rb
+- lib/jenkins_pipeline_builder/compiler.rb
+- lib/jenkins_pipeline_builder/generator.rb
+- lib/jenkins_pipeline_builder/job_builder.rb
+- lib/jenkins_pipeline_builder/module_registry.rb
+- lib/jenkins_pipeline_builder/publishers.rb
+- lib/jenkins_pipeline_builder/triggers.rb
+- lib/jenkins_pipeline_builder/utils.rb
+- lib/jenkins_pipeline_builder/version.rb
+- lib/jenkins_pipeline_builder/view.rb
+- lib/jenkins_pipeline_builder/wrappers.rb
+- lib/jenkins_pipeline_builder/xml_helper.rb
 - spec/func_tests/spec_helper.rb
 - spec/func_tests/view_spec.rb
 - spec/unit_tests/compiler_spec.rb
@@ -301,6 +302,8 @@ files:
 - spec/unit_tests/fixtures/files/Job-Multi-Project.xml
 - spec/unit_tests/fixtures/files/Job-Multi-Project.yaml
 - spec/unit_tests/fixtures/files/project.yaml
+- spec/unit_tests/fixtures/templates/external_job.yaml
+- spec/unit_tests/fixtures/templates/project_with_jobs.yaml
 - spec/unit_tests/generator_spec.rb
 - spec/unit_tests/module_registry_spec.rb
 - spec/unit_tests/resolve_dependencies_spec.rb
@@ -347,6 +350,8 @@ test_files:
 - spec/unit_tests/fixtures/files/Job-Multi-Project.xml
 - spec/unit_tests/fixtures/files/Job-Multi-Project.yaml
 - spec/unit_tests/fixtures/files/project.yaml
+- spec/unit_tests/fixtures/templates/external_job.yaml
+- spec/unit_tests/fixtures/templates/project_with_jobs.yaml
 - spec/unit_tests/generator_spec.rb
 - spec/unit_tests/module_registry_spec.rb
 - spec/unit_tests/resolve_dependencies_spec.rb