opswalrus 1.0.52 → 1.0.54

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1ce678751d6d62f4a9b5e40eb6127c22e2e664c6641023ce8df4135609fb73e
-  data.tar.gz: a2747abc2711e77a47371f7c16d1b5104d70b10419b09cd3e992e892cea2d6ca
+  metadata.gz: 50b82ac565a56bb1585653a90c4c0c09b06ba3490c3121da8717e9bdf085f48b
+  data.tar.gz: f38e88fa6db2769cd7ae59291ce28f337c1ca8a9bcd00509f8ccc00cd47b0890
 SHA512:
-  metadata.gz: 5ec4e2b6a547e394b0290a47dafa7cc13960a9c21cef7e1a7edc4d20900cd304a1e0c828025df68f8e7e2e6ce22e3f48882fe44efcaaf1a25e3c74d357981071
-  data.tar.gz: 386afc9a49856131615ff5c5e0c54a1934bf8458d3a77f7f2c6e1da6479343c54a0be8436f8a08beec4e89d6f1b9019e463bc96a5c169f639a7061838f8f240f
+  metadata.gz: 751dfb54af8521b4e33a45cd8d38c0aa0b2c433006bd7030e412605584ffb4b7cba44d49fe26b64c7c2c4d0f2cea08a53cd02aea40c1d2341de7d20fbbe1ac35
+  data.tar.gz: a52102d80e0b0f966d7b357173f87cafcb6ddcfdf0e9d0b3aa369e115c5b7da03ef0ce1fb6ba8d25486ac296e2f3e06dc717ab0fe61f96cf3c904b0a14b3d87c

data/Gemfile

@@ -7,3 +7,5 @@ gemspec
 
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
+
+gem 'solargraph', group: :development

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    opswalrus (1.0.52)
+    opswalrus (1.0.54)
+      activesupport (~> 7.0)
       bcrypt_pbkdf (~> 1.1)
       binding_of_caller (~> 1.0)
       citrus (~> 3.0)
@@ -17,28 +18,61 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (7.0.8)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
     addressable (2.8.5)
       public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    backport (1.2.0)
+    base64 (0.1.1)
     bcrypt_pbkdf (1.1.0)
+    benchmark (0.2.1)
     binding_of_caller (1.0.0)
       debug_inspector (>= 0.0.1)
     citrus (3.0.2)
     concurrent-ruby (1.2.2)
     debug_inspector (1.1.0)
     diff-lcs (1.5.0)
+    e2mmap (0.1.0)
     ed25519 (1.3.0)
     git (1.18.0)
       addressable (~> 2.8)
       rchardet (~> 1.8)
     gli (2.21.1)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.6)
+    json (2.6.3)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    language_server-protocol (3.17.0.3)
+    minitest (5.20.0)
     net-scp (4.0.0)
       net-ssh (>= 2.6.5, < 8.0.0)
     net-ssh (7.2.0)
+    nokogiri (1.15.4-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
     pastel (0.8.0)
       tty-color (~> 0.5)
     public_suffix (5.0.3)
+    racc (1.7.1)
+    rainbow (3.1.1)
     rake (13.0.6)
+    rbs (2.8.4)
     rchardet (1.8.0)
+    regexp_parser (2.8.1)
+    reverse_markdown (2.1.1)
+      nokogiri
+    rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -52,12 +86,45 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.1)
+    rubocop (1.56.3)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
     rubyzip (2.3.2)
     semantic_logger (4.14.0)
       concurrent-ruby (~> 1.0)
+    solargraph (0.49.0)
+      backport (~> 1.2)
+      benchmark
+      bundler (~> 2.0)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      rbs (~> 2.0)
+      reverse_markdown (~> 2.0)
+      rubocop (~> 1.38)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
     sshkit (1.21.5)
       net-scp (>= 1.1.2)
       net-ssh (>= 2.8.0)
+    thor (1.2.2)
+    tilt (2.3.0)
     tty-color (0.6.0)
     tty-cursor (0.7.1)
     tty-editor (0.7.0)
@@ -70,7 +137,11 @@ GEM
       tty-screen (~> 0.8)
       wisper (~> 2.0)
     tty-screen (0.8.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
     wisper (2.0.1)
+    yard (0.9.34)
 
 PLATFORMS
   x86_64-linux
@@ -79,6 +150,7 @@ DEPENDENCIES
   opswalrus!
   rake (~> 13.0)
   rspec (~> 3.0)
+  solargraph
 
 BUNDLED WITH
    2.4.10

data/lib/opswalrus/_run_remote.ops

@@ -0,0 +1,11 @@
+params:
+  ops_file: OpsFile
+  operation_kv_args: array string
+...
+ssh in: :sequence do
+# ssh_noprep do
+  puts params.stringify_keys!
+  desc "Running `#{params.ops_file.ops_file_path} #{params.operation_kv_args.join(' ')}` on #{to_s} (alias=#{self.alias})"
+  # run_ops(ops_command, ops_command_options = nil, command_arguments, in_bundle_root_dir: true, ops_prompt_for_sudo_password: false)
+  _invoke_remote(params.ops_file, *params.operation_kv_args)
+end

data/lib/opswalrus/app.rb

@@ -38,11 +38,11 @@ module OpsWalrus
     attr_reader :identity_file_paths
 
     def initialize(pwd = Dir.pwd)
-      SemanticLogger.default_level = :info
+      SemanticLogger.default_level = :warn
       # SemanticLogger.add_appender(file_name: 'development.log', formatter: :color)   # Log to a file, and use the colorized formatter
       SemanticLogger.add_appender(io: $stdout, formatter: :color)       # Log errors and above to standard error:
       @logger = SemanticLogger[OpsWalrus]    # Logger.new($stdout, level: Logger::INFO)
-      @logger.level = :info    # , :trace or 'trace'
+      @logger.level = :warn    # :trace or 'trace'
 
       # @logger.warn Style.yellow("warn"), foo: "bar", baz: {qux: "quux"}
       # @logger.info Style.yellow("info"), foo: "bar", baz: {qux: "quux"}
@@ -216,18 +216,22 @@ module OpsWalrus
     end
 
     def bootstrap()
-      set_pwd(__FILE__.to_pathname.dirname)
-      bootstrap_ops_file = OpsFile.new(self, __FILE__.to_pathname.dirname.join("_bootstrap.ops"))
-      op = OperationRunner.new(self, bootstrap_ops_file)
-      op.run([], params_json_hash: @params)
+      run_internal("_bootstrap.ops")
     end
 
     def shell(command)
+      run_internal("_shell.ops", {"command" => command})
+    end
+
+    def reboot()
+      run_internal("_reboot.ops")
+    end
+
+    def run_internal(ops_file_name, params = @params)
       set_pwd(__FILE__.to_pathname.dirname)
-      shell_ops_file = OpsFile.new(self, __FILE__.to_pathname.dirname.join("_shell.ops"))
-      op = OperationRunner.new(self, shell_ops_file)
-      puts "running #{command}"
-      result = op.run([], params_json_hash: {"command" => command})
+      internal_ops_file = OpsFile.new(self, __FILE__.to_pathname.dirname.join(ops_file_name))
+      op = OperationRunner.new(self, internal_ops_file)
+      result = op.run([], params_json_hash: params)
       puts "result class=#{result.class}"
       exit_status = result.exit_status
       stdout = JSON.pretty_generate(result.value)
@@ -243,27 +247,45 @@ module OpsWalrus
       1
     end
 
-    def reboot()
-      set_pwd(__FILE__.to_pathname.dirname)
-      shell_ops_file = OpsFile.new(self, __FILE__.to_pathname.dirname.join("_reboot.ops"))
-      op = OperationRunner.new(self, shell_ops_file)
-      result = op.run([], params_json_hash: @params)
-      puts "result class=#{result.class}"
+    # package_operation_and_args is of the form ["github.com/davidkellis/my-package/sub-package1", "operation1", "arg1:val1", "arg2:val2", "arg3:val3"]
+    # if the first argument is the path to a .ops file, then treat it as a local path, and add the containing package
+    #   to the load path
+    # otherwise, copy the
+    # returns the exit status code that the script should terminate with
+    def run_remote(package_operation_and_args, update_bundle: false)
+      return 0 if package_operation_and_args.empty?
+
+      ops_file_path, operation_kv_args, tmp_bundle_root_dir = get_entry_point_ops_file_and_args(package_operation_and_args)
+
+      ops_file = load_entry_point_ops_file(ops_file_path, tmp_bundle_root_dir)
+
+      bundler.update if update_bundle
+
+      debug "Running: #{ops_file.ops_file_path}"
+
+      internal_ops_file = OpsFile.new(self, __FILE__.to_pathname.dirname.join("_run_remote.ops"))
+
+      op = OperationRunner.new(self, internal_ops_file)
+      result = op.run([], params_json_hash: {ops_file: ops_file, operation_kv_args: operation_kv_args})
       exit_status = result.exit_status
-      stdout = JSON.pretty_generate(result.value)
-      output = if exit_status == 0
-        Style.green(stdout)
-      else
-        Style.red(stdout)
-      end
-      puts output
+
+      debug "Op exit_status"
+      debug exit_status
+
+      debug "Op output"
+      debug JSON.pretty_generate(result.value)
+
+      puts JSON.pretty_generate(result.value)
+
       exit_status
     rescue Error => e
       puts "Error: #{e.message}"
       1
+    ensure
+      FileUtils.remove_entry(tmp_bundle_root_dir) if tmp_bundle_root_dir
     end
 
-    # args is of the form ["github.com/davidkellis/my-package/sub-package1", "operation1", "arg1:val1", "arg2:val2", "arg3:val3"]
+    # package_operation_and_args is of the form ["github.com/davidkellis/my-package/sub-package1", "operation1", "arg1:val1", "arg2:val2", "arg3:val3"]
     # if the first argument is the path to a .ops file, then treat it as a local path, and add the containing package
     #   to the load path
     # otherwise, copy the

data/lib/opswalrus/bundler.rb

@@ -56,7 +56,11 @@ module OpsWalrus
     # end
 
     def update()
-      delete_pwd_bundle_directory
+      # 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
+                                      # invoked was not present on the remote host, since it had never been copied over as a result
+                                      # of the bundle dir being blown away after the dynamic package reference had been downloaded
       ensure_pwd_bundle_directory_exists
 
       package_yaml_files = pwd.glob("./**/package.yaml") - pwd.glob("./**/#{BUNDLE_DIR}/**/package.yaml")
@@ -204,6 +208,8 @@ module OpsWalrus
 
       destination_package_path ||= dynamic_package_path_for_git_package(package_url, version)
 
+      App.instance.debug "Download git package #{package_url} version #{version.inspect} to #{destination_package_path}"
+
       return destination_package_path if destination_package_path.exist?
 
       if version
@@ -212,6 +218,8 @@ module OpsWalrus
         ::Git.clone(package_url, destination_package_path, config: ['submodule.recurse=true'])
       end
 
+      App.instance.debug "Downloaded git package #{package_url} version #{version.inspect} to #{destination_package_path}"
+
       destination_package_path
     end
 

data/lib/opswalrus/cli.rb

@@ -30,13 +30,11 @@ module OpsWalrus
 
     program_desc 'ops is an operation runner'
 
-    switch [:v, :verbose], desc: "Verbose output"
-    switch :debug, desc: "Debug output"
-    switch :trace, desc: "Trace output"
+    switch :loud, desc: "Verbose output"
+    switch :louder, desc: "Debug output"
+    switch :loudest, desc: "Trace output"
 
-    switch :noop, desc: "Perform a dry run"
-    switch :dryrun, desc: "Perform a dry run"
-    switch :dry_run, desc: "Perform a dry run"
+    switch :dry, desc: "Perform a dry run"
 
     flag [:h, :hosts], multiple: true, desc: "Specify the hosts.yaml file"
     flag [:t, :tags], multiple: true, desc: "Specify a set of tags to filter the hosts by"
@@ -61,7 +59,7 @@ module OpsWalrus
           hosts = global_options[:hosts]
           tags = global_options[:tags]
 
-          $app.set_log_level(global_options[:trace] && :trace || global_options[:debug] && :debug || global_options[:verbose] && :info || :warn)
+          $app.set_log_level(global_options[:loudest] && :trace || global_options[:louder] && :debug || global_options[:loud] && :info || :warn)
 
           $app.report_inventory(hosts, tags: tags)
         end
@@ -123,12 +121,10 @@ module OpsWalrus
     long_desc 'Bootstrap a set of hotss to run opswalrus: install dependencies, ruby, opswalrus gem'
     command :bootstrap do |c|
       # dry run
-      c.switch :noop, desc: "Perform a dry run"
-      c.switch :dryrun, desc: "Perform a dry run"
-      c.switch :dry_run, desc: "Perform a dry run"
+      c.switch :dry, desc: "Perform a dry run"
 
       c.action do |global_options, options, args|
-        $app.set_log_level(global_options[:trace] && :trace || global_options[:debug] && :debug || global_options[:verbose] && :info || :warn)
+        $app.set_log_level(global_options[:loudest] && :trace || global_options[:louder] && :debug || global_options[:loud] && :info || :warn)
 
         hosts = global_options[:hosts]
         $app.set_inventory_hosts(hosts)
@@ -141,7 +137,7 @@ module OpsWalrus
 
         $app.set_identity_files(id_files)
 
-        dry_run = [:noop, :dryrun, :dry_run].any? {|sym| global_options[sym] || options[sym] }
+        dry_run = global_options[:dry] || options[:dry]
         $app.dry_run! if dry_run
 
         $app.bootstrap()
@@ -155,12 +151,10 @@ module OpsWalrus
       c.flag [:u, :user], desc: "Specify the user that the operation will run as"
 
       # dry run
-      c.switch :noop, desc: "Perform a dry run"
-      c.switch :dryrun, desc: "Perform a dry run"
-      c.switch :dry_run, desc: "Perform a dry run"
+      c.switch :dry, desc: "Perform a dry run"
 
       c.action do |global_options, options, args|
-        $app.set_log_level(global_options[:trace] && :trace || global_options[:debug] && :debug || global_options[:verbose] && :info || :warn)
+        $app.set_log_level(global_options[:loudest] && :trace || global_options[:louder] && :debug || global_options[:loud] && :info || :warn)
 
         hosts = global_options[:hosts]
         $app.set_inventory_hosts(hosts)
@@ -176,7 +170,7 @@ module OpsWalrus
 
         $app.set_identity_files(id_files)
 
-        dry_run = [:noop, :dryrun, :dry_run].any? {|sym| global_options[sym] || options[sym] }
+        dry_run = global_options[:dry] || options[:dry]
         $app.dry_run! if dry_run
 
         if options[:pass]
@@ -193,12 +187,10 @@ module OpsWalrus
     long_desc 'Reboot one or more remote hosts'
     command :reboot do |c|
       # dry run
-      c.switch :noop, desc: "Perform a dry run"
-      c.switch :dryrun, desc: "Perform a dry run"
-      c.switch :dry_run, desc: "Perform a dry run"
+      c.switch :dry, desc: "Perform a dry run"
 
       c.action do |global_options, options, args|
-        $app.set_log_level(global_options[:trace] && :trace || global_options[:debug] && :debug || global_options[:verbose] && :info || :warn)
+        $app.set_log_level(global_options[:loudest] && :trace || global_options[:louder] && :debug || global_options[:loud] && :info || :warn)
 
         hosts = global_options[:hosts]
         $app.set_inventory_hosts(hosts)
@@ -211,7 +203,7 @@ module OpsWalrus
 
         $app.set_identity_files(id_files)
 
-        dry_run = [:noop, :dryrun, :dry_run].any? {|sym| global_options[sym] || options[sym] }
+        dry_run = global_options[:dry] || options[:dry]
         $app.dry_run! if dry_run
 
         exit_status = $app.reboot()
@@ -227,17 +219,16 @@ module OpsWalrus
       c.switch [:b, :bundle], desc: "Update bundle prior to running the specified operation"
       c.switch :pass, desc: "Prompt for a sudo password"
       c.switch :script, desc: "Script mode"
+      c.switch [:r, :remote], desc: "Run the operation on the remote hosts"
 
       c.flag [:u, :user], desc: "Specify the user that the operation will run as"
       c.flag [:p, :params], desc: "Either specify a file that contains JSON OR specify a JSON encoded string. In both cases, the JSON represents the runtime arguments (i.e. the params) for the operation. The JSON string must conform to the params schema for the operation being run."
 
       # dry run
-      c.switch :noop, desc: "Perform a dry run"
-      c.switch :dryrun, desc: "Perform a dry run"
-      c.switch :dry_run, desc: "Perform a dry run"
+      c.switch :dry, desc: "Perform a dry run"
 
       c.action do |global_options, options, args|
-        $app.set_log_level(global_options[:trace] && :trace || global_options[:debug] && :debug || global_options[:verbose] && :info || :warn)
+        $app.set_log_level(global_options[:loudest] && :trace || global_options[:louder] && :debug || global_options[:loud] && :info || :warn)
 
         hosts = global_options[:hosts]
         $app.set_inventory_hosts(hosts)
@@ -256,7 +247,7 @@ module OpsWalrus
 
         $app.set_identity_files(id_files)
 
-        dry_run = [:noop, :dryrun, :dry_run].any? {|sym| global_options[sym] || options[sym] }
+        dry_run = global_options[:dry] || options[:dry]
         $app.dry_run! if dry_run
 
         if options[:pass]
@@ -267,7 +258,11 @@ module OpsWalrus
           $app.script_mode!
         end
 
-        exit_status = $app.run(args, update_bundle: options[:bundle])
+        exit_status = if options[:remote]
+          $app.run_remote(args, update_bundle: options[:bundle])
+        else
+          $app.run(args, update_bundle: options[:bundle])
+        end
 
         exit_now!("error", exit_status) unless exit_status == 0
       end
@@ -281,7 +276,7 @@ module OpsWalrus
       long_desc 'Download and bundle the latest versions of dependencies for the current package'
       c.command :update do |update|
         update.action do |global_options, options, args|
-          $app.set_log_level(global_options[:trace] && :trace || global_options[:debug] && :debug || global_options[:verbose] && :info || :warn)
+          $app.set_log_level(global_options[:loudest] && :trace || global_options[:louder] && :debug || global_options[:loud] && :info || :warn)
 
           $app.bundle_update
         end
@@ -301,7 +296,7 @@ module OpsWalrus
         unzip.flag [:o, :output], desc: "Specify the output directory"
 
         unzip.action do |global_options, options, args|
-          $app.set_log_level(global_options[:trace] && :trace || global_options[:debug] && :debug || global_options[:verbose] && :info || :warn)
+          $app.set_log_level(global_options[:loudest] && :trace || global_options[:louder] && :debug || global_options[:loud] && :info || :warn)
 
           output_dir = options[:output]
           zip_file_path = args.first

data/lib/opswalrus/host.rb

@@ -81,6 +81,12 @@ module OpsWalrus
       @_host.to_s
     end
 
+    def _invoke_remote(ops_file, *args, **kwargs)
+      App.instance.debug "Remove invoke #{ops_file.relative_path_to_app_pwd} on host `#{to_s}` with args:\n  #{args.inspect}\nkwargs:\n  #{kwargs.inspect}"
+
+      RemoteInvocation.new(self, ops_file, ops_prompt_for_sudo_password: !!ssh_password).invoke(*args, **kwargs)
+    end
+
     # returns [stdout, stderr, exit_status]
     def _bootstrap_host(print_report = true)
       # copy over bootstrap shell script
@@ -119,7 +125,7 @@ module OpsWalrus
       raise Error, "Unable to upload ops bundle to remote host" unless upload_success
 
       stdout, _stderr, exit_status = @_host.run_ops(:bundle, "unzip tmpops.zip", in_bundle_root_dir: false)
-      raise Error, "Unable to unzip ops bundle on remote host" unless exit_status == 0
+      raise Error, "Unable to unzip ops bundle on remote host: #{stdout}" unless exit_status == 0
       tmp_bundle_root_dir = stdout.strip
       @_host.set_ssh_session_tmp_bundle_root_dir(tmp_bundle_root_dir)
 
@@ -168,7 +174,8 @@ module OpsWalrus
             # while trying to reconnect, we expect the following exceptions:
             # 1. Net::SSH::Disconnect < Net::SSH::Exception with message: "connection closed by remote host"
             # 2. Errno::ECONNRESET < SystemCallError with message: "Connection reset by peer"
-          rescue Net::SSH::Disconnect, Errno::ECONNRESET => e
+            # 3. Errno::ECONNREFUSED < SystemCallError with message: "Connection refused - connect(2) for 192.168.56.10:22"
+          rescue Net::SSH::Disconnect, Errno::ECONNRESET, Errno::ECONNREFUSED => e
             # noop; we expect these while we're trying to reconnect
           rescue => e
             puts "#{e.class} < #{e.class.superclass}"
@@ -214,7 +221,7 @@ module OpsWalrus
     end
 
     # returns the tuple: [stdout, stderr, exit_status]
-    def shell!(desc_or_cmd = nil, cmd = nil, block = nil, input: nil, log_level: nil, ops_prompt_for_sudo_password: false)
+    def shell!(desc_or_cmd = nil, cmd = nil, block = nil, input: nil, ops_prompt_for_sudo_password: false)
       # description = nil
 
       return ["", "", 0] if !desc_or_cmd && !cmd && !block    # we were told to do nothing; like hitting enter at the bash prompt; we can do nothing successfully
@@ -241,28 +248,24 @@ module OpsWalrus
       #cmd = Shellwords.escape(cmd)
 
       cmd_id = Random.uuid.split('-').first
-      # if App.instance.report_mode?
       output_block = StringIO.open do |io|
-        io.print Style.blue(host)
-        io.print " (#{Style.blue(self.alias)})" if self.alias
-        io.print " | #{Style.magenta(description)}" if description
-        io.puts
-        io.print Style.yellow(cmd_id)
-        io.print Style.green.bold(" > ")
-        io.puts Style.yellow(cmd)
+        if App.instance.info?   # this is true if log_level is trace, debug, info
+          io.print Style.blue(host)
+          io.print " (#{Style.blue(self.alias)})" if self.alias
+          io.print " | #{Style.magenta(description)}" if description
+          io.puts
+          io.print Style.yellow(cmd_id)
+          io.print Style.green.bold(" > ")
+          io.puts Style.yellow(cmd)
+        elsif App.instance.warn? && description
+          io.print Style.blue(host)
+          io.print " (#{Style.blue(self.alias)})" if self.alias
+          io.print " | #{Style.magenta(description)}" if description
+          io.puts
+        end
         io.string
       end
-      puts output_block
-
-        # puts Style.green("*" * 80)
-        # if self.alias
-        #   print "[#{Style.blue(self.alias)} | #{Style.blue(host)}] "
-        # else
-        #   print "[#{Style.blue(host)}] "
-        # end
-        # print "#{description}: " if description
-        # puts Style.yellow("[#{cmd_id}] #{cmd}")
-      # end
+      puts output_block unless output_block.empty?
 
       return unless cmd && !cmd.strip.empty?
 
@@ -277,27 +280,37 @@ module OpsWalrus
       seconds = t2 - t1
 
       output_block = StringIO.open do |io|
-        if App.instance.info? || log_level == :info
-          io.puts Style.cyan(out)
-          io.puts Style.red(err)
-        elsif App.instance.debug? || log_level == :debug
-          io.puts Style.cyan(out)
-          io.puts Style.red(err)
-        elsif App.instance.trace? || log_level == :trace
-          io.puts Style.cyan(out)
-          io.puts Style.red(err)
-        end
-        io.print Style.yellow(cmd_id)
-        io.print Style.blue(" | Finished in #{seconds} seconds with exit status ")
-        if exit_status == 0
-          io.puts Style.green("#{exit_status} (#{exit_status == 0 ? 'success' : 'failure'})")
-        else
-          io.puts Style.red("#{exit_status} (#{exit_status == 0 ? 'success' : 'failure'})")
+        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)
+          elsif App.instance.debug?
+            io.puts Style.cyan(out)
+            io.puts Style.red(err)
+          elsif App.instance.info?
+            # io.puts Style.cyan(out)
+            # io.puts Style.red(err)
+          end
+          io.print Style.yellow(cmd_id)
+          io.print Style.blue(" | Finished in #{seconds} seconds with exit status ")
+          if exit_status == 0
+            io.puts Style.green("#{exit_status} (success)")
+          else
+            io.puts Style.red("#{exit_status} (failure)")
+          end
+          io.puts Style.green("*" * 80)
+        elsif App.instance.warn? && description
+          io.print Style.blue(" | Finished in #{seconds} seconds with exit status ")
+          if exit_status == 0
+            io.puts Style.green("#{exit_status} (success)")
+          else
+            io.puts Style.red("#{exit_status} (failure)")
+          end
+          io.puts Style.green("*" * 80)
         end
-        io.puts Style.green("*" * 80)
         io.string
       end
-      puts output_block
+      puts output_block unless output_block.empty?
 
       [out, err, exit_status]
     end
@@ -313,18 +326,18 @@ module OpsWalrus
       # cmd = "OPS_GEM=\"#{OPS_GEM}\" OPSWALRUS_LOCAL_HOSTNAME='#{local_hostname_for_remote_host}'; $OPS_GEM exec --conservative -g opswalrus ops"
       cmd = "OPSWALRUS_LOCAL_HOSTNAME='#{local_hostname_for_remote_host}' eval #{OPS_CMD}"
       if App.instance.trace?
-        cmd << " --trace"
+        cmd << " --loudest"
       elsif App.instance.debug?
-        cmd << " --debug"
+        cmd << " --louder"
       elsif App.instance.info?
-        cmd << " --verbose"
+        cmd << " --loud"
       end
       cmd << " #{ops_command.to_s}"
       cmd << " #{ops_command_options.to_s}" if ops_command_options
       cmd << " #{@tmp_bundle_root_dir}" if in_bundle_root_dir
       cmd << " #{command_arguments}" unless command_arguments.empty?
 
-      shell!(cmd, log_level: :info, ops_prompt_for_sudo_password: ops_prompt_for_sudo_password)
+      shell!(cmd, ops_prompt_for_sudo_password: ops_prompt_for_sudo_password)
     end
 
     def desc(msg)

