tefoji 3.4.1 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d877edf49d4a6326964946cb9550504d33d0d27f2d647ee9d4cbd44989ef35df
-  data.tar.gz: 24722e16086cd273ec562ac8f5628f98c09e73c2c51e6c31db2e01cbffcb4618
+  metadata.gz: fc4b951086f14bcc81ab1aabd55e9598d10178ba5cbfbd61984d89444b2df2b3
+  data.tar.gz: a822ad69a634e8e78d763adde8e0606460b290f7b291553216194ddb7c59c23a
 SHA512:
-  metadata.gz: b095075f6a039349fa85a748f788091274fc2e0f751f78c399a6fc28d159f18e1827503889cd865a1dd47d871c6b8a30b8bb710c16d65f92605ff63c70ad8a60
-  data.tar.gz: e9f3a20477f55ddfb188f501451b652bd6f6a2b9a116fdb529b37846adcea282e82132723b2f943e70ae171cd2f14b7fab0407414b6d2da100b5025bdacf78e3
+  metadata.gz: 4720d892040f8f1be05329d2de1845c1a2255441c9e71cb7211df1b189c4d0d342f31c6611ad52f210fb442a289406250f53c0a7705bbc7c244bd8fe3de3d750
+  data.tar.gz: b2e7f33d4e8cd0ee744a3e7d55b8d6d29b5a48887441f54ba0bfdb55789f31167913a963c368fcee9d4458572bd48e7571257e2c853935ac5ed9d52d500a2d05

data/lib/mixins/user_functions.rb

@@ -48,6 +48,7 @@ module UserFunctions
       MODULES: 'MODULES',
       MODULES_INTERNAL: 'FM',
       OPERATIONS: 'OPS',
+      P4DEVOPS: 'P4DEVOPS',
       PDK: 'CONT',
       PE_INTERNAL: 'PE',
       POOLER: 'POOLER',
@@ -57,7 +58,6 @@ module UserFunctions
       PUPPETSERVER: 'SERVER',
       PUPPET_AGENT: 'PA',
       QUALITY_ENGINEERING: 'QENG',
-      RELEASE_ENGINEERING: 'RE',
       SLV: 'SLV',
       SUPPORT: 'SUP',
       VANAGON: 'VANAGON',
@@ -80,8 +80,7 @@ module UserFunctions
       CODE_MANAGEMENT: 'Dumpling',
       DUMPLING: 'Dumpling',
       FACTER: 'Phoenix',
-      INSTALLER: 'Installer and Management',
-      NETWORKING: 'Network Automation',
+      INSTALLER: 'Installer',
       OPERATIONS: 'Operations',
       PE: 'Dumpling',
       PLATFORM_OS: 'Unicorn',

data/lib/tefoji/jira_api.rb

@@ -73,21 +73,28 @@ module Tefoji
       # HTTP doesn't like linefeeds in the auth string, hence #strict_encode64
       @jira_auth = Base64.strict_encode64(decoded_auth.join(':'))
       @authentication_header = { 'Authorization' => "Basic #{@jira_auth}" }
-    end
 
-    # Do this so we can inform the user quickly that their credentials didn't work
-    # There may be a better test, but this is the one the original Winston uses
-    def test_authentication
-      get_username(@jira_username)
-    rescue RestClient::Forbidden
-      fatal 'Forbidden: either the authentication is incorrect or ' \
-            'Jira might be requiring a CAPTCHA response from the web interface.'
+      # Verify authentication
+      return if @jira_mock
+      return if get_username(@jira_username)
+
+      @logger.info "Authentication failed, trying again with username: #{@jira_username}@perforce.com"
+      # Reset authentication with @perforce.com added to username
+      @jira_username = "#{@jira_username}@perforce.com"
+      decoded_auth[0] = @jira_username
+      @jira_auth = Base64.strict_encode64(decoded_auth.join(':'))
+      @authentication_header = { 'Authorization' => "Basic #{@jira_auth}" }
+      # Retry authentication
+      fatal 'Authentication failed: Credentials are invalid' unless get_username(@jira_username)
     end
 
     # Get information about user in Jira
-    def get_username(username, fail_if_not_found = true)
+    def get_username(username)
       search_parameters = "user/search?query=#{username}"
-      jira_get(search_parameters, fail_if_not_found)
+      response = jira_get(search_parameters)
+      return false if response.empty?
+
+      response
     end
 
     # Get information about user in Jira
@@ -197,7 +204,7 @@ module Tefoji
       account_name = user_name_to_account_name(user_email)
       response = get_username(account_name)
 
-      fatal "Jira account ID not found for \"#{account_name}\"" if response.empty?
+      fatal "Jira account ID not found for \"#{account_name}\"" unless response
       account_id = response[0]['accountId']
 
       @logger.debug("user account name: \"#{account_name} \" " \
@@ -241,7 +248,7 @@ module Tefoji
       issue_data.key?('type') && issue_data['type'].casecmp?(ISSUE_EPIC)
     end
 
-    def jira_get(jira_request_path, fail_if_not_found = true)
+    def jira_get(jira_request_path)
       # Jira likes to send complete URLs for responses. Handle
       # the case where we've received a 'self' query from Jira with
       # fully formed url
@@ -265,8 +272,7 @@ module Tefoji
              SocketError,
              Errno::ECONNREFUSED => e
         # Return false if not found rather than fail to allow for checking the existence of users.
-        fatal "Cannot connect to #{@jira_base_rest_url}: #{e.message}" if fail_if_not_found
-        return false
+        fatal "Cannot connect to #{@jira_base_rest_url}: #{e.message}"
       end
       return JSON.parse(response.body)
     end
@@ -433,6 +439,14 @@ module Tefoji
         jira_fields['customfield_10020'] = issue_data['sprint'].to_i
       end
 
+      if issue_data['product']
+        jira_fields['customfield_10350'] = { FIELD_VALUE => issue_data['product'] }
+      end
+
+      if issue_data['shirt_size']
+        jira_fields['customfield_10078'] = { FIELD_VALUE => issue_data['shirt_size'] }
+      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
       # either be an epic linked to the main epic or the main epic itself.

data/lib/tefoji/version.rb

@@ -1,3 +1,3 @@
 module Tefoji
-  VERSION = '3.4.1'
+  VERSION = '3.5.0'
 end

data/lib/tefoji.rb

@@ -75,6 +75,8 @@ module Tefoji
         @declarations[k] = DeclaredValue.new(v)
       end
 
+      standardize_epics(main_template_data)
+
       resolve_variables(main_template_data['declare'])
       @logger.debug "Declarations: #{@declarations}"
 
@@ -85,6 +87,7 @@ module Tefoji
       main_template.dig(:includes, :before)&.each do |before|
         default_epic_saved = @default_target_epic
         @formats = before.dig(:data, 'formats') if before.dig(:data, 'formats')
+        standardize_epics(before[:data])
         process_template(before[:template_name], before[:data], before[:conditional])
         @default_target_epic = default_epic_saved
       end
@@ -98,6 +101,7 @@ module Tefoji
       main_template.dig(:includes, :after)&.each do |after|
         default_epic_saved = @default_target_epic
         @formats = after.dig(:data, 'formats') if after.dig(:data, 'formats')
+        standardize_epics(after[:data])
         process_template(after[:template_name], after[:data], after[:conditional])
         @default_target_epic = default_epic_saved
       end
@@ -118,9 +122,7 @@ module Tefoji
       @template_data = template_data
 
       if @template_data.key?('epics')
-        generate_epics_with_issues('epics')
-      elsif @template_data.key?('epic')
-        generate_epics_with_issues('epic')
+        generate_epics_with_issues
       elsif @template_data.key?('issues')
         generate_ordinary_issues
       else
@@ -272,7 +274,6 @@ module Tefoji
       @jira_api.logger = @logger
 
       @jira_api.authenticate(@jira_url, @jira_user, @jira_auth_string)
-      @jira_api.test_authentication unless @jira_mock
     end
 
     # Save Jira auth data
@@ -281,8 +282,8 @@ module Tefoji
       @jira_api.save_authentication(@jira_auth_file)
     end
 
-    def generate_epics_with_issues(epic_key)
-      epics = generate_epics(epic_key)
+    def generate_epics_with_issues
+      epics = generate_epics
       epics.each do |epic|
         @default_target_epic = epic
         generate_ordinary_issues
@@ -290,8 +291,8 @@ module Tefoji
     end
 
     # @return [Array] an array of responses from Jira containing a hash of the epic fields.
-    def generate_epics(epic_key)
-      epic_to_do_list = [@template_data[epic_key]].flatten
+    def generate_epics
+      epic_to_do_list = [@template_data['epics']].flatten
       @logger.debug "Generating data: #{@template_data}"
 
       epic_to_do_list.map do |epic|
@@ -427,6 +428,17 @@ module Tefoji
     # Return the fully prepared Jira hash as well as the 'raw' variable-substituted one;
     # The latter will be needed when processing deferrals.
     def prepare_jira_ready_data(issue, issue_defaults)
+      # For multi-epic templates, skip this issue if it is not part of this epic
+      if issue.key?('epic_link') &&
+         issue['epic_link'] != @default_target_epic['short_name'].value
+        @logger.debug 'Issue %s "%s" does not have "%s" as epic_link, skipping' % [
+                        issue['short_name'],
+                        issue['epic_link'],
+                        @default_target_epic['short_name'].value
+                     ]
+        return nil
+      end
+
       raw_issue_data = variable_substitute(issue_defaults.merge(issue), except: %w[summary_format])
       error_name = raw_issue_data['short_name']
 
@@ -441,20 +453,6 @@ module Tefoji
         )
       end
 
-      # For multi-epic templates, skip this issue if it is not part of this epic
-      if raw_issue_data.key?('epic_link') &&
-         raw_issue_data['epic_link'].value != @default_target_epic['short_name'].value
-        @logger.debug 'Issue %s "%s" does not have "%s" as epic_link, skipping' % [
-                       raw_issue_data['short_name'].value,
-                       raw_issue_data['epic_link'].value,
-                       @default_target_epic['short_name'].value
-                     ]
-        return nil
-      end
-
-      return nil if raw_issue_data.key?('epic_link') &&
-                    raw_issue_data['epic_link'].value != @default_target_epic['short_name'].value
-
       if conflicting_conditionals?(raw_issue_data)
         fatal "Issue \"#{error_name}\" has conflicting conditionals."
       end
@@ -851,6 +849,7 @@ module Tefoji
     def check_assignees(main_template_data)
       valid_users = []
       invalid_users_to_epics = {}
+
       main_template_data['epics']&.each do |epic|
         next unless epic['assignee']
 
@@ -865,18 +864,6 @@ module Tefoji
         )
       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
-          )
-        end
-      end
-
       invalid_users_to_issue_defaults = {}
       if main_template_data.dig('issue_defaults', 'assignee')
         assignee_username = get_username_from_assignee(
@@ -946,7 +933,7 @@ module Tefoji
     def update_user_validity(username, issue_name, valid_users, invalid_users)
       if invalid_users.key?(username)
         invalid_users[username] += [issue_name]
-      elsif @jira_api.get_username(username, false)
+      elsif @jira_api.get_username(username)
         valid_users << username
       else
         invalid_users[username] = invalid_users.fetch(username, []) + [issue_name]
@@ -957,6 +944,7 @@ module Tefoji
     # in the associated project.
     def check_components(main_template_data)
       invalid_components = Set.new
+
       main_template_data['epics']&.each do |epic|
         next unless epic['components']
 
@@ -967,14 +955,6 @@ module Tefoji
         end
       end
 
-      if main_template_data.dig('epic', 'components')
-        project = expand_right_value(main_template_data['epic']['project']).value
-        update_valid_components(project)
-        main_template_data['epic']['components'].each do |component|
-          invalid_components.add([project, component]) unless @valid_components[project].include?(component)
-        end
-      end
-
       main_template_data['issues'].each do |issue|
         next unless issue['components']
 
@@ -1016,5 +996,25 @@ module Tefoji
 
       logger
     end
+
+    # Takes template data as input and ensures the format for the epics
+    # field is the 'epics' key with an array as the value.
+    def standardize_epics(template_data)
+      # Determine if epic or epics key exists
+      if template_data['epic']
+        epic_value = 'epic'
+      elsif template_data['epics']
+        epic_value = 'epics'
+      else
+        @logger.debug('No epics found in template, skipping standardize_epics')
+        return
+      end
+      # Convert epic data to array if not currently an array
+      epics_data = template_data[epic_value]
+      epics_data = [template_data[epic_value]] unless epics_data.is_a?(Array)
+      # Set epics data and delete epic data if it exists
+      template_data['epics'] = epics_data
+      template_data.delete('epic') if epic_value == 'epic'
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tefoji
 version: !ruby/object:Gem::Version
-  version: 3.4.1
+  version: 3.5.0
 platform: ruby
 authors:
 - Puppet By Perforce
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-31 00:00:00.000000000 Z
+date: 2025-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debug
@@ -174,8 +174,8 @@ licenses:
 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: 
+  changelog_uri: https://github.com/puppetlabs/tefoji/blob/main/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -191,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.33
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Generate Jira issues from a YAML specification.
 test_files: []