tefoji 1.0.9 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8279bb8ebda1af1e674da5c4d16932b790e69210a5c163563746a80d44aca92b
-  data.tar.gz: f17bbc221ed1ec7c4fde90d2e64caddb45078ee0ee2d5cb59e7226d90df14317
+  metadata.gz: b048f1a4325a22d2fa736626f148827792639424d448ccc0d5a09250e250bdfa
+  data.tar.gz: 8350c3e8d0fdf3ad2ecfdf922ef654b37ddd86f9e44b4358cc713bf54cb462b8
 SHA512:
-  metadata.gz: d790551fe749db5eea41ce6889479c3f23e8278ad94744b8be4561d0cceadb33b609949c612224e49bbc21587b8b3cf50501a6eeef1e2d3059c860420e583c15
-  data.tar.gz: a0b4bd8875027f141a87f2bc960c43143813500db372e0764df428896fc04f34fd3f5b91d3a4d4ca305e9949b88dd3329f4363a1981905f6b4b7d7fe6c7b9fe9
+  metadata.gz: fd6187add4fe25d2ea7ebcc3aadc8346cfbfeae133e1fc4c366dad99395cfcbddd0aa6c024caa9f86676651037dcacdf0f1092a98ab0a2d1cc74a9033ab7dd7c
+  data.tar.gz: 2d5fe6518a6a174aeb033e006fa92b168f5115bb4526cb7dbbce2b177ac185bb79b795fcf7e43e86e63f063150bb5e5e6ad2fee28f17251010bbe2d319efd4c7

data/lib/mixins/user_functions.rb

@@ -34,7 +34,6 @@ module UserFunctions
   # Maps of Winston-style Jira names (projects, sprints, to the actual assets
   def jira_projects
     {
-      BOLT: 'BOLT',
       BUILD_TOOLS: 'BUILD',
       CLIENT_TOOLS: 'CT',
       CODE_MANAGEMENT: 'CODEMGMT',
@@ -50,14 +49,13 @@ module UserFunctions
       OPERATIONS: 'OPS',
       PDK: 'CONT',
       PE_INTERNAL: 'PE',
+      POOLER: 'POOLER',
       PROJECT_CENTRAL: 'PC',
       PUPPETDB: 'PDB',
       PUPPETSERVER: 'SERVER',
       PUPPET_AGENT: 'PA',
       PUPPET: 'PUP',
       QUALITY_ENGINEERING: 'QENG',
-      DIO: 'DIO',
-      RAZOR: 'RAZOR',
       RELEASE_ENGINEERING: 'RE',
       SLV: 'SLV',
       SUPPORT: 'SUP',

data/lib/tefoji/cli.rb

@@ -6,8 +6,11 @@ require 'yaml'
 module Tefoji
   class CLI
     DEFAULT_JIRA_URL = 'https://tickets.puppetlabs.com'
-    JIRA_TEST_URL = 'https://jira-app-dev-1.ops.puppetlabs.net'
+    JIRA_TEST_URL = 'https://jira-app-test-1.ops.puppetlabs.net/'
     DEFAULT_JIRA_AUTH_FILE = "#{ENV['HOME']}/.tefoji-auth.yaml"
+    JIRA_CLOUD_URLS = [
+      'https://puppet.atlassian.net'
+    ]
 
     DOCUMENTATION = <<~DOCOPT
       Generate Jira issues from YAML files.
@@ -47,19 +50,24 @@ module Tefoji
         exit 0
       end
 
+      @user_options['--jira'] = JIRA_TEST_URL if @user_options['--jira-test']
+      @user_options['--jira'] = DEFAULT_JIRA_URL if @user_options['--jira'].nil?
+
       @user_options['jira-auth-string'] = nil
       @user_options['jira-auth-file'] = @user_options['--jira-auth'] || DEFAULT_JIRA_AUTH_FILE
 
+      @user_options['jira-cloud'] = false
+      @user_options['jira-cloud'] = true if JIRA_CLOUD_URLS.include?(@user_options['--jira'])
+
       jira_auth_file = @user_options['jira-auth-file']
-      if File.file?(jira_auth_file)
-        authentication = YAML.load_file(jira_auth_file)
-        if authentication.key?('jira-auth')
-          @user_options['jira-auth-string'] = authentication['jira-auth']
-        end
-      end
+      return unless File.file?(jira_auth_file)
 
-      @user_options['--jira'] = JIRA_TEST_URL if @user_options['--jira-test']
-      @user_options['--jira'] = DEFAULT_JIRA_URL if @user_options['--jira'].nil?
+      authentication = YAML.load_file(jira_auth_file)
+      if @user_options['jira-cloud'] && authentication.key?('jira-cloud-auth')
+        @user_options['jira-auth-string'] = authentication['jira-cloud-auth']
+      elsif authentication.key?('jira-auth')
+        @user_options['jira-auth-string'] = authentication['jira-auth']
+      end
     end
 
     # Iterate through issue templates, validating each. If that goes well, generate

data/lib/tefoji/jira_api.rb

@@ -2,6 +2,7 @@ require 'base64'
 require 'io/console'
 require 'json'
 require 'rest-client'
+RestClient.log = 'stdout'
 
 module Tefoji
   ## An interface to send API request to Jira using the rest-client gem.
@@ -14,6 +15,7 @@ module Tefoji
     include Logging
 
     ## Jira field keys
+    FIELD_ACCOUNT_ID = 'accountId'
     FIELD_ID = 'id'
     FIELD_KEY = 'key'
     FIELD_NAME = 'name'
@@ -21,7 +23,6 @@ module Tefoji
 
     ## Issue type constants
     ISSUE_EPIC = 'Epic'
-    ISSUE_FEATURE = 'Feature'
     ISSUE_NEW_FEATURE = 'New Feature'
     ISSUE_SUB_TASK = 'Sub-task'
     ISSUE_TASK = 'Task'
@@ -74,20 +75,26 @@ 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(@jira_username)
+    def test_authentication(jira_cloud)
+      get_username(@jira_username, jira_cloud)
     rescue RestClient::Forbidden
       fatal 'Forbidden: either the authentication is incorrect or ' \
             'Jira might be requiring a CAPTCHA response from the web interface.'
     end
 
     # Get information about user in Jira
-    def get_username(username, fail_if_not_found = true)
-      jira_get("user?username=#{username}", fail_if_not_found)
+    def get_username(username, jira_cloud, fail_if_not_found = true)
+      search_parameters = if jira_cloud
+                            "user/search?query=#{username}"
+                          else
+                            "user?username=#{username}"
+                          end
+
+      jira_get(search_parameters, fail_if_not_found)
     end
 
     # Save authentication YAML to the a file for reuse.
-    def save_authentication(save_file_name)
+    def save_authentication(save_file_name, jira_cloud)
       backup_file_name = "#{save_file_name}.bak"
 
       if File.readable?(save_file_name)
@@ -95,18 +102,22 @@ module Tefoji
         @logger.info "Saved #{save_file_name} to #{backup_file_name}"
       end
 
-      File.open(save_file_name, 'w') do |f|
-        f.puts "jira-auth: #{@jira_auth_string}"
-      end
+      jira_auth_string = if jira_cloud
+                           "jira-auth: #{@jira_auth_string}\n"
+                         else
+                           "jira-cloud-auth: #{@jira_auth_string}\n"
+                         end
+      File.write(save_file_name, jira_auth_string)
+
       File.chmod(0o600, save_file_name)
 
       @logger.info "Saved Jira authentication to #{save_file_name}"
     end
 
     # Create a Jira issue
-    def create_issue(issue_data)
+    def create_issue(issue_data, jira_cloud)
       request_path = 'issue'
-      jira_fields = issue_data_to_jira_fields(issue_data)
+      jira_fields = issue_data_to_jira_fields(issue_data, jira_cloud)
       jira_post(request_path, jira_fields)
     rescue RestClient::Forbidden
       fatal "Forbidden: could not send #{request_path} request to Jira. "\
@@ -160,12 +171,25 @@ module Tefoji
     end
 
     # https://www.youtube.com/watch?v=JsntlJZ9h1U
-    def add_watcher(issue_key, watcher)
+    def add_watcher(issue_key, watcher, jira_cloud)
       request_path = "issue/#{issue_key}/watchers"
+      watcher = useremail_to_id(watcher) if jira_cloud
       request_data = watcher
       jira_post(request_path, request_data)
     end
 
+    # jira cloud api calls now require an accountId rather than a username. This method will convert
+    # emails or display names to accountIds.
+    def useremail_to_id(email)
+      response = get_username(email, true, true)[0]
+      id = response['accountId']
+      if id.nil? || id.empty?
+        @logger.error "accountId not found for #{email}."
+        exit 1
+      end
+      return id
+    end
+
     private
 
     def jira_get(jira_request_path, fail_if_not_found = true)
@@ -177,7 +201,6 @@ module Tefoji
         url = "#{@jira_base_rest_url}/#{jira_request_path}"
       end
       headers = @authentication_header
-
       begin
         response = RestClient.get(url, headers)
       rescue RestClient::MovedPermanently,
@@ -244,7 +267,7 @@ module Tefoji
     # Provide the needed translation of user-created data to required format
     # of Jira requests. This is mostly a list of fussing with the Jira field
     # names.
-    def issue_data_to_jira_fields(issue_data)
+    def issue_data_to_jira_fields(issue_data, jira_cloud)
       # Check to ensure we have what we need to create a issue
 
       unless issue_data['summary']
@@ -257,64 +280,130 @@ module Tefoji
       end
 
       # build the jira_fields hash describing the issue
-
       # These are required for all issues
       jira_fields = {
         'summary' => issue_data['summary'],
         'project' => { 'key' => issue_data['project'] }
       }
 
+      set_common_jira_fields(issue_data, jira_fields)
+
+      if jira_cloud
+        set_cloud_jira_fields(issue_data, jira_fields)
+      else
+        set_onprem_jira_fields(issue_data, jira_fields)
+      end
+
+      return { 'fields' => jira_fields }
+    end
+
+    def set_common_jira_fields(issue_data, jira_fields)
       # The following are optional
       if issue_data['description']
         jira_fields['description'] = issue_data['description']
       end
+
+      if issue_data['labels']
+        labels = issue_data['labels'].to_a.flatten.reject { |t| t =~ /^\s*$/ }
+        jira_fields['labels'] = labels unless labels.empty?
+      end
+      if issue_data['duedate']
+        jira_fields['duedate'] = issue_data['duedate']
+      end
+      if issue_data['fix_version']
+        jira_fields['fixVersions'] = [issue_data['fix_version']]
+      end
+
+      if issue_data['components']
+        components = issue_data[:components].to_a.flatten.reject { |t| t =~ /^\s*$/ }
+        unless components.empty?
+          jira_fields['components'] = components.map { |component| { FIELD_NAME => component } }
+        end
+      end
+
+      # Default issue type to ISSUE_TASK if it isn't already set
+      jira_fields['issuetype'] = { FIELD_NAME => ISSUE_TASK }
+
+      security = ENV['SECURITY'] || issue_data['security']
+      return unless security
+
+      case security.downcase
+      when 'confidential'
+        jira_fields['security'] = { FIELD_ID => '10002' }
+      when 'internal'
+        jira_fields['security'] = { FIELD_ID => '10001' }
+      when 'public'
+        # Nothing to do here - public is default
+      else
+        @logger.fatal "Unknown security type: #{security}"
+        exit 1
+      end
+    end
+
+    def set_cloud_jira_fields(issue_data, jira_fields)
       if issue_data['assignee']
-        jira_fields['assignee'] = { FIELD_NAME => issue_data['assignee'] }
+        assignee = issue_data['assignee']
+        assignee = useremail_to_id(assignee)
+        jira_fields['assignee'] = { FIELD_ACCOUNT_ID => assignee }
       end
+
+      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)
+          jira_fields['customfield_10011'] = issue_data['epic_name'] || issue_data['summary']
+        end
+      end
+
       if issue_data['story_points']
