opswalrus 1.0.3 → 1.0.5

data/README.md

@@ -2,6 +2,22 @@
 
 opswalrus is a tool that runs scripts against hosts. It's kind of like Ansible, but aims to be simpler to use.
 
+# Getting started
+
+You have two options:
+- Install via Rubygems
+- Install via Docker
+
+## Rubygems install
+
+## Docker install
+
+```shell
+alias ops='docker run --rm -it -v $HOME/.ssh:/root/.ssh -v /var/run/docker.sock:/var/run/docker.sock -v ${PWD}/:/workdir ghcr.io/opswalrus/ops'
+
+ops --version
+```
+
 # Examples
 
 ```bash

data/lib/opswalrus/app.rb

@@ -64,6 +64,14 @@ module OpsWalrus
       ""  # return empty string because we won't want anyone accidentally printing or inspecting @sudo_password
     end
 
+    def emit_json_output!
+      @emit_json_output = true
+    end
+
+    def emit_json_output?
+      @emit_json_output
+    end
+
     def set_local_hostname(hostname)
       hostname = hostname.strip
       @local_hostname = hostname.empty? ? "localhost" : hostname
@@ -186,6 +194,10 @@ module OpsWalrus
         puts JSON.pretty_generate(result.value)
       end
 
+      if emit_json_output?
+        puts JSON.pretty_generate(result.value)
+      end
+
       exit_status
     ensure
       FileUtils.remove_entry(tmp_dir) if tmp_dir

data/lib/opswalrus/cli.rb

@@ -53,6 +53,7 @@ module OpsWalrus
       c.flag [:u, :user], desc: "Specify the user that the operation will run as"
       c.switch :pass, desc: "Prompt for a sudo password"
       c.flag [:p, :params], desc: "JSON string that represents the input parameters for the operation. The JSON string must conform to the params schema for the operation."
+      c.switch :json, desc: "Emit JSON output"
 
       c.action do |global_options, options, args|
         hosts = global_options[:hosts] || []
@@ -80,6 +81,10 @@ module OpsWalrus
           $app.prompt_sudo_password
         end
 
+        if options[:json]
+          $app.emit_json_output!
+        end
+
         # puts "verbose"
         # puts verbose.inspect
         # puts "user"

data/lib/opswalrus/host.rb

@@ -86,19 +86,26 @@ module OpsWalrus
         # so we want to build up a command and send it to the remote host via HostDSL#run_ops
         @method_chain.unshift(Bundler::BUNDLE_DIR) if @is_invocation_a_call_to_package_in_bundle_dir
 
-        # path_to_ops_file_basename = @method_chain.join(File::Separator)
-        # remote_run_command_args << path_to_ops_file_basename
+        remote_run_command_args = "--json"
 
-        remote_run_command_args = @method_chain.join(" ")
+        remote_run_command_args << " "
+        remote_run_command_args << @method_chain.join(" ")
 
         unless args.empty?
           remote_run_command_args << " "
           remote_run_command_args << args.join(" ")
         end
 
-        unless kvargs.empty?
+        unless kwargs.empty?
           remote_run_command_args << " "
-          remote_run_command_args << kvargs.map{|k,v| "#{k}=#{v}" }.join(" ") unless kvargs.empty?
+          remote_run_command_args << kwargs.map do |k, v|
+            case v
+            when Array
+              v.map {|v_element| "#{k}:#{v_element}" }
+            else
+              "#{k}:#{v}"
+            end
+          end.join(" ")
         end
 
         @host_proxy.run_ops(:run, remote_run_command_args)

data/lib/opswalrus/ops_file_script.rb

@@ -148,9 +148,11 @@ module OpsWalrus
           # we run the block in the context of the host, s.t. `self` within the block evaluates to `host`
           retval = host.instance_exec(local_host, &block)    # host is passed as the argument to the block
 
+          puts retval.inspect
+
           # cleanup
-          if tmp_bundle_dir =~ /tmp/   # sanity check the temp path before we blow away something we don't intend
-            host.execute(:rm, "-rf", "tmpopsbootstrap.sh", "tmpops.zip", tmp_bundle_dir)
+          if tmp_bundle_root_dir =~ /tmp/   # sanity check the temp path before we blow away something we don't intend
+            host.execute(:rm, "-rf", "tmpopsbootstrap.sh", "tmpops.zip", tmp_bundle_root_dir)
           else
             host.execute(:rm, "-rf", "tmpopsbootstrap.sh", "tmpops.zip")
           end
@@ -222,12 +224,12 @@ module OpsWalrus
       @runtime_env.resolve_import_reference(@ops_file_script.ops_file, import_reference)
     end
 
-    def params(*keys)
+    def params(*keys, default: nil)
       keys = keys.map(&:to_s)
       if keys.empty?
         @params
       else
-        @params.dig(*keys)
+        @params.dig(*keys) || default
       end
     end
 

data/lib/opswalrus/version.rb

@@ -1,3 +1,3 @@
 module OpsWalrus
-  VERSION = "1.0.3"
+  VERSION = "1.0.5"
 end

data/lib/opswalrus/walrus_lang.rb

@@ -1,4 +1,5 @@
 require "citrus"
+require "ostruct"
 require "stringio"
 
 module WalrusLang
@@ -54,9 +55,17 @@ module WalrusLang
 
   Citrus.eval(Grammar)
 
-  def self.render(template, binding)
+  # binding_obj : Binding | Hash
+  def self.render(template, binding_obj)
+    binding_obj = binding_obj.to_binding if binding_obj.is_a?(Hash)
     ast = WalrusLang::Parser.parse(template)
-    ast.render(binding)
+    ast.render(binding_obj)
+  end
+end
+
+class Hash
+  def to_binding
+    OpenStruct.new(self).instance_eval { binding }
   end
 end
 

data/opswalrus.gemspec

@@ -3,14 +3,15 @@
 require_relative "lib/opswalrus/version"
 
 Gem::Specification.new do |spec|
-  spec.name = "opswalrus"
-  spec.version = OpsWalrus::VERSION
-  spec.authors = ["David Ellis"]
-  spec.email = ["david@conquerthelawn.com"]
-
-  spec.summary = "opswalrus is a tool that runs scripts against a fleet of hosts"
-  spec.description = "opswalrus is a tool that runs scripts against a fleet of hosts hosts. It's kind of like Ansible, but aims to be simpler to use."
-  spec.homepage = "https://github.com/opswalrus/opswalrus"
+  spec.name                  = "opswalrus"
+  spec.version               = OpsWalrus::VERSION
+  spec.authors               = ["David Ellis"]
+  spec.email                 = ["david@conquerthelawn.com"]
+
+  spec.summary               = "opswalrus is a tool that runs scripts against a fleet of hosts"
+  spec.description           = "opswalrus is a tool that runs scripts against a fleet of hosts hosts. It's kind of like Ansible, but aims to be simpler to use."
+  spec.homepage              = "https://github.com/opswalrus/opswalrus"
+  spec.license               = 'EPL-2.0'
   spec.required_ruby_version = ">= 2.6.0"
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
@@ -31,14 +32,14 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # gem dependencies
-  spec.add_dependency "citrus"
-  spec.add_dependency "gli"
-  spec.add_dependency "git"
-  spec.add_dependency "rubyzip"
-
-  spec.add_dependency "bcrypt_pbkdf"
-  spec.add_dependency "ed25519"
-  spec.add_dependency "sshkit"
+  spec.add_dependency "citrus", "~> 3.0"
+  spec.add_dependency "gli", '~> 2.21'
+  spec.add_dependency "git", '~> 1.18'
+  spec.add_dependency "rubyzip", '~> 2.3'
+
+  spec.add_dependency "bcrypt_pbkdf", '~> 1.1'
+  spec.add_dependency "ed25519", '~> 1.3'
+  spec.add_dependency "sshkit", '~> 1.21'
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opswalrus
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.5
 platform: ruby
 authors:
 - David Ellis
@@ -14,100 +14,100 @@ dependencies:
   name: citrus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: gli
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.21'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.21'
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.18'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: bcrypt_pbkdf
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: ed25519
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: sshkit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.21'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.21'
 description: opswalrus is a tool that runs scripts against a fleet of hosts hosts.
   It's kind of like Ansible, but aims to be simpler to use.
 email:
@@ -118,6 +118,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
+- Dockerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -150,7 +151,8 @@ files:
 - opswalrus.gemspec
 - sig/opswalrus.rbs
 homepage: https://github.com/opswalrus/opswalrus
-licenses: []
+licenses:
+- EPL-2.0
 metadata:
   homepage_uri: https://github.com/opswalrus/opswalrus
   source_code_uri: https://github.com/opswalrus/opswalrus