jenkins_api_client 0.6.2 → 0.7.0

data/spec/func_tests/node_spec.rb

@@ -0,0 +1,174 @@
+#
+# Specifying JenkinsApi::Client::Node class capabilities
+# Author Kannan Manickam <arangamani.kannan@gmail.com>
+#
+
+require File.expand_path('../spec_helper', __FILE__)
+require 'yaml'
+
+describe JenkinsApi::Client::Node do
+  context "With properly initialized client" do
+    before(:all) do
+      @creds_file = '~/.jenkins_api_client/spec.yml'
+      @node_name = 'master'
+      begin
+        @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
+      end
+    end
+
+    describe "InstanceMethods" do
+
+      describe "#initialize" do
+        it "Initializes without any exception" do
+          expect(
+            lambda{ node = JenkinsApi::Client::Node.new(@client) }
+          ).not_to raise_error
+        end
+        it "Raises an error if a reference of client is not passed" do
+          expect(
+            lambda{ node JenkinsApi::Client::Node.new() }
+          ).to raise_error
+        end
+      end
+
+      describe "#create_dump_slave" do
+        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
+        end
+        it "fails if name is missing" do
+          params = {
+            :slave_host => "10.10.10.10",
+            :private_key_file => "/root/.ssh/id_rsa"
+          }
+          expect(
+            lambda{ @client.node.create_dump_slave(params) }
+          ).to raise_error
+        end
+        it "fails if slave_host is missing" do
+          params = {
+            :name => "func_test_slave",
+            :private_key_file => "/root/.ssh/id_rsa"
+          }
+          expect(
+            lambda{ @client.node.create_dump_slave(params) }
+          ).to raise_error
+        end
+        it "fails if private_key_file is missing" do
+          params = {
+            :name => "func_test_slave",
+            :slave_host => "10.10.10.10"
+          }
+          expect(
+            lambda{ @client.node.create_dump_slave(params) }
+          ).to raise_error
+        end
+        it "fails if the slave already exists in 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
+          expect(
+            lambda{ @client.node.create_dump_slave(params) }
+          ).to raise_error
+          @client.node.delete(params[:name]).to_i.should == 302
+        end
+      end
+
+      describe "#delete" do
+        it "deletes the node given the name" 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
+        end
+        it "raises an error if the slave doesn't exist in Jenkins" do
+          expect(
+            lambda{ @client.node.delete("not_there") }
+          ).to raise_error
+        end
+      end
+
+      describe "#list" do
+        it "Should be able to list all nodes" do
+          @client.node.list.class.should == Array
+        end
+      end
+
+      describe "GeneralAttributes" do
+        general_attributes = JenkinsApi::Client::Node::GENERAL_ATTRIBUTES
+        general_attributes.each do |attribute|
+          describe "#get_#{attribute}" do
+            it "should get the #{attribute} attribute" do
+              @client.node.method("get_#{attribute}").call
+            end
+          end
+        end
+      end
+
+      describe "NodeProperties" do
+        node_properties = JenkinsApi::Client::Node::NODE_PROPERTIES
+        node_properties.each do |property|
+          describe "#is_#{property}" do
+            it "should get the #{property} property" do
+              @client.node.method("is_#{property}?").call(@node_name)
+            end
+          end
+        end
+      end
+
+      describe "NodeAttributes" do
+        node_attributes = JenkinsApi::Client::Node::NODE_ATTRIBUTES
+        node_attributes.each do |attribute|
+          describe "#get_node_#{attribute}" do
+            it "Should be able to list all node attributes" do
+              @client.node.method("get_node_#{attribute}").call(@node_name)
+            end
+          end
+        end
+      end
+
+      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
+        end
+      end
+
+      describe "#get_config" do
+        it "obtaines the node config.xml from the server" do
+          expect(
+            lambda { @client.node.get_config("slave") }
+          ).not_to raise_error
+        end
+      end
+
+      describe "#post_config" do
+        it "posts the given config.xml to the jenkins server's node" do
+          expect(
+            lambda {
+              xml = @client.node.get_config("slave")
+              @client.node.post_config("slave", xml)
+            }
+          ).not_to raise_error
+        end
+      end
+
+    end
+  end
+end

data/spec/{spec_helper.rb → func_tests/spec_helper.rb}

@@ -5,7 +5,7 @@
 
 require 'simplecov'
 SimpleCov.start if ENV["COVERAGE"]
-require File.expand_path('../../lib/jenkins_api_client', __FILE__)
+require File.expand_path('../../../lib/jenkins_api_client', __FILE__)
 require 'pp'
 require 'yaml'
 require 'nokogiri'
@@ -33,7 +33,7 @@ module JenkinsApiSpecHelper
           xml.concurrentBuild "false"
           xml.builders {
             xml.send("hudson.tasks.Shell") {
-              xml.command "\necho 'going to take a nice nap'\nsleep 120\necho 'took a nice nap'"
+              xml.command "\necho 'going to take a nice nap'\nsleep 10\necho 'took a nice nap'"
             }
           }
           xml.publishers

data/spec/func_tests/system_spec.rb

@@ -0,0 +1,55 @@
+#
+# Specifying JenkinsApi::Client::System class capabilities
+# Author: Kannan Manickam <arangamani.kannan@gmail.com>
+#
+
+require File.expand_path('../spec_helper', __FILE__)
+require 'yaml'
+
+describe JenkinsApi::Client::System do
+  context "With properly initialized client" do
+    before(:all) do
+      @creds_file = '~/.jenkins_api_client/spec.yml'
+      begin
+        @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
+      end
+    end
+
+    describe "InstanceMethods" do
+
+      describe "#quiet_down" do
+        it "Should be able to quiet down a Jenkins server" do
+          @client.system.quiet_down.to_i.should == 302
+        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
+        end
+      end
+
+      describe "#restart" do
+        it "Should be able to restart a Jenkins server safely" do
+          @client.system.restart.to_i.should == 302
+        end
+
+        it "Should be able to wait after a safe restart" do
+          @client.system.wait_for_ready.should == true
+        end
+
+        it "Should be able to force restart a Jenkins server" do
+          @client.system.restart(true).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
+end

data/spec/func_tests/view_spec.rb

@@ -0,0 +1,53 @@
+#
+# Specifying JenkinsApi::Client::View class capabilities
+# Author Kannan Manickam <arangamani.kannan@gmail.com>
+#
+
+require File.expand_path('../spec_helper', __FILE__)
+require 'yaml'
+
+describe JenkinsApi::Client::View do
+  context "With properly initialized client" do
+    before(:all) do
+      @creds_file = '~/.jenkins_api_client/spec.yml'
+      @node_name = 'master'
+      begin
+        @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
+      end
+    end
+
+    describe "InstanceMethods" do
+
+      describe "#list" do
+        it "Should be able to list all views" do
+          @client.view.list.class.should == Array
+        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
+        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
+        end
+      end
+      
+    end
+  end
+end

data/spec/unit_tests/client_spec.rb

