itamae 1.3.3 → 1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ad665ed56e3ebcad528cbfd6a6a6b1d3b77f084
-  data.tar.gz: 989188954e3f2f2062a6a21397b54a4bc81c3afc
+  metadata.gz: 3c3734924aed2c2ab9472e781e7c512c31599b46
+  data.tar.gz: fe29b7a53a36075a3886be1d89e17355edf528cd
 SHA512:
-  metadata.gz: 9a3708718a9b72bc1403bb85c4fbf283dc83f58aa9709ea8ddc60f27d1e1a0dec3a3e0ba1ae1a5890237f7fd8772f59a918030bac7d7406e95d946a25a3f8e54
-  data.tar.gz: 6780d1cf5dda81bbb1cd2966f06b87ad1c12420e3df4557f123ed8b50a46575841f9bcdbca9aed7bea70be615637e12d7038a258ce36ba317707d5f124a660c5
+  metadata.gz: c7a9d8d4400cc1b46276c7e5115e4c5bd653fb9d2cb63c3edcd548d36207b021947b8925aaaab9b693bf8e4a26db4c9324275c0b80a4e2ea9ac5e4cb382f97a2
+  data.tar.gz: abd0f092cfa89168efe723b0210a58ba3a4ec82993818be5cda8a7787d5827148744fd6dda2355e2482146b79d7414f084bc7e4d3b568a2d695385abc4721379

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## v1.3.4
+
+Improvements
+
+- [Output stdout/err logs during command execution](https://github.com/itamae-kitchen/itamae/commit/24f140dd9744f30c645422959a6a72b6e31eacc4)
+
 ## v1.3.3
 
 Improvements

data/itamae.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "thor"
-  spec.add_runtime_dependency "specinfra", [">= 2.31.0", "< 3.0.0"]
+  spec.add_runtime_dependency "specinfra", [">= 2.37.0", "< 3.0.0"]
   spec.add_runtime_dependency "hashie"
   spec.add_runtime_dependency "ansi"
   spec.add_runtime_dependency "schash", "~> 0.1.0"

data/lib/itamae/backend.rb

@@ -43,61 +43,37 @@ module Itamae
       def run_command(commands, options = {})
         options = {error: true}.merge(options)
 
-        if commands.is_a?(Array)
-          command = commands.map do |cmd|
-            Shellwords.escape(cmd)
-          end.join(' ')
-        else
-          command = commands
-        end
-
-        cwd = options[:cwd]
-        if cwd
-          command = "cd #{Shellwords.escape(cwd)} && #{command}"
-        end
-
-        user = options[:user]
-        if user
-          command = "sudo -H -u #{Shellwords.escape(user)} -- /bin/sh -c #{Shellwords.escape(command)}"
-        end
-
+        command = build_command(commands, options)
         Logger.debug "Executing `#{command}`..."
 
-        result = @backend.run_command(command)
-        exit_status = result.exit_status
+        result = nil
 
         Logger.formatter.with_indent do
-          if exit_status == 0 || !options[:error]
+          reset_output_handler
+          result = @backend.run_command(command)
+          flush_output_handler_buffer
+
+          if result.exit_status == 0 || !options[:error]
             method = :debug
-            message = "exited with #{exit_status}"
+            message = "exited with #{result.exit_status}"
           else
             method = :error
-            message = "Command `#{command}` failed. (exit status: #{exit_status})"
-          end
-
-          Logger.public_send(method, message)
-
-          {"stdout" => result.stdout, "stderr" => result.stderr}.each_pair do |name, value|
-            next unless value && value != ''
+            message = "Command `#{command}` failed. (exit status: #{result.exit_status})"
 
-            if value.bytesize > 1024 * 1024
-              Logger.public_send(method, "#{name} is suppressed because it's too large")
-              next
-            end
-
-            value.each_line do |line|
-              # remove control chars
-              case line.encoding
-              when Encoding::UTF_8
-                line = line.tr("\u0000-\u001f\u007f\u2028",'')
+            unless Logger.logger.level == ::Logger::DEBUG
+              result.stdout.each_line do |l|
+                log_output_line("stdout", l, :error)
+              end
+              result.stderr.each_line do |l|
+                log_output_line("stderr", l, :error)
               end
-
-              Logger.public_send(method, "#{name} | #{line}")
             end
           end
+
+          Logger.public_send(method, message)
         end
 
-        if options[:error] && exit_status != 0
+        if options[:error] && result.exit_status != 0
           raise CommandExecutionError
         end
 
@@ -152,6 +128,59 @@ module Itamae
       def create_specinfra_backend
         raise NotImplementedError
       end
+
+      def reset_output_handler
+        @buf = {}
+        %w!stdout stderr!.each do |output_name|
+          @buf[output_name] = ""
+          handler = lambda do |str|
+            lines = str.split(/\r?\n/, -1)
+            @buf[output_name] += lines.pop
+            unless lines.empty?
+              lines[0] = @buf[output_name] + lines[0]
+              @buf[output_name] = ""
+              lines.each do |l|
+                log_output_line(output_name, l)
+              end
+            end
+          end
+          @backend.public_send("#{output_name}_handler=", handler)
+        end
+      end
+
+      def flush_output_handler_buffer
+        @buf.each do |output_name, line|
+          next if line.empty?
+          log_output_line(output_name, line)
+        end
+      end
+
+      def log_output_line(output_name, line, severity = :debug)
+        line = line.gsub(/[[:cntrl:]]/, '')
+        Logger.public_send(severity, "#{output_name} | #{line}")
+      end
+
+      def build_command(commands, options)
+        if commands.is_a?(Array)
+          command = commands.map do |cmd|
+            Shellwords.escape(cmd)
+          end.join(' ')
+        else
+          command = commands
+        end
+
+        cwd = options[:cwd]
+        if cwd
+          command = "cd #{Shellwords.escape(cwd)} && #{command}"
+        end
+
+        user = options[:user]
+        if user
+          command = "sudo -H -u #{Shellwords.escape(user)} -- /bin/sh -c #{Shellwords.escape(command)}"
+        end
+
+        command
+      end
     end
 
     # TODO: Make Specinfra's backends instanciatable 

data/lib/itamae/version.txt

@@ -1 +1 @@
-1.3.3
+1.3.4

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: itamae
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.3.4
 platform: ruby
 authors:
 - Ryota Arai
@@ -30,7 +30,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.31.0
+        version: 2.37.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -40,7 +40,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.31.0
+        version: 2.37.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0