dor-workflow-client 3.0.0.rc1

data/spec/models/response/workflow_spec.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Dor::Workflow::Response::Workflow do
+  subject(:instance) { described_class.new(xml: xml) }
+
+  describe '#pid' do
+    subject { instance.pid }
+
+    let(:xml) do
+      <<~XML
+        <workflow repository="dor" objectId="druid:mw971zk1113" id="assemblyWF">
+        </workflow>
+      XML
+    end
+    it { is_expected.to eq 'druid:mw971zk1113' }
+  end
+
+  describe '#workflow_name' do
+    subject { instance.workflow_name }
+
+    let(:xml) do
+      <<~XML
+        <workflow repository="dor" objectId="druid:mw971zk1113" id="assemblyWF">
+        </workflow>
+      XML
+    end
+    it { is_expected.to eq 'assemblyWF' }
+  end
+
+  describe '#active?' do
+    subject { instance.active_for?(version: 2) }
+
+    context 'when the workflow has not been instantiated for the given version' do
+      let(:xml) do
+        <<~XML
+          <workflow repository="dor" objectId="druid:mw971zk1113" id="assemblyWF">
+            <process version="1" laneId="default" elapsed="0.0" attempts="1" datetime="2013-02-18T14:40:25-0800" status="completed" name="start-assembly"/>
+            <process version="1" laneId="default" elapsed="0.509" attempts="1" datetime="2013-02-18T14:42:24-0800" status="completed" name="jp2-create"/>
+          </workflow>
+        XML
+      end
+      it { is_expected.to be false }
+    end
+
+    context 'when the workflow has been instantiated for the given version' do
+      let(:xml) do
+        <<~XML
+          <workflow repository="dor" objectId="druid:mw971zk1113" id="assemblyWF">
+            <process version="1" laneId="default" elapsed="0.0" attempts="1" datetime="2013-02-18T14:40:25-0800" status="completed" name="start-assembly"/>
+            <process version="1" laneId="default" elapsed="0.509" attempts="1" datetime="2013-02-18T14:42:24-0800" status="completed" name="jp2-create"/>
+            <process version="2" laneId="default" elapsed="0.509" attempts="1" datetime="2013-02-18T14:42:24-0800" status="waiting" name="jp2-create"/>
+          </workflow>
+        XML
+      end
+      it { is_expected.to be true }
+    end
+  end
+
+  describe '#empty?' do
+    subject { instance.empty? }
+
+    context 'when there is xml' do
+      let(:xml) do
+        '<?xml version="1.0" encoding="UTF-8"?>
+          <workflow repository="dor" objectId="druid:oo201oo0001" id="accessionWF">
+            <process version="2" lifecycle="submitted" elapsed="0.0" archived="true" attempts="1"
+              datetime="2012-11-06T16:18:24-0800" status="completed" name="start-accession"/>
+            <process version="2" elapsed="0.0" archived="true" attempts="1"
+              datetime="2012-11-06T16:18:58-0800" status="completed" name="technical-metadata"/>
+            <process version="2" elapsed="0.0" archived="true" attempts="1"
+              datetime="2012-11-06T16:19:02-0800" status="completed" name="provenance-metadata"/>
+            <process version="2" elapsed="0.0" archived="true" attempts="1"
+              datetime="2012-11-06T16:19:05-0800" status="completed" name="remediate-object"/>
+            <process version="2" elapsed="0.0" archived="true" attempts="1"
+              datetime="2012-11-06T16:19:06-0800" status="completed" name="shelve"/>
+            <process version="2" lifecycle="published" elapsed="0.0" archived="true" attempts="1"
+              datetime="2012-11-06T16:19:07-0800" status="completed" name="publish"/>
+            <process version="2" elapsed="0.0" archived="true" attempts="1"
+              datetime="2012-11-06T16:19:09-0800" status="completed" name="sdr-ingest-transfer"/>
+            <process version="2" lifecycle="accessioned" elapsed="0.0" archived="true" attempts="1"
+              datetime="2012-11-06T16:19:10-0800" status="completed" name="cleanup"/>
+            <process version="2" elapsed="0.0" archived="true" attempts="1"
+              datetime="2012-11-06T16:19:13-0800" status="completed" name="rights-metadata"/>
+            <process version="2" lifecycle="described" elapsed="0.0" archived="true" attempts="1"
+              datetime="2012-11-06T16:19:15-0800" status="completed" name="descriptive-metadata"/>
+            <process version="2" elapsed="0.0" archived="true" attempts="2"
+              datetime="2012-11-06T16:19:16-0800" status="completed" name="content-metadata"/>
+          </workflow>'
+      end
+
+      it { is_expected.to be false }
+    end
+
+    context 'when the xml is empty' do
+      let(:xml) { '' }
+
+      it { is_expected.to be true }
+    end
+  end
+
+  describe '#process_for_recent_version' do
+    subject(:process) { instance.process_for_recent_version(name: 'jp2-create') }
+
+    context 'when the workflow has not been instantiated for the given version' do
+      let(:xml) do
+        <<~XML
+          <workflow repository="dor" objectId="druid:mw971zk1113" id="assemblyWF">
+            <process version="1" laneId="default" elapsed="0.0" attempts="1" datetime="2013-02-18T14:40:25-0800" status="completed" name="start-assembly"/>
+            <process version="1" laneId="default" elapsed="0.509" attempts="1" datetime="2013-02-18T14:42:24-0800" status="completed" name="jp2-create"/>
+          </workflow>
+        XML
+      end
+
+      it 'returns a process' do
+        expect(process).to be_kind_of Dor::Workflow::Response::Process
+        expect(process.status).to eq 'completed'
+        expect(process.name).to eq 'jp2-create'
+      end
+    end
+
+    context 'when the workflow has been instantiated for the given version' do
+      let(:xml) do
+        <<~XML
+          <workflow repository="dor" objectId="druid:mw971zk1113" id="assemblyWF">
+            <process version="1" laneId="default" elapsed="0.0" attempts="1" datetime="2013-02-18T14:40:25-0800" status="completed" name="start-assembly"/>
+            <process version="1" laneId="default" elapsed="0.509" attempts="1" datetime="2013-02-18T14:42:24-0800" status="completed" name="jp2-create"/>
+            <process version="2" laneId="default" elapsed="0.509" attempts="1" datetime="2013-02-18T14:42:24-0800" status="error" name="jp2-create" errorMessage="it just broke"/>
+          </workflow>
+        XML
+      end
+
+      it 'returns a process' do
+        expect(process).to be_kind_of Dor::Workflow::Response::Process
+        expect(process.status).to eq 'error'
+        expect(process.error_message).to eq 'it just broke'
+        expect(process.name).to eq 'jp2-create'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'spec'
+end
+
+require 'byebug'
+require 'dor/workflow/client'
+require 'equivalent-xml'
+require 'equivalent-xml/rspec_matchers'
+require 'webmock/rspec'
+
+# RSpec.configure do |conf|
+# end

data/spec/workflow/client/connection_factory_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+# This test can take up to 15s to run because it does retries with exponential backoff
+RSpec.describe Dor::Workflow::Client::ConnectionFactory do
+  let(:mock_logger) { double('Logger', info: true, debug: true, warn: true) }
+
+  let(:repo) { 'dor' }
+  let(:druid) { 'druid:123' }
+  before do
+    stub_request(:put, "http://example.com/#{repo}/objects/#{druid}/workflows/httpException?create-ds=true")
+      .to_return(status: 500, body: 'Internal error', headers: {})
+  end
+
+  let(:client) { Dor::Workflow::Client.new url: 'http://example.com', logger: mock_logger }
+
+  describe '#create_workflow' do
+    it 'logs an error and retry upon a targeted Faraday exception' do
+      expect(mock_logger).to receive(:warn).with('retrying connection (1 remaining) to http://example.com/dor/objects/druid:123/workflows/httpException?create-ds=true: (Faraday::RetriableResponse)  500')
+      expect(mock_logger).to receive(:warn).with('retrying connection (0 remaining) to http://example.com/dor/objects/druid:123/workflows/httpException?create-ds=true: (Faraday::RetriableResponse)  500')
+      expect { client.create_workflow(repo, druid, 'httpException', '<xml>') }.to raise_error Dor::WorkflowException
+    end
+  end
+end

data/spec/workflow/client/lifecycle_routes_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Dor::Workflow::Client::LifecycleRoutes do
+  let(:mock_requestor) { instance_double(Dor::Workflow::Client::Requestor) }
+
+  let(:routes) { described_class.new(requestor: mock_requestor) }
+
+  describe '#milestones' do
+    let(:ng_xml) { Nokogiri::XML(xml) }
+    let(:xml) do
+      '<?xml version="1.0" encoding="UTF-8"?><lifecycle objectId="druid:gv054hp4128"><milestone date="2012-01-26T21:06:54-0800" version="2">published</milestone></lifecycle>'
+    end
+
+    before do
+      allow(routes).to receive(:query_lifecycle).and_return(ng_xml)
+    end
+
+    subject(:milestones) { routes.milestones('dor', 'druid:gv054hp4128') }
+
+    it 'includes the version in with the milestones' do
+      expect(milestones.first[:milestone]).to eq('published')
+      expect(milestones.first[:version]).to eq('2')
+    end
+  end
+end

data/spec/workflow/client/requestor_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Dor::Workflow::Client::Requestor do
+  let(:mock_http_connection) do
+    Faraday.new(url: 'http://example.com/') do |builder|
+      builder.use Faraday::Response::RaiseError
+      builder.options.params_encoder = Faraday::FlatParamsEncoder
+
+      builder.adapter :test, stubs
+    end
+  end
+
+  let(:requestor) { described_class.new(connection: mock_http_connection) }
+
+  describe '.send_workflow_resource_request' do
+    let(:stubs) do
+      Faraday::Adapter::Test::Stubs.new do |stub|
+        stub.get('x?complete=a&complete=b') do |_env|
+          [200, {}, 'ab']
+        end
+      end
+    end
+
+    it 'uses the flat params encoder' do
+      response = requestor.send(:send_workflow_resource_request, 'x?complete=a&complete=b')
+
+      expect(response.body).to eq 'ab'
+      expect(response.env.url.query).to eq 'complete=a&complete=b'
+    end
+  end
+end

data/spec/workflow/client/workflow_routes_spec.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Dor::Workflow::Client::WorkflowRoutes do
+  let(:mock_requestor) { instance_double(Dor::Workflow::Client::Requestor) }
+
+  let(:routes) { described_class.new(requestor: mock_requestor) }
+
+  let(:wf_xml) do
+    <<-EOXML
+    <workflow id="etdSubmitWF">
+         <process name="register-object" status="completed" attempts="1" />
+         <process name="submit" status="waiting" />
+         <process name="reader-approval" status="waiting" />
+         <process name="registrar-approval" status="waiting" />
+         <process name="start-accession" status="waiting" />
+    </workflow>
+    EOXML
+  end
+
+  describe '#add_lane_id_to_workflow_xml' do
+    it 'adds laneId attributes to all process elements' do
+      expected = <<-XML
+        <workflow id="etdSubmitWF">
+          <process name="register-object" status="completed" attempts="1" laneId="lane1"/>
+          <process name="submit" status="waiting" laneId="lane1"/>
+          <process name="reader-approval" status="waiting" laneId="lane1"/>
+          <process name="registrar-approval" status="waiting" laneId="lane1"/>
+          <process name="start-accession" status="waiting" laneId="lane1"/>
+        </workflow>
+      XML
+      expect(routes.send(:add_lane_id_to_workflow_xml, 'lane1', wf_xml)).to be_equivalent_to(expected)
+    end
+  end
+
+  describe '#workflow' do
+    let(:xml) do
+      <<~XML
+        <workflow repository="dor" objectId="druid:mw971zk1113" id="accessionWF">
+          <process laneId="default" lifecycle="submitted" elapsed="0.0" attempts="1" datetime="2013-02-18T15:08:10-0800" status="completed" name="start-accession"/>
+        </workflow>
+      XML
+    end
+    before do
+      allow(routes).to receive(:workflow_xml) { xml }
+    end
+
+    it 'it returns a workflow' do
+      expect(routes.workflow(pid: 'druid:mw971zk1113', workflow_name: 'accessionWF')).to be_kind_of Dor::Workflow::Response::Workflow
+    end
+  end
+end