abide_dev_utils 0.12.2 → 0.14.0

data/lib/abide_dev_utils/jira.rb

@@ -11,6 +11,7 @@ module AbideDevUtils
     ERRORS = AbideDevUtils::Errors::Jira
     COV_PARENT_SUMMARY_PREFIX = '::BENCHMARK:: '
     COV_CHILD_SUMMARY_PREFIX = '::CONTROL:: '
+    PROGRESS_BAR_FORMAT = '%a %e %P% Created: %c of %C'
 
     def self.project(client, project)
       client.Project.find(project)
@@ -18,6 +19,11 @@ module AbideDevUtils
 
     def self.issue(client, issue)
       client.Issue.find(issue)
+    rescue URI::InvalidURIError
+      iss = client.Issue.all.find { |i| i.summary == issue }
+      raise ERRORS::FindIssueError, issue unless iss
+
+      iss
     end
 
     def self.myself(client)
@@ -25,11 +31,19 @@ module AbideDevUtils
     end
 
     def self.issuetype(client, id)
-      client.Issuetype.find(id)
+      if id.match?(%r{^\d+$})
+        client.Issuetype.find(id)
+      else
+        client.Issuetype.all.find { |i| i.name == id }
+      end
     end
 
     def self.priority(client, id)
-      client.Priority.find(id)
+      if id.match?(%r{^\d+$})
+        client.Priority.find(id)
+      else
+        client.Priority.all.find { |i| i.name == id }
+      end
     end
 
     def self.all_project_issues_attrs(project)
@@ -37,21 +51,50 @@ module AbideDevUtils
       raw_issues.collect(&:attrs)
     end
 
-    def self.new_issue(client, project, summary, dry_run: false)
+    def self.add_issue_label(iss, label, dry_run: false)
+      return if dry_run || iss.labels.include?(label)
+
+      iss.labels << profile_summary
+      iss.save
+    end
+
+    def self.new_issue(client, project, summary, labels: ['abide_dev_utils'], epic: nil, dry_run: false)
       if dry_run
         sleep(0.2)
-        return Dummy.new
+        return Dummy.new(summary)
       end
       fields = {}
       fields['summary'] = summary
       fields['project'] = project(client, project)
       fields['reporter'] = myself(client)
-      fields['issuetype'] = issuetype(client, '3')
+      fields['issuetype'] = issuetype(client, 'Task')
       fields['priority'] = priority(client, '6')
-      issue = client.Issue.build
-      raise ERRORS::CreateIssueError, issue.attrs unless issue.save({ 'fields' => fields })
+      fields['labels'] = labels
+      epic = issue(client, epic) if epic && !epic.is_a?(JIRA::Resource::Issue)
+      fields['customfield_10006'] = epic.key if epic # Epic_Link
+      iss = client.Issue.build
+      raise ERRORS::CreateIssueError, iss.attrs unless iss.save({ 'fields' => fields })
 
-      issue
+      iss
+    end
+
+    def self.new_epic(client, project, summary, dry_run: false)
+      AbideDevUtils::Output.simple("#{dr_prefix(dry_run)}Creating epic '#{summary}'")
+      if dry_run
+        sleep(0.2)
+        return Dummy.new(summary)
+      end
+      fields = {
+        'summary' => summary,
+        'project' => project(client, project),
+        'reporter' => myself(client),
+        'issuetype' => issuetype(client, 'Epic'),
+        'customfield_10007' => summary, # Epic Name
+      }
+      iss = client.Issue.build
+      raise ERRORS::CreateEpicError, iss.attrs unless iss.save({ 'fields' => fields })
+
+      iss
     end
 
     # This should probably be threaded in the future
@@ -135,46 +178,55 @@ module AbideDevUtils
       end
     end
 
-    def self.new_issues_from_xccdf(client, project, xccdf_path, dry_run: false)
-      dr_prefix = dry_run ? 'DRY RUN: ' : ''
+    def self.new_issues_from_xccdf(client, project, xccdf_path, epic: nil, dry_run: false)
       i_attrs = all_project_issues_attrs(project)
-
       xccdf = AbideDevUtils::XCCDF::Benchmark.new(xccdf_path)
-
-      summaries = summaries_from_xccdf(xccdf)
-      summaries.each do |profile_summary, control_summaries|
-        if summary_exist?(profile_summary, i_attrs)
-          AbideDevUtils::Output.simple("#{dr_prefix}Skipping #{profile_summary} as it already exists")
-          next
+      # We need to get the actual epic Issue object, or create it if it doesn't exist
+      epic = if epic.nil?
+               new_epic_summary = "#{COV_PARENT_SUMMARY_PREFIX}#{xccdf.title}"
+               if summary_exist?(new_epic_summary, i_attrs)
+                 issue(client, new_epic_summary)
+               else
+                 unless AbideDevUtils::Prompt.yes_no("#{dr_prefix(dry_run)}Create new epic '#{new_epic_summary}'?")
+                   AbideDevUtils::Output.simple("#{dr_prefix(dry_run)}Aborting")
+                   exit(0)
+                 end
+                 new_epic(client, project.key, new_epic_summary, dry_run: dry_run)
+               end
+             else
+               issue(client, epic)
+             end
+      # Now we need to find out which issues we need to create for the benchmark
+      # The profiles that the control belongs to will be added as an issue label
+      to_create = {}
+      summaries_from_xccdf(xccdf).each do |profile_summary, control_summaries|
+        control_summaries.reject { |s| summary_exist?(s, i_attrs) }.each do |control_summary|
+          if to_create.key?(control_summary)
+            to_create[control_summary] << profile_summary.split.join('_').downcase
+          else
+            to_create[control_summary] = [profile_summary.split.join('_').downcase]
+          end
         end
+      end
 
-        parent = new_issue(client, project.attrs['key'], profile_summary, dry_run: dry_run)
-        AbideDevUtils::Output.simple("#{dr_prefix}Created parent issue #{profile_summary}")
-        parent_issue = issue(client, parent.attrs['key']) unless parent.respond_to?(:dummy)
-        AbideDevUtils::Output.simple("#{dr_prefix}Creating subtasks, this can take a while...")
-        progress = AbideDevUtils::Output.progress(title: "#{dr_prefix}Creating Subtasks", total: nil)
-        control_summaries.each do |control_summary|
-          next if summary_exist?(control_summary, i_attrs)
+      unless AbideDevUtils::Prompt.yes_no("#{dr_prefix(dry_run)}Create #{to_create.keys.count} new Jira issues?")
+        AbideDevUtils::Output.simple("#{dr_prefix(dry_run)}Aborting")
+        exit(0)
+      end
 
-          progress.title = "#{dr_prefix}#{control_summary}"
-          new_subtask(client, parent_issue, control_summary, dry_run: dry_run)
-          progress.increment
-        end
-        final_text = "#{dr_prefix}Created #{control_summaries.count} subtasks for #{profile_summary}"
-        puts "\r\033[K#{final_text}\n"
+      progress = AbideDevUtils::Output.progress(title: "#{dr_prefix(dry_run)}Creating issues",
+                                                total: to_create.keys.count,
+                                                format: PROGRESS_BAR_FORMAT)
+      to_create.each do |control_summary, labels|
+        abrev = control_summary.length > 40 ? control_summary[0..60] : control_summary
+        progress.log("#{dr_prefix(dry_run)}Creating #{abrev}...")
+        new_issue(client, project.key, control_summary, labels: labels, epic: epic, dry_run: dry_run)
+        progress.increment
       end
+      progress.finish
+      AbideDevUtils::Output.simple("#{dr_prefix(dry_run)}Done creating tasks in Epic '#{epic.summary}'")
     end
 
-    # def self.new_issues_from_comply_report(client, project, report, dry_run: false)
-    #   dr_prefix = dry_run ? 'DRY RUN: ' : ''
-    #   i_attrs = all_project_issues_attrs(project)
-    #   rep_sums = summaries_from_coverage_report(report)
-    #   rep_sums.each do |k, v|
-    #     next if summary_exist?(k, i_attrs)
-
-    #     progress = AbideDevUtils::Output.progress(title: "#{dr_prefix}Creating Tasks", total: nil)
-    #     v.each do |s|
-
     def self.merge_options(options)
       config.merge(options)
     end
@@ -209,25 +261,30 @@ module AbideDevUtils
 
     def self.summaries_from_xccdf(xccdf)
       summaries = {}
-      facter_os = xccdf.facter_benchmark.join('-')
       xccdf.profiles.each do |profile|
-        summaries["#{COV_PARENT_SUMMARY_PREFIX}#{facter_os} - #{profile.level} #{profile.title}"] = profile.controls.collect do |control|
-          summary = "#{COV_CHILD_SUMMARY_PREFIX}#{control.vulnid} - #{control.title}"
-          if summary.length > 255
-            summary = summary[0..251] + '...'
-          end
+        sum_key = "#{profile.level}_#{profile.title}".split.join('_').downcase
+        summaries[sum_key] = profile.controls.collect do |control|
+          control_id = control.respond_to?(:vulnid) ? control.vulnid : control.number
+          summary = "#{control_id} - #{control.title}"
+          summary = "#{summary[0..251]}..." if summary.length > 255
           summary
         end
       end
       summaries
     end
 
-    # def self.summaries_from_comply_report(report)
-    #   summaries = {}
-    #   report.each do |_, v|
-    # end
+    def self.dr_prefix(dry_run)
+      dry_run ? 'DRY RUN: ' : ''
+    end
 
     class Dummy
+      attr_reader :summary, :key
+
+      def initialize(summary = 'dummy summary')
+        @summary = summary
+        @key = 'DUM-111'
+      end
+
       def attrs
         { 'fields' => {
           'project' => 'dummy',

data/lib/abide_dev_utils/markdown.rb

@@ -49,6 +49,10 @@ module AbideDevUtils
       "#### #{text}\n"
     end
 
+    def paragraph(text)
+      "#{text}\n"
+    end
+
     def ul(text, indent: 0)
       indented_text = []
       indent.times { indented_text << '  ' } if indent.positive?

data/lib/abide_dev_utils/output.rb

@@ -10,30 +10,44 @@ require 'abide_dev_utils/files'
 module AbideDevUtils
   module Output
     FWRITER = AbideDevUtils::Files::Writer.new
-    def self.simple(msg, stream: $stdout)
-      stream.puts msg
+    def self.simple(msg, stream: $stdout, **_)
+      case msg
+      when Hash
+        stream.puts JSON.pretty_generate(msg)
+      else
+        stream.puts msg
+      end
     end
 
-    def self.json(in_obj, console: false, file: nil, pretty: true)
+    def self.text(msg, console: false, file: nil, **_)
+      simple(msg) if console
+      FWRITER.write_text(msg, file: file) unless file.nil?
+    end
+
+    def self.json(in_obj, console: false, file: nil, pretty: true, **_)
       AbideDevUtils::Validate.hashable(in_obj)
       json_out = pretty ? JSON.pretty_generate(in_obj) : JSON.generate(in_obj)
       simple(json_out) if console
       FWRITER.write_json(json_out, file: file) unless file.nil?
     end
 
-    def self.yaml(in_obj, console: false, file: nil)
+    def self.yaml(in_obj, console: false, file: nil, stringify: false, **_)
       yaml_out = if in_obj.is_a? String
                    in_obj
                  else
                    AbideDevUtils::Validate.hashable(in_obj)
-                   # Use object's #to_yaml method if it exists, convert to hash if not
-                   in_obj.respond_to?(:to_yaml) ? in_obj.to_yaml : in_obj.to_h.to_yaml
+                   if stringify
+                     JSON.parse(JSON.generate(in_obj)).to_yaml
+                   else
+                     # Use object's #to_yaml method if it exists, convert to hash if not
+                     in_obj.respond_to?(:to_yaml) ? in_obj.to_yaml : in_obj.to_h.to_yaml
+                   end
                  end
       simple(yaml_out) if console
       FWRITER.write_yaml(yaml_out, file: file) unless file.nil?
     end
 
-    def self.yml(in_obj, console: false, file: nil)
+    def self.yml(in_obj, console: false, file: nil, **_)
       AbideDevUtils::Validate.hashable(in_obj)
       # Use object's #to_yaml method if it exists, convert to hash if not
       yml_out = in_obj.respond_to?(:to_yaml) ? in_obj.to_yaml : in_obj.to_h.to_yaml
@@ -41,8 +55,8 @@ module AbideDevUtils
       FWRITER.write_yml(yml_out, file: file) unless file.nil?
     end
 
-    def self.progress(title: 'Progress', start: 0, total: 100)
-      ProgressBar.create(title: title, starting_at: start, total: total)
+    def self.progress(title: 'Progress', start: 0, total: 100, format: nil, **_)
+      ProgressBar.create(title: title, starting_at: start, total: total, format: format)
     end
   end
 end

data/lib/abide_dev_utils/ppt/code_introspection.rb

@@ -10,17 +10,30 @@ module AbideDevUtils
         attr_reader :manifest_file
 
         def initialize(manifest_file)
+          @compiler = Puppet::Pal::Compiler.new(nil)
           @manifest_file = File.expand_path(manifest_file)
           raise ArgumentError, "File #{@manifest_file} is not a file" unless File.file?(@manifest_file)
         end
 
         def ast
-          @ast ||= Puppet::Pal::Compiler.new(nil).parse_file(manifest_file)
+          @ast ||= non_validating_parse_file(manifest_file)
         end
 
         def declaration
           @declaration ||= Declaration.new(ast)
         end
+
+        private
+
+        # This method gets around the normal validation performed by the regular
+        # Puppet::Pal::Compiler#parse_file method. This is necessary because, with
+        # validation enabled, the parser will raise errors during parsing if the
+        # file contains any calls to Facter. This is due to facter being disallowed
+        # in Puppet when evaluating the code in a scripting context instead of catalog
+        # compilation, which is what we are doing here.
+        def non_validating_parse_file(file)
+          @compiler.send(:internal_evaluator).parser.parse_file(file)&.model
+        end
       end
 
       class Declaration