ticket-replicator 0.1.1

data/features/extract-sap-solution-manager-defect-tickets.feature

@@ -0,0 +1,45 @@
+@in-specification
+Feature: Extract defect tickets from SAP Solution Manager
+  As an integration system
+  I want to extract defect tickets from SAP
+  So that I can prepare them for transformation
+
+  Scenario: Successfully extract defect tickets
+    Given the SAP system contains the following defect tickets:
+      | ID    | Status      | Priority   | Team         | Summary                                      |
+      | 10001 | New         | 2-High     | Frontend     | Login page randomly fails to load CSS assets |
+      | 10002 | In Progress | 1-Critical | Backend      | Database deadlock during order processing    |
+      | 10003 | Resolved    | 3-Medium   | Integration  | Invalid date format in SOAP response         |
+      | 10004 | Closed      | 4-Low      | Mobile       | App crashes when offline on Android 12       |
+      | 10005 | Open        | 2-High     | Security     | Session tokens not properly invalidated      |
+      | 10006 | In Review   | 3-Medium   | DevOps       | Jenkins pipeline timeout on large builds     |
+      | 10007 | Rejected    | 4-Low      | QA           | Test data missing edge case scenarios        |
+      | 10008 | Confirmed   | 1-Critical | Architecture | Memory leak in caching implementation        |
+      | 10009 | On Hold     | 3-Medium   | UX           | Inconsistent button styles across modules    |
+      | 10010 | Fixed       | 2-High     | Performance  | Slow response time on product search API     |
+    When I run the extract process
+    Given the SAP system contains defect tickets
+    When I run the extract process
+    Then a file named "sap_defects.csv" should exist
+    And the file "sap_defects.csv" should contain exactly:
+        """
+        "ID","Status","Priority","Team","Summary"
+        "10001","New","2-High","Frontend","Login page randomly fails to load CSS assets (10001)"
+        "10002","In Progress","1-Critical","Backend","Database deadlock during order processing (10002)"
+        "10003","Resolved","3-Medium","Integration","Invalid date format in SOAP response (10003)"
+        "10004","Closed","4-Low","Mobile","App crashes when offline on Android 12 (10004)"
+        "10005","Open","2-High","Security","Session tokens not properly invalidated (10005)"
+        "10006","In Review","3-Medium","DevOps","Jenkins pipeline timeout on large builds (10006)"
+        "10007","Rejected","4-Low","QA","Test data missing edge case scenarios (10007)"
+        "10008","Confirmed","1-Critical","Architecture","Memory leak in caching implementation (10008)"
+        "10009","On Hold","3-Medium","UX","Inconsistent button styles across modules (10009)"
+        "10010","Fixed","2-High","Performance","Slow response time on product search API (10010)"
+        """
+
+
+
+  Scenario: Handle SAP connection error
+    Given the SAP system is unavailable
+    When I run the extract process
+    Then the process should fail gracefully
+    And an error should be logged

data/features/load_tickets_in_jira.feature

@@ -0,0 +1,129 @@
+Feature: Load tickets into Jira
+  In order to achieve overall transparency in a single ticket system
+  As team
+  I want to load the SAP tickets in Jira
+
+  Background:
+    Given the following environment variables have already been set with a value:
+      | name                                    |
+      | TICKET_REPLICATOR_JIRA_PROJECT_KEY      |
+      | TICKET_REPLICATOR_JIRA_TICKET_TYPE_NAME |
+    And the project has no tickets
+
+  Scenario: Load tickets in Jira
+    Given a file named "queue/20.transformed/sap_solution_manager_defects.csv" with:
+      """
+      "ID","Status","Resolution","Priority","Team","Summary"
+      "10001","Open","","Highest","A16 Restaurant","SMAN-10001 | Login page randomly fails to load CSS assets (10001)"
+      "10002","In Process","","Highest","A16 Platform","SMAN-10002 | Database deadlock during order processing (10002)"
+      "10003","Confirmed","Fixed","Medium","A16 Logistic","SMAN-10003 | Invalid date format in SOAP response (10003)"
+      "10004","Closed","Done","Low","A16 Market","SMAN-10004 | App crashes when offline on Android 12 (10004)"
+      "10005","Open","","High","A16 CRM","SMAN-10005 | Session tokens not properly invalidated (10005)"
+      "10006","Solution Proposal","","Medium","A16 Supply","SMAN-10006 | Jenkins pipeline timeout on large builds (10006)"
+      "10007","Withdrawn","Won't Do","Low","A16 E2E-Test","SMAN-10007 | Test data missing edge case scenarios (10007)"
+      "10008","Open","","Highest","A16  Markets","SMAN-10008 | Memory leak in caching implementation (10008)"
+      "10009","Wait on External","","Medium","A16  Platform","SMAN-10009 | Inconsistent button styles across modules (10009)"
+      """
+    When I successfully run `ticket-replicator --load`
+    Then the Jira project should only have the following tickets:
+      | status            | resolution | priority | team           | summary                                                            | source ticket url            |
+      | Open              |            | Highest  | A16 Restaurant | SMAN-10001 \| Login page randomly fails to load CSS assets (10001) | https://sap.example/id/10001 |
+      | In Process        |            | Highest  | A16 Platform   | SMAN-10002 \| Database deadlock during order processing (10002)    | https://sap.example/id/10002 |
+      | Confirmed         | Fixed      | Medium   | A16 Logistic   | SMAN-10003 \| Invalid date format in SOAP response (10003)         | https://sap.example/id/10003 |
+      | Closed            | Done       | Low      | A16 Market     | SMAN-10004 \| App crashes when offline on Android 12 (10004)       | https://sap.example/id/10004 |
+      | Open              |            | High     | A16 CRM        | SMAN-10005 \| Session tokens not properly invalidated (10005)      | https://sap.example/id/10005 |
+      | Solution Proposal |            | Medium   | A16 Supply     | SMAN-10006 \| Jenkins pipeline timeout on large builds (10006)     | https://sap.example/id/10006 |
+      | Withdrawn         | Won't Do   | Low      | A16 E2E-Test   | SMAN-10007 \| Test data missing edge case scenarios (10007)        | https://sap.example/id/10007 |
+      | Open              |            | Highest  | A16 Markets    | SMAN-10008 \| Memory leak in caching implementation (10008)        | https://sap.example/id/10008 |
+      | Wait on External  |            | Medium   | A16 Platform   | SMAN-10009 \| Inconsistent button styles across modules (10009)    | https://sap.example/id/10009 |
+    And the source ticket URL is found in the ticket descriptions of those tickets
+
+  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:
+      """
+      "ID","Status","Resolution","Priority","Team","Summary"
+      "10001","Open","","Highest","A16 Restaurant","SMAN-10001 | Login page randomly fails to load CSS assets (10001)"
+      "10002","In Process","","Highest","A16 Platform","SMAN-10002 | Database deadlock during order processing (10002)"
+      """
+    And a file named "queue/20.transformed/sap_solution_manager_defects.SAME_CONTENT.csv" with:
+      """
+      "ID","Status","Resolution","Priority","Team","Summary"
+      "10001","Open","","Highest","A16 Restaurant","SMAN-10001 | Login page randomly fails to load CSS assets (10001)"
+      "10002","In Process","","Highest","A16 Platform","SMAN-10002 | Database deadlock during order processing (10002)"
+      """
+    When I successfully run `ticket-replicator --load`
+    Then the Jira project should only have the following tickets:
+      | status     | resolution | priority | team           | summary                                                            | source ticket url            |
+      | Open       |            | Highest  | A16 Restaurant | SMAN-10001 \| Login page randomly fails to load CSS assets (10001) | https://sap.example/id/10001 |
+      | In Process |            | Highest  | A16 Platform   | SMAN-10002 \| Database deadlock during order processing (10002)    | https://sap.example/id/10002 |
+    And the source ticket URL is found in the ticket descriptions of those tickets
+
+  Scenario: Tickets are updated only if changes happened or they were not replicated before
+    Given a file named "queue/20.transformed/2025-03-29.16h16.sap_solution_manager_defects.csv" with:
+      """
+      "ID","Status","Resolution","Priority","Team","Summary"
+      "10001","Open","","Highest","A16 Restaurant","SMAN-10001 | Login page randomly fails to load CSS assets (10001)"
+      "10002","In Process","","Medium","A16 Platform","SMAN-10002 | Database deadlock during order processing (10002)"
+      "10016","Confirmed","Fixed","High","Performance Team","SMAN-10016 | Slow response time on product search API (10016)"
+      """
+    And I successfully run `ticket-replicator --load`
+    When a file named "queue/20.transformed/2025-03-29.19h56.update_tickets.csv" with:
+      """
+      "ID","Status","Resolution","Priority","Team","Summary"
+      "10001","Closed","","Highest","A16 Restaurant","SMAN-10001 | Login page randomly fails to load CSS assets (10001)"
+      "10002","In Process","","High","A16 Platform","SMAN-10002 | *Recurring* database deadlock during order processing (10002)"
+      "10008","Open","","Highest","A16 Markets","SMAN-10008 | Memory leak in caching implementation (10008)"
+      "10016","Confirmed","Fixed","High","Performance Team","SMAN-10016 | Slow response time on product search API (10016)"
+      """
+    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 | team             | summary                                                                     | source ticket url            |
+      | one update due to status change                                   | Closed     |            | Highest  | A16 Restaurant   | SMAN-10001 \| Login page randomly fails to load CSS assets (10001)          | https://sap.example/id/10001 |
+      | one update due to priority and summary updates                    | In Process |            | High     | A16 Platform     | SMAN-10002 \| *Recurring* database deadlock during order processing (10002) | https://sap.example/id/10002 |
+      | two updates due to new ticket created (fields and status changes) | Open       |            | Highest  | A16 Markets      | SMAN-10008 \| Memory leak in caching implementation (10008)                 | https://sap.example/id/10008 |
+      | no update since no status or field change                         | Confirmed  | Fixed      | High     | Performance Team | SMAN-10016 \| Slow response time on product search API (10016)              | https://sap.example/id/10016 |
+    And only 4 Jira update requests were emitted
+
+  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:
+      """
+      "ID","Status","Resolution","Priority","Team","Summary"
+      "10001","Open","","Highest","A16 Restaurant","SMAN-10001 | Login page randomly fails to load CSS assets (10001)"
+      "10002","In Process","","Highest","A16 Platform","SMAN-10002 | Database deadlock during order processing (10002)"
+      "10003","Confirmed","Fixed","Medium","A16 Logistic","SMAN-10003 | Invalid date format in SOAP response (10003)"
+      "10004","____ INEXISTING STATUS ____","Done","Low","A16 Market","SMAN-10004 | App crashes when offline on Android 12 (10004)"
+      "10005","Open","","High","A16 CRM","SMAN-10005 | Session tokens not properly invalidated (10005)"
+      "10006","Solution Proposal","","Medium","A16 Supply","SMAN-10006 | Jenkins pipeline timeout on large builds (10006)"
+      "10007","Withdrawn","Won't Do","Low","A16 E2E-Test","SMAN-10007 | Test data missing edge case scenarios (10007)"
+      "10008","Open","","Highest","A16  Markets","SMAN-10008 | Memory leak in caching implementation (10008)"
+      "10009","Wait on External","","Medium","A16  Platform","SMAN-10009 | Inconsistent button styles across modules (10009)"
+      """
+    When I run `ticket-replicator --load`
+    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"].:
+      #<CSV::Row id:"10004" status:"____ INEXISTING STATUS ____" resolution:"Done" priority:"Low" team:"A16 Market" summary:"SMAN-10004 | App crashes when offline on Android 12 (10004)">
+      """
+
+  Scenario: Attempting to set an unexpected priority generates information about the current row being loaded
+    Given a file named "queue/20.transformed/sap_solution_manager_defects.csv" with:
+      """
+      "ID","Status","Resolution","Priority","Team","Summary"
+      "10001","Open","","Highest","A16 Restaurant","SMAN-10001 | Login page randomly fails to load CSS assets (10001)"
+      "10002","In Process","","Highest","A16 Platform","SMAN-10002 | Database deadlock during order processing (10002)"
+      "10003","Confirmed","Fixed","Medium","A16 Logistic","SMAN-10003 | Invalid date format in SOAP response (10003)"
+      "10004","Closed","Done","Low","A16 Market","SMAN-10004 | App crashes when offline on Android 12 (10004)"
+      "10005","Open","","High","A16 CRM","SMAN-10005 | Session tokens not properly invalidated (10005)"
+      "10006","Solution Proposal","","Medium","A16 Supply","SMAN-10006 | Jenkins pipeline timeout on large builds (10006)"
+      "10007","Withdrawn","Won't Do","Low","A16 E2E-Test","SMAN-10007 | Test data missing edge case scenarios (10007)"
+      "10008","Open","","____ UNEXPECTED PRIORITY ____","A16  Markets","SMAN-10008 | Memory leak in caching implementation (10008)"
+      "10009","Wait on External","","Medium","A16  Platform","SMAN-10009 | Inconsistent button styles across modules (10009)"
+      """
+    When I run `ticket-replicator --load`
+    Then it should fail with:
+      """
+      ERROR  Object : Ticket::Replicator::FileLoader::LoadError: queue/20.transformed/sap_solution_manager_defects.csv:9: error while loading row:
+      Bad Request:
+      #<CSV::Row id:"10008" status:"Open" resolution:"" priority:"____ UNEXPECTED PRIORITY ____" team:"A16  Markets" summary:"SMAN-10008 | Memory leak in caching implementation (10008)">
+      """

data/features/setup_ticket_replicator.feature

@@ -0,0 +1,85 @@
+@wip
+Feature: Setup Ticket Replicator
+  In order to simplify the initial setup
+  As a user of ticket-replicator
+  I want to be able to setup the queue and generate an initial configuration
+
+  Scenario: Creating the environment configuration file
+    Given a file named "config/ticket-replicator.mappings.yml" does not exist
+    When I successfully run `ticket-replicator --setup`
+    Then the output should contain:
+      """
+       INFO  Ticket::Replicator::Setup : Created folder "queue/10.extracted"
+       INFO  Ticket::Replicator::Setup : Created file "config/ticket-replicator.mappings.yml"
+      """
+    And a file named "config/ticket-replicator.mappings.yml" should contain exactly:
+      """
+      ---
+      ### WARNING
+      ### WARNING - Example config: Please adapt to your context
+      ### WARNING
+      field_mapping:
+        id: Defect
+        summary: Defect (2)
+        priority: Defect Priority
+        resolution: Defect Status
+        status: Defect Status
+        team: Defect Support Team (2)
+
+      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: keep_original_value
+        "New":
+        "Open":
+        "In Process":
+        "In Review":
+        "On Hold":
+        Deferred:
+        Defect Correction in Process:
+        "Fixed": "Fixed"
+        "Closed": "Done"
+        "Rejected": "Won't Do"
+        "Resolved": "Fixed"
+        "Confirmed":
+        "Forwarded":
+        "Information Required":
+        Wait for Defect Correction:
+        Solution Proposal:
+        Tester Action:
+        Wait on External:
+
+      team_mapping:
+        defaults_to: keep_original_value
+        "Frontend": "Web Team"
+        "Backend": "Server Team"
+        "Integration": "Integration Team"
+        "Mobile": "Mobile Team"
+        "Security": "Security Team"
+        "DevOps": "DevOps Team"
+        "QA": "Quality Assurance"
+        "Architecture": "Architecture Team"
+        "UX": "Design Team"
+        "Performance": "Performance Team"
+      """
+    And a directory named "queue/10.extracted" should exist
+
+  Scenario: Not overriding an existing environment configuration file
+    Given a file named "config/ticket-replicator.mappings.yml" with:
+      """
+      ---
+      # existing configuration
+      """
+    When I run `ticket-replicator --setup`
+    Then it should fail with:
+      """
+       INFO  Ticket::Replicator::Setup : Created folder "queue/10.extracted"
+      ERROR  Object : Ticket::Replicator::Setup::SetupError: Not overwriting existing config file "config/ticket-replicator.mappings.yml"
+      """

data/features/step_definitions/anonymized_sample.xlsx:Zone.Identifier

@@ -0,0 +1,3 @@
+[ZoneTransfer]
+ZoneId=3
+HostUrl=about:internet

data/features/step_definitions/execution_context_steps.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+Given(/^the following environment variables have been set:$/) do |table|
+  table.hashes.each do |env_var|
+    name = env_var.fetch("name")
+    value = env_var.fetch("value")
+    set_environment_variable(name, value)
+  end
+end
+
+Given("the current date time is {string}") do |current_date_time|
+  set_environment_variable("JAT_CURRENT_DATE_TIME", current_date_time)
+end

data/features/step_definitions/extract_defect_tickets_from_sap_solution_manager_steps.rb.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+Given(/^the SAP system contains the following defect tickets:$/) do |table|
+  MockDefectTicketServer.set_tickets(table.hashes)
+end
+
+When(/^I run the extract process$/) do
+  @extractor = DefectTicketExtractor.new
+  @extractor.run
+end
+
+Given(/^the SAP system contains defect tickets$/) do
+  default_tickets = [
+    { ID: "DEF001", Status: "Open", Priority: "High", Team: "Core", Summary: "Test defect" }
+  ]
+  MockDefectTicketServer.set_tickets(default_tickets)
+end
+
+Given(/^the SAP system is unavailable$/) do
+  MockDefectTicketServer.simulate_unavailable
+end
+
+Then(/^the process should fail gracefully$/) do
+  expect { @extractor.run }.to raise_error(SAPConnectionError)
+end
+
+And(/^an error should be logged$/) do
+  expect(Logger).to have_received(:error).with(/SAP system unavailable/)
+end

data/features/step_definitions/load_tickets_in_jira_steps.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "ticket/replicator"
+
+Given(/^the following environment variables have already been set with a value:$/) do |table|
+  # table is a table.hashes.keys # => [:name]
+  table.hashes.each { |env_var| expect(ENV).to have_key(env_var["name"]) }
+end
+
+Given(/^the project has no tickets$/) do
+  ticket_replicator.jira_project.all_tickets.each(&:delete)
+end
+
+Then(/^the Jira project should only have the following tickets:$/) do |table|
+  keys = table.headers - ["example purpose", "source ticket url", "team", "resolution"]
+
+  expected_tickets = table.hashes.map { |ticket| keys.collect { |key| ticket[key] } }.sort
+
+  log.debug { "expected_tickets =\n#{expected_tickets.inspect}" }
+
+  actual_tickets = ticket_replicator.jira_project.all_tickets.collect do |ticket|
+    keys.collect { |field_name| ticket.send(field_name) }
+  end.sort
+
+  log.debug { "actual_tickets =\n#{actual_tickets.inspect}" }
+
+  expect(actual_tickets).to match_array(expected_tickets)
+end
+
+And(/^only (\d+) Jira update requests were emitted$/) do |expected_update_request_count|
+  command_output = last_command_started.stdout
+  actual_put_count = command_output.scan("put").count
+  actual_post_count = command_output.scan("post").count
+
+  actual_update_request_count = actual_post_count + actual_put_count
+
+  expect(actual_update_request_count)
+    .to eq(expected_update_request_count.to_i), <<~EOEM
+
+       expected_update_request_count = #{expected_update_request_count}
+      != actual_update_request_count = #{actual_update_request_count}
+                    actual_put_count = #{actual_put_count}
+                   actual_post_count = #{actual_post_count}
+
+      Actual command output:\n#{command_output}"
+    EOEM
+end

data/features/step_definitions/transform_solution_manager_tickets_steps.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "axlsx"
+require "fileutils"
+
+Given("an Excel file named {string}") do |path|
+  @excel_file_path = path
+end
+
+And("it has a tab named {string} with the following rows:") do |tab_name, table|
+  package = Axlsx::Package.new
+
+  package.workbook.add_worksheet(name: tab_name) do |sheet|
+    sheet.add_row(table.hashes.first.keys, types: :string)
+
+    table.hashes.each { |row| sheet.add_row(row.values, types: :string) }
+  end
+
+  create_directory(File.dirname(@excel_file_path))
+  cd(".") { package.serialize(@excel_file_path) }
+end

data/features/support/10.setup_cucumber.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "aruba/cucumber"
+
+Aruba.configure do |config|
+  config.exit_timeout = 300 # seconds
+
+  config.activate_announcer_on_command_failure = %i[command stdout stderr]
+  config.log_level = :debug
+end

data/features/support/env.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "aruba/cucumber"
+
+module TicketReplicatorWorld
+  def log
+    @log ||= Logging.logger[self]
+  end
+
+  def ticket_replicator
+    @ticket_replicator ||= Ticket::Replicator.new
+  end
+end
+
+World(TicketReplicatorWorld)

data/features/support/hooks.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+def ensure_the_aruba_sandbox_is_active
+  setup_aruba
+  ENV["HOME"] = expand_path(".")
+  cd(".")
+
+  expect(Dir.home).to eq(expand_path("."))
+end
+
+Before do
+  ensure_the_aruba_sandbox_is_active
+end

data/features/support/manage_mock_sap_solution_manager.rb.DISABLED

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "mocks/mock_defect_ticket_server"
+
+Before do
+  @mock_defect_ticket_server = MockDefectTicketServer.new(port: 9001)
+  @mock_defect_ticket_server.start
+end
+
+After do
+  @mock_defect_ticket_server&.stop
+end