ticket-replicator 0.1.1

data/spec/ticket/replicator/ticket_spec.rb

@@ -0,0 +1,244 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "rspec"
+require "ticket/replicator/ticket"
+
+module Ticket
+  # rubocop:disable Metrics/ClassLength
+  class Replicator
+    RSpec.describe Ticket do
+      let(:jira_ticket_properties_string) do
+        <<-EOJTPS
+      {
+        "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
+        "id": "13661",#{" "}
+        "self": "https://cbroult.atlassian.net/rest/api/2/issue/13661",
+        "key": "TRCIDEVLX-1",
+        "fields": {
+          "statuscategorychangedate": "2025-04-02T19:39:22.438+0200",
+          "issuetype": {
+            "self": "https://cbroult.atlassian.net/rest/api/2/issuetype/10022",
+            "id": "10022",
+            "description": "Bugs track problems or errors.",
+            "iconUrl": "https://cbroult.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10303?size=medium",
+            "name": "Bug",
+            "subtask": false,
+            "avatarId": 10303,
+            "entityId": "a23acedd-54b7-4e0c-846a-12588361ba53",
+            "hierarchyLevel": 0
+          },
+          "components": [],
+          "timeoriginalestimate": null,
+          "description": null,
+          "project": {
+            "self": "https://cbroult.atlassian.net/rest/api/2/project/10009",
+            "id": "10009",#{" "}
+            "key": "TRCIDEVLX",
+            "name": "TR CI/CD - Dev - Linux",
+            "projectTypeKey": "software",
+            "simplified": true,
+            "avatarUrls": {
+              "48x48": "https://cbroult.atlassian.net/rest/api/2/universal_avatar/view/type/project/avatar/10413",
+              "24x24": "https://cbroult.atlassian.net/rest/api/2/universal_avatar/view/type/project/avatar/10413?size=small",
+              "16x16": "https://cbroult.atlassian.net/rest/api/2/universal_avatar/view/type/project/avatar/10413?size=xsmall",#{" "}
+              "32x32": "https://cbroult.atlassian.net/rest/api/2/universal_avatar/view/type/project/avatar/10413?size=medium"
+            }
+          },
+          "fixVersions": [],
+          "statusCategory": {
+            "self": "https://cbroult.atlassian.net/rest/api/2/statuscategory/2",
+            "id": 2,
+            "key": "new",
+            "colorName": "blue-gray",#{" "}
+            "name": "To Do"
+          },
+          "resolution": null,
+          "security": null,
+          "resolutiondate": null,
+          "summary": "SMAN-16384 | Login page randomly fails to load CSS assets (10001)",
+          "lastViewed": null,
+          "watches": {
+            "self": "https://cbroult.atlassian.net/rest/api/2/issue/TRCIDEVLX-1/watchers",
+            "watchCount": 1,
+            "isWatching": true
+          },
+          "created": "2025-04-02T19:39:21.673+0200",
+          "customfield_10020": null,
+          "customfield_10021": null,
+          "reporter": {
+            "self": "https://cbroult.atlassian.net/rest/api/2/user?accountId=712020%3Acbaffa92-1b2a-41b7-be0b-9199dcdf927c",
+            "accountId": "712020:cbaffa92-1b2a-41b7-be0b-9199dcdf927c",
+            "emailAddress": "cbroult@yahoo.com",
+            "avatarUrls": {
+              "48x48": "https://secure.gravatar.com/avatar/adb3120007b0819ce4e6e5535dabbfd9?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FCB-0.png",
+              "24x24": "https://secure.gravatar.com/avatar/adb3120007b0819ce4e6e5535dabbfd9?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FCB-0.png",
+              "16x16": "https://secure.gravatar.com/avatar/adb3120007b0819ce4e6e5535dabbfd9?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FCB-0.png",
+              "32x32": "https://secure.gravatar.com/avatar/adb3120007b0819ce4e6e5535dabbfd9?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FCB-0.png"
+            },
+            "displayName": "Christophe Broult",
+            "active": true,
+            "timeZone": "Europe/Berlin",
+            "accountType": "atlassian"
+          },
+          "priority": {
+            "self": "https://cbroult.atlassian.net/rest/api/2/priority/3",
+            "iconUrl": "https://cbroult.atlassian.net/images/icons/priorities/medium.svg",
+            "name": "Medium",
+            "id": "3"
+          },
+          "customfield_10001": null,
+          "labels": [],
+          "customfield_10016": null,
+          "customfield_10116": null,
+          "environment": null,
+          "customfield_10019": "0|i000ev:",
+          "versions": [],
+          "duedate": null,
+          "votes": {
+            "self": "https://cbroult.atlassian.net/rest/api/2/issue/TRCIDEVLX-1/votes",
+            "votes": 0,
+            "hasVoted": false
+          },
+          "issuelinks": [],
+          "assignee": null,
+          "updated": "2025-04-02T19:39:21.905+0200",
+          "status": {
+            "self": "https://cbroult.atlassian.net/rest/api/2/status/10023",
+            "description": "",
+            "iconUrl": "https://cbroult.atlassian.net/",
+            "name": "To Do",
+            "id": "10023",
+            "statusCategory": {
+              "self": "https://cbroult.atlassian.net/rest/api/2/statuscategory/2",
+              "id": 2,
+              "key": "new",
+              "colorName": "blue-gray",
+              "name": "To Do"
+            }
+          }
+        }
+      }
+        EOJTPS
+      end
+
+      let(:jira_ticket_properties_hash) { Psych.load(jira_ticket_properties_string) }
+      let(:field_navigator) { double("field_navigator") }
+
+      before(:each) do
+        %i[summary status resolution priority].each do |field|
+          allow(field_navigator).to receive(:name_to_id).with(field).and_return(true)
+        end
+
+        allow(field_navigator).to receive(:name_to_id).and_return(true)
+      end
+
+      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) }
+
+      describe "#source_id" do
+        it { expect(ticket.source_id).to eq("16384") }
+      end
+
+      describe "#summary" do
+        it { expect(ticket.summary).to eq("SMAN-16384 | Login page randomly fails to load CSS assets (10001)") }
+      end
+
+      describe "replicated?" do
+        let(:ticket) { described_class.new(jira_auto_tool, jira_ticket) }
+        let(:jira_ticket) { double(JIRA::Resource::Issue, summary: actual_summary) }
+
+        context "when replicated" do
+          let(:actual_summary) { "SMAN-1 | summary of a replicated ticket" }
+          it { expect(ticket.replicated?).to be_truthy }
+        end
+
+        context "when non replicated" do
+          let(:actual_summary) { "summary of a non replicated ticket" }
+          it { expect(ticket.replicated?).to be_falsy }
+        end
+      end
+
+      describe "#status" do
+        it { expect(ticket.status).to eq("To Do") }
+      end
+
+      describe "#resolution" do
+        it { expect(ticket.resolution).to eq("") }
+      end
+
+      describe "#priority" do
+        it { expect(ticket.priority).to eq("Medium") }
+      end
+
+      describe "<=>" do
+        let(:ticket) { build_ticket "SMAN-16384 | Test ticket" }
+
+        def build_ticket(summary)
+          attributes = Marshal.load(Marshal.dump(jira_ticket_properties_hash))
+          attributes["fields"]["summary"] = summary
+          described_class.new(jira_auto_tool, JIRA::Resource::Issue.build(jira_client, attributes))
+        end
+
+        it "returns 0 for identical tickets" do
+          expect(ticket <=> ticket).to eq(0) # rubocop:disable  Lint/BinaryOperatorWithIdenticalOperands
+        end
+
+        it "returns 0 for tickets with identical source_id" do
+          other_ticket = build_ticket(ticket.summary)
+
+          expect(ticket <=> other_ticket).to eq(0)
+        end
+
+        it "returns -1 when comparing ticket with higher source_id" do
+          other_ticket = build_ticket("SMAN-16385 | Test ticket")
+          expect(ticket <=> other_ticket).to eq(-1)
+        end
+
+        it "returns 1 when comparing ticket with lower source_id" do
+          other_ticket = build_ticket("SMAN-16383 | Test ticket")
+          expect(ticket <=> other_ticket).to eq(1)
+        end
+
+        it "returns nil when comparing with nil" do
+          expect(ticket <=> nil).to be_nil
+        end
+
+        it "returns nil when comparing ticket with nil source_id" do
+          other_ticket = build_ticket("Summary with no source id prefix")
+          expect { ticket <=> other_ticket }.to raise_error(ReplicatedSummary::ParseError)
+        end
+      end
+
+      describe "#delete" do
+        it do
+          expect(jira_ticket).to receive(:delete)
+
+          ticket.delete
+        end
+
+        it "raises an exception when deletion fails" do
+          expect(jira_ticket).to receive(:delete).and_raise(JIRA::HTTPError.new("Not found"))
+
+          expect { ticket.delete }.to raise_error(JIRA::HTTPError)
+        end
+      end
+
+      describe "#transition_to" do
+        let(:transitioner) { instance_double(TicketStatusTransitioner) }
+        it do
+          expect(TicketStatusTransitioner).to receive(:new).with(ticket).and_return(transitioner)
+          expect(transitioner).to receive(:transition_to).with("Testing")
+
+          ticket.transition_to("Testing")
+        end
+      end
+    end
+  end
+  # rubocop:enable Metrics/ClassLength
+end

data/spec/ticket/replicator/ticket_status_transitioner_spec.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require "rspec"
+require "ticket/replicator/ticket_status_transitioner"
+
+module Ticket
+  class Replicator
+    RSpec.describe TicketStatusTransitioner do
+      let(:transitioner) { described_class.send(:new, ticket) }
+
+      let(:ticket) do
+        double(Ticket, key: "PROJKEY-16", status: "Todo", jira_auto_tool: jira_auto_tool, jira_client: jira_client)
+      end
+
+      let(:jira_auto_tool) { instance_double(Jira::Auto::Tool, jira_client: jira_client) }
+      let(:jira_client) { instance_double(JIRA::Client) }
+
+      describe "#transistion_to" do
+        let(:expected_payload) { { transition: { id: 131 } }.to_json }
+        let(:expected_headers) { { "Content-Type" => "application/json" } }
+
+        let(:http_response) do
+          instance_double(Net::HTTPResponse, code: 200, body: [].to_json)
+        end
+
+        it "transition the ticket status as per the ticket workflow" do
+          expect(jira_auto_tool).to receive(:jira_url)
+            .with("/rest/api/2/issue/PROJKEY-16/transitions")
+            .and_return("/transition/ticket/path")
+
+          expect(transitioner)
+            .to receive(:transition_payload_for).with("Pending Deployment").and_return(expected_payload)
+
+          expect(jira_client).to receive(:post)
+            .with("/transition/ticket/path", expected_payload, expected_headers)
+            .and_return(http_response)
+
+          transitioner.transition_to("Pending Deployment")
+        end
+
+        context "when the ticket is already in the expected status" do
+          it "does not transition the ticket" do
+            expect(ticket).to receive_messages(status: "a status")
+            expect(jira_client).not_to receive(:post).with(:anything)
+
+            transitioner.transition_to("a status")
+          end
+        end
+      end
+
+      describe "#transition_payload_for" do
+        let(:available_transitions) do
+          [
+            { "id" => "701",
+              "name" => "Close Issue",
+              "to" =>
+                { "name" => "Closed",
+                  "id" => "6" } },
+            { "id" => "3",
+              "name" => "Reopen Issue",
+              "to" =>
+                { "name" => "Reopened",
+                  "id" => "4" } }
+          ]
+        end
+
+        it do
+          expect(transitioner).to receive(:available_transitions).and_return(available_transitions)
+
+          expect(transitioner.transition_payload_for("Closed")).to eq({ transition: { id: "701" } }.to_json)
+        end
+      end
+
+      describe "#available_transitions" do
+        let(:actual_ticket_with_transition_information_response) do
+          { "key" => "PROJKEY-16",
+            "summary" => "SMAN-90056 | a summary",
+            "transitions" =>
+              [
+                { "id" => "701",
+                  "name" => "Close Issue",
+                  "to" =>
+                    { "name" => "Closed",
+                      "id" => "6" } },
+                { "id" => "3",
+                  "name" => "Reopen Issue",
+                  "to" =>
+                    { "name" => "Reopened",
+                      "id" => "4" } }
+              ] }
+        end
+
+        let(:http_response) do
+          instance_double(Net::HTTPResponse, body: actual_ticket_with_transition_information_response.to_json)
+        end
+
+        it "returns the available transitions for the ticket" do
+          expect(jira_auto_tool)
+            .to receive(:jira_url).with("/rest/api/2/issue/PROJKEY-16?expand=transitions")
+                                  .and_return("/path/to/fetch/issue_with_transitions")
+
+          expect(jira_client).to receive(:get).with("/path/to/fetch/issue_with_transitions")
+                                              .and_return(http_response)
+
+          expect(transitioner.available_transitions).to eq(
+            [
+              { "id" => "701",
+                "name" => "Close Issue",
+                "to" =>
+                  { "name" => "Closed",
+                    "id" => "6" } },
+              { "id" => "3",
+                "name" => "Reopen Issue",
+                "to" =>
+                  { "name" => "Reopened",
+                    "id" => "4" } }
+            ]
+          )
+        end
+      end
+    end
+  end
+end

data/spec/ticket/replicator_spec.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require "ticket/replicator"
+
+module Ticket
+  class Replicator
+    RSpec.describe Replicator do
+      it("has a version number") { expect(VERSION).not_to be nil }
+
+      let(:replicator) { Replicator.new }
+
+      it { expect(replicator.jira_project).to be_a(JiraProject) }
+      it { expect(replicator.jira_client).to be_a(JIRA::Client) }
+      it { expect(replicator.jira_auto_tool).to be_a(Jira::Auto::Tool) }
+
+      describe "#load" do
+        let(:transformed_files) { %w[transformed_file1 transformed_file2] }
+
+        before do
+          allow(replicator).to receive_messages(transformed_files: transformed_files)
+          allow(replicator).to receive(:jira_project).and_return(:jira_project)
+        end
+
+        it "transforms extracted files in the queue" do
+          transformed_files.each do |transformed_file|
+            expect(FileLoader).to receive(:run_on).with(:jira_project, transformed_file)
+          end
+
+          replicator.load
+        end
+      end
+
+      describe "#ticket_queue_transform_and_load" do
+        let(:extracted_files) { %w[extracted_file1 extracted_file2] }
+
+        before { allow(replicator).to receive_messages(extracted_files: extracted_files) }
+
+        it do
+          extracted_files.each do |extracted_file|
+            expect(FileReplicator).to receive(:run_on).with(replicator, extracted_file)
+          end
+
+          replicator.ticket_queue_transform_and_load
+        end
+      end
+
+      describe "#transformed_queue_clear" do
+        it "clears the transformed queue" do
+          expect(replicator).to receive_messages(transformed_folder: "path/to/transformed_folder")
+          expect(FileUtils).to receive(:rm_rf).with("path/to/transformed_folder")
+
+          replicator.transformed_queue_clear
+        end
+      end
+
+      describe "#transform" do
+        let(:extracted_files) { %w[extracted_file1 extracted_file2] }
+
+        before { allow(replicator).to receive_messages(extracted_files: extracted_files) }
+
+        it("transforms extracted files in the queue") do
+          extracted_files.each do |extracted_file|
+            expect(FileReplicator).to receive(:transform).with(replicator, extracted_file)
+          end
+
+          replicator.transform
+        end
+      end
+
+      describe "#extracted_files" do
+        it "returns a list of files" do
+          allow(replicator).to receive(:queue_files).with("queue/10.extracted").and_return(%w[file1 file2])
+
+          expect(replicator.extracted_files).to eq(%w[file1 file2])
+        end
+      end
+
+      describe "#transformed_files" do
+        it "returns a list of files" do
+          allow(replicator).to receive(:queue_files).with("queue/20.transformed").and_return(%w[file1 file2])
+
+          expect(replicator.transformed_files).to eq(%w[file1 file2])
+        end
+      end
+
+      describe "#queue_files" do
+        it "returns a list of files in the specified queue folder" do
+          expect(Dir).to receive(:glob).with("path/to/queue/folder/**/*").and_return(%w[file1 file2])
+
+          expect(replicator.send(:queue_files, "path/to/queue/folder")).to eq(%w[file1 file2])
+        end
+      end
+
+      shared_examples "a queue sub folder" do |sub_folder_method, expected_folder_path|
+        before { allow(replicator).to receive(:queue_dir).and_return("path/to/queue") }
+
+        it("is a queue sub folder") { expect(replicator.send(sub_folder_method)).to eq(expected_folder_path) }
+
+        it "automatically creates the queue sub folder if it does not exist" do
+          expect(FileUtils).to receive(:mkdir_p).with(expected_folder_path)
+
+          replicator.send(sub_folder_method)
+        end
+      end
+
+      it_behaves_like "a queue sub folder", :extracted_folder, "path/to/queue/10.extracted"
+      it_behaves_like "a queue sub folder", :transformed_folder, "path/to/queue/20.transformed"
+      it_behaves_like "a queue sub folder", :archived_folder, "path/to/queue/30.archived"
+
+      describe "#queue_folder" do
+        it("returns the queue folder") { expect(replicator.queue_folder).to eq("queue") }
+
+        it "automatically creates the queue folder if it does not exist" do
+          expect(FileUtils).to receive(:mkdir_p).with("queue")
+
+          replicator.queue_folder
+        end
+
+        context "when a subfolder is given" do
+          it "returns the queue folder" do
+            expect(FileUtils).to receive(:mkdir_p).with("queue/sub_folder")
+
+            expect(replicator.queue_folder("sub_folder")).to eq("queue/sub_folder")
+          end
+        end
+      end
+
+      describe "#home_dir" do
+        it { expect(replicator.home_dir).to eq(File.expand_path("../../", __dir__)) }
+      end
+
+      describe "#setup" do
+        it { expect(replicator.setup).to be_a(Setup) }
+      end
+    end
+  end
+end

data/transformed_file1

@@ -0,0 +1 @@
+"ID","Status","Resolution","Priority","Team","Summary"