@@ -0,0 +1,211 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe JenkinsApi::Client do
+  context "With valid credentials given" do
+    before do
+      @client = JenkinsApi::Client.new(
+        :server_ip => '127.0.0.1',
+        :server_port => 8080,
+        :username => 'username',
+        :password => 'password'
+      )
+    end
+
+    describe "#initialize" do
+      it "initializes without exception" do
+        expect(
+          lambda do
+            JenkinsApi::Client.new(
+              :server_ip => '127.0.0.1',
+              :server_port => 8080,
+              :username => 'username',
+              :password => 'password'
+            )
+          end
+        ).not_to raise_error
+      end
+    end
+
+    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 "#SubClassAccessorMethods" do
+      describe "#job" do
+        it "Should return a Client::Job object" do
+          client = JenkinsApi::Client.new(
+            :server_ip => '127.0.0.1',
+            :server_port => 8080,
+            :username => 'username',
+            :password => 'password'
+            )
+          client.job.class.should == JenkinsApi::Client::Job
+        end
+      end
+
+      describe "#node" do
+        it "Should return a Client::Node object" do
+          client = JenkinsApi::Client.new(
+            :server_ip => '127.0.0.1',
+            :server_port => 8080,
+            :username => 'username',
+            :password => 'password'
+            )
+          client.node.class.should == JenkinsApi::Client::Node
+        end
+      end
+
+      describe "#view" do
+        it "Should return a Client::View object" do
+          client = JenkinsApi::Client.new(
+            :server_ip => '127.0.0.1',
+            :server_port => 8080,
+            :username => 'username',
+            :password => 'password'
+            )
+          client.view.class.should == JenkinsApi::Client::View
+        end
+      end
+
+      describe "#system" do
+        it "Should return a Client::System object" do
+          client = JenkinsApi::Client.new(
+            :server_ip => '127.0.0.1',
+            :server_port => 8080,
+            :username => 'username',
+            :password => 'password'
+          )
+          client.system.class.should == JenkinsApi::Client::System
+        end
+      end
+
+      describe "#queue" do
+        it "Should return a Client::BuildQueue object" do
+          client = JenkinsApi::Client.new(
+            :server_ip => '127.0.0.1',
+            :server_port => 8080,
+            :username => 'username',
+            :password => 'password'
+          )
+          client.queue.class.should == JenkinsApi::Client::BuildQueue
+        end
+      end
+    end
+
+    describe "InstanceMethods" do
+      describe "#getroot" do
+        it "is defined with no parameters" do
+          expect(
+            lambda { @client.get_root }
+          ).not_to raise_error(NoMethodError)
+        end
+      end
+
+      describe "#api_get_request" do
+        it "defined and should accept url_prefix, tree, and url_suffix" do
+          expect(
+            lambda { @client.api_get_request("/some/prefix", "tree", "/json") }
+          ).not_to raise_error(NoMethodError)
+        end
+      end
+
+      describe "#api_post_request" do
+        it "is defined and should accept url_prefix" do
+          expect(
+            lambda { @client.api_post_request("/some/prefix") }
+          ).not_to raise_error(NoMethodError)
+        end
+      end
+
+      describe "#get_config" do
+        it "is defined and should accept url_prefix" do
+          expect(
+            lambda { @client.get_config("/some/prefix") }
+          ).not_to raise_error(NoMethodError)
+        end
+      end
+
+      describe "#post_config" do
+        it "is defined and should accept url_prefix and xml" do
+          expect(
+            lambda { @client.post_config("/some/prefix", "<tag></tag>") }
+          ).not_to raise_error(NoMethodError)
+        end
+      end
+    end
+  end
+
+  context "With some required parameters missing" do
+    context "#initialize" do
+      it "Should fail if server_ip is missing" do
+        expect(
+          lambda do
+            JenkinsApi::Client.new({
+              :bogus => '127.0.0.1',
+              :server_port => 8080,
+              :username => 'username',
+              :password => 'password'
+            })
+          end
+        ).to raise_error
+      end
+
+      it "Should fail if username is missing" do
+        expect(
+          lambda do
+            JenkinsApi::Client.new({
+              :server_ip => '127.0.0.1',
+              :server_port => 8080,
+              :bogus => 'username',
+              :password => 'password'
+            })
+          end
+        ).to raise_error
+      end
+
+      it "Should fail if password is missing" do
+        expect(
+          lambda do
+            JenkinsApi::Client.new({
+              :server_ip => '127.0.0.1',
+              :server_port => 8080,
+              :username => 'username',
+              :bogus => 'password'
+            })
+          end
+        ).to raise_error
+      end
+    end
+  end
+end