moose-inventory 1.0.8 → 2.0

data/lib/moose_inventory/cli/host_rmgroup.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 require 'thor'
 require 'json'
 
-require_relative './formatter.rb'
-require_relative '../db/exceptions.rb'
+require_relative 'formatter'
+require_relative '../db/exceptions'
+require_relative '../inventory_context'
+require_relative '../operations/remove_associations'
 
 module Moose
   module Inventory
@@ -13,67 +17,66 @@ module Moose
         #==========================
         desc 'rmgroup HOSTNAME GROUPNAME [GROUPNAME ...]',
              'dissociation the host from a group'
-        # rubocop:disable Metrics/LineLength
-        def rmgroup(*args) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
-          # rubocop:enable Metrics/LineLength
-          if args.length < 2
-            abort('ERROR: Wrong number of arguments, '\
-                  "#{args.length} for 2 or more.")
-          end
-          
-          # Convenience
-          db = Moose::Inventory::DB
-          fmt = Moose::Inventory::Cli::Formatter
-
-          # arguments
-          name   = args[0].downcase
-          groups = args.slice(1, args.length - 1).uniq.map(&:downcase)
-
-          # Sanity
-          if groups.include?('ungrouped')
-            abort 'ERROR: Cannot manually manipulate the automatic '\
-              'group \'ungrouped\'.'
-          end
-          
-          # Transaction
-          db.transaction do # Transaction start
-            puts "Dissociate host '#{name}' from groups '#{groups.join(',')}':" 
-            fmt.puts 2, "- Retrieve host '#{name}'..."
-            host = db.models[:host].find(name: name)
-            if host.nil?
-              fail db.exceptions[:moose],
-                   "The host '#{name}' was not found in the database."
-            end
-            fmt.puts 4, '- OK'
-
-            # dissociate host from the groups
-            groups_ds = host.groups_dataset
-            groups.each do |g|
-              fmt.puts 2, "- Remove association {host:#{name} <-> group:#{g}}..."
-
-              # Check against existing associations
-              if groups_ds[name: g].nil?
-                fmt.warn "Association {host:#{name} <-> group:#{g}} doesn't exist, skipping.\n"
-                fmt.puts 4,  "- Doesn't exist, skipping."
-              else
-                group = db.models[:group].find(name: g)
-                host.remove_group(group) unless group.nil?
-              end
-              fmt.puts 4, '- OK'
-            end
-
-            # Handle 'ungrouped' group automation
-            if host.groups_dataset.count == 0
-              fmt.puts 2, '- Add automatic association '\
-                "{host:#{name} <-> group:ungrouped}..."
-              ungrouped  = db.models[:group].find_or_create(name: 'ungrouped')
-              host.add_group(ungrouped) unless ungrouped.nil?
-              fmt.puts 4, '- OK'
-            end
+        def rmgroup(*args)
+          abort_if_missing_args(args, 2, '2 or more')
+
+          name = args[0].downcase
+          groups = normalize_names(args.slice(1, args.length - 1))
+
+          abort_if_automatic_group(groups)
+
+          context = Moose::Inventory::InventoryContext.new(db: db)
+          operation = Moose::Inventory::Operations::RemoveAssociations.new(context: context)
+
+          db.transaction do
+            puts "Dissociate host '#{name}' from groups '#{groups.join(',')}':"
+            host = fetch_existing_host_for_rmgroup(context, name)
+            render_host_rmgroup_events(
+              operation.host_from_groups(host: host, host_name: name, group_names: groups).events
+            )
             fmt.puts 2, '- All OK'
-          end # End transaction
+          end
           puts 'Succeeded'
         end
+
+        private
+
+        def fetch_existing_host_for_rmgroup(context, name)
+          fmt.puts 2, "- Retrieve host '#{name}'..."
+          host = context.find_host(name)
+          raise db.exceptions[:moose], "The host '#{name}' was not found in the database." if host.nil?
+
+          fmt.puts 4, '- OK'
+          host
+        end
+
+        def render_host_rmgroup_events(events)
+          events.each { |event| render_host_rmgroup_event(event) }
+        end
+
+        def render_host_rmgroup_event(event)
+          payload = event.payload
+
+          return render_host_rmgroup_warning(payload) if event.type == :host_group_association_missing
+          return render_host_rmgroup_missing(payload) if event.type == :missing_skipping
+
+          case event.type
+          when :removing_host_group_association
+            fmt.puts 2, "- Remove association {host:#{payload[:host]} <-> group:#{payload[:group]}}..."
+          when :adding_automatic_group
+            fmt.puts 2, "- Add automatic association {host:#{payload[:host]} <-> group:ungrouped}..."
+          when :ok
+            fmt.puts payload[:indent], '- OK'
+          end
+        end
+
+        def render_host_rmgroup_warning(payload)
+          fmt.warn "Association {host:#{payload[:host]} <-> group:#{payload[:group]}} doesn't exist, skipping.\n"
+        end
+
+        def render_host_rmgroup_missing(payload)
+          fmt.puts payload[:indent], "- Doesn't exist, skipping."
+        end
       end
     end
   end

data/lib/moose_inventory/cli/host_rmvar.rb

@@ -13,7 +13,7 @@ module Moose
         #==========================
         desc 'rmvar', 'Remove a variable from the host'
         # rubocop:disable Metrics/LineLength
-        def rmvar(*args) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize
+        def rmvar(*args) # rubocop:disable Metrics/AbcSize
           # rubocop:enableMetrics/LineLength
           if args.length < 2
             abort('ERROR: Wrong number of arguments, ' \
@@ -30,8 +30,8 @@ module Moose
 
           # Transaction
           db.transaction do # Transaction start
-            puts "Remove variable(s) '#{vars.join(",")}' from host '#{name}':"
-            
+            puts "Remove variable(s) '#{vars.join(',')}' from host '#{name}':"
+
             fmt.puts 2, "- retrieve host '#{name}'..."
             host = db.models[:host].find(name: name)
             if host.nil?

data/lib/moose_inventory/config/config.rb

@@ -41,19 +41,19 @@ module Moose
         #                   Default is to search standard locations.
         #
         # --env ENV      => sets the section to be used as the configuration.
-        #                   Defaults to "", which forces the use of the 
-        #                   defaultenv parameter from the general section of 
-        #                   the config file. 
+        #                   Defaults to "", which forces the use of the
+        #                   defaultenv parameter from the general section of
+        #                   the config file.
         #
         # --format FORMAT=> See formatter for supported types.
         #                   Defaults to json.
         #
         # -- trace       => Enable more complete exceptions for db transactions
-        #                   Default is not to trace. 
+        #                   Default is not to trace.
 
         @_confopts = { env: '', format: 'json', ansible: false, trace: false }
 
-        # Check for two-part flags   
+        # Check for two-part flags
         %w(config env format).each do |var|
           @_argv.each_with_index do |val, index|
             next if val != "--#{var}"
@@ -62,7 +62,7 @@ module Moose
             break
           end
         end
-        
+
         # Check for one-part flags
         %w(ansible trace).each do |var|
           @_argv.each_with_index do |val, index|
@@ -72,59 +72,58 @@ module Moose
             break
           end
         end
-        
+
         # Sanity
-        # - Ansible output format must be json - pjson is permitted, but yaml is not. 
+        # - Ansible output format must be json - pjson is permitted, but yaml is not.
         if @_confopts[:ansible] == true
-          unless @_confopts[:format] =~ /p|pjson|j|json/ 
+          unless @_confopts[:format] =~ /p|pjson|j|json/
             @_confopts[:format] = 'json'
-          end 
+          end
         end
-        
       end
 
       #----------------------
       def self.top_level_help
         if @_argv[0] == 'help'
-          puts "Global flags:"
-          printf "  %-31s %-10s", "--ansible", "# Force Ansible mode (automatically set when using ansible flags)\n"
-          printf "  %-31s %-10s", "--config FILE", "# Specifies a configuration file to use\n"
-          printf "  %-31s %-10s", "--env ENV", "# Specifies the environment section of the config to use\n"
-          printf "  %-31s %-10s", "--format yaml|json|pjson", "# Format for the output of 'get', 'list', and 'listvars' subcommands\n"
-          printf "  %-31s %-10s", "--trace", "# Enable more complete exception dumps for database transactions\n"
+          puts 'Global flags:'
+          printf '  %-31s %-10s', '--ansible', "# Force Ansible mode (automatically set when using ansible flags)\n"
+          printf '  %-31s %-10s', '--config FILE', "# Specifies a configuration file to use\n"
+          printf '  %-31s %-10s', '--env ENV', "# Specifies the environment section of the config to use\n"
+          printf '  %-31s %-10s', '--format yaml|json|pjson', "# Format for the output of 'get', 'list', and 'listvars' subcommands\n"
+          printf '  %-31s %-10s', '--trace', "# Enable more complete exception dumps for database transactions\n"
           puts "\nAnsible flags:"
-          printf "  %-31s %-10s", "--host HOSTNAME", "# Retrieves host variables for the specified host (alias for 'host listvars HOSTNAME')\n"
-          printf "  %-31s %-10s", "--list", "# Retrieves the list of groups (alias for 'group list')\n\n"
+          printf '  %-31s %-10s', '--host HOSTNAME', "# Retrieves host variables for the specified host (alias for 'host listvars HOSTNAME')\n"
+          printf '  %-31s %-10s', '--list', "# Retrieves the list of groups (alias for 'group list')\n\n"
         end
       end
-      
+
       #----------------------
-      def self.ansible_args  # rubocop:disable Metrics/AbcSize
+      def self.ansible_args
         #
         # See http://docs.ansible.com/developing_inventory.html for Ansible specs
         # for dynamic inventory sources
-        
+
         # --list            => group list
         # --host HOSTNAME  => host getvars HOSTNAME
 
         case @_argv[0]
-          when '--list' 
-            @_confopts[:ansible] = true
-            @_confopts[:format] = 'json' unless @_confopts[:format] =~ /p|pjson|j|json/ 
-            @_argv.clear
-            @_argv.concat(['group', 'list']).flatten
-          when '--host'
-            @_confopts[:ansible] = true
-            @_confopts[:format] = 'json' unless @_confopts[:format] =~ /p|pjson|j|json/ 
-            host = @_argv[1]
-            @_argv.clear
-            @_argv.concat(['host', 'listvars', "#{host}"]).flatten
-        end 
+        when '--list'
+          @_confopts[:ansible] = true
+          @_confopts[:format] = 'json' unless @_confopts[:format] =~ /p|pjson|j|json/
+          @_argv.clear
+          @_argv.concat(%w(group list)).flatten
+        when '--host'
+          @_confopts[:ansible] = true
+          @_confopts[:format] = 'json' unless @_confopts[:format] =~ /p|pjson|j|json/
+          host = @_argv[1]
+          @_argv.clear
+          @_argv.concat(['host', 'listvars', host.to_s]).flatten
+        end
       end
 
       #----------------------
-      def self.resolve_config_file # rubocop:disable Metrics/AbcSize
-        if ! @_confopts[:config].nil?
+      def self.resolve_config_file
+        if !@_confopts[:config].nil?
           path = File.expand_path(@_confopts[:config])
           if File.exist?(path)
             @_confopts[:config] = path
@@ -135,8 +134,7 @@ module Moose
           possibles = ['./.moose-tools/inventory/config',
                        '~/.moose-tools/inventory/config',
                        '~/local/etc/moose-tools/inventory/config',
-                       '/etc/moose-tools/inventory/config'
-                      ]
+                       '/etc/moose-tools/inventory/config']
           possibles.each do |f|
             file = File.expand_path(f)
             @_confopts[:config] = file if File.exist?(file)
@@ -170,7 +168,12 @@ module Moose
       # rubocop:disable PerceivedComplexity
       # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize
       def self.load
-        newsets = symbolize_keys(YAML.load_file(@_confopts[:config]))
+        newsets = symbolize_keys(YAML.safe_load_file(
+          @_confopts[:config],
+          aliases: false,
+          permitted_classes: [],
+          permitted_symbols: []
+        ))
 
         path = @_confopts[:config]
 
@@ -184,7 +187,7 @@ module Moose
           env = @_confopts[:env]
           @_settings[:config] = newsets[@_confopts[:env].to_sym]
         else
-          env  = @_settings[:general][:defaultenv]
+          env = @_settings[:general][:defaultenv]
           (env.nil? || env.empty?) && fail("No defaultenv set in #{path}")
           @_settings[:config] = newsets[env.to_sym]
         end

data/lib/moose_inventory/db/db.rb

@@ -22,6 +22,8 @@ module Moose
 
       #----------------------
       def self.init
+        init_exceptions
+
         # If we allow init more than once, then the db connection is remade,
         # which changes Sequel:DATABASES[0], thereby invalidating the sequel
         # models.  This causes unexpected behavour. That is to say, because
@@ -31,8 +33,8 @@ module Moose
         # So, we allow init only once, gated by whether @db is nil. In effect,
         # this means we pool the DB connection for the life of the application.
         # Again, not a problem for our one-shot app, but it may be an issue in
-        # long-running code. Personally, I don't like this pooling regime - 
-        # perhaps I'm not understanding how it's supposed to be used? 
+        # long-running code. Personally, I don't like this pooling regime -
+        # perhaps I'm not understanding how it's supposed to be used?
         #
         # QUESTION: can the models be refreshed, to make then again valid? What if
         #       we "load" instead of "require" the models?
@@ -57,55 +59,58 @@ module Moose
         @models[:group]    = Moose::Inventory::DB::Group
         @models[:groupvar] = Moose::Inventory::DB::Groupvar
 
-        @exceptions = {}
-        @exceptions[:moose] = Moose::Inventory::DB::MooseDBException
+      end
 
+      #--------------------
+      def self.init_exceptions
+        @exceptions ||= {}
+        @exceptions[:moose] ||= Moose::Inventory::DB::MooseDBException
       end
 
       #--------------------
       def self.transaction
         fail('Database connection has not been established') if @db.nil?
-        
+
         tries = 0
-        
+
         begin
           @db.transaction(savepoint: true) do
             yield
           end
 
         rescue Sequel::DatabaseError => e
-        # We want to rescue Sqlite3::BusyException.  But, sequel catches that
-        # and re-raises it as Sequel::DatabaseError, with a message referencing
-        # the original exception class  
-         
-        # We look into e, to see whether it is a BusyException.  If not, 
-        # we re-raise immediately.  
-        raise unless e.message.include?("BusyException")  
-
-        # Looks like a BusyException, so we retry, after a random delay.           
-        tries += 1
-        case tries
-        when 1..10
-          if Moose::Inventory::Config._confopts[:trace] == true
-            STDERR.puts e.message
+          # We want to rescue Sqlite3::BusyException.  But, sequel catches that
+          # and re-raises it as Sequel::DatabaseError, with a message referencing
+          # the original exception class
+
+          # We look into e, to see whether it is a BusyException.  If not,
+          # we re-raise immediately.
+          raise unless e.message.include?('BusyException')
+
+          # Looks like a BusyException, so we retry, after a random delay.
+          tries += 1
+          case tries
+          when 1..10
+            if Moose::Inventory::Config._confopts[:trace] == true
+              $stderr.puts e.message
+            end
+            sleep rand
+            retry
+          else
+            warn('The database appears to be locked by another process, and '\
+                 " did not become free after #{tries} tries. Giving up. ")
+
+            # TODO: Some useful advice to the user, as to what to do about this error.
+            raise
           end
-          sleep rand()
-          retry
-        else
-          warn('The database appears to be locked by another process, and '\
-               " did not become free after #{tries} tries. Giving up. ")
 
-          # TODO: Some useful advice to the user, as to what to do about this error. 
-          raise  
-        end
-            
         rescue @exceptions[:moose] => e
           warn 'An error occurred during a transaction, any changes have been rolled back.'
 
           if Moose::Inventory::Config._confopts[:trace] == true
-            STDERR.puts $!.backtrace    
-            abort("ERROR: #{e}")
-          else      
+            $stderr.puts e.full_message(highlight: false, order: :top)
+            abort("ERROR: #{e.message}")
+          else
             abort("ERROR: #{e.message}")
           end
 
@@ -158,7 +163,7 @@ module Moose
 
         else
           @db.drop_table(:hosts, :hostvars,
-                         :groups,  :groupvars, :group_hosts,
+                         :groups, :groupvars, :group_hosts,
                          if_exists: true, cascade: true)
         end
       end
@@ -195,7 +200,7 @@ module Moose
             foreign_key :child_id,  :groups
           end
         end
-        
+
         unless @db.table_exists? :groupvars
           @db.create_table(:groupvars) do
             primary_key :id
@@ -225,28 +230,29 @@ module Moose
         when 'sqlite3'
           init_sqlite3
 
-        when 'msqsql'
+        when 'mysql'
           init_mysql
 
         when 'postgresql'
           init_postgresql
 
         else
-          fail @exceptions[:moose ], 
-            "database adapter #{adapter} is not yet supported."
+          fail @exceptions[:moose],
+               "database adapter #{adapter} is not yet supported."
         end
       end
 
       #--------------------
       def self.init_sqlite3 # rubocop:disable Metrics/AbcSize
         require 'sqlite3'
+        require 'fileutils'
 
         # Quick check that expected keys are at least present & sensible
         config = Moose::Inventory::Config._settings[:config][:db]
         [:file].each do |key|
           if config[key].nil?
-            fail @exceptions[:moose ], 
-              "Expected key #{key} missing in sqlite3 configuration"
+            fail @exceptions[:moose],
+                 "Expected key #{key} missing in sqlite3 configuration"
           end
         end
         config[:file].empty? && fail("SQLite3 DB 'file' cannot be empty")
@@ -254,7 +260,7 @@ module Moose
         # Make sure the directory exists
         dbfile = File.expand_path(config[:file])
         dbdir = File.dirname(dbfile)
-        Dir.mkdir(dbdir) unless Dir.exist?(dbdir)
+        FileUtils.mkdir_p(dbdir) unless Dir.exist?(dbdir)
 
         # Create and/or open the database file
         @db = Sequel.sqlite(dbfile)
@@ -262,26 +268,60 @@ module Moose
 
       #--------------------
       def self.init_mysql
-        require 'mysql'
+        require 'mysql2'
 
-        # TODO: native MySQL driver vs the pure ruby one?
-        #       Sequel requires the native on.
-        # gem('mysql')
+        # Quick check that expected keys are at least present
+        config = Moose::Inventory::Config._settings[:config][:db]
+        [:host, :database, :user].each do |key|
+          if config[key].nil?
+            fail @exceptions[:moose],
+                 "Expected key #{key} missing in mysql configuration"
+          end
+        end
+        password = db_password(config, 'mysql')
+
+        @db = Sequel.mysql2(user: config[:user],
+                            password: password,
+                            host: config[:host],
+                            database: config[:database])
+      end
+
+      #--------------------
+      def self.init_postgresql
+        require 'pg'
 
         # Quick check that expected keys are at least present
         config = Moose::Inventory::Config._settings[:config][:db]
-        [:host, :database, :user, :password].each do |key|
+        [:host, :database, :user].each do |key|
           if config[key].nil?
-            fail @exceptions[:moose ],
-              "Expected key #{key} missing in mysql configuration"
+            fail @exceptions[:moose],
+                 "Expected key #{key} missing in postgresql configuration"
           end
         end
+        password = db_password(config, 'postgresql')
+
+        @db = Sequel.postgres(user: config[:user],
+                              password: password,
+                              host: config[:host],
+                              database: config[:database])
+      end
+
+      #--------------------
+      def self.db_password(config, adapter)
+        return config[:password] unless config[:password].nil?
+
+        if config[:password_env].nil?
+          fail @exceptions[:moose],
+               "Expected key password or password_env missing in #{adapter} configuration"
+        end
+
+        password = ENV.fetch(config[:password_env].to_s, nil)
+        if password.nil? || password.empty?
+          fail @exceptions[:moose],
+               "Environment variable #{config[:password_env]} is not set for #{adapter} password"
+        end
 
-        @db = Sequel.mysql(user: config[:user],
-                           password: config[:password],
-                           host: config[:host],
-                           database: config[:database]
-                          )
+        password
       end
     end
   end

data/lib/moose_inventory/db/models.rb

@@ -11,20 +11,19 @@ module Moose
       ##
       # Model for the groups table
       class Group < Sequel::Model
-        
-        many_to_many :parents,  
-                     :left_key=>:parent_id, 
-                     :right_key=>:child_id, 
-                     :class=>self
-        
-        many_to_many :children, 
-                     :left_key=>:child_id, 
-                     :right_key=>:parent_id, 
-                     :class=>self        
+        many_to_many :parents,
+                     left_key: :parent_id,
+                     right_key: :child_id,
+                     class: self
 
-        many_to_many :hosts 
+        many_to_many :children,
+                     left_key: :child_id,
+                     right_key: :parent_id,
+                     class: self
+
+        many_to_many :hosts
         one_to_many  :groupvars
-      end   
+      end
 
       ##
       # Model for the hostvars table

data/lib/moose_inventory/inventory_context.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Moose
+  module Inventory
+    ##
+    # Thin facade over the current DB singleton.
+    #
+    # This gives new operation/service objects a small inventory-facing seam
+    # without forcing the legacy CLI to stop using the DB singleton all at once.
+    class InventoryContext
+      AUTOMATIC_GROUP = 'ungrouped'
+
+      def initialize(db: Moose::Inventory::DB)
+        @db = db
+      end
+
+      def transaction(&)
+        db.transaction(&)
+      end
+
+      def find_host(name)
+        db.models[:host].find(name: name)
+      end
+
+      def create_host(name)
+        db.models[:host].create(name: name)
+      end
+
+      def find_group(name)
+        db.models[:group].find(name: name)
+      end
+
+      def create_group(name)
+        db.models[:group].create(name: name)
+      end
+
+      def find_or_create_group(name)
+        db.models[:group].find_or_create(name: name)
+      end
+
+      def automatic_group
+        find_or_create_group(AUTOMATIC_GROUP)
+      end
+
+      private
+
+      attr_reader :db
+    end
+  end
+end