ticket-replicator 1.2.1 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4908df60d4dab3d25cd2e90eeb384b39ab9bb979e8f9b37a8f2c42cc2f55504d
-  data.tar.gz: dfbc162f181e5430b18b9415065cb6fc88d1ae995b4371eb9dbe4b01cb2d304b
+  metadata.gz: f526835796d74716dc38bff10d6be52892b547ad78c089b8a7e77e5fc080ffde
+  data.tar.gz: 0f004dbeda462964f94aa14f8ddaf51edca62dc1ac73d3f1fb89fab209e3a5d7
 SHA512:
-  metadata.gz: b304fa83d1ad816f78e6471ccd0213c4fa85a0bc8a3439536dd272a222c60fc0aaf3585f05454905850e6a9517caf0335a7f5eea59c10a007896a3bdbdf2cfca
-  data.tar.gz: 56023fe34b940b1d3e1be046edbae4d6912815a87a69f2d965110eb94a827388d5483443fe4f0fe8e24e067e534f6630e43f063a19e48b0efed3384074b68aff
+  metadata.gz: 34c1f9ad5dd0f245d72f483c507515c44055f2489039320667ad5430aeea3a58585b2be0e2c4075eebccc98ee2924495bf07afa1f78c94463d27c14566eba58f
+  data.tar.gz: dcd4d81a0ce4361f906e4fe921421035987db61693ed224fbbcf14bd2d3d6e8f3eaa534d1b90c26f2f8d1958af34050ddfd4dffb947021f1c51652c73e8ac705

data/README.md

@@ -52,6 +52,8 @@ Optional environment variables:
 - `JAT_RATE_INTERVAL_IN_SECONDS` - Interval for rate limiting in seconds (e.g., "1").
 - `JAT_RATE_LIMIT_PER_INTERVAL` - Rate limit per interval for Jira API calls (e.g., "1")
 - `TICKET_REPLICATOR_DISABLE_RESOLUTION_LOADING` - To deal with tickets not having a resolution field.
+- `TICKET_REPLICATOR_ONLY_UPDATE_LINKS_FOR_MODIFIED_TICKETS` - Limit the amount of requests
+to modified tickets only (default to "true" when unset). Set to "false" to disable this feature.
 
 ### Setup Queue Folder And Field Mapping
 

data/features/load_tickets_in_jira.feature

@@ -42,7 +42,7 @@ Feature: Load tickets into Jira
     Given the following environment variables have been set:
       | name                                         | value |
       | TICKET_REPLICATOR_DISABLE_RESOLUTION_LOADING | true  |
-    Given a file named "queue/20.transformed/sap_solution_manager_defects.csv" with:
+    And a file named "queue/20.transformed/sap_solution_manager_defects.csv" with:
       """
       "ID","Status","Resolution","Priority","Summary","Source Ticket URL"
       "10001","Open","","Highest","SMAN-10001 | Login page randomly fails to load CSS assets (10001)","http://url/to/source/ticket/10001"
@@ -56,6 +56,23 @@ Feature: Load tickets into Jira
       | Confirmed |            | Medium   | SMAN-10003 \| Invalid date format in SOAP response (10003)         | http://url/to/source/ticket/10003 |
       | Withdrawn |            | Low      | SMAN-10007 \| Test data missing edge case scenarios (10007)        | http://url/to/source/ticket/10007 |
 
+  Scenario: No duplicates created when the same ticket is listed several times in a given file
+    Given a file named "queue/20.transformed/sap_solution_manager_defects.csv" with:
+      """
+      "ID","Status","Resolution","Priority","Summary","Source Ticket URL"
+      "10001","Open","","Highest","SMAN-10001 | Login page randomly fails to load CSS assets (10001)","http://url/to/source/ticket/10001"
+      "10001","Open","","Highest","SMAN-10001 | Login page randomly fails to load CSS assets (10001)","http://url/to/source/ticket/10001"
+      "10003","Open","","Medium","SMAN-10003 | Invalid date format in SOAP response (10003)","http://url/to/source/ticket/10003"
+      "10007","Withdrawn","Won't Do","Low","SMAN-10007 | Test data missing edge case scenarios (10007)","http://url/to/source/ticket/10007"
+      "10003","Confirmed","Done","Medium","SMAN-10003 | Invalid date format in SOAP response (10003)","http://url/to/source/ticket/10003"
+      """
+    When I successfully run `ticket-replicator --load`
+    Then the Jira project should only have the following tickets:
+      | status    | resolution | priority | summary                                                            | source_ticket_url                 |
+      | Open      |            | Highest  | SMAN-10001 \| Login page randomly fails to load CSS assets (10001) | http://url/to/source/ticket/10001 |
+      | Confirmed | Done       | Medium   | SMAN-10003 \| Invalid date format in SOAP response (10003)         | http://url/to/source/ticket/10003 |
+      | Withdrawn | Won't Do   | Low      | SMAN-10007 \| Test data missing edge case scenarios (10007)        | http://url/to/source/ticket/10007 |
+
 
   Scenario: Loading the ticket information twice in Jira does not create additional tickets
     Given a file named "queue/20.transformed/sap_solution_manager_defects.csv" with:
@@ -95,12 +112,37 @@ Feature: Load tickets into Jira
       """
     And I successfully run `ticket-replicator --jira-http-debug --load`
     Then the Jira project should only have the following tickets:
-      | example purpose                                                                 | status     | resolution | priority | summary                                                                     | source_ticket_url                 |
-      | one update due to status change                                                 | Closed     |            | Highest  | SMAN-10001 \| Login page randomly fails to load CSS assets (10001)          | http://url/to/source/ticket/10001 |
-      | one update due to priority, resolution and summary updates                      | In Process |            | High     | SMAN-10002 \| *Recurring* database deadlock during order processing (10002) | http://url/to/source/ticket/10002 |
-      | three updates due to new ticket created (fields, source ticket link and status) | Open       |            | Highest  | SMAN-10008 \| Memory leak in caching implementation (10008)                 | http://url/to/source/ticket/10008 |
-      | no update since no status or field change                                       | Confirmed  | Done       | High     | SMAN-10016 \| Slow response time on product search API (10016)              | http://url/to/source/ticket/10016 |
-    And only 5 Jira update requests were emitted
+      | example purpose                                                                                  | status     | resolution | priority | summary                                                                     | source_ticket_url                 |
+      | one update due to status change                                                                  | Closed     |            | Highest  | SMAN-10001 \| Login page randomly fails to load CSS assets (10001)          | http://url/to/source/ticket/10001 |
+      | two updates due to field updated (priority, resolution and summary) and updating the remote link | In Process |            | High     | SMAN-10002 \| *Recurring* database deadlock during order processing (10002) | http://url/to/source/ticket/10002 |
+      | three updates due to new ticket created (fields, source ticket link and status)                  | Open       |            | Highest  | SMAN-10008 \| Memory leak in caching implementation (10008)                 | http://url/to/source/ticket/10008 |
+      | no update since no status or field change                                                        | Confirmed  | Done       | High     | SMAN-10016 \| Slow response time on product search API (10016)              | http://url/to/source/ticket/10016 |
+    And only 6 Jira update requests were emitted
+
+  Scenario: Updating fields and statuses of closed and withdrawn tickets is possible
+    Given a file named "queue/20.transformed/10.initial_replication.csv" with:
+      """
+      "ID","Status","Resolution","Priority","Summary","Source Ticket URL"
+      "10001","Closed","","Highest","SMAN-10001 | Possible to update summary and resolution of closed ticket (100001)","http://url/to/source/ticket/10001"
+      "10002","Closed","","Low","SMAN-10002 | Reopening ticket while updating priority  (10002)","http://url/to/source/ticket/10002"
+      "10003","Withdrawn","Won't Do","Medium","SMAN-10003 | Possible to update a resolved ticket (10003)","http://url/to/source/ticket/10003"
+      "10004","Withdrawn","Done","Low","SMAN-10004 | Re-opening resolved ticket (10004)","http://url/to/source/ticket/10004"
+      """
+    And a file named "queue/20.transformed/20.update_replication.csv" with:
+      """
+      "ID","Status","Resolution","Priority","Summary","Source Ticket URL"
+      "10001","Closed","Done","Highest","SMAN-10001 | Successfully updated summary and resolution of the closed ticket (100001)","http://url/to/source/ticket/10001"
+      "10002","Open","","Highest","SMAN-10002 | Successfully reopened ticket while its updating priority and summary (10002)","http://url/to/source/ticket/10002"
+      "10003","Withdrawn","Done","High","SMAN-10003 | Successfully updated resolved ticket (10003)","http://url/to/source/ticket/10003"
+      "10004","Open","","Low","SMAN-10004 | Successfully re-opened and updated the ticket (10004)","http://url/to/source/ticket/10004"
+      """
+    When I successfully run `ticket-replicator --load`
+    Then the Jira project should only have the following tickets:
+      | status    | resolution | priority | summary                                                                                    | source_ticket_url                 |
+      | Closed    | Done       | Highest  | SMAN-10001 \| Successfully updated summary and resolution of the closed ticket (100001)    | http://url/to/source/ticket/10001 |
+      | Open      |            | Highest  | SMAN-10002 \| Successfully reopened ticket while its updating priority and summary (10002) | http://url/to/source/ticket/10002 |
+      | Withdrawn | Done       | High     | SMAN-10003 \| Successfully updated resolved ticket (10003)                                 | http://url/to/source/ticket/10003 |
+      | Open      |            | Low      | SMAN-10004 \| Successfully re-opened and updated the ticket (10004)                        | http://url/to/source/ticket/10004 |
 
   Scenario: Attempting to set an unexpected status generates information about the current row being loaded
     Given a file named "queue/20.transformed/sap_solution_manager_defects.csv" with:
@@ -120,7 +162,7 @@ Feature: Load tickets into Jira
     Then it should fail with:
       """
       ERROR  Object : Ticket::Replicator::FileLoader::LoadError: queue/20.transformed/sap_solution_manager_defects.csv:5: error while loading row:
-      No transition found for "____ INEXISTING STATUS ____" in ["No Error -> No Error", "Tester Action -> Tester Action", "Close Bug -> Closed", "Confirmed -> Confirmed", "Defect Correction in Process -> Defect Correction in Process", "Deferred -> Deferred", "Forwarded -> Forwarded", "Information Required -> Information Required", "New -> New", "Open -> Open", "Solution Proposal -> Solution Proposal", "Wait for Defect Correction -> Wait for Defect Correction", "Wait on External -> Wait on External", "Withdrawn -> Withdrawn", "In Process -> In Process"].:
+      No transition found for "____ INEXISTING STATUS ____" in ["No Error => No Error", "Tester Action => Tester Action", "Close Bug => Closed", "Confirmed => Confirmed", "Defect Correction in Process => Defect Correction in Process", "Deferred => Deferred", "Forwarded => Forwarded", "Information Required => Information Required", "New => New", "Open => Open", "Solution Proposal => Solution Proposal", "Wait for Defect Correction => Wait for Defect Correction", "Wait on External => Wait on External", "Withdrawn => Withdrawn", "In Process => In Process"].:
       #<CSV::Row id:"10004" status:"____ INEXISTING STATUS ____" resolution:"Done" priority:"Low" summary:"SMAN-10004 | App crashes when offline on Android 12 (10004)" source_ticket_url:"http://url/to/source/ticket/10004">
       """
 

data/features/transform_and_load_extracted_ticket_queue.feature

@@ -9,7 +9,7 @@ Feature: Transform and load extracted ticket queue
       | TICKET_REPLICATOR_JIRA_PROJECT_KEY      |
       | TICKET_REPLICATOR_JIRA_TICKET_TYPE_NAME |
     And the following environment variables have been set:
-      | name                                | value                                        |
+      | name                                | value                                               |
       | TICKET_REPLICATOR_SOURCE_TICKET_URL | http://url/to/source/ticket/<%= source_ticket_id %> |
 
     And a file named "config/ticket-replicator.mappings.yml" with:

data/lib/ticket/replicator/file_loader.rb

@@ -34,7 +34,7 @@ module Ticket
             #{row.inspect}
           EOERROR
 
-          raise LoadError, message
+          raise LoadError, message, e.backtrace
         end
       end
 

data/lib/ticket/replicator/file_transformer.rb

@@ -40,17 +40,23 @@ module Ticket
         end
       end
 
+      private
+
       def extracted_rows
         raise NotImplementedError, "You must implement this method in your subclass"
       end
 
+      def mappings
+        @mappings ||= Mappings.new
+      end
+
       FIRST_EXTRACTED_DATA_ROW_LINE_NUMBER = 2
       private_constant :FIRST_EXTRACTED_DATA_ROW_LINE_NUMBER
 
       def transformed_rows
         row_index = FIRST_EXTRACTED_DATA_ROW_LINE_NUMBER
         extracted_rows.collect do |row|
-          RowTransformer.run_on(row)
+          RowTransformer.run_on(row, mappings)
         rescue StandardError => e
           raise TransformError, <<~EOERRORMSG
             #{extracted_path}:#{row_index}: error while transforming row:

data/lib/ticket/replicator/mappings.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Ticket
+  class Replicator
+    class Mappings
+      def self.file_path
+        File.join("config", "ticket-replicator.mappings.yml")
+      end
+
+      def to_h
+        @to_h = YAML.safe_load_file(self.class.file_path, symbolize_names: false)
+      end
+    end
+  end
+end

data/lib/ticket/replicator/row_loader.rb

@@ -38,9 +38,15 @@ module Ticket
       def save_ticket
         return unless ticket_fields_need_to_be_updated?
 
+        reopen_ticket_if_status_in_done_category
+
         ticket.jira_ticket.save!(attributes_for_save)
 
         ticket.jira_ticket.fetch
+
+        @ticket_was_just_updated = true
+
+        jira_project.replicated_tickets[id] = ticket
       end
 
       private
@@ -76,6 +82,12 @@ module Ticket
         nil
       end
 
+      def reopen_ticket_if_status_in_done_category
+        return unless ticket_previously_replicated? && ticket.status_in_done_category?
+
+        ticket.transition_to_not_done
+      end
+
       def ticket_fields_need_to_be_updated?
         !ticket_previously_replicated? || ticket_fields_changed?
       end
@@ -98,6 +110,8 @@ module Ticket
 
       # rubocop:disable Metrics/MethodLength
       def source_ticket_link_needs_update?
+        return ticket_was_just_updated? if only_update_links_for_modified_ticket?
+
         existing_ticket_link_attributes = ticket.source_ticket_link&.attrs
 
         object = existing_ticket_link_attributes&.[]("object")
@@ -118,6 +132,10 @@ module Ticket
         filtered_existing_ticket_link_attributes != ticket_link_attributes
       end
 
+      def only_update_links_for_modified_ticket?
+        ENV.fetch("TICKET_REPLICATOR_ONLY_UPDATE_LINKS_FOR_MODIFIED_TICKETS", "true") != "false"
+      end
+
       # rubocop:enable Metrics/MethodLength
 
       def source_ticket_link_title
@@ -137,10 +155,15 @@ module Ticket
           if ticket_previously_replicated?
             fetch_ticket
           else
+            @ticket_was_just_updated = true
             create_ticket
           end
       end
 
+      def ticket_was_just_updated?
+        @ticket_was_just_updated
+      end
+
       def fetch_ticket
         jira_project.replicated_tickets.fetch(id)
       end

data/lib/ticket/replicator/row_transformer.rb

@@ -2,21 +2,23 @@
 
 require "ticket/replicator/replicated_summary"
 require "ticket/replicator/file_transformer"
+require "ticket/replicator/mappings"
 require "erb"
 
 module Ticket
   class Replicator
     class RowTransformer
-      def self.run_on(extracted_row)
-        new(extracted_row).run
+      def self.run_on(extracted_row, mappings)
+        new(extracted_row, mappings).run
       end
 
       private_class_method :new
 
-      attr_reader :extracted_row
+      attr_reader :extracted_row, :mappings
 
-      def initialize(extracted_row)
+      def initialize(extracted_row, mappings)
         @extracted_row = extracted_row
+        @mappings = mappings.to_h
       end
 
       def run
@@ -115,10 +117,6 @@ module Ticket
         end
       end
 
-      def mappings
-        @mappings ||= YAML.safe_load_file(mapping_file_path, symbolize_names: false)
-      end
-
       def remapped_field_extracted_row
         @remapped_field_extracted_row ||= fields_to_remap.to_h do |field|
           mapped_field_key = remapped_field_key(field)
@@ -142,10 +140,6 @@ module Ticket
         @extracted_field_mapping ||= mapping_for :field
       end
 
-      def self.mapping_file_path
-        File.join("config", "ticket-replicator.mappings.yml")
-      end
-
       private
 
       def extracted_row_value_for(mapped_field_key)

data/lib/ticket/replicator/setup.rb

@@ -35,7 +35,7 @@ module Ticket
       def config_file_path
         @config_file_path ||=
           begin
-            path = RowTransformer.mapping_file_path
+            path = Mappings.file_path
             FileUtils.mkdir_p(File.dirname(path))
             path
           end

data/lib/ticket/replicator/ticket.rb

@@ -21,7 +21,7 @@ module Ticket
       end
 
       def transition_to(status)
-        TicketStatusTransitioner.new(self).transition_to(status)
+        status_transitioner.transition_to(status)
       end
 
       def <=>(other)
@@ -49,8 +49,20 @@ module Ticket
         source_ticket_link_attributes(source_ticket_link)&.[]("object")&.[]("url")
       end
 
+      def status_in_done_category?
+        jira_ticket.status.attrs.fetch("statusCategory").fetch("key") == "done"
+      end
+
+      def transition_to_not_done
+        status_transitioner.transition_to_not_done
+      end
+
       private
 
+      def status_transitioner
+        TicketStatusTransitioner.new(self)
+      end
+
       def source_ticket_link_attributes(link)
         link&.attrs
       end

data/lib/ticket/replicator/ticket_status_transitioner.rb

@@ -2,7 +2,10 @@
 
 module Ticket
   class Replicator
+    # Assumption: The ticket workflow allows for transitioning to any other status.
     class TicketStatusTransitioner
+      StatusTransitionerError = Class.new(StandardError)
+
       attr_reader :ticket
 
       def initialize(ticket)
@@ -21,14 +24,27 @@ module Ticket
                                 http_headers)
       end
 
+      def transition_to_not_done
+        not_done_status =
+          available_transitions.find do |transition|
+            transition.fetch("to").fetch("statusCategory").fetch("key") != "done"
+          end or
+          raise StatusTransitionerError, build_error_message("No non-done transition found")
+
+        transition_to(not_done_status.fetch("to").fetch("name"))
+      end
+
       def transition_payload_for(status)
         transition = available_transitions.find { |transition| transition.fetch("to").fetch("name") == status } or
-          raise "No transition found for #{status.inspect} in " \
-                "#{available_transitions.collect { |t| "#{t["name"]} -> #{t["to"]["name"]}" }.inspect}."
+          raise StatusTransitionerError, build_error_message("No transition found for #{status.inspect}")
 
         { transition: { id: transition["id"] } }.to_json
       end
 
+      def build_error_message(message)
+        message + " in #{available_transitions.collect { |t| "#{t["name"]} => #{t["to"]["name"]}" }.inspect}."
+      end
+
       def available_transitions
         response = tool.jira_client.get(tool.jira_url("/rest/api/2/issue/#{ticket.key}?expand=transitions"))
 

data/lib/ticket/replicator/version.rb

@@ -2,6 +2,6 @@
 
 module Ticket
   class Replicator
-    VERSION = "1.2.1"
+    VERSION = "1.2.3"
   end
 end

data/spec/ticket/replicator/file_transformer_spec.rb

@@ -43,34 +43,34 @@ module Ticket
 
         describe "#transformed_headers" do
           it "returns the headers" do
-            expect(transformer.transformed_headers)
+            expect(transformer.send(:transformed_headers))
               .to eq(%w[ID Status Resolution Priority Summary] + ["Source Ticket URL"])
           end
         end
 
         describe "#transformed_rows" do
           before do
-            allow(transformer).to receive_messages(extracted_rows: %i[a_row another_row])
+            allow(transformer).to receive_messages(extracted_rows: %i[a_row another_row], mappings: :mappings)
           end
 
           it "returns the rows" do
-            allow(RowTransformer).to receive(:run_on).with(:a_row).and_return(:a_tranformed_row)
-            allow(RowTransformer).to receive(:run_on).with(:another_row).and_return(:another_transformed_row)
+            allow(RowTransformer).to receive(:run_on).with(:a_row, :mappings).and_return(:a_tranformed_row)
+            allow(RowTransformer).to receive(:run_on).with(:another_row, :mappings).and_return(:another_transformed_row)
 
-            expect(transformer.transformed_rows).to eq(%i[a_tranformed_row another_transformed_row])
+            expect(transformer.send(:transformed_rows)).to eq(%i[a_tranformed_row another_transformed_row])
           end
 
           context "when a row transformation error occurs" do
             before do
-              allow(RowTransformer).to receive(:run_on).with(:a_row).and_return(:a_tranformed_row)
+              allow(RowTransformer).to receive(:run_on).with(:a_row, :mappings).and_return(:a_tranformed_row)
 
               allow(RowTransformer)
-                .to receive(:run_on).with(:another_row)
+                .to receive(:run_on).with(:another_row, :mappings)
                                     .and_raise(TransformError, "transformation error")
             end
 
             it "raises an error message including the file name and line number of the row that was processed" do
-              expect { transformer.transformed_rows }
+              expect { transformer.send(:transformed_rows) }
                 .to raise_error(TransformError,
                                 /source\.csv:3: error while transforming row:\ntransformation error:\n:another_row\n/)
             end

data/spec/ticket/replicator/mappings_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Ticket
+  class Replicator
+    class Mappings
+      RSpec.describe Mappings do
+        let(:mappings) { described_class.new }
+
+        describe ".file_path" do
+          it { expect(described_class.file_path).to eq("config/ticket-replicator.mappings.yml") }
+        end
+
+        describe "#to_h" do
+          let(:mappings_yaml) do
+            <<~'YAML'
+              field_mapping:
+                id: Defect
+                summary: Defect (2)
+              id_extraction_regex: "\\((?<id>\\d+)\\)$"
+              status_mapping:
+                defaults_to: keep_original_value
+                Open: Open
+                Closed: Closed
+              resolution_mapping:
+                Closed: Done
+                Rejected: Won't Fix
+              team_mapping:
+                Source Team: Transformed Team
+                Front End: Web Team
+              priority_mapping:
+                1 - Critical: Critical
+                2 - High: High
+                3 - Medium: Medium
+                4 - Low: Low
+            YAML
+          end
+
+          let(:file_io) { instance_double(IO) }
+
+          it "loads the mappings from the mappings.yml file" do
+            expect(IO).to receive(:open).with("config/ticket-replicator.mappings.yml",
+                                              "r:bom|utf-8").and_yield(mappings_yaml)
+
+            expect(mappings.to_h)
+              .to eq(
+                "field_mapping" => { "id" => "Defect", "summary" => "Defect (2)" },
+                "id_extraction_regex" => "\\((?<id>\\d+)\\)$",
+                "status_mapping" => { "defaults_to" => "keep_original_value", "Open" => "Open",
+                                      "Closed" => "Closed" },
+                "resolution_mapping" => { "Closed" => "Done", "Rejected" => "Won't Fix" },
+                "team_mapping" => { "Source Team" => "Transformed Team", "Front End" => "Web Team" },
+                "priority_mapping" =>
+                  { "1 - Critical" => "Critical", "2 - High" => "High", "3 - Medium" => "Medium",
+                    "4 - Low" => "Low" }
+              )
+          end
+        end
+      end
+    end
+  end
+end

data/spec/ticket/replicator/row_loader_spec.rb

@@ -149,6 +149,8 @@ module Ticket
             ticket: ticket,
             :ticket_fields_need_to_be_updated? => ticket_fields_need_to_be_updated?
           )
+
+          allow(jira_project).to receive_messages(replicated_tickets: { "456" => :another_ticket })
         end
 
         context "when the previously replicated needs to be updated " do
@@ -156,10 +158,14 @@ module Ticket
 
           it do
             allow(loader).to receive_messages(attributes_for_save: { fields: { a: "b" } })
-            expect(jira_ticket).to receive(:save!).with({ fields: { a: "b" } })
 
+            expect(loader).to receive(:reopen_ticket_if_status_in_done_category)
+            expect(jira_ticket).to receive(:save!).with({ fields: { a: "b" } })
             expect(jira_ticket).to receive(:fetch)
 
+            # TODO: fix this check that should work
+            # expect(loader).to be_ticket_previously_replicated
+
             loader.save_ticket
           end
         end
@@ -176,6 +182,52 @@ module Ticket
         end
       end
 
