Merge pull request #11 from OpenVoxProject/standardize_tasks

Standardize rake tasks

Author: nmburgan

Rakefile

@@ -1,15 +1,27 @@
 require 'rake'
 require 'open3'
 
-def run_command(cmd, silent = false)
+RED = "\033[31m"
+GREEN = "\033[32m"
+RESET = "\033[0m"
+
+def run_command(cmd, silent: true, print_command: false, report_status: false)
+  puts "#{GREEN}Running #{cmd}#{RESET}" if print_command
   output = ''
   Open3.popen2e(cmd) do |_stdin, stdout_stderr, thread|
     stdout_stderr.each do |line|
       puts line unless silent
       output += line
     end
     exitcode = thread.value.exitstatus
-    abort "Command failed!" unless exitcode.zero?
+    unless exitcode.zero?
+      err = "#{RED}Command failed! Command: #{cmd}, Exit code: #{exitcode}"
+      # Print details if we were running silent
+      err += "\nOutput:\n#{output}" if silent
+      err += RESET
+      abort err
+    end
+    puts "#{GREEN}Command finished with status #{exitcode}#{RESET}" if report_status
   end
   output.chomp
 end

tasks/build.rake

@@ -28,18 +28,17 @@ end
 def teardown
   if container_exists
     puts "Stopping #{@container}"
-    run_command("docker stop #{@container}")
-    run_command("docker rm #{@container}")
+    run_command("docker stop #{@container}", silent: false, print_command: true)
+    run_command("docker rm #{@container}", silent: false, print_command: true)
   end
 end
 
 def start_container(ezbake_dir)
-  run_command("docker run -d --name #{@container} -v .:/code -v #{ezbake_dir}:/ezbake #{@image} /bin/sh -c 'tail -f /dev/null'")
+  run_command("docker run -d --name #{@container} -v .:/code -v #{ezbake_dir}:/ezbake #{@image} /bin/sh -c 'tail -f /dev/null'", silent: false, print_command: true)
 end
 
 def run(cmd)
-  puts "\033[32mRunning #{cmd}\033[0m"
-  run_command("docker exec #{@container} /bin/bash --login -c '#{cmd}'")
+  run_command("docker exec #{@container} /bin/bash --login -c '#{cmd}'", silent: false, print_command: true)
 end
 
 namespace :vox do
@@ -53,15 +52,15 @@ namespace :vox do
       # delete all containers and do `docker rmi ezbake-builder`
       unless image_exists
         puts "Building ezbake-builder image"
-        run_command("docker build -t ezbake-builder .")
+        run_command("docker build -t ezbake-builder .", silent: false, print_command: true)
       end
 
       puts "Checking out ezbake"
       tmp = Dir.mktmpdir("ezbake")
       ezbake_dir = "#{tmp}/ezbake"
-      run_command("git clone https://github.com/openvoxproject/ezbake #{ezbake_dir}")
+      run_command("git clone https://github.com/openvoxproject/ezbake #{ezbake_dir}", silent: false, print_command: true)
       ezbake_branch = ENV['EZBAKE_BRANCH'] || 'main'
-      Dir.chdir(ezbake_dir) { |_| run_command("git checkout #{ezbake_branch}") }
+      Dir.chdir(ezbake_dir) { |_| run_command("git checkout #{ezbake_branch}", silent: false, print_command: true) }
 
       puts "Starting container"
       teardown if container_exists
@@ -73,7 +72,7 @@ namespace :vox do
       puts "Building openvoxdb"
       run("cd /code && rm -rf ruby && rm -rf output && bundle install --without test && lein install")
       run("cd /code && COW=\"#{@debs}\" MOCK=\"#{@rpms}\" GEM_SOURCE='https://rubygems.org' EZBAKE_ALLOW_UNREPRODUCIBLE_BUILDS=true EZBAKE_NODEPLOY=true LEIN_PROFILES=ezbake lein with-profile user,ezbake,provided,internal ezbake local-build")
-      run_command("sudo chown -R $USER output")
+      run_command("sudo chown -R $USER output", print_command: true)
       Dir.glob('output/**/*i386*').each { |f| FileUtils.rm_rf(f) }
       Dir.glob('output/puppetdb-*.tar.gz').each { |f| FileUtils.mv(f, f.sub('puppetdb','openvoxdb'))}
     ensure

tasks/tag.rake

@@ -18,9 +18,9 @@ namespace :vox do
     set_version(version)
 
     # Run git command to get short SHA and one line description of the commit on HEAD
-    branch = run_command('git rev-parse --abbrev-ref HEAD', true)
-    sha = run_command('git rev-parse --short HEAD', true)
-    msg = run_command('git log -n 1 --pretty=%B', true)
+    branch = run_command('git rev-parse --abbrev-ref HEAD')
+    sha = run_command('git rev-parse --short HEAD')
+    msg = run_command('git log -n 1 --pretty=%B')
 
     puts "Branch: #{branch}"
     puts "SHA: #{sha}"
@@ -31,7 +31,7 @@ namespace :vox do
     puts "Setting version after tag to #{snapshot_version}"
     set_version("#{snapshot_version}-SNAPSHOT")
 
-    unless !ENV['NOPUSH'].nil?
+    if ENV['NOPUSH'].nil?
       puts "Pushing to origin"
       run_command("git push origin && git push origin #{args[:tag]}")
     end

tasks/upload.rake

@@ -20,7 +20,7 @@ namespace :vox do
     s3 = "aws s3 --endpoint-url=#{endpoint}"
 
     # Ensure the AWS CLI isn't going to fail with the given parameters
-    run_command("#{s3} ls s3://#{bucket}/", true)
+    run_command("#{s3} ls s3://#{bucket}/")
 
     glob = "#{__dir__}/../output/**/*#{munged_tag}*"
     if os
@@ -32,7 +32,7 @@ namespace :vox do
 
     path = "s3://#{bucket}/#{component}/#{args[:tag]}"
     files.each do |f|
-      run_command("#{s3} cp #{f} #{path}/#{File.basename(f)}")
+      run_command("#{s3} cp #{f} #{path}/#{File.basename(f)}", silent: false)
     end
   end
 end