jenkins_pipeline_builder 0.1.2 → 0.1.3

data/lib/jenksin_pipeline_builder/wrappers.rb

@@ -0,0 +1,91 @@
+#
+# Copyright (c) 2014 Igor Moochnick
+#
+# 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 NONINFRINGEMENT. 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.
+#
+
+module JenkinsPipelineBuilder
+  class Wrappers
+    def self.ansicolor(wrapper, xml)
+      xml.send('hudson.plugins.ansicolor.AnsiColorBuildWrapper') {
+        xml.colorMapName 'xterm'
+      }
+    end
+
+    def self.console_timestamp(wrapper, xml)
+      xml.send('hudson.plugins.timestamper.TimestamperBuildWrapper')
+    end
+
+    def self.run_with_rvm(wrapper, xml)
+      xml.send('ruby-proxy-object') {
+        xml.send('ruby-object', 'ruby-class' => 'Jenkins::Plugin::Proxies::BuildWrapper', 'pluginid' => 'rvm') {
+          xml.object('ruby-class' => 'RvmWrapper', 'pluginid' => 'rvm') {
+            xml.impl('pluginid' => "rvm", 'ruby-class' => 'String') { xml.text wrapper }
+          }
+          xml.pluginid(:pluginid => 'rvm', 'ruby-class' => 'String') { xml.text 'rvm' }
+        }
+      }
+    end
+
+    def self.inject_passwords(passwords, xml)
+      xml.EnvInjectPasswordWrapper {
+        xml.injectGlobalPasswords false
+        xml.passwordEntries {
+          passwords.each do |password|
+            xml.EnvInjectPasswordEntry {
+              xml.name password[:name]
+              xml.value password[:value]
+            }
+          end
+        }
+      }
+    end
+
+    def self.inject_env_vars(wrapper, xml)
+      xml.EnvInjectBuildWrapper {
+        xml.info {
+          xml.propertiesContent wrapper
+          xml.loadFilesFromMaster false
+        }
+      }
+    end
+
+    def self.publish_to_artifactory(wrapper, xml)
+      xml.send('org.jfrog.hudson.generic.ArtifactoryGenericConfigurator') {
+        xml.details {
+          xml.artifactoryUrl wrapper[:url]
+          xml.artifactoryName wrapper[:'artifactory-name']
+          xml.repositoryKey wrapper[:'target-repo']
+          xml.snapshotsRepositoryKey wrapper[:'target-repo']
+        }
+        xml.deployPattern wrapper[:publish]
+        xml.resolvePattern
+        xml.matrixParams
+        xml.deployBuildInfo wrapper[:'publish-build-info']
+        xml.includeEnvVars false
+        xml.envVarsPatterns {
+          xml.includePatterns
+          xml.excludePatterns '*password*,*secret*'
+        }
+        xml.discardOldBuilds false
+        xml.discardBuildArtifacts true
+      }
+    end
+  end
+end

data/lib/jenksin_pipeline_builder/xml_helper.rb

@@ -0,0 +1,40 @@
+#
+# Copyright (c) 2014 Igor Moochnick
+#
+# 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 NONINFRINGEMENT. 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.
+#
+
+module JenkinsPipelineBuilder
+  class XmlHelper
+    def self.update_node_text(n_xml, path, value)
+      n_node = n_xml.xpath(path).first
+      if n_node.nil?
+        left, right = path.match(/^(.*)\/([^\/]*)$/).captures
+        parent_node = n_xml.xpath(left).first
+        Nokogiri::XML::Builder.with(parent_node) do |xml|
+          xml.send(right) {
+            xml.text value
+          }
+        end
+      else
+        n_node.content = value
+      end
+    end
+  end
+end

data/spec/func_tests/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'logger'
+require 'rspec'
+
+require 'simplecov'
+require 'simplecov-rcov'
+
+SimpleCov.start if ENV["COVERAGE"]
+
+require File.expand_path('../../../lib/jenksin_pipeline_builder', __FILE__)
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run_excluding :broken => true
+
+  config.before(:each) do
+  end
+end

data/spec/func_tests/view_spec.rb

@@ -0,0 +1,93 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe JenkinsPipelineBuilder::View do
+  context "With properly initialized client" do
+    before(:all) do
+      @creds_file = '~/.jenkins_api_client/login.yml'
+      @valid_post_responses = [200, 201, 302]
+      begin
+        @client = JenkinsApi::Client.new(
+            YAML.load_file(File.expand_path(@creds_file, __FILE__))
+        )
+        @client.logger.level = Logger::DEBUG
+        @generator = JenkinsPipelineBuilder::Generator.new(nil, @client)
+        @generator.no_files = true
+      rescue Exception => e
+        puts 'WARNING: Credentials are not set properly.'
+        puts e.message
+      end
+    end
+
+    describe 'InstanceMethods' do
+      describe '#create' do
+        def create_and_validate(params)
+          name = params[:name]
+          @valid_post_responses.should include(
+                                           @generator.view.create(params).to_i
+                                       )
+          @generator.view.list_children(params[:parent_view], name).include?(name).should be_true
+        end
+
+        def destroy_and_validate(params)
+          name = params[:name]
+          @valid_post_responses.should include(
+                                           @generator.view.delete(name, params[:parent_view]).to_i
+                                       )
+          @generator.view.list_children(params[:parent_view], name).include?(name).should be_false
+        end
+
+        def test_and_validate(params)
+          create_and_validate(params)
+          destroy_and_validate(params)
+        end
+
+        it 'accepts the name of the view and creates the view' do
+          params = {
+              :name => 'test_list_view'
+          }
+
+          test_and_validate(params)
+        end
+
+        it 'creates a Nested view with a child' do
+          params_parent = {
+              name: 'test_nested_view',
+              type: 'nestedView'
+          }
+
+          create_and_validate(params_parent)
+
+          params_child = {
+              name: 'test_list_view',
+              parent_view: params_parent[:name]
+          }
+
+          test_and_validate(params_child)
+
+          destroy_and_validate(params_parent)
+        end
+
+        it 'creates a categorized view with columns' do
+          params = {
+              name: 'test_category_view',
+              type: 'categorizedView',
+              description: 'Blah blah',
+              regex: 'Job-.*',
+              groupingRules: [{
+                                  groupRegex: 'Step-1.*',
+                                  namingRule: '1. Commit'
+                              },{
+                                  groupRegex: 'Step-2.*',
+                                  namingRule: '2. Acceptance'
+                              },{
+                                  groupRegex: 'Step-3.*',
+                                  namingRule: '3. Release'
+                              }]
+          }
+
+          test_and_validate(params)
+        end
+      end
+    end
+  end
+end

data/spec/unit_tests/compiler_spec.rb

@@ -0,0 +1,19 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe 'Compiler' do
+  it 'transforms hash into hash' do
+    hash = {
+        a: 'A sentence',
+        b: 'B sentence',
+        hash: {
+            c: 5,
+            d: true
+        },
+        z: false
+    }
+
+    result = JenkinsPipelineBuilder::Compiler.compile(hash)
+
+    result.should == hash
+  end
+end

data/spec/unit_tests/fixtures/files/Job-Build-Flow.xml

@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<com.cloudbees.plugins.flow.BuildFlow>
+  <actions/>
+  <description/>
+  <keepDependencies>false</keepDependencies>
+  <properties>
+    <jenkins.plugins.hipchat.HipChatNotifier_-HipChatJobProperty>
+      <room>HipChat Room Name</room>
+      <startNotification>true</startNotification>
+    </jenkins.plugins.hipchat.HipChatNotifier_-HipChatJobProperty>
+    <hudson.model.ParametersDefinitionProperty>
+      <parameterDefinitions>
+        <hudson.model.StringParameterDefinition>
+          <name>param1</name>
+          <description/>
+          <defaultValue/>
+        </hudson.model.StringParameterDefinition>
+      </parameterDefinitions>
+    </hudson.model.ParametersDefinitionProperty>
+  </properties>
+  <scm class="hudson.scm.NullSCM"/>
+  <canRoam>true</canRoam>
+  <disabled>false</disabled>
+  <blockBuildWhenDownstreamBuilding>false</blockBuildWhenDownstreamBuilding>
+  <blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>
+  <triggers class="vector"/>
+  <concurrentBuild>false</concurrentBuild>
+  <builders/>
+  <publishers>
+    <hudson.plugins.parameterizedtrigger.BuildTrigger>
+      <configs>
+        <hudson.plugins.parameterizedtrigger.BuildTriggerConfig>
+          <configs>
+            <hudson.plugins.parameterizedtrigger.PredefinedBuildParameters>
+              <properties/>
+            </hudson.plugins.parameterizedtrigger.PredefinedBuildParameters>
+          </configs>
+          <projects>project_name</projects>
+          <condition>SUCCESS</condition>
+          <triggerWithNoParameters>false</triggerWithNoParameters>
+        </hudson.plugins.parameterizedtrigger.BuildTriggerConfig>
+      </configs>
+    </hudson.plugins.parameterizedtrigger.BuildTrigger>
+    <jenkins.plugins.hipchat.HipChatNotifier>
+      <jenkinsUrl>https://jenkins_url/</jenkinsUrl>
+      <authToken>auth_token</authToken>
+      <room>room name</room>
+    </jenkins.plugins.hipchat.HipChatNotifier>
+  </publishers>
+  <buildWrappers/>
+  <dsl>guard {
+    build("job_name1", param1: params["param1"]);
+    } rescue {
+    build("job_name2", param1: build21.environment.get("some_var"))
+    }
+  </dsl>
+</com.cloudbees.plugins.flow.BuildFlow>

data/spec/unit_tests/fixtures/files/Job-Build-Flow.yaml

@@ -0,0 +1,22 @@
+---
+- job:
+    name: Job-Build-Flow
+    job_type: build_flow
+    hipchat:
+        room: 'HipChat Room Name'
+        start-notify: true
+    parameters:
+      - name: param1
+    publishers:
+      - downstream:
+          project: project_name
+      - hipchat:
+          jenkinsUrl: 'https://jenkins_url/'
+          authToken: 'auth_token'
+          room: 'room name'
+    build_flow: |
+      guard {
+        build("job_name1", param1: params["param1"]);
+      } rescue {
+        build("job_name2", param1: build21.environment.get("some_var"))
+      }

data/spec/unit_tests/fixtures/files/Job-Build-Maven.xml

@@ -0,0 +1,90 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project>
+  <actions/>
+  <description/>
+  <keepDependencies>false</keepDependencies>
+  <properties/>
+  <scm class="hudson.plugins.git.GitSCM">
+    <configVersion>2</configVersion>
+    <userRemoteConfigs>
+      <hudson.plugins.git.UserRemoteConfig>
+        <name/>
+        <refspec/>
+        <url>git@github.com:devops/repo.git</url>
+      </hudson.plugins.git.UserRemoteConfig>
+    </userRemoteConfigs>
+    <branches>
+      <hudson.plugins.git.BranchSpec>
+        <name>release</name>
+      </hudson.plugins.git.BranchSpec>
+    </branches>
+    <localBranch>release</localBranch>
+    <disableSubmodules>false</disableSubmodules>
+    <recursiveSubmodules>false</recursiveSubmodules>
+    <doGenerateSubmoduleConfigurations>false</doGenerateSubmoduleConfigurations>
+    <authorOrCommitter>false</authorOrCommitter>
+    <clean>false</clean>
+    <wipeOutWorkspace>true</wipeOutWorkspace>
+    <pruneBranches>false</pruneBranches>
+    <remotePoll>false</remotePoll>
+    <ignoreNotifyCommit>false</ignoreNotifyCommit>
+    <useShallowClone>false</useShallowClone>
+    <buildChooser class="hudson.plugins.git.util.DefaultBuildChooser"/>
+    <gitTool>Default</gitTool>
+    <submoduleCfg class="list"/>
+    <relativeTargetDir/>
+    <reference/>
+    <excludedRegions/>
+    <excludedUsers>user</excludedUsers>
+    <gitConfigName/>
+    <gitConfigEmail/>
+    <skipTag>false</skipTag>
+    <includedRegions/>
+    <scmName/>
+  </scm>
+  <canRoam>true</canRoam>
+  <disabled>false</disabled>
+  <blockBuildWhenDownstreamBuilding>false</blockBuildWhenDownstreamBuilding>
+  <blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>
+  <triggers class="vector"/>
+  <concurrentBuild>false</concurrentBuild>
+  <builders>
+    <hudson.tasks.Shell>
+      <command>echo 'Doing some work'
+        run command1
+      </command>
+    </hudson.tasks.Shell>
+    <org.jfrog.hudson.maven3.Maven3Builder>
+      <mavenName>tools-maven-3.0.3</mavenName>
+      <rootPom/>
+      <goals>-B clean</goals>
+      <mavenOpts/>
+    </org.jfrog.hudson.maven3.Maven3Builder>
+  </builders>
+  <publishers>
+    <hudson.plugins.descriptionsetter.DescriptionSetterPublisher>
+      <regexp>See the QE build details at (.*)</regexp>
+      <regexpForFailed>See the QE build details at (.*)</regexpForFailed>
+      <description>QE Build Details: &lt;a href="\1"&gt;\1&lt;/a&gt;</description>
+      <descriptionForFailed>QE Build Details: &lt;a href="\1"&gt;\1&lt;/a&gt;</descriptionForFailed>
+      <setForMatrix>false</setForMatrix>
+    </hudson.plugins.descriptionsetter.DescriptionSetterPublisher>
+    <hudson.plugins.parameterizedtrigger.BuildTrigger>
+      <configs>
+        <hudson.plugins.parameterizedtrigger.BuildTriggerConfig>
+          <configs>
+            <hudson.plugins.parameterizedtrigger.PredefinedBuildParameters>
+              <properties>VM_NAME=${VM_NAME}</properties>
+            </hudson.plugins.parameterizedtrigger.PredefinedBuildParameters>
+          </configs>
+          <projects>project_name</projects>
+          <condition>SUCCESS</condition>
+          <triggerWithNoParameters>false</triggerWithNoParameters>
+        </hudson.plugins.parameterizedtrigger.BuildTriggerConfig>
+      </configs>
+    </hudson.plugins.parameterizedtrigger.BuildTrigger>
+  </publishers>
+  <buildWrappers>
+    <hudson.plugins.timestamper.TimestamperBuildWrapper/>
+  </buildWrappers>
+</project>

data/spec/unit_tests/fixtures/files/Job-Build-Maven.yaml

@@ -0,0 +1,26 @@
+---
+- job:
+    name: Job-Build-Maven
+    scm_provider: git
+    scm_url: git@github.com:devops/repo.git
+    scm_branch: release
+    scm_params:
+      local_branch: release
+      wipe_workspace: true
+      excuded_users: user
+    builders:
+      - shell_command: |
+          echo 'Doing some work'
+          run command1
+      - maven3:
+          goals: -B clean
+    publishers:
+      - description_setter:
+          regexp: See the QE build details at (.*)
+          description: 'QE Build Details: <a href="\1">\1</a>'
+      - downstream:
+          project: project_name
+          data:
+            - params: VM_NAME=${VM_NAME}
+    wrappers:
+      - timestamp: true