+      describe "#reopen_ticket_if_status_in_done_category" do
+        let(:loader) { described_class.send(:new, jira_project, double("row", id: "123", status: "Closed")) }
+        let(:ticket) { instance_double(Ticket) }
+
+        before do
+          allow(loader).to receive_messages(ticket: ticket,
+                                            :ticket_previously_replicated? => actual_ticket_previously_replicated)
+        end
+
+        context "when the ticket was not previously replicated" do
+          let(:actual_ticket_previously_replicated) { false }
+
+          it do
+            expect(ticket).not_to receive(:transition_to_not_done)
+
+            loader.send(:reopen_ticket_if_status_in_done_category)
+          end
+        end
+
+        context "when the ticket was previously replicated" do
+          let(:actual_ticket_previously_replicated) { true }
+
+          before { allow(ticket).to receive_messages(status_in_done_category?: actual_status_in_done_category) }
+
+          context "when the ticket is not closed" do
+            let(:actual_status_in_done_category) { false }
+
+            it do
+              expect(ticket).not_to receive(:transition_to_not_done)
+
+              loader.send(:reopen_ticket_if_status_in_done_category)
+            end
+          end
+
+          context "when the ticket is closed" do
+            let(:actual_status_in_done_category) { true }
+
+            it do
+              expect(ticket).to receive(:transition_to_not_done)
+
+              loader.send(:reopen_ticket_if_status_in_done_category)
+            end
+          end
+        end
+      end
+
       describe "#attributes_for_save" do
         let(:loader) { described_class.send(:new, jira_project, row) }
 
@@ -405,6 +457,24 @@ module Ticket
           it { expect(loader.send(:source_ticket_link_title)).to eq("Source Ticket 123") }
         end
 
+        describe "#only_update_links_for_modified_ticket?" do
+          it "defaults to true when unset" do
+            expect(ENV)
+              .to receive(:fetch).with("TICKET_REPLICATOR_ONLY_UPDATE_LINKS_FOR_MODIFIED_TICKETS",
+                                       "true").and_return("true")
+
+            expect(loader.send(:only_update_links_for_modified_ticket?)).to be_truthy
+          end
+
+          it "when TICKET_REPLICATOR_ONLY_UPDATE_LINKS_FOR_MODIFIED_TICKETS set to false" do
+            expect(ENV)
+              .to receive(:fetch).with("TICKET_REPLICATOR_ONLY_UPDATE_LINKS_FOR_MODIFIED_TICKETS", "true")
+                                 .and_return("false")
+
+            expect(loader.send(:only_update_links_for_modified_ticket?)).to be_falsey
+          end
+        end
+
         describe "#update_source_ticket_remote_link" do
           before do
             allow(loader).to receive_messages(source_ticket_link_needs_update?: needs_update)
@@ -449,57 +519,87 @@ module Ticket
 
         describe "#source_ticket_link_needs_update?" do
           before do
-            allow(ticket).to receive_messages(source_ticket_link: remote_link)
+            allow(loader).to receive_messages(only_update_links_for_modified_ticket?: only_update_links_for_new_ticket)
           end
 
-          context "when link has yet to be created" do
-            let(:remote_link) { nil }
+          context "when only for modified tickets" do
+            let(:only_update_links_for_new_ticket) { true }
+
+            before { allow(loader).to receive_messages(ticket_was_just_updated?: actual_was_updated) }
+
+            context "when the ticket has already been replicated (i.e., exists)" do
+              let(:actual_was_updated) { false }
+
+              it "does not request the remote link information" do
+                expect(ticket).not_to receive(:source_ticket_link)
 
-            it { expect(loader.send(:source_ticket_link_needs_update?)).to be_truthy }
+                expect(loader.send(:source_ticket_link_needs_update?)).to be_falsey
+              end
+            end
+
+            context "when the ticket is new" do
+              let(:actual_was_updated) { true }
+
+              it { expect(loader.send(:source_ticket_link_needs_update?)).to be_truthy }
+            end
           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}>")
+          context "when not only for new tickets" do
+            let(:only_update_links_for_new_ticket) { false }
+
+            before do
+              allow(ticket).to receive_messages(source_ticket_link: remote_link)
             end
 
-            context "when the link is not up to date" do
-              let(:source_ticket_link) { build_link(existing_url, existing_title) }
+            context "when link has yet to be created" do
+              let(:remote_link) { nil }
 
-              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.send(:source_ticket_link_needs_update?)).to be_truthy }
+            end
 
-                it { expect(loader.send(:source_ticket_link_needs_update?)).to be_truthy }
+            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 title has changed" do
-                let(:existing_url) { "https://url/to/source/ticket/123" }
-                let(:existing_title) { "__OLD TITLE__Source Ticket 1234" }
+              context "when the link is not up to date" do
+                let(:source_ticket_link) { build_link(existing_url, existing_title) }
 
-                it { expect(loader.send(:source_ticket_link_needs_update?)).to be_truthy }
-              end
-            end
+                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.send(:source_ticket_link_needs_update?)).to be_truthy }
+                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" } }
+                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.send(:source_ticket_link_needs_update?)).to be_truthy }
+                end
               end
 
-              it("only checks the needed attributes") {
-                expect(loader.send(:source_ticket_link_needs_update?)).to be_falsey
-              }
+              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.send(:source_ticket_link_needs_update?)).to be_falsey
+                }
+              end
             end
           end
         end
@@ -519,6 +619,44 @@ module Ticket
           end
         end
       end
+
+      describe "#ticket_was_just_updated?" do
+        let(:loader) { described_class.send(:new, jira_project, { id: 789 }) }
+
+        context "when the ticket was just created" do
+          it do
+            allow(loader).to receive_messages(ticket_previously_replicated?: false)
+            allow(loader).to receive_messages(create_ticket: nil)
+
+            loader.send(:ticket)
+
+            expect(loader.send(:ticket_was_just_updated?)).to be_truthy
+          end
+        end
+
+        context "when the ticket had modified fields" do
+          let(:jira_ticket) { double(JIRA::Resource::Issue, save!: nil, fetch: nil) }
+          let(:ticket) { instance_double(Ticket, jira_ticket: jira_ticket) }
+
+          it do
+            allow(loader)
+              .to receive_messages(ticket_fields_need_to_be_updated?: true,
+                                   reopen_ticket_if_status_in_done_category: nil,
+                                   ticket: ticket,
+                                   attributes_for_save: {})
+
+            allow(jira_project).to receive_messages(replicated_tickets: { "789" => "a_ticket" })
+
+            loader.send(:save_ticket)
+
+            expect(loader.send(:ticket_was_just_updated?)).to be_truthy
+          end
+        end
+
+        context "when the ticket was not new or had modified fields" do
+          it { expect(loader.send(:ticket_was_just_updated?)).to be_falsey }
+        end
+      end
     end
     # rubocop:enable Metrics/ClassLength
   end

data/spec/ticket/replicator/row_transformer_spec.rb

@@ -7,17 +7,18 @@ module Ticket
     # rubocop:disable Metrics/ClassLength
     class RowTransformer
       RSpec.describe RowTransformer do
-        let(:transformer) { described_class.send(:new, extracted_row) }
+        let(:transformer) { described_class.send(:new, extracted_row, mappings) }
+        let(:mappings) { instance_double(Mappings, to_h: {}) }
 
         describe ".run_on" do
           let(:extracted_row) { :a_row_to_transform }
 
           it "transforms the given file" do
-            expect(described_class).to receive(:new).with(:a_row_to_transform).and_return(transformer)
+            expect(described_class).to receive(:new).with(:a_row_to_transform, mappings).and_return(transformer)
 
             expect(transformer).to receive(:run)
 
-            described_class.run_on(:a_row_to_transform)
+            described_class.run_on(:a_row_to_transform, mappings)
           end
         end
 
@@ -46,50 +47,13 @@ module Ticket
         end
 
         describe "#mappings" do
-          let(:mappings_yaml) do
-            <<~'YAML'
-              field_mapping:
-                id: Defect
-                summary: Defect (2)
-              id_extraction_regex: "\\((?<id>\\d+)\\)$"
-              status_mapping:
-                defaults_to: keep_original_value
-                Open: Open
-                Closed: Closed
-              resolution_mapping:
-                Closed: Done
-                Rejected: Won't Fix
-              team_mapping:
-                Source Team: Transformed Team
-                Front End: Web Team
-              priority_mapping:
-                1 - Critical: Critical
-                2 - High: High
-                3 - Medium: Medium
-                4 - Low: Low
-            YAML
-          end
-
           let(:extracted_row) { {} }
+          let(:mappings) { instance_double(Mappings, to_h: { "field_mapping" => {} }) }
+
+          it "uses the mapping object" do
+            RowTransformer.send(:new, extracted_row, mappings)
 
-          let(:file_io) { instance_double(IO) }
-
-          it "loads the mappings from the mappings.yml file" do
-            expect(IO).to receive(:open).with("config/ticket-replicator.mappings.yml",
-                                              "r:bom|utf-8").and_yield(mappings_yaml)
-
-            expect(transformer.mappings)
-              .to eq(
-                "field_mapping" => { "id" => "Defect", "summary" => "Defect (2)" },
-                "id_extraction_regex" => "\\((?<id>\\d+)\\)$",
-                "status_mapping" => { "defaults_to" => "keep_original_value", "Open" => "Open",
-                                      "Closed" => "Closed" },
-                "resolution_mapping" => { "Closed" => "Done", "Rejected" => "Won't Fix" },
-                "team_mapping" => { "Source Team" => "Transformed Team", "Front End" => "Web Team" },
-                "priority_mapping" =>
-                  { "1 - Critical" => "Critical", "2 - High" => "High", "3 - Medium" => "Medium",
-                    "4 - Low" => "Low" }
-              )
+            expect(transformer.mappings).to eq({ "field_mapping" => {} })
           end
         end
 

data/spec/ticket/replicator/ticket_spec.rb

@@ -217,6 +217,28 @@ module Ticket
         it { expect(ticket.status).to eq("To Do") }
       end
 
+      describe "#status_in_done_category?" do
+        let(:jira_ticket) do
+          double(JIRA::Resource::Issue, status: actual_status)
+        end
+
+        let(:actual_status) do
+          double(JIRA::Resource::Status, attrs: { "name" => "A status", "statusCategory" => actual_status_category })
+        end
+
+        context "when status is in done category" do
+          let(:actual_status_category) { { "key" => "done", "name" => "Done" } }
+
+          it { expect(ticket.status_in_done_category?).to be_truthy }
+        end
+
+        context "when status is not in done category" do
+          let(:actual_status_category) { { "key" => "new", "name" => "To Do" } }
+
+          it { expect(ticket.status_in_done_category?).to be_falsy }
+        end
+      end
+
       describe "#resolution" do
         it { expect(ticket.resolution).to eq("") }
       end
