ticket-replicator 0.1.1 → 1.1.0

data/spec/ticket/replicator/row_loader_spec.rb

@@ -20,12 +20,13 @@ module Ticket
       end
 
       describe ".fields_to_load" do
-        it { expect(described_class.fields_to_load).to eq(%i[id status resolution priority team summary]) }
+        it { expect(described_class.fields_to_load).to eq(%i[id status resolution priority summary source_ticket_url]) }
       end
 
       describe "#run" do
         it do
           expect(loader).to receive(:save_ticket)
+          expect(loader).to receive(:update_source_ticket_remote_link)
           expect(loader).to receive(:transition_ticket_to_the_expected_status)
 
           loader.run
@@ -56,6 +57,49 @@ module Ticket
         end
       end
 
+      describe "#jira_resolution_value" do
+        let(:loader) { described_class.send(:new, jira_project, row) }
+        let(:row) { { resolution: actual_resolution } }
+        let(:logger) { instance_double(Logger, info: nil) }
+        let(:resolutions) { { "Done" => double(id: "10004"), "Won't Fix" => double(id: "10005") } }
+
+        let(:jira_resolution_value) { loader.send(:jira_resolution_value) }
+
+        before do
+          allow(jira_project).to receive(:resolutions).and_return(resolutions)
+          allow(loader).to receive(:log).and_return(logger)
+        end
+
+        context "when the resolution is not set" do
+          let(:actual_resolution) { nil }
+          it { expect(jira_resolution_value).to be_nil }
+        end
+
+        context "when the resolution is an empty string" do
+          let(:actual_resolution) { "" }
+          it { expect(jira_resolution_value).to be_nil }
+        end
+
+        context "when the resolution is set to an existing value" do
+          let(:actual_resolution) { "Done" }
+          it { expect(jira_resolution_value).to eq({ name: "Done" }) }
+        end
+
+        context "when the resolution is set to an unknown value" do
+          let(:actual_resolution) { "an unknown resolution #{rand}" }
+
+          it do
+            expect(logger).to receive(:warn) do |&block|
+              expect(block.call)
+                .to eq("Setting resolution to unset " \
+                       "since resolution #{actual_resolution.inspect} not found in #{resolutions.inspect}!")
+            end
+
+            expect(jira_resolution_value).to be_nil
+          end
+        end
+      end
+
       describe "#fetch_ticket" do
         let(:loader) { described_class.send(:new, jira_project, { id: "123" }) }
 
@@ -92,7 +136,8 @@ module Ticket
         let(:loader) { described_class.send(:new, jira_project, row) }
 
         let(:row) do
-          { id: "123", priority: "Low", resolution: "", status: "Open", summary: "PREFIX | summary", team: "A Team" }
+          { id: "123", priority: "Low", resolution: "Done", status: "Open", summary: "PREFIX | summary",
+            team: "A Team" }
         end
 
         let(:ticket) { instance_double(Ticket, jira_ticket: jira_ticket) }
@@ -100,8 +145,15 @@ module Ticket
         let(:jira_ticket) { double(JIRA::Resource::Issue) }
 
         before do
-          allow(loader).to receive_messages(ticket: ticket,
-                                            :ticket_fields_need_to_be_updated? => ticket_fields_need_to_be_updated?)
+          allow(loader).to receive_messages(
+            ticket: ticket,
+            :ticket_fields_need_to_be_updated? => ticket_fields_need_to_be_updated?
+          )
+
+          allow(jira_project)
+            .to receive_messages(resolutions: {
+                                   "Done" => nil, "Won't Do" => nil, "Duplicate" => nil, "Cannot Reproduce" => nil
+                                 })
         end
 
         context "when the previously replicated needs to be updated " do
@@ -112,9 +164,8 @@ module Ticket
                                                           fields: {
                                                             project: { key: "PROJKEY" },
                                                             issuetype: { name: "Bug" },
-                                                            # resolution: { name: "" },
+                                                            resolution: { name: "Done" },
                                                             priority: { name: "Low" },
-                                                            #         team: { name: "A Team" },
                                                             summary: "PREFIX | summary"
                                                           }
                                                         })
