jenkins_pipeline_builder 0.1.2 → 0.1.3

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

@@ -0,0 +1,15 @@
+- defaults:
+    name: global
+    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_password: some_encrypted_password
+
+- project:
+    name: Generate
+    jobs:
+      - Job-{{name}}-From-Template:
+          command: run.sh
+      - Job-DSL1
+      - Job-DSL2

data/spec/unit_tests/generator_spec.rb

@@ -0,0 +1,67 @@
+require File.expand_path('../spec_helper', __FILE__)
+require 'equivalent-xml'
+
+describe 'Test YAML jobs conversion to XML' do
+  context 'Loading YAML files' do
+    before do
+      @client = JenkinsApi::Client.new(
+          :server_ip => '127.0.0.1',
+          :server_port => 8080,
+          :username => 'username',
+          :password => 'password',
+          :log_location => '/dev/null'
+      )
+      @generator = JenkinsPipelineBuilder::Generator.new(nil, @client)
+      @generator.debug = true
+      @generator.no_files = true
+    end
+
+    def compare_jobs(job, path)
+      xml = @generator.compile_job_to_xml(job)
+      doc1 = Nokogiri::XML(xml)
+
+      sample_job_xml = File.read(path + '.xml')
+
+      doc2 = Nokogiri::XML(sample_job_xml)
+
+      doc1.should be_equivalent_to(doc2)
+    end
+
+    [
+      'Job-Multi-Project',
+      'Job-Build-Maven',
+      'Job-Build-Flow',
+      'Job-Gem-Build'
+    ].each do |file|
+      it "should create expected XML from YAML '#{file}'" do
+        path = File.expand_path('../fixtures/files/' + file, __FILE__)
+
+        @generator.load_collection_from_path path + '.yaml'
+        job_name = @generator.job_collection.keys.first
+        job = @generator.resolve_job_by_name(job_name)
+
+        compare_jobs job, path
+      end
+    end
+
+    it "should create expected XML from YAML collection" do
+      path = File.expand_path('../fixtures/files/', __FILE__)
+
+      @generator.load_collection_from_path(path)
+
+      project_name = @generator.projects.first[:name]
+
+      project = @generator.resolve_project(@generator.get_item(project_name))
+
+      project[:value][:jobs].should_not be_nil
+
+      project[:value][:jobs].each do |i|
+        job = i[:result]
+        job.should_not be_nil
+
+        file_name = File.join(path, job[:name])
+        compare_jobs job, file_name
+      end
+    end
+  end
+end

data/spec/unit_tests/module_registry_spec.rb

@@ -0,0 +1,19 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe 'ModuleRegistry' do
+
+  it 'should return item by a specified path' do
+
+    registry = JenkinsPipelineBuilder::ModuleRegistry.new ({
+        zz: {
+            aa: 'aa',
+            bb: 'bb',
+            cc: {
+                dd: 'dd'
+            }
+        }
+    })
+
+    registry.get('zz/aa').should be == 'aa'
+  end
+end

data/spec/unit_tests/resolve_dependencies_spec.rb