@@ -280,7 +302,8 @@ module Ticket
 
       describe "#transition_to" do
         let(:transitioner) { instance_double(TicketStatusTransitioner) }
-        it do
+
+        it "uses a status transitioner" do
           expect(TicketStatusTransitioner).to receive(:new).with(ticket).and_return(transitioner)
           expect(transitioner).to receive(:transition_to).with("Testing")
 
@@ -288,6 +311,17 @@ module Ticket
         end
       end
 
+      describe "#transition_to_not_done" do
+        let(:transitioner) { instance_double(TicketStatusTransitioner) }
+
+        it "uses a status transitioner" do
+          expect(TicketStatusTransitioner).to receive(:new).with(ticket).and_return(transitioner)
+          expect(transitioner).to receive(:transition_to_not_done)
+
+          ticket.transition_to_not_done
+        end
+      end
+
       describe "#sanitize" do
         let(:expectations) do
           [
@@ -311,4 +345,5 @@ module Ticket
     end
   end
 end
+
 # rubocop:enable Metrics/ClassLength

data/spec/ticket/replicator/ticket_status_transitioner_spec.rb

@@ -6,7 +6,7 @@ require "ticket/replicator/ticket_status_transitioner"
 module Ticket
   class Replicator
     RSpec.describe TicketStatusTransitioner do
-      let(:transitioner) { described_class.send(:new, ticket) }
+      let(:transitioner) { described_class.new(ticket) }
 
       let(:ticket) do
         double(Ticket, key: "PROJKEY-16", status: "Todo", jira_auto_tool: jira_auto_tool, jira_client: jira_client)
@@ -15,7 +15,7 @@ module Ticket
       let(:jira_auto_tool) { instance_double(Jira::Auto::Tool, jira_client: jira_client) }
       let(:jira_client) { instance_double(JIRA::Client) }
 
-      describe "#transistion_to" do
+      describe "#transition_to" do
         let(:expected_payload) { { transition: { id: 131 } }.to_json }
         let(:expected_headers) { { "Content-Type" => "application/json" } }
 
@@ -48,6 +48,53 @@ module Ticket
         end
       end
 
+      describe "#transition_to_not_done" do
+        let(:available_transitions) do
+          [
+            { "name" => "Withdraw",
+              "to" => { "name" => "Withdrawn",
+                        "statusCategory" => { "key" => "done", "colorName" => "green", "name" => "Done" } } },
+            { "name" => "Set As Defect Correction in Process",
+              "to" => {
+                "name" => "Defect Correction in Process",
+                "statusCategory" => { "key" => "indeterminate", "colorName" => "yellow", "name" => "In Progress" }
+              } },
+            { "name" => "Confirm",
+              "to" => { "name" => "Confirmed",
+                        "statusCategory" => { "key" => "new", "colorName" => "blue-gray", "name" => "To Do" } } }
+          ]
+        end
+
+        before do
+          expect(transitioner).to receive(:available_transitions).at_least(:once).and_return(available_transitions)
+        end
+
+        it "finds a non-done transition and transitions to it" do
+          expect(transitioner).to receive(:transition_to).with("Defect Correction in Process")
+
+          transitioner.transition_to_not_done
+        end
+
+        context "when no non-done transition is found" do
+          let(:available_transitions) do
+            [
+              { "name" => "Withdraw",
+                "to" => { "name" => "Withdrawn",
+                          "statusCategory" => { "key" => "done", "colorName" => "green", "name" => "Done" } } },
+              { "name" => "Set To Done",
+                "to" => { "name" => "Done",
+                          "statusCategory" => { "key" => "done", "colorName" => "green", "name" => "Done" } } }
+            ]
+          end
+
+          it "transitions to the first done transition" do
+            expect { transitioner.transition_to_not_done }
+              .to raise_error(TicketStatusTransitioner::StatusTransitionerError,
+                              /No non-done transition found in .+/)
+          end
+        end
+      end
+
       describe "#transition_payload_for" do
         let(:available_transitions) do
           [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ticket-replicator
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.3
 platform: ruby
 authors:
 - Christophe Broult
@@ -183,6 +183,7 @@ files:
 - lib/ticket/replicator/file_transformer/for_csv.rb
 - lib/ticket/replicator/file_transformer/for_xlsx.rb
 - lib/ticket/replicator/jira_project.rb
+- lib/ticket/replicator/mappings.rb
 - lib/ticket/replicator/replicated_summary.rb
 - lib/ticket/replicator/row_loader.rb
 - lib/ticket/replicator/row_transformer.rb
@@ -199,6 +200,7 @@ files:
 - spec/ticket/replicator/file_transformer/for_xlsx_spec.rb
 - spec/ticket/replicator/file_transformer_spec.rb
 - spec/ticket/replicator/jira_project_spec.rb
+- spec/ticket/replicator/mappings_spec.rb
 - spec/ticket/replicator/replicated_summary_spec.rb
 - spec/ticket/replicator/row_loader_spec.rb
 - spec/ticket/replicator/row_transformer_spec.rb