@@ -137,6 +188,30 @@ module Ticket
         end
       end
 
+      describe "#build_ticket_link_attributes" do
+        it "builds the link attributes with a default application" do
+          expect(described_class.send(:build_ticket_link_attributes,
+                                      "https://url/to/source/ticket/123", "Source Ticket 123"))
+            .to eq({ "object" => { "url" => "https://url/to/source/ticket/123", "title" => "Source Ticket 123" },
+                     "application" => { "name" => "Ticket Source" } })
+        end
+
+        it "builds the link attributes with a custom application" do
+          expect(described_class.send(:build_ticket_link_attributes,
+                                      "https://url/to/source/ticket/123", "Source Ticket 123",
+                                      "A custom application"))
+            .to eq({ "object" => { "url" => "https://url/to/source/ticket/123", "title" => "Source Ticket 123" },
+                     "application" => { "name" => "A custom application" } })
+        end
+
+        it "builds the link attributes with no application" do
+          expect(described_class.send(:build_ticket_link_attributes,
+                                      "https://url/to/source/ticket/123", "Source Ticket 123",
+                                      nil))
+            .to eq({ "object" => { "url" => "https://url/to/source/ticket/123", "title" => "Source Ticket 123" } })
+        end
+      end
+
       describe "#ticket_fields_need_to_be_updated?" do
         before do
           allow(loader).to receive_messages(ticket_previously_replicated?: ticket_previously_replicated?,
@@ -225,21 +300,139 @@ module Ticket
         end
       end
 
-      describe "#transition_ticket_to_the_expected_status" do
+      # rubocop:disable Metrics/BlockLength
+      context "when caring for the source ticket link" do
+        def build_link(url, title, application_name = "Ticket Source")
+          RowLoader.build_ticket_link_attributes(url, title, application_name)
+        end
+
         let(:loader) { described_class.send(:new, jira_project, row) }
-        let(:row) { { id: "123", status: "Testing" } }
+        let(:row) { { id: "123", source_ticket_url: "https://url/to/source/ticket/123" } }
+        let(:ticket) { instance_double(Ticket, jira_ticket: jira_ticket) }
+        let(:jira_ticket) { double(JIRA::Resource::Issue, remotelink: double(build: remotelink)) }
+        let(:remotelink) { instance_double(JIRA::Resource::Remotelink) }
 
-        let(:ticket) { double(Ticket) }
+        before { allow(loader).to receive_messages(ticket: ticket) }
 
-        it do
-          expect(loader).to receive(:ticket).at_least(:once).and_return(ticket)
-          expect(ticket).to receive(:transition_to).with("Testing")
+        let(:expected_link) { build_link("https://url/to/source/ticket/123", "Source Ticket 123") }
+
+        describe "#source_ticket_link_title" do
+          it { expect(loader.source_ticket_link_title).to eq("Source Ticket 123") }
+        end
+
+        describe "#update_source_ticket_remote_link" do
+          before do
+            allow(loader).to receive_messages(source_ticket_link_needs_update?: needs_update)
+          end
+
+          context "when the link does not exist" do
+            let(:needs_update) { true }
+
+            before { allow(ticket).to receive_messages(source_ticket_link: nil) }
+
+            it "setups the link" do
+              expect(remotelink).to receive(:save!).with(expected_link)
+
+              loader.update_source_ticket_remote_link
+            end
+          end
+
+          context "when the link needs to be updated" do
+            let(:needs_update) { true }
+            let(:source_ticket_link) { instance_double(JIRA::Resource::Remotelink) }
+
+            before { allow(ticket).to receive_messages(source_ticket_link: source_ticket_link) }
+
+            it "deletes the previous link and creates a new one" do
+              expect(source_ticket_link).to receive(:delete)
+              expect(remotelink).to receive(:save!).with(expected_link)
+
+              loader.update_source_ticket_remote_link
+            end
+          end
+
+          context "when the link does not need to be updated" do
+            let(:needs_update) { false }
+
+            it "no link creation happens" do
+              expect(remotelink).not_to receive(:save!)
+
+              loader.update_source_ticket_remote_link
+            end
+          end
+        end
+
+        describe "#source_ticket_link_needs_update?" do
+          before do
+            allow(ticket).to receive_messages(source_ticket_link: remote_link)
+          end
+
+          context "when link has yet to be created" do
+            let(:remote_link) { nil }
+
+            it { expect(loader.source_ticket_link_needs_update?).to be_truthy }
+          end
+
+          context "when link already exists" do
+            let(:remote_link) do
+              instance_double(JIRA::Resource::Remotelink,
+                              attrs: source_ticket_link,
+                              inspect: "<JIRA::Resource::Remotelink attrs: #{source_ticket_link}>")
+            end
+
+            context "when the link is not up to date" do
+              let(:source_ticket_link) { build_link(existing_url, existing_title) }
+
+              context "when url has changed" do
+                let(:existing_url) { "https://__OLD_URL__/to/source/ticket/1234" }
+                let(:existing_title) { "Source Ticket 123" }
+
+                it { expect(loader.source_ticket_link_needs_update?).to be_truthy }
+              end
+
+              context "when title has changed" do
+                let(:existing_url) { "https://url/to/source/ticket/123" }
+                let(:existing_title) { "__OLD TITLE__Source Ticket 1234" }
+
+                it { expect(loader.source_ticket_link_needs_update?).to be_truthy }
+              end
+            end
+
+            context "when the link is up to date" do
+              let(:existing_url) { "https://url/to/source/ticket/123" }
+              let(:existing_title) { "Source Ticket 123" }
+              let(:source_ticket_link) do
+                { "object" => {
+                    "url" => "https://url/to/source/ticket/123",
+                    "title" => "Source Ticket 123",
+                    "icon" => { "title" => "link", "url16x16" => "https://url/to/source/ticket/123/icon" }
+                  },
+                  "application" => { "name" => "Ticket Source" },
+                  "extra_attributes" =>
+                    { "id" => 10_443, "self" => "https://url/to/source/ticket/123/remotelink/10443" } }
+              end
+
+              it("only checks the needed attributes") { expect(loader.source_ticket_link_needs_update?).to be_falsey }
+            end
+          end
+        end
+        # rubocop:enable Metrics/BlockLength
+
+        describe "#transition_ticket_to_the_expected_status" do
+          let(:loader) { described_class.send(:new, jira_project, row) }
+          let(:row) { { id: "123", status: "Testing" } }
+
+          let(:ticket) { double(Ticket) }
 
-          loader.transition_ticket_to_the_expected_status
+          it do
+            expect(loader).to receive(:ticket).at_least(:once).and_return(ticket)
+            expect(ticket).to receive(:transition_to).with("Testing")
+
+            loader.transition_ticket_to_the_expected_status
+          end
         end
       end
     end
+    # rubocop:enable Metrics/ClassLength
   end
-
-  # rubocop:enable Metrics/ClassLength
 end

data/spec/ticket/replicator/row_transformer_spec.rb

@@ -33,11 +33,11 @@ RSpec.describe Ticket::Replicator::RowTransformer do
       allow(transformer).to receive(:transformed_status).and_return("Open")
       allow(transformer).to receive(:transformed_resolution).and_return("")
       allow(transformer).to receive(:transformed_priority).and_return("Low")
-      allow(transformer).to receive(:transformed_team).and_return("Transformed Team")
       allow(transformer).to receive(:transformed_summary).and_return("transformed summary (123)")
+      allow(transformer).to receive(:transformed_source_ticket_url).and_return("url/to/source/ticket/123")
 
       expect(transformer.run)
-        .to eq(["123", "Open", "", "Low", "Transformed Team", "transformed summary (123)"])
+        .to eq(["123", "Open", "", "Low", "transformed summary (123)", "url/to/source/ticket/123"])
     end
   end
 
@@ -84,6 +84,46 @@ RSpec.describe Ticket::Replicator::RowTransformer do
     end
   end
 
+  describe "#ticket_replicator_source_ticket_url" do
+    let(:extracted_row) { {} }
+
+    context "when the source ticket url is set in the environment" do
+      before do
+        allow(ENV)
+          .to receive(:fetch).with("TICKET_REPLICATOR_SOURCE_TICKET_URL").and_return("url/to/source/ticket")
+      end
+
+      it { expect(transformer.ticket_replicator_source_ticket_url).to eq("url/to/source/ticket") }
+    end
+
+    context "when the source ticket url is not set in the environment" do
+      it do
+        expect { transformer.ticket_replicator_source_ticket_url }
+          .to raise_error("TICKET_REPLICATOR_SOURCE_TICKET_URL: not set in environment!")
+      end
+    end
+  end
+
+  describe "#source_ticket_url_builder" do
+    let(:extracted_row) { {} }
+
+    before do
+      allow(transformer).to receive_messages(ticket_replicator_source_ticket_url: ticket_replicator_source_ticket_url)
+    end
+
+    context "when the URL has no syntax error" do
+      let(:ticket_replicator_source_ticket_url) { "http://url/to/source/ticket/<%= source_ticket_id %>" }
+
+      it { expect(transformer.source_ticket_url_builder("123")).to eq("http://url/to/source/ticket/123") }
+    end
+
+    context "when the URL has a syntax error" do
+      let(:ticket_replicator_source_ticket_url) { "http://url/to/source/ticket/<%= missing_variable %>" }
+
+      it { expect { transformer.source_ticket_url_builder("123") }.to raise_error(StandardError) }
+    end
+  end
+
   describe "using mappings" do
     before { allow(transformer).to receive_messages(mappings: mappings) }
 
@@ -92,7 +132,7 @@ RSpec.describe Ticket::Replicator::RowTransformer do
         {
           "field_mapping" => {
             "id" => "Defect", "priority" => "Defect Priority", "resolution" => "Defect (2)",
-            "status" => "Defect status", "summary" => "Defect (2)", "team" => "Defect Team (2)"
+            "status" => "Defect status", "summary" => "Defect (2)"
           }
         }
       end
@@ -107,7 +147,7 @@ RSpec.describe Ticket::Replicator::RowTransformer do
       it do
         expect(transformer.remapped_field_extracted_row)
           .to eq({ "id" => "123", "priority" => "High", "resolution" => "a summary",
-                   "status" => "Open", "summary" => "a summary", "team" => "system team" })
+                   "status" => "Open", "summary" => "a summary" })
       end
     end
 
@@ -126,6 +166,21 @@ RSpec.describe Ticket::Replicator::RowTransformer do
         end
       end
 
+      describe "#transformed_source_ticket_url" do
+        let(:remapped_field_extracted_row) { { "id" => "123" } }
+        let(:mappings) { {} }
+
+        before do
+          allow(transformer)
+            .to receive_messages(transformed_id: "123",
+                                 ticket_replicator_source_ticket_url: "url/to/source/ticket/<%= source_ticket_id %>")
+        end
+
+        it "returns the source ticket url" do
+          expect(transformer.transformed_source_ticket_url).to eq("url/to/source/ticket/123")
+        end
+      end
+
       describe "#transformed_summary" do
         let(:remapped_field_extracted_row) { { "id" => "426", "summary" => "a summary" } }
         let(:mappings) { {} }
@@ -155,7 +210,19 @@ RSpec.describe Ticket::Replicator::RowTransformer do
           it { expect(transformed_value).to eq(an_original_value) }
         end
 
-        context "when the status is unexpected" do
+        context "when defaulting to unset value" do
+          let(:mappings) { { "#{field_name}_mapping" => { "defaults_to" => "unset_value" } } }
+
+          it { expect(transformed_value).to eq(nil) }
+        end
+
+        context "when defaulting to blank value" do
+          let(:mappings) { { "#{field_name}_mapping" => { "defaults_to" => "blank_value" } } }
+
+          it { expect(transformed_value).to eq("") }
+        end
+
+        context "when the value is unexpected" do
           let(:mappings) do
             { "#{field_name}_mapping" => { "extracted value" => "transformed value" } }
           end

data/spec/ticket/replicator/ticket_spec.rb

@@ -136,7 +136,6 @@ module Ticket
       let(:jira_auto_tool) { instance_double(Jira::Auto::Tool) }
       let(:jira_client) { instance_double(JIRA::Client, Field: field_navigator) }
 
-      #  let(:jira_ticket) { OpenStruct.new(jira_ticket_properties_hash["fields"]) }
       let(:jira_ticket) { JIRA::Resource::Issue.build(jira_client, jira_ticket_properties_hash) }
 
       let(:ticket) { described_class.new(jira_auto_tool, jira_ticket) }
@@ -149,6 +148,56 @@ module Ticket
         it { expect(ticket.summary).to eq("SMAN-16384 | Login page randomly fails to load CSS assets (10001)") }
       end
 
+      def build_ticket_link(url, title, application = Ticket::SOURCE_TICKET_REMOTE_LINK_APPLICATION)
+        double(JIRA::Resource::Remotelink, attrs: RowLoader.build_ticket_link_attributes(url, title, application))
+      end
+
+      describe "#source_ticket_link" do
+        let(:ticket_links) { [double(JIRA::Resource::Remotelink, attrs: {}), source_ticket_jira_link].compact }
+
+        before { allow(jira_ticket).to receive_messages(remotelink: double(all: ticket_links)) }
+
+        let(:source_ticket_jira_link) { build_ticket_link("https://ur/to/source/ticket/16384", "Source Ticket 16384") }
+
+        it { expect(ticket.source_ticket_link).to eq(source_ticket_jira_link) }
+
+        context "when no source ticket is linked" do
+          let(:source_ticket_jira_link) { nil }
+          it { expect(ticket.source_ticket_link).to be_nil }
+        end
+
+        context "when the existing remote link is not a ticket source link (no application specified)" do
+          let(:source_ticket_jira_link) do
+            build_ticket_link("https://ur/to/source/ticket/16384", "Source Ticket 16384", nil)
+          end
+
+          it { expect(ticket.source_ticket_link).to be_nil }
+        end
+
+        context "when the existing remote link is not a ticket source link (another application specified)" do
+          let(:source_ticket_jira_link) do
+            build_ticket_link("https://ur/to/source/ticket/16384", "Source Ticket 16384", "Another application")
+          end
+
+          it { expect(ticket.source_ticket_link).to be_nil }
+        end
+      end
+
+      describe "#source_ticket_url" do
+        before do
+          allow(ticket).to receive_messages(source_ticket_link: source_ticket_jira_link)
+        end
+
+        let(:source_ticket_jira_link) { build_ticket_link("https://ur/to/source/ticket/16384", "Source Ticket 16384") }
+
+        it { expect(ticket.source_ticket_url).to eq("https://ur/to/source/ticket/16384") }
+
+        context "when no source ticket is linked" do
+          let(:source_ticket_jira_link) { nil }
+          it { expect(ticket.source_ticket_url).to be_nil }
+        end
+      end
+
       describe "replicated?" do
         let(:ticket) { described_class.new(jira_auto_tool, jira_ticket) }
         let(:jira_ticket) { double(JIRA::Resource::Issue, summary: actual_summary) }
@@ -238,7 +287,28 @@ module Ticket
           ticket.transition_to("Testing")
         end
       end
+
+      describe "#sanitize" do
+        let(:expectations) do
+          [
+            ["value as name attribute", double(name: "value as name attribute")],
+            ["value as value attribute", double(value: "value as value attribute")],
+            ["value from name entry in hash", { "name" => "value from name entry in hash" }],
+            ["value from value entry in hash", { "value" => "value from value entry in hash" }],
+            ["value as a string", "value as a string"],
+            ["125", 125],
+            ["object as a string", double(to_s: "object as a string")],
+            ["", nil]
+          ]
+        end
+
+        it do
+          expectations.each do |expected_sanitized_value, value|
+            expect(ticket.send(:sanitize, value)).to eq(expected_sanitized_value)
+          end
+        end
+      end
     end
   end
-  # rubocop:enable Metrics/ClassLength
 end
+# rubocop:enable Metrics/ClassLength

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ticket-replicator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Christophe Broult