wash 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29c5e73c61e19273eeeb661fe0632dd71d98c6b5155b3928a71165b4dbcb255d
-  data.tar.gz: 96435335cf622b25ef9fd412ba4a66db4f4ad2d20c12eea766ffad0afdab1d9b
+  metadata.gz: aaae396f56664799c39570eef26c32861301ac233717133cb9cf00a3bb889262
+  data.tar.gz: e618c3d78d9dcff5aeb2a3cbaa3642a66a947026bd25176d2cfd692f9a14e76c
 SHA512:
-  metadata.gz: 69b74fb0465cd0b9706e597e4226eaf5304aa1888b824e516d8606dc62a998f807b72ae3445068d28afb801fc1252af63ee5876978f23d00ea3ababba7320c65
-  data.tar.gz: 1fc0e79f46a566a26ead6b30d82c84d62918b37abe7efd2fb45eb02abe0160df014281b2c2f174932c4b98fcfc9c8102f037d38c2930ce0c25e2b3bbc1b736cb
+  metadata.gz: 7fe1ee4d30afcd383893007022ffbd306ac6c324ca67ce8387d77faf407abd0a7f184c86428473f101358f4d99d743716e24b9161e3352a50fe55b0b0f4809bc
+  data.tar.gz: 7d1b888019d19babb129227b77996be16e16e7994e7c6d4b8627bf3f735277fc0afa0e5e7eb1a5c95c38937347d6f3bf6c12cf6250b5eabfe8288081b9226cb7

data/lib/wash.rb

@@ -9,7 +9,7 @@ module Wash
     @pretty_print = true
   end
 
-  # enable_entry_schemas enables {Entry schema}[https://puppetlabs.github.io/wash/docs/#entry-schemas]
+  # enable_entry_schemas enables {Entry schema}[https://puppetlabs.github.io/wash/docs/external-plugins#entry-schemas]
   # support. See {Wash::Entry}'s documentation for more details on
   # the available Entry schema helpers.
   def self.enable_entry_schemas
@@ -126,7 +126,7 @@ module Wash
   private_class_method :print_json
 
   def self.parse_json(json)
-    JSON.parse(json,:symbolize_names => true)
+    JSON.parse(json, symbolize_names: true)
   end
   private_class_method :parse_json
 

data/lib/wash/entry.rb

@@ -66,7 +66,7 @@ module Wash
       #     end
       #   end
       #
-      # Note that Wash.run uses {Class#allocate} when it reconstructs the entries, so
+      # Note that Wash.run uses Class#allocate when it reconstructs the entries, so
       # it does not call the initialize method.
       def state(field, *fields)
         @state ||= []
@@ -187,6 +187,11 @@ module Wash
         end
         visited[type_id][:children] = @child_klasses
         @child_klasses.each do |child_klass|
+          if child_klass == VOLUMEFS
+            visited[child_klass] = {}
+            next
+          end
+
           child_klass = const_get(child_klass)
           if visited[child_klass.send(:type_id)]
             next
@@ -237,6 +242,10 @@ module Wash
       end
     end
 
+    # Name of the volume filesystem type in Wash. Use with `parent_of` when
+    # returning `volumefs` in your `list` method.
+    VOLUMEFS = '__volume::fs__'
+
     # All entries have a name. Note that the name is always
     # included in the entry's state hash.
     attr_accessor :name
@@ -244,7 +253,7 @@ module Wash
     # Contains the entry's partial metadata.
     attr_accessor :partial_metadata
 
-    def to_json(*)
+    def to_json(jstate = {})
       unless @name && @name.size > 0
         unless singleton
           raise "A nameless entry is being serialized. The entry is an instance of #{type_id}"
@@ -268,6 +277,8 @@ module Wash
           # supporting more overloaded methods
           block_readable = self.method(:read).arity > 0
           [:read, block_readable]
+        elsif method == :exec && @transport
+          [:exec, { transport: @transport[0], options: @transport[1] }]
         else
           method
         end
@@ -290,9 +301,9 @@ module Wash
       end
       hash[:state] = to_hash(state).merge(klass: type_id, name: @name).to_json
       if Wash.send(:pretty_print?)
-        JSON.pretty_generate(hash)
+        JSON.pretty_generate(hash, jstate)
       else
-        JSON.generate(hash)
+        JSON.generate(hash, jstate)
       end
     end
 
@@ -343,6 +354,49 @@ module Wash
       @cache_ttls = @cache_ttls.merge(ttls)
     end
 
+    # volumefs creates the `volume::fs` entry as specified in Wash's external plugin docs.
+    #
+    # @example
+    #   class Foo
+    #     parent_of VOLUMEFS
+    #     def list
+    #       [volumefs('fs', maxdepth: 5), Bar.new]
+    #     end
+    #   end
+    #
+    # @param [String] name The name to use for the child representing the remote filesystem.
+    # @param [Hash] options Options to configure the filesystem.
+    #     - maxdepth: How deep to walk the remote filesystem when needed. This is a trade-off
+    #       between speed of the transport and filesystem complexity. For fast transports it
+    #       should be low (1-3), for slower transports higher (3-6).
+    def volumefs(name, options = {})
+      { type_id: VOLUMEFS, name: name, state: options.to_json }
+    end
+
+    # transport requests that Wash use a built-in transport with the supplied
+    # transport options to implement Exec. When using this feature, you must
+    # also declare the 'exec' method so it's included in the schema. You may
+    # use this to implement a fallback implementation for entries where the
+    # transport feature is not used.
+    #
+    # @example
+    #   class Foo
+    #     def initialize(name)
+    #       transport :ssh, host: name, user: 'root'
+    #     end
+    #
+    #     def exec
+    #       raise 'implemented by transport'
+    #     end
+    #   end
+    #
+    # @param [Symbol] klass The transport to use. Only `:ssh` is supported
+    # @param [Hash] options For SSH: :host (required), :user, :fallback_user,
+    #     :password, :identity_file, :known_hosts, :host_key_alias, :retries, :port
+    def transport(klass, options = {})
+      @transport = [klass, options]
+    end
+
     # schema returns the entry's schema. It should not be overridden.
     def schema
       schemaHash = {}

data/lib/wash/method.rb

@@ -42,17 +42,17 @@ module Wash
         # the size and offset
         args = args.map(&:to_i)
       end
-      STDOUT.print(entry.read(*args))
+      $stdout.print(entry.read(*args))
     end
 
     method(:write) do |entry, _|
-      entry.write(STDIN)
+      entry.write($stdin)
     end
 
     method(:exec) do |entry, *args|
       opts, cmd, args = Wash.send(:parse_json, args[0]), args[1], args[2..-1]
       if opts[:stdin]
-        opts[:stdin] = STDIN
+        opts[:stdin] = $stdin
       else
         opts[:stdin] = nil
       end

data/lib/wash/streamer.rb

@@ -17,8 +17,8 @@ module Wash
           puts("200")
           @first_chunk = false
         end
-        STDOUT.print(chunk)
-        STDOUT.flush
+        $stdout.print(chunk)
+        $stdout.flush
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wash
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-14 00:00:00.000000000 Z
+date: 2020-01-28 00:00:00.000000000 Z
 dependencies: []
 description: A library for building Wash external plugins
 email:
@@ -40,8 +40,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A library for building Wash external plugins