tefoji 3.2.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b78e2ac6210a1adbd94b8ab0613522a8dbf024dccd1ff3e99321a554c7d7ba6
-  data.tar.gz: 9aacc9f1a3735955f4b67cd4a804c379b3dfbd8e965fe8a27bca67c9d85ca2d6
+  metadata.gz: 69675edd7a74569645d7b4124adf46b6b89fe61b6b249e8773ce3a90e37d4cbd
+  data.tar.gz: 9925aa98c156453976e2e54b55231bd22dfb2de0fe9867ffb385d3030a3684a4
 SHA512:
-  metadata.gz: e0522340f64d64008d536b3bd593a230c993b45097b846b9272b73f6e1b592dc56b420026f10b6c7294c3e597f21f411743ca3f330135a6465c6d9f107d7b7dc
-  data.tar.gz: 457ca87866b1620062a968df3a0e733c40eb57402fec66848c0e243da51d8dc0da2888d3f7d0842f255c2d1fcbb0668cfefecfc295ae629977d8e1e541ed69ef
+  metadata.gz: fb28d7c19800cd8b61b8a30d44cb67f96c1dea95f31a40703d6fa74fe47f5865648dc433f6b757f853377fea76a3b7e053559753f6911f1ce7bdb553ea273cc3
+  data.tar.gz: 4ec1f5c99b091fd457482c9678c7d6b85fad114d3d212c126d1351214a0687bff5f94f19e40ebaefcc5a0298a5867fd67c70750e352c0d3556ee6966c771ebb1

data/lib/mixins/user_functions.rb

@@ -14,6 +14,7 @@ module UserFunctions
     %w[
       chooser
       conditional
+      counter
       date_after
       date_before
       default
@@ -38,8 +39,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',
@@ -128,6 +129,24 @@ module UserFunctions
     end
   end
 
+  # Takes 2 optional arguments:
+  #   initial_value (default 1), increment (default)
+  # Returns a Struct that starts with the initial value and post-increments every
+  # time it is used.
+  # The method name 'computed_value' is required for this form.
+  def counter(args)
+    initial_value = args[0] || 1
+    increment = args[1] || 1
+
+    Struct.new(:current_value, :increment) do
+      def computed_value
+        current = current_value.to_s
+        self.current_value += self.increment
+        current
+      end
+    end.new(initial_value, increment)
+  end
+
   # Date `number_of_days` after `date_string`
   def date_after(args)
     _fail_if_unset(__method__.to_s, args)

data/lib/tefoji/declared_value.rb

@@ -1,43 +1,60 @@
 module Tefoji
   class DeclaredValue
-    attr_accessor :value, :properties
+    def initialize(user_value = nil)
+      @value = if user_value.is_a? DeclaredValue
+                 # prevent recursive DeclaredValues
+                 user_value.value
+               else
+                 user_value
+               end
+    end
 
-    def initialize(value = nil)
-      @value = value
-      @value = value.value if value.is_a? DeclaredValue
-      @properties = {}
+    # For most DeclaredValues that aren't Structs that have their one `value` method
+    def simple?
+      !@value.respond_to?(:computed_value)
+    end
+
+    def value
+      if simple?
+        @value
+      else
+        @value.computed_value
+      end
     end
 
     def prepend(*prepended_things)
-      @value.prepend(*prepended_things)
+      value.prepend(*prepended_things)
     end
 
     def to_i
-      @value.to_i
+      value.to_i
     end
 
     def to_s
-      @value.to_s
+      value.to_s
     end
 
     def to_a
-      if @value.is_a? Array
-        @value
+      current = value
+      if current.is_a? Array
+        current
       else
-        [@value]
+        [current]
       end
     end
 
     def %(other)
-      @value % other
+      value % other
     end
 
+    # When querying @value, we don't want to invoke @value.computed_value because it may have
+    # unwanted side-effects.
     def unset?
       @value.nil?
     end
 
     def falsey?
-      @value.nil? || @value.empty? || @value.downcase == 'false' || @value == false
+      simple? && (@value.nil? || @value.empty? || @value.downcase == 'false' || @value == false)
     end
 
     def truthy?

data/lib/tefoji/jira_api.rb

@@ -4,8 +4,6 @@ require 'json'
 require 'rest-client'
 require 'uri'
 
-RestClient.log = 'stdout'
-
 module Tefoji
   ## An interface to send API request to Jira using the rest-client gem.
   ## Contained here are the bits of knowledge necessary to form API calls to Jira.
@@ -32,7 +30,7 @@ module Tefoji
     def log_level=(level)
       @log_level = level
       # When debugging, turn on the RestClient @logger
-      RestClient.log = @logger if @log_level == Logger::DEBUG
+      RestClient.log = 'stderr' if @log_level == Logger::DEBUG
     end
 
     # Depending on how user specified their authorization we want to
@@ -92,6 +90,12 @@ module Tefoji
       jira_get(search_parameters, fail_if_not_found)
     end
 
+    # Get information about user in Jira
+    def get_components(project)
+      search_parameters = "project/#{project}/components"
+      jira_get(search_parameters)
+    end
+
     # Save authentication YAML to the a file for reuse.
     def save_authentication(save_file_name)
       backup_file_name = "#{save_file_name}.bak"

data/lib/tefoji/version.rb

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

data/lib/tefoji.rb

@@ -43,6 +43,7 @@ module Tefoji
       @epic_security = nil
       @deferral_data = {}
       @transitions_table = {}
+      @valid_components = {}
 
       # Logging
       @log_level = Logger::INFO
@@ -78,6 +79,7 @@ module Tefoji
       @logger.debug "Declarations: #{@declarations}"
 
       check_assignees(main_template_data)
+      check_components(main_template_data)
 
       # Process 'before' templates
       main_template.dig(:includes, :before)&.each do |before|
@@ -506,7 +508,7 @@ module Tefoji
                     .gsub('%{short_name}', raw_issue_data['short_name'].value)
 
       # Now do generic expansion of anything else
-      DeclaredValue.new(expand_string(formatted))
+      DeclaredValue.new(expand_variables_in_string(formatted))
     end
 
     # These tags must not be in the issue creation because they need to be
@@ -629,25 +631,23 @@ module Tefoji
     def user_function_call(function_definition)
       @logger.debug "function_definition is: #{function_definition}"
       function_name = function_definition['name']
-      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 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
+      # Allow singlular or plural form for any function call
+      user_arguments = function_definition['argument'] || function_definition['arguments']
 
       unless user_function_allowlist.include?(function_name)
         fatal "Unknown function call: \"#{function_name}\""
       end
 
+      function_arguments = if user_arguments.is_a?(Array)
+                             user_arguments.map do |a|
+                               expand_right_value(a).value
+                             end
+                           elsif user_arguments.is_a?(String)
+                             [expand_right_value(user_arguments).value]
+                           else
+                             []
+                           end
+
       return_value = send(function_name, function_arguments)
       @logger.debug "send(#{function_name}, #{function_arguments}) => #{return_value}"
       DeclaredValue.new(return_value)
@@ -695,11 +695,11 @@ module Tefoji
       # Some simple cases
       return value if value.is_a?(DeclaredValue)
       return DeclaredValue.new(value) if value.is_a?(Numeric)
-      return DeclaredValue.new(expand_string(value)) if value.is_a?(String)
+      return DeclaredValue.new(expand_variables_in_string(value)) if value.is_a?(String)
 
       # Do a user-function call
       if value.is_a?(Hash) && value.key?('function')
-        return DeclaredValue.new(user_function_call(value['function']))
+        return user_function_call(value['function'])
       end
 
       # Return the original hash with the values variable-expanded
@@ -726,13 +726,39 @@ module Tefoji
       raise "Unimplemented condition in expand_right_value: (#{value.class}) #{value}"
     end
 
-    def expand_string(value)
+    def expand_variables_in_string(expandable_string)
+      # If there are no symbols, there's nothing to expand
+      return expandable_string if @declarations.nil?
+
       # Special-case where 'foo: "%{bar}"'; this allows for passing around hashes and
       # arrays without interpolation into strings
-      single_value = %r{\A%{(.+?)}\Z}.match(value)
+      single_value = %r/\A%{([^}]+)}\Z/.match(expandable_string)
       return @declarations[single_value[1].to_sym] if single_value
 
