jenkins_api_client 0.6.2 → 0.7.0

data/spec/unit_tests/fixtures/files/computer_sample.xml

@@ -0,0 +1,17 @@
+<slave>
+<name>slave</name>
+<description/>
+<remoteFS>/var/jenkins</remoteFS>
+<numExecutors>20</numExecutors>
+<mode>NORMAL</mode>
+<retentionStrategy class="hudson.slaves.RetentionStrategy$Always"/>
+<launcher class="hudson.plugins.sshslaves.SSHLauncher" plugin="ssh-slaves@0.21">
+<host>127.0.0.1</host>
+<port>22</port>
+<password>supersecret</password>
+<privatekey>/root/.ssh/api_user_key</privatekey>
+</launcher>
+<label>slave</label>
+<nodeProperties/>
+<userId>kannan</userId>
+</slave>

data/spec/unit_tests/fixtures/files/job_sample.xml

@@ -0,0 +1,16 @@
+<project>
+<actions/>
+<description/>
+<keepDependencies>false</keepDependencies>
+<properties/>
+<scm class="hudson.scm.NullSCM"/>
+<canRoam>true</canRoam>
+<disabled>false</disabled>
+<blockBuildWhenDownstreamBuilding>false</blockBuildWhenDownstreamBuilding>
+<blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>
+<triggers class="vector"/>
+<concurrentBuild>false</concurrentBuild>
+<builders/>
+<publishers/>
+<buildWrappers/>
+</project>

data/spec/unit_tests/job_spec.rb

@@ -0,0 +1,355 @@
+require File.expand_path('../spec_helper', __FILE__)
+require 'net/http'
+
+describe JenkinsApi::Client::Job do
+  context "With properly initialized Client and all methods defined" do
+
+    before do
+      @client = mock
+      @job = JenkinsApi::Client::Job.new(@client)
+      @sample_json_response = {
+        "jobs" => [
+          {"name" => "test_job"},
+          {"name" => "test_job2"}
+        ]
+      }
+      @sample_json_job_response = {
+        "downstreamProjects" => ["test_job1"],
+        "upstreamProjects" => ["test_job2"],
+        "builds" => [],
+        "color" => "running",
+        "nextBuildNumber" => 2
+      }
+      @sample_job_xml = File.read(
+        File.expand_path('../fixtures/files/job_sample.xml', __FILE__))
+    end
+
+    describe "InstanceMethods" do
+
+      describe "#create_job" do
+        it "accepts job_name and xml and creates the job" do
+          job_name = 'test_job'
+          xml = '<name>somename</name>'
+          @client.should_receive(:post_config)
+          @job.create(job_name, xml)
+        end
+      end
+
+      describe "#create_freestyle" do
+        it "creates a simple freestyle job" do
+          params = {
+            :name => 'test_job_using_params'
+          }
+          @client.should_receive(:post_config)
+          @job.create_freestyle(params)
+        end
+        it "creates a freestyle job with shell command" do
+          params = {
+            :name => "test_job_using_params_shell",
+            :shell_command => "echo this is a freestyle project"
+          }
+          @client.should_receive(:post_config)
+          @job.create_freestyle(params)
+        end
+        it "accepts Git SCM provider" do
+          params = {
+            :name => "test_job_using_params_git",
+            :scm_provider => "git",
+            :scm_url => "git://github.com/arangamani/jenkins_api_client/git",
+            :scm_branch => "master"
+          }
+          @client.should_receive(:post_config)
+          @job.create_freestyle(params)
+        end
+        it "accepts subversion SCM provider" do
+          params = {
+            :name => "test_job_using_params_subversion",
+            :scm_provider => "subversion",
+            :scm_url => "http://svn.freebsd.org/base",
+            :scm_branch => "master"
+          }
+          @client.should_receive(:post_config)
+          @job.create_freestyle(params)
+        end
+        it "accepts CVS SCM provider with branch" do
+          params = {
+            :name => "test_job_using_params_cvs_branch",
+            :scm_provider => "cvs",
+            :scm_url => "http://cvs.NetBSD.org",
+            :scm_module => "src",
+            :scm_branch => "MAIN"
+          }
+          @client.should_receive(:post_config)
+          @job.create_freestyle(params)
+        end
+        it "accepts CVS SCM provider with tag" do
+          params = {
+            :name => "test_job_using_params_cvs_tag",
+            :scm_provider => "cvs",
+            :scm_url => "http://cvs.NetBSD.org",
+            :scm_module => "src",
+            :scm_tag => "MAIN"
+          }
+          @client.should_receive(:post_config)
+          @job.create_freestyle(params)
+        end
+      end
+
+      describe "#delete" do
+        it "accepts the job name and deletes the job" do
+          @client.should_receive(:api_post_request)
+          @job.delete('test_job')
+        end
+      end
+
+      describe "#stop_build" do
+        it "accepts the job name and build number and stops the build" do
+          @client.should_receive(:api_get_request).twice.and_return(
+            "building" => true, "nextBuildNumber" => 2)
+          @client.should_receive(:api_post_request)
+          @job.stop_build('test_job')
+        end
+      end
+
+      describe "#get_console_output" do
+        it "accepts the job name and the obtains the console output" do
+          @client.should_receive(:api_get_request).and_return(
+            Net::HTTP.get_response(URI('http://example.com/index.html')))
+          @job.get_console_output('test_job', 1, 0, 'text')
+        end
+
+        it "raises an error if invalid mode is specified" do
+          expect(
+            lambda do
+              @job.get_console_output('test_job', 1, 0, 'image')
+            end
+          ).to raise_error
+        end
+      end
+
+      describe "#list_all" do
+        it "accepts no parameters and returns all jobs in an array" do
+          @client.should_receive(:api_get_request).and_return(
+            @sample_json_response)
+          response = @job.list_all
+          response.class.should == Array
+          response.size.should == @sample_json_response["jobs"].size
+        end
+      end
+
+      describe "#exists?" do
+        it "accepts a job name and returns true if the job exists" do
+          @client.should_receive(:api_get_request).and_return(
+            @sample_json_response)
+          @job.exists?("test_job").should == true
+        end
+      end
+
+      describe "#list_by_status" do
+        it "accepts the status and returns jobs in specified status" do
+          @client.should_receive(:api_get_request).twice.and_return(
+            @sample_json_response)
+          @job.list_by_status("success").class.should == Array
+        end
+        it "accepts the status and returns the jobs in specified status" do
+          @client.should_receive(:api_get_request).and_return(
+            @sample_json_response)
+          @job.list_by_status("success", ["test_job"]).class.should == Array
+        end
+      end
+
+      describe "#list" do
+        it "accepts a filter and returns all jobs matching the filter" do
+          @client.should_receive(:api_get_request).and_return(
+            "jobs" => ["test_job"])
+          @job.list("filter").class.should == Array
+        end
+      end
+
+      describe "#list_all_with_details" do
+        it "accepts no parameters and returns all jobs with details" do
+          @client.should_receive(:api_get_request).and_return(
+            @sample_json_response)
+          response = @job.list_all_with_details
+          response.class.should == Array
+          response.size.should == @sample_json_response["jobs"].size
+        end
+      end
+
+      describe "#list_details" do
+        it "accepts the job name and returns its details" do
+          @client.should_receive(:api_get_request).and_return(
+            @sample_json_response)
+          response = @job.list_details("test_job")
+          response.class.should == Hash
+        end
+      end
+
+      describe "#get_upstream_projects" do
+        it "accepts the job name and returns its upstream projects" do
+          @client.should_receive(:api_get_request).and_return(
+            @sample_json_job_response)
+          response = @job.get_upstream_projects("test_job")
+          response.class.should == Array
+        end
+      end
+
+      describe "#get_downstream_projects" do
+        it "accepts the job name and returns its downstream projects" do
+          @client.should_receive(:api_get_request).and_return(
+            @sample_json_job_response)
+          response = @job.get_downstream_projects("test_job")
+          response.class.should == Array
+        end
+      end
+
+      describe "#get_builds" do
+        it "accepts the job name and returns its builds" do
+          @client.should_receive(:api_get_request).and_return(
+            @sample_json_job_response)
+          response = @job.get_builds("test_job")
+          response.class.should == Array
+        end
+      end
+
+      describe "#color_to_status" do
+        it "accepts the color and convert it to correct status" do
+          @job.color_to_status("blue").should         == "success"
+          @job.color_to_status("blue_anime").should   == "running"
+          @job.color_to_status("red").should          == "failure"
+          @job.color_to_status("red_anime").should    == "running"
+          @job.color_to_status("yellow").should       == "unstable"
+          @job.color_to_status("yellow_anime").should == "running"
+          @job.color_to_status("grey").should         == "not_run"
+          @job.color_to_status("grey_anime").should   == "running"
+          @job.color_to_status("aborted").should      == "aborted"
+        end
+        it "returns invalid as the output if unknown color is detected" do
+          @job.color_to_status("orange").should == "invalid"
+        end
+      end
+
+      describe "#get_current_build_status" do
+        it "accepts the job name and returns its current build status" do
+          @client.should_receive(:api_get_request).and_return(
+            @sample_json_job_response)
+          @job.get_current_build_status("test_job").class.should == String
+        end
+      end
+
+      describe "#get_current_build_number" do
+        it "accepts the job name and returns its current build number" do
+          @client.should_receive(:api_get_request).and_return(
+            @sample_json_job_response)
+          @job.get_current_build_number("test_job").class.should == Fixnum
+        end
+      end
+
+      describe "#build" do
+        it "accepts the job name and builds the job" do
+          @client.should_receive(:api_post_request).with(
+            "/job/test_job/build").and_return(302)
+          @job.build("test_job").should == 302
+        end
+      end
+
+      describe "#get_config" do
+        it "accepts the job name and obtains its config.xml" do
+          @client.should_receive(:get_config).with(
+            "/job/test_job").and_return("<job>test_job</job>")
+          @job.get_config("test_job").should == "<job>test_job</job>"
+        end
+      end
+
+      describe "#post_config" do
+        it "accepts the job name and posts its config.xml to the server" do
+          @client.should_receive(:post_config).with(
+            "/job/test_job/config.xml", "<job>test_job</job>")
+          @job.post_config("test_job", "<job>test_job</job>")
+        end
+      end
+
+      describe "#change_description" do
+        it "accepts the job name and description and changes it" do
+          @client.should_receive(:get_config).with(
+            "/job/test_job").and_return(@sample_job_xml)
+          @client.should_receive(:post_config)
+          @job.change_description("test_job", "new description")
+        end
+      end
+
+      describe "#block_build_when_downstream_building" do
+        it "accepts the job name and blocks build when downstream builds" do
+          @client.should_receive(:get_config).with(
+            "/job/test_job").and_return(@sample_job_xml)
+          @client.should_receive(:post_config)
+          @job.block_build_when_downstream_building("test_job")
+        end
+      end
+
+      describe "#unblock_build_when_downstream_building" do
+        it "accepts the job name and unblocks build when downstream builds" do
+          @client.should_receive(:get_config).with(
+            "/job/test_job").and_return(@sample_job_xml)
+          @job.unblock_build_when_downstream_building("test_job")
+        end
+      end
+
+      describe "#block_build_when_upstream_building" do
+        it "accepts the job name and blocks build when upstream is building" do
+          @client.should_receive(:get_config).with(
+            "/job/test_job").and_return(@sample_job_xml)
+          @client.should_receive(:post_config)
+          @job.block_build_when_upstream_building("test_job")
+        end
+      end
+
+      describe "#unblock_build_when_upstream_building" do
+        it "accepts the job name and unblocks build when upstream builds" do
+          @client.should_receive(:get_config).with(
+            "/job/test_job").and_return(@sample_job_xml)
+          @job.unblock_build_when_upstream_building("test_job")
+        end
+      end
+
+      describe "#execute_concurrent_builds" do
+        it "accepts the job name and option and executes concurrent builds" do
+          @client.should_receive(:get_config).with(
+            "/job/test_job").and_return(@sample_job_xml)
+          @client.should_receive(:post_config)
+          @job.execute_concurrent_builds("test_job", true)
+        end
+      end
+
+      describe "#restrict_to_node" do
+        it "accepts the job name and node name and restricts the job node" do
+          @client.should_receive(:get_config).with(
+            "/job/test_job").and_return(@sample_job_xml)
+          @client.should_receive(:post_config)
+          @job.restrict_to_node("test_job", "test_slave")
+        end
+      end
+
+      describe "#unchain" do
+        it "accepts the job names and unchains them" do
+          @client.should_receive(:debug).and_return(false)
+          @client.should_receive(:get_config).with(
+            "/job/test_job").and_return(@sample_job_xml)
+          @client.should_receive(:post_config)
+          @job.unchain(["test_job"])
+        end
+      end
+
+      describe "#chain" do
+        it "accepts the job names and other options and chains them" do
+          @client.should_receive(:debug).and_return(false)
+          @client.should_receive(:get_config).with(
+            "/job/test_job").and_return(@sample_job_xml)
+          @client.should_receive(:post_config)
+          @job.unchain(["test_job"])
+        end
+      end
+
+    end
+  end
+end

data/spec/unit_tests/node_spec.rb

@@ -0,0 +1,192 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe JenkinsApi::Client::Node do
+  context "With properly initialized Client" do
+    before do
+      @client = mock
+      @node = JenkinsApi::Client::Node.new(@client)
+      @sample_json_computer_response = {
+        "computer" => [
+          "displayName" => "slave"
+        ]
+      }
+      computer_sample_xml_filename = '../fixtures/files/computer_sample.xml'
+      @sample_computer_xml = File.read(
+        File.expand_path(computer_sample_xml_filename , __FILE__)
+      )
+    end
+
+    describe "InstanceMethods" do
+
+      describe "#initialize" do
+        it "initializes by receiving an instance of client object" do
+          expect(
+            lambda{ JenkinsApi::Client::Node.new(@client) }
+          ).not_to raise_error
+        end
+      end
+
+      describe "#create_dump_slave" do
+        it "creates a dump slave by accepting required params" do
+          @client.should_receive(
+            :api_get_request
+          ).with(
+            "/computer"
+          ).and_return(
+            @sample_json_computer_response
+          )
+          @client.should_receive(:api_post_request).and_return("302")
+          @node.create_dump_slave(
+            :name => "test_slave",
+            :slave_host => "10.10.10.10",
+            :private_key_file => "/root/.ssh/id_rsa"
+          )
+        end
+        it "fails if name is not given" do
+          expect(
+            lambda{
+              @node.create_dump_slave(
+                :slave_host => "10.10.10.10",
+                :private_key_file => "/root/.ssh/id_rsa"
+              )
+            }
+          ).to raise_error
+        end
+        it "fails if slave_host is not given" do
+          expect(
+            lambda{
+              @node.create_dump_slave(
+                :name => "test_slave",
+                :private_key_file => "/root/.ssh/id_rsa"
+              )
+            }
+          ).to raise_error
+        end
+        it "fails if private_key_file is not given" do
+          expect(
+            lambda{
+              @node.create_dump_slave(
+                :name => "test_slave",
+                :slave_host => "10.10.10.10"
+              )
+            }
+          ).to raise_error
+        end
+      end
+
+      describe "#delete" do
+        it "gets the node name and deletes if exists" do
+          slave_name = "slave"
+          @client.should_receive(
+            :api_get_request
+          ).with(
+            "/computer"
+          ).and_return(
+            @sample_json_computer_response
+          )
+          @client.should_receive(
+            :api_post_request
+          ).with(
+            "/computer/#{slave_name}/doDelete"
+          ).and_return(
+            "302"
+          )
+          @node.delete(slave_name).to_i.should == 302
+        end
+        it "fails if the given node doesn't exist in Jenkins" do
+          slave_name = "not_there"
+          @client.should_receive(
+            :api_get_request
+          ).with(
+            "/computer"
+          ).and_return(
+            @sample_json_computer_response
+          )
+          expect(
+            lambda{ @node.delete(slave_name) }
+          ).to raise_error
+        end
+      end
+
+      describe "#list" do
+        it "accepts filter and lists all nodes matching the filter" do
+          @client.should_receive(
+            :api_get_request
+          ).and_return(
+            @sample_json_computer_response
+          )
+          @node.list("slave").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.should_receive(
+                :api_get_request
+              ).and_return(
+                @sample_json_computer_response
+              )
+              @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.should_receive(
+                :api_get_request
+              ).twice.and_return(
+                @sample_json_computer_response
+              )
+              @node.method("is_#{property}?").call("slave")
+            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 get the #{attribute} node attribute" do
+              @client.should_receive(
+                :api_get_request
+              ).twice.and_return(
+                @sample_json_computer_response
+              )
+              @node.method("get_node_#{attribute}").call("slave")
+            end
+          end
+        end
+      end
+
+      describe "#get_config" do
+        it "accepts the node name and obtains the config xml from the server" do
+          @client.should_receive(
+            :get_config
+          ).with(
+            "/computer/slave/config.xml"
+          ).and_return(
+            @sample_computer_xml
+          )
+          @node.get_config("slave")
+        end
+      end
+
+      describe "#post_config" do
+        it "accepts the node namd and config.xml and posts it to the server" do
+          @client.should_receive(:post_config)
+          @node.post_config("slave", @sample_computer_xml)
+        end
+      end
+
+    end
+  end
+end