build_eval 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 582fae85bf01612ef73e180f2d762834629d5cc7
-  data.tar.gz: 0d8fa6378adb766d1c7392dc3bbcb9c8821fdc26
+  metadata.gz: c9ed39e2bae3a1ef5d1ffd40242183287fae193a
+  data.tar.gz: bff2e6552ad2a28e5d1dbc0cea6b463cd6a82a3a
 SHA512:
-  metadata.gz: 8ff9b48b6b4dc4073b249c87e3a9258b50a94b3e68fb1e218d4c4e9560753b131fb474d5f398f99e7f6c7e564a24d1f49385b7f4cb75136988e697f104f1c7c1
-  data.tar.gz: 1c4c9bb4757754e7addef6326c15cc8d96a74eaa08121023330a74da3e388ebd1dfaf78d0776e33be39480202b4bb482cfe35b1e739e68382305aab9511ecbde
+  metadata.gz: b6006e6709284a157a71b6b48f09b0706f9112c89706e57de79faf3a40d3b46d8e998366c422420349f5d48e1e2beb6e0f6ff3cdddb59993efb5abe34bc862a6
+  data.tar.gz: 6c2978e0ce2095206a9086b018beef07e409f18dbf3c8e9afb5c7b8210942728b496ac04d8af499f3e9d54deb5df6435dfedef34f18d252661602afc1f1113b1

data/lib/build_eval/error.rb

@@ -0,0 +1,11 @@
+module BuildEval
+
+  class Error < ::StandardError
+
+    def initialize(message)
+      super(message)
+    end
+
+  end
+
+end

data/lib/build_eval/http.rb

@@ -2,15 +2,29 @@ module BuildEval
 
   class Http
 
-    def self.get(uri_string, basic_auth=nil)
+    def initialize(config)
+      @username        = config[:username]
+      @password        = config[:password]
+      @ssl_verify_mode = config[:ssl_verify_mode]
+    end
+
+    def get(uri_string)
       uri = URI.parse(uri_string)
-      Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") do |http|
+      Net::HTTP.start(uri.host, uri.port, ssl_options(uri)) do |http|
         request = Net::HTTP::Get.new(uri.request_uri)
-        request.basic_auth(basic_auth[:username], basic_auth[:password]) if basic_auth
+        request.basic_auth(@username, @password) if @username && @password
         http.request(request)
       end
     end
 
+    private
+
+    def ssl_options(uri)
+      ssl_options = { use_ssl: uri.scheme == "https" }
+      ssl_options[:ssl_verify_mode] = @ssl_verify_mode if @ssl_verify_mode
+      ssl_options
+    end
+
   end
 
 end

data/lib/build_eval/result/build_result.rb

@@ -9,8 +9,8 @@ module BuildEval
           self.new(build_name: args[:build_name], status: BuildEval::Result::Status.find(args[:status_name]))
         end
 
-        def unknown(build_name)
-          self.new(build_name: build_name, status: BuildEval::Result::Status::UNKNOWN)
+        def indeterminate(build_name)
+          self.new(build_name: build_name, status: BuildEval::Result::Status::INDETERMINATE)
         end
 
       end

data/lib/build_eval/result/status.rb

@@ -13,10 +13,11 @@ module BuildEval
 
       public
 
-      SUCCESS = self.new(severity: 0, symbol: :success!, description: "succeeded")
-      UNKNOWN = self.new(severity: 1, symbol: :warning!, description: "unknown")
-      FAILURE = self.new(severity: 2, symbol: :failure!,  description: "failed")
-      ERROR   = self.new(severity: 3, symbol: :failure!,  description: "errored")
+      SUCCESS       = self.new(severity: 0, symbol: :success!, description: "succeeded")
+      UNKNOWN       = self.new(severity: 1, symbol: :warning!, description: "unknown")
+      INDETERMINATE = self.new(severity: 2, symbol: :warning!, description: "indeterminate")
+      FAILURE       = self.new(severity: 3, symbol: :failure!, description: "failed")
+      ERROR         = self.new(severity: 4, symbol: :failure!, description: "errored")
 
       class << self
 

data/lib/build_eval/server/cruise_control_response.rb

@@ -0,0 +1,22 @@
+module BuildEval
+  module Server
+
+    class CruiseControlResponse
+
+      def initialize(raw_response)
+        @raw_response = raw_response
+      end
+
+      def parse_result(project_selector)
+        build_element = Nokogiri::XML(@raw_response.body).xpath(project_selector).first
+        raise BuildEval::Server::InvalidSelectorError.new(@raw_response, project_selector) unless build_element
+        BuildEval::Result::BuildResult.create(
+          build_name:  build_element.attribute("name").value.match(/[^\/]+$/)[0],
+          status_name: build_element.attribute("lastBuildStatus").value
+        )
+      end
+
+    end
+
+  end
+end

data/lib/build_eval/server/decorator.rb

@@ -11,7 +11,7 @@ module BuildEval
         begin
           @delegate.build_result(name)
         rescue Exception
-          BuildEval::Result::BuildResult.unknown(name)
+          BuildEval::Result::BuildResult.indeterminate(name)
         end
       end
 

data/lib/build_eval/server/invalid_selector_error.rb

@@ -0,0 +1,13 @@
+module BuildEval
+  module Server
+
+    class InvalidSelectorError < BuildEval::Error
+
+      def initialize(response, selector)
+        super("Build response did not match selector:\nResponse: #{response.message}\nSelector: #{selector}")
+      end
+
+    end
+
+  end
+end

data/lib/build_eval/server/jenkins.rb

@@ -0,0 +1,23 @@
+module BuildEval
+  module Server
+
+    class Jenkins
+
+      def initialize(args)
+        @http     = BuildEval::Http.new(args)
+        @base_uri = args[:uri]
+      end
+
+      def build_result(name)
+        raw_response = @http.get("#{@base_uri}/cc.xml")
+        BuildEval::Server::CruiseControlResponse.new(raw_response).parse_result("//Project[@name=\"#{name}\"]")
+      end
+
+      def to_s
+        "Jenkins server #{@base_uri}"
+      end
+
+    end
+
+  end
+end

data/lib/build_eval/server/team_city.rb

@@ -4,15 +4,12 @@ module BuildEval
     class TeamCity
 
       def initialize(args)
+        @http     = BuildEval::Http.new(args)
         @base_uri = args[:uri]
-        @username = args[:username]
-        @password = args[:password]
       end
 
       def build_result(name)
-        response = BuildEval::Http.get(
-          "#{@base_uri}/httpAuth/app/rest/buildTypes/id:#{name}/builds", username: @username, password: @password
-        )
+        response = @http.get("#{@base_uri}/httpAuth/app/rest/buildTypes/id:#{name}/builds")
         build_element = Nokogiri::XML(response.body).xpath("//build").first
         raise "Unexpected build response: #{response.message}" unless build_element
         BuildEval::Result::BuildResult.create(build_name: name, status_name: build_element.attribute("status").value)

data/lib/build_eval/server/travis.rb

@@ -4,16 +4,13 @@ module BuildEval
     class Travis
 
       def initialize(args)
+        @http     = BuildEval::Http.new(args)
         @username = args[:username]
       end
 
       def build_result(name)
-        response = BuildEval::Http.get("https://api.travis-ci.org/repositories/#{@username}/#{name}/cc.xml")
-        build_element = Nokogiri::XML(response.body).xpath("//Project").first
-        raise "Unexpected build response: #{response.message}" unless build_element
-        BuildEval::Result::BuildResult.create(
-          build_name: name, status_name: build_element.attribute("lastBuildStatus").value
-        )
+        raw_response = @http.get("https://api.travis-ci.org/repositories/#{@username}/#{name}/cc.xml")
+        BuildEval::Server::CruiseControlResponse.new(raw_response).parse_result("//Project")
       end
 
       def to_s

data/lib/build_eval/version.rb

@@ -1,3 +1,3 @@
 module BuildEval
-  VERSION = "0.0.3".freeze
+  VERSION = "0.0.4".freeze
 end

data/lib/build_eval.rb

@@ -1,13 +1,19 @@
 require 'nokogiri'
-
+require 'uri'
+require 'net/http'
+require 'net/https'
+require_relative 'build_eval/error'
 require_relative 'build_eval/http'
 require_relative 'build_eval/result/status'
 require_relative 'build_eval/result/build_result'
 require_relative 'build_eval/result/server_result'
 require_relative 'build_eval/result/composite_result'
+require_relative 'build_eval/server/invalid_selector_error'
 require_relative 'build_eval/server/decorator'
+require_relative 'build_eval/server/cruise_control_response'
 require_relative 'build_eval/server/team_city'
 require_relative 'build_eval/server/travis'
+require_relative 'build_eval/server/jenkins'
 require_relative 'build_eval/monitor/base'
 require_relative 'build_eval/monitor/server'
 require_relative 'build_eval/monitor/composite'

data/spec/lib/build_eval/error_spec.rb

@@ -0,0 +1,21 @@
+describe BuildEval::Error do
+
+  let(:message) { "some message" }
+
+  let(:error) { described_class.new(message) }
+
+  it "is a standard error" do
+    expect(error).to be_a(::StandardError)
+  end
+
+  describe "#messsage" do
+
+    subject { error.message }
+
+    it "returns the provided message" do
+      expect(subject).to eql(message)
+    end
+
+  end
+
+end

data/spec/lib/build_eval/http_shared_context.rb

@@ -0,0 +1,7 @@
+shared_context "stubbed http interactions" do
+
+  let(:http) { instance_double(BuildEval::Http) }
+
+  before(:example) { allow(BuildEval::Http).to receive(:new).and_return(http) }
+
+end

data/spec/lib/build_eval/http_spec.rb

@@ -1,5 +1,9 @@
 describe BuildEval::Http do
 
+  let(:config) { {} }
+
+  let(:http)   { described_class.new(config) }
+
   shared_examples_for "a http method returning a response" do
 
     let(:response_status) { [ "200", "OK" ] }
@@ -19,14 +23,14 @@ describe BuildEval::Http do
 
   end
 
-  describe "::get" do
+  describe "#get" do
 
     let(:scheme)     { "http" }
     let(:host)       { "a.host" }
     let(:path)       { "some/path" }
     let(:uri_string) { "#{scheme}://#{host}/#{path}" }
 
-    subject { described_class.get(uri_string) }
+    subject { http.get(uri_string) }
 
     context "when the uri is valid" do
 
@@ -52,15 +56,31 @@ describe BuildEval::Http do
 
       end
 
-      context "and basic authentication is provided" do
+      context "and an ssl verification mode configuration option was established" do
+
+        let(:ssl_verification_mode) { OpenSSL::SSL::VERIFY_NONE }
+        let(:config)                { { ssl_verify_mode: ssl_verification_mode } }
+
+        it_behaves_like "a http method returning a response"
+
+      end
+
+      context "and partial authentication configuration options were established" do
+
+        let(:config)   { { username: "some_username" } }
+
+        it_behaves_like "a http method returning a response"
+
+      end
+
+      context "and basic authentication configuration options were established" do
 
         let(:username) { "some_username" }
         let(:password) { "some_password" }
+        let(:config)   { { username: username, password: password } }
 
         let(:expected_request_uri) { "#{scheme}://#{username}:#{password}@#{host}/#{path}" }
 
-        subject { described_class.get(uri_string, basic_authentication: { username: username, password: password }) }
-
         it_behaves_like "a http method returning a response"
 
       end

data/spec/lib/build_eval/result/build_result_spec.rb

@@ -27,18 +27,18 @@ describe BuildEval::Result::BuildResult do
 
   end
 
-  describe "::unknown" do
+  describe "::indeterminate" do
 
     let(:build_name) { "Some build name" }
 
-    subject { described_class.unknown(build_name) }
+    subject { described_class.indeterminate(build_name) }
 
     it "returns a result with the provided build name" do
       expect(subject.build_name).to eql(build_name)
     end
 
-    it "returns a result with an unknown status" do
-      expect(subject.status).to eql(BuildEval::Result::Status::UNKNOWN)
+    it "returns a result with an indeterminate status" do
+      expect(subject.status).to eql(BuildEval::Result::Status::INDETERMINATE)
     end
 
   end

data/spec/lib/build_eval/result/status_spec.rb

@@ -50,13 +50,16 @@ describe BuildEval::Result::Status do
 
     end
 
-    context "when the statuses are ordered in descending severity" do
+    context "when the statuses are ordered in ascending severity" do
 
       let(:statuses) do
-        [ BuildEval::Result::Status::ERROR,
+        [
+          BuildEval::Result::Status::ERROR,
           BuildEval::Result::Status::FAILURE,
           BuildEval::Result::Status::UNKNOWN,
-          BuildEval::Result::Status::SUCCESS ]
+          BuildEval::Result::Status::INDETERMINATE,
+          BuildEval::Result::Status::SUCCESS
+        ]
       end
 
       it "returns the most severe status" do
@@ -65,13 +68,16 @@ describe BuildEval::Result::Status do
 
     end
 
-    context "when the statuses are ordered in ascending severity" do
+    context "when the statuses are ordered in descending severity" do
 
       let(:statuses) do
-        [ BuildEval::Result::Status::SUCCESS,
+        [
+          BuildEval::Result::Status::SUCCESS,
           BuildEval::Result::Status::UNKNOWN,
+          BuildEval::Result::Status::INDETERMINATE,
           BuildEval::Result::Status::FAILURE,
-          BuildEval::Result::Status::ERROR ]
+          BuildEval::Result::Status::ERROR
+        ]
       end
 
       it "returns the most severe status" do
@@ -97,9 +103,10 @@ describe BuildEval::Result::Status do
     end
 
     {
-      "UNKNOWN" => BuildEval::Result::Status::UNKNOWN,
-      "FAILURE" => BuildEval::Result::Status::FAILURE,
-      "ERROR"   => BuildEval::Result::Status::ERROR
+      "UNKNOWN"       => BuildEval::Result::Status::UNKNOWN,
+      "FAILURE"       => BuildEval::Result::Status::FAILURE,
+      "ERROR"         => BuildEval::Result::Status::ERROR,
+      "INDETERMINATE" => BuildEval::Result::Status::INDETERMINATE
     }.each do |name, status|
 
       context "when the status is #{name}" do
@@ -120,7 +127,13 @@ describe BuildEval::Result::Status do
 
     subject { status.to_sym }
 
-    { SUCCESS: :success!, UNKNOWN: :warning!, FAILURE: :failure!, ERROR: :failure! }.each do |name, expected_symbol|
+    {
+      SUCCESS:       :success!,
+      UNKNOWN:       :warning!,
+      INDETERMINATE: :warning!,
+      FAILURE:       :failure!,
+      ERROR:         :failure!
+    }.each do |name, expected_symbol|
 
       context "when the status is #{name}" do
 
@@ -140,7 +153,13 @@ describe BuildEval::Result::Status do
 
     subject { status.to_s }
 
-    { SUCCESS: "succeeded", UNKNOWN: "unknown", FAILURE: "failed", ERROR: "errored" }.each do |name, expected_string|
+    {
+      SUCCESS:       "succeeded",
+      UNKNOWN:       "unknown",
+      INDETERMINATE: "indeterminate",
+      FAILURE:       "failed",
+      ERROR:         "errored"
+    }.each do |name, expected_string|
 
       context "when the status is #{name}" do
 

data/spec/lib/build_eval/server/cruise_control_response_spec.rb

@@ -0,0 +1,115 @@
+describe BuildEval::Server::CruiseControlResponse do
+
+  let(:raw_response) { double("RawResponse", body: response_body) }
+
+  let(:cruise_control_response) { described_class.new(raw_response) }
+
+  describe "#parse_result" do
+
+    let(:build_name)          { "some_build_name" }
+    let(:response_build_name) { build_name }
+    let(:project_selector)    { "//Project[2]" }
+
+    subject { cruise_control_response.parse_result(project_selector) }
+
+    context "when the response is successful, containing projects" do
+
+      let(:latest_build_status) { "Success" }
+      let(:response_body) do
+        <<-RESPONSE
+          <Projects>
+            <Project name="another_build_name" activity="Sleeping" lastBuildStatus="Unknown" lastBuildLabel="2" lastBuildTime="2015-08-02T00:00:00.000+0000" webUrl="https://my.build.server/another_build_name" />
+            <Project name="#{response_build_name}" activity="Sleeping" lastBuildStatus="#{latest_build_status}" lastBuildLabel="1" lastBuildTime="2015-08-01T00:00:00.000+0000" webUrl="https://my.build.server/#{build_name}" />
+            <Project name="yet_another_build_name" activity="Sleeping" lastBuildStatus="Error" lastBuildLabel="3" lastBuildTime="2015-08-03T00:00:00.000+0000" webUrl="https://my.build.server/yet_another_build_name" />
+          </Projects>
+        RESPONSE
+      end
+
+      context "and the selector matches a project" do
+
+        context "and the build name in the response is not a path" do
+
+          it "creates a build result with the build name from the response" do
+            expect(BuildEval::Result::BuildResult).to receive(:create).with(hash_including(build_name: build_name))
+
+            subject
+          end
+
+        end
+
+        context "and the build name in the response is a path" do
+
+          let(:response_build_name) { "some/path/to/#{build_name}" }
+
+          it "creates a build result with the build name from the response with the path omitted" do
+            expect(BuildEval::Result::BuildResult).to receive(:create).with(hash_including(build_name: build_name))
+
+            subject
+          end
+
+        end
+
+        it "creates a build result containing the latest build status" do
+          expect(BuildEval::Result::BuildResult).to(
+            receive(:create).with(hash_including(status_name: latest_build_status))
+          )
+
+          subject
+        end
+
+        it "returns the created result" do
+          build_result = instance_double(BuildEval::Result::BuildResult)
+          allow(BuildEval::Result::BuildResult).to receive(:create).and_return(build_result)
+
+          expect(subject).to eql(build_result)
+        end
+
+      end
+
+      context "and the selector does not match a project" do
+
+        let(:project_selector) { "does_not_match" }
+        let(:error)            { "an error" }
+
+        before(:example) { allow(BuildEval::Server::InvalidSelectorError).to receive(:new).and_return(error) }
+
+        it "creates an invalid selector error" do
+          expect(BuildEval::Server::InvalidSelectorError).to(
+            receive(:new).with(raw_response, project_selector).and_return(error)
+          )
+
+          subject rescue Exception
+        end
+
+        it "raises the error" do
+          expect { subject }.to raise_error(error)
+        end
+
+      end
+
+    end
+
+    context "when the response is in error" do
+
+      let(:response_body) { { "file" => "not found" }.to_json }
+      let(:error)         { "an error" }
+
+      before(:example) { allow(BuildEval::Server::InvalidSelectorError).to receive(:new).and_return(error) }
+
+      it "creates an invalid selector error" do
+        expect(BuildEval::Server::InvalidSelectorError).to(
+          receive(:new).with(raw_response, project_selector).and_return(error)
+        )
+
+        subject rescue Exception
+      end
+
+      it "raises an invalid selector error" do
+        expect { subject }.to raise_error(error)
+      end
+
+    end
+
+  end
+
+end

data/spec/lib/build_eval/server/decorator_spec.rb

@@ -32,17 +32,17 @@ describe BuildEval::Server::Decorator do
 
       before(:example) { allow(server).to receive(:build_result).and_raise("Forced error") }
 
-      it "creates an unknown result" do
-        expect(BuildEval::Result::BuildResult).to receive(:unknown).with(build_name)
+      it "creates an indeterminate result" do
+        expect(BuildEval::Result::BuildResult).to receive(:indeterminate).with(build_name)
 
         subject
       end
 
-      it "returns the unknown result" do
-        unknown_build_result = instance_double(BuildEval::Result::BuildResult)
-        allow(BuildEval::Result::BuildResult).to receive(:unknown).and_return(unknown_build_result)
+      it "returns the indeterminate result" do
+        indeterminate_result = instance_double(BuildEval::Result::BuildResult)
+        allow(BuildEval::Result::BuildResult).to receive(:indeterminate).and_return(indeterminate_result)
 
-        expect(subject).to eql(unknown_build_result)
+        expect(subject).to eql(indeterminate_result)
       end
 
     end

data/spec/lib/build_eval/server/invalid_selector_error_spec.rb

@@ -0,0 +1,27 @@
+describe BuildEval::Server::InvalidSelectorError do
+
+  let(:response_message) { "Some response message" }
+  let(:response)         { double("HttpResponse", message: response_message) }
+  let(:selector)         { "some/selector" }
+
+  let(:error) { described_class.new(response, selector) }
+
+  describe "#message" do
+
+    subject { error.message }
+
+    it "indicates the selector was not matched" do
+      expect(subject).to match(/response did not match selector/i)
+    end
+
+    it "contains a message describing the response" do
+      expect(subject).to include(response_message)
+    end
+
+    it "contains the selector that was invalid" do
+      expect(subject).to include(selector)
+    end
+
+  end
+
+end

data/spec/lib/build_eval/server/jenkins_integration_spec.rb

@@ -0,0 +1,52 @@
+describe BuildEval::Server::Jenkins, "integrating with a response parser", integration: true do
+  include_context "stubbed http interactions"
+
+  let(:uri) { "https://some.jenkins.server" }
+
+  let(:jenkins) { described_class.new(uri: uri) }
+
+  describe "#build_result" do
+
+    let(:build_name) { "some_build_name" }
+    let(:response)   { instance_double(Net::HTTPResponse, body: response_body) }
+
+    subject { jenkins.build_result(build_name) }
+
+    before(:example) { allow(http).to receive(:get).and_return(response) }
+
+    context "when the server responds successfully with build results" do
+
+      let(:latest_build_status) { "Failure" }
+      let(:response_body) do
+        <<-RESPONSE
+         <Projects>
+          <Project webUrl="#{uri}/job/#{build_name}/" name="#{build_name}" lastBuildLabel="190" lastBuildTime="2015-10-09T02:39:36Z" lastBuildStatus="#{latest_build_status}" activity="Sleeping"/>
+          <Project webUrl="#{uri}/job/another_build_name/" name="another_build_name" lastBuildLabel="71" lastBuildTime="2015-10-12T17:07:00Z" lastBuildStatus="Success" activity="Sleeping"/>
+          <Project webUrl="#{uri}/job/yet_another_build_name/" name="yet_another_build_name" lastBuildLabel="15" lastBuildTime="2015-10-13T01:40:32Z" lastBuildStatus="Success" activity="Sleeping"/>
+         </Projects>
+        RESPONSE
+      end
+
+      it "creates a build result containing the build name" do
+        expect(BuildEval::Result::BuildResult).to receive(:create).with(hash_including(build_name: build_name))
+
+        subject
+      end
+
+      it "creates a build result containing the latest build status" do
+        expect(BuildEval::Result::BuildResult).to receive(:create).with(hash_including(status_name: latest_build_status))
+        subject
+      end
+
+      it "returns the created result" do
+        build_result = instance_double(BuildEval::Result::BuildResult)
+        allow(BuildEval::Result::BuildResult).to receive(:create).and_return(build_result)
+
+        expect(subject).to eql(build_result)
+      end
+
+    end
+
+  end
+
+end