jenkins_pipeline_builder 0.5.2 → 0.6.0

data/spec/lib/jenkins_pipeline_builder/fixtures/generator_tests/pullrequest_pipeline/PullRequest-10-SampleJob.yaml

@@ -0,0 +1,2 @@
+- job:
+    name: '{{name}}-10-SampleJob'

data/spec/lib/jenkins_pipeline_builder/fixtures/generator_tests/pullrequest_pipeline/PullRequest-40-PullRequestGenerator.yaml

@@ -0,0 +1,12 @@
+- job:
+    name: '{{name}}-40-PullRequestGenerator'
+    job_type: pull_request_generator
+    git_url: '{{git_url}}'
+    git_repo: '{{git_repo}}'
+    git_org: '{{git_org}}'
+    jobs: 
+      - '{{name}}-10-SampleJob'
+    builders:
+      - shell_command: |
+          generate -v || gem install jenkins_pipeline_builder
+          generate pipeline -d pull_request pipeline/ PullRequest

data/spec/lib/jenkins_pipeline_builder/fixtures/generator_tests/pullrequest_pipeline/project.yaml

@@ -0,0 +1,12 @@
+- defaults:
+    name: global
+    description: 'Test pipeline for generator_spec.rb'
+    git_url: 'https://github.com'
+    git_org: 'bencentra'
+    git_repo: 'generator_tests'
+
+- project: 
+    name: PullRequest
+    jobs:
+      - '{{name}}-10-SampleJob'
+      - '{{name}}-40-PullRequestGenerator'

data/spec/lib/jenkins_pipeline_builder/fixtures/generator_tests/sample_pipeline/SamplePipeline-10-Commit.yaml

@@ -0,0 +1,3 @@
+- job:
+    name: '{{name}}-10-Commit'
+    description: '{{description}}'

data/spec/lib/jenkins_pipeline_builder/fixtures/generator_tests/sample_pipeline/SamplePipeline-20-Acceptance.yaml

@@ -0,0 +1,3 @@
+- job:
+    name: '{{name}}-20-Acceptance'
+    description: '{{description}}'

data/spec/lib/jenkins_pipeline_builder/fixtures/generator_tests/sample_pipeline/SamplePipeline-30-Release.yaml

@@ -0,0 +1,3 @@
+- job:
+    name: '{{name}}-30-Release'
+    description: '{{description}}'

data/spec/lib/jenkins_pipeline_builder/fixtures/generator_tests/sample_pipeline/project.yaml

@@ -0,0 +1,12 @@
+- defaults:
+    name: global
+    description: 'Test pipeline for generator_spec.rb'
+
+- project:
+    name: SamplePipeline
+    jobs:
+      - '{{name}}-10-Commit'
+      - '{{name}}-20-Acceptance'
+      - '{{name}}-30-Release'
+    views:
+      - '{{name}} View'

data/spec/lib/jenkins_pipeline_builder/fixtures/generator_tests/sample_pipeline/view.yaml

@@ -0,0 +1,5 @@
+- view:
+    name: '{{name}} View'
+    type: 'listview'
+    description: '{{description}}'
+    regex: '{{name}}.*'

data/spec/lib/jenkins_pipeline_builder/fixtures/generator_tests/template_pipeline/project.yaml

@@ -0,0 +1,15 @@
+- defaults:
+    name: global
+    description: 'Test pipeline for generator_spec.rb'
+
+- dependencies: 
+    - source: 
+        url: 'spec/lib/jenkins_pipeline_builder/fixtures/generator_tests/template_pipeline/jobs.tar.gz'
+        templates:
+          - name: test_temp
+
+- project:
+    name: TemplatePipeline
+    jobs:
+      - '{{name}}-10'
+      - '{{name}}-11'

data/spec/lib/jenkins_pipeline_builder/fixtures/generator_tests/test_job.xml

@@ -0,0 +1,48 @@
+<?xml version="1.0"?>
+<project>
+    <actions/>
+    <description>Jenkins Lab Step 1</description>
+    <keepDependencies>false</keepDependencies>
+    <properties>
+        <jenkins.plugins.hipchat.HipChatNotifier_-HipChatJobProperty plugin="hipchat@0.1.5">
+            <room/>
+            <startNotification>false</startNotification>
+            <notifySuccess>false</notifySuccess>
+            <notifyAborted>false</notifyAborted>
+            <notifyNotBuilt>false</notifyNotBuilt>
+            <notifyUnstable>false</notifyUnstable>
+            <notifyFailure>false</notifyFailure>
+            <notifyBackToNormal>false</notifyBackToNormal>
+        </jenkins.plugins.hipchat.HipChatNotifier_-HipChatJobProperty>
+        <jenkins.advancedqueue.AdvancedQueueSorterJobProperty plugin="PrioritySorter@2.6">
+            <useJobPriority>false</useJobPriority>
+            <priority>-1</priority>
+        </jenkins.advancedqueue.AdvancedQueueSorterJobProperty>
+        <hudson.plugins.throttleconcurrents.ThrottleJobProperty plugin="throttle-concurrents@1.8.2">
+            <maxConcurrentPerNode>0</maxConcurrentPerNode>
+            <maxConcurrentTotal>0</maxConcurrentTotal>
+            <throttleEnabled>false</throttleEnabled>
+            <throttleOption>project</throttleOption>
+        </hudson.plugins.throttleconcurrents.ThrottleJobProperty>
+    </properties>
+    <scm class="hudson.scm.NullSCM"/>
+    <canRoam>true</canRoam>
+    <disabled>false</disabled>
+    <blockBuildWhenDownstreamBuilding>false</blockBuildWhenDownstreamBuilding>
+    <blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>
+    <triggers/>
+    <concurrentBuild>false</concurrentBuild>
+    <builders>
+        <hudson.tasks.Shell>
+            <command>echo "Hello" &gt; artifact.txt</command>
+        </hudson.tasks.Shell>
+    </builders>
+    <publishers>
+        <hudson.tasks.ArtifactArchiver>
+            <artifacts>artifact.txt</artifacts>
+            <latestOnly>false</latestOnly>
+            <allowEmptyArchive>false</allowEmptyArchive>
+        </hudson.tasks.ArtifactArchiver>
+    </publishers>
+    <buildWrappers/>
+</project>

data/spec/lib/jenkins_pipeline_builder/fixtures/view_test/duplicate_view.yaml

@@ -0,0 +1,4 @@
+- view:
+    name: 'duplicate_view'
+    type: 'categorizedView'
+    description: 'ViewTest'

data/spec/lib/jenkins_pipeline_builder/fixtures/view_test/parent_view.yaml

@@ -0,0 +1,9 @@
+- view:
+    name: 'view'
+    parent_view: 'ParentView'
+    type: 'categorizedView'
+    description: 'ViewTest'
+    regex: 'ViewTest.*'
+    groupingRules: 
+      - groupRegex: "ViewTest-1.*"
+        namingRule: "1. Commit Stage"

data/spec/lib/jenkins_pipeline_builder/fixtures/view_test/regular_view.yaml

@@ -0,0 +1,5 @@
+- view:
+    name: 'RegularView'
+    type: 'listview'
+    description: 'ViewTest'
+    status_filter: enabled_jobs_only

data/spec/lib/jenkins_pipeline_builder/generator_spec.rb

@@ -0,0 +1,165 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe JenkinsPipelineBuilder::Generator do
+
+  before(:all) do
+    JenkinsPipelineBuilder.credentials = {
+      server_ip: '127.0.0.1',
+      server_port: 8080,
+      username: 'username',
+      password: 'password',
+      log_location: '/dev/null'
+    }
+    JenkinsPipelineBuilder.client
+    @generator = JenkinsPipelineBuilder.generator
+  end
+
+  after(:each) do
+    @generator.debug = false
+    @generator.job_collection = {}
+    @generator.remote_depends = {}
+    @generator.module_registry = JenkinsPipelineBuilder::ModuleRegistry.new
+    JenkinsPipelineBuilder.load_registry
+  end
+
+  describe 'initialized in before(:example)' do
+    it 'creates a new generator' do
+      expect(@generator.job_collection).to be_empty
+      expect(@generator.module_registry).not_to be_nil
+    end
+
+    it 'accepts new jobs into the job_collection' do
+      job_name = 'sample_job'
+      job_type = 'project'
+      job_value = {}
+      @generator.job_collection[job_name] = { name: job_name, type: job_type, value: job_value }
+      expect(@generator.job_collection).not_to be_empty
+      expect(@generator.job_collection[job_name]).not_to be_nil
+    end
+  end
+
+  describe '#debug=' do
+    it 'sets debug mode to false' do
+      @generator.debug = false
+      expect(@generator.debug).to be false
+      expect(@generator.logger.level).to eq(Logger::INFO)
+    end
+
+    it 'sets debug mode to true' do
+      @generator.debug = true
+      expect(@generator.debug).to be true
+      expect(@generator.logger.level).to eq(Logger::DEBUG)
+    end
+  end
+
+  describe '#client' do
+    it 'returns the singleton JenkinsPipelineBuilder.client object' do
+      expect(@generator.client).to be(JenkinsPipelineBuilder.client)
+    end
+  end
+
+  describe '#view' do
+    it 'returns a new JenkinsPipelineBuilder::View object' do
+      view = @generator.view
+      expect(view).not_to be_nil
+      # expect(view.generator).to be(@generator)
+    end
+  end
+
+  describe '#bootstrap' do
+    it 'produces no errors while creating pipeline SamplePipeline with view' do
+      @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
+    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
+    end
+    # Things to check for:
+    # Fail - Finds duplicate job names (load_job_collection)
+    # Extension fails to register?
+    # resolve_project returns false
+    # Accumulates errors in publish_project/job path
+    it 'produces no errors while creating a job dsl'
+  end
+
+  describe '#pull_request' do
+    it 'produces no errors while creating pipeline PullRequest' do
+      # Dummy data
+      purge = []
+      create = [
+        {
+          name: 'PullRequest-PR1',
+          type: :project,
+          value: {
+            name: 'PullRequest-PR1',
+            jobs: [
+              '{{name}}-10-SampleJob'
+            ]
+          }
+        }
+      ]
+      jobs = {
+        '{{name}}-10-SampleJob' => {
+          name: '{{name}}-10-SampleJob',
+          type: :job,
+          value: {
+            name: '{{name}}-10-SampleJob',
+            scm_branch: 'origin/pr/2/head',
+            scm_params: {
+              refspec: 'refs/pull/*:refs/remotes/origin/pr/*'
+            }
+          }
+        }
+      }
+      # Run the test
+      @generator.debug = true
+      job_name = 'PullRequest'
+      path = File.expand_path('../fixtures/generator_tests/pullrequest_pipeline', __FILE__)
+      JenkinsPipelineBuilder::PullRequestGenerator.should_receive(:new).once.and_return(
+        double(purge: purge, create: create, jobs: jobs)
+      )
+      success = @generator.pull_request(path, job_name)
+      expect(success).to be_truthy
+      Dir["#{job_name}*.xml"].each do |file|
+        File.delete(file)
+      end
+    end
+    # Things to check for
+    # Fail - no PR job type found
+    # Encounters failure during build process
+    # Fails to purge old PR jobs from Jenkins
+  end
+
+  describe '#dump' do
+    it "writes a job's config XML to a file" do
+      @generator.debug = true
+      job_name = 'test_job'
+      body = ''
+      test_path = File.expand_path('../fixtures/generator_tests', __FILE__)
+      File.open("#{test_path}/#{job_name}.xml", 'r') do |f|
+        f.each_line do |line|
+          body << line
+        end
+      end
+      stub_request(:get, 'http://username:password@127.0.0.1:8080/job/test_job/config.xml')
+         .to_return(status:  200, body:  "#{body}", headers:  {})
+      @generator.dump(job_name)
+      expect(File.exist?("#{job_name}.xml")).to be true
+      File.delete("#{job_name}.xml")
+    end
+  end
+end

data/spec/lib/jenkins_pipeline_builder/module_registry_spec.rb

@@ -0,0 +1,147 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe JenkinsPipelineBuilder::ModuleRegistry do
+  describe '#register' do
+    it 'should return item by a specified path' do
+
+      registry = JenkinsPipelineBuilder::ModuleRegistry.new
+      ext = double
+      allow(ext).to receive(:name).and_return :foo
+      registry.register [:job], ext
+
+      expect(registry.get('job/foo').first.name).to eq :foo
+    end
+
+    it 'registered the builders correctly' do
+      builders = {
+        multi_job: [0],
+        maven3: [0],
+        shell_command: [0],
+        inject_vars_file: [0],
+        blocking_downstream: [0],
+        remote_job: [0],
+        copy_artifact: [0]
+      }
+      registry = JenkinsPipelineBuilder.registry.registry
+      expect(registry[:job][:builders].size).to eq builders.size
+      builders.each do |builder, versions|
+        expect(registry[:job][:builders]).to have_key builder
+
+        versions.each do |version|
+          expect(registry[:job][:builders][builder]).to have_min_version version
+        end
+      end
+    end
+    it 'registered the triggers correctly' do
+      triggers = {
+        git_push: [0],
+        scm_polling: [0],
+        periodic_build: [0],
+        upstream: [0]
+      }
+      registry = JenkinsPipelineBuilder.registry.registry
+      expect(registry[:job][:triggers].size).to eq triggers.size
+      triggers.each do |trigger, versions|
+        expect(registry[:job][:triggers]).to have_key trigger
+
+        versions.each do |version|
+          expect(registry[:job][:triggers][trigger]).to have_min_version version
+        end
+      end
+    end
+    it 'registered the job_attributes correctly' do
+      job_attributes = {
+        description: [0],
+        scm_params: [0],
+        hipchat: [0],
+        priority: [0],
+        parameters: [0],
+        discard_old: [0],
+        throttle: [0],
+        prepare_environment: [0],
+        concurrent_build: [0]
+      }
+      registry = JenkinsPipelineBuilder.registry.registry
+      # There are 4 sub types so, we don't count those
+      expect(registry[:job].size - 4).to eq job_attributes.size
+      job_attributes.each do |job_attribute, versions|
+        expect(registry[:job]).to have_key job_attribute
+
+        versions.each do |version|
+          expect(registry[:job][job_attribute]).to have_min_version version
+        end
+      end
+    end
+    it 'registered the publishers correctly' do
+      publishers = {
+        description_setter: [0],
+        downstream: [0],
+        hipchat: [0],
+        git: [0],
+        junit_result: [0],
+        coverage_result: [0],
+        post_build_script: [0],
+        groovy_postbuild: [0],
+        archive_artifact: [0],
+        email_notifications: [0]
+      }
+      registry = JenkinsPipelineBuilder.registry.registry
+      expect(registry[:job][:publishers].size).to eq publishers.size
+      publishers.each do |publisher, versions|
+        expect(registry[:job][:publishers]).to have_key publisher
+
+        versions.each do |version|
+          expect(registry[:job][:publishers][publisher]).to have_min_version version
+        end
+      end
+    end
+    it 'registered the wrappers correctly' do
+      wrappers = {
+        ansicolor: [0],
+        timestamp: [0],
+        name: [0],
+        rvm: ['0', '0.5'],
+        inject_passwords: [0],
+        inject_env_var: [0],
+        artifactory: [0],
+        maven3artifactory: [0]
+      }
+      registry = JenkinsPipelineBuilder.registry.registry
+      expect(registry[:job][:wrappers].size).to eq wrappers.size
+      wrappers.each do |wrapper, versions|
+        expect(registry[:job][:wrappers]).to have_key wrapper
+
+        versions.each do |version|
+          expect(registry[:job][:wrappers][wrapper]).to have_min_version version
+        end
+      end
+    end
+  end
+  describe '#initialize' do
+
+  end
+
+  describe '#entries' do
+
+  end
+
+  describe '#get' do
+
+  end
+
+  describe '#get_by_path_collection' do
+
+  end
+
+  describe '#traverse_registry_path' do
+
+  end
+
+  describe '#traverse_registry' do
+
+  end
+
+  describe '#execute_extension' do
+  end
+
+end