jenkins_pipeline_builder 0.14.0 → 0.15.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDBiZGQ1ODhjMWU2ZTE0Mjk0MDM5ZjIzMmUyYzMwOTcyMDc2ODJkMA==
+    MjAwOGQ5NDM1MmMyYTkzNjExNzViMWYyMzRlMzFiYTYwMTc0ZTU3MA==
   data.tar.gz: !binary |-
-    OTExNDQ5YjYyYTlhYzUxNjgxY2QzMDI4ODkyZDM5NjQ4MDI1NDg1Mw==
+    MzlmOGIxNmRhYWFiYjYyMDUxNmIzNzZjOGFhZTIxNmUxNmE2NjhmMA==
 SHA512:
   metadata.gz: !binary |-
-    ZmRkMmE4OTA3MDA3YjZkM2Q2NDJkZGFhMTA1Njc0MGQ1N2E2NTBhYzgzYWM1
-    Mjc5ZjMzNjVhMDJjODI3ZjQ4ZDc4MTdjN2VlNjI0NjlmN2M1NDEyNWY2OWI4
-    YmMzMDJjNTZmYmIzNTk4NzNkMjc5MWRlMGE2ZDFlNTkxOWVjMGQ=
+    YzMwNWQzZjliNGFkZTY5ZjY5NzgzMzY1MTdmZThjZjI5MjhkNDAwNzVhNzE3
+    YTI2ZGY5ZWVhNWRhMDliOWVmNGE1NGIwNDdhYjEwNTdiNjM5MGVmYzExOTY5
+    YmU1NmJmZGYxZjlhMTJmZWRlNTU2OWY0ZGQ1MWVjOWY5YjI1OTE=
   data.tar.gz: !binary |-
-    ZjEwYjc1ODg1MzliMzNkYzkwM2M2ZDU4MGJhNjc4M2EwMTlmMWEzYTNlMmRi
-    Zjk3ZTM3YTlkYzBmOThjOWI1ODJhNzgyMzFhNGI2OWM3YTk5NWY3NWY5OThh
-    Y2M4ZWRmOWQ3YTA2MWJjMjk3OWZhZDkwZGI0YmJlZTgxYTQyOWY=
+    ZGMwNjliZDJiNWQ4YWJlZTlmOWQxZjVlMTQxNjQwOTgwYjc5YTUyMDA2NWU1
+    NDdlZDgzMjg5YmJhY2U1NTY2NWM3YWI1NzhhZmU5OGQ1Y2M3ZTBjOTQ1NjU0
+    MmY5N2E5Zjc5NzNjMTExYmIwYjNkOWM4NDcwZGIzOTU2NGFlNjE=

data/.simplecov

@@ -3,10 +3,10 @@ SimpleCov.profiles.define 'spec' do
   add_group 'jenkins_pipeline_builder', '/lib/'
   add_filter 'spec'
   coverage_dir 'out/coverage'
-  formatter SimpleCov::Formatter::MultiFormatter[
+  formatter SimpleCov::Formatter::MultiFormatter.new([
                 SimpleCov::Formatter::Console,
                 SimpleCov::Formatter::RcovFormatter,
-            ]
+            ])
 end
 
 class SimpleCov::Formatter::Console

data/circle.yml

@@ -0,0 +1,8 @@
+machine:
+  timezone:
+    America/New_York
+
+test:
+  override:
+    - bundle exec rake
+

data/lib/jenkins_pipeline_builder/cli/helper.rb

@@ -34,6 +34,12 @@ module JenkinsPipelineBuilder
     # This is the helper class that sets up the credentials from the command
     # line parameters given and initializes the Jenkins Pipeline Builder.
     class Helper
+      class << self
+        attr_accessor :jenkins_api_creds
+      end
+
+      DEFAULT_FILE_FORMATS = %w(rb json yaml).freeze
+
       # Sets up the credentials and initializes the Jenkins Pipeline Builder
       #
       # @param [Hash] options Options obtained from the command line
@@ -41,23 +47,24 @@ module JenkinsPipelineBuilder
       # @return [JenkinsPipelineBuilder::Generator] A new Client object
       #
       def self.setup(options)
-        creds = process_creds options
+        process_creds options
 
-        JenkinsPipelineBuilder.credentials = creds
+        JenkinsPipelineBuilder.credentials = jenkins_api_creds
         generator = JenkinsPipelineBuilder.generator
         JenkinsPipelineBuilder.debug! if options[:debug]
         generator
       end
 
       def self.process_creds(options)
-        if valid_cli_creds? options
+        default_file = find_default_file
+        if options[:debug]
+          self.jenkins_api_creds = { username: :foo, password: :bar, server_ip: :baz }
+        elsif valid_cli_creds? options
           process_cli_creds(options)
         elsif options[:creds_file]
           process_creds_file options[:creds_file]
-        elsif File.exist?("#{ENV['HOME']}/.jenkins_api_client/login.yml")
-          YAML.load_file(File.expand_path("#{ENV['HOME']}/.jenkins_api_client/login.yml", __FILE__))
-        elsif options[:debug]
-          { username: :foo, password: :bar, server_ip: :baz }
+        elsif default_file
+          process_creds_file default_file
         else
           msg = 'Credentials are not set. Please pass them as parameters or'
           msg << ' set them in the default credentials file'
@@ -71,23 +78,45 @@ module JenkinsPipelineBuilder
       end
 
       def self.process_creds_file(file)
-        return JSON.parse(IO.read(File.expand_path(file))) if file.end_with? 'json'
-        YAML.load_file(File.expand_path(file))
+        return load File.expand_path(file) if file.end_with? 'rb'
+        return self.jenkins_api_creds = JSON.parse(IO.read(File.expand_path(file))) if file.end_with? 'json'
+        self.jenkins_api_creds = YAML.load_file(File.expand_path(file))
       end
 
       def self.process_cli_creds(options)
-        creds = {}.with_indifferent_access.merge options
-        if creds[:server] =~ Resolv::AddressRegex
-          creds[:server_ip] = creds.delete :server
-        elsif creds[:server] =~ URI.regexp
-          creds[:server_url] = creds.delete :server
+        self.jenkins_api_creds = {}.with_indifferent_access.merge options
+        if jenkins_api_creds[:server] =~ Resolv::AddressRegex
+          jenkins_api_creds[:server_ip] = jenkins_api_creds.delete :server
+        elsif jenkins_api_creds[:server] =~ URI.regexp
+          jenkins_api_creds[:server_url] = jenkins_api_creds.delete :server
         else
-          msg = "server given (#{creds[:server]}) is neither a URL nor an IP."
+          msg = "server given (#{jenkins_api_creds[:server]}) is neither a URL nor an IP."
           msg << ' Please pass either a valid IP address or valid URI'
           $stderr.puts msg
           exit 1
         end
-        creds
+      end
+
+      private_class_method
+
+      def self.find_default_file
+        default_file_name = "#{ENV['HOME']}/.jenkins_api_client/login"
+
+        found_suffix = nil
+        DEFAULT_FILE_FORMATS.each do |suffix|
+          next unless File.exist?("#{default_file_name}.#{suffix}")
+          if !found_suffix
+            found_suffix = suffix
+          else
+            logger.warn "Multiple default files found! Using '#{default_file_name}.#{found_suffix}' but \
+'#{default_file_name}.#{suffix}' found."
+          end
+        end
+        "#{ENV['HOME']}/.jenkins_api_client/login.#{found_suffix}" if found_suffix
+      end
+
+      def self.logger
+        JenkinsPipelineBuilder.logger
       end
     end
   end

data/lib/jenkins_pipeline_builder/version.rb

@@ -21,5 +21,5 @@
 #
 
 module JenkinsPipelineBuilder
-  VERSION = '0.14.0'.freeze
+  VERSION = '0.15.0'.freeze
 end

data/spec/lib/jenkins_pipeline_builder/cli/helper_spec.rb

@@ -2,6 +2,8 @@ require File.expand_path('../../spec_helper', __FILE__)
 
 describe JenkinsPipelineBuilder::CLI::Helper do
   context '#setup' do
+    let(:creds_file_base) { 'spec/lib/jenkins_pipeline_builder/fixtures/sample_creds' }
+
     context 'username and password given' do
       let(:options) do
         {
@@ -46,8 +48,6 @@ describe JenkinsPipelineBuilder::CLI::Helper do
     end
 
     context 'credential file given' do
-      let(:creds_file_base) { 'spec/lib/jenkins_pipeline_builder/fixtures/sample_creds' }
-
       let(:expected_options) do
         {
           'username' => 'username',
@@ -61,6 +61,7 @@ describe JenkinsPipelineBuilder::CLI::Helper do
         options = {
           creds_file: "#{creds_file_base}.yaml"
         }
+        expect(YAML).to receive(:load_file).and_call_original
         expect(JenkinsPipelineBuilder).to receive(:credentials=).with(expected_options)
         described_class.setup(options)
       end
@@ -69,6 +70,16 @@ describe JenkinsPipelineBuilder::CLI::Helper do
         options = {
           creds_file: "#{creds_file_base}.json"
         }
+        expect(JSON).to receive(:parse).and_call_original
+        expect(JenkinsPipelineBuilder).to receive(:credentials=).with(expected_options)
+        described_class.setup(options)
+      end
+
+      it 'should handle credentials passed as a ruby file' do
+        options = {
+          creds_file: "#{creds_file_base}.rb"
+        }
+        expect(File).to receive(:expand_path).with(options[:creds_file]).and_call_original
         expect(JenkinsPipelineBuilder).to receive(:credentials=).with(expected_options)
         described_class.setup(options)
       end
@@ -86,10 +97,79 @@ describe JenkinsPipelineBuilder::CLI::Helper do
       end
 
       it 'should puts and error to stdout and exit if no credentials are passed' do
-        expect(File).to receive(:exist?).and_return(false)
+        allow(File).to receive(:exist?).and_return(false)
         expect($stderr).to receive(:puts).with(/Credentials are not set/)
         expect { described_class.setup({}) }.to raise_error(SystemExit, 'exit')
       end
     end
+
+    context 'default credential files' do
+      let(:default_creds_base) { '/foo/.jenkins_api_client/login' }
+
+      before(:each) do
+        allow(ENV).to receive(:[]).with('HOME').and_return '/foo'
+      end
+
+      it 'checks for all 3 supported formats in order' do
+        expect(File).to receive(:exist?).with("#{default_creds_base}.rb")
+        expect(File).to receive(:exist?).with("#{default_creds_base}.json")
+        expect(File).to receive(:exist?).with("#{default_creds_base}.yaml")
+        expect { described_class.setup({}) }.to raise_error(SystemExit, 'exit')
+      end
+
+      it 'loads the default ruby file' do
+        expect(File).to receive(:exist?).with("#{default_creds_base}.rb").and_return true
+        expect(File).to receive(:exist?).with("#{default_creds_base}.json").and_return false
+        expect(File).to receive(:exist?).with("#{default_creds_base}.yaml").and_return false
+        expect(File).to receive(:expand_path).with("#{default_creds_base}.rb").and_return "#{creds_file_base}.rb"
+        described_class.setup({})
+      end
+
+      it 'loads the default json file' do
+        expect(File).to receive(:exist?).with("#{default_creds_base}.rb").and_return false
+        expect(File).to receive(:exist?).with("#{default_creds_base}.json").and_return true
+        expect(File).to receive(:exist?).with("#{default_creds_base}.yaml").and_return false
+        expect(File).to receive(:expand_path).with("#{default_creds_base}.json").and_return "#{creds_file_base}.json"
+        expect(JSON).to receive(:parse).and_call_original
+        described_class.setup({})
+      end
+
+      it 'loads the default yaml file' do
+        expect(File).to receive(:exist?).with("#{default_creds_base}.rb").and_return false
+        expect(File).to receive(:exist?).with("#{default_creds_base}.json").and_return false
+        expect(File).to receive(:exist?).with("#{default_creds_base}.yaml").and_return true
+        expect(File).to receive(:expand_path).with("#{default_creds_base}.yaml").and_return "#{creds_file_base}.yaml"
+        expect(YAML).to receive(:load_file).and_call_original
+        described_class.setup({})
+      end
+
+      it 'warns if both ruby and yaml' do
+        used_suffix = 'rb'
+        found_suffix = 'yaml'
+        expect(File).to receive(:exist?).with("#{default_creds_base}.rb").and_return true
+        expect(File).to receive(:exist?).with("#{default_creds_base}.json").and_return false
+        expect(File).to receive(:exist?).with("#{default_creds_base}.yaml").and_return true
+        expect(JenkinsPipelineBuilder.logger).to receive(:warn)
+          .with(/'#{default_creds_base}\.#{used_suffix}' but '#{default_creds_base}\.#{found_suffix}' found\./)
+          .and_return true
+        expect(File).to receive(:expand_path)
+          .with("#{default_creds_base}.#{used_suffix}").and_return "#{creds_file_base}.#{used_suffix}"
+        described_class.setup({})
+      end
+
+      it 'warns if both ruby and json' do
+        used_suffix = 'rb'
+        found_suffix = 'json'
+        expect(File).to receive(:exist?).with("#{default_creds_base}.rb").and_return true
+        expect(File).to receive(:exist?).with("#{default_creds_base}.json").and_return true
+        expect(File).to receive(:exist?).with("#{default_creds_base}.yaml").and_return false
+        expect(JenkinsPipelineBuilder.logger).to receive(:warn)
+          .with(/'#{default_creds_base}\.#{used_suffix}' but '#{default_creds_base}\.#{found_suffix}' found\./)
+          .and_return true
+        expect(File).to receive(:expand_path)
+          .with("#{default_creds_base}.#{used_suffix}").and_return "#{creds_file_base}.#{used_suffix}"
+        described_class.setup({})
+      end
+    end
   end
 end

data/spec/lib/jenkins_pipeline_builder/fixtures/sample_creds.rb

@@ -0,0 +1,6 @@
+JenkinsPipelineBuilder::CLI::Helper.jenkins_api_creds = {
+  'username' => 'username',
+  'password' => 'password',
+  'server_url' => 'https://localhost.localdomain',
+  'server_port' => 8080
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jenkins_pipeline_builder
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Igor Moochnick
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-05 00:00:00.000000000 Z
+date: 2016-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -331,6 +331,7 @@ files:
 - README.md
 - Rakefile
 - bin/generate
+- circle.yml
 - commit_build.sh
 - config/login.yml
 - example/pipeline/.ruby-version
@@ -426,6 +427,7 @@ files:
 - spec/lib/jenkins_pipeline_builder/fixtures/job_collection/extensions/extension.rb
 - spec/lib/jenkins_pipeline_builder/fixtures/job_collection/extensions/helpers/my_test_thing_helper.rb
 - spec/lib/jenkins_pipeline_builder/fixtures/sample_creds.json
+- spec/lib/jenkins_pipeline_builder/fixtures/sample_creds.rb
 - spec/lib/jenkins_pipeline_builder/fixtures/sample_creds.yaml
 - spec/lib/jenkins_pipeline_builder/fixtures/view_test/duplicate_view.yaml
 - spec/lib/jenkins_pipeline_builder/fixtures/view_test/parent_view.yaml
@@ -512,6 +514,7 @@ test_files:
 - spec/lib/jenkins_pipeline_builder/fixtures/job_collection/extensions/extension.rb
 - spec/lib/jenkins_pipeline_builder/fixtures/job_collection/extensions/helpers/my_test_thing_helper.rb
 - spec/lib/jenkins_pipeline_builder/fixtures/sample_creds.json
+- spec/lib/jenkins_pipeline_builder/fixtures/sample_creds.rb
 - spec/lib/jenkins_pipeline_builder/fixtures/sample_creds.yaml
 - spec/lib/jenkins_pipeline_builder/fixtures/view_test/duplicate_view.yaml
 - spec/lib/jenkins_pipeline_builder/fixtures/view_test/parent_view.yaml