abide_dev_utils 0.17.1 → 0.17.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba0491c8fbcaa0a69015c410a2aa7e61ac61e6b30caca6fb5b334d22fd77069c
-  data.tar.gz: 119c837a5ea897957e63744ec3f38a7567222d7dbb5b952302ec71cd70aafc24
+  metadata.gz: 69b32737c24844c999bd460d836d6eef7d87be94363c4b2ba277807042b646a5
+  data.tar.gz: a391723e49202b26efbf77b24e5ae65a4114889eb56c8c1428784d6da84be0b8
 SHA512:
-  metadata.gz: 492066b562bee8dd3c3d3b465396a569d66a66200018bb74e606c8f3a78320853ecc71a8f30ee0c4f18194dbdc0d8679ff8c32fd38fbaf7936267eae1b35d5eb
-  data.tar.gz: 2766d7c84c887b573cd9cb23f5d2aa869a4f238e5208ab2377832827e88d44056d180226a31c93ee242ed954d6aaf65b0e075d282b65ba53ea475ae1adb8e45a
+  metadata.gz: f30ad258bce39e8a9801440998ad6f4fd80caced6779f0836c288434539acb817e8d31e221cc143b2e5b431e193333d84f211cd47d18449a0d1d5abaa7be0811
+  data.tar.gz: adfeaa5dc2da9bb80f6da347115bf4f102387fd936763f0c7ac0a74e3c146b6d84e7a4c00b81bc32c6fad923871d86af8e609b8c346c2f18d7a57ad4a04ba019

data/Gemfile.lock

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

data/lib/abide_dev_utils/cli/jira.rb

@@ -163,6 +163,11 @@ module Abide
         long_desc(CMD_LONG)
         argument_desc(PATH1: 'An XCCDF file', PATH2: '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('-z', '--print-only', 'Prints a list of issues that would be created. Implies dry-run, and auto-approve, but less verbose than --dry-run.') do
+          @data[:print_only] = true
+          @data[:dry_run] = true
+          @data[:auto_approve] = true
+        end
         options.on('-y', '--yes', 'Automatically approve all yes / no prompts') { |_| @data[:auto_approve] = true }
         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('-p [PROFILE]', '--profile', 'Only diff rules belonging to the matching profile. Takes a string that is treated as RegExp') do |x|
@@ -188,8 +193,9 @@ module Abide
           path2,
           epic: @data[:epic],
           dry_run: @data[:dry_run],
+          print_only: @data[:print_only],
           auto_approve: @data[:auto_approve],
-          diff_opts: @data[:diff_opts],
+          diff_opts: @data[:diff_opts] || {},
         )
       end
     end

data/lib/abide_dev_utils/jira.rb

@@ -172,18 +172,18 @@ module AbideDevUtils
       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: {})
+    def self.new_issues_from_xccdf_diff(project, xccdf1_path, xccdf2_path, epic: nil, dry_run: false, print_only: false, auto_approve: false, diff_opts: {})
       require 'abide_dev_utils/xccdf/diff'
       diff = AbideDevUtils::XCCDF::Diff::BenchmarkDiff.new(xccdf1_path, xccdf2_path, diff_opts)
       client(dry_run: dry_run) # Initializes the client if needed
       i_attrs = client.helper.all_project_issues_attrs(project)
       # 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}"
+               new_epic_summary = "#{COV_PARENT_SUMMARY_PREFIX}#{diff.this.title}: #{diff.this.version} -> #{diff.other.version}"
                if client.helper.summary_exist?(new_epic_summary, i_attrs)
                  client.find(:issue, new_epic_summary)
                else
-                 unless AbideDevUtils::Prompt.yes_no("#{dr_prefix(dry_run)}Create new epic '#{new_epic_summary}'?")
+                 unless AbideDevUtils::Prompt.yes_no("#{dr_prefix(dry_run)}Create new epic '#{new_epic_summary}'?", auto_approve: auto_approve)
                    AbideDevUtils::Output.simple("#{dr_prefix(dry_run)}Aborting")
                    exit(0)
                  end
@@ -202,30 +202,57 @@ module AbideDevUtils
             sum = "Add rule #{v[:number]} - #{v[:title]}"
             sum = "#{sum[0..60]}..." if sum.length > 60
             to_create[sum] = <<~DESC
-              Rule #{v[:number]} - #{v[:title]} is added with #{diff.other.title} #{diff.other.version}
+              Rule #{v[:number]} - #{v[:title]} is added
+
+              * From:
+                * Benchmark: #{diff.this.title} #{diff.this.version}
+              * To:
+                * Benchmark: #{diff.other.title} #{diff.other.version}
             DESC
           when :removed
             sum = "Remove rule #{v[:number]} - #{v[:title]}"
             sum = "#{sum[0..60]}..." if sum.length > 60
             to_create[sum] = <<~DESC
-              Rule #{v[:number]} - #{v[:title]} is removed from #{diff.this.title} #{diff.this.version}
+              Remove rule #{v[:number]} - #{v[:title]}
+
+              * From:
+                * Benchmark: #{diff.this.title} #{diff.this.version}
+              * To:
+                * Benchmark: #{diff.other.title} #{diff.other.version}
             DESC
           else
-            sum = "Update rule \"#{v[:from]}\""
+            sum = "Changed rule \"#{v[:from]}\""
             sum = "#{sum[0..60]}..." if sum.length > 60
             to_create[sum] = <<~DESC
-              Rule #{v[:from]} is updated in #{diff.other.title} #{diff.other.version}:
-              #{v[:changes].collect { |k, v| "#{k}: #{v}" }.join("\n")}
+              #{v[:changes].collect { |ck, cv| "Property \"#{ck}\" changed: \"#{cv.last}\" changed to \"#{cv.first}\"" }.join("\n  ")}
+
+              * From:
+                * Rule: #{v[:from]}
+                * Benchmark: #{diff.this.title} #{diff.this.version}
+              * To:
+                * Rule: #{v[:to]}
+                * Benchmark: #{diff.other.title} #{diff.other.version}
             DESC
           end
         end
       end
       approved_create = {}
       to_create.each do |summary, description|
-        if AbideDevUtils::Prompt.yes_no("#{dr_prefix(dry_run)}Create new issue '#{summary}' with description:\n#{description}", auto_approve: auto_approve)
+        section_header = "#{dr_prefix(dry_run)}NEW ISSUE"
+        prompt_msg = <<~PROMPT
+          #{AbideDevUtils::Output.simple_section_separator(section_header, width: 90)}
+          Title: '#{summary}'
+          Description:
+          #{description}
+        PROMPT
+        if print_only
+          AbideDevUtils::Output.simple(prompt_msg)
+        elsif AbideDevUtils::Prompt.yes_no("#{prompt_msg.strip}\nCreate?", auto_approve: auto_approve)
           approved_create[summary] = description
         end
       end
+      return if approved_create.empty?
+
       AbideDevUtils::Output.simple("#{dr_prefix(dry_run)}Creating #{approved_create.keys.count} new Jira issues")
       progress = AbideDevUtils::Output.progress(title: "#{dr_prefix(dry_run)}Creating issues",
                                                 total: approved_create.keys.count,

data/lib/abide_dev_utils/output.rb

@@ -27,6 +27,10 @@ module AbideDevUtils
       end
     end
 
+    def self.print(msg, stream: $stdout, **_)
+      stream.print msg
+    end
+
     def self.text(msg, console: false, file: nil, **_)
       simple(msg) if console
       FWRITER.write_text(msg, file: file) unless file.nil?

data/lib/abide_dev_utils/prompt.rb

@@ -1,25 +1,30 @@
 # frozen_string_literal: true
 
 require 'io/console'
+require_relative 'output'
 
 module AbideDevUtils
   module Prompt
-    def self.yes_no(msg, auto_approve: false)
-      return true if auto_approve
-
-      print "#{msg} (Y/n): "
+    def self.yes_no(msg, auto_approve: false, stream: $stdout)
+      prompt_msg = "#{msg} (Y/n): "
+      if auto_approve
+        AbideDevUtils::Output.simple("#{prompt_msg}Y", stream: stream)
+        return true
+      end
+
+      AbideDevUtils::Output.print(prompt_msg, stream: stream)
       return true if $stdin.cooked(&:gets).match?(/^[Yy].*/)
 
       false
     end
 
-    def self.single_line(msg)
-      print "#{msg}: "
+    def self.single_line(msg, stream: $stdout)
+      AbideDevUtils::Output.print("#{msg}: ", stream: stream)
       $stdin.cooked(&:gets).chomp
     end
 
-    def self.username
-      print 'Username: '
+    def self.username(stream: $stdout)
+      AbideDevUtils::Output.print('Username: ', stream: stream)
       $stdin.cooked(&:gets).chomp
     end
 

data/lib/abide_dev_utils/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abide_dev_utils
 version: !ruby/object:Gem::Version
-  version: 0.17.1
+  version: 0.17.2
 platform: ruby
 authors:
 - abide-team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-03 00:00:00.000000000 Z
+date: 2023-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -469,7 +469,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.18
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: Helper utilities for developing compliance Puppet code