-        jira_fields['customfield_10002'] = issue_data['story_points'].to_i
+        jira_fields['customfield_10038'] = issue_data['story_points'].to_i
       end
       if issue_data['team']
-        jira_fields['customfield_14200'] = { FIELD_VALUE => issue_data['team'] }
+        jira_fields['customfield_10052'] = { 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 } }
+          jira_fields['customfield_10066'] = teams.map { |team| { FIELD_VALUE => team } }
         end
       end
       if issue_data['subteam']
-        jira_fields['customfield_11700'] = [issue_data['subteam']]
+        jira_fields['customfield_10045'] = [issue_data['subteam']]
       end
       if issue_data['sprint']
-        jira_fields['customfield_10005'] = issue_data['sprint'].to_i
+        jira_fields['customfield_10020'] = issue_data['sprint'].to_i
       end
       if issue_data['acceptance']
-        jira_fields['customfield_11501'] = issue_data['acceptance']
-      end
-      if issue_data['labels']
-        labels = issue_data['labels'].to_a.flatten.reject { |t| t =~ /^\s*$/ }
-        jira_fields['labels'] = labels unless labels.empty?
-      end
-      if issue_data['duedate']
-        jira_fields['duedate'] = issue_data['duedate']
-      end
-      if issue_data['fix_version']
-        jira_fields['fixVersions'] = [issue_data['fix_version']]
+        jira_fields['customfield_10062'] = issue_data['acceptance']
       end
       if issue_data['release_notes']
-        jira_fields['customfield_11100'] = { FIELD_VALUE => issue_data['release_notes'] }
+        jira_fields['customfield_10043'] = { FIELD_VALUE => issue_data['release_notes'] }
       end
 
-      if issue_data['components']
-        components = issue_data[:components].to_a.flatten.reject { |t| t =~ /^\s*$/ }
-        unless components.empty?
-          jira_fields['components'] = components.map { |component| { FIELD_NAME => component } }
+      # 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.
+
+      if issue_data['parent']
+        unless issue_data['type'].casecmp?(ISSUE_SUB_TASK) || !issue_data['type']
+          @logger.fatal "A issue with a parent must be classified as a Sub-issue\n\n#{issue_data}"
+          exit 1
+        end
+        jira_fields['issuetype'] = { FIELD_NAME => ISSUE_SUB_TASK }
+        jira_fields['parent'] = { FIELD_KEY => issue_data['parent'] }
+      elsif issue_data['epic_parent']
+        if issue_data['type'].casecmp?(ISSUE_SUB_TASK)
+          @logger.fatal "This issue cannot be a subtask of an epic\n\n#{issue_data}"
+          exit 1
         end
+        jira_fields['customfield_10018'] = issue_data['epic_parent']
       end
+    end
 
-      # Default issue type to ISSUE_TASK if it isn't already set
-      jira_fields['issuetype'] = { FIELD_NAME => ISSUE_TASK }
+    def set_onprem_jira_fields(issue_data, jira_fields)
+      if issue_data['assignee']
+        jira_fields['assignee'] = { FIELD_NAME => issue_data['assignee'] }
+      end
 
       if issue_data['type']
         jira_fields['issuetype'] = { FIELD_NAME => issue_data['type'] }
@@ -324,6 +413,31 @@ module Tefoji
         end
       end
 
+      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
+      if issue_data['sprint']
+        jira_fields['customfield_10005'] = issue_data['sprint'].to_i
+      end
+      if issue_data['acceptance']
+        jira_fields['customfield_11501'] = issue_data['acceptance']
+      end
+      if issue_data['release_notes']
+        jira_fields['customfield_11100'] = { FIELD_VALUE => issue_data['release_notes'] }
+      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.
@@ -342,23 +456,6 @@ module Tefoji
         end
         jira_fields['customfield_10006'] = issue_data['epic_parent']
       end
-
-      security = ENV['SECURITY'] || issue_data['security']
-      if security
-        case security.downcase
-        when 'confidential'
-          jira_fields['security'] = { FIELD_ID => '10002' }
-        when 'internal'
-          jira_fields['security'] = { FIELD_ID => '10001' }
-        when 'public'
-          # Nothing to do here - public is default
-        else
-          @logger.fatal "Unknown security type: #{security}"
-          exit 1
-        end
-      end
-
-      return { 'fields' => jira_fields }
     end
   end
 

data/lib/tefoji.rb

@@ -28,6 +28,7 @@ module Tefoji
       @jira_auth_string = user_options['jira-auth-string']
       @jira_auth_file = user_options['jira-auth-file']
       @jira_mock = user_options['--jira-mock']
+      @jira_cloud = user_options['jira-cloud']
 
       @no_notes = user_options['--no-notes']
       @template_data = {}
@@ -272,13 +273,13 @@ module Tefoji
       @jira_api.logger = @logger
 
       @jira_api.authenticate(@jira_url, @jira_user, @jira_auth_string)
-      @jira_api.test_authentication unless @jira_mock
+      @jira_api.test_authentication(@jira_cloud) unless @jira_mock
     end
 
     # Save Jira auth data
     def save_authentication
       authenticate unless @jira_api
-      @jira_api.save_authentication(@jira_auth_file)
+      @jira_api.save_authentication(@jira_auth_file, @jira_cloud)
     end
 
     private
@@ -297,8 +298,9 @@ module Tefoji
       feature_to_do = @template_data['feature']
 
       feature = variable_substitute(feature_to_do)
-      feature['type'] = JiraApi::ISSUE_FEATURE
-      @feature_issue = @jira_api.create_issue(feature)
+      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
@@ -360,7 +362,7 @@ module Tefoji
           epic['security'] = 'internal'
         end
 
-        epic_issue = @jira_api.create_issue(epic)
+        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
@@ -400,7 +402,7 @@ module Tefoji
         jira_ready_data, raw_issue_data = prepare_jira_ready_data(issue, issue_defaults)
         next if jira_ready_data.nil? || raw_issue_data.nil?
 
-        response_data = @jira_api.create_issue(jira_ready_data)
+        response_data = @jira_api.create_issue(jira_ready_data, @jira_cloud)
         jira_issue = @jira_api.retrieve_issue(response_data['self'])
         jira_issue['short_name'] = raw_issue_data['short_name']
 
@@ -610,7 +612,7 @@ module Tefoji
         issue_key = jira_issue_data['key']
         watchers = raw_issue_data[deferred_tag].value
         watchers.each do |watcher|
-          @jira_api.add_watcher(issue_key, watcher)
+          @jira_api.add_watcher(issue_key, watcher, @jira_cloud)
           @logger.info '%14s: watched by %s' % [issue_key, watcher]
         end
       end
@@ -932,7 +934,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, @jira_cloud, false)
         valid_users << username
       else
         invalid_users[username] = invalid_users.fetch(username, []) + [issue_name]

metadata

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