opswalrus 1.0.58 → 1.0.59

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 561e5d52fb2898d5c93e6a1b683194ed4dccf1ba476f68be79261cd58de8afba
-  data.tar.gz: 0cddaa43d4fac68a82c4dd0755486a8dd25c229e46e55c9698e74e69c7eef2bd
+  metadata.gz: 7c02e6cf3098713124796fdaddf3630d91434d40a6f0df607cf4184e5cd060c3
+  data.tar.gz: bedbfd919aba32a943ac22a1596c439d74879f1e88b0f42a1062dd6fe3c5cc08
 SHA512:
-  metadata.gz: 258d673028667b25f58cdf93b2d4fd82dfca0c6058687bccd3f4267d935f807c83ffc7981cbd638099186b6f93ab965a4b3d6f4bd7da2c26018e8378249bc57e
-  data.tar.gz: 8d234040ba815a0e83cbe15338c51cfdafee068720417ed2ce384e03bb7295a4b7b2ac68a6eca4555a52d56c2656ccc49e5a99887f013c25f4dcd7fe19f1c32c
+  metadata.gz: 79e953bac9a4c83104431d0c2ccf871b684810a81283b52ad677d4bff7bee27c804f93ec94be43b3b24a7b6504a40419c6932de1525ed7d1fbc5a4b0293036a6
+  data.tar.gz: 1ed925365dd182c27dc922da7aa99319566aefc01154dd8227253bfcf2798f6fc92686c6832941dddb0d55ce1d28148b2e7a3c341c5a4d1c80fa1ba739a74ace

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    opswalrus (1.0.58)
+    opswalrus (1.0.59)
       activesupport (~> 7.0)
       bcrypt_pbkdf (~> 1.1)
       binding_of_caller (~> 1.0)

data/lib/opswalrus/app.rb

@@ -32,7 +32,7 @@ module OpsWalrus
     end
 
     LOCAL_SUDO_PASSWORD_PROMPT = "[opswalrus] Please enter sudo password to run sudo in local environment: "
-
+    SCRIPT_RESULT_HEADER = "#### OpsWalrus Script Result JSON ".ljust(80, '#')
 
     attr_reader :local_hostname
     attr_reader :identity_file_paths
@@ -58,7 +58,7 @@ module OpsWalrus
       @pwd = pwd.to_pathname
       @bundler = Bundler.new(self, @pwd)
       @local_hostname = "localhost"
-      @mode = :report     # :report | :script
+      @script_mode = false
       @dry_run = false
       @zip_mutex = Thread::Mutex.new
     end
@@ -72,15 +72,11 @@ module OpsWalrus
     end
 
     def script_mode!
-      @mode = :script
-    end
-
-    def report_mode?
-      @mode == :report
+      @script_mode = true
     end
 
     def script_mode?
-      @mode == :script
+      @script_mode
     end
 
     def dry_run?
@@ -269,13 +265,7 @@ module OpsWalrus
       result = op.run([], params_json_hash: {ops_file: ops_file, operation_kv_args: operation_kv_args}.stringify_keys)
       exit_status = result.exit_status
 
-      debug "Op exit_status"
-      debug exit_status
-
-      debug "Op output"
-      debug JSON.pretty_generate(result.value)
-
-      puts JSON.pretty_generate(result.value)
+      print_script_result(result)
 
       exit_status
     rescue Error => e
@@ -305,13 +295,7 @@ module OpsWalrus
       result = op.run(operation_kv_args, params_json_hash: @params)
       exit_status = result.exit_status
 
-      debug "Op exit_status"
-      debug exit_status
-
-      debug "Op output"
-      debug JSON.pretty_generate(result.value)
-
-      puts JSON.pretty_generate(result.value)
+      print_script_result(result)
 
       exit_status
     rescue Error => e
@@ -321,6 +305,17 @@ module OpsWalrus
       FileUtils.remove_entry(tmp_bundle_root_dir) if tmp_bundle_root_dir
     end
 
+    def print_script_result(result)
+      if script_mode?
+        output = StringIO.open do |io|
+          io.print(SCRIPT_RESULT_HEADER)
+          io.puts JSON.pretty_generate(result.value)
+          io.string
+        end
+        puts output
+      end
+    end
+
     def load_entry_point_ops_file(ops_file_path, tmp_bundle_root_dir)
       ops_file = OpsFile.new(self, ops_file_path)
 
@@ -449,8 +444,8 @@ module OpsWalrus
     def bundle_status
     end
 
-    def bundle_update
-      bundler.update
+    def bundle_update(force = false)
+      bundler.update(force)
     end
 
     def report_inventory(host_references, tags: nil)

data/lib/opswalrus/bundler.rb

@@ -55,7 +55,7 @@ module OpsWalrus
     #   bundler_for_package.include_directory_in_bundle_as_self_pkg(pwd)
     # end
 
-    def update()
+    def update(force = false)
       # delete_pwd_bundle_directory   # this was causing problems when we do: ops run -r -b ... because a dynamic package reference was being
                                       # downloaded to the bundle dir, and then update was being called afterward, which was blowing away
                                       # the entire bundle dir, so when the bundle dir was copied to the remote host, the ops file being
@@ -66,22 +66,22 @@ module OpsWalrus
       package_yaml_files = pwd.glob("./**/package.yaml") - pwd.glob("./**/#{BUNDLE_DIR}/**/package.yaml")
       package_files_within_pwd = package_yaml_files.map {|path| PackageFile.new(path.realpath) }
 
-      download_package_dependency_tree(package_files_within_pwd)
+      download_package_dependency_tree(package_files_within_pwd, force: force)
 
       ops_files = pwd.glob("./**/*.ops") - pwd.glob("./**/#{BUNDLE_DIR}/**/*.ops")
       ops_files_within_pwd = ops_files.map {|path| OpsFile.new(@app, path.realpath) }
 
-      download_import_dependencies(ops_files_within_pwd)
+      download_import_dependencies(ops_files_within_pwd, force: force)
     end
 
     # downloads all transitive package dependencies associated with ops_files_and_package_files
     # all downloaded packages are placed into @bundle_dir
-    def download_package_dependency_tree(*ops_files_and_package_files)
+    def download_package_dependency_tree(*ops_files_and_package_files, force: false)
       package_files = ops_files_and_package_files.flatten.map(&:package_file).compact.uniq
 
       package_files.each do |root_package_file|
         pre_order_traverse(root_package_file) do |package_file|
-          download_package_dependencies(package_file).map do |downloaded_package_directory_path|
+          download_package_dependencies(package_file, force: force).map do |downloaded_package_directory_path|
             package_file_path = File.join(downloaded_package_directory_path, "package.yaml")
             PackageFile.new(package_file_path)
           end
@@ -89,13 +89,13 @@ module OpsWalrus
       end
     end
 
-    def download_import_dependencies(*ops_files)
+    def download_import_dependencies(*ops_files, force: false)
       ops_files.flatten.each do |ops_file|
         ops_file.imports.each do |local_name, import_reference|
           case import_reference
           when PackageDependencyReference, DynamicPackageImportReference
             package_reference = import_reference.package_reference
-            download_package(ops_file.dirname, ops_file.ops_file_path, package_reference)
+            download_package(ops_file.dirname, ops_file.ops_file_path, package_reference, force: force)
           when DirectoryReference
             # noop
           when OpsFileReference
@@ -107,11 +107,11 @@ module OpsWalrus
 
     # returns the array of the destination directories that the packages that ops_file depend on were downloaded to
     # e.g. [dir_path1, dir_path2, dir_path3, ...]
-    def download_package_dependencies(package_file)
+    def download_package_dependencies(package_file, force: false)
       containing_directory = package_file.containing_directory
       package_file_source = package_file.package_file_path
       package_file.dependencies.map do |local_name, package_reference|
-        download_package(containing_directory, package_file_source, package_reference)
+        download_package(containing_directory, package_file_source, package_reference, force: force)
       end
     end
 
@@ -138,7 +138,7 @@ module OpsWalrus
     # returns the destination directory that the package was downloaded to
     #
     # relative_base_path is the relative base path that any relative file paths captured in the package_reference should be evaluated relative to
-    def download_package(relative_base_path, source_of_package_reference, package_reference)
+    def download_package(relative_base_path, source_of_package_reference, package_reference, force: false)
       ensure_pwd_bundle_directory_exists
 
       local_name = package_reference.local_name
@@ -152,11 +152,11 @@ module OpsWalrus
 
       # we return early here under the assumption that an already downloaded package/version combo will not
       # differ if we download it again multiple times to the same location
-      if destination_package_path.exist?
+      if destination_package_path.exist? && !force
         App.instance.log("Skipping #{package_reference} referenced in #{source_of_package_reference} since it already has been downloaded to #{destination_package_path}")
         return destination_package_path
       end
-      # FileUtils.remove_dir(destination_package_path) if destination_package_path.exist?
+      FileUtils.remove_dir(destination_package_path) if destination_package_path.exist?
 
       # download_package_contents(package_file.containing_directory, local_name, package_url, version, destination_package_path)
       download_package_contents(relative_base_path, local_name, package_url, version, destination_package_path)

data/lib/opswalrus/cli.rb

@@ -275,10 +275,12 @@ module OpsWalrus
       desc 'Update bundle dependencies'
       long_desc 'Download and bundle the latest versions of dependencies for the current package'
       c.command :update do |update|
+        update.switch [:f, :force], desc: "Force update even if the package has already been downloaded"
+
         update.action do |global_options, options, args|
           $app.set_log_level(global_options[:loudest] && :trace || global_options[:louder] && :debug || global_options[:loud] && :info || :warn)
 
-          $app.bundle_update
+          $app.bundle_update(options[:force])
         end
       end
 

data/lib/opswalrus/invocation.rb

@@ -122,8 +122,8 @@ module OpsWalrus
         end
 
         # invoke the ops command on the remote host to run the specified ops script on the remote host
-        ops_command_options = ""
-        ops_command_options << "--pass" if @ops_prompt_for_sudo_password
+        ops_command_options = "--script"
+        ops_command_options << " --pass" if @ops_prompt_for_sudo_password
         ops_command_options << " --params #{remote_json_kwargs_tempfile_basename}" if remote_json_kwargs_tempfile_basename
         retval = if ops_command_options.empty?
           @host_proxy.run_ops(:run, remote_run_command_args, ops_prompt_for_sudo_password: @ops_prompt_for_sudo_password)
@@ -232,8 +232,8 @@ module OpsWalrus
         end
 
         # invoke the ops command on the remote host to run the specified ops script on the remote host
-        ops_command_options = ""
-        ops_command_options << "--pass" if @ops_prompt_for_sudo_password
+        ops_command_options = "--script"
+        ops_command_options << " --pass" if @ops_prompt_for_sudo_password
         ops_command_options << " --params #{remote_json_kwargs_tempfile_basename}" if remote_json_kwargs_tempfile_basename
         retval = if ops_command_options.empty?
           @host_proxy.run_ops(:run, remote_run_command_args, ops_prompt_for_sudo_password: @ops_prompt_for_sudo_password)

data/lib/opswalrus/operation_runner.rb

@@ -110,13 +110,6 @@ module OpsWalrus
         Invocation::Error.new(e)
       end
 
-      # if result.failure?
-      #   App.instance.debug "Ops script error details:"
-      #   App.instance.debug "Error: #{result.value}"
-      #   App.instance.debug "Status code: #{result.exit_status}"
-      #   App.instance.debug @entry_point_ops_file.script.to_s
-      # end
-
       result
     end
   end

data/lib/opswalrus/ops_file_script_dsl.rb

@@ -322,21 +322,23 @@ module OpsWalrus
       puts output_block unless output_block.empty?
 
       t1 = Time.now
-      out, err, exit_status = yield
+      output, stderr, exit_status = yield
       t2 = Time.now
       seconds = t2 - t1
 
+      stdout, remote_ops_script_retval = parse_stdout_and_script_return_value(output)
+
       output_block = StringIO.open do |io|
         if App.instance.info?   # this is true if log_level is trace, debug, info
           if App.instance.trace?
-            io.puts Style.cyan(out)
-            io.puts Style.red(err)
+            io.puts Style.cyan(stdout)
+            io.puts Style.red(stderr)
           elsif App.instance.debug?
-            io.puts Style.cyan(out)
-            io.puts Style.red(err)
+            io.puts Style.cyan(stdout)
+            io.puts Style.red(stderr)
           elsif App.instance.info?
-            io.puts Style.cyan(out)
-            io.puts Style.red(err)
+            io.puts Style.cyan(stdout)
+            io.puts Style.red(stderr)
           end
           io.print Style.yellow(cmd_id)
           io.print Style.blue(" | Finished in #{seconds} seconds with exit status ")
@@ -359,7 +361,23 @@ module OpsWalrus
       end
       puts output_block unless output_block.empty?
 
-      [out, err, exit_status]
+      out = remote_ops_script_retval || stdout
+      [out, stderr, exit_status]
+    end
+
+    def parse_stdout_and_script_return_value(command_output)
+      output_sections = command_output.split(/^#{::OpsWalrus::App::SCRIPT_RESULT_HEADER}$/)
+      case output_sections.count
+      when 1
+        stdout, ops_script_retval = output_sections.first, nil
+      when 2
+        stdout, ops_script_retval = *output_sections
+      else
+        # this is unexpected
+        ops_script_retval = output_sections.pop
+        stdout = output_sections.join(::OpsWalrus::App::SCRIPT_RESULT_HEADER)
+      end
+      [stdout, ops_script_retval]
     end
 
   end

data/lib/opswalrus/version.rb

@@ -1,3 +1,3 @@
 module OpsWalrus
-  VERSION = "1.0.58"
+  VERSION = "1.0.59"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opswalrus
 version: !ruby/object:Gem::Version
-  version: 1.0.58
+  version: 1.0.59
 platform: ruby
 authors:
 - David Ellis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-23 00:00:00.000000000 Z
+date: 2023-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport