jenkins_pipeline_builder 0.5.2 → 0.6.0

data/lib/jenkins_pipeline_builder/wrappers.rb

@@ -20,126 +20,193 @@
 # THE SOFTWARE.
 #
 
-module JenkinsPipelineBuilder
-  class Wrappers < Extendable
-    register :ansicolor, jenkins_name: 'color ansi', description: 'this is a description' do |_, xml|
-      xml.send('hudson.plugins.ansicolor.AnsiColorBuildWrapper') do
-        xml.colorMapName 'xterm'
-      end
+wrapper do
+  name :ansicolor
+  plugin_id 123
+  min_version 0
+  announced false
+  jenkins_name 'color ansi'
+  description 'this is a description'
+  xml do |_|
+    send('hudson.plugins.ansicolor.AnsiColorBuildWrapper') do
+      colorMapName 'xterm'
     end
+  end
+end
 
-    register :timestamp do |_, xml|
-      xml.send('hudson.plugins.timestamper.TimestamperBuildWrapper', 'plugin' => 'timestamper')
-    end
+wrapper do
+  name :timestamp
+  plugin_id 123
+  min_version 0
+  announced false
 
-    register :rvm05 do |wrapper, xml|
-      xml.send('ruby-proxy-object') do
-        xml.send('ruby-object', 'ruby-class' => 'Jenkins::Tasks::BuildWrapperProxy', 'pluginid' => 'rvm') do
-          xml.object('ruby-class' => 'RvmWrapper', 'pluginid' => 'rvm') do
-            xml.impl('pluginid' => 'rvm', 'ruby-class' => 'String') { xml.text wrapper }
-          end
-          xml.pluginid(:pluginid => 'rvm', 'ruby-class' => 'String') { xml.text 'rvm' }
+  xml do |_|
+    send('hudson.plugins.timestamper.TimestamperBuildWrapper', 'plugin' => 'timestamper')
+  end
+end
+
+wrapper do
+  name :rvm
+  plugin_id 123
+  min_version '0.5'
+  announced false
+  description 'rvm plugin for versions 0.5 and greater'
+
+  xml do |wrapper|
+    send('ruby-proxy-object') do
+      send('ruby-object', 'ruby-class' => 'Jenkins::Tasks::BuildWrapperProxy', 'pluginid' => 'rvm') do
+        object('ruby-class' => 'RvmWrapper', 'pluginid' => 'rvm') do
+          impl('pluginid' => 'rvm', 'ruby-class' => 'String') { text wrapper }
         end
+        pluginid(:pluginid => 'rvm', 'ruby-class' => 'String') { text 'rvm' }
       end
     end
+  end
+end
+
+wrapper do
+  name :name
+  plugin_id 123
+  min_version 0
+  announced false
+
+  xml do |_|
+  end
+end
 
-    register :rvm do |wrapper, xml|
-      xml.send('ruby-proxy-object') do
-        xml.send('ruby-object', 'ruby-class' => 'Jenkins::Plugin::Proxies::BuildWrapper', 'pluginid' => 'rvm') do
-          xml.object('ruby-class' => 'RvmWrapper', 'pluginid' => 'rvm') do
-            xml.impl('pluginid' => 'rvm', 'ruby-class' => 'String') { xml.text wrapper }
+wrapper do
+  name :rvm
+  plugin_id 123
+  min_version '0'
+  announced false
+  description 'rvm plugin for versions less than 0.5'
+
+  xml do |wrapper|
+    send('ruby-proxy-object') do
+      send('ruby-object', 'ruby-class' => 'Jenkins::Plugin::Proxies::BuildWrapper', 'pluginid' => 'rvm') do
+        object('ruby-class' => 'RvmWrapper', 'pluginid' => 'rvm') do
+          impl('pluginid' => 'rvm', 'ruby-class' => 'String') do
+            text wrapper
           end
-          xml.pluginid(:pluginid => 'rvm', 'ruby-class' => 'String') { xml.text 'rvm' }
         end
+        pluginid(:pluginid => 'rvm', 'ruby-class' => 'String') { text 'rvm' }
       end
     end
+  end
+end
+
+wrapper do
+  name :inject_passwords
+  plugin_id 123
+  min_version 0
+  announced false
 
-    register :inject_passwords do |passwords, xml|
-      xml.EnvInjectPasswordWrapper do
-        xml.injectGlobalPasswords false
-        xml.passwordEntries do
-          passwords.each do |password|
-            xml.EnvInjectPasswordEntry do
-              xml.name password[:name]
-              xml.value password[:value]
-            end
+  xml do |passwords|
+    EnvInjectPasswordWrapper do
+      injectGlobalPasswords false
+      passwordEntries do
+        passwords.each do |password|
+          EnvInjectPasswordEntry do
+            name password[:name]
+            value password[:value]
           end
         end
       end
     end
+  end
+end
 
-    register :inject_env_var do |params, xml|
-      xml.EnvInjectBuildWrapper do
-        xml.info do
-          xml.propertiesFilePath params[:file] if params[:file]
-          xml.propertiesContent params[:content] if params[:content]
-          xml.loadFilesFromMaster false
-        end
+wrapper do
+  name :inject_env_var
+  plugin_id 123
+  min_version 0
+  announced false
+
+  xml do |params|
+    EnvInjectBuildWrapper do
+      info do
+        propertiesFilePath params[:file] if params[:file]
+        propertiesContent params[:content] if params[:content]
+        loadFilesFromMaster false
       end
     end
+  end
+end
 
-    register :artifactory do |wrapper, xml|
-      xml.send('org.jfrog.hudson.generic.ArtifactoryGenericConfigurator') do
-        xml.details do
-          xml.artifactoryUrl wrapper[:url]
-          xml.artifactoryName wrapper[:'artifactory-name']
-          xml.repositoryKey wrapper[:'release-repo']
-          xml.snapshotsRepositoryKey wrapper.fetch(:'snapshot-repo', wrapper[:'release-repo'])
-        end
-        xml.deployPattern wrapper[:publish]
-        xml.resolvePattern
-        xml.matrixParams wrapper[:properties]
-        xml.deployBuildInfo wrapper[:'publish-build-info']
-        xml.includeEnvVars false
-        xml.envVarsPatterns do
-          xml.includePatterns
-          xml.excludePatterns '*password*,*secret*'
-        end
-        xml.discardOldBuilds false
-        xml.discardBuildArtifacts true
+wrapper do
+  name :artifactory
+  plugin_id 123
+  min_version 0
+  announced false
+
+  xml do |wrapper|
+    send('org.jfrog.hudson.generic.ArtifactoryGenericConfigurator') do
+      details do
+        artifactoryUrl wrapper[:url]
+        artifactoryName wrapper[:'artifactory-name']
+        repositoryKey wrapper[:'release-repo']
+        snapshotsRepositoryKey wrapper.fetch(:'snapshot-repo', wrapper[:'release-repo'])
       end
+      deployPattern wrapper[:publish]
+      resolvePattern
+      matrixParams wrapper[:properties]
+      deployBuildInfo wrapper[:'publish-build-info']
+      includeEnvVars false
+      envVarsPatterns do
+        includePatterns
+        excludePatterns '*password*,*secret*'
+      end
+      discardOldBuilds false
+      discardBuildArtifacts true
     end
+  end
+end
 
-    register :maven3artifactory do |wrapper, xml|
-      xml.send('org.jfrog.hudson.maven3.ArtifactoryMaven3Configurator') do # plugin='artifactory@2.2.1'
-        xml.details do
-          xml.artifactoryUrl wrapper[:url]
-          xml.artifactoryName wrapper[:'artifactory-name']
-          xml.repositoryKey wrapper[:'release-repo']
-          xml.snapshotsRepositoryKey wrapper.fetch(:'snapshot-repo', wrapper[:'release-repo'])
-        end
-        xml.deployArtifacts wrapper.fetch(:'deploy', true)
-        xml.artifactDeploymentPatterns do
-          xml.includePatterns
-          xml.excludePatterns
-        end
-        xml.includeEnvVars false
-        xml.deployBuildInfo wrapper.fetch(:'publish-build-info', true)
-        xml.envVarsPatterns do
-          xml.includePatterns
-          xml.excludePatterns '*password*,*secret*'
-        end
-        xml.runChecks false
-        xml.violationRecipients
-        xml.includePublishArtifacts false
-        xml.scopes
-        xml.licenseAutoDiscovery true
-        xml.disableLicenseAutoDiscovery false
-        xml.discardOldBuilds false
-        xml.discardBuildArtifacts true
-        xml.matrixParams
-        xml.enableIssueTrackerIntegration false
-        xml.aggregateBuildIssues false
-        xml.blackDuckRunChecks false
-        xml.blackDuckAppName
-        xml.blackDuckAppVersion
-        xml.blackDuckReportRecipients
-        xml.blackDuckScopes
-        xml.blackDuckIncludePublishedArtifacts false
-        xml.autoCreateMissingComponentRequests true
-        xml.autoDiscardStaleComponentRequests true
-        xml.filterExcludedArtifactsFromBuild false
+wrapper do
+  name :maven3artifactory
+  plugin_id 123
+  min_version 0
+  announced false
+
+  xml do |wrapper|
+    send('org.jfrog.hudson.maven3.ArtifactoryMaven3Configurator') do # plugin='artifactory@2.2.1'
+      details do
+        artifactoryUrl wrapper[:url]
+        artifactoryName wrapper[:'artifactory-name']
+        repositoryKey wrapper[:'release-repo']
+        snapshotsRepositoryKey wrapper.fetch(:'snapshot-repo', wrapper[:'release-repo'])
+      end
+      deployArtifacts wrapper.fetch(:'deploy', true)
+      artifactDeploymentPatterns do
+        includePatterns
+        excludePatterns
+      end
+      includeEnvVars false
+      deployBuildInfo wrapper.fetch(:'publish-build-info', true)
+      envVarsPatterns do
+        includePatterns
+        excludePatterns '*password*,*secret*'
       end
+      runChecks false
+      violationRecipients
+      includePublishArtifacts false
+      scopes
+      licenseAutoDiscovery true
+      disableLicenseAutoDiscovery false
+      discardOldBuilds false
+      discardBuildArtifacts true
+      matrixParams
+      enableIssueTrackerIntegration false
+      aggregateBuildIssues false
+      blackDuckRunChecks false
+      blackDuckAppName
+      blackDuckAppVersion
+      blackDuckReportRecipients
+      blackDuckScopes
+      blackDuckIncludePublishedArtifacts false
+      autoCreateMissingComponentRequests true
+      autoDiscardStaleComponentRequests true
+      filterExcludedArtifactsFromBuild false
     end
   end
 end

data/spec/lib/jenkins_pipeline_builder/compiler_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path('../spec_helper', __FILE__)
+require 'pp'
+describe JenkinsPipelineBuilder::Compiler do
+  let(:compiler) { JenkinsPipelineBuilder::Compiler }
+  let(:settings_project) { { name: 'DummyPipeline', type: :project, value: { name: 'DummyPipeline', jobs: ['{{name}}-00', { '{{name}}-01' => { job_name: '{{name}}-02' } }] } } }
+  let(:settings_global) { { name: 'global', description: 'Do not edit this job through the web!', discard_days: '14', pipeline_repo: 'git@github.com:constantcontact/jenkins_pipeline_builder.git', pipeline_branch: 'master' } }
+  let(:settings_bag) { { name: 'DummyPipeline', description: 'Do not edit this job through the web!', discard_days: '14', pipeline_repo: 'git@github.com:constantcontact/jenkins_pipeline_builder.git', pipeline_branch: 'master' } }
+  let(:job0) { { name: '{{name}}-00', description: '{{description}}', scm_provider: 'git', scm_url: '{{pipeline_repo}}', scm_branch: '{{pipeline_branch}}', scm_params: { remote_name: 'origin', skip_tag: true }, wrappers: [{ ansicolor: true }], builders: [{ shell_command: "echo 'Running {{name}}'\necho 'About to run {{job@{{name}}-01}}'\n" }], publishers: [{ downstream: { project: '{{job@{{name}}-01}}' } }] } }
+  let(:job0_compiled) { { name: 'DummyPipeline-00', description: 'Do not edit this job through the web!', scm_provider: 'git', scm_url: 'git@github.com:constantcontact/jenkins_pipeline_builder.git', scm_branch: 'master', scm_params: { remote_name: 'origin', skip_tag: true }, wrappers: [{ ansicolor: true }], builders: [{ shell_command: "echo 'Running DummyPipeline'\necho 'About to run DummyPipeline-02'\n" }], publishers: [{ downstream: { project: 'DummyPipeline-02' } }] } }
+  let(:job2) { { name: '{{name}}-02', description: '{{description}}', scm_provider: 'git', scm_url: '{{pipeline_repo}}', scm_branch: '{{pipeline_branch}}', scm_params: { remote_name: 'origin', skip_tag: true }, wrappers: [{ ansicolor: true }], builders: [{ shell_command: "echo 'Running {{name}}'" }] } }
+  let(:job2_compiled) { { name: 'DummyPipeline-02', description: 'Do not edit this job through the web!', scm_provider: 'git', scm_url: 'git@github.com:constantcontact/jenkins_pipeline_builder.git', scm_branch: 'master', scm_params: { remote_name: 'origin', skip_tag: true }, wrappers: [{ ansicolor: true }], builders: [{ shell_command: "echo 'Running DummyPipeline'" }] } }
+  let(:job_collection) { { '{{name}}-00' => { name: '{{name}}-00', type: :job, value: { name: '{{name}}-00', description: '{{description}}', scm_provider: 'git', scm_url: '{{pipeline_repo}}', scm_branch: '{{pipeline_branch}}', scm_params: { remote_name: 'origin', skip_tag: true }, wrappers: [{ ansicolor: true }], builders: [{ shell_command: "echo 'Running {{name}}'\necho 'About to run {{job@{{name}}-01}}'\n" }], publishers: [{ downstream: { project: '{{job@{{name}}-01}}' } }] } }, '{{name}}-01' => { name: '{{name}}-01', type: :job, value: { name: '{{name}}-02', description: '{{description}}', scm_provider: 'git', scm_url: '{{pipeline_repo}}', scm_branch: '{{pipeline_branch}}', scm_params: { remote_name: 'origin', skip_tag: true }, wrappers: [{ ansicolor: true }], builders: [{ shell_command: "echo 'Running {{name}}'" }] }, job_name: '{{name}}-02' }, 'global' => { name: 'global', type: :defaults, value: { name: 'global', description: 'Do not edit this job through the web!', discard_days: '14', pipeline_repo: 'git@github.com:constantcontact/jenkins_pipeline_builder.git', pipeline_branch: 'master' } }, 'DummyPipeline' => { name: 'DummyPipeline', type: :project, value: { name: 'DummyPipeline', jobs: [{ '{{name}}-00' => {}, result: { name: 'DummyPipeline-00', description: 'Do not edit this job through the web!', scm_provider: 'git', scm_url: 'git@github.com:constantcontact/jenkins_pipeline_builder.git', scm_branch: 'master', scm_params: { remote_name: 'origin', skip_tag: true }, wrappers: [{ ansicolor: true }], builders: [{ shell_command: "echo 'Running DummyPipeline'\necho 'About to run DummyPipeline-02'\n" }], publishers: [{ downstream: { project: 'DummyPipeline-02' } }] } }, { '{{name}}-01' => { job_name: '{{name}}-02' } }] }, settings: { name: 'DummyPipeline', description: 'Do not edit this job through the web!', discard_days: '14', pipeline_repo: 'git@github.com:constantcontact/jenkins_pipeline_builder.git', pipeline_branch: 'master' } } } }
+
+  describe '#get_settings_bag' do
+    it 'merge settings' do
+      settings = compiler.get_settings_bag(settings_project, settings_global)
+      expect(settings).to eq(settings_bag)
+    end
+  end
+
+  describe '#compile' do
+    it 'compile a job with a name change' do
+      result = compiler.compile(job2, settings_bag, job_collection)
+      expect(result[1]).to eq(job2_compiled)
+    end
+    it 'compile a job with a downstream name change' do
+      result = compiler.compile(job0, settings_bag, job_collection)
+      expect(result[1]).to eq(job0_compiled)
+    end
+  end
+end

data/spec/lib/jenkins_pipeline_builder/extensions_spec.rb

@@ -0,0 +1,145 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe JenkinsPipelineBuilder::Extension do
+  subject(:extension) { JenkinsPipelineBuilder::Extension.new }
+  context 'defaults' do
+    it 'min_version is nil' do
+      expect(extension.min_version).to be nil
+    end
+    it 'name is nil' do
+      expect(extension.name).to be nil
+    end
+    it 'plugin_id is nil' do
+      expect(extension.plugin_id).to be nil
+    end
+    it 'type is nil' do
+      expect(extension.type).to be nil
+    end
+    it 'path is nil' do
+      expect(extension.path).to be nil
+    end
+    it 'announced is true' do
+      expect(extension.announced).to be true
+    end
+    it 'jenkins_name has the correct default' do
+      expect(extension.jenkins_name).to eq 'No jenkins display name set'
+    end
+    it 'description has the correct default' do
+      expect(extension.description).to eq 'No description set'
+    end
+  end
+
+  context 'methods' do
+    context 'name' do
+      it 'sets the name if a parameter is provided' do
+        extension.name('foo')
+        expect(extension.name).to eq 'foo'
+      end
+    end
+    context 'plugin_id' do
+      it 'sets the plugin_id if a parameter is provided' do
+        extension.plugin_id('foo')
+        expect(extension.plugin_id).to eq 'foo'
+      end
+    end
+    context 'min_version' do
+      it 'sets the min_version if a parameter is provided' do
+        extension.min_version('foo')
+        expect(extension.min_version).to eq 'foo'
+      end
+    end
+    context 'jenkins_name' do
+      it 'sets the jenkins_name if a parameter is provided' do
+        extension.jenkins_name('foo')
+        expect(extension.jenkins_name).to eq 'foo'
+      end
+    end
+    context 'description' do
+      it 'sets the description if a parameter is provided' do
+        extension.description('foo')
+        expect(extension.description).to eq 'foo'
+      end
+    end
+    context 'path' do
+      it 'sets the path if a parameter is provided' do
+        extension.path('foo')
+        expect(extension.path).to eq 'foo'
+      end
+    end
+    context 'announced' do
+      it 'sets the announced if a parameter is provided' do
+        extension.announced('foo')
+        expect(extension.announced).to eq 'foo'
+      end
+    end
+    context 'type' do
+      it 'sets the type if a parameter is provided' do
+        extension.type('foo')
+        expect(extension.type).to eq 'foo'
+      end
+    end
+    context 'xml' do
+      it 'saves the block' do
+        extension.xml do
+          true
+        end
+        expect(extension.xml.call).to be true
+      end
+      it 'uses the path if provided' do
+        extension.xml('foo') do
+          true
+        end
+        expect(extension.path).to eq 'foo'
+      end
+      it 'returns the saved block if there none is provided' do
+        extension.xml do
+          true
+        end
+        expect(extension.xml).to be_kind_of Proc
+      end
+    end
+    context 'after' do
+      it 'saves the block' do
+        extension.after do
+          true
+        end
+        expect(extension.after.call).to be true
+      end
+      it 'returns the saved block if there none is provided' do
+        extension.after do
+          true
+        end
+        expect(extension.after).to be_kind_of Proc
+      end
+    end
+    context 'before' do
+      it 'saves the block' do
+        extension.before do
+          true
+        end
+        expect(extension.before.call).to be true
+      end
+      it 'returns the saved block if there none is provided' do
+        extension.before do
+          true
+        end
+        expect(extension.before).to be_kind_of Proc
+      end
+    end
+    context 'valid?' do
+      it 'returns true if errors is empty' do
+        extension.name 'foo'
+        extension.plugin_id 'foo'
+        extension.min_version 'foo'
+        extension.type 'foo'
+        extension.path 'foo'
+        expect(extension.errors).to be_empty
+        expect(extension.valid?).to be true
+      end
+      it 'returns false if errors is not empty' do
+        expect(extension.errors).to_not be_empty
+        expect(extension.valid?).to be false
+      end
+    end
+  end
+end