jira-auto-tool 0.1.1

data/spec/jira/auto/tool/project/ticket_fields_spec.rb

@@ -0,0 +1,390 @@
+# frozen_string_literal: true
+
+require "rspec"
+require "jira/auto/tool/project/ticket_fields"
+
+module Jira
+  module Auto
+    class Tool
+      class Project
+        # rubocop:disable Metrics/ClassLength
+        class TicketFields
+          RSpec.describe TicketFields do
+            let(:ticket_fields) { described_class.new(tool, project) }
+            let(:tool) { instance_double(Tool) }
+            let(:project) { instance_double(Project, key: "project_key") }
+
+            describe "#list" do
+              let(:expected_list_output) do
+                <<~EOELO
+                  +----------------------------------------------------------------------------------------------------------------+
+                  |                                       Project project_key Ticket Fields                                        |
+                  +-------------+-----------+---------------------+------------+---------------------------------------------------+
+                  | Ticket Type | Field Key | Field Name          | Field Type | Allowed Values                                    |
+                  +-------------+-----------+---------------------+------------+---------------------------------------------------+
+                  | Story       | 10001     | key                 | String     | n/a                                               |
+                  | Story       | 10000     | Summary             | String     | n/a                                               |
+                  | Story       | 10002     | Story Points        | Number     | n/a                                               |
+                  | Epic        | 10001     | Implementation Team | Set        | ["Food Platform", "Food Delivery", "Food Supply"] |
+                  +-------------+-----------+---------------------+------------+---------------------------------------------------+
+                EOELO
+              end
+
+              before do
+                allow(ticket_fields)
+                  .to receive_messages(table_rows: [
+                                         ["Story", 10_001, "key", "String", "n/a"],
+                                         ["Story", 10_000, "Summary", "String", "n/a"],
+                                         ["Story", 10_002, "Story Points", "Number", "n/a"],
+                                         ["Epic", 10_001, "Implementation Team", "Set",
+                                          ["Food Platform", "Food Delivery", "Food Supply"]]
+                                       ])
+              end
+
+              it do
+                expect { ticket_fields.list }.to output(expected_list_output).to_stdout
+              end
+            end
+
+            describe "#table_row_header" do
+              it {
+                expect(ticket_fields.table_row_header).to eq(["Ticket Type", "Field Key", "Field Name", "Field Type",
+                                                              "Allowed Values"])
+              }
+            end
+
+            describe "#table_rows" do
+              let(:jira_client) { jira_resource_double(JIRA::Client) }
+              let(:createmeta) { jira_resource_double(JIRA::Resource::Createmeta, all: all_createmeta) }
+              let(:all_createmeta) do
+                [jira_resource_double(JIRA::Resource::Createmeta, attrs:
+                  { "id" => "10006",
+                    "key" => "JATCIDEVLX",
+                    "name" => "JAT CI/CD - Dev - Linux",
+                    "issuetypes" =>
+                      [{ "id" => "10005",
+                         "name" => "Task",
+                         "untranslatedName" => "Task",
+                         "subtask" => false,
+                         "fields" =>
+                           { "summary" =>
+                               { "schema" => { "type" => "string", "system" => "summary" },
+                                 "name" => "Summary",
+                                 "key" => "summary" },
+                             "customfield_10081" =>
+                               { "schema" =>
+                                   { "type" => "date",
+                                     "custom" =>
+                                       "com.atlassian.jira.plugin.system.customfieldtypes:datepicker",
+                                     "customId" => 10_081 },
+                                 "name" => "Expected Start",
+                                 "key" => "customfield_10081" },
+                             "customfield_10082" =>
+                               { "schema" =>
+                                   { "type" => "option",
+                                     "custom" =>
+                                       "com.atlassian.jira.plugin.system.customfieldtypes:select",
+                                     "customId" => 10_082 },
+                                 "name" => "Implementation Team",
+                                 "key" => "customfield_10082",
+                                 "allowedValues" =>
+                                   [{ "value" => "A16 CRM", "id" => "10044" },
+                                    { "value" => "A16 E2E-Test", "id" => "10045" },
+                                    { "value" => "A16 Logistic", "id" => "10048" },
+                                    { "value" => "A16 Platform", "id" => "10046" },
+                                    { "value" => "A16 Sys-Team", "id" => "10047" }] },
+                             "customfield_10020" =>
+                               { "schema" =>
+                                   { "type" => "array",
+                                     "items" => "json",
+                                     "custom" => "com.pyxis.greenhopper.jira:gh-sprint",
+                                     "customId" => 10_020 },
+                                 "name" => "Sprint",
+                                 "key" => "customfield_10020" },
+                             "customfield_10001" =>
+                               { "schema" =>
+                                   { "type" => "team",
+                                     "custom" =>
+                                       "com.atlassian.jira.plugin.system.customfieldtypes:atlassian-team",
+                                     "customId" => 10_001,
+                                     "configuration" =>
+                                       { "com.atlassian.jira.plugin.system.customfieldtypes:atlassian-team" =>
+                                           true } },
+                                 "name" => "Team",
+                                 "key" => "customfield_10001" } } },
+                       { "id" => "10006",
+                         "name" => "Sub-task",
+                         "untranslatedName" => "Sub-task",
+                         "subtask" => true,
+                         "fields" =>
+                           { "summary" =>
+                               { "schema" => { "type" => "string", "system" => "summary" },
+                                 "name" => "Summary",
+                                 "key" => "summary" },
+                             "customfield_10081" =>
+                               { "schema" =>
+                                   { "type" => "date",
+                                     "custom" =>
+                                       "com.atlassian.jira.plugin.system.customfieldtypes:datepicker",
+                                     "customId" => 10_081 },
+                                 "name" => "Expected Start",
+                                 "key" => "customfield_10081" },
+                             "customfield_10082" =>
+                               { "schema" =>
+                                   { "type" => "option",
+                                     "custom" =>
+                                       "com.atlassian.jira.plugin.system.customfieldtypes:select",
+                                     "customId" => 10_082 },
+                                 "name" => "Implementation Team",
+                                 "key" => "customfield_10082",
+                                 "allowedValues" =>
+                                   [{ "value" => "A16 CRM", "id" => "10044" },
+                                    { "value" => "A16 E2E-Test", "id" => "10045" },
+                                    { "value" => "A16 Logistic", "id" => "10048" },
+                                    { "value" => "A16 Platform", "id" => "10046" },
+                                    { "value" => "A16 Sys-Team", "id" => "10047" }] },
+                             "customfield_10020" =>
+                               { "schema" =>
+                                   { "type" => "array",
+                                     "items" => "json",
+                                     "custom" => "com.pyxis.greenhopper.jira:gh-sprint",
+                                     "customId" => 10_020 },
+                                 "name" => "Sprint",
+                                 "key" => "customfield_10020" },
+                             "customfield_10001" =>
+                               { "schema" =>
+                                   { "type" => "team",
+                                     "custom" =>
+                                       "com.atlassian.jira.plugin.system.customfieldtypes:atlassian-team",
+                                     "customId" => 10_001,
+                                     "configuration" =>
+                                       { "com.atlassian.jira.plugin.system.customfieldtypes:atlassian-team" =>
+                                           true } },
+                                 "name" => "Team",
+                                 "key" => "customfield_10001" } } },
+                       { "id" => "10003",
+                         "name" => "Story",
+                         "untranslatedName" => "Story",
+                         "subtask" => false,
+                         "fields" =>
+                           { "summary" =>
+                               { "schema" => { "type" => "string", "system" => "summary" },
+                                 "name" => "Summary",
+                                 "key" => "summary" },
+                             "customfield_10081" =>
+                               { "schema" =>
+                                   { "type" => "date",
+                                     "custom" =>
+                                       "com.atlassian.jira.plugin.system.customfieldtypes:datepicker",
+                                     "customId" => 10_081 },
+                                 "name" => "Expected Start",
+                                 "key" => "customfield_10081" },
+                             "customfield_10082" =>
+                               { "schema" =>
+                                   { "type" => "option",
+                                     "custom" =>
+                                       "com.atlassian.jira.plugin.system.customfieldtypes:select",
+                                     "customId" => 10_082 },
+                                 "name" => "Implementation Team",
+                                 "key" => "customfield_10082",
+                                 "allowedValues" =>
+                                   [{ "value" => "A16 CRM", "id" => "10044" },
+                                    { "value" => "A16 E2E-Test", "id" => "10045" },
+                                    { "value" => "A16 Logistic", "id" => "10048" },
+                                    { "value" => "A16 Platform", "id" => "10046" },
+                                    { "value" => "A16 Sys-Team", "id" => "10047" }] },
+                             "customfield_10020" =>
+                               { "schema" =>
+                                   { "type" => "array",
+                                     "items" => "json",
+                                     "custom" => "com.pyxis.greenhopper.jira:gh-sprint",
+                                     "customId" => 10_020 },
+                                 "name" => "Sprint",
+                                 "key" => "customfield_10020" },
+                             "customfield_10001" =>
+                               { "schema" =>
+                                   { "type" => "team",
+                                     "custom" =>
+                                       "com.atlassian.jira.plugin.system.customfieldtypes:atlassian-team",
+                                     "customId" => 10_001,
+                                     "configuration" =>
+                                       { "com.atlassian.jira.plugin.system.customfieldtypes:atlassian-team" =>
+                                           true } },
+                                 "name" => "Team",
+                                 "key" => "customfield_10001" } } },
+                       { "id" => "10007",
+                         "name" => "Bug",
+                         "untranslatedName" => "Bug",
+                         "subtask" => false,
+                         "fields" =>
+                           { "summary" =>
+                               { "schema" => { "type" => "string", "system" => "summary" },
+                                 "name" => "Summary",
+                                 "key" => "summary" },
+                             "customfield_10081" =>
+                               { "schema" =>
+                                   { "type" => "date",
+                                     "custom" =>
+                                       "com.atlassian.jira.plugin.system.customfieldtypes:datepicker",
+                                     "customId" => 10_081 },
+                                 "name" => "Expected Start",
+                                 "key" => "customfield_10081" },
+                             "customfield_10082" =>
+                               { "schema" =>
+                                   { "type" => "option",
+                                     "custom" =>
+                                       "com.atlassian.jira.plugin.system.customfieldtypes:select",
+                                     "customId" => 10_082 },
+                                 "name" => "Implementation Team",
+                                 "key" => "customfield_10082",
+                                 "allowedValues" =>
+                                   [{ "value" => "A16 CRM", "id" => "10044" },
+                                    { "value" => "A16 E2E-Test", "id" => "10045" },
+                                    { "value" => "A16 Logistic", "id" => "10048" },
+                                    { "value" => "A16 Platform", "id" => "10046" },
+                                    { "value" => "A16 Sys-Team", "id" => "10047" }] },
+                             "customfield_10020" =>
+                               { "schema" =>
+                                   { "type" => "array",
+                                     "items" => "json",
+                                     "custom" => "com.pyxis.greenhopper.jira:gh-sprint",
+                                     "customId" => 10_020 },
+                                 "name" => "Sprint",
+                                 "key" => "customfield_10020" },
+                             "customfield_10001" =>
+                               { "schema" =>
+                                   { "type" => "team",
+                                     "custom" =>
+                                       "com.atlassian.jira.plugin.system.customfieldtypes:atlassian-team",
+                                     "customId" => 10_001,
+                                     "configuration" =>
+                                       { "com.atlassian.jira.plugin.system.customfieldtypes:atlassian-team" =>
+                                           true } },
+                                 "name" => "Team",
+                                 "key" => "customfield_10001" },
+                             "environment" =>
+                               { "schema" => { "type" => "string", "system" => "environment" },
+                                 "name" => "Environment",
+                                 "key" => "environment" } } },
+                       { "id" => "10000",
+                         "name" => "Epic",
+                         "untranslatedName" => "Epic",
+                         "subtask" => false,
+                         "fields" =>
+                           { "summary" =>
+                               { "schema" => { "type" => "string", "system" => "summary" },
+                                 "name" => "Summary",
+                                 "key" => "summary" },
+                             "customfield_10081" =>
+                               { "schema" =>
+                                   { "type" => "date",
+                                     "custom" =>
+                                       "com.atlassian.jira.plugin.system.customfieldtypes:datepicker",
+                                     "customId" => 10_081 },
+                                 "name" => "Expected Start",
+                                 "key" => "customfield_10081" },
+                             "customfield_10082" =>
+                               { "schema" =>
+                                   { "type" => "option",
+                                     "custom" =>
+                                       "com.atlassian.jira.plugin.system.customfieldtypes:select",
+                                     "customId" => 10_082 },
+                                 "name" => "Implementation Team",
+                                 "key" => "customfield_10082",
+                                 "allowedValues" =>
+                                   [{ "value" => "A16 CRM", "id" => "10044" },
+                                    { "value" => "A16 E2E-Test", "id" => "10045" },
+                                    { "value" => "A16 Logistic", "id" => "10048" },
+                                    { "value" => "A16 Platform", "id" => "10046" },
+                                    { "value" => "A16 Sys-Team", "id" => "10047" }] },
+                             "customfield_10020" =>
+                               { "schema" =>
+                                   { "type" => "array",
+                                     "items" => "json",
+                                     "custom" => "com.pyxis.greenhopper.jira:gh-sprint",
+                                     "customId" => 10_020 },
+                                 "name" => "Sprint",
+                                 "key" => "customfield_10020" },
+                             "customfield_10001" =>
+                               { "schema" =>
+                                   { "type" => "team",
+                                     "custom" =>
+                                       "com.atlassian.jira.plugin.system.customfieldtypes:atlassian-team",
+                                     "customId" => 10_001,
+                                     "configuration" =>
+                                       { "com.atlassian.jira.plugin.system.customfieldtypes:atlassian-team" =>
+                                           true } },
+                                 "name" => "Team",
+                                 "key" => "customfield_10001" } } }] })]
+              end
+
+              let(:expected_table_rows) do
+                [
+                  ["Bug", "customfield_10001", "Team", "team", "n/a"],
+                  ["Bug", "customfield_10020", "Sprint", "array", "n/a"],
+                  ["Bug", "customfield_10081", "Expected Start", "date", "n/a"],
+                  ["Bug", "customfield_10082", "Implementation Team", "option",
+                   ["A16 CRM (10044)",
+                    "A16 E2E-Test (10045)",
+                    "A16 Logistic (10048)",
+                    "A16 Platform (10046)",
+                    "A16 Sys-Team (10047)"]],
+                  ["Bug", "environment", "Environment", "string", "n/a"],
+                  ["Bug", "summary", "Summary", "string", "n/a"],
+                  ["Epic", "customfield_10001", "Team", "team", "n/a"],
+                  ["Epic", "customfield_10020", "Sprint", "array", "n/a"],
+                  ["Epic", "customfield_10081", "Expected Start", "date", "n/a"],
+                  ["Epic", "customfield_10082", "Implementation Team", "option",
+                   ["A16 CRM (10044)",
+                    "A16 E2E-Test (10045)",
+                    "A16 Logistic (10048)",
+                    "A16 Platform (10046)",
+                    "A16 Sys-Team (10047)"]],
+                  ["Epic", "summary", "Summary", "string", "n/a"],
+                  ["Story", "customfield_10001", "Team", "team", "n/a"],
+                  ["Story", "customfield_10020", "Sprint", "array", "n/a"],
+                  ["Story", "customfield_10081", "Expected Start", "date", "n/a"],
+                  ["Story", "customfield_10082", "Implementation Team", "option",
+                   ["A16 CRM (10044)",
+                    "A16 E2E-Test (10045)",
+                    "A16 Logistic (10048)",
+                    "A16 Platform (10046)",
+                    "A16 Sys-Team (10047)"]],
+                  ["Story", "summary", "Summary", "string", "n/a"],
+                  ["Sub-task", "customfield_10001", "Team", "team", "n/a"],
+                  ["Sub-task", "customfield_10020", "Sprint", "array", "n/a"],
+                  ["Sub-task", "customfield_10081", "Expected Start", "date", "n/a"],
+                  ["Sub-task", "customfield_10082", "Implementation Team", "option",
+                   ["A16 CRM (10044)",
+                    "A16 E2E-Test (10045)",
+                    "A16 Logistic (10048)",
+                    "A16 Platform (10046)",
+                    "A16 Sys-Team (10047)"]],
+                  ["Sub-task", "summary", "Summary", "string", "n/a"],
+                  ["Task", "customfield_10001", "Team", "team", "n/a"],
+                  ["Task", "customfield_10020", "Sprint", "array", "n/a"],
+                  ["Task", "customfield_10081", "Expected Start", "date", "n/a"],
+                  ["Task", "customfield_10082", "Implementation Team", "option",
+                   ["A16 CRM (10044)",
+                    "A16 E2E-Test (10045)",
+                    "A16 Logistic (10048)",
+                    "A16 Platform (10046)",
+                    "A16 Sys-Team (10047)"]],
+                  ["Task", "summary", "Summary", "string", "n/a"]
+                ]
+              end
+
+              before do
+                allow(tool).to receive_messages(jira_client: jira_client)
+                allow(jira_client).to receive_messages(Createmeta: createmeta)
+              end
+
+              it { expect(ticket_fields.table_rows).to eq(expected_table_rows) }
+            end
+          end
+        end
+        # rubocop:enable Metrics/ClassLength
+      end
+    end
+  end
+end

data/spec/jira/auto/tool/project_spec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+require "jira/auto/tool/project"
+
+module Jira
+  module Auto
+    class Tool
+      class Project
+        RSpec.describe Project do
+          let(:tool) { instance_double(Tool, jira_client: jira_client) }
+          let(:jira_client) { instance_double(JIRA::Client) }
+
+          describe ".find" do
+            let(:jira_project) { jira_resource_double(JIRA::Resource::Project, key: "project_key") }
+            let(:actual_end_date) { described_class.find(tool, "project_key") }
+
+            before do
+              allow(jira_client)
+                .to receive_messages(Project: jira_resource_double("project_query", find: jira_project))
+            end
+
+            it { expect(actual_end_date.key).to eq("project_key") }
+            it { expect(actual_end_date).to be_a(described_class) }
+          end
+        end
+      end
+    end
+  end
+end

data/spec/jira/auto/tool/rate_limited_jira_client_spec.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "jira/auto/tool/rate_limited_jira_client"
+
+module Jira
+  module Auto
+    class Tool
+      class RateLimitedJiraClient
+        RSpec.describe RateLimitedJiraClient do
+          describe "#request" do
+            let(:client) { described_class.new({}, rate_interval:, rate_limit:) }
+            let(:rate_interval) { 2 }
+            let(:rate_limit) { 1 }
+            let(:oauth_client) { instance_double(JIRA::OauthClient, request: nil, consumer: nil) }
+            let(:rate_limiter) { instance_double(Ratelimit) }
+
+            before do
+              allow(described_class).to receive_messages(rate_limiter: rate_limiter)
+
+              allow(JIRA::OauthClient).to receive_messages(new: oauth_client)
+
+              allow(client).to receive_messages(original_request: :response)
+
+              allow(rate_limiter).to receive_messages(add: nil)
+              allow(rate_limiter).to receive(:exec_within_threshold).and_yield
+            end
+
+            it "returns the response" do
+              expect(client.request(:get, "/path/to/resource")).to eq(:response)
+            end
+
+            it "calls the original request method" do
+              client.request(:get, "/path/to/resource")
+
+              expect(client).to have_received(:original_request).with(:get, "/path/to/resource")
+            end
+
+            context "when it leverages the rate limiter" do
+              it "uses :exec_within_threshold to control rate limiting" do
+                allow(rate_limiter).to receive_messages(exec_within_threshold: nil)
+
+                4.times { client.request(:get, "/path/to/resource") }
+
+                expect(rate_limiter)
+                  .to have_received(:exec_within_threshold)
+                  .with("jira_auto_tool_api_requests", { interval: rate_interval, threshold: rate_limit })
+                  .exactly(4).times
+              end
+
+              it "adds keeps track of the rate limiter key calls" do
+                allow(rate_limiter).to receive_messages(add: nil)
+
+                4.times { client.request(:get, "/path/to/resource") }
+
+                expect(rate_limiter)
+                  .to have_received(:add)
+                  .with("jira_auto_tool_api_requests")
+                  .exactly(4).times
+              end
+            end
+
+            context "when it does not leverage the rate limiter" do
+              let(:rate_limit) { 0 }
+
+              it "does not use :exec_within_threshold to control rate limiting" do
+                client.request(:get, "/path/to/resource")
+
+                expect(rate_limiter).not_to have_received(:exec_within_threshold)
+              end
+
+              it "calls the original request method" do
+                client.request(:get, "/path/to/resource")
+
+                expect(client).to have_received(:original_request).with(:get, "/path/to/resource")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/jira/auto/tool/request_builder/field_context_fetcher_spec.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "rspec"
+require "jira/auto/tool/request_builder/field_context_fetcher"
+
+module Jira
+  module Auto
+    class Tool
+      class RequestBuilder
+        RSpec.describe FieldContextFetcher do
+          let(:field_context_fetcher) { described_class.new(jira_client, field) }
+
+          let(:field) do
+            instance_double(Field, jira_client: jira_client, name: "a field name", type: "option",
+                                   id: "customfield_10000")
+          end
+
+          let(:jira_client) do
+            instance_spy(JIRA::Client, options: { context_path: :a_context_path }).as_null_object
+          end
+
+          it do
+            expect(field_context_fetcher.send(:request_path))
+              .to eq("/rest/api/3/field/#{field.id}/context")
+          end
+
+          describe ".fetch_field_contexts" do
+            let(:id_name_pairs) do
+              [
+                [10_578, "a field context name"],
+                [10_792, "another field context name"],
+                [10_793, "yet another field context name"]
+              ]
+            end
+
+            let(:jira_field_contexts) { id_name_pairs.collect { |id, name| { "id" => id, "name" => name } } }
+
+            let(:actual_response) do
+              instance_double(Net::HTTPResponse, code: "200", body: { "values" => jira_field_contexts }.to_json)
+            end
+
+            let(:actual_field_contexts) { jira_field_contexts.collect(&:symbolize_keys) }
+
+            it "returns the actual field options" do
+              allow(jira_client).to receive_messages(send: actual_response)
+
+              expect(described_class.fetch_field_contexts(field)).to eq(actual_field_contexts)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/jira/auto/tool/request_builder/field_option_fetcher_spec.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "rspec"
+require "jira/auto/tool/request_builder/field_option_fetcher"
+
+module Jira
+  module Auto
+    class Tool
+      class RequestBuilder
+        RSpec.describe FieldOptionFetcher do
+          let(:field_option_fetcher) { described_class.new(jira_client, field, field_context) }
+          let(:jira_client) { instance_spy(JIRA::Client, options: { context_path: :a_context_path }).as_null_object }
+          let(:field_context) { { "id" => context_id, "name" => "a context name" }.symbolize_keys }
+
+          let(:field) do
+            instance_double(Field, jira_client: jira_client, name: "a field name", type: "option",
+                                   id: "customfield_10000")
+          end
+
+          let(:context_id) { "10567" }
+
+          before do
+            allow(FieldContextFetcher)
+              .to receive_messages(fetch_field_contexts: [field_context])
+          end
+
+          it do
+            expect(field_option_fetcher.send(:request_path))
+              .to eq("/rest/api/3/field/#{field.id}/context/#{context_id}/option")
+          end
+
+          # rubocop:disable RSpec/MultipleMemoizedHelpers
+          describe ".fetch_field_options" do
+            let(:id_value_pairs) do
+              [
+                ["option_id_128", "a field option value"],
+                ["option_id_256", "another field option value"],
+                ["option_id_512", "yet another field option value"]
+              ]
+            end
+
+            let(:jira_options) { id_value_pairs.collect { |id, value| { "id" => id, "value" => value } } }
+
+            let(:actual_response) do
+              instance_double(Net::HTTPResponse, code: "200", body: { "values" => jira_options }.to_json)
+            end
+
+            let(:actual_field_options) do
+              id_value_pairs.collect { |id, value| FieldOption.new(jira_client, id, value) }
+            end
+
+            it "returns the actual field options" do
+              allow(jira_client).to receive_messages(send: actual_response)
+              allow(field).to receive_messages(field_context: field_context)
+
+              expect(described_class.fetch_field_options(field)).to eq(actual_field_options)
+            end
+          end
+          # rubocop:enable RSpec/MultipleMemoizedHelpers
+        end
+      end
+    end
+  end
+end