ticket-replicator 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c470d25146cd29253a36275e23181f072d7131333f271f748ebe3560d9849825
-  data.tar.gz: 72393510381f5d4abdd4aa3bccafbec872fc30f585ddee5fdf7a8ae4e0f28f2e
+  metadata.gz: '018e90cb8cce2dd15fdb8b766ec815f875a502b2404da79d5c11265b12d00ff9'
+  data.tar.gz: 5746059539911a89e647a9ef0b0de23dd060476ebaa55d5d79543354786fb25c
 SHA512:
-  metadata.gz: d1460f599c98ef9bdd4c0852cbf9c0b3734a7cba3453c96c4ab25e7dbac7a6e3303cf3b051b2d54ac80f7296113e383fafd1236eb62b8c4b57fe1d1cf190dc12
-  data.tar.gz: d641aa5a31b2efab1f6028383d534caf55336eeb49f43ceae446044df1cd0073873d6ca5f0b835d0581de049a402813a50a03478fdd81b9914259af079fbdadc
+  metadata.gz: 2f25722b36fb72167dd32f6d2a13a3855a8f3eaec98aa40ba2ac65b643ee4b318671d5236029856ebb89acf343bd9fdfa2588ddf387e8b91a71ea432ab84cc00
+  data.tar.gz: d301a6fe343826713be40f74cddc41fcd51a3b005009c16990b87e5e708e7312385a0925ed349668583556d50b8be2d45319fe407de5cf1ba0ca7328fb44c5c5

data/.ruby-version

@@ -0,0 +1 @@
+3.4.3

data/README.md

