jira-auto-tool 1.2.1 → 1.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (17) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +9 -47
  3. data/bin/setup +8 -0
  4. data/bin/setup-dev-win.bat +3 -0
  5. data/features/configure_environment.feature +8 -48
  6. data/features/create_sprints_using_existing_ones_as_reference.feature +3 -31
  7. data/lib/jira/auto/tool/environment_loader.rb +1 -25
  8. data/lib/jira/auto/tool/helpers/environment_based_value.rb +1 -6
  9. data/lib/jira/auto/tool/performer/planning_increment_sprint_creator.rb +3 -4
  10. data/lib/jira/auto/tool/version.rb +1 -1
  11. data/lib/jira/auto/tool.rb +21 -23
  12. data/lib/tasks/version.rake +1 -1
  13. data/spec/jira/auto/tool/environment_loader_spec.rb +9 -64
  14. data/spec/jira/auto/tool/performer/planning_increment_sprint_creator_spec.rb +13 -76
  15. data/spec/jira/auto/tool_spec.rb +4 -13
  16. metadata +5 -3
  17. data/ext/no_wrappers_win.rb +0 -6
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a991321a0f8768d42b913499a80fd76ff32cbea71f243e651c0097a6e9c1f10a
4
- data.tar.gz: 346c3e37814218b13f5b3cb57d74b0431655b9dbca95edf3406f7b1d036252b8
3
+ metadata.gz: 3251ceb453c396902d6db2a2b60d521ee62d63c2790def56a98bed4efffb08c1
4
+ data.tar.gz: ccc07c34fd13d46b9037d326b9fad1da98c1fe11c33918648e88461f994bc65d
5
5
  SHA512:
6
- metadata.gz: c66c77d800f993de4821e03711585976c1cb021258add0d2ee5cb940d7fa92915d66d1b8754a2a4f245d768bbf19b7e71d791673ac9d30b0cf6bff23bcaadfc8
7
- data.tar.gz: 8e3c54c724e47e4267a3ed4c65d23ff723a5c67764fdce38a05aae3ffdbc6a10d35691c4618fabc2b429a8f26af09e3303ac1004ffa0cc6ce94b1f0999b65b4c
6
+ metadata.gz: 13a44334523917299d28f617f873212696ec839fa37f64f9056fa811a60aa385641c4f37ea6a528ec459316a28899a03aad4de8162deee77a874db81a199b2bd
7
+ data.tar.gz: b910dbd81dfd35759b02d0e44b596b3a191bc6dc587342557ca7187ea233eea90d0761c93104e155e1ff17739f8f7c86e643eebfc6a6b6a4b7de27c135f22181
data/README.md CHANGED
@@ -4,33 +4,15 @@
4
4
  ![Main Workflow - all branches](https://github.com/cbroult/jira-auto-tool/actions/workflows/main.yml/badge.svg?label=Ruby%20-%20all%20branches)
5
5
 
6
6
  ****
7
- The purpose of this tool is to make it easier to make adjustments to the sprints of multiple teams.
7
+ The purpose of this tool it support managing the sprints of multiple teams so it is easier to adjust to changes.
8
8
  See the [feature files](./features) for some behavior examples.
9
9
 
10
10
  ## Table of Contents
11
11
 
12
- - [Principles](#principles)
13
- - [Installation](#installation)
14
- - [Setup](#setup)
15
- - [Usage](#usage)
16
- - [Warning](#warning)
17
- - [Add Sprints](#add-sprints)
18
- - [Adjusting The End Date Of Sprints](#adjusting-the-end-date-of-sprints)
19
- - [Align Time In Sprint Dates](#align-time-in-sprint-dates)
20
- - [List Sprints](#list-sprints)
21
- - [List Sprint Prefixes (Teams)](#list-sprint-prefixes-teams)
22
- - [Rename Sprints](#rename-sprints)
23
- - [Team Sprint Mapping](#team-sprint-mapping)
24
- - [Team Ticket Sprint Dispatching](#team-ticket-sprint-dispatching)
25
- - [Development](#development)
26
- - [Install Dependencies](#install-dependencies)
27
- - [Continuous Testing While Making Changes](#continuous-testing-while-making-changes)
28
- - [Experiment Using An Interactive Prompt](#experiment-using-an-interactive-prompt)
29
- - [Install Locally](#install-locally)
30
- - [Release](#release)
31
- - [Contributing](#contributing)
32
- - [License](#license)
33
- - [Code of Conduct](#code-of-conduct)
12
+ <!-- Generated using jekyll-toc -->
13
+
14
+ * TOC
15
+ {:toc}
34
16
 
35
17
  ## Principles
36
18
 
@@ -67,7 +49,7 @@ will use the existing ones as a reference for the prefix and the length of the s
67
49
  ```
68
50
  2. Adjust the file to your context.
69
51
 
70
- The following environment variables have to be set to use this tool. **Except** for the `JIRA_API_TOKEN` that should
52
+ The following environment variables have to be set to use this tool. **Except** for te `JIRA_API_TOKEN` that should
71
53
  be done via the configuration file.
72
54
 
73
55
  Some explanations:
@@ -90,9 +72,9 @@ Optional environment variables:
90
72
  See [sprint filtering](./features/sprint_filtering.feature).
91
73
  - `JIRA_CONTEXT_PATH` - Context path for Jira instance (if needed typically "/jira").
92
74
  - `JIRA_HTTP_DEBUG` - Enable HTTP debug logging (set to "true" or "false").
93
- - `JAT_RATE_INTERVAL_IN_SECONDS` - Interval for rate limiting in seconds (e.g., "1").
94
75
  - `JAT_RATE_LIMIT_PER_INTERVAL` - Rate limit for Jira API calls (e.g., "1")
95
- See [Control Jira HTTP request rate](./features/control_http_request_rate_limit.feature).
76
+ See [Control Jira HTTP request rate.](./features/control_http_request_rate_limit.feature).
77
+ - `JAT_RATE_INTERVAL_IN_SECONDS` - Interval for rate limiting in seconds (e.g., "1").
96
78
 
97
79
  ## Usage
98
80
 
@@ -124,15 +106,6 @@ to the teams respective sprint prefixes.
124
106
  jira-auto-tool --sprint-add=25.4.3,4
125
107
  ```
126
108
 
127
- ### Adjusting The End Date Of Sprints
128
-
129
- The following is going to
130
- [adjust the end date of sprints](./features/update_sprint_end_date_and_shift_following_ones.feature)
131
- named `sprint_prefix_25.1.5` and shift the subsequent ones by adjust their start and end dates:
132
- ```bash
133
- jira-auto-tool --sprint-update-end-date=25.1.5,"2025-02-25 16:00:00 UTC"
134
- ```
135
-
136
109
  ### Align Time In Sprint Dates
137
110
 
138
111
  ````bash
@@ -197,18 +170,7 @@ To install this gem onto your local machine, run `bundle exec rake install`.
197
170
 
198
171
  ### Release
199
172
 
200
- 1. Bump the gem version:
201
- ```bash
202
- bundle exec rake version:bump[{major|minor|patch}]
203
- ```
204
- 2. Release the version to [rubygems.org](https://rubygems.org):
205
- ```bash
206
- bundle exec rake release
207
- ```
208
- which will:
209
- * create a git tag for the version
210
- * push git commits and the created tag
211
- * push the `.gem` file to [rubygems.org](https://rubygems.org).
173
+ To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
212
174
 
213
175
  ## Contributing
214
176
 
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/bin/setup-dev-win.bat ADDED
@@ -0,0 +1,3 @@
1
+
2
+
3
+ choco install act-cli
data/features/configure_environment.feature CHANGED
@@ -63,7 +63,7 @@ Feature: Environment Configuration Management
63
63
  Please remove first before running this again!
64
64
  """
65
65
 
66
- Scenario: Tool successfully loads the config from the current directory and hides secret values when listing them
66
+ Scenario: Tool successfully loads the config
67
67
  Given a file named "jira-auto-tool.env.yaml.erb" with:
68
68
  """
69
69
  ---
@@ -104,7 +104,7 @@ Feature: Environment Configuration Management
104
104
  | JAT_RATE_LIMIT_IMPLEMENTATION | |
105
105
  | JAT_RATE_LIMIT_PER_INTERVAL | |
106
106
  | JAT_TICKETS_FOR_TEAM_SPRINT_TICKET_DISPATCHER_JQL | project = PROJ AND Sprint IS EMPTY |
107
- | JIRA_API_TOKEN | **** |
107
+ | JIRA_API_TOKEN | current API TOKEN |
108
108
  | JIRA_BOARD_NAME | Team Board |
109
109
  | JIRA_BOARD_NAME_REGEX | ART 16|unconventional board name |
110
110
  | JIRA_CONTEXT_PATH | /jira |
@@ -116,7 +116,7 @@ Feature: Environment Configuration Management
116
116
  +---------------------------------------------------+------------------------------------+
117
117
  """
118
118
 
119
- Scenario: Tool looks first for configuration in the current directory (hiding secret when listing)
119
+ Scenario: Tool looks first for configuration in the current directory
120
120
  Given a file named "./jira-auto-tool.env.yaml.erb" with:
121
121
  """
122
122
  ---
@@ -136,16 +136,8 @@ Feature: Environment Configuration Management
136
136
  """
137
137
  Using configuration from ./jira-auto-tool.env.yaml.erb
138
138
  """
139
- And the output should match:
140
- """
141
- JIRA_API_TOKEN\s+\|\s\*{4}
142
- """
143
- And the output should match:
144
- """
145
- JIRA_USERNAME\s+\|\scurrent@company.com
146
- """
147
139
 
148
- Scenario: Tool looks for home directory config folder when no config file in the current directory (hiding secret when listing)
140
+ Scenario: Tool looks for home directory config folder when no config file in the current directory
149
141
  Given a file named "./jira-auto-tool.env.yaml.erb" does not exist
150
142
  And a file named "~/.config/jira-auto-tool/jira-auto-tool.env.yaml.erb" with:
151
143
  """
@@ -158,23 +150,14 @@ Feature: Environment Configuration Management
158
150
  """
159
151
  Using configuration from .+/.config/jira-auto-tool/jira-auto-tool.env.yaml.erb
160
152
  """
161
- And the output should match:
162
- """
163
- JIRA_API_TOKEN\s+\|\s\*{4}\s+
164
- """
165
- And the output should match:
166
- """
167
- JIRA_USERNAME\s+\|\shome@company.com
168
- """
169
153
 
170
- Scenario: Tool uses the existing environment values if no config file found (hiding secret when listing)
154
+ Scenario: Tool uses the existing environment values if no config file found
171
155
  Given the following files should not exist:
172
156
  | ./jira-auto-tool.env.yaml.erb |
173
157
  | ~/.config/jira-auto-tool/jira-auto-tool.env.yaml.erb |
174
158
  And the following environment variables are set:
175
- | name | value |
176
- | JIRA_API_TOKEN | token-value |
177
- | JIRA_USERNAME | env@company.com |
159
+ | name | value |
160
+ | JIRA_API_TOKEN | token-value |
178
161
  When I successfully run `jira-auto-tool --env-list`
179
162
  Then the output should match:
180
163
  """
@@ -184,28 +167,5 @@ Feature: Environment Configuration Management
184
167
  """
185
168
  And the output should match:
186
169
  """
187
- JIRA_API_TOKEN\s+\|\s\*{4}
188
- """
189
- And the output should match:
190
- """
191
- JIRA_USERNAME\s+\|\senv@company.com
170
+ JIRA_API_TOKEN\s+|token-value\s+
192
171
  """
193
-
194
- Scenario: Tool displays a useful error message in case of error
195
- Given a file named "./jira-auto-tool.env.yaml.erb" with:
196
- """
197
- ---
198
- JIRA_USERNAME: "error@company.com"
199
- JIRA_API_TOKEN: "error-token"
200
- JIRA_SITE_URL: "https://home.atlassian.net"
201
- <%
202
- raise "This is meant to fail while loading!"
203
- %>
204
- """
205
- When I run `jira-auto-tool --env-list`
206
- Then it should fail with:
207
- """
208
- ERROR Jira::Auto::Tool::EnvironmentLoader : ./jira-auto-tool.env.yaml.erb:6: failed to load with the following error:
209
- This is meant to fail while loading!
210
- """
211
-
data/features/create_sprints_using_existing_ones_as_reference.feature CHANGED
@@ -5,14 +5,14 @@ Feature: Add sprints using existing ones as reference
5
5
 
6
6
  Background:
7
7
  Given a Jira Scrum board
8
-
9
- Scenario: Add several sprints using existing sprint prefixes
10
- Given the board only has the following sprints:
8
+ And the board only has the following sprints:
11
9
  | comment | name | length | start_date | state |
12
10
  | none added since closed | Food_Supply_25.1.3 | 2-week | 2025-02-01 11:00:00 UTC | closed |
13
11
  | "sprints | Food_Delivery_25.1.4 | 4-day | 2025-02-01 11:00:00 UTC | future |
14
12
  | expected to be | Food_Market_25.2.1 | 3-week | 2025-02-01 11:00:00 UTC | active |
15
13
  | added" | Food_Restaurant_25.2.1 | 4-week | 2025-02-21 11:00:00 UTC | future |
14
+
15
+ Scenario: Add several sprints using existing sprint prefixes
16
16
  When I successfully run `jira-auto-tool --sprint-add=25.3.1,4`
17
17
  Then afterwards the board only has the following sprints:
18
18
  | name | start_date | state |
@@ -34,12 +34,6 @@ Feature: Add sprints using existing ones as reference
34
34
  | Food_Restaurant_25.3.4 | 2025-06-13 11:00:00 UTC | future |
35
35
 
36
36
  Scenario: Add several planning interval sprints
37
- Given the board only has the following sprints:
38
- | comment | name | length | start_date | state |
39
- | none added since closed | Food_Supply_25.1.3 | 2-week | 2025-02-01 11:00:00 UTC | closed |
40
- | "sprints | Food_Delivery_25.1.4 | 4-day | 2025-02-01 11:00:00 UTC | future |
41
- | expected to be | Food_Market_25.2.1 | 3-week | 2025-02-01 11:00:00 UTC | active |
42
- | added" | Food_Restaurant_25.2.1 | 4-week | 2025-02-21 11:00:00 UTC | future |
43
37
  When I successfully run `jira-auto-tool --sa=25.2.2,3 --sa=25.3.1,4 --sa=25.4.1,5`
44
38
  Then afterwards the board only has the following sprints:
45
39
  | name | start_date | state |
@@ -83,25 +77,3 @@ Feature: Add sprints using existing ones as reference
83
77
  | Food_Restaurant_25.4.3 | 2025-11-28 11:00:00 UTC | future |
84
78
  | Food_Restaurant_25.4.4 | 2025-12-26 11:00:00 UTC | future |
85
79
  | Food_Restaurant_25.4.5 | 2026-01-23 11:00:00 UTC | future |
86
-
87
- Scenario: Adding sprints is not creating duplicates or ones anterior to last sprints of prefixes
88
- Given the board only has the following sprints:
89
- | comment | name | length | start_date | state |
90
- | none added since closed | Food_Supply_25.1.3 | 2-week | 2025-02-01 11:00:00 UTC | closed |
91
- | all sprints added | Food_Delivery_25.1.4 | 4-day | 2025-02-01 11:00:00 UTC | future |
92
- | the last 3 added since the first already exist | Food_Market_25.2.1 | 3-week | 2025-02-01 11:00:00 UTC | active |
93
- | none added because would be anterior existing sprint | Food_Restaurant_25.3.1 | 4-week | 2025-02-21 11:00:00 UTC | future |
94
- When I successfully run `jira-auto-tool --sa=25.2.1,4`
95
- Then afterwards the board only has the following sprints:
96
- | name | start_date | state |
97
- | Food_Supply_25.1.3 | 2025-02-01 11:00:00 UTC | closed |
98
- | Food_Delivery_25.1.4 | 2025-02-01 11:00:00 UTC | future |
99
- | Food_Delivery_25.2.1 | 2025-02-05 11:00:00 UTC | future |
100
- | Food_Delivery_25.2.2 | 2025-02-09 11:00:00 UTC | future |
101
- | Food_Delivery_25.2.3 | 2025-02-13 11:00:00 UTC | future |
102
- | Food_Delivery_25.2.4 | 2025-02-17 11:00:00 UTC | future |
103
- | Food_Market_25.2.1 | 2025-02-01 11:00:00 UTC | active |
104
- | Food_Market_25.2.2 | 2025-02-22 11:00:00 UTC | future |
105
- | Food_Market_25.2.3 | 2025-03-15 11:00:00 UTC | future |
106
- | Food_Market_25.2.4 | 2025-04-05 11:00:00 UTC | future |
107
- | Food_Restaurant_25.3.1 | 2025-02-21 11:00:00 UTC | future |
data/lib/jira/auto/tool/environment_loader.rb CHANGED
@@ -46,18 +46,11 @@ module Jira
46
46
  def tool_environment
47
47
  Environment.constants.sort.to_h do |constant|
48
48
  constant_as_string = constant.to_s
49
- actual_value = ENV.fetch(constant_as_string, nil)
50
- value_to_display = environment_variable_holds_a_secret?(constant_as_string) ? "****" : actual_value
51
49
 
52
- [constant_as_string, value_to_display]
50
+ [constant_as_string, ENV.fetch(constant_as_string, nil)]
53
51
  end
54
52
  end
55
53
 
56
- def environment_variable_holds_a_secret?(env_var_name)
57
- method_name = env_var_name.to_s.downcase
58
- tool.send("#{method_name}_holds_a_secret?")
59
- end
60
-
61
54
  def file_path
62
55
  File.exist?(current_dir_file_path) ? current_dir_file_path : config_dir_file_path
63
56
  end
@@ -88,27 +81,10 @@ module Jira
88
81
 
89
82
  def config_values
90
83
  @config_values ||= YAML.safe_load(config_file_content) || {}
91
- rescue StandardError => e
92
- error_line = e.backtrace_locations.first.lineno
93
- message = <<~EOEMSG
94
- #{file_path}:#{error_line}: failed to load with the following error:
95
- #{e.message}
96
- EOEMSG
97
-
98
- raise message
99
84
  end
100
85
 
101
86
  def config_file_content
102
87
  @config_file_content ||= File.exist?(file_path) ? ERB.new(File.read(file_path)).result(binding) : ""
103
- rescue StandardError => e
104
- error_line = e.backtrace_locations.first.lineno
105
-
106
- message = <<~EOEMSG
107
- #{file_path}:#{error_line}: failed to load with the following error:
108
- #{e.message}
109
- EOEMSG
110
-
111
- raise message
112
88
  end
113
89
 
114
90
  def table
data/lib/jira/auto/tool/helpers/environment_based_value.rb CHANGED
@@ -6,13 +6,12 @@ module Jira
6
6
  module Helpers
7
7
  module EnvironmentBasedValue
8
8
  # TODO: overly complex - simplify by moving this to the Config and define a Configurable module
9
- def define_overridable_environment_based_value(method_name, holds_a_secret)
9
+ def define_overridable_environment_based_value(method_name)
10
10
  define_reader(method_name)
11
11
  define_predicate(method_name)
12
12
  define_reader_accepting_default_value(method_name)
13
13
  define_writer(method_name)
14
14
  define_environment_variable_name_constant(method_name)
15
- define_holds_a_secret_predicate(method_name, holds_a_secret)
16
15
  end
17
16
 
18
17
  def define_reader(method_name)
@@ -33,10 +32,6 @@ module Jira
33
32
  end
34
33
  end
35
34
 
36
- def define_holds_a_secret_predicate(method_name, holds_a_secret)
37
- define_method(:"#{method_name}_holds_a_secret?") { holds_a_secret }
38
- end
39
-
40
35
  def define_reader_accepting_default_value(method_name)
41
36
  define_method(:"#{method_name}_when_defined_else") do |value|
42
37
  if config.key?(method_name)
data/lib/jira/auto/tool/performer/planning_increment_sprint_creator.rb CHANGED
@@ -21,10 +21,9 @@ module Jira
21
21
  parsed_new_name = Sprint::Name.new_with(sprint_prefix.name, sprint_suffix)
22
22
 
23
23
  iteration_count.times do |_iteration|
24
- unless parsed_new_name <= last_sprint.parsed_name
25
- last_sprint = create_sprint_for(last_sprint, parsed_new_name.to_s)
26
- sprint_prefix << last_sprint
27
- end
24
+ last_sprint = create_sprint_for(last_sprint, parsed_new_name.to_s)
25
+
26
+ sprint_prefix << last_sprint
28
27
 
29
28
  parsed_new_name = parsed_new_name.next_in_planning_interval
30
29
  end
data/lib/jira/auto/tool/version.rb CHANGED
@@ -3,7 +3,7 @@
3
3
  module Jira
4
4
  module Auto
5
5
  class Tool
6
- VERSION = "1.2.1"
6
+ VERSION = "1.2.3"
7
7
  end
8
8
  end
9
9
  end
data/lib/jira/auto/tool.rb CHANGED
@@ -139,29 +139,27 @@ module Jira
139
139
  jira_base_url + url
140
140
  end
141
141
 
142
- HOLDS_A_SECRET = true
143
- ENVIRONMENT_BASED_VALUE_SYMBOLS =
144
- ([[:jira_api_token, HOLDS_A_SECRET]] + %i[
145
- art_sprint_regex
146
- expected_start_date_field_name
147
- implementation_team_field_name
148
- jat_rate_interval_in_seconds
149
- jat_rate_limit_implementation
150
- jat_rate_limit_per_interval
151
- jat_tickets_for_team_sprint_ticket_dispatcher_jql
152
- jira_board_name
153
- jira_board_name_regex
154
- jira_context_path
155
- jira_http_debug
156
- jira_project_key
157
- jira_site_url
158
- jira_sprint_field_name
159
- jira_username
160
- ].collect { |value_name| [value_name, !HOLDS_A_SECRET] }).freeze
161
-
162
- ENVIRONMENT_BASED_VALUE_SYMBOLS.each do |method_name, holds_a_secret|
163
- holds_a_secret ||= false
164
- define_overridable_environment_based_value(method_name, holds_a_secret)
142
+ ENVIRONMENT_BASED_VALUE_SYMBOLS = %i[
143
+ art_sprint_regex
144
+ expected_start_date_field_name
145
+ implementation_team_field_name
146
+ jat_rate_interval_in_seconds
147
+ jat_rate_limit_implementation
148
+ jat_rate_limit_per_interval
149
+ jat_tickets_for_team_sprint_ticket_dispatcher_jql
150
+ jira_api_token
151
+ jira_board_name
152
+ jira_board_name_regex
153
+ jira_context_path
154
+ jira_http_debug
155
+ jira_project_key
156
+ jira_site_url
157
+ jira_sprint_field_name
158
+ jira_username
159
+ ].freeze
160
+
161
+ ENVIRONMENT_BASED_VALUE_SYMBOLS.each do |method_name|
162
+ define_overridable_environment_based_value(method_name)
165
163
  end
166
164
 
167
165
  def board_controller
data/lib/tasks/version.rake CHANGED
@@ -29,7 +29,7 @@ end
29
29
  def amend_commit_to_include_gemfile_lock_changes
30
30
  puts "Amending commit to include Gemfile.lock update..."
31
31
  system("git add .")
32
- system("git commit --amend --no-edit")
32
+ system(%(git commit --amend --no-edit))
33
33
  end
34
34
 
35
35
  namespace :version do
data/spec/jira/auto/tool/environment_loader_spec.rb CHANGED
@@ -5,7 +5,6 @@ require "rspec"
5
5
  module Jira
6
6
  module Auto
7
7
  class Tool
8
- # rubocop:disable Metrics/ClassLength
9
8
  class EnvironmentLoader
10
9
  RSpec.describe EnvironmentLoader do
11
10
  let(:environment_loader) { described_class.new(tool, auto_setup: auto_setup) }
@@ -57,7 +56,7 @@ module Jira
57
56
  end
58
57
 
59
58
  describe "#tool_environment" do
60
- let(:environment_keys) { %i[JIRA_SITE_URL JIRA_USERNAME JIRA_API_TOKEN] }
59
+ let(:environment_keys) { %i[JIRA_HOST JIRA_USER JIRA_PASSWORD] }
61
60
 
62
61
  before do
63
62
  allow(Environment).to receive(:constants).and_return(environment_keys)
@@ -65,29 +64,14 @@ module Jira
65
64
  environment_keys.each do |environment_key|
66
65
  allow(ENV).to receive(:fetch).with(environment_key.to_s, nil).and_return("#{environment_key} value")
67
66
  end
68
-
69
- allow(tool).to receive_messages(
70
- jira_api_token_holds_a_secret?: true,
71
- jira_site_url_holds_a_secret?: false,
72
- jira_username_holds_a_secret?: false
73
- )
74
67
  end
75
68
 
76
69
  it do
77
- expect(environment_loader.tool_environment)
78
- .to eq(
79
- "JIRA_API_TOKEN" => "****",
80
- "JIRA_SITE_URL" => "JIRA_SITE_URL value",
81
- "JIRA_USERNAME" => "JIRA_USERNAME value"
82
- )
83
- end
84
- end
85
-
86
- describe "#environment_variable_holds_a_secret?" do
87
- it "allows checking that the corresponding constant is a secret or not" do
88
- allow(tool).to receive(:jira_api_token_holds_a_secret?).and_return(true)
89
-
90
- expect(environment_loader).to be_environment_variable_holds_a_secret("JIRA_API_TOKEN")
70
+ expect(environment_loader.tool_environment).to eq(
71
+ "JIRA_HOST" => "JIRA_HOST value",
72
+ "JIRA_USER" => "JIRA_USER value",
73
+ "JIRA_PASSWORD" => "JIRA_PASSWORD value"
74
+ )
91
75
  end
92
76
  end
93
77
 
@@ -148,12 +132,10 @@ module Jira
148
132
  end
149
133
 
150
134
  describe "#setup" do
151
- before do
152
- allow(environment_loader).to receive_messages(file_path: "path/to/config/file.yaml")
135
+ it "sets up the value according to the configuration file content" do
136
+ allow(environment_loader).to receive_messages(file_path: "file_path")
153
137
  allow(environment_loader).to receive_messages(config_file_content: "file_content")
154
- end
155
138
 
156
- it "sets up the value according to the configuration file content" do
157
139
  allow(YAML)
158
140
  .to receive(:safe_load)
159
141
  .with("file_content")
@@ -165,25 +147,10 @@ module Jira
165
147
 
166
148
  environment_loader.send(:setup)
167
149
  end
168
-
169
- context "when the YAML parsing fails" do
170
- it "generates an error message including the file name" do
171
- allow(YAML).to receive(:safe_load)
172
- .with("file_content")
173
- .and_raise(RuntimeError, "could not find expected ':' at line 3 column 6)")
174
-
175
- expect { environment_loader.send(:setup) }
176
- .to raise_error(RuntimeError, <<~EOEMSG
177
- path/to/config/file.yaml:188: failed to load with the following error:
178
- could not find expected ':' at line 3 column 6)
179
- EOEMSG
180
- )
181
- end
182
- end
183
150
  end
184
151
 
185
152
  describe "#config_file_content" do
186
- let(:file_path) { "path/to/config/file" }
153
+ let(:file_path) { "file_path" }
187
154
  let(:file_content) do
188
155
  <<-YAML_ERB
189
156
  ---
@@ -207,31 +174,9 @@ module Jira
207
174
  end
208
175
 
209
176
  it { expect(environment_loader.send(:config_file_content)).to eq(erb_result) }
210
-
211
- context "when the ERB evaluation fails" do
212
- let(:file_content) do
213
- <<-YAML_ERB
214
- ---
215
- a_key: <%= 4*4 %>
216
- another_key: <%= 4*4 %>
217
- <%
218
- raise "An error that should be caught and reported!"#{" "}
219
- %>
220
- YAML_ERB
221
- end
222
-
223
- it "generates an error message including the file name" do
224
- expect { environment_loader.send(:config_file_content) }
225
- .to raise_error(RuntimeError, <<~EOEMSG)
226
- path/to/config/file:5: failed to load with the following error:
227
- An error that should be caught and reported!
228
- EOEMSG
229
- end
230
- end
231
177
  end
232
178
  end
233
179
  end
234
- # rubocop:enable Metrics/ClassLength
235
180
  end
236
181
  end
237
182
  end
data/spec/jira/auto/tool/performer/planning_increment_sprint_creator_spec.rb CHANGED
@@ -33,90 +33,27 @@ module Jira
33
33
  end
34
34
  end
35
35
 
36
- # rubocop:disable Naming/VariableNumber, RSpec/IndexedLet
37
36
  describe "#act_on_sprints_for_sprint_prefix" do
38
- def get_sprint(name, attributes = {})
39
- instance_double(Sprint, name: name, to_s: name, **attributes,
40
- parsed_name: Sprint::Name.parse(name))
37
+ def get_sprint(name, attributes)
38
+ instance_double(Sprint, name: name, to_s: name, **attributes)
41
39
  end
42
40
 
43
- let(:sprint_prefix) do
44
- instance_double(Sprint::Prefix, name: "Food_Delivery", last_sprint: last_sprint)
45
- end
46
-
47
- context "when the sprints to create are all posterior to the last sprint from a naming perspective" do
48
- let(:last_sprint) do
49
- get_sprint "Food_Delivery_25.2.1", end_date: "2025-02-16 12:45", length_in_days: 10
50
- end
51
-
52
- let(:sprint_25_3_1) { get_sprint("Food_Delivery_25.3.1") }
53
- let(:sprint_25_3_2) { get_sprint("Food_Delivery_25.3.2") }
54
- let(:sprint_25_3_3) { get_sprint("Food_Delivery_25.3.3") }
55
- let(:sprint_25_3_4) { get_sprint("Food_Delivery_25.3.4") }
56
-
57
- before do
58
- allow(updater).to receive(:create_sprint_for).with(last_sprint,
59
- "Food_Delivery_25.3.1")
60
- .and_return(sprint_25_3_1)
61
-
62
- allow(updater).to receive(:create_sprint_for).with(sprint_25_3_1, "Food_Delivery_25.3.2")
63
- .and_return(sprint_25_3_2)
64
-
65
- allow(updater).to receive(:create_sprint_for).with(sprint_25_3_2, "Food_Delivery_25.3.3")
66
- .and_return(sprint_25_3_3)
67
-
68
- allow(updater).to receive(:create_sprint_for).with(sprint_25_3_3, "Food_Delivery_25.3.4")
69
- .and_return(sprint_25_3_4)
70
- end
71
-
72
- it "creates the expected number of sprints with the expected names" do
73
- expect(sprint_prefix).to receive(:<<).with(sprint_25_3_1)
74
- expect(sprint_prefix).to receive(:<<).with(sprint_25_3_2)
75
- expect(sprint_prefix).to receive(:<<).with(sprint_25_3_3)
76
- expect(sprint_prefix).to receive(:<<).with(sprint_25_3_4)
77
-
78
- updater.act_on_sprints_for_sprint_prefix(sprint_prefix)
79
- end
80
- end
81
-
82
- context "when some sprints to create are anterior to the last sprint from a naming perspective" do
83
- let(:last_sprint) do
84
- get_sprint "Food_Delivery_25.3.2", end_date: "2025-02-16 12:45", length_in_days: 10
85
- end
86
-
87
- let(:sprint_25_3_3) { get_sprint("Food_Delivery_25.3.3") }
88
- let(:sprint_25_3_4) { get_sprint("Food_Delivery_25.3.4") }
89
-
90
- before do
91
- allow(updater).to receive(:create_sprint_for).with(last_sprint, "Food_Delivery_25.3.3")
92
- .and_return(sprint_25_3_3)
93
-
94
- allow(updater).to receive(:create_sprint_for).with(sprint_25_3_3, "Food_Delivery_25.3.4")
95
- .and_return(sprint_25_3_4)
96
- end
97
-
98
- it "only creates the ones posterior to the last sprint" do
99
- expect(sprint_prefix).to receive(:<<).with(sprint_25_3_3)
100
- expect(sprint_prefix).to receive(:<<).with(sprint_25_3_4)
101
-
102
- updater.act_on_sprints_for_sprint_prefix(sprint_prefix)
103
- end
104
- end
41
+ let(:last_sprint) { get_sprint "Food_Delivery_25.2.1", end_date: "2025-02-16 12:45", length_in_days: 10 }
105
42
 
106
- context "when requested sprints to create are anterior to the last sprint from a naming perspective" do
107
- let(:last_sprint) do
108
- get_sprint "Food_Delivery_25.4.1", end_date: "2025-02-16 12:45", length_in_days: 10
109
- end
43
+ let(:sprint_prefix) { instance_double(Sprint::Prefix, name: "Food_Delivery", last_sprint: last_sprint) }
110
44
 
111
- it "does not create any since they would be anterior to the last sprint" do
112
- expect(updater).not_to receive(:create_sprint_for)
113
- expect(sprint_prefix).not_to receive(:<<)
45
+ # rubocop:disable RSpec/MultipleExpectations
46
+ it "creates the expected number of sprints with the expected names" do
47
+ expect(updater).to receive(:create_sprint_for).ordered.with(last_sprint, "Food_Delivery_25.3.1")
48
+ expect(updater).to receive(:create_sprint_for).ordered.with(nil, "Food_Delivery_25.3.2")
49
+ expect(updater).to receive(:create_sprint_for).ordered.with(nil, "Food_Delivery_25.3.3")
50
+ expect(updater).to receive(:create_sprint_for).ordered.with(nil, "Food_Delivery_25.3.4")
51
+ expect(sprint_prefix).to receive(:<<).exactly(4).times
114
52
 
115
- updater.act_on_sprints_for_sprint_prefix(sprint_prefix)
116
- end
53
+ updater.act_on_sprints_for_sprint_prefix(sprint_prefix)
117
54
  end
55
+ # rubocop:enable RSpec/MultipleExpectations
118
56
  end
119
- # rubocop:enable Naming/VariableNumber, RSpec/IndexedLet
120
57
  end
121
58
  end
122
59
  end
data/spec/jira/auto/tool_spec.rb CHANGED
@@ -136,7 +136,7 @@ module Jira
136
136
  end
137
137
 
138
138
  # TODO: move that to environment_based_value_spec
139
- RSpec.shared_examples "an overridable environment based value" do |method_name, holds_a_secret_expectation|
139
+ RSpec.shared_examples "an overridable environment based value" do |method_name|
140
140
  let(:env_var_name) { method_name.to_s.upcase }
141
141
  let(:method_name?) { :"#{method_name}_defined?" }
142
142
  let(:config) { Config.new(object_with_overridable_value) }
@@ -146,13 +146,6 @@ module Jira
146
146
  allow(config).to receive_messages(value_store: {})
147
147
  end
148
148
 
149
- context "when dealing with sensitive information" do
150
- it "defines a predicate informing about the value being a secret or not" do
151
- expect(object_with_overridable_value.send("#{method_name}_holds_a_secret?"))
152
- .to eq(holds_a_secret_expectation)
153
- end
154
- end
155
-
156
149
  context "when the environment variable is set" do
157
150
  let(:expected_value) { "#{env_var_name} env_value" }
158
151
 
@@ -229,13 +222,11 @@ module Jira
229
222
  end
230
223
  end
231
224
 
232
- described_class::ENVIRONMENT_BASED_VALUE_SYMBOLS.each do |method_name, holds_a_secret|
233
- holds_a_secret ||= false
234
-
235
- describe "environment based values - #{method_name} - holds_a_secret = #{holds_a_secret}}" do
225
+ described_class::ENVIRONMENT_BASED_VALUE_SYMBOLS.each do |method_name|
226
+ describe "environment based values" do
236
227
  let(:object_with_overridable_value) { tool }
237
228
 
238
- it_behaves_like "an overridable environment based value", method_name, holds_a_secret
229
+ it_behaves_like "an overridable environment based value", method_name
239
230
  end
240
231
  end
241
232
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jira-auto-tool
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.2.1
4
+ version: 1.2.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Christophe Broult
@@ -209,6 +209,7 @@ email:
209
209
  - cbroult@yahoo.com
210
210
  executables:
211
211
  - jira-auto-tool
212
+ - setup
212
213
  extensions: []
213
214
  extra_rdoc_files: []
214
215
  files:
@@ -222,12 +223,13 @@ files:
222
223
  - Rakefile
223
224
  - bin/jira-auto-tool
224
225
  - bin/jira-auto-tool.bat
226
+ - bin/setup
227
+ - bin/setup-dev-win.bat
225
228
  - config/examples/jira-auto-tool.env.yaml.erb
226
229
  - cucumber.yml
227
230
  - documentation/JiraToolClassDiagram.uml
228
231
  - documentation/class_diagram.md
229
232
  - documentation/principle.md
230
- - ext/no_wrappers_win.rb
231
233
  - features/align_sprint_time_in_dates.feature
232
234
  - features/assign_tickets_to_team_sprints.feature
233
235
  - features/cache_boards.feature
@@ -384,7 +386,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
384
386
  - !ruby/object:Gem::Version
385
387
  version: '0'
386
388
  requirements: []
387
- rubygems_version: 3.6.8
389
+ rubygems_version: 3.6.9
388
390
  specification_version: 4
389
391
  summary: Automate making adjustments to Jira sprints for multiple teams following
390
392
  some naming conventions.
data/ext/no_wrappers_win.rb DELETED
@@ -1,6 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # Disable wrappers only on Windows
4
- puts "Disabling wrappers for Windows installation"
5
- RubyGems.configuration.wrappers = false
6
- exit 0