kanrisuru 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93755393c0e2f4b2353bdd4bda27df54e4aceccf3ae7cd6d77f0e4cbc8c908c7
-  data.tar.gz: f28c287f77b9edcb505e319030d67fc51287b99dc23cc0903fcfcb7dcec8c52c
+  metadata.gz: 4ffb2183c8f1a5610dd416259a663787076f79cb8502fe8656a52d2c2cd1a7e0
+  data.tar.gz: 43b63c2e14d7f29356cd110261ef1ba55aabd50e97830e4aea3770429625caf8
 SHA512:
-  metadata.gz: 493e8a9019139f5326e50b2ade2ef1f5c631bec796fc08655455e356b0718ce41f5e34d1b348cc88f8f6c1f6857a56ed36dff30c56f285866c525ed07500b342
-  data.tar.gz: 4b4a6141a7bbc4731c6693639071470291881876589ee8033195d3f9e32a13fd6bad444ccfd2cf8bf1f5d302c93b3a09d6cf2e32ecda42fef954c2d2a93595d6
+  metadata.gz: c0b333f36fb00bd16177fe434522c2bd1717db0019d39dba681ab7810b786aca050e6ea79c2647a1bedf4f0bdb4d7e6ffb26079b2ad10d92d3b6da6e4372ee56
+  data.tar.gz: 17377294cc356a44b1a76c6d32bae36940d8ec43d31cdbf0716c4d347735a8d30591e94a8babc8f7cd70d68127f7177d6a2dd70015c4eb8132148868e47a227d

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## Kanrisuru 0.7.2 (August 9, 2021) ##
+* Fixed bug with the `os_method_cache` instance variable set in the namespaced instance of a host. This was causing collision issues inbetween host instances, where, hosts with the same aliased method name was getting overwritten (with a different OS), since the namespace instance variable existing on the host class definition wasn't getting reset inbetween host instantiations. Given that the `os_method_cache` is normally re-instantiated, this bug fix addresses this so that the `os_method_cache` is always defined on the host instance, ie:
+
+  ```ruby
+  host.instance_variable_get(:@os_method_cache)
+  host.instance_variable_set(:@os_method_cache, os_method_cache)
+  ```
+  This is done instead of being saved on the namespace module. With the previous bug fix of using namespaced keys, there's no way for a method to be overwritten otherwise with a global `os_method_cache`.
+
 ## Kanrisuru 0.7.1 (August 8, 2021) ##
 * Fix bug with `os_include` when caching namespace unbound methods, use the namespace in the 
 cache key to avoid any namespace collisions with the same method name, namely:

data/lib/kanrisuru/os_package.rb

@@ -8,7 +8,6 @@ module Kanrisuru
       def self.extended(base)
         base.instance_variable_set(:@os_method_properties, {})
         base.instance_variable_set(:@os_methods, Set.new)
-        base.instance_variable_set(:@os_method_cache, {})
       end
 
       def os_define(os_name, method_name, options = {})
@@ -102,12 +101,6 @@ module Kanrisuru
         include_methods   = (public_methods + protected_methods + private_methods).flatten
 
         include_method_bindings = proc do
-          define_method 'os_method_cache' do
-            @os_method_cache ||= {}
-          end
-
-          private :os_method_cache
-
           include_methods.each do |method_name|
             define_method method_name do |*args, &block|
               unbound_method = mod.instance_method(method_name)
@@ -144,10 +137,11 @@ module Kanrisuru
           ## defined with the methods added.
           if Kanrisuru::Remote::Host.instance_variable_defined?("@#{namespace}")
             namespace_class = Kanrisuru::Remote::Host.const_get(Kanrisuru::Util.camelize(namespace))
-            namespace_instance = instance_variable_get("@#{namespace}")
+            namespace_instance = Kanrisuru::Remote::Host.instance_variable_get("@#{namespace}")
           else
             namespace_class    = Kanrisuru::Remote::Host.const_set(Kanrisuru::Util.camelize(namespace), Class.new)
             namespace_instance = Kanrisuru::Remote::Host.instance_variable_set("@#{namespace}", namespace_class.new)
+
             class_eval do
               define_method namespace do
                 namespace_instance.instance_variable_set(:@host, self)
@@ -165,14 +159,16 @@ module Kanrisuru
           os_method_names.each do |method_name|
             if namespace
               namespace_class.class_eval do
+
                 define_method method_name do |*args, &block|
                   unbound_method = nil
 
+                  host = namespace_instance.instance_variable_get(:@host)
+                  os_method_cache = host.instance_variable_get(:@os_method_cache) || {}
+
                   if os_method_cache.key?("#{namespace}.#{method_name}")
                     unbound_method = os_method_cache["#{namespace}.#{method_name}"]
                   else
-                    host = namespace_instance.instance_variable_get(:@host)
-
                     ## Find the correct method to resolve based on the OS for the remote host.
                     defined_method_name = host.resolve_os_method_name(os_method_properties, method_name)
                     unless defined_method_name
@@ -186,6 +182,7 @@ module Kanrisuru
                     ## Cache the unbound method on this host instance for faster resolution on
                     ## the next invocation of this method
                     os_method_cache["#{namespace}.#{method_name}"] = unbound_method
+                    host.instance_variable_set(:@os_method_cache, os_method_cache)
                   end
 
                   ## Bind the method to host instance and
@@ -196,12 +193,13 @@ module Kanrisuru
             else
               define_method method_name do |*args, &block|
                 unbound_method = nil
+                
+                host = self
+                os_method_cache = host.instance_variable_get(:@os_method_cache) || {}
 
                 if os_method_cache.key?(method_name)
                   unbound_method = os_method_cache[method_name]
                 else
-                  host = self
-
                   ## Find the correct method to resolve based on the OS for the remote host.
                   defined_method_name = host.resolve_os_method_name(os_method_properties, method_name)
                   raise NoMethodError, "undefined method `#{method_name}' for #{self.class}" unless defined_method_name
@@ -213,6 +211,7 @@ module Kanrisuru
                   ## Cache the unbound method on this host instance for faster resolution on
                   ## the next invocation of this method
                   os_method_cache[method_name] = unbound_method
+                  host.instance_variable_set(:@os_method_cache, os_method_cache)
                 end
 
                 ## Bind the method to host instance and

data/lib/kanrisuru/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kanrisuru
-  VERSION = '0.7.1'
+  VERSION = '0.7.2'
 end

data/spec/functional/os_package_spec.rb

@@ -40,18 +40,66 @@ module Kanrisuru
       a - b
     end
   end
+
+  module TestAliasNames
+    extend Kanrisuru::OsPackage::Define
+
+    os_define :fedora, :output_fedora, alias: :output
+    os_define :debian, :output_debian, alias: :output
+    os_define :sles,   :output_sles, alias: :output
+
+    def output_debian
+      'debian'
+    end
+
+    def output_fedora
+      'fedora'
+    end
+
+    def output_sles
+      'sles'
+    end
+  end
+
+  module TestAliasNamesNamespace
+    extend Kanrisuru::OsPackage::Define
+
+    os_define :fedora, :output_fedora, alias: :output
+    os_define :debian, :output_debian, alias: :output
+    os_define :sles,   :output_sles, alias: :output
+
+    def output_debian
+      'debian'
+    end
+
+    def output_fedora
+      'fedora'
+    end
+
+    def output_sles
+      'sles'
+    end
+  end
 end
 
 module Kanrisuru
   module Remote
     class Host
       os_include Kanrisuru::TestInclude
+
+      os_include Kanrisuru::TestAliasNames
+      os_include Kanrisuru::TestAliasNamesNamespace, namespace: :alias
+
       os_include Kanrisuru::TestNamespaceAdditions, namespace: :asdf
       os_include Kanrisuru::TestNamespace, namespace: :asdf
     end
 
     class Cluster
       os_collection Kanrisuru::TestInclude
+
+      os_collection Kanrisuru::TestAliasNames
+      os_collection Kanrisuru::TestAliasNamesNamespace, namespace: :alias
+
       os_collection Kanrisuru::TestNamespaceAdditions, namespace: :asdf
       os_collection Kanrisuru::TestNamespace, namespace: :asdf
     end
@@ -94,6 +142,52 @@ RSpec.describe Kanrisuru::OsPackage do
     expect(cluster.asdf.tester).to be_instance_of(Array)
 
     host.disconnect
+    host2.disconnect
+    cluster.disconnect
+  end
+
+  it 'includes the correct alias named method' do
+    host1 = Kanrisuru::Remote::Host.new(host: 'ubuntu-host', username: 'ubuntu', keys: ['~/.ssh/id_rsa'])
+    host2 = Kanrisuru::Remote::Host.new(host: 'centos-host', username: 'centos', keys: ['~/.ssh/id_rsa'])
+    host3 = Kanrisuru::Remote::Host.new(host: 'opensuse-host', username: 'opensuse', keys: ['~/.ssh/id_rsa'])
+
+    cluster = Kanrisuru::Remote::Cluster.new([host1, host2, host3])
+
+    expect(host1).to respond_to(:output)
+    expect(host2).to respond_to(:output)
+    expect(host3).to respond_to(:output)
+    expect(host1.output).to eq('debian')
+    expect(host2.output).to eq('fedora')
+    expect(host3.output).to eq('sles')
+
+    expect(cluster).to respond_to(:output)
+    expect(cluster.output).to eq([
+      {:host=>"ubuntu-host", :result=>"debian"},
+      {:host=>"centos-host", :result=>"fedora"},
+      {:host=>"opensuse-host", :result=>"sles"}
+    ])
+
+    expect(host1).to respond_to(:alias)
+    expect(host2).to respond_to(:alias)
+    expect(host3).to respond_to(:alias)
+    expect(host1.alias).to respond_to(:output)
+    expect(host2.alias).to respond_to(:output)
+    expect(host3.alias).to respond_to(:output)
+    expect(host1.alias.output).to eq('debian')
+    expect(host2.alias.output).to eq('fedora')
+    expect(host3.alias.output).to eq('sles')
+
+    expect(cluster).to respond_to(:alias)
+    expect(cluster.alias).to respond_to(:output)
+    expect(cluster.alias.output).to eq([
+      {:host=>"ubuntu-host", :result=>"debian"},
+      {:host=>"centos-host", :result=>"fedora"},
+      {:host=>"opensuse-host", :result=>"sles"}
+    ])
+
+    host1.disconnect
+    host2.disconnect
+    host3.disconnect
     cluster.disconnect
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kanrisuru
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Ryan Mammina