data/lib/opswalrus/interaction_handlers.rb

@@ -8,9 +8,7 @@ module OpsWalrus
 
     attr_accessor :input_mappings   # Hash[ String | Regex => String ]
 
-    # log_level is one of: :fatal, :error, :warn, :info, :debug, :trace
-    def initialize(mapping, log_level = nil)
-      @log_level = log_level
+    def initialize(mapping)
       @input_mappings = mapping
     end
 
@@ -63,7 +61,7 @@ module OpsWalrus
       if new_mapping.empty? || new_mapping == @input_mappings
         yield self
       else
-        yield ScopedMappingInteractionHandler.new(new_mapping, @log_level)
+        yield ScopedMappingInteractionHandler.new(new_mapping)
       end
     end
 

data/lib/opswalrus/invocation.rb

@@ -196,4 +196,62 @@ module OpsWalrus
 
   end
 
+
+
+
+
+  class RemoteInvocation
+    def initialize(host_proxy, ops_file, ops_prompt_for_sudo_password: nil)
+      @host_proxy = host_proxy
+      @ops_file = ops_file
+      @ops_prompt_for_sudo_password = ops_prompt_for_sudo_password
+    end
+
+    def invoke(*args, **kwargs)
+      # when there are args or kwargs, then the method invocation represents an attempt to run an OpsFile on a remote host,
+      # so we want to build up a command and send it to the remote host via HostDSL#run_ops
+      remote_run_command_args = @ops_file.relative_path_to_app_pwd.to_s
+
+      unless args.empty?
+        remote_run_command_args << " "
+        remote_run_command_args << args.join(" ")
+      end
+
+      begin
+        json = JSON.dump(kwargs) unless kwargs.empty?
+        if json
+          # write the kwargs to a tempfile
+          json_kwargs_tempfile = Tempfile.create('ops_invoke_kwargs')
+          json_kwargs_tempfile.write(json)
+          json_kwargs_tempfile.close()   # we want to close the file without unlinking so that we can copy it to the remote host before deleting it
+
+          # upload the kwargs file to the remote host
+          json_kwargs_tempfile_path = json_kwargs_tempfile.path.to_pathname
+          remote_json_kwargs_tempfile_basename = json_kwargs_tempfile_path.basename
+          @host_proxy.upload(json_kwargs_tempfile_path, remote_json_kwargs_tempfile_basename)
+        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 << " --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)
+        else
+          @host_proxy.run_ops(:run, ops_command_options, remote_run_command_args, ops_prompt_for_sudo_password: @ops_prompt_for_sudo_password)
+        end
+
+        retval
+      ensure
+        if json_kwargs_tempfile
+          json_kwargs_tempfile.close rescue nil
+          File.unlink(json_kwargs_tempfile) rescue nil
+        end
+        # todo: make sure this cleanup is present
+        if remote_json_kwargs_tempfile_basename
+          @host_proxy.execute(:rm, "-f", remote_json_kwargs_tempfile_basename)
+        end
+      end
+    end
+  end
 end

data/lib/opswalrus/operation_runner.rb

@@ -110,12 +110,12 @@ 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
+      # 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

data/lib/opswalrus/ops_file.rb

@@ -233,6 +233,13 @@ module OpsWalrus
     #   end
     # end
 
+    # if ops_file_path is /home/david/sync/projects/ops/davidinfra/opswalrus_bundle/pkg_https---github.com-opswalrus-core_version_/file/exists.ops
+    # and the @app.pwd is /home/david/sync/projects/ops/davidinfra
+    # then this returns opswalrus_bundle/pkg_https---github.com-opswalrus-core_version_/file/exists.ops
+    def relative_path_to_app_pwd
+      @ops_file_path.relative_path_from(@app.pwd)
+    end
+
     # "/home/david/sync/projects/ops/ops/core/host/info.ops" => "/home/david/sync/projects/ops/ops/core/host"
     def dirname
       @ops_file_path.dirname

data/lib/opswalrus/ops_file_script_dsl.rb

@@ -48,6 +48,7 @@ module OpsWalrus
 
 
   module OpsFileScriptDSL
+    # we run the block in the context of the host proxy object, s.t. `self` within the block evaluates to the host proxy object
     def ssh_noprep(*args, **kwargs, &block)
       runtime_env = @runtime_env
 
@@ -112,6 +113,7 @@ module OpsWalrus
       results
     end # def ssh
 
+    # we run the block in the context of the host proxy object, s.t. `self` within the block evaluates to the host proxy object
     def ssh(*args, **kwargs, &block)
       runtime_env = @runtime_env
 
@@ -122,7 +124,6 @@ module OpsWalrus
 
       results_lock = Thread::Mutex.new
       results = {}
-      # bootstrap_shell_script = BootstrapLinuxHostShellScript
       # on sshkit_hosts do |sshkit_host|
       SSHKit::Coordinator.new(sshkit_hosts).each(in: kwargs[:in] || :parallel) do |sshkit_host|
         # in this context, self is an instance of one of the subclasses of SSHKit::Backend::Abstract, e.g. SSHKit::Backend::Netssh
@@ -263,7 +264,7 @@ module OpsWalrus
     end
 
     # returns the tuple: [stdout, stderr, exit_status]
-    def shell!(desc_or_cmd = nil, cmd = nil, block = nil, input: nil, log_level: nil)
+    def shell!(desc_or_cmd = nil, cmd = nil, block = nil, input: nil)
       return ["", "", 0] if !desc_or_cmd && !cmd && !block    # we were told to do nothing; like hitting enter at the bash prompt; we can do nothing successfully
 
       description = desc_or_cmd if cmd || block
@@ -285,7 +286,7 @@ module OpsWalrus
       end
       #cmd = Shellwords.escape(cmd)
 
-      report_on(@runtime_env.local_hostname, description, cmd, log_level: log_level) do
+      report_on(@runtime_env.local_hostname, description, cmd) do
         if App.instance.dry_run?
           ["", "", 0]
         else
@@ -300,19 +301,25 @@ module OpsWalrus
       end
     end
 
-    def report_on(hostname, description = nil, cmd, log_level: nil)
+    def report_on(hostname, description = nil, cmd)
       cmd_id = Random.uuid.split('-').first
 
       output_block = StringIO.open do |io|
-        io.print Style.blue(hostname)
-        io.print " | #{Style.magenta(description)}" if description
-        io.puts
-        io.print Style.yellow(cmd_id)
-        io.print Style.green.bold(" > ")
-        io.puts Style.yellow(cmd)
+        if App.instance.info?   # this is true if log_level is trace, debug, info
+          io.print Style.blue(hostname)
+          io.print " | #{Style.magenta(description)}" if description
+          io.puts
+          io.print Style.yellow(cmd_id)
+          io.print Style.green.bold(" > ")
+          io.puts Style.yellow(cmd)
+        elsif App.instance.warn? && description
+          io.print Style.blue(hostname)
+          io.print " | #{Style.magenta(description)}" if description
+          io.puts
+        end
         io.string
       end
