Add output file option for pipeline_visibility_stats

Signed-off-by: Phil Dibowitz <phil@ipom.com>

Author: jaymzh

src/pipeline_visibility_stats.rb

@@ -78,6 +78,14 @@ def run_cmd!(args, cwd: nil, echo: true, retries: 0)
   raise
 end
 
+def output(fh, msg)
+  if fh
+    fh.write("#{msg}\n")
+  else
+    log.info(msg)
+  end
+end
+
 # Command-line options
 options = {
   skip_patterns: %w{adhoc release},
@@ -121,6 +129,12 @@ def run_cmd!(args, cwd: nil, echo: true, retries: 0)
     "GitHub org name. [default: #{options[:org]}]",
   ) { |v| options[:org] = v }
 
+  opts.on(
+    '-o FILE',
+    '--output FILE',
+    'Write the output to FILE',
+  ) { |v| options[:output] = v }
+
   opts.on(
     '--repos REPO',
     Array,
@@ -159,13 +173,19 @@ def run_cmd!(args, cwd: nil, echo: true, retries: 0)
 options[:repos].uniq!
 options[:make_prs_for].uniq!
 
+if options[:output]
+  fh = open(options[:output], 'w')
+  log.info("Generating report and writing to #{options[:output]}")
+end
+
 github_token = get_github_token!(options)
 
 total_pipeline_count = 0
 private_pipeline_count = 0
 repos_with_private = 0
 skipped_by_pattern = Hash.new(0)
 
+output(fh, "Pipeline Visibility Report #{Date.today}\n")
 if options[:repos].empty?
   log.info("Fetching repos under '#{options[:org]}'...")
   page = 1
@@ -197,6 +217,8 @@ def run_cmd!(args, cwd: nil, echo: true, retries: 0)
     next
   end
 
+  print('.') if fh
+
   content = get_expeditor_config(options[:org], repo, github_token)
   unless content
     log.debug("No expeditor config for #{repo}")
@@ -247,9 +269,9 @@ def run_cmd!(args, cwd: nil, echo: true, retries: 0)
   end
 
   next if repo_missing_public.empty?
-  log.info("* #{repo}")
+  output(fh, "* #{repo}")
   repo_missing_public.each do |pname|
-    log.info("    * #{pname}")
+    output(fh, "    * #{pname}")
   end
   repos_with_private += 1
 
@@ -302,18 +324,22 @@ def run_cmd!(args, cwd: nil, echo: true, retries: 0)
   percentage_private = (
     (private_pipeline_count.to_f / total_pipeline_count.to_f) * 100
   ).round(2)
-  log.info("\nTotal percentage of private pipelines: #{percentage_private}%")
-  log.info(
+  output(fh, "\nTotal percentage of private pipelines: #{percentage_private}%")
+  output(
+    fh,
     "  --> #{private_pipeline_count} out of #{total_pipeline_count} " +
     "across #{repos_with_private} repos",
   )
 
   if skipped_by_pattern.any?
-    log.info('  --> Skipped pipelines:')
+    output(fh, '  --> Skipped pipelines:')
     skipped_by_pattern.each do |pattern, count|
-      log.info("    - #{pattern}: #{count}")
+      output(fh, "    - #{pattern}: #{count}")
     end
   end
 else
-  log.info('No pipelines found (excluding skipped patterns).')
+  output(fh, 'No pipelines found (excluding skipped patterns).')
 end
+
+puts if fh
+fh.close if options[:output]