jenkins_api_client 0.8.1 → 0.9.0

data/lib/jenkins_api_client/system.rb

@@ -65,11 +65,17 @@ module JenkinsApi
         end
       end
 
+      # Reload the Jenkins server
+      #
+      def reload
+        @client.api_post_request("/reload")
+      end
+
       # This method waits till the server becomes ready after a start
       # or restart.
       #
       def wait_for_ready
-        Timeout::timeout(120) do
+        Timeout::timeout(@client.timeout) do
           while true do
             response = @client.get_root
             puts "[INFO] Waiting for jenkins to restart..." if @client.debug

data/lib/jenkins_api_client/version.rb

@@ -23,8 +23,8 @@
 module JenkinsApi
   class Client
     MAJOR   = 0
-    MINOR   = 8
-    TINY    = 1
+    MINOR   = 9
+    TINY    = 0
     PRE     = nil
     VERSION = [MAJOR, MINOR, TINY, PRE].compact.join('.')
   end

data/lib/jenkins_api_client/view.rb

@@ -50,6 +50,8 @@ module JenkinsApi
           "hudson.model.ListView"
         when "myview"
           "hudson.model.MyView"
+        else
+          raise "Type #{type} is not supported by Jenkins."
         end
         initial_post_params = {
           "name" => view_name,

data/scripts/login_with_irb.rb

@@ -8,9 +8,7 @@ require 'yaml'
 require 'irb'
 
 begin
-  @client = JenkinsApi::Client.new(YAML.load_file(File.expand_path(
-    '~/.jenkins_api_client/spec.yml', __FILE__))
-  )
+  @client = JenkinsApi::Client.new(YAML.load_file(File.expand_path('~/.jenkins_api_client/login.yml', __FILE__)))
   puts "logged-in to the Jenkins API, use the '@client' variable to use the client"
 end
 

data/spec/func_tests/client_spec.rb

@@ -60,7 +60,26 @@ describe JenkinsApi::Client do
           end
         end
       end
+      describe "#get_jenkins_version" do
+        it "Should the jenkins version" do
+          @client.get_jenkins_version.class.should == String
+        end
+      end
+
+      describe "#get_hudson_version" do
+        it "Should get the hudson version" do
+          @client.get_hudson_version.class.should == String
+        end
+      end
+
+      describe "#get_server_date" do
+        it "Should return the server date" do
+          @client.get_server_date.class.should == String
+        end
+      end
+    end
 
+    describe "SubClassAccessorMethods" do
       describe "#job" do
         it "Should return a job object on call" do
           @client.job.class.should == JenkinsApi::Client::Job
@@ -84,6 +103,12 @@ describe JenkinsApi::Client do
           @client.system.class.should == JenkinsApi::Client::System
         end
       end
+
+      describe "#queue" do
+        it "Should return a build queue object on call" do
+          @client.queue.class.should == JenkinsApi::Client::BuildQueue
+        end
+      end
     end
 
   end

data/spec/func_tests/job_spec.rb

@@ -53,7 +53,9 @@ describe JenkinsApi::Client::Job do
       describe "#create" do
         it "Should be able to create a job by getting an xml" do
           xml = @helper.create_job_xml
-          @client.job.create("qwerty_nonexistent_job", xml).to_i.should == 200
+          name = "qwerty_nonexistent_job"
+          @client.job.create(name, xml).to_i.should == 200
+          @client.job.list(name).include?(name).should be_true
         end
       end
 
@@ -225,12 +227,23 @@ describe JenkinsApi::Client::Job do
         end
       end
 
+      describe "#add_email_notification" do
+        it "Should accept email address and add to existing job" do
+          name = "email_notification_test_job"
+          params = {:name => name}
+          @client.job.create_freestyle(params).to_i.should == 200
+          @client.job.add_email_notification(
+            :name => name,
+            :notification_email => "testuser@testdomain.com"
+          ).to_i.should == 200
+          @client.job.delete(name).to_i.should == 302
+        end
+      end
+
       describe "#add_skype_notification" do
         it "Should accept skype configuration and add to existing job" do
           name = "skype_notification_test_job"
-          params = {
-            :name => name
-          }
+          params = {:name => name}
           @client.job.create_freestyle(params).to_i.should == 200
           @client.job.add_skype_notification(
             :name => name,
@@ -239,6 +252,7 @@ describe JenkinsApi::Client::Job do
           @client.job.delete(name).to_i.should == 302
         end
       end
+
       describe "#rename" do
         it "Should accept new and old job names and rename the job" do
           xml = @helper.create_job_xml
@@ -335,12 +349,14 @@ describe JenkinsApi::Client::Job do
         it "Should obtain the current build status for the specified job" do
           build_status = @client.job.get_current_build_status(@job_name)
           build_status.class.should == String
-          valid_build_status = ["not_run",
-                                "aborted",
-                                "success",
-                                "failure",
-                                "unstable",
-                                "running"]
+          valid_build_status = [
+            "not_run",
+            "aborted",
+            "success",
+            "failure",
+            "unstable",
+            "running"
+          ]
           valid_build_status.include?(build_status).should be_true
         end
       end
@@ -398,8 +414,11 @@ describe JenkinsApi::Client::Job do
         it "Should be able to chain jobs based on the specified criteria" do
           jobs = @client.job.list(@filter)
           jobs.class.should == Array
-          start_jobs = @client.job.chain(jobs,
-            'failure', ["not_run", "aborted", 'failure'], 3
+          start_jobs = @client.job.chain(
+            jobs,
+            'failure',
+            ["not_run", "aborted", 'failure'],
+            3
           )
           start_jobs.class.should == Array
           start_jobs.length.should == 3

data/spec/func_tests/node_spec.rb

@@ -43,14 +43,30 @@ describe JenkinsApi::Client::Node do
       end
 
       describe "#create_dump_slave" do
+
+        def test_and_validate(params)
+          name = params[:name]
+          @client.node.create_dump_slave(params).to_i.should == 302
+          @client.node.list(name).include?(name).should be_true
+          @client.node.delete(params[:name]).to_i.should == 302
+          @client.node.list(name).include?(name).should be_false
+        end
+
         it "accepts required params and creates the slave on jenkins" do
           params = {
             :name => "func_test_slave",
             :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
+          test_and_validate(params)
+        end
+        it "accepts spaces and other characters in node name" do
+          params = {
+            :name => "slave with spaces and {special characters}",
+            :slave_host => "10.10.10.10",
+            :private_key_file => "/root/.ssh/id_rsa"
+          }
+          test_and_validate(params)
         end
         it "fails if name is missing" do
           params = {

data/spec/func_tests/system_spec.rb

@@ -49,6 +49,16 @@ describe JenkinsApi::Client::System do
           @client.system.wait_for_ready.should == true
         end
       end
+
+      describe "#reload" do
+        it "Should be able to reload a Jenkins server" do
+          @client.system.reload.to_i.should == 302
+        end
+        it "Should be able to wait after a force restart" do
+          @client.system.wait_for_ready.should == true
+        end
+      end
+
     end
 
   end

data/spec/func_tests/view_spec.rb

@@ -19,6 +19,9 @@ describe JenkinsApi::Client::View do
         puts "WARNING: Credentials are not set properly."
         puts e.message
       end
+
+      # Create a view that can be used for tests
+      @client.view.create("general_purpose_view").to_i.should == 302
     end
 
     describe "InstanceMethods" do
@@ -29,25 +32,178 @@ describe JenkinsApi::Client::View do
         end
       end
 
+      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
+          @client.view.list(name).include?(name).should be_true
+          @client.view.delete(name).to_i.should == 302
+        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
+          @client.view.list(name).include?(name).should be_true
+          @client.view.delete(name).to_i.should == 302
+        end
+        it "accepts the name of view and creates a listview" do
+          name = "test_view"
+          @client.view.create(name, "listview").to_i.should == 302
+          @client.view.list(name).include?(name).should be_true
+          @client.view.delete(name).to_i.should == 302
+        end
+        it "accepts the name of view and creates a myview" do
+          name = "test_view"
+          @client.view.create(name, "myview").to_i.should == 302
+          @client.view.list(name).include?(name).should be_true
+          @client.view.delete(name).to_i.should == 302
+        end
+        it "raises an error when unsupported view type is specified" do
+          expect(
+            lambda { @client.view.create(name, "awesomeview") }
+          ).to raise_error
+        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
+          @client.view.list(name).include?(name).should be_true
+          @client.view.delete(name).to_i.should == 302
+          @client.view.list(name).include?(name).should be_false
+        end
+
+        it "accepts just the name of the view and creates the view" do
+          params = {
+            :name => "test_list_view"
+          }
+          test_and_validate(params)
+        end
+
+        it "accepts description as an option" do
+          params = {
+            :name => "test_list_view",
+            :description => "test list view created for functional test"
+          }
+          test_and_validate(params)
+        end
+
+        it "accepts filter_queue as an option" do
+          params = {
+            :name => "test_list_view",
+            :filter_queue => true
+          }
+          test_and_validate(params)
+        end
+
+        it "accepts filter_executors as an option" do
+          params = {
+            :name => "test_list_view",
+            :filter_executors => true
+          }
+          test_and_validate(params)
+        end
+
+        it "accepts regex as an option" do
+          params = {
+            :name => "test_list_view",
+            :regex => "^test.*"
+          }
+          test_and_validate(params)
+        end
+      end
+
+      describe "#delete" do
+        name = "test_view_to_delete"
+        before(:all) do
+          @client.view.create(name).to_i.should == 302
+        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
+          @client.view.list(name).include?(name).should be_false
+        end
+      end
+
+      describe "#list_jobs" do
+        it "accepts the view name and lists all jobs in the view" do
+          @client.view.list_jobs("general_purpose_view").class.should == Array
+        end
+      end
+
+      describe "#exists?" do
+        it "accepts the vie name and returns true if the view exists" do
+          @client.view.exists?("general_purpose_view").should be_true
+        end
+      end
+
+      describe "#add_job" do
+        before(:all) do
+          @client.job.create_freestyle(
+            :name => "test_job_for_view"
+          ).to_i.should == 200
+        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
+          @client.view.list_jobs(
+            "general_purpose_view"
+          ).include?("test_job_for_view").should be_true
+        end
+      end
+
+      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
+          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
+          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
+        end
+      end
+
       describe "#get_config" do
         it "obtaines the view config.xml from the server" do
-          #expect(
-            #lambda { @client.view.get_config("slave") }
-          #).not_to raise_error
+          expect(
+            lambda { @client.view.get_config("general_purpose_view") }
+          ).not_to raise_error
         end
       end
 
       describe "#post_config" do
         it "posts the given config.xml to the jenkins server's view" do
-          #expect(
-            #lambda {
-              #xml = @client.view.get_config("slave")
-              #@client.view.post_config("slave", xml)
-            #}
-          #).not_to raise_error
+          expect(
+            lambda {
+              xml = @client.view.get_config("general_purpose_view")
+              @client.view.post_config("general_purpose_view", xml)
+            }
+          ).not_to raise_error
         end
       end
-      
     end
+
+    after(:all) do
+      @client.view.delete("general_purpose_view").to_i.should == 302
+      if @client.job.exists?("test_job_for_view")
+        @client.job.delete("test_job_for_view").to_i.should == 302
+      end
+    end
+
   end
 end

data/spec/unit_tests/build_queue_spec.rb

@@ -0,0 +1,148 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe JenkinsApi::Client::BuildQueue do
+  context "With properly initialized Client" do
+    before do
+      @client = mock
+      @queue = JenkinsApi::Client::BuildQueue.new(@client)
+      @sample_queue_json = {
+        "items" => [
+          {
+            "actions" => [
+              {
+                "causes" => [
+                  {
+
+                  }
+                ]
+              }
+            ],
+            "blocked" => true,
+            "buildable" => false,
+            "id" => 2,
+            "inQueueSince" => 1362906942731,
+            "params" => "",
+            "stuck" => false,
+            "task" => {
+              "name" => "queue_test",
+              "url" => "http://localhost:8080/job/queue_test/",
+              "color" => "grey_anime"
+            },
+            "why" => "Build #1 is already in progress (ETA:N/A)",
+            "buildStartMilliseconds" => 1362906942832
+          }
+        ]
+      }
+    end
+
+    describe "InstanceMethods" do
+      describe "#initialize" do
+        it "initializes by receiving an instance of client object" do
+          expect(
+            lambda{ JenkinsApi::Client::BuildQueue.new(@client) }
+          ).not_to raise_error
+        end
+      end
+
+      describe "#size" do
+        it "returns the size of the queue" do
+          @client.should_receive(:api_get_request).with("/queue").and_return(
+            @sample_queue_json
+          )
+          @queue.size
+        end
+      end
+
+      describe "#list" do
+        it "returns the list of tasks in the queue" do
+          @client.should_receive(:api_get_request).with("/queue").and_return(
+            @sample_queue_json
+          )
+          @queue.list.class.should == Array
+        end
+      end
+
+      describe "#get_age" do
+        it "returns the age of a task" do
+          @client.should_receive(:api_get_request).with("/queue").and_return(
+            @sample_queue_json
+          )
+          @queue.get_age("queue_test").class.should == Float
+        end
+      end
+
+      describe "#get_details" do
+        it "returns the details of a task in the queue" do
+          @client.should_receive(:api_get_request).with("/queue").and_return(
+            @sample_queue_json
+          )
+          @queue.get_details("queue_test").class.should == Hash
+        end
+      end
+
+      describe "#get_causes" do
+        it "returns the causes of a task in queue" do
+          @client.should_receive(:api_get_request).with("/queue").and_return(
+            @sample_queue_json
+          )
+          @queue.get_causes("queue_test").class.should == Array
+        end
+      end
+
+      describe "#get_reason" do
+        it "returns the reason of a task in queue" do
+          @client.should_receive(:api_get_request).with("/queue").and_return(
+            @sample_queue_json
+          )
+          @queue.get_reason("queue_test").class.should == String
+        end
+      end
+
+      describe "#get_eta" do
+        it "returns the ETA of a task in queue" do
+          @client.should_receive(:api_get_request).with("/queue").and_return(
+            @sample_queue_json
+          )
+          @queue.get_eta("queue_test").class.should == String
+        end
+      end
+
+      describe "#get_params" do
+        it "returns the params of a task in queue" do
+          @client.should_receive(:api_get_request).with("/queue").and_return(
+            @sample_queue_json
+          )
+          @queue.get_params("queue_test").class.should == String
+        end
+      end
+
+      describe "#is_buildable?" do
+        it "returns true if the job is buildable" do
+          @client.should_receive(:api_get_request).with("/queue").and_return(
+            @sample_queue_json
+          )
+          @queue.is_buildable?("queue_test").should == false
+        end
+      end
+
+      describe "#is_blocked?" do
+        it "returns true if the job is blocked" do
+          @client.should_receive(:api_get_request).with("/queue").and_return(
+            @sample_queue_json
+          )
+          @queue.is_blocked?("queue_test").should == true
+        end
+      end
+
+      describe "#is_stuck?" do
+        it "returns true if the job is stuck" do
+          @client.should_receive(:api_get_request).with("/queue").and_return(
+            @sample_queue_json
+          )
+          @queue.is_stuck?("queue_test").should == false
+        end
+      end
+
+    end
+  end
+end