tefoji 1.2.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 427d2dac516388b9bfe1db4ce55a164621c0530d30a9a79ce322fe098372d3a4
-  data.tar.gz: 756adc133f20f25d43f422149df86e17c685a741c10801150092ffd633265bf6
+  metadata.gz: 2c2caf0e00b4916388f8bfb1db2b6ad61317558ed7495d2b39573670c3d7ebc1
+  data.tar.gz: 11f6804530ed3bdcdfa68ef5caeee1f34c070695646b228fa5842493a060732e
 SHA512:
-  metadata.gz: 42c08df5f8727ad1b052b780478d1f66022a35eb2148001f5576eb41874a6334028a91552f02729d526ff96b9c1774606c8cbdc8666e2f83289ae9663ff8ab01
-  data.tar.gz: 1eb096e1869ae3bcedfebb77aacd69b4241d9f0062625850cbd8b1f3ecc4b04325c8e12eaa114ad6083f084b65e59029e46e26cfe0628f31543f049a01730483
+  metadata.gz: ed85494595e4f21db5a8cd26f8b556e29e496481611c6a1322621c495151b94d9ea253450ca2dc0db79493bf8bb74bf0e7c0674ed54ded1974614347e9f523be
+  data.tar.gz: 4c00b11dcb3ef0179838b5bbcac8fdeb1c808905fcf6f9f3236150999cb7a2f696171ff539ad1d6653252f3eabef01664dc36785855aa1d395684d3504646d80

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,22 @@ module Tefoji
         end
       end
 
+      # Backward compatiblity: translate 'team' to 'scrum_team'
+      scrum_team = issue_data['scrum_team'] || issue_data['team']
+
+      if scrum_team
+        field_name, field_value = scrum_team_rules(issue_data, scrum_team)
+        jira_fields[field_name] = field_value
+      end
+
+      # Backward compatiblity: translate 'teams' to 'scrum_teams'
+      scrum_teams = issue_data['scrum_teams'] || issue_data['teams']
+
+      if scrum_teams
+        field_name, field_value = scrum_teams_rules(issue_data, scrum_team)
+        jira_fields[field_name] = field_value
+      end
+
       # Default issue type to ISSUE_TASK if it isn't already set
       jira_fields['issuetype'] = { FIELD_NAME => ISSUE_TASK }
 
@@ -340,6 +362,36 @@ module Tefoji
       end
     end
 
+    # There are now some funky rules for setting the 'scrum_team' (previously 'team')
+    # and 'scrum_teams' field in different issues.
+    #
+    # For epics, put the scrum team in the 'components' field.
+    # Except for a couple of projects, put the scrum team in customfield_11500
+    # For Puppet Agent (PA) and Puppet Server (SERVER) projects, put the scrum team in
+    # customfield_14200
+    def scrum_team_rules(issue_data, scrum_team)
+      if epic?(issue_data)
+        return ['components', [{ FIELD_NAME => scrum_team }]]
+      end
+
+      customfield = 'customfield_11500'
+      if %w[PA SERVER].include?(issue_data['project'].value)
+        customfield = 'customfield_14200'
+      end
+
+      return [customfield, { FIELD_VALUE => scrum_team }]
+    end
+
+    def scrum_teams_rules(issue_data, scrum_teams)
+      processed_teams = scrum_teams.to_a.flatten.reject { |t| t =~ /^\s*$/ }
+      if epic?(issue_data)
+        return ['components', processed_teams.map { |team| { FIELD_NAME => team } }]
+      end
+
+      # For ordinary issues we can only set one team.
+      scrum_team_rules(issue_data, processed_teams.first)
+    end
+
     def set_cloud_jira_fields(issue_data, jira_fields)
       if issue_data['assignee']
         assignee = issue_data['assignee']
@@ -350,7 +402,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 +460,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 +468,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

@@ -40,7 +40,6 @@ module Tefoji
       @issue_counter = 1
 
       # Changable internal states
-      @feature_issue = nil
       @default_target_epic = nil
       @epic_security = nil
       @deferral_data = {}
@@ -116,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')
@@ -239,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')
@@ -285,33 +279,6 @@ module Tefoji
       @jira_api.save_authentication(@jira_auth_file, @jira_cloud)
     end
 
-    # 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
-
-      short_name = feature['short_name'] || feature['summary']
-
-      @feature_issue = @jira_api.create_issue(feature, @jira_cloud)
-      @deferral_data[short_name.to_s] = {
-        'jira' => @feature_issue,
-        'raw' => feature
-      }
-      @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|
@@ -372,7 +339,6 @@ 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
@@ -822,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']
+    # 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.
 
-        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
-
-      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|
@@ -864,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
 
@@ -890,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"
@@ -930,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.2.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Puppet Labs
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-06-01 00:00:00.000000000 Z
+date: 2023-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug