moose-inventory 1.0.7 → 1.0.9

data/spec/lib/moose_inventory/cli/host_rmvar_spec.rb

@@ -9,7 +9,7 @@ RSpec.describe Moose::Inventory::Cli::Host do
     @mockarg_parts = {
       config:  File.join(spec_root, 'config/config.yml'),
       format:  'yaml',
-      env:     'test'
+      env:     'test',
     }
 
     @mockargs = []
@@ -38,169 +38,169 @@ RSpec.describe Moose::Inventory::Cli::Host do
       result = @host.instance_methods(false).include?(:rmvar)
       expect(result).to eq(true)
     end
-    
+
     #-----------------
-     it '<missing args> ... should abort with an error' do
-       actual = runner  do
-         @app.start(%w(host rmvar)) # <- no group given
-       end
- 
-       # Check output
-       desired = { aborted: true}
-       desired[:STDERR] = "ERROR: Wrong number of arguments, 0 for 2 or more.\n"
-       expected(actual, desired)
-     end
- 
-     #------------------------
-     it 'HOST key=value ... should abort if the host does not exist' do
-       host_name = "not-a-host"
-       var_name = "foo=bar"
-       actual = runner do
-         @app.start(%W(host rmvar #{host_name} #{var_name}))
-       end
- 
-       # Check output
-       desired = { aborted: true}
-       desired[:STDOUT] =
-         "Remove variable(s) '#{var_name}' from host '#{host_name}':\n"\
-         "  - retrieve host '#{host_name}'...\n"
-       desired[:STDERR] = 
-         "An error occurred during a transaction, any changes have been rolled back.\n"\
-         "ERROR: The host '#{host_name}' does not exist.\n"
-       expected(actual, desired)
-     end
- 
-     #------------------------
-     it 'HOST <malformed> ... should abort with an error' do
-        # 1. Should add the var to the db
-        # 2. Should associate the host with the var
-        
-        host_name = 'test1'
-        @db.models[:host].create(name: host_name)
-  
-        var  = {name: 'foo', value: "bar"}
-        cases = %W(
-          =bar 
-          foo=bar=
-          =foo=bar
-          foo=bar=extra
-        )      
-
-        cases.each do |args| 
-          actual = runner do
-            @app.start(%W(host rmvar #{host_name} #{args} ))
-          end
-          #@console.out(actual,'p')
-    
-          desired = { aborted: true}
-          desired[:STDOUT] = 
-            "Remove variable(s) '#{args}' from host '#{host_name}':\n"\
-            "  - retrieve host '#{host_name}'...\n"\
-            "    - OK\n"\
-            "  - remove variable '#{args}'...\n"
-          desired[:STDERR] = 
-            "An error occurred during a transaction, any changes have been rolled back.\n"\
-            "ERROR: Incorrect format in {#{args}}. Expected 'key' or 'key=value'.\n"
-            
-          expected(actual, desired)
+    it '<missing args> ... should abort with an error' do
+      actual = runner  do
+        @app.start(%w(host rmvar)) # <- no group given
+      end
+
+      # Check output
+      desired = { aborted: true }
+      desired[:STDERR] = "ERROR: Wrong number of arguments, 0 for 2 or more.\n"
+      expected(actual, desired)
+    end
+
+    #------------------------
+    it 'HOST key=value ... should abort if the host does not exist' do
+      host_name = 'not-a-host'
+      var_name = 'foo=bar'
+      actual = runner do
+        @app.start(%W(host rmvar #{host_name} #{var_name}))
+      end
+
+      # Check output
+      desired = { aborted: true }
+      desired[:STDOUT] =
+        "Remove variable(s) '#{var_name}' from host '#{host_name}':\n"\
+        "  - retrieve host '#{host_name}'...\n"
+      desired[:STDERR] =
+        "An error occurred during a transaction, any changes have been rolled back.\n"\
+        "ERROR: The host '#{host_name}' does not exist.\n"
+      expected(actual, desired)
+    end
+
+    #------------------------
+    it 'HOST <malformed> ... should abort with an error' do
+      # 1. Should add the var to the db
+      # 2. Should associate the host with the var
+
+      host_name = 'test1'
+      @db.models[:host].create(name: host_name)
+
+      var = { name: 'foo', value: 'bar' }
+      cases = %w(
+        =bar
+        foo=bar=
+        =foo=bar
+        foo=bar=extra
+      )
+
+      cases.each do |args|
+        actual = runner do
+          @app.start(%W(host rmvar #{host_name} #{args}))
         end
+        # @console.out(actual,'p')
+
+        desired = { aborted: true }
+        desired[:STDOUT] =
+          "Remove variable(s) '#{args}' from host '#{host_name}':\n"\
+          "  - retrieve host '#{host_name}'...\n"\
+          "    - OK\n"\
+          "  - remove variable '#{args}'...\n"
+        desired[:STDERR] =
+          "An error occurred during a transaction, any changes have been rolled back.\n"\
+          "ERROR: Incorrect format in {#{args}}. Expected 'key' or 'key=value'.\n"
+
+        expected(actual, desired)
       end
-     
+    end
+
     #------------------------
     it 'host rmvar HOST <valid args> ... should remove the host variable' do
-       # 1. Should add the var to the db
-       # 2. Should associate the host with the var
-       
-       host_name = 'test1'
-
-       var  = {name: 'foo', value: "bar"}
-       cases = %W(
-         #{var[:name]}
-         #{var[:name]}=
-         #{var[:name]}=#{var[:value]}
-       )
-       cases.each do |example|
-         # reset the db
-         @db.reset
-         
-         # Add an initial host and hostvar
-         @db.models[:host].create(name: host_name)
-         runner do
-           @app.start(%W(host addvar #{host_name} #{var[:name]}=#{var[:value]} ))
-         end
-         
-         # Try to remove the hostvar using the case example valid args 
-         actual = runner do
-           @app.start(%W(host rmvar #{host_name} #{example}))
-         end
-         #@console.out(actual,'p')
-         
-         # Check the output
-         desired = { aborted: false}
-         desired[:STDOUT] =
-           "Remove variable(s) '#{example}' from host '#{host_name}':\n"\
-           "  - retrieve host '#{host_name}'...\n"\
-           "    - OK\n"\
-           "  - remove variable '#{example}'...\n"\
-           "    - OK\n"\
-           "  - all OK\n"\
-           "Succeeded.\n"
-           
-          #@console.out(desired,'p')  
-         expected(actual, desired)
-   
-         # Check the db
-         host = @db.models[:host].find(name: host_name)
-         hostvars = host.hostvars_dataset
-         expect(hostvars.count).to eq(0)
-         
-         hostvars = @db.models[:hostvar].all
-         expect(hostvars.count).to eq(0)
-       end
+      # 1. Should add the var to the db
+      # 2. Should associate the host with the var
+
+      host_name = 'test1'
+
+      var = { name: 'foo', value: 'bar' }
+      cases = %W(
+        #{var[:name]}
+        #{var[:name]}=
+        #{var[:name]}=#{var[:value]}
+      )
+      cases.each do |example|
+        # reset the db
+        @db.reset
+
+        # Add an initial host and hostvar
+        @db.models[:host].create(name: host_name)
+        runner do
+          @app.start(%W(host addvar #{host_name} #{var[:name]}=#{var[:value]}))
+        end
+
+        # Try to remove the hostvar using the case example valid args
+        actual = runner do
+          @app.start(%W(host rmvar #{host_name} #{example}))
+        end
+        # @console.out(actual,'p')
+
+        # Check the output
+        desired = { aborted: false }
+        desired[:STDOUT] =
+          "Remove variable(s) '#{example}' from host '#{host_name}':\n"\
+          "  - retrieve host '#{host_name}'...\n"\
+          "    - OK\n"\
+          "  - remove variable '#{example}'...\n"\
+          "    - OK\n"\
+          "  - all OK\n"\
+          "Succeeded.\n"
+
+        # @console.out(desired,'p')
+        expected(actual, desired)
+
+        # Check the db
+        host = @db.models[:host].find(name: host_name)
+        hostvars = host.hostvars_dataset
+        expect(hostvars.count).to eq(0)
+
+        hostvars = @db.models[:hostvar].all
+        expect(hostvars.count).to eq(0)
+      end
     end
-    
+
     #------------------------
     it 'HOST key1=value1 key2=value2 ... should remove multiple key/value pairs' do
       host_name = 'test1'
-      varsarray  = [
-        {name: 'var1', value: "val1"},
-        {name: 'var2', value: "val2"}
+      varsarray = [
+        { name: 'var1', value: 'val1' },
+        { name: 'var2', value: 'val2' },
       ]
-          
+
       vars = []
       varsarray.each do |var|
         vars << "#{var[:name]}=#{var[:value]}"
       end
-        
+
       @db.models[:host].create(name: host_name)
       actual = runner do
-        @app.start(%W(host addvar #{host_name}) + vars )
+        @app.start(%W(host addvar #{host_name}) + vars)
       end
-      
+
       actual = runner do
-        @app.start(%W(host rmvar #{host_name}) + vars )
+        @app.start(%W(host rmvar #{host_name}) + vars)
       end
-      #@console.out(actual,'p')
-      
-      desired = { aborted: false}
-      desired[:STDOUT] = 
+      # @console.out(actual,'p')
+
+      desired = { aborted: false }
+      desired[:STDOUT] =
         "Remove variable(s) '#{vars.join(',')}' from host '#{host_name}':\n"\
         "  - retrieve host '#{host_name}'...\n"\
         "    - OK\n"
       vars.each do |var|
-        desired[:STDOUT] =  desired[:STDOUT] + 
-          "  - remove variable '#{var}'...\n"\
-          "    - OK\n"
+        desired[:STDOUT] = desired[:STDOUT] +
+                           "  - remove variable '#{var}'...\n"\
+                           "    - OK\n"
       end
-      desired[:STDOUT] =  desired[:STDOUT] + 
-        "  - all OK\n"\
-        "Succeeded.\n"
+      desired[:STDOUT] = desired[:STDOUT] +
+                         "  - all OK\n"\
+                         "Succeeded.\n"
       expected(actual, desired)
-    
+
       # We should have the correct hostvar associations
       host = @db.models[:host].find(name: host_name)
       hostvars = host.hostvars_dataset
       expect(hostvars.count).to eq(0)
-    end        
+    end
   end
 end

data/spec/lib/moose_inventory/config/config_spec.rb

@@ -6,7 +6,7 @@ RSpec.describe 'Moose::Inventory::Config' do
     @mockarg_parts = {
       config:  File.join(spec_root, 'config/config.yml'),
       format:  'yaml',
-      env:     'test'
+      env:     'test',
     }
 
     @mockargs = []
@@ -39,7 +39,7 @@ RSpec.describe 'Moose::Inventory::Config' do
     end
 
     it 'should default "--format" to json' do
-      @config.init([])
+      @config.init(['--config', @mockarg_parts[:config]])
       expect(@config._confopts[:format]).to eq('json')
     end
 
@@ -49,7 +49,7 @@ RSpec.describe 'Moose::Inventory::Config' do
     end
 
     it 'should default "--env" to ""' do
-      @config.init([])
+      @config.init(['--config', @mockarg_parts[:config]])
       expect(@config._confopts[:env]).to eq('')
     end
 
@@ -76,5 +76,18 @@ RSpec.describe 'Moose::Inventory::Config' do
       @config.init(@mockargs)
       expect(@config._settings[:config][:db]).not_to be_nil
     end
+
+    it 'uses safe YAML loading for configuration files' do
+      expect(YAML).not_to receive(:load_file)
+      expect(YAML).to receive(:safe_load_file).with(
+        @mockarg_parts[:config],
+        aliases: false,
+        permitted_classes: [],
+        permitted_symbols: []
+      ).and_call_original
+
+      @config.init(@mockargs)
+      expect(@config._settings[:config][:db]).not_to be_nil
+    end
   end
 end

data/spec/lib/moose_inventory/db/db_spec.rb

@@ -1,6 +1,26 @@
 require 'spec_helper'
+require 'fileutils'
+require 'tmpdir'
 
 RSpec.describe 'Moose::Inventory::DB' do
+  def with_db_config(db_config)
+    saved_db = @db.instance_variable_get(:@db)
+    saved_settings = @config._settings.dup
+
+    begin
+      @db.instance_variable_set(:@db, nil)
+      @config._settings.clear
+      @config._settings[:config] = { db: db_config }
+      yield
+    ensure
+      current_db = @db.instance_variable_get(:@db)
+      current_db.disconnect if current_db.respond_to?(:disconnect)
+      @db.instance_variable_set(:@db, saved_db)
+      @config._settings.clear
+      @config._settings.merge!(saved_settings)
+    end
+  end
+
   #=============================
   # Initialization
   #
@@ -10,7 +30,7 @@ RSpec.describe 'Moose::Inventory::DB' do
     @mockarg_parts = {
       config:  File.join(spec_root, 'config/config.yml'),
       format:  'yaml',
-      env:     'test'
+      env:     'test',
     }
 
     @mockargs = []
@@ -22,7 +42,7 @@ RSpec.describe 'Moose::Inventory::DB' do
     @config = Moose::Inventory::Config
     @config.init(@mockargs)
 
-    @db      = Moose::Inventory::DB
+    @db = Moose::Inventory::DB
   end
 
   #=============================
@@ -47,6 +67,208 @@ RSpec.describe 'Moose::Inventory::DB' do
 
       expect(failed).to eq(false)
     end
+
+    it 'raises a Moose DB exception for unsupported adapters' do
+      saved_db = @db.instance_variable_get(:@db)
+      saved_models = @db.instance_variable_get(:@models)
+      saved_exceptions = @db.instance_variable_get(:@exceptions)
+      saved_settings = @config._settings.dup
+
+      begin
+        @db.instance_variable_set(:@db, nil)
+        @db.instance_variable_set(:@models, nil)
+        @db.instance_variable_set(:@exceptions, nil)
+        @config._settings.clear
+        @config._settings[:config] = { db: { adapter: 'unsupported' } }
+
+        expect { @db.init }.to raise_error(
+          Moose::Inventory::DB::MooseDBException,
+          /database adapter unsupported is not yet supported/
+        )
+        expect(@db.exceptions[:moose]).to eq(Moose::Inventory::DB::MooseDBException)
+      ensure
+        @db.instance_variable_set(:@db, saved_db)
+        @db.instance_variable_set(:@models, saved_models)
+        @db.instance_variable_set(:@exceptions, saved_exceptions)
+        @config._settings.clear
+        @config._settings.merge!(saved_settings)
+      end
+    end
+  end
+
+  describe '.init_exceptions()' do
+    it 'is responsive' do
+      expect(@db.respond_to?(:init_exceptions)).to eq(true)
+    end
+  end
+
+  describe '.connect()' do
+    it 'dispatches the documented sqlite3 adapter to the sqlite initializer' do
+      with_db_config(adapter: 'sqlite3') do
+        expect(@db).to receive(:init_sqlite3) do
+          @db.instance_variable_set(:@db, :sqlite_connection)
+        end
+        @db.connect
+        expect(@db.db).to eq(:sqlite_connection)
+      end
+    end
+
+    it 'dispatches the documented mysql adapter to the mysql initializer' do
+      with_db_config(adapter: 'mysql') do
+        expect(@db).to receive(:init_mysql) do
+          @db.instance_variable_set(:@db, :mysql_connection)
+        end
+        @db.connect
+        expect(@db.db).to eq(:mysql_connection)
+      end
+    end
+
+    it 'dispatches the documented postgresql adapter to the postgresql initializer' do
+      with_db_config(adapter: 'postgresql') do
+        expect(@db).to receive(:init_postgresql) do
+          @db.instance_variable_set(:@db, :postgresql_connection)
+        end
+        @db.connect
+        expect(@db.db).to eq(:postgresql_connection)
+      end
+    end
+  end
+
+  describe '.init_sqlite3()' do
+    it 'raises a Moose DB exception when the configured database file is missing' do
+      with_db_config(adapter: 'sqlite3') do
+        expect { @db.init_sqlite3 }.to raise_error(
+          Moose::Inventory::DB::MooseDBException,
+          /Expected key file missing in sqlite3 configuration/
+        )
+      end
+    end
+
+    it 'creates nested parent directories for configured database files' do
+      saved_db = @db.instance_variable_get(:@db)
+      saved_settings = @config._settings.dup
+      tmpdir = Dir.mktmpdir('moose-inventory-sqlite')
+      nested_dbfile = File.join(tmpdir, 'one', 'two', 'inventory.db')
+
+      begin
+        @db.instance_variable_set(:@db, nil)
+        @config._settings.clear
+        @config._settings[:config] = {
+          db: {
+            adapter: 'sqlite3',
+            file: nested_dbfile,
+          },
+        }
+
+        @db.init_sqlite3
+
+        expect(File.directory?(File.dirname(nested_dbfile))).to eq(true)
+        expect(File.file?(nested_dbfile)).to eq(true)
+      ensure
+        current_db = @db.instance_variable_get(:@db)
+        current_db.disconnect if current_db.respond_to?(:disconnect)
+        @db.instance_variable_set(:@db, saved_db)
+        @config._settings.clear
+        @config._settings.merge!(saved_settings)
+        FileUtils.remove_entry(tmpdir) if tmpdir && Dir.exist?(tmpdir)
+      end
+    end
+  end
+
+  describe '.init_mysql()' do
+    it 'raises a Moose DB exception when a required connection key is missing' do
+      with_db_config(
+        adapter: 'mysql',
+        database: 'moose_inventory_test',
+        user: 'moose',
+        password: 'secret'
+      ) do
+        expect { @db.init_mysql }.to raise_error(
+          Moose::Inventory::DB::MooseDBException,
+          /Expected key host missing in mysql configuration/
+        )
+      end
+    end
+
+    it 'uses the mysql2 Sequel adapter with configured connection settings' do
+      saved_db = @db.instance_variable_get(:@db)
+      saved_settings = @config._settings.dup
+      mysql_config = {
+        adapter: 'mysql',
+        host: 'localhost',
+        database: 'moose_inventory_test',
+        user: 'moose',
+        password: 'secret',
+      }
+
+      begin
+        @db.instance_variable_set(:@db, nil)
+        @config._settings.clear
+        @config._settings[:config] = { db: mysql_config }
+
+        expect(Sequel).to receive(:mysql2).with(
+          user: 'moose',
+          password: 'secret',
+          host: 'localhost',
+          database: 'moose_inventory_test'
+        ).and_return(:mysql2_connection)
+
+        @db.init_mysql
+        expect(@db.db).to eq(:mysql2_connection)
+      ensure
+        @db.instance_variable_set(:@db, saved_db)
+        @config._settings.clear
+        @config._settings.merge!(saved_settings)
+      end
+    end
+  end
+
+  describe '.init_postgresql()' do
+    it 'raises a Moose DB exception when a required connection key is missing' do
+      with_db_config(
+        adapter: 'postgresql',
+        host: 'localhost',
+        database: 'moose_inventory_test',
+        password: 'secret'
+      ) do
+        expect { @db.init_postgresql }.to raise_error(
+          Moose::Inventory::DB::MooseDBException,
+          /Expected key user missing in postgresql configuration/
+        )
+      end
+    end
+
+    it 'uses the postgres Sequel adapter with configured connection settings' do
+      saved_db = @db.instance_variable_get(:@db)
+      saved_settings = @config._settings.dup
+      postgresql_config = {
+        adapter: 'postgresql',
+        host: 'localhost',
+        database: 'moose_inventory_test',
+        user: 'moose',
+        password: 'secret',
+      }
+
+      begin
+        @db.instance_variable_set(:@db, nil)
+        @config._settings.clear
+        @config._settings[:config] = { db: postgresql_config }
+
+        expect(Sequel).to receive(:postgres).with(
+          user: 'moose',
+          password: 'secret',
+          host: 'localhost',
+          database: 'moose_inventory_test'
+        ).and_return(:postgresql_connection)
+
+        @db.init_postgresql
+        expect(@db.db).to eq(:postgresql_connection)
+      ensure
+        @db.instance_variable_set(:@db, saved_db)
+        @config._settings.clear
+        @config._settings.merge!(saved_settings)
+      end
+    end
   end
 
   describe '.db' do

data/spec/lib/moose_inventory/db/models_spec.rb

@@ -10,7 +10,7 @@ RSpec.describe 'models' do
     @mockarg_parts = {
       config:  File.join(spec_root, 'config/config.yml'),
       format:  'yaml',
-      env:     'test'
+      env:     'test',
     }
 
     @mockargs = []
@@ -128,45 +128,44 @@ RSpec.describe 'models' do
     end
 
     it 'should have a many-to-many self-referential relationship (i.e. GROUPS of GROUPS)' do
-      
       parent1 = @db.models[:group].create(name: 'parent1')
       parent2 = @db.models[:group].create(name: 'parent2')
       child1 = @db.models[:group].create(name: 'child1')
       child2 = @db.models[:group].create(name: 'child2')
 
-      parent1.add_child(child1)  
+      parent1.add_child(child1)
       parent1.add_child(child2)
 
-      parent2.add_child(child1)  
+      parent2.add_child(child1)
       parent2.add_child(child2)
-      
+
       group = @db.models[:group].find(name: 'parent1')
       children = group.children_dataset
 
       expect(children).not_to be_nil
       expect(children.count).to eq(2)
-      
+
       group = @db.models[:group].find(name: 'parent2')
       children = group.children_dataset
 
       expect(children).not_to be_nil
       expect(children.count).to eq(2)
     end
-     
+
     it 'should have relationships with Hostvars' do
       groupname = 'group-test'
       groupvarname = 'groupvar-test'
       groupvarval = '1'
-  
+
       group = @db.models[:group].create(name: groupname)
       groupvar = @db.models[:groupvar].create(name: groupvarname,
                                               value: groupvarval)
-  
+
       group.add_groupvar(groupvar)
-  
+
       group = @db.models[:group].find(name: groupname)
       groupvars = group.groupvars_dataset
-  
+
       expect(groupvars).not_to be_nil
       expect(groupvars.count).to eq(1)
       expect(groupvars.first[:name]).to eq(groupvarname)