tefoji 3.1.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f21e85163dfc8f1b659b53e940406ad91008dad1f0f1d3244418ff67541f89a0
-  data.tar.gz: b8f8c785e16325f553a62b11bfe92ff5ba9164a37f6045f2468ebfb68152b569
+  metadata.gz: 7de8bcf06db002032d9477d09b5db5b033d2e8ccfdd4a23d4593ae3b1905f6ec
+  data.tar.gz: 2fa6bcbd050208e764a4be84fb33b5dab452169f170ee532eccc0d39c136fefd
 SHA512:
-  metadata.gz: da84a77b06069df84270a4a15b3e9d2b7ad851246f25200e147443c8e14b163fb988a386ac0e117f44f3c0a896689baa40b122ad9ef12d0eeec3cee522fb2365
-  data.tar.gz: 98bfb1f2e0478a2598e892ed656ab5605052b22b146a637bbb18c2b0ad16c7b4b389b1a818cb0c01a157843798b5dec3e2142ef687e3991dc4ebd5dd11427b4b
+  metadata.gz: f3e12ada8d4ea8fcef49e6928dabe30c37a1d431e870a4d898444f58ceb8fba99356acc1243b89b8e3dbc355f307ff560b4d55ff01e963cf0dd747781a99f3df
+  data.tar.gz: c51c23d9ceff772762c061f587a6cbb53d1d980d12b09bbc2e12b31361096516a03036a105230a7c528f20eba7a5e242052441b253fdd8cb2ff5fe88342ffc3b

data/lib/mixins/user_functions.rb

@@ -19,7 +19,6 @@ module UserFunctions
       default
       jira_project
       jira_sprint
-      jira_status
       jira_team
       jira_user
       n_digit_version
@@ -39,8 +38,8 @@ module UserFunctions
       CLIENT_TOOLS: 'CT',
       CODE_MANAGEMENT: 'CODEMGMT',
       COMMUNITY_PACKAGE_REPO: 'CPR',
-      DOC: 'DOC',
-      DOCS: 'DOC',
+      DOC: 'PUPDOC',
+      DOCS: 'PUPDOC',
       EZBAKE: 'EZ',
       FACTER: 'FACT',
       FORGE_INTERNAL: 'PF',
@@ -73,21 +72,6 @@ module UserFunctions
     }
   end
 
-  def jira_statuses
-    # READY_FOR_ENGINEERING deprecated and translated to ACCEPTED
-    {
-      ACCEPTED: 11,
-      READY_FOR_ENGINEERING: 11,
-      ON_HOLD: 21,
-      UNDER_INVESTIGATION: 31,
-      TESTING: 41,
-      IN_PROGRESS: 51,
-      IN_REVIEW: 61,
-      CLOSED: 71,
-      CANCELED: 81
-    }
-  end
-
   def jira_teams
     {
       BOLT: 'Bolt',
@@ -114,10 +98,9 @@ module UserFunctions
 
     projects = jira_projects.transform_keys { |k| "#{k.downcase}_project".to_sym }
     sprints = jira_sprints.transform_keys { |k| "#{k.downcase}_sprint".to_sym }
-    statuses = jira_statuses.transform_keys { |k| "#{k.downcase}_status".to_sym }
     teams = jira_teams.transform_keys { |k| "#{k.downcase}_team".to_sym }
 
-    variables.merge(**projects, **sprints, **statuses, **teams)
+    variables.merge(**projects, **sprints, **teams)
   end
 
   # Takes at least two arguments.
@@ -184,10 +167,6 @@ module UserFunctions
     _jira_key('sprint', jira_sprints, args[0])
   end
 
-  def jira_status(args)
-    _jira_key('status', jira_statuses, args[0])
-  end
-
   def jira_team(args)
     _jira_key('team', jira_teams, args[0])
   end

data/lib/tefoji/jira_api.rb

@@ -204,6 +204,31 @@ module Tefoji
       fatal "Jira account ID not found for #{account_name}"
     end
 
+    def get_transition_id(issue_key, status)
+      transitions_request_path = "issue/#{issue_key}/transitions"
+      response = jira_get(transitions_request_path)
+
+      fatal "Transitions data not found for issue: \"#{issue_key}\"" if response.empty?
+
+      downcased_status = status.downcase
+
+      transitions_data = response['transitions']
+      transition = transitions_data.find { |transition_data| transition_data['name'].downcase == downcased_status }
+
+      if transition.nil?
+        warn "No transition ID found for issue: \"#{issue_key}\" status: \"#{status}\"\n \
+              available transitions: #{transitions_data}"
+        return nil
+      end
+
+      transition_id = transition['id']
+
+      @logger.debug("issue: \"#{issue_key}\" status: \"#{status}\"" \
+                    "converted to transition ID: \"#{transition_id}\"")
+
+      return transition_id.to_i
+    end
+
     private
 
     ## BUG BUG 'type' should ALWAYS be defined but we have a number of assumptions in
@@ -403,12 +428,6 @@ module Tefoji
       if issue_data['sprint']
         jira_fields['customfield_10020'] = issue_data['sprint'].to_i
       end
-      if issue_data['acceptance']
-        jira_fields['customfield_10062'] = issue_data['acceptance']
-      end
-      if issue_data['release_notes']
-        jira_fields['customfield_10043'] = { FIELD_VALUE => issue_data['release_notes'] }
-      end
 
       # If a issue has a specified parent issue, prefer that. The parent issue *should* already
       # be linked to the main epic. Otherwise, we need to set it to have an epic_parent. This can

data/lib/tefoji/version.rb

@@ -0,0 +1,3 @@
+module Tefoji
+  VERSION = '3.3.0'
+end

data/lib/tefoji.rb

@@ -42,6 +42,7 @@ module Tefoji
       @default_target_epic = nil
       @epic_security = nil
       @deferral_data = {}
+      @transitions_table = {}
 
       # Logging
       @log_level = Logger::INFO
@@ -374,15 +375,17 @@ module Tefoji
 
       @template_data['issues'].each do |issue|
         jira_ready_data, raw_issue_data = prepare_jira_ready_data(issue, issue_defaults)
+
         next if jira_ready_data.nil? || raw_issue_data.nil?
 
         response_data = @jira_api.create_issue(jira_ready_data)
         jira_issue = @jira_api.retrieve_issue(response_data['self'])
         jira_issue['short_name'] = raw_issue_data['short_name']
+        issue_key = jira_issue['key']
 
         @logger.info 'Issue %4d: %10s [%s]' % [
                       @issue_counter,
-                      jira_issue['key'],
+                      issue_key,
                       jira_issue['fields']['summary']
                     ]
         @issue_counter += 1
@@ -395,6 +398,11 @@ module Tefoji
           'jira' => jira_issue,
           'raw' => raw_issue_data
         }
+
+        next unless raw_issue_data.key?('status')
+
+        status = raw_issue_data['status'].value
+        @transitions_table[issue_key] = @jira_api.get_transition_id(issue_key, status)
       end
       process_deferred_updates
     end
@@ -562,14 +570,17 @@ module Tefoji
         next unless raw_issue_data.key?(deferred_tag)
 
         issue_key = jira_issue_data['key']
+        next unless @transitions_table[issue_key]
+
         new_status = raw_issue_data[deferred_tag].value
+        transition_id = @transitions_table[issue_key]
+
         begin
-          @jira_api.transition(issue_key, new_status)
+          @jira_api.transition(issue_key, transition_id)
         rescue RestClient::BadRequest => e
-          fatal "setting the status on #{issue_key} to #{new_status} failed: #{e}"
+          fatal "setting the status on #{issue_key} to #{new_status} with transition ID #{transition_id} failed: #{e}"
         end
-        status_human_readable = jira_statuses.key(new_status.to_i)
-        @logger.info '%14s: status set to %s' % [issue_key, status_human_readable]
+        @logger.info '%14s: status set to "%s"' % [issue_key, new_status]
       end
     end
 
@@ -721,7 +732,15 @@ module Tefoji
       single_value = %r{\A%{(.+?)}\Z}.match(value)
       return @declarations[single_value[1].to_sym] if single_value
 
-      return value % @declarations
+      return value if @declarations.nil?
+
+      # Substitute all variables in the string
+      variable_substituted_value = value
+      @declarations.each_key do |key|
+        variable_substituted_value = variable_substituted_value.gsub("%{#{key}}",
+                                                                     @declarations[key].value.to_s)
+      end
+      return variable_substituted_value
     end
 
     # Return a list of all the unset variables in a template

metadata

@@ -1,150 +1,150 @@
 --- !ruby/object:Gem::Specification
 name: tefoji
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Puppet By Perforce
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-27 00:00:00.000000000 Z
+date: 2023-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
-  type: :development
+  name: debug
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
-  type: :development
+  name: rake
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-  type: :development
+  name: rspec
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: rubocop
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: rubocop-rake
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: rubocop-rspec
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: webmock
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-  type: :development
+  name: yard
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: docopt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
-  type: :runtime
+  name: docopt
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
-  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-  type: :runtime
+  name: rest-client
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -153,7 +153,7 @@ dependencies:
 description: 'From a YAML specification, create a batch of Jira issues allowing for
   variable substitutions.
 
-'
+  '
 email: release@puppet.com
 executables:
 - tefoji
@@ -167,6 +167,7 @@ files:
 - lib/tefoji/cli.rb
 - lib/tefoji/declared_value.rb
 - lib/tefoji/jira_api.rb
+- lib/tefoji/version.rb
 homepage: https://github.com/puppetlabs/tefoji
 licenses:
 - Apache-2.0
@@ -174,7 +175,7 @@ metadata:
   homepage_uri: https://github.com/puppetlabs/tefoji
   source_code_uri: https://github.com/puppetlabs/tefoji
   changelog_uri: https://github.com/puppetlabs/tefoji/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -189,8 +190,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Generate Jira issues from a YAML specification.
 test_files: []