@@ -0,0 +1,230 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe 'Templates resolver' do
+  before(:each) do
+    @client = JenkinsApi::Client.new(
+        :server_ip => '127.0.0.1',
+        :server_port => 8080,
+        :username => 'username',
+        :password => 'password',
+        :log_location => '/dev/null'
+    )
+    @generator = JenkinsPipelineBuilder::Generator.new(nil, @client)
+    @generator.debug = true
+    @generator.no_files = true
+  end
+
+  describe 'resolving settings bags' do
+    it 'gives a bag when all the variables can be resolved' do
+      str = %{
+- project:
+    name: project-name
+    db: my_own_db_{{else}}
+      }
+      project = YAML.load(str)
+      @generator.load_job_collection project
+
+      #@generator.resolve_item('project-name')
+      settings = JenkinsPipelineBuilder::Compiler.get_settings_bag(@generator.get_item('project-name'), { db: 'blah', else: "bum" })
+      settings.should == { name: "project-name", db: "my_own_db_bum", else: "bum", }
+    end
+
+    it 'returns nil when all the variables cant be resolved' do
+      str = %{
+- project:
+    name: project-name
+    db: my_own_db_{{else}}_{{blah}}
+      }
+      project = YAML.load(str)
+      @generator.load_job_collection project
+
+      #@generator.resolve_item('project-name')
+      settings = JenkinsPipelineBuilder::Compiler.get_settings_bag(@generator.get_item('project-name'), { db: 'blah', else: "bum" })
+      settings.should be_nil
+    end
+  end
+
+  it 'starts with the defaults section for settings bag' do
+    str = %{
+- defaults:
+    name: global
+    description: 'Do not edit this job through the web!'
+- job-template:
+    name: 'foo-bar'
+    description: '{{description}}'
+    builders:
+      - shell: perftest
+- project:
+    name: project-name
+    db: my_own_db
+    jobs:
+      - 'foo-bar'
+      }
+    project = YAML.load(str)
+    @generator.load_job_collection project
+
+    @generator.resolve_project(@generator.get_item('project-name')).should ==
+        {:name=>"project-name",
+         :type=>:project,
+         :value=>
+             {:name=>"project-name",
+              :db=>"my_own_db",
+              :jobs=>
+                  [{:"foo-bar"=>{},
+                    :result=>
+                        {:name=>"foo-bar",
+                         :description=>"Do not edit this job through the web!",
+                         :builders=>[{:shell=>"perftest"}]}}]},
+         :settings=>
+             {:name=>"project-name",
+              :description=>"Do not edit this job through the web!",
+              :db=>"my_own_db"}}
+  end
+
+  it 'should build project collection from jobs templates' do
+    str = %{
+- 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
+}
+
+    project = YAML.load(str)
+    @generator.load_job_collection project
+
+    @generator.resolve_project(@generator.get_item('project-name')).should ==
+        {:name=>"project-name",
+         :type=>:project,
+         :value=>
+             {:name=>"project-name",
+              :db=>"my_own_db",
+              :jobs=>
+                  [{:"{{name}}-unit-tests"=>{:"mail-to"=>"developer@nowhere.net"},
+                    :result=>
+                        {:name=>"project-name-unit-tests",
+                         :builders=>[{:shell=>"unittest"}],
+                         :publishers=>[{:email=>{:recipients=>"developer@nowhere.net"}}]}},
+                   {:"{{name}}-perf-tests"=>{:"mail-to"=>"projmanager@nowhere.net"},
+                    :result=>
+                        {:name=>"project-name-perf-tests",
+                         :builders=>[{:shell=>"perftest"}],
+                         :publishers=>[{:email=>{:recipients=>"projmanager@nowhere.net"}}]}}]},
+         :settings=>{:name=>"project-name", :db=>"my_own_db"}}
+  end
+
+  it 'should build project collection from jobs and jobs templates' do
+    str = %{
+- job-template:
+    name: '{{name}}-unit-tests'
+    builders:
+      - shell: unittest
+    publishers:
+      - email:
+          recipients: '{{mail-to}}'
+
+- job:
+    name: 'foo-bar'
+    builders:
+      - shell: perftest
+
+- project:
+    name: project-name
+    db: my_own_db
+    jobs:
+      - 'foo-bar'
+      - '{{name}}-unit-tests':
+          mail-to: projmanager@nowhere.net
+}
+
+    project = YAML.load(str)
+    @generator.load_job_collection project
+
+    @generator.resolve_project(@generator.get_item('project-name')).should ==
+        {:name=>"project-name",
+         :type=>:project,
+         :value=>
+             {:name=>"project-name",
+              :db=>"my_own_db",
+              :jobs=>
+                  [{:"foo-bar"=>{},
+                    :result=>
+                        {:name=>"foo-bar",
+                         :builders=>[{:shell=>"perftest"}]}},
+                   {:"{{name}}-unit-tests"=>{:"mail-to"=>"projmanager@nowhere.net"},
+                    :result=>
+                        {:name=>"project-name-unit-tests",
+                         :builders=>[{:shell=>"unittest"}],
+                         :publishers=>[{:email=>{:recipients=>"projmanager@nowhere.net"}}]}}]},
+         :settings=>{:name=>"project-name", :db=>"my_own_db"}}
+  end
+
+
+  describe 'compilation of templates' do
+    it 'compiles String' do
+      JenkinsPipelineBuilder::Compiler.compile('blah', { item1: 'data1'}).should == 'blah'
+    end
+
+    it 'compiles simple Hash' do
+      JenkinsPipelineBuilder::Compiler.compile({ name: 'item-{{item1}}', value: 'item1-data'}, { item1: 'data1'}).should ==
+          { name: 'item-data1', value: 'item1-data'}
+    end
+
+    it 'compiles nested Hash' do
+      JenkinsPipelineBuilder::Compiler.compile({ name: 'item-{{item1}}', value: { house: 'house-{{item1}}'}}, { item1: 'data1'}).should ==
+          { name: 'item-data1', value: { house: 'house-data1'}}
+    end
+
+    it 'compiles complex Hash' do
+      template = {:name=>"{{name}}-unit-tests",
+                  :builders=>[{:shell=>"unittest"}],
+                  :publishers=>[{:email=>{:recipients=>"{{mail-to}}"}}]}
+      settings = {:name=>"project-name", :db=>"my_own_db", :'mail-to' => 'developer@nowhere.net'}
+
+      JenkinsPipelineBuilder::Compiler.compile(template, settings).should ==
+          {:name=>"project-name-unit-tests",
+           :builders=>[{:shell=>"unittest"}],
+           :publishers=>[{:email=>{:recipients=>"developer@nowhere.net"}}]}
+    end
+  end
+
+  it 'shoult resolve job template into a job' do
+    file = 'project_simple'
+    path = File.expand_path('../fixtures/templates/' + file, __FILE__)
+    project = YAML.load_file(path + '.yaml')
+
+    @generator.load_job_collection project
+
+    @generator.resolve_job_by_name('{{name}}-unit-tests', { name: 'project-name', db: 'my_own_db', :'mail-to' => 'developer@nowhere.net' }).should ==
+        {:name=>"project-name-unit-tests",
+         :builders=>[{:shell=>"unittest"}],
+         :publishers=>[{:email=>{:recipients=>"developer@nowhere.net"}}]}
+  end
+
+  it 'should load from folder' do
+    path = File.expand_path('../fixtures/templates/', __FILE__)
+    @generator.load_collection_from_path(path)
+
+    @generator.job_collection.count.should == 4
+    @generator.projects.count == 1
+  end
+end

data/spec/unit_tests/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'logger'
+require 'rspec'
+
+require 'simplecov'
+require 'simplecov-rcov'
+
+SimpleCov.profiles.define 'spec' do
+  add_group 'jenksin_pipeline_builder', '/lib/'
+  coverage_dir 'out/coverage'
+  formatter SimpleCov::Formatter::MultiFormatter[
+                SimpleCov::Formatter::Console,
+                SimpleCov::Formatter::RcovFormatter,
+            ]
+end
+
+class SimpleCov::Formatter::Console
+  def format(result)
+    print "COVERAGE: #{result.covered_percent.round(2)}%\n"
+  end
+end
+
+SimpleCov.start 'spec' #if ENV["COVERAGE"]
+
+require File.expand_path('../../../lib/jenksin_pipeline_builder', __FILE__)
+
+RSpec.configure do |config|
+  config.before(:each) do
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jenkins_pipeline_builder
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Igor Moochnick
@@ -248,16 +248,64 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: This gem is intended to upload Jenkins pipelines
+description: |-
+  This is a simple and easy-to-use Jenkins Pipeline generator with features focused on
+  automating Job & Pipeline creation from the YAML files checked-in with your application source code
 email:
 - igor.moochnick@gmail.com
-executables: []
+executables:
+- generate
 extensions: []
 extra_rdoc_files: []
 files:
+- .ruby-gemset
+- .ruby-version
+- Gemfile
 - LICENSE
 - README.md
-homepage: ''
+- Rakefile
+- bin/generate
+- 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
+- spec/func_tests/spec_helper.rb
+- spec/func_tests/view_spec.rb
+- spec/unit_tests/compiler_spec.rb
+- spec/unit_tests/fixtures/files/Job-Build-Flow.xml
+- spec/unit_tests/fixtures/files/Job-Build-Flow.yaml
+- spec/unit_tests/fixtures/files/Job-Build-Maven.xml
+- spec/unit_tests/fixtures/files/Job-Build-Maven.yaml
+- spec/unit_tests/fixtures/files/Job-DSL.yaml
+- spec/unit_tests/fixtures/files/Job-DSL1.xml
+- spec/unit_tests/fixtures/files/Job-DSL2.xml
+- spec/unit_tests/fixtures/files/Job-Gem-Build.xml
+- spec/unit_tests/fixtures/files/Job-Gem-Build.yaml
+- spec/unit_tests/fixtures/files/Job-Generate-From-Template.xml
+- spec/unit_tests/fixtures/files/Job-Generate-From-Template.yaml
+- 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/generator_spec.rb
+- spec/unit_tests/module_registry_spec.rb
+- spec/unit_tests/resolve_dependencies_spec.rb
+- spec/unit_tests/spec_helper.rb
+homepage: https://github.com/IgorShare/jenkins_pipeline_builder
 licenses:
 - MIT
 metadata: {}
@@ -280,6 +328,27 @@ rubyforge_project:
 rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
-summary: This gem is intended to upload Jenkins pipelines
-test_files: []
+summary: This gem is will boostrap your Jenkins pipelines
+test_files:
+- spec/func_tests/spec_helper.rb
+- spec/func_tests/view_spec.rb
+- spec/unit_tests/compiler_spec.rb
+- spec/unit_tests/fixtures/files/Job-Build-Flow.xml
+- spec/unit_tests/fixtures/files/Job-Build-Flow.yaml
+- spec/unit_tests/fixtures/files/Job-Build-Maven.xml
+- spec/unit_tests/fixtures/files/Job-Build-Maven.yaml
+- spec/unit_tests/fixtures/files/Job-DSL.yaml
+- spec/unit_tests/fixtures/files/Job-DSL1.xml
+- spec/unit_tests/fixtures/files/Job-DSL2.xml
+- spec/unit_tests/fixtures/files/Job-Gem-Build.xml
+- spec/unit_tests/fixtures/files/Job-Gem-Build.yaml
+- spec/unit_tests/fixtures/files/Job-Generate-From-Template.xml
+- spec/unit_tests/fixtures/files/Job-Generate-From-Template.yaml
+- 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/generator_spec.rb
+- spec/unit_tests/module_registry_spec.rb
+- spec/unit_tests/resolve_dependencies_spec.rb
+- spec/unit_tests/spec_helper.rb
 has_rdoc: