hive-messages 1.0.1

data/lib/hive/paths/queues.rb

@@ -0,0 +1,21 @@
+module Hive
+  module Paths
+
+    class Queues
+
+      class << self
+
+        def job_reservation_url(queues)
+          queues=[*queues].join(",")
+          "#{queues_base}/#{queues}/jobs/reserve"
+        end
+
+        private
+
+        def queues_base
+          "#{Hive::Paths.base}/api/queues"
+        end
+      end
+    end
+  end
+end

data/lib/hive/representers/artifact_representer.rb

@@ -0,0 +1,13 @@
+module Hive
+  module Representers
+    module ArtifactRepresenter
+      include Roar::JSON
+
+      property :artifact_id
+      property :job_id
+      property :asset_file_name
+      property :asset_content_type
+      property :asset_file_size
+    end
+  end
+end

data/lib/hive/representers/job_representer.rb

@@ -0,0 +1,25 @@
+module Hive
+  module Representers
+    module JobRepresenter
+      include Roar::JSON
+
+      property :command
+      property :job_id
+      property :repository
+      property :execution_directory
+      property :target
+      property :execution_variables
+      property :reservation_details
+      property :device_id
+      property :running_count
+      property :passed_count
+      property :failed_count
+      property :errored_count
+      property :state
+      property :result
+      property :exit_value
+      property :message
+      property :result_details
+    end
+  end
+end

data/lib/roar/transport/net_http/request_patch.rb

@@ -0,0 +1,19 @@
+require "roar/transport/net_http/request"
+
+module Roar
+  module Transport
+    class NetHTTP
+      class Request
+
+        class <<self
+
+          def new(options)
+            options[:pem_file] = Hive::Messages.configuration.pem_file
+            options[:ssl_verify_mode] = Hive::Messages.configuration.ssl_verify_mode
+            super(options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/virtus/attribute/execution_variables.rb

@@ -0,0 +1,20 @@
+module Virtus
+  class Attribute
+    class ExecutionVariables < Attribute
+
+      def coerce(values)
+        unless values.blank?
+          klass = Class.new(Hive::Messages::ExecutionVariablesBase)
+
+          attributes     = klass.attribute_set.collect(&:name)
+          new_attributes = values.keys-attributes
+          new_attributes.each do |attribute|
+            klass.attribute attribute
+          end
+
+          klass.new(values)
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/sample.pem

@@ -0,0 +1,31 @@
+-----BEGIN CERTIFICATE-----
+MIICcTCCAdqgAwIBAgIJAMvA30EY1rKtMA0GCSqGSIb3DQEBBQUAMDAxCzAJBgNV
+BAYTAlVTMQ0wCwYDVQQKEwRLZWFzMRIwEAYDVQQDEwlsb2NhbGhvc3QwHhcNMDgw
+OTA0MTU1MTU5WhcNMTgwOTAyMTU1MTU5WjAwMQswCQYDVQQGEwJVUzENMAsGA1UE
+ChMES2VhczESMBAGA1UEAxMJbG9jYWxob3N0MIGfMA0GCSqGSIb3DQEBAQUAA4GN
+ADCBiQKBgQDK17rB/KVaK8MVjiEkvA4ZncOOIC3nStZ/erXM+qwkghPM4Tfr2FTU
+iTgwwdLdu/ht74oWnppttfaTQ+sVz2rFXnPgfqKTGoJTwWFiuNuZhSRDVssGVnL/
+RatZW6wns8UNf+W4hUe6/vGQP6obNTe2T4R+t2hXP51OkOy4BMcq0QIDAQABo4GS
+MIGPMB0GA1UdDgQWBBQDIsX7HoSqbxKrCawi64MkXRmtmzBgBgNVHSMEWTBXgBQD
+IsX7HoSqbxKrCawi64MkXRmtm6E0pDIwMDELMAkGA1UEBhMCVVMxDTALBgNVBAoT
+BEtlYXMxEjAQBgNVBAMTCWxvY2FsaG9zdIIJAMvA30EY1rKtMAwGA1UdEwQFMAMB
+Af8wDQYJKoZIhvcNAQEFBQADgYEAW5UBM7EIMpARzQwpQ8N1gyTR/VqJ9fSm4MIw
+Y5m90HRgsDcXVbhn0rRfcC8o4EtGDvCjqsFYXy/ImF9tjEiuaysxbqepl+XMszPE
+1kO50quWsV1FLSdcJX6t/ofJYOxiQkqPvg9t/ovTnEZ+w4NfPo+0MJgudjJoD2+w
+5UTsKtU=
+-----END CERTIFICATE-----
+-----BEGIN RSA PRIVATE KEY-----
+MIICXQIBAAKBgQDK17rB/KVaK8MVjiEkvA4ZncOOIC3nStZ/erXM+qwkghPM4Tfr
+2FTUiTgwwdLdu/ht74oWnppttfaTQ+sVz2rFXnPgfqKTGoJTwWFiuNuZhSRDVssG
+VnL/RatZW6wns8UNf+W4hUe6/vGQP6obNTe2T4R+t2hXP51OkOy4BMcq0QIDAQAB
+AoGAHcDJDx1M784NfoLrj6TZ+J3wik9kDFIo5mgMdLWsPGqsFthOSJTh1I8QI+66
+THX++bkyKyE2i7MuKOnEeN2Ezo2jAThF7XoWhm6/+pSXhSqmL1jKr/1CZRaR9jv0
+cCVJc3mTuAGH+yFVeGpWNvDaCmOUlD5M48xTROJXteDQ0TECQQDuDM9pmQdqkGIp
+dvbIviS8donYn0kJ0TKS14pMtb/C63lcld513rHS43ru3FRY9baR/q5vV9vW5RhH
+S7w4cYvVAkEA2iNLsFEAkY88oZJYbdyybeKxZdReyes1/zPe4RYzRdbDHRNAa+zk
+mZIZDI820E0Y+DeoT+q3nXkXiiOS/iRNDQJBAKdAvOH2sO1AcJetjArS/cCkkIlw
+sMKDB0OAyRzIfekXxPc2HU03oD0Jsy/sAh9W1GWTST/VvRIpeHtvTNljfdkCQF5T
+UuBcNoW6zXoEYU6oV1Oi6hjhW1eu6PuAv4jPY754XoiNEZdZqYQqo8BFkWtDW1/C
+GXrtQRbMDPzD40UYB2UCQQCmJpJp+u2lHj7zuZikHIHQBNyXyoGnzgNs6XUj1Bs6
+Y4vjue8w6RkRLZ1YGP+xqsngVqb9IRygyLDpEgwEnOT4
+-----END RSA PRIVATE KEY-----

data/spec/fixtures/upload_sample.log

@@ -0,0 +1 @@
+This is a sample log file.

data/spec/lib/hive/messages/artifact_spec.rb

@@ -0,0 +1,50 @@
+require "spec_helper"
+require "shoulda/matchers"
+require "shoulda/matchers/active_model/validate_presence_of_matcher"
+require 'webmock/rspec'
+
+describe Hive::Messages::Artifact, type: :model do
+
+  describe "validations" do
+
+    it { should validate_presence_of(:artifact_id) }
+    it { should validate_presence_of(:job_id) }
+    it { should validate_presence_of(:asset_file_name) }
+    it { should validate_presence_of(:asset_content_type) }
+    it { should validate_presence_of(:asset_file_size) }
+  end
+
+  describe "serialization" do
+
+    let(:artifact_attributes) do
+      {
+          artifact_id:        321,
+          job_id:             123,
+          asset_file_name:    "screenshot1.png",
+          asset_content_type: "image/png",
+          asset_file_size:    2300
+      }
+    end
+
+    describe "#to_json" do
+
+      let(:artifact_message) { Hive::Messages::Artifact.new(artifact_attributes) }
+
+      it  "outputs valid payload JSON" do
+        expect(artifact_message.to_json).to eq artifact_attributes.to_json
+      end
+    end
+
+    describe "#from_json" do
+
+      let(:artifact_message) { Hive::Messages::Artifact.new.from_json(artifact_attributes.to_json) }
+      subject { artifact_message }
+
+      its(:artifact_id)        { should eq artifact_attributes[:artifact_id] }
+      its(:job_id)             { should eq artifact_attributes[:job_id] }
+      its(:asset_file_name)    { should eq artifact_attributes[:asset_file_name] }
+      its(:asset_content_type) { should eq artifact_attributes[:asset_content_type] }
+      its(:asset_file_size)    { should eq artifact_attributes[:asset_file_size] }
+    end
+  end
+end

data/spec/lib/hive/messages/configuration_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+describe Hive::Messages::Configuration do
+
+  describe "attributes" do
+
+    subject { Hive::Messages::Configuration.new.attributes.keys }
+
+    it { should include(:base_path) }
+    it { should include(:pem_file) }
+    it { should include(:ssl_verify_mode) }
+  end
+end

data/spec/lib/hive/messages/execution_variables_base_spec.rb

@@ -0,0 +1,12 @@
+require "spec_helper"
+require "shoulda/matchers"
+
+describe Hive::Messages::ExecutionVariablesBase, type: :model do
+
+  describe "validations" do
+
+    it { should validate_presence_of(:job_id) }
+    it { should validate_presence_of(:version) }
+    it { should validate_presence_of(:queue_name) }
+  end
+end

data/spec/lib/hive/messages/job_spec.rb

@@ -0,0 +1,233 @@
+require "spec_helper"
+require "shoulda/matchers"
+require "shoulda/matchers/active_model/validate_presence_of_matcher"
+require 'webmock/rspec'
+
+describe Hive::Messages::Job, type: :model do
+
+  describe "validations" do
+
+    it { should validate_presence_of(:command) }
+    it { should validate_presence_of(:job_id) }
+  end
+
+  describe "serialization" do
+
+    let(:job_attributes) do
+      {
+          command:             "cucumber -t @all",
+          job_id:              99,
+          repository:          "svn://...",
+          execution_directory: "/some_dir",
+          target:              { application_url: "http://www.bbc.co.uk/mobile", application_url_parameters: "thing=value" },
+          execution_variables: { job_id: 99, version: "1.0", queue_name: "nexus-4", run_id: "88", tests: ["test one", "test two"] },
+          reservation_details: { hive_id: 99, pid: 1024 },
+          device_id:           23,
+          state:               "running"
+
+      }
+    end
+
+    describe "#to_json" do
+
+      let(:job_message) { Hive::Messages::Job.new(job_attributes) }
+
+      it  "outputs valid payload JSON" do
+        expect(job_message.to_json).to eq job_attributes.to_json
+      end
+    end
+
+    describe "#from_json" do
+
+      let(:job_message) { Hive::Messages::Job.new.from_json(job_attributes.to_json) }
+      subject { job_message }
+
+      its(:command)             { should eq job_attributes[:command] }
+      its(:job_id)              { should eq job_attributes[:job_id] }
+      its(:repository)          { should eq job_attributes[:repository] }
+      its(:execution_directory) { should eq job_attributes[:execution_directory] }
+      its(:target)              { should eq job_attributes[:target].stringify_keys }
+      it "assigned the correct values to the execution variables object" do
+        expect(job_message.execution_variables.attributes).to eq job_attributes[:execution_variables]
+      end
+      its(:reservation_details) { should eq job_attributes[:reservation_details].stringify_keys }
+      its(:device_id)           { should eq job_attributes[:device_id] }
+      its(:state)               { should eq job_attributes[:state] }
+    end
+  end
+
+  describe "class methods" do
+
+    describe ".reserve" do
+
+      let(:base_path)           { "http://hive.bbc" }
+      let(:remote_job)          { Hive::Messages::Job.new(job_id: 99, command: "cmd", repository: "repository") }
+      let(:queue_names)         { ["queue_one", "queue_two"] }
+      let(:reservation_details) { { hive_id: 99, worker_pid: 1024 } }
+
+      before(:each) do
+        Hive::Messages.configure { |config| config.base_path = base_path }
+        stub_request(:patch, Hive::Paths::Queues.job_reservation_url(queue_names))
+        .with( body: {reservation_details: reservation_details}.to_json, headers: { "Content-Type" => "application/json" } )
+        .to_return( body: http_body, status: http_status )
+      end
+
+      subject { Hive::Messages::Job.reserve(queue_names, reservation_details) }
+
+      context "when a job is available for reservation" do
+
+        let(:http_status) { 200 }
+        let(:http_body) { remote_job.to_json }
+
+        its(:job_id) { should eq remote_job.job_id }
+        its(:command) { should eq remote_job.command }
+        its(:repository) { should eq remote_job.repository }
+      end
+
+      context "when NO job is available for reservation" do
+
+        let(:http_status) { 404 }
+        let(:http_body) { nil }
+
+        it { should be_nil }
+      end
+    end
+  end
+
+  describe "instance methods" do
+
+    let(:base_path)   { "http://hive.bbc" }
+    let(:remote_job)  { Hive::Messages::Job.new(job_id: job_id, command: "cmd", repository: "repository") }
+
+    let(:local_job) { Hive::Messages::Job.new(job_id: job_id) }
+
+    let(:job_id)    { 99 }
+
+    before(:each) do
+      Hive::Messages.configure { |config| config.base_path = base_path }
+    end
+
+    describe "#start" do
+      let(:device_id) { 33 }
+
+      let!(:stubbed_request) do
+        stub_request(:patch, Hive::Paths::Jobs.start_url(job_id))
+        .with( body: {job_id: job_id, device_id: device_id}.to_json, headers: { "Content-Type" => "application/json" } )
+        .to_return( body: remote_job.to_json )
+      end
+
+      before(:each) do
+        pending "Behaviour of start has changed"
+        local_job.start(device_id)
+      end
+
+      it "made the request to start the job" do
+        expect(stubbed_request).to have_been_requested
+      end
+    end
+
+
+    describe "#update_results" do
+
+      let(:device_id) { 33 }
+
+      let(:running_count)  { 4 }
+      let(:failed_count)   { 3 }
+      let(:errored_count)  { 2 }
+      let(:passed_count)   { 1 }
+
+      let(:counts) {
+        {   running_count: running_count,
+            passed_count:  passed_count,
+            failed_count:  failed_count,
+            errored_count: errored_count
+        }
+      }
+
+      let!(:stubbed_request) do
+        stub_request(:patch, Hive::Paths::Jobs.update_results_url(job_id))
+        .with( body:    {job_id:job_id}.merge(counts).to_json,
+               headers: { "Content-Type" => "application/json" }
+              )
+        .to_return( body: remote_job.to_json )
+      end
+
+      before(:each) do
+        local_job.update_results(counts)
+      end
+
+      it "made the request to start the job" do
+        expect(stubbed_request).to have_been_requested
+      end
+    end
+
+    describe "#report_artifact" do
+
+      let(:remote_artifact) { Hive::Messages::Artifact.new(job_id: 99, asset_file_name: "screenshot_1.png", asset_content_type: "image/png", asset_file_size: 2300) }
+
+      let!(:stubbed_request) do
+        stub_request(:post, Hive::Paths::Artifacts.create_url(job_id))
+        .with(
+            body: "-------------RubyMultipartPost\r\nContent-Disposition: form-data; name=\"data\"; filename=\"#{artifact_basename}\"\r\nContent-Length: 26\r\nContent-Type: #{artifact_mime}\r\nContent-Transfer-Encoding: binary\r\n\r\nThis is a sample log file.\r\n-------------RubyMultipartPost--\r\n\r\n",
+            headers: {'Accept'=>'*/*', 'Content-Length'=>'254', 'Content-Type'=>'multipart/form-data; boundary=-----------RubyMultipartPost', 'User-Agent'=>'Ruby'}
+        )
+        .to_return( body: remote_artifact.to_json )
+      end
+
+      let(:artifact_mime) { MimeMagic.by_path(artifact_path) }
+      let(:artifact_basename) { Pathname.new(artifact_path).basename }
+
+      let(:artifact_path) { File.expand_path("spec/fixtures/upload_sample.log", Hive::Messages.root) }
+
+      let!(:returned_artifact) { Hive::Messages::Job.new(job_id: job_id).report_artifact(artifact_path) }
+
+      it "returns an Artifact object" do
+        expect(returned_artifact).to be_instance_of(Hive::Messages::Artifact)
+      end
+
+      it "populates the resulting Artifact with the attributes returned upstream" do
+        expect(returned_artifact.attributes).to eq remote_artifact.attributes
+      end
+
+      it "uploaded the artifact" do
+        expect(stubbed_request).to have_been_requested
+      end
+    end
+
+    describe "#end" do
+
+      let!(:stubbed_request) do
+        stub_request(:patch, Hive::Paths::Jobs.end_url(job_id))
+        .with( body: {job_id: job_id}.to_json, headers: { "Content-Type" => "application/json" } )
+        .to_return( body: remote_job.to_json )
+      end
+
+      before(:each) do
+        pending "Behaviour of new has changed"
+        Hive::Messages::Job.new(job_id: job_id).end
+      end
+
+      it "made the request to start the job" do
+        expect(stubbed_request).to have_been_requested
+      end
+    end
+
+    describe "#error" do
+
+      let!(:stubbed_request) do
+        stub_request(:patch, Hive::Paths::Jobs.error_url(job_id))
+        .with( body: {job_id: job_id}.to_json, headers: { "Content-Type" => "application/json" } )
+        .to_return( body: remote_job.to_json )
+      end
+
+      before(:each) do
+        pending "Behaviour of new has changed"
+        Hive::Messages::Job.new(job_id: job_id).error
+      end
+
+      it "made the request to start the job" do
+        expect(stubbed_request).to have_been_requested
+      end
+    end
+  end
+end