@@ -1,6 +1,7 @@
 # Ticket::Replicator
 
 [![Ruby](https://github.com/cbroult/ticket-replicator/actions/workflows/main.yml/badge.svg)](https://github.com/cbroult/ticket-replicator/actions/workflows/main.yml)
+[![Dependabot Updates](https://github.com/cbroult/ticket-replicator/actions/workflows/dependabot/dependabot-updates/badge.svg)](https://github.com/cbroult/ticket-replicator/actions/workflows/dependabot/dependabot-updates)
 
 ## Purpose
 
@@ -50,7 +51,7 @@ Optional environment variables:
 - `JIRA_HTTP_DEBUG` - Enable HTTP debug logging (set to "true" or "false").
 - `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.
 
 ### Setup Queue Folder And Field Mapping
 

data/config/examples/ticket-replicator.mappings.yml

@@ -4,12 +4,14 @@
 ### WARNING
 field_mapping:
   id: Defect
-  summary: Defect (2)
+  summary: Defect
   priority: Defect Priority
   resolution: Defect Status
   status: Defect Status
   team: Defect Support Team (2)
 
+id_extraction_regex: "\\((?<id>\\d+)\\)$"
+
 priority_mapping:
   "1: Critical": "Highest"
     "2: High": "High"

data/features/load_tickets_in_jira.feature

@@ -8,9 +8,6 @@ Feature: Load tickets into Jira
       | name                                    |
       | TICKET_REPLICATOR_JIRA_PROJECT_KEY      |
       | TICKET_REPLICATOR_JIRA_TICKET_TYPE_NAME |
-#    And the following environment variables have been set:
-#      | name                                | value                                        |
-#      | TICKET_REPLICATOR_SOURCE_TICKET_URL | http://url/to/source/ticket/<%= source_ticket_id %> |
     And the project has no tickets
 
   Scenario: Load tickets in Jira
@@ -40,6 +37,26 @@ Feature: Load tickets into Jira
       | Open              |            | Highest  | SMAN-10008 \| Memory leak in caching implementation (10008)        | http://url/to/source/ticket/10008 |
       | Wait on External  |            | Medium   | SMAN-10009 \| Inconsistent button styles across modules (10009)    | http://url/to/source/ticket/10009 |
 
+
+  Scenario: Load tickets in Jira w/o their resolution
+    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:
+      """
+      "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"
+      "10003","Confirmed","Done","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"
+      """
+    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 |            | 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: 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:
       """

data/features/setup_ticket_replicator.feature

@@ -20,12 +20,14 @@ Feature: Setup Ticket Replicator
       ### WARNING
       field_mapping:
         id: Defect
-        summary: Defect (2)
+        summary: Defect
         priority: Defect Priority
         resolution: Defect Status
         status: Defect Status
         team: Defect Support Team (2)
 
+      id_extraction_regex: "\\((?<id>\\d+)\\)$"
+
       priority_mapping:
         "1: Critical": "Highest"
           "2: High": "High"

data/features/transform-solution-manager-tickets-into-jira-loadable-tickets.feature

@@ -5,12 +5,13 @@ Feature: Transform SAP tickets to Jira format
 
   Background:
     Given the following environment variables have been set:
-      | name                                | value                                        |
+      | name                                | value                                               |
       | TICKET_REPLICATOR_SOURCE_TICKET_URL | http://url/to/source/ticket/<%= source_ticket_id %> |
 
   Scenario: Transform valid ticket CSV
     Given a file named "config/ticket-replicator.mappings.yml" with:
       """
+      ---
       field_mapping:
         id: ID
         summary: Summary
@@ -77,6 +78,7 @@ Feature: Transform SAP tickets to Jira format
   Scenario: Transform valid ticket Excel
     Given a file named "config/ticket-replicator.mappings.yml" with:
       """
+      ---
       field_mapping:
         id: Defect
         summary: Defect (2)
@@ -146,9 +148,60 @@ Feature: Transform SAP tickets to Jira format
       "3000018423","No Error","","Medium","SMAN-3000018423 | Summary","http://url/to/source/ticket/3000018423"
       """
 
+  Scenario: Transform with ID originally embedded into the summary
+    Given a file named "config/ticket-replicator.mappings.yml" with:
+      """
+      ---
+      field_mapping:
+        id: Defect (2)
+        summary: Defect (2)
+        priority: Defect Priority
+        resolution: Defect Status
+        status: Defect Status
+
+      id_extraction_regex: "\\((?<id>\\d+)\\)$"
+
+      priority_mapping:
+        "1: Critical": "Highest"
+        "2: High": "High"
+        "3: Medium": "Medium"
+        "4: Low": "Low"
+
+      status_mapping:
+        defaults_to: keep_original_value
+
+      resolution_mapping:
+        defaults_to: blank_value
+        "Fixed": "Done"
+        "Closed": "Done"
+        "Rejected": "Won't Do"
+        "Resolved": "Done"
+        "Withdrawn": "Cannot Reproduce"
+      """
+    And an Excel file named "queue/10.extracted/sap_solution_manager_defects.xlsx"
+    And it has a tab named "SAP Document Export" with the following rows:
+      | Defect (2)           | Defect Priority | Defect Status                |
+      | Summary (3000017049) | 3: Medium       | Closed                       |
+      | Summary (9400011377) | 4: Low          | Confirmed                    |
+      | Summary (3000016618) | 3: Medium       | Defect Correction in Process |
+      | Summary (3000016617) | 3: Medium       | No Error                     |
+      | Summary (3000017667) | 3: Medium       | Closed                       |
+    Then a file named "queue/10.extracted/sap_solution_manager_defects.xlsx" should exist
+    When I successfully run `ticket-replicator --transform`
+    Then a file named "queue/20.transformed/sap_solution_manager_defects.csv" should contain exactly:
+      """
+      "ID","Status","Resolution","Priority","Summary","Source Ticket URL"
+      "3000017049","Closed","Done","Medium","SMAN-3000017049 | Summary (3000017049)","http://url/to/source/ticket/3000017049"
+      "9400011377","Confirmed","","Low","SMAN-9400011377 | Summary (9400011377)","http://url/to/source/ticket/9400011377"
+      "3000016618","Defect Correction in Process","","Medium","SMAN-3000016618 | Summary (3000016618)","http://url/to/source/ticket/3000016618"
+      "3000016617","No Error","","Medium","SMAN-3000016617 | Summary (3000016617)","http://url/to/source/ticket/3000016617"
+      "3000017667","Closed","Done","Medium","SMAN-3000017667 | Summary (3000017667)","http://url/to/source/ticket/3000017667"
+      """
+
   Scenario: Processing an invalid Excel file generates an error with relevant information
     Given a file named "config/ticket-replicator.mappings.yml" with:
       """
+      ---
       field_mapping:
         id: Defect
         summary: Defect (2)
@@ -184,6 +237,7 @@ Feature: Transform SAP tickets to Jira format
   Scenario: Processing a file with missing columns generates an error with relevant information
     Given a file named "config/ticket-replicator.mappings.yml" with:
       """
+      ---
       field_mapping:
         id: Defect
         summary: Defect (2)
@@ -223,6 +277,7 @@ Feature: Transform SAP tickets to Jira format
   Scenario: Processing a file with an unexpected priority generates an error with relevant information
     Given a file named "config/ticket-replicator.mappings.yml" with:
       """
+      ---
       field_mapping:
         id: Defect
         summary: Defect (2)

data/lib/ticket/replicator/file_transformer.rb

@@ -56,6 +56,7 @@ module Ticket
             #{extracted_path}:#{row_index}: error while transforming row:
             #{e.message}:
             #{row.inspect}
+            #{e.backtrace.join("\n")}
           EOERRORMSG
         ensure
           row_index += 1

data/lib/ticket/replicator/row_loader.rb

@@ -9,6 +9,13 @@ module Ticket
         new(jira_project, row).run
       end
 
+      def self.build_ticket_link_attributes(
+        url, title, application_name = Ticket::SOURCE_TICKET_REMOTE_LINK_APPLICATION
+      )
+        { "object" => { "url" => url, "title" => title } }
+          .merge(application_name ? { "application" => { "name" => application_name } } : {})
+      end
+
       private_class_method :new
 
       attr_reader :jira_project, :row
@@ -28,23 +35,35 @@ module Ticket
         jira_project.replicated_tickets.key?(id)
       end
 
-      # rubocop:disable Metrics/MethodLength
       def save_ticket
         return unless ticket_fields_need_to_be_updated?
 
-        ticket.jira_ticket.save!({
-                                   fields: {
-                                     project: { key: jira_project.project_key },
-                                     issuetype: { name: jira_project.ticket_type_name },
-                                     resolution: jira_resolution_value,
-                                     priority: { name: priority },
-                                     summary: summary
-                                   }
-                                 })
+        ticket.jira_ticket.save!(attributes_for_save)
 
         ticket.jira_ticket.fetch
       end
 
+      private
+
+      def attributes_for_save
+        {
+          fields: field_values
+        }
+      end
+
+      def field_values
+        {
+          project: { key: jira_project.project_key },
+          issuetype: { name: jira_project.ticket_type_name },
+          priority: { name: priority },
+          summary: summary
+        }.merge(exclude_resolution? ? {} : { resolution: jira_resolution_value })
+      end
+
+      def exclude_resolution?
+        ENV["TICKET_REPLICATOR_DISABLE_RESOLUTION_LOADING"] == "true"
+      end
+
       def jira_resolution_value
         return if resolution.blank?
         return { name: resolution } if jira_project.resolutions.key?(resolution)
@@ -57,8 +76,6 @@ module Ticket
         nil
       end
 
-      # rubocop:enable Metrics/MethodLength
-
       def ticket_fields_need_to_be_updated?
         !ticket_previously_replicated? || ticket_fields_changed?
       end
@@ -68,7 +85,7 @@ module Ticket
       end
 
       def fields_to_save
-        %i[summary priority]
+        %i[summary priority] + (exclude_resolution? ? [] : %i[resolution])
       end
 
       def update_source_ticket_remote_link
@@ -94,7 +111,7 @@ module Ticket
 
             existing_ticket_link_attributes          = #{existing_ticket_link_attributes.inspect}
             filtered_existing_ticket_link_attributes = #{filtered_existing_ticket_link_attributes}
-            ticket_link_attributes:                    #{ticket_link_attributes.inspect}
+            ticket_link_attributes                   = #{ticket_link_attributes.inspect}
           EOLOG
         end
 
@@ -111,13 +128,6 @@ module Ticket
         self.class.build_ticket_link_attributes(url, title)
       end
 
-      def self.build_ticket_link_attributes(
-        url, title, application_name = Ticket::SOURCE_TICKET_REMOTE_LINK_APPLICATION
-      )
-        { "object" => { "url" => url, "title" => title } }
-          .merge(application_name ? { "application" => { "name" => application_name } } : {})
-      end
-
       def transition_ticket_to_the_expected_status
         ticket.transition_to(status)
       end
@@ -139,8 +149,6 @@ module Ticket
         Replicator::Ticket.new(jira_project.jira_auto_tool, jira_project.jira_client.Issue.build)
       end
 
-      private
-
       def method_missing(name, *args)
         if field_to_load?(name)
           row.fetch(name) { |key| raise "No value found for #{key.inspect} in #{row.inspect}" }

data/lib/ticket/replicator/row_transformer.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "ticket/replicator/replicated_summary"
+require "ticket/replicator/file_transformer"
 require "erb"
 
 module Ticket
@@ -23,9 +24,30 @@ module Ticket
       end
 
       def transformed_id
-        remapped_field_extracted_value_for :id
+        remapped_id = remapped_field_extracted_value_for :id
+
+        return remapped_id unless id_extraction_regex
+
+        match_data = id_extraction_regex.match(remapped_id)
+
+        return match_data[:id] if match_data
+
+        raise FileTransformer::TransformError,
+              "No match found for :id in #{remapped_id.inspect} using #{id_extraction_regex.inspect}"
+      end
+
+      private
+
+      def id_extraction_regex
+        @id_extraction_regex ||=
+          begin
+            regex_string = mappings["id_extraction_regex"]
+            Regexp.new(regex_string) if regex_string
+          end
       end
 
+      public
+
       def transformed_source_ticket_url
         source_ticket_url_builder(transformed_id)
       end
@@ -55,7 +77,7 @@ module Ticket
       end
 
       def transformed_summary
-        ReplicatedSummary.build(remapped_field_extracted_value_for(:id),
+        ReplicatedSummary.build(transformed_id,
                                 remapped_field_extracted_value_for(:summary)).to_s
       end
 

data/lib/ticket/replicator/version.rb

@@ -2,6 +2,6 @@
 
 module Ticket
   class Replicator
-    VERSION = "1.1.0"
+    VERSION = "1.2.0"
   end
 end

data/spec/ticket/replicator/file_transformer_spec.rb

@@ -70,11 +70,9 @@ module Ticket
             end
 
             it "raises an error message including the file name and line number of the row that was processed" do
-              expect { transformer.transformed_rows }.to raise_error(TransformError, <<~EOEXPECTEDERRORMSG)
-                source.csv:3: error while transforming row:
-                transformation error:
-                :another_row
-              EOEXPECTEDERRORMSG
+              expect { transformer.transformed_rows }
+                .to raise_error(TransformError,
+                                /source\.csv:3: error while transforming row:\ntransformation error:\n:another_row\n/)
             end
           end
         end