tefoji 1.0.8 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 888097f6ae0c3877e00fa2a2fc0318fb094f5e340621b445f510ffab51b01f85
-  data.tar.gz: 65af396135aa1f22b1385a3c2ed7738db817733429d2243651b3ced884a2a9fe
+  metadata.gz: 8279bb8ebda1af1e674da5c4d16932b790e69210a5c163563746a80d44aca92b
+  data.tar.gz: f17bbc221ed1ec7c4fde90d2e64caddb45078ee0ee2d5cb59e7226d90df14317
 SHA512:
-  metadata.gz: 9d5ce9983a3401f0fe6644fa35725a9c892733d7ad1bdb7ba6051e058fb6aa0a911a2a5cd30aba783c2260c19067fc1112c49c1bf4bf64501b7188096b5ae64e
-  data.tar.gz: 171807f4bf998fd42dd6296de339934c6a22dcd73722749886abf474a795a2e6dfdb2b6faea95a6a8bd5cf7956bd5f9c6d81d786b1c30c554756c7faba7d18db
+  metadata.gz: d790551fe749db5eea41ce6889479c3f23e8278ad94744b8be4561d0cceadb33b609949c612224e49bbc21587b8b3cf50501a6eeef1e2d3059c860420e583c15
+  data.tar.gz: a0b4bd8875027f141a87f2bc960c43143813500db372e0764df428896fc04f34fd3f5b91d3a4d4ca305e9949b88dd3329f4363a1981905f6b4b7d7fe6c7b9fe9

data/lib/mixins/logging.rb

@@ -3,7 +3,7 @@ module Logging
   # Another cheap hack to wrap 'logger' above. Called as 'fatal' rather than 'logger.fatal'
   # directly, does the exit for us so we can be lazy.
   def fatal(message)
-    logger.fatal(message)
+    @logger.fatal(message)
     exit 1
   end
 end

data/lib/mixins/user_functions.rb

@@ -48,7 +48,7 @@ module UserFunctions
       MODULES: 'MODULES',
       MODULES_INTERNAL: 'FM',
       OPERATIONS: 'OPS',
-      PDK: 'PDK',
+      PDK: 'CONT',
       PE_INTERNAL: 'PE',
       PROJECT_CENTRAL: 'PC',
       PUPPETDB: 'PDB',
@@ -89,12 +89,12 @@ module UserFunctions
       CD4PE: 'CD4PE',
       CODE_MANAGEMENT: 'Dumpling',
       DUMPLING: 'Dumpling',
-      FACTER: "Phoenix",
+      FACTER: 'Phoenix',
       INSTALLER: 'Installer and Management',
       NETWORKING: 'Network Automation',
       OPERATIONS: 'Operations',
       PE: 'Dumpling',
-      PLATFORM_OS: "Phoenix",
+      PLATFORM_OS: 'Phoenix',
       PUPPETDB: 'Dumpling',
       PUPPETSERVER: 'Dumpling',
       QE: 'Quality Engineering',

data/lib/tefoji/cli.rb

@@ -43,7 +43,7 @@ module Tefoji
       @user_options = parse_options(argv)
 
       if @user_options['--version']
-        warn "tefoji version #{Gem.loaded_specs['tefoji'].version.to_s}"
+        warn "tefoji version #{Gem.loaded_specs['tefoji'].version}"
         exit 0
       end
 

data/lib/tefoji/jira_api.rb

@@ -75,14 +75,15 @@ module Tefoji
     # 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
+      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.'
     end
 
-    def get_username
-      jira_get("user?username=#{@jira_username}")
+    # Get information about user in Jira
+    def get_username(username, fail_if_not_found = true)
+      jira_get("user?username=#{username}", fail_if_not_found)
     end
 
     # Save authentication YAML to the a file for reuse.
@@ -167,7 +168,7 @@ module Tefoji
 
     private
 
-    def jira_get(jira_request_path)
+    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
       # fully formed url
@@ -191,7 +192,9 @@ module Tefoji
       rescue RestClient::NotFound,
              SocketError,
              Errno::ECONNREFUSED => e
-        fatal "Cannot connect to #{@jira_base_rest_url}: #{e.message}"
+        # 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
       end
 
       return JSON.parse(response.body)

data/lib/tefoji.rb

@@ -74,6 +74,8 @@ module Tefoji
       resolve_variables(main_template_data['declare'])
       @logger.debug "Declarations: #{@declarations}"
 
+      check_assignees(main_template_data)
+
       # Process 'before' templates
       main_template.dig(:includes, :before)&.each do |before|
         default_epic_saved = @default_target_epic
@@ -641,12 +643,17 @@ module Tefoji
     def user_function_call(function_definition)
       @logger.debug "function_definition is: #{function_definition}"
       function_name = function_definition['name']
-      if function_definition.key?('arguments')
-        function_arguments = function_definition['arguments'].map do |a|
+      argument = function_definition['argument']
+      arguments = function_definition['arguments']
+
+      if argument.is_a?(Array) || arguments.is_a?(Array)
+        arguments = argument || function_definition['arguments']
+        function_arguments = arguments.map do |a|
           expand_right_value(a).value
         end
-      elsif function_definition.key?('argument')
-        function_arguments = [expand_right_value(function_definition['argument']).value]
+      elsif argument.is_a?(String) || arguments.is_a?(String)
+        argument = function_definition['argument'] || function_definition['arguments']
+        function_arguments = [expand_right_value(argument).value]
       else
         fatal("No arguments supplied to function \"#{function_name}\"")
       end
@@ -814,6 +821,124 @@ module Tefoji
       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
+    # 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
+
+      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
+
+      invalid_users_to_epics = {}
+      main_template_data['epics']&.each do |epic|
+        next unless epic['assignee']
+
+        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)
+      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(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)
+        end
+      end
+
+      invalid_users_to_issues = {}
+      main_template_data['issues'].each do |issue|
+        next unless issue['assignee']
+
+        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)
+      end
+      unless invalid_users_to_features.empty? &&
+             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"
+        end
+      end
+      unless invalid_users_to_issue_defaults.empty?
+        invalid_users_to_issue_defaults.each do |assignee, _|
+          invalid_user_message += "Assignee #{assignee} associated with issue_defaults\n"
+        end
+      end
+      unless invalid_users_to_issues.empty?
+        invalid_users_to_issues.each do |assignee, issues|
+          invalid_user_message += "Assignee #{assignee} associated with issues #{issues}\n"
+        end
+      end
+      fatal invalid_user_message if invalid_user_message
+    end
+
+    def get_username_from_assignee(assignee)
+      # Assignee is a variable or direct input
+      username = expand_string(assignee) if assignee.is_a?(String)
+      # Assignee is a function
+      if assignee.is_a?(Hash) && assignee.key?('function')
+        username = user_function_call(assignee['function'])
+      end
+
+      unless username
+        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)
+      username
+    end
+
+    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)
+        valid_users << username
+      else
+        invalid_users[username] = invalid_users.fetch(username, []) + [issue_name]
+      end
+    end
+
     def logger_initialize(log_location)
       logger = Logger.new(log_location, progname: 'tefoji', level: @log_level)
       logger.formatter = proc do |severity, _, script_name, message|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tefoji
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
 platform: ruby
 authors:
 - Puppet Labs
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-11 00:00:00.000000000 Z
+date: 2023-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug