jenkins_api_client 0.12.1 → 0.13.0

data/spec/func_tests/node_spec.rb

@@ -10,6 +10,7 @@ describe JenkinsApi::Client::Node do
   context "With properly initialized client" do
     before(:all) do
       @creds_file = '~/.jenkins_api_client/spec.yml'
+      @valid_post_responses = [200, 201, 302]
       @node_name = 'master'
       begin
         @client = JenkinsApi::Client.new(
@@ -46,9 +47,13 @@ describe JenkinsApi::Client::Node do
 
         def test_and_validate(params)
           name = params[:name]
-          @client.node.create_dump_slave(params).to_i.should == 302
+          @valid_post_responses.should include(
+            @client.node.create_dump_slave(params).to_i
+          )
           @client.node.list(name).include?(name).should be_true
-          @client.node.delete(params[:name]).to_i.should == 302
+          @valid_post_responses.should include(
+            @client.node.delete(params[:name]).to_i
+          )
           @client.node.list(name).include?(name).should be_false
         end
 
@@ -75,7 +80,7 @@ describe JenkinsApi::Client::Node do
           }
           expect(
             lambda{ @client.node.create_dump_slave(params) }
-          ).to raise_error
+          ).to raise_error(ArgumentError)
         end
         it "fails if slave_host is missing" do
           params = {
@@ -84,7 +89,7 @@ describe JenkinsApi::Client::Node do
           }
           expect(
             lambda{ @client.node.create_dump_slave(params) }
-          ).to raise_error
+          ).to raise_error(ArgumentError)
         end
         it "fails if private_key_file is missing" do
           params = {
@@ -93,7 +98,7 @@ describe JenkinsApi::Client::Node do
           }
           expect(
             lambda{ @client.node.create_dump_slave(params) }
-          ).to raise_error
+          ).to raise_error(ArgumentError)
         end
         it "fails if the slave already exists in Jenkins" do
           params = {
@@ -101,11 +106,15 @@ describe JenkinsApi::Client::Node do
             :slave_host => "10.10.10.10",
             :private_key_file => "/root/.ssh/id_rsa"
           }
-          @client.node.create_dump_slave(params).to_i.should == 302
+          @valid_post_responses.should include(
+            @client.node.create_dump_slave(params).to_i
+          )
           expect(
             lambda{ @client.node.create_dump_slave(params) }
-          ).to raise_error
-          @client.node.delete(params[:name]).to_i.should == 302
+          ).to raise_error(JenkinsApi::Exceptions::NodeAlreadyExists)
+          @valid_post_responses.should include(
+            @client.node.delete(params[:name]).to_i
+          )
         end
       end
 
@@ -116,8 +125,12 @@ describe JenkinsApi::Client::Node do
             :slave_host => "10.10.10.10",
             :private_key_file => "/root/.ssh/id_rsa"
           }
-          @client.node.create_dump_slave(params).to_i.should == 302
-          @client.node.delete(params[:name]).to_i.should == 302
+          @valid_post_responses.should include(
+            @client.node.create_dump_slave(params).to_i
+          )
+          @valid_post_responses.should include(
+            @client.node.delete(params[:name]).to_i
+          )
         end
         it "raises an error if the slave doesn't exist in Jenkins" do
           expect(
@@ -167,8 +180,12 @@ describe JenkinsApi::Client::Node do
 
       describe "#change_mode" do
         it "changes the mode of the given slave to the given mode" do
-          @client.node.change_mode("slave", "exclusive").to_i.should == 200
-          @client.node.change_mode("slave", "normal").to_i.should == 200
+          @valid_post_responses.should include(
+            @client.node.change_mode("slave", "exclusive").to_i
+          )
+          @valid_post_responses.should include(
+            @client.node.change_mode("slave", "normal").to_i
+          )
         end
       end
 

data/spec/func_tests/spec_helper.rb

@@ -10,13 +10,8 @@ require 'pp'
 require 'yaml'
 require 'nokogiri'
 
-#RSpec.configure do |config|
-#  config.mock_with :flexmock
-#end
-
 module JenkinsApiSpecHelper
   class Helper
-
     def create_job_xml
       builder = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') { |xml|
         xml.project {
@@ -33,7 +28,7 @@ module JenkinsApiSpecHelper
           xml.concurrentBuild "false"
           xml.builders {
             xml.send("hudson.tasks.Shell") {
-              xml.command "\necho 'going to take a nice nap'\nsleep 10\necho 'took a nice nap'"
+              xml.command "\necho 'going to take a nice nap'\nsleep 15\necho 'took a nice nap'"
             }
           }
           xml.publishers
@@ -42,6 +37,5 @@ module JenkinsApiSpecHelper
       }
       builder.to_xml
     end
-
   end
 end

data/spec/func_tests/system_spec.rb

@@ -10,8 +10,11 @@ describe JenkinsApi::Client::System do
   context "With properly initialized client" do
     before(:all) do
       @creds_file = '~/.jenkins_api_client/spec.yml'
+      @valid_post_responses = [200, 201, 302]
       begin
-        @client = JenkinsApi::Client.new(YAML.load_file(File.expand_path(@creds_file, __FILE__)))
+        @client = JenkinsApi::Client.new(
+          YAML.load_file(File.expand_path(@creds_file, __FILE__))
+        )
       rescue Exception => e
         puts "WARNING: Credentials are not set properly."
         puts e.message
@@ -22,19 +25,25 @@ describe JenkinsApi::Client::System do
 
       describe "#quiet_down" do
         it "Should be able to quiet down a Jenkins server" do
-          @client.system.quiet_down.to_i.should == 302
+          @valid_post_responses.should include(
+            @client.system.quiet_down.to_i
+          )
         end
       end
 
       describe "#cancel_quiet_down" do
         it "Should be able to cancel the quiet down a Jenkins server" do
-          @client.system.cancel_quiet_down.to_i.should == 302
+          @valid_post_responses.should include(
+            @client.system.cancel_quiet_down.to_i
+          )
         end
       end
 
       describe "#restart" do
         it "Should be able to restart a Jenkins server safely" do
-          @client.system.restart.to_i.should == 302
+          @valid_post_responses.should include(
+            @client.system.restart.to_i
+          )
         end
 
         it "Should be able to wait after a safe restart" do
@@ -42,7 +51,9 @@ describe JenkinsApi::Client::System do
         end
 
         it "Should be able to force restart a Jenkins server" do
-          @client.system.restart(true).to_i.should == 302
+          @valid_post_responses.should include(
+            @client.system.restart(true).to_i
+          )
         end
 
         it "Should be able to wait after a force restart" do
@@ -52,13 +63,21 @@ describe JenkinsApi::Client::System do
 
       describe "#reload" do
         it "Should be able to reload a Jenkins server" do
-          @client.system.reload.to_i.should == 302
+          @valid_post_responses.should include(
+            @client.system.reload.to_i
+          )
         end
         it "Should be able to wait after a force restart" do
           @client.system.wait_for_ready.should == true
         end
       end
 
+      describe "#list_users" do
+        it "Should be able to get a list of users" do
+          @client.system.list_users.size == 1
+        end
+      end
+
     end
 
   end

data/spec/func_tests/view_spec.rb

@@ -10,6 +10,7 @@ describe JenkinsApi::Client::View do
   context "With properly initialized client" do
     before(:all) do
       @creds_file = '~/.jenkins_api_client/spec.yml'
+      @valid_post_responses = [200, 201, 302]
       @node_name = 'master'
       begin
         @client = JenkinsApi::Client.new(
@@ -21,7 +22,9 @@ describe JenkinsApi::Client::View do
       end
 
       # Create a view that can be used for tests
-      @client.view.create("general_purpose_view").to_i.should == 302
+      @valid_post_responses.should include(
+        @client.view.create("general_purpose_view").to_i
+      )
     end
 
     describe "InstanceMethods" do
@@ -35,42 +38,75 @@ describe JenkinsApi::Client::View do
       describe "#create" do
         it "accepts the name of the view and creates the view" do
           name = "test_view"
-          @client.view.create(name).to_i.should == 302
+          @valid_post_responses.should include(
+            @client.view.create(name).to_i
+          )
           @client.view.list(name).include?(name).should be_true
-          @client.view.delete(name).to_i.should == 302
+          @valid_post_responses.should include(
+            @client.view.delete(name).to_i
+          )
         end
         it "accepts spaces and other characters in the view name" do
           name = "test view with spaces and {special characters}"
-          @client.view.create(name).to_i.should == 302
+          @valid_post_responses.should include(
+            @client.view.create(name).to_i
+          )
           @client.view.list(name).include?(name).should be_true
-          @client.view.delete(name).to_i.should == 302
+          @valid_post_responses.should include(
+            @client.view.delete(name).to_i
+          )
         end
         it "accepts the name of view and creates a listview" do
           name = "test_view"
-          @client.view.create(name, "listview").to_i.should == 302
+          @valid_post_responses.should include(
+            @client.view.create(name, "listview").to_i
+          )
           @client.view.list(name).include?(name).should be_true
-          @client.view.delete(name).to_i.should == 302
+          @valid_post_responses.should include(
+            @client.view.delete(name).to_i
+          )
         end
         it "accepts the name of view and creates a myview" do
           name = "test_view"
-          @client.view.create(name, "myview").to_i.should == 302
+          @valid_post_responses.should include(
+            @client.view.create(name, "myview").to_i
+          )
           @client.view.list(name).include?(name).should be_true
-          @client.view.delete(name).to_i.should == 302
+          @valid_post_responses.should include(
+            @client.view.delete(name).to_i
+          )
         end
         it "raises an error when unsupported view type is specified" do
           expect(
             lambda { @client.view.create(name, "awesomeview") }
           ).to raise_error
         end
+        it "raises proper error if the view already exists" do
+          name = "duplicate_view"
+          @valid_post_responses.should include(
+            @client.view.create(name, "listview").to_i
+          )
+          @client.view.list(name).include?(name).should be_true
+          expect(
+            lambda { @client.view.create(name, "listview") }
+          ).to raise_error(JenkinsApi::Exceptions::ViewAlreadyExists)
+          @valid_post_responses.should include(
+            @client.view.delete(name).to_i
+          )
+        end
       end
 
       describe "#create_list_view" do
 
         def test_and_validate(params)
           name = params[:name]
-          @client.view.create_list_view(params).to_i.should == 302
+          @valid_post_responses.should include(
+            @client.view.create_list_view(params).to_i
+          )
           @client.view.list(name).include?(name).should be_true
-          @client.view.delete(name).to_i.should == 302
+          @valid_post_responses.should include(
+            @client.view.delete(name).to_i
+          )
           @client.view.list(name).include?(name).should be_false
         end
 
@@ -112,16 +148,34 @@ describe JenkinsApi::Client::View do
           }
           test_and_validate(params)
         end
+        it "raises an error when the input parameters is not a Hash" do
+          expect(
+            lambda {
+              @client.view.create_list_view("a_string")
+            }
+          ).to raise_error(ArgumentError)
+        end
+        it "raises an error when the required name paremeter is missing" do
+          expect(
+            lambda {
+              @client.view.create_list_view(:description => "awesomeview")
+            }
+          ).to raise_error(ArgumentError)
+        end
       end
 
       describe "#delete" do
         name = "test_view_to_delete"
         before(:all) do
-          @client.view.create(name).to_i.should == 302
+          @valid_post_responses.should include(
+            @client.view.create(name).to_i
+          )
         end
         it "accepts the name of the view and deletes from Jenkins" do
           @client.view.list(name).include?(name).should be_true
-          @client.view.delete(name).to_i.should == 302
+          @valid_post_responses.should include(
+            @client.view.delete(name).to_i
+          )
           @client.view.list(name).include?(name).should be_false
         end
       end
@@ -140,15 +194,19 @@ describe JenkinsApi::Client::View do
 
       describe "#add_job" do
         before(:all) do
-          @client.job.create_freestyle(
-            :name => "test_job_for_view"
-          ).to_i.should == 200
+          @valid_post_responses.should include(
+            @client.job.create_freestyle(
+              :name => "test_job_for_view"
+            ).to_i
+          )
         end
         it "accepts the job and and adds it to the specified view" do
-          @client.view.add_job(
-            "general_purpose_view",
-            "test_job_for_view"
-          ).to_i.should == 200
+          @valid_post_responses.should include(
+            @client.view.add_job(
+              "general_purpose_view",
+              "test_job_for_view"
+            ).to_i
+          )
           @client.view.list_jobs(
             "general_purpose_view"
           ).include?("test_job_for_view").should be_true
@@ -158,23 +216,29 @@ describe JenkinsApi::Client::View do
       describe "#remove_job" do
         before(:all) do
           unless @client.job.exists?("test_job_for_view")
-            @client.job.create_freestyle(
-              :name => "test_job_for_view"
-            ).to_i.should == 200
+            @valid_post_responses.should include(
+              @client.job.create_freestyle(
+                :name => "test_job_for_view"
+              ).to_i
+            )
           end
           unless @client.view.list_jobs(
             "general_purpose_view").include?("test_job_for_view")
-            @client.view.add_job(
-              "general_purpose_job",
-              "test_job_for_view"
-            ).to_i.should == 200
+            @valid_post_responses.should include(
+              @client.view.add_job(
+                "general_purpose_job",
+                "test_job_for_view"
+              ).to_i
+            )
           end
         end
         it "accepts the job name and removes it from the specified view" do
-          @client.view.remove_job(
-            "general_purpose_view",
-            "test_job_for_view"
-          ).to_i.should == 200
+          @valid_post_responses.should include(
+            @client.view.remove_job(
+              "general_purpose_view",
+              "test_job_for_view"
+            ).to_i
+          )
         end
       end
 
@@ -199,11 +263,14 @@ describe JenkinsApi::Client::View do
     end
 
     after(:all) do
-      @client.view.delete("general_purpose_view").to_i.should == 302
+      @valid_post_responses.should include(
+        @client.view.delete("general_purpose_view").to_i
+      )
       if @client.job.exists?("test_job_for_view")
-        @client.job.delete("test_job_for_view").to_i.should == 302
+        @valid_post_responses.should include(
+          @client.job.delete("test_job_for_view").to_i
+        )
       end
     end
-
   end
 end

data/spec/unit_tests/build_queue_spec.rb

@@ -4,6 +4,8 @@ describe JenkinsApi::Client::BuildQueue do
   context "With properly initialized Client" do
     before do
       @client = mock
+      mock_logger = Logger.new "/dev/null"
+      @client.should_receive(:logger).and_return(mock_logger)
       @queue = JenkinsApi::Client::BuildQueue.new(@client)
       @sample_queue_json = {
         "items" => [
@@ -38,6 +40,8 @@ describe JenkinsApi::Client::BuildQueue do
     describe "InstanceMethods" do
       describe "#initialize" do
         it "initializes by receiving an instance of client object" do
+          mock_logger = Logger.new "/dev/null"
+          @client.should_receive(:logger).and_return(mock_logger)
           expect(
             lambda{ JenkinsApi::Client::BuildQueue.new(@client) }
           ).not_to raise_error

data/spec/unit_tests/client_spec.rb

@@ -7,7 +7,8 @@ describe JenkinsApi::Client do
         :server_ip => '127.0.0.1',
         :server_port => 8080,
         :username => 'username',
-        :password => 'password'
+        :password => 'password',
+        :log_location => '/dev/null'
       )
     end
 
@@ -141,41 +142,6 @@ describe JenkinsApi::Client do
     end
 
     describe "InstanceMethods" do
-      describe "#debug" do
-        it "The default for debug should be false" do
-          client = JenkinsApi::Client.new(
-            :server_ip => '127.0.0.1',
-            :server_port => 8080,
-            :username => 'username',
-            :password => 'password'
-          )
-          client.debug.should == false
-        end
-
-        it "Should be able to set the debug value" do
-          client = JenkinsApi::Client.new(
-            :server_ip => '127.0.0.1',
-            :server_port => 8080,
-            :username => 'username',
-            :password => 'password',
-            :debug => true
-            )
-          client.debug.should == true
-        end
-
-        it "Should be able to toggle the debug value" do
-          client = JenkinsApi::Client.new(
-            :server_ip => '127.0.0.1',
-            :server_port => 8080,
-            :username => 'username',
-            :password => 'password',
-            :debug => true
-            )
-          client.toggle_debug
-          client.debug.should == false
-        end
-      end
-
       describe "#getroot" do
         it "is defined with no parameters" do
           expect(