-      puts output_block
+      puts output_block unless output_block.empty?
 
       t1 = Time.now
       out, err, exit_status = yield
@@ -320,27 +327,37 @@ module OpsWalrus
       seconds = t2 - t1
 
       output_block = StringIO.open do |io|
-        if App.instance.info? || log_level == :info
-          io.puts Style.cyan(out)
-          io.puts Style.red(err)
-        elsif App.instance.debug? || log_level == :debug
-          io.puts Style.cyan(out)
-          io.puts Style.red(err)
-        elsif App.instance.trace? || log_level == :trace
-          io.puts Style.cyan(out)
-          io.puts Style.red(err)
-        end
-        io.print Style.yellow(cmd_id)
-        io.print Style.blue(" | Finished in #{seconds} seconds with exit status ")
-        if exit_status == 0
-          io.puts Style.green("#{exit_status} (#{exit_status == 0 ? 'success' : 'failure'})")
-        else
-          io.puts Style.red("#{exit_status} (#{exit_status == 0 ? 'success' : 'failure'})")
+        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)
+          elsif App.instance.debug?
+            io.puts Style.cyan(out)
+            io.puts Style.red(err)
+          elsif App.instance.info?
+            # io.puts Style.cyan(out)
+            # io.puts Style.red(err)
+          end
+          io.print Style.yellow(cmd_id)
+          io.print Style.blue(" | Finished in #{seconds} seconds with exit status ")
+          if exit_status == 0
+            io.puts Style.green("#{exit_status} (success)")
+          else
+            io.puts Style.red("#{exit_status} (failure)")
+          end
+          io.puts Style.green("*" * 80)
+        elsif App.instance.warn? && description
+          io.print Style.blue(" | Finished in #{seconds} seconds with exit status ")
+          if exit_status == 0
+            io.puts Style.green("#{exit_status} (success)")
+          else
+            io.puts Style.red("#{exit_status} (failure)")
+          end
+          io.puts Style.green("*" * 80)
         end
-        io.puts Style.green("*" * 80)
         io.string
       end
-      puts output_block
+      puts output_block unless output_block.empty?
 
       [out, err, exit_status]
     end

data/lib/opswalrus/patches.rb

@@ -1,5 +1,7 @@
 require 'json'
 require 'pathname'
+require 'active_support'
+require 'active_support/core_ext/hash'
 
 class String
   def escape_single_quotes

data/lib/opswalrus/version.rb

@@ -1,3 +1,3 @@
 module OpsWalrus
-  VERSION = "1.0.52"
+  VERSION = "1.0.54"
 end

data/opswalrus.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # gem dependencies
+  spec.add_dependency "activesupport", "~> 7.0"
   spec.add_dependency "binding_of_caller", "~> 1.0"
   spec.add_dependency "citrus", "~> 3.0"
   spec.add_dependency "gli", "~> 2.21"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: opswalrus
 version: !ruby/object:Gem::Version
-  version: 1.0.52
+  version: 1.0.54
 platform: ruby
 authors:
 - David Ellis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-20 00:00:00.000000000 Z
+date: 2023-09-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: binding_of_caller
   requirement: !ruby/object:Gem::Requirement
@@ -186,6 +200,7 @@ files:
 - lib/opswalrus.rb
 - lib/opswalrus/_bootstrap.ops
 - lib/opswalrus/_reboot.ops
+- lib/opswalrus/_run_remote.ops
 - lib/opswalrus/_shell.ops
 - lib/opswalrus/app.rb
 - lib/opswalrus/bootstrap.sh