Quiet(er) spec output

- Introduce `Output.say` which we stub in specs
- Hoist some behavior up to `spec_helper`, and require this in all specs

Author: aramprice

Rakefile

@@ -1,4 +1,7 @@
-require_relative 'lib/stemcell/builder'
+$LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
+
+require 'output'
+require 'stemcell/builder'
 
 import 'lib/tasks/build/aws.rake'
 import 'lib/tasks/build/azure.rake'

lib/exec_command.rb

@@ -1,4 +1,5 @@
 require 'open3'
+require_relative 'output'
 
 class Executor
   def self.exec_command(cmd)
@@ -9,7 +10,7 @@ def self.exec_command(cmd)
     Open3.popen2(cmd) do |stdin, out, wait_thr|
       out.each_line do |line|
         ret += line
-        puts line
+        Output.say line
       end
       exit_status = wait_thr.value
       if exit_status != 0

lib/output.rb

@@ -0,0 +1,5 @@
+class Output
+  def self.say(something)
+    puts something
+  end
+end

lib/packer/runner.rb

@@ -2,6 +2,7 @@
 require 'json'
 require 'English'
 require 'open3'
+require_relative '../output'
 
 module Packer
   class Runner
@@ -25,7 +26,7 @@ def run(command, args={})
       log_config(config_file.path)
 
       packer_command = "packer #{command} -machine-readable #{args_combined} #{config_file.path}"
-      puts packer_command
+      Output.say packer_command
 
       Open3.popen2e(packer_command) do |_stdin, out, wait_thr|
         yield(out) if block_given?
@@ -38,7 +39,7 @@ def log_config(path)
       unless "#{ENV['NEW_PASSWORD']}".empty?
         config_contents.gsub! ENV['NEW_PASSWORD'], "( redacted )"
       end
-      puts "config file contents: #{config_contents}"
+      Output.say "config file contents: #{config_contents}"
     end
   end
 end

lib/s3.rb

@@ -1,4 +1,5 @@
 require 'aws-sdk-s3'
+require_relative 'output'
 require_relative 'exec_command'
 
 module S3
@@ -15,23 +16,23 @@ def initialize(endpoint: "")
     end
     def get(bucket,key,file_name)
       bucket, key = rationalize(bucket, key)
-      puts "Downloading the #{key} from #{bucket} to #{file_name}"
+      Output.say "Downloading the #{key} from #{bucket} to #{file_name}"
       path = File.dirname(file_name)
       FileUtils.mkdir_p(path)
       File.open(file_name, 'wb') do |file|
         @s3.get_object({ bucket:bucket , key:key, response_target: file })
       end
-      puts "Finished Downloading the #{key} from #{bucket} to #{file_name}"
+      Output.say "Finished Downloading the #{key} from #{bucket} to #{file_name}"
     end
     def put(bucket,key,file_name)
       bucket, key = rationalize(bucket, key)
-      puts "Uploading the #{file_name} to #{bucket}:#{key}"
+      Output.say "Uploading the #{file_name} to #{bucket}:#{key}"
       @s3_resource.bucket(bucket).object(key).upload_file(file_name)
-      puts "Finished uploading the #{file_name} to #{bucket}:#{key}"
+      Output.say "Finished uploading the #{file_name} to #{bucket}:#{key}"
     end
     def list(bucket)
       bucket, prefix = rationalize(bucket, '')
-      puts "Listing bucket #{bucket} with prefix #{prefix}"
+      Output.say "Listing bucket #{bucket} with prefix #{prefix}"
       resp = @s3.list_objects({
         bucket: bucket,
         delimiter: '/',
@@ -40,9 +41,9 @@ def list(bucket)
       resp.to_h[:contents].map { |x| x[:key] }
     end
     def clear(bucket)
-      puts "Clearing bucket #{bucket}"
+      Output.say "Clearing bucket #{bucket}"
       @s3_resource.bucket(bucket).clear!
-      puts "Finished: clearing bucket #{bucket}"
+      Output.puts "Finished: clearing bucket #{bucket}"
     end
     private
       # Our ci passes the bucket and key as bucket: bucket/path/to/file,
@@ -56,7 +57,7 @@ def rationalize(bucket, key)
   end
 
   def self.test_upload_permissions(bucket, endpoint="")
-    puts "Testing upload permissions for #{bucket}"
+    Output.say "Testing upload permissions for #{bucket}"
     tempfile = Tempfile.new("stemcell-permissions-tempfile")
     s3_client = Client.new(endpoint: endpoint)
     s3_client.put(bucket, 'test-upload-permissions', tempfile.path)

lib/stemcell/builder/aws.rb

@@ -48,7 +48,7 @@ def parse_packer_output(packer_output)
         amis = []
         packer_output.each_line do |line|
           if !(line.include?('secret_key') || line.include?('access_key'))
-            puts line
+            Output.say line
           end
           ami = parse_ami(line)
           if !ami.nil?

lib/stemcell/builder/azure.rb

@@ -34,11 +34,11 @@ def build
       end
 
       def stage_image(disk_uri)
-        puts 'TODO: stage azure disk image'
+        Output.say 'TODO: stage azure disk image'
       end
 
       def publish_image(disk_uri)
-        puts 'TODO: publish azure disk image'
+        Output.say 'TODO: publish azure disk image'
       end
 
       private
@@ -63,7 +63,7 @@ def packer_config
         def parse_packer_output(packer_output)
           disk_uri = nil
           packer_output.each_line do |line|
-            puts line
+            Output.say line
             disk_uri ||= parse_disk_uri(line)
           end
           disk_uri

lib/stemcell/builder/base.rb

@@ -1,3 +1,5 @@
+require_relative '../../output'
+
 module Stemcell
   class Builder
     class PackerFailure < RuntimeError
@@ -51,7 +53,7 @@ def run_packer
           packer_artifact = parse_packer_output(stdout)
         end
         if exit_status != 0
-          puts "packer_artifact is: #{packer_artifact}"
+          Output.say "packer_artifact is: #{packer_artifact}"
           raise PackerFailure
         end
         packer_artifact
@@ -63,7 +65,7 @@ def exec_command(cmd)
         STDOUT.sync = true
         Open3.popen2(cmd) do |stdin, out, wait_thr|
           out.each_line do |line|
-            puts line
+            Output.say line
           end
           exit_status = wait_thr.value
           if exit_status != 0
@@ -74,15 +76,15 @@ def exec_command(cmd)
 
       def parse_packer_output(packer_output)
         packer_output.each_line do |line|
-          puts line
+          Output.say line
         end
       end
 
       def update_list_path
         if File.exist?(File.join(@output_directory, 'updates.txt'))
           File.join(@output_directory, 'updates.txt')
         else
-          puts "'updates.txt' does not exist in #{@output_directory}"
+          Output.say "'updates.txt' does not exist in #{@output_directory}"
         end
       end
     end

lib/stemcell/builder/gcp.rb

@@ -42,7 +42,7 @@ def packer_config
         def parse_packer_output(packer_output)
           image_name = nil
           packer_output.each_line do |line|
-            puts line
+            Output.say line
             image_name ||= parse_image_name(line)
           end
           get_image_url(image_name)

lib/stemcell/packager.rb

@@ -1,5 +1,6 @@
 require 'zlib'
 require 'rubygems/package'
+require_relative '../output'
 
 module Stemcell
   class Packager
@@ -190,14 +191,13 @@ def self.exec_command(cmd)
       STDOUT.sync = true
       Open3.popen2(cmd) do |stdin, out, wait_thr|
         out.each_line do |line|
-          puts line
+          Output.say line
         end
         exit_status = wait_thr.value
         if exit_status != 0
           raise "error running command: #{cmd}"
         end
       end
     end
-
   end
 end