-      return value % @declarations
+      expand_variables(expandable_string)
+    end
+
+    # Generic form of #expand_variables_in_string that recursively replaces
+    # variable forms ("%{foo}") in a string with the text of the variable from
+    # @declarations
+    def expand_variables(expandable_string)
+      # Any pattern starting with '%{', followed by 1 or more characters, ending with '}'
+      variable_match_data = %r/%{([^}]+)}/.match(expandable_string)
+
+      # Return the string if there's nothing to expand
+      return expandable_string if variable_match_data.nil?
+
+      variable_expression = variable_match_data[0]
+      variable_symbol = variable_match_data[1].to_sym
+      variable_value = @declarations[variable_symbol].value
+      variable_stringified_value = variable_value.to_s
+
+      if variable_value.nil?
+        fatal "Unknown variable: \"#{variable_expression}\""
+      end
+
+      modified_string = expandable_string.sub(variable_expression, variable_stringified_value)
+      expand_variables(modified_string)
     end
 
     # Return a list of all the unset variables in a template
@@ -816,7 +842,6 @@ module Tefoji
     #       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_epics = {}
@@ -897,7 +922,7 @@ module Tefoji
 
     def get_username_from_assignee(assignee)
       # Assignee is a variable or direct input
-      username = expand_string(assignee) if assignee.is_a?(String)
+      username = expand_variables_in_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'])
@@ -922,6 +947,57 @@ module Tefoji
       end
     end
 
+    # Takes a Tefoji template as input and verifies that all components used in the template exist
+    # 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']
+
+        project = expand_right_value(epic['project']).value
+        update_valid_components(project)
+        epic['components'].each do |component|
+          invalid_components.add([project, component]) unless @valid_components[project].include?(component)
+        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']
+
+        project = if issue['project']
+                    expand_right_value(issue['project']).value
+                  else
+                    expand_right_value(main_template_data['issue_defaults']['project']).value
+                  end
+        update_valid_components(project)
+        issue['components'].each do |component|
+          invalid_components.add([project, component]) unless @valid_components[project].include?(component)
+        end
+      end
+
+      fail_message = "component validation failed. the following components do not exist within the given projects: \n"
+      invalid_components.each do |component_project, component|
+        fail_message += "#{component_project}, #{component} \n"
+      end
+      fatal fail_message unless invalid_components.empty?
+    end
+
+    def update_valid_components(project)
+      return if @valid_components.key?(project)
+
+      components_response = @jira_api.get_components(project)
+      valid_components = components_response.map { |component_data| component_data['name'] }
+      @valid_components[project] = valid_components
+    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: 3.2.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Puppet By Perforce
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-12 00:00:00.000000000 Z
+date: 2024-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debug
@@ -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
@@ -189,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: Generate Jira issues from a YAML specification.