tefoji 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9bb72bd908fda02253da35856c56dd5aa0c889af3abcdb5bfea31b329563bee
-  data.tar.gz: 8e50beef2605dec8298ede53aca85413e5dd547ea911bafcbb38a7968a7b93b4
+  metadata.gz: c181a5680af5eebeab13d8a78d1e5430df0f3e7535cd9083771af8fbff6d3d06
+  data.tar.gz: 9e0e8b9dcbc36cdbc093a038bd67d4b38f56197bf25695329d78f15c273e5ace
 SHA512:
-  metadata.gz: cfa17bc65afb628477b49ebbcb383bd6f1864acea598a6333751ffb1327895bd427f5c03e38f0d8f4fd622afaf5854ebd4b097f3cf96fba976086e2831f4527f
-  data.tar.gz: 857c3522c6397462163b74257edd7a1c7f145399da45000ad95d941a4bf315bc6695f3a2935ad879dc78c729088e1f8f5335b7e7a72eca551c808ba03896fe31
+  metadata.gz: 40b84da52997e8df28012872982e3e50c2f3b18da3a2f80650d08c0f45525a3fa6803e1c9fdca9a82e6461c67882357ddc77d85125b39000176930bb6ccf3464
+  data.tar.gz: 6396ee3ff93fd5214500ebe2913d5eddce18968741532e8c7a95b4547a4ffef7251fd9cf0667a30236503b76d1468f44e650f2816ca8815e0f8d6dbaf7891593

data/lib/mixins/user_functions.rb

@@ -27,6 +27,7 @@ module UserFunctions
       prompt_only
       random
       release_type
+      scrum_team
       split
     ]
   end
@@ -51,10 +52,10 @@ module UserFunctions
       PE_INTERNAL: 'PE',
       POOLER: 'POOLER',
       PROJECT_CENTRAL: 'PC',
+      PUPPET: 'PUP',
       PUPPETDB: 'PDB',
       PUPPETSERVER: 'SERVER',
       PUPPET_AGENT: 'PA',
-      PUPPET: 'PUP',
       QUALITY_ENGINEERING: 'QENG',
       RELEASE_ENGINEERING: 'RE',
       SLV: 'SLV',
@@ -67,17 +68,23 @@ module UserFunctions
 
   def jira_sprints
     {
-      RE_KANBAN: 3150,
-      DUMPLING_READY_TO_WORK: 5515
+      DUMPLING_READY_TO_WORK: 5515,
+      RE_KANBAN: 3150
     }
   end
 
   def jira_statuses
+    # READY_FOR_ENGINEERING deprecated and translated to ACCEPTED
     {
-      READY_FOR_ENGINEERING: 111,
-      ACCEPTED: 271,
-      DEVELOPING_FEATURE: 61,
-      DEVELOPING_EPIC: 41
+      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
 
@@ -184,6 +191,7 @@ module UserFunctions
   def jira_team(args)
     _jira_key('team', jira_teams, args[0])
   end
+  alias scrum_team jira_team
 
   # Return the first n fields of '.' - delimited version string
   def n_digit_version(args)

data/lib/tefoji/jira_api.rb

@@ -192,6 +192,12 @@ module Tefoji
 
     private
 
+    ## BUG BUG 'type' should ALWAYS be defined but we have a number of assumptions in
+    # this file that just check for the field existence and not the value.
+    def epic?(issue_data)
+      issue_data.key?('type') && issue_data['type'].casecmp?(ISSUE_EPIC)
+    end
+
     def jira_get(jira_request_path, fail_if_not_found = true)
       # Jira likes to send complete URLs for responses. Handle
       # the case where we've received a 'self' query from Jira with
@@ -321,6 +327,28 @@ module Tefoji
         end
       end
 
+      # Backward compatiblity: translate 'team' to 'scrum_team'
+      scrum_team = issue_data['scrum_team'] || issue_data['team']
+      if scrum_team
+        if epic?(issue_data)
+          jira_fields['components'] = [{ FIELD_NAME => scrum_team }]
+        else
+          jira_fields['customfield_11500'] = { FIELD_VALUE => scrum_team }
+        end
+      end
+
+      # We're only allowed multiple teams (as 'components') in epics. For ordinary
+      # issues take only the first of the list
+      scrum_teams = issue_data['scrum_teams'] || issue_data['teams']
+      if scrum_teams
+        processed_teams = scrum_teams.to_a.flatten.reject { |t| t =~ /^\s*$/ }
+        if epic?(issue_data)
+          jira_fields['components'] = processed_teams.map { |team| { FIELD_NAME => team } }
+        else
+          jira_fields['customfield_11500'] = { FIELD_VALUE => processed_teams.first }
+        end
+      end
+
       # Default issue type to ISSUE_TASK if it isn't already set
       jira_fields['issuetype'] = { FIELD_NAME => ISSUE_TASK }
 
@@ -350,7 +378,7 @@ module Tefoji
       if issue_data['type']
         jira_fields['issuetype'] = { FIELD_NAME => issue_data['type'] }
         # If this is an epic, we need to add an epic name
-        if issue_data['type'].casecmp?(ISSUE_EPIC)
+        if epic?(issue_data)
           jira_fields['customfield_10011'] = issue_data['epic_name'] || issue_data['summary']
         end
       end
@@ -408,7 +436,7 @@ module Tefoji
       if issue_data['type']
         jira_fields['issuetype'] = { FIELD_NAME => issue_data['type'] }
         # If this is an epic, we need to add an epic name
-        if issue_data['type'].casecmp?(ISSUE_EPIC)
+        if epic?(issue_data)
           jira_fields['customfield_10007'] = issue_data['epic_name'] || issue_data['summary']
         end
       end
@@ -416,15 +444,7 @@ module Tefoji
       if issue_data['story_points']
         jira_fields['customfield_10002'] = issue_data['story_points'].to_i
       end
-      if issue_data['team']
-        jira_fields['customfield_14200'] = { FIELD_VALUE => issue_data['team'] }
-      end
-      if issue_data['teams']
-        teams = issue_data['teams'].to_a.flatten.reject { |t| t =~ /^\s*$/ }
-        unless teams.empty?
-          jira_fields['customfield_14201'] = teams.map { |team| { FIELD_VALUE => team } }
-        end
-      end
+
       if issue_data['subteam']
         jira_fields['customfield_11700'] = [issue_data['subteam']]
       end

data/lib/tefoji.rb

@@ -18,6 +18,8 @@ module Tefoji
     include Logging
     include UserFunctions
 
+    attr_accessor :template_data, :jira_api
+
     # @param [Hash] user_options options provided by the user through the CLI.
     # @see CLI
     def initialize(user_options = {}, log_location = $stderr)
@@ -38,9 +40,9 @@ module Tefoji
       @issue_counter = 1
 
       # Changable internal states
-      @feature_issue = nil
       @default_target_epic = nil
       @epic_security = nil
+      @deferral_data = {}
 
       # Logging
       @log_level = Logger::INFO
@@ -113,9 +115,7 @@ module Tefoji
       @logger.info "- Processing \"#{template_name}\" template"
       @template_data = template_data
 
-      if @template_data.key?('feature')
-        generate_feature_with_issues
-      elsif @template_data.key?('epics')
+      if @template_data.key?('epics')
         generate_epics_with_issues('epics')
       elsif @template_data.key?('epic')
         generate_epics_with_issues('epic')
@@ -236,9 +236,6 @@ module Tefoji
 
         yaml_data = YAML.safe_load(raw_yaml, filename: included_template_path)
 
-        # In included templates, we don't include features.
-        yaml_data.delete('feature')
-
         # In included templates, we don't include epics unless they are specifically kept.
         unless include_epics
           yaml_data.delete('epics')
@@ -282,29 +279,6 @@ module Tefoji
       @jira_api.save_authentication(@jira_auth_file, @jira_cloud)
     end
 
-    private
-
-    # Generate a feature, a list of epics, and associated issues
-    def generate_feature_with_issues
-      @feature_issue = generate_feature
-      generate_epics('epics').each do |epic|
-        @default_target_epic = epic
-        generate_ordinary_issues
-      end
-    end
-
-    # Generate a 'feature' issue
-    def generate_feature
-      feature_to_do = @template_data['feature']
-
-      feature = variable_substitute(feature_to_do)
-      feature['type'] = JiraApi::ISSUE_NEW_FEATURE
-
-      @feature_issue = @jira_api.create_issue(feature, @jira_cloud)
-      @logger.info "Feature issue: #{@feature_issue['key']}"
-      @feature_issue
-    end
-
     def generate_epics_with_issues(epic_key)
       epics = generate_epics(epic_key)
       epics.each do |epic|
@@ -365,7 +339,10 @@ module Tefoji
         epic_issue = @jira_api.create_issue(epic, @jira_cloud)
         epic_issue['short_name'] = short_name
         @logger.info 'Epic: %16s [%s]' % [epic_issue['key'], short_name]
-        @jira_api.link_issues(@feature_issue['key'], epic_issue['key']) if @feature_issue
+        @deferral_data[short_name.to_s] = {
+          'jira' => epic_issue,
+          'raw' => epic
+        }
         epic_issue
       end
     end
@@ -385,10 +362,6 @@ module Tefoji
     # Iterate through all issues in the template, creating each one in Jira.
     # Link the issues back to their epic, if required
     def generate_ordinary_issues
-      # Need to keep a map of tefoji data and associated responses from Jira to perform
-      # deferred updates, like blocked_by or watchers
-      deferral_data = {}
-
       issue_defaults = {}
       if @template_data.key?('issue_defaults')
         issue_defaults = variable_substitute(@template_data['issue_defaults'])
@@ -417,12 +390,12 @@ module Tefoji
 
         # deferral_data is kept to match the jira raw request data to the jira response data.
         # This is needed so that deferred actions (like 'blocked_by') can be correctly mapped.
-        deferral_data[raw_issue_data['short_name'].to_s] = {
+        @deferral_data[raw_issue_data['short_name'].to_s] = {
           'jira' => jira_issue,
           'raw' => raw_issue_data
         }
       end
-      process_deferred_updates(deferral_data)
+      process_deferred_updates
     end
 
     # Transform the tefoji issue data and tefoji issue_defaults into a hash that is ready to
@@ -538,16 +511,16 @@ module Tefoji
     #
     # @param deferral_data [Hash] raw template and jira response data
     # @see generate_ordinary_issues
-    def process_deferred_updates(deferral_data)
+    def process_deferred_updates
       ## Find deferred tags in the jira_epic_issues and do the required work
       deferred_tags.each do |deferred_tag|
         case deferred_tag
         when 'blocked_by'
-          process_blocked_by(deferral_data)
+          process_blocked_by
         when 'status'
-          process_status(deferral_data)
+          process_status
         when 'watchers'
-          process_watchers(deferral_data)
+          process_watchers
         else
           raise "Unimplemented deferred_tag: #{deferred_tag}"
         end
@@ -557,10 +530,10 @@ module Tefoji
     ## The process_* methods have repeated code. This could be cleaned up
     ## with some well-thought-through functional techniques. Since the list
     ## of methods is short, I'll pass on that for now.
-    def process_blocked_by(deferral_data)
+    def process_blocked_by
       deferred_tag = 'blocked_by'
 
-      deferral_data.each_value do |deferral_hash|
+      @deferral_data.each_value do |deferral_hash|
         raw_issue_data = deferral_hash['raw']
         jira_issue_data = deferral_hash['jira']
         next unless raw_issue_data.key?(deferred_tag)
@@ -568,10 +541,9 @@ module Tefoji
         target_issues = [raw_issue_data[deferred_tag].value].flatten
         target_issues.each do |target_issue_name|
           this_issue_key = jira_issue_data['key']
-
           # If we skipped creating the target issue because of a 'conditional',
           # don't try to link to it.
-          target_issue_key = deferral_data.dig(target_issue_name, 'jira', 'key')
+          target_issue_key = @deferral_data.dig(target_issue_name, 'jira', 'key')
           next if target_issue_key.nil?
 
           @jira_api.link_issues(target_issue_key, this_issue_key)
@@ -580,10 +552,10 @@ module Tefoji
       end
     end
 
-    def process_status(deferral_data)
+    def process_status
       deferred_tag = 'status'
 
-      deferral_data.each_value do |deferral_hash|
+      @deferral_data.each_value do |deferral_hash|
         raw_issue_data = deferral_hash['raw']
         jira_issue_data = deferral_hash['jira']
         next unless raw_issue_data.key?(deferred_tag)
@@ -600,10 +572,10 @@ module Tefoji
       end
     end
 
-    def process_watchers(deferral_data)
+    def process_watchers
       deferred_tag = 'watchers'
 
-      deferral_data.each_value do |deferral_hash|
+      @deferral_data.each_value do |deferral_hash|
         raw_issue_data = deferral_hash['raw']
         jira_issue_data = deferral_hash['jira']
 
@@ -816,40 +788,27 @@ module Tefoji
     end
 
     def missing_expected_keys?(template_uri, template)
-      expected_keys = %w[epic epics feature issues]
+      expected_keys = %w[epic epics issues]
       return false if (template.keys & expected_keys).any?
 
       @logger.error "Cannot find any known template keywords in \"#{template_uri}\""
       return true
     end
 
-    # Iterates through the assignees in a template and checks if they exist on jira. If any assignee in
-    # the template does not exist, it will fail, outputting a message saying which users failed and
+    # Iterates through the assignees in a template and checks if they
+    # exist on jira. If any assignee in the template does not exist,
+    # it will fail, outputting a message saying which users failed and
     # what epics/issues they are associated with.
-    # NOTE: This check does not guarantee a user is assignable, so there may be cases when a user passes
-    #       the check but still fails when being assigned a ticket/epic. If we find a reasonable way to
-    #       check assignability prior to the epic/issue being created, we should implement it in place of
-    #       using the get_username method.
-    def check_assignees(main_template_data)
-      valid_users = []
-
-      invalid_users_to_features = {}
-      main_template_data['features']&.each do |feature|
-        next unless feature['assignee']
-
-        assignee_username = get_username_from_assignee(feature['assignee'])
-        next if valid_users.include?(assignee_username)
 
-        update_user_validity(assignee_username, feature['summary'], valid_users, invalid_users_to_features)
-      end
+    # NOTE: This check does not guarantee a user is assignable, so
+    #       there may be cases when a user passes the check but still
+    #       fails when being assigned a ticket/epic. If we find a
+    #       reasonable way to check assignability prior to the
+    #       epic/issue being created, we should implement it in place
+    #       of using the get_username method.
 
-      if main_template_data.dig('feature', 'assignee')
-        assignee_username = get_username_from_assignee(main_template_data['feature']['assignee'])
-        unless valid_users.include?(assignee_username)
-          update_user_validity(assignee_username, main_template_data['feature']['summary'], valid_users,
-                               invalid_users_to_features)
-        end
-      end
+    def check_assignees(main_template_data)
+      valid_users = []
 
       invalid_users_to_epics = {}
       main_template_data['epics']&.each do |epic|
@@ -858,22 +817,35 @@ module Tefoji
         assignee_username = get_username_from_assignee(epic['assignee'])
         next if valid_users.include?(assignee_username)
 
-        update_user_validity(assignee_username, epic['summary'], valid_users, invalid_users_to_epics)
+        update_user_validity(
+          assignee_username,
+          epic['summary'],
+          valid_users,
+          invalid_users_to_epics
+        )
       end
 
       if main_template_data.dig('epic', 'assignee')
         assignee_username = get_username_from_assignee(main_template_data['epic']['assignee'])
         unless valid_users.include?(assignee_username)
-          update_user_validity(assignee_username, main_template_data['epic']['summary'], valid_users,
-                               invalid_users_to_epics)
+          update_user_validity(
+            assignee_username,
+            main_template_data['epic']['summary'],
+            valid_users,
+            invalid_users_to_epics
+          )
         end
       end
 
       invalid_users_to_issue_defaults = {}
       if main_template_data.dig('issue_defaults', 'assignee')
-        assignee_username = get_username_from_assignee(main_template_data['issue_defaults']['assignee'])
+        assignee_username = get_username_from_assignee(
+          main_template_data['issue_defaults']['assignee']
+        )
         unless valid_users.include?(assignee_username)
-          update_user_validity(assignee_username, 'issue_defaults', valid_users, invalid_users_to_issue_defaults)
+          update_user_validity(
+            assignee_username, 'issue_defaults', valid_users, invalid_users_to_issue_defaults
+          )
         end
       end
 
@@ -884,19 +856,18 @@ module Tefoji
         assignee_username = get_username_from_assignee(issue['assignee'])
         next if valid_users.include?(assignee_username)
 
-        update_user_validity(assignee_username, issue['summary'], valid_users, invalid_users_to_issues)
+        update_user_validity(
+          assignee_username,
+          issue['summary'],
+          valid_users,
+          invalid_users_to_issues
+        )
       end
-      unless invalid_users_to_features.empty? &&
-             invalid_users_to_epics.empty? &&
+      unless invalid_users_to_epics.empty? &&
              invalid_users_to_issue_defaults.empty? &&
              invalid_users_to_issues.empty?
         invalid_user_message = "Invalid assignees:\n"
       end
-      unless invalid_users_to_features.empty?
-        invalid_users_to_features.each do |assignee, feature|
-          invalid_user_message += "Assignee #{assignee} associated with features #{feature}\n"
-        end
-      end
       unless invalid_users_to_epics.empty?
         invalid_users_to_epics.each do |assignee, epic|
           invalid_user_message += "Assignee #{assignee} associated with epics #{epic}\n"
@@ -924,7 +895,8 @@ module Tefoji
       end
 
       unless username
-        fatal "invalid assignee format for issue: #{issue['short_name']} failed: must be a function or a string"
+        fatal "invalid assignee format for issue: #{issue['short_name']} failed: ",
+              'must be a function or a string'
       end
 
       username = username.value unless username.is_a?(String)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tefoji
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Puppet Labs
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-18 00:00:00.000000000 Z
+date: 2023-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug