abide_dev_utils 0.17.0 → 0.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0216511efe504da6597b81a7b494975377b8afe013697e37f9985467a6a4fa14
-  data.tar.gz: '08265323331b31cb17e875b951ce89dfcb83bbb9649c0df97513cff26355f713'
+  metadata.gz: ba0491c8fbcaa0a69015c410a2aa7e61ac61e6b30caca6fb5b334d22fd77069c
+  data.tar.gz: 119c837a5ea897957e63744ec3f38a7567222d7dbb5b952302ec71cd70aafc24
 SHA512:
-  metadata.gz: 9cbd439058affe3311587d81d4dfe75191abe9f9fb1a1f8c964c2a8187f02cf9057943e4bacd5aaeb1676c936cccdd5e196b9d4a0822ed0c725d06fe0c46f0d3
-  data.tar.gz: f01c66b8079d9d257de1158f4a1f9f529b2e9e31c8eb04a19fa21fee63f34b2fa018b8e3bba8eefce2bf90d20f23249e27a83126f54057232aef6bd7658cbe0a
+  metadata.gz: 492066b562bee8dd3c3d3b465396a569d66a66200018bb74e606c8f3a78320853ecc71a8f30ee0c4f18194dbdc0d8679ff8c32fd38fbaf7936267eae1b35d5eb
+  data.tar.gz: 2766d7c84c887b573cd9cb23f5d2aa869a4f238e5208ab2377832827e88d44056d180226a31c93ee242ed954d6aaf65b0e075d282b65ba53ea475ae1adb8e45a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    abide_dev_utils (0.17.0)
+    abide_dev_utils (0.17.1)
       cmdparse (~> 3.0)
       facterdb (>= 1.21)
       google-cloud-storage (~> 1.34)

data/lib/abide_dev_utils/cli/jira.rb

@@ -118,7 +118,12 @@ module Abide
         short_desc(CMD_SHORT)
         long_desc(CMD_LONG)
         argument_desc(PATH: 'An XCCDF file', PROJECT: 'A Jira project')
-        options.on('-d', '--dry-run', 'Print to console instead of saving objects') { |_| @data[:dry_run] = true }
+        options.on('-d', '--dry-run', 'Runs through mock issue creation. Useful for testing, but not reliable for knowing what exactly will be created. Use --explain for more accurate information.') do
+          @data[:dry_run] = true
+        end
+        options.on('-x', '--explain', 'Shows a report of all the controls that will and won\'t be created as issues, and why. DOES NOT create issues.') do
+          @data[:explain] = true
+        end
         options.on('-e [EPIC]', '--epic [EPIC]', 'If given, tasks will be created and assigned to this epic. Takes form <PROJECT>-<NUM>') { |e| @data[:epic] = e }
         options.on('-l [LEVEL]', '--level [LEVEL]', 'Only create tasks for rules belonging to the matching level. Takes a string that is treated as RegExp') do |x|
           @data[:level] = x
@@ -136,12 +141,13 @@ module Abide
         @data[:label_include] = nil
         @data[:label_include] = "level_#{@data[:level]}_" if @data[:level]
         @data[:label_include] = "#{@data[:label_include]}#{@data[:profile]}" if @data[:profile]
-        Abide::CLI::Output.simple "Label include: #{@data[:label_include]}"
+        Abide::CLI::OUTPUT.simple "Label include: #{@data[:label_include]}"
         AbideDevUtils::Jira.new_issues_from_xccdf(
           project,
           path,
           epic: @data[:epic],
           dry_run: @data[:dry_run],
+          explain: @data[:explain],
           label_include: @data[:label_include],
         )
       end

data/lib/abide_dev_utils/jira/client.rb

@@ -47,6 +47,10 @@ module AbideDevUtils
         @helper ||= Helper.new(self, dry_run: @dry_run)
       end
 
+      def translate_issue_custom_field(name)
+        IssueBuilder::CUSTOM_FIELDS[name] || IssueBuilder::CUSTOM_FIELDS.invert[name]
+      end
+
       private
 
       def client

data/lib/abide_dev_utils/jira/dry_run.rb

@@ -12,19 +12,20 @@ module AbideDevUtils
               if !!@dry_run
                 case method_name
                 when %r{^create}
-                  AbideDevUtils::Output.simple("DRY RUN: #{self.class.name}##{method_name}(#{args[0]}, #{args[1].map { |k, v| "#{k}: #{v.inspect}" }.join(', ')})")
+                  AbideDevUtils::Output.simple("DRY RUN: #{self.class.name}##{method_name}(#{args[0]}, #{kwargs.map { |k, v| "#{k}: #{v.inspect}" }.join(', ')})")
                   sleep 0.1
                   return DummyIssue.new if args[0].match?(%r{^issue$})
                   return DummySubtask.new if args[0].match?(%r{^subtask$})
                 when %r{^find}
-                  AbideDevUtils::Output.simple("DRY RUN: #{self.class.name}##{method_name}(#{args[0]}, #{args[1].inspect})")
+                  AbideDevUtils::Output.simple("DRY RUN: #{self.class.name}##{method_name}(#{args[0]}, #{kwargs.inspect})")
                   return DummyIssue.new if args[0].match?(%r{^issue$})
                   return DummySubtask.new if args[0].match?(%r{^subtask$})
                   return DummyProject.new if args[0].match?(%r{^project$})
+                  return [] if args[0].match?(%r{^issues_by_jql$})
 
                   "Dummy #{args[0].capitalize}"
                 else
-                  AbideDevUtils::Output.simple("DRY RUN: #{self.class.name}##{method_name}(#{args.map(&:inspect).join(', ')})")
+                  AbideDevUtils::Output.simple("DRY RUN: #{self.class.name}##{method_name}(#{args.map(&:inspect).join(', ')}, #{kwargs.map { |k, v| "#{k}: #{v.inspect}" }.join(', ')})")
                 end
               else
                 super(*args, **kwargs)
@@ -77,7 +78,7 @@ module AbideDevUtils
       class Dummy
         attr_reader :dummy
 
-        def initialize
+        def initialize(*_args, **_kwargs)
           @dummy = true
         end
       end
@@ -85,10 +86,14 @@ module AbideDevUtils
       class DummyIssue < Dummy
         attr_reader :summary, :key
 
-        def initialize
+        def initialize(summary = 'Dummy Issue', key = 'DUM-111')
           super
-          @summary = 'Dummy Issue'
-          @key = 'DUM-111'
+          @summary = summary
+          @key = key
+        end
+
+        def labels
+          @labels ||= ['abide_dev_utils']
         end
 
         def attrs
@@ -102,10 +107,8 @@ module AbideDevUtils
       end
 
       class DummySubtask < DummyIssue
-        def initialize
-          super
-          @summary = 'Dummy Subtask'
-          @key = 'DUM-222'
+        def initialize(summary = 'Dummy Subtask', key = 'DUM-222')
+          super(summary, key)
         end
 
         def attrs
@@ -122,7 +125,7 @@ module AbideDevUtils
       class DummyProject < Dummy
         attr_reader :key, :issues
 
-        def initialize
+        def initialize(key = 'DUM', issues = [DummyIssue.new, DummySubtask.new])
           super
           @key = 'DUM'
           @issues = [DummyIssue.new, DummySubtask.new]

data/lib/abide_dev_utils/jira/finder.rb

@@ -32,6 +32,12 @@ module AbideDevUtils
         iss
       end
 
+      # @param jql [String] The JQL query
+      # @return [Array<JIRA::Resource::Issue>]
+      def issues_by_jql(jql)
+        client.Issue.jql(jql, max_results: 1000)
+      end
+
       # @param id [String] The issuetype ID or name
       def issuetype(id)
         return id if id.is_a?(client.Issuetype.target_class)

data/lib/abide_dev_utils/jira.rb

@@ -43,7 +43,9 @@ module AbideDevUtils
       end
     end
 
-    def self.new_issues_from_xccdf(project, xccdf_path, epic: nil, dry_run: false, label_include: nil)
+    ToCreateData = Struct.new(:summary, :labels, :should_create, :metadata)
+
+    def self.new_issues_from_xccdf(project, xccdf_path, epic: nil, dry_run: false, explain: false, label_include: nil)
       client(dry_run: dry_run) # Initializes the client if needed
       i_attrs = client.helper.all_project_issues_attrs(project)
       xccdf = AbideDevUtils::XCCDF::Benchmark.new(xccdf_path)
@@ -64,42 +66,112 @@ module AbideDevUtils
              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 = {}
+      to_create = []
       summaries_from_xccdf(xccdf).each do |profile_summary, control_summaries|
-        control_summaries.reject { |s| client.helper.summary_exist?(s, i_attrs) }.each do |control_summary|
-          if to_create.key?(control_summary)
-            to_create[control_summary] << profile_summary.split.join('_').downcase
+        control_summaries.each do |control_summary|
+          existing_to_create = to_create.find { |tc| tc.summary == control_summary }
+          if existing_to_create
+            existing_to_create.labels << profile_summary.split.join('_').downcase
           else
-            to_create[control_summary] = [profile_summary.split.join('_').downcase]
+            new_to_create = ToCreateData.new(
+              summary: control_summary,
+              labels: [profile_summary.split.join('_').downcase],
+              should_create: true,
+              metadata: {
+                epic_key: epic.key,
+                project: project,
+              },
+            )
+            to_create << new_to_create
           end
         end
       end
 
-      # If we have a label_include, we need to filter out any controls that don't have that label
-      unless label_include.nil?
-        to_create = to_create.select do |_control_summary, labels|
-          labels.any? { |l| l.match?(label_include) }
-        end
-      end
+      final_to_create = filter_to_create(to_create, label_include, project, epic)
+
+      return explain_this(to_create) if explain
 
-      unless AbideDevUtils::Prompt.yes_no("#{dr_prefix(dry_run)}Create #{to_create.keys.count} new Jira issues?")
+      unless AbideDevUtils::Prompt.yes_no("#{dr_prefix(dry_run)}Create #{final_to_create.count} new Jira issues?")
         AbideDevUtils::Output.simple("#{dr_prefix(dry_run)}Aborting")
         exit(0)
       end
 
       progress = AbideDevUtils::Output.progress(title: "#{dr_prefix(dry_run)}Creating issues",
-                                                total: to_create.keys.count,
+                                                total: final_to_create.count,
                                                 format: PROGRESS_BAR_FORMAT)
-      to_create.each do |control_summary, labels|
-        abrev = control_summary.length > 40 ? control_summary[0..60] : control_summary
+      final_to_create.each do |tc|
+        abrev = tc.summary.length > 40 ? tc.summary[0..60] : tc.summary
         progress.log("#{dr_prefix(dry_run)}Creating #{abrev}...")
-        client.create(:issue, project: project, summary: control_summary, labels: labels, epic_link: epic)
+        client.create(:issue, project: project, summary: tc.summary, labels: tc.labels, epic_link: epic)
         progress.increment
       end
       progress.finish
       AbideDevUtils::Output.simple("#{dr_prefix(dry_run)}Done creating tasks in Epic '#{epic.summary}'")
     end
 
+    def self.filter_to_create(to_create, label_include, project, epic)
+      not_already_exists = filter_already_exists(to_create, project, epic)
+      AbideDevUtils::Output.simple(
+        "Filtered out #{to_create.count - not_already_exists.count} issues that already existed",
+      )
+      only_label_include = filter_label_include(not_already_exists, label_include)
+      AbideDevUtils::Output.simple(
+        "Filtered out #{not_already_exists.count - only_label_include.count} issues that didn't include the label #{label_include}",
+      )
+      only_label_include
+    end
+
+    def self.filter_already_exists(to_create, project, epic)
+      AbideDevUtils::Output.simple('Checking if issues already exist...')
+      project = client.find(:project, project)
+      epic = client.find(:issue, epic)
+      issues = client.find(:issues_by_jql, "project = \"#{project.key}\" AND 'Epic Link' = \"#{epic.key}\"")
+      to_create.reject do |tc|
+        if issues.any? { |i| i.summary == tc.summary }
+          tc.metadata[:already_exists] = true
+          tc.should_create = false
+          true
+        else
+          tc.metadata[:already_exists] = false
+          false
+        end
+      end
+    end
+
+    # If we have a label_include, we need to filter out any controls that don't have that label
+    def self.filter_label_include(to_create, label_include)
+      return to_create if label_include.nil?
+
+      AbideDevUtils::Output.simple("Filtering out controls that don't match label include: #{label_include}")
+      to_create.select do |tc|
+        if tc.labels.any? { |l| l.match?(label_include) }
+          tc.metadata[:label_include] = true
+          true
+        else
+          tc.metadata[:label_include] = false
+          tc.should_create = false
+          false
+        end
+      end
+    end
+
+    def self.explain_this(to_create)
+      should_create = to_create.select(&:should_create)
+      should_not_create = to_create.reject(&:should_create)
+      AbideDevUtils::Output.simple(AbideDevUtils::Output.simple_section_separator('EXPLAIN'))
+      AbideDevUtils::Output.simple("Will create #{should_create.count} issues")
+      AbideDevUtils::Output.simple("Will not create #{should_not_create.count} issues")
+      AbideDevUtils::Output.simple(AbideDevUtils::Output.simple_section_separator('WILL CREATE'))
+      should_create.each do |tc|
+        AbideDevUtils::Output.simple("\"#{tc.summary}\"; labels: #{tc.labels}; metadata: #{tc.metadata}")
+      end
+      AbideDevUtils::Output.simple(AbideDevUtils::Output.simple_section_separator('WILL NOT CREATE'))
+      should_not_create.each do |tc|
+        AbideDevUtils::Output.simple("\"#{tc.summary}\"; labels: #{tc.labels}; metadata: #{tc.metadata}")
+      end
+      exit(0)
+    end
+
     def self.new_issues_from_xccdf_diff(project, xccdf1_path, xccdf2_path, epic: nil, dry_run: false, auto_approve: false, diff_opts: {})
       require 'abide_dev_utils/xccdf/diff'
       diff = AbideDevUtils::XCCDF::Diff::BenchmarkDiff.new(xccdf1_path, xccdf2_path, diff_opts)

data/lib/abide_dev_utils/output.rb

@@ -10,6 +10,14 @@ require 'abide_dev_utils/files'
 module AbideDevUtils
   module Output
     FWRITER = AbideDevUtils::Files::Writer.new
+    def self.simple_section_separator(section_text, sepchar: '#', width: 60, **_)
+      section_text = section_text.to_s
+      section_text = section_text[0..width - 4] if section_text.length > width
+      section_text = " #{section_text} "
+      section_sep_line = sepchar * width
+      [section_sep_line, section_text.center(width, sepchar), section_sep_line].join("\n")
+    end
+
     def self.simple(msg, stream: $stdout, **_)
       case msg
       when Hash

data/lib/abide_dev_utils/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AbideDevUtils
-  VERSION = "0.17.0"
+  VERSION = "0.17.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abide_dev_utils
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.17.1
 platform: ruby
 authors:
 - abide-team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-02 00:00:00.000000000 Z
+date: 2023-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri