moose-inventory 0.1.0

data/lib/moose/inventory/db/db.rb

@@ -0,0 +1,249 @@
+require 'sequel'
+require 'json'
+
+require_relative './exceptions.rb'
+
+module Moose
+  module Inventory
+    ##
+    # Module for DB-related functionality
+    module DB
+      # rubocop:disable Style/ModuleFunction
+      extend self
+      # rubocop:enable Style/ModuleFunction
+
+      @db         = nil
+      @models     = nil
+      @exceptions = nil
+
+      attr_reader :db
+      attr_reader :models
+      attr_reader :exceptions
+
+      #----------------------
+      def self.init
+        # 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
+        # of the way Sequel initializes models, this method is not idempotent.
+        # In our single-shot application, this shouldn't be a problem. However,
+        # our unit tests like to call init multiple times, which borks things.
+        # 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? 
+        #
+        # TODO: can the models be refreshed, to make then again valid? What if
+        #       we "load" instead of "require" the models?
+        # UPDATE: Nope, still borks even if we use a load.
+        #
+        # @db = nil            # <- fails for unit tests
+        return unless @db.nil? # <- works for unit tests
+
+        Sequel::Model.plugin :json_serializer
+        connect
+        create_tables
+
+        # Make our models work
+        Sequel::DATABASES[0] = @db
+        require_relative 'models'
+        # load( load_dir = File.join(File.dirname(__FILE__), "models.rb") )
+
+        # For convenience
+        @models = {}
+        @models[:host]     = Moose::Inventory::DB::Host
+        @models[:hostvar]  = Moose::Inventory::DB::Hostvar
+        @models[:group]    = Moose::Inventory::DB::Group
+        @models[:groupvar] = Moose::Inventory::DB::Groupvar
+
+        @exceptions = {}
+        @exceptions[:moose] = Moose::Inventory::DB::MooseDBException
+
+      end
+
+      #--------------------
+      def self.transaction
+        fail('Database connection has not been established') if @db.nil?
+        begin
+          @db.transaction(savepoint: true) do
+            yield
+          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
+            abort("ERROR: #{e}")
+          else          
+            abort("ERROR: #{e.message}")
+          end
+
+        rescue Exception => e
+          warn 'An error occurred during a transaction, any changes have been rolled back.'
+          raise e
+        end
+      end
+
+      #--------------------
+      def self.reset
+        fail('Database connection has not been established') if @db.nil?
+        # @debug << 'reset'
+        purge
+        create_tables
+      end
+
+      #===============================
+
+      private
+
+      #--------------------
+      def self.purge # rubocop:disable Metrics/AbcSize
+        adapter = Moose::Inventory::Config._settings[:config][:db][:adapter]
+        adapter.downcase!
+
+        if adapter == 'sqlite3'
+          # HACK: SQLite3 supposedly supports CASCADE, see
+          # https://www.sqlite.org/foreignkeys.html#fk_actions
+          # However, when we do a drop_table with :cascade=>true
+          # on an sqlite3 database, it throws errors regarding
+          # foreign keys constraints. Instead, the following is
+          # less efficient, but does work.
+
+          Group.all.each do |g|
+            g.remove_all_hosts
+            g.remove_all_groupvars
+            g.destroy
+          end
+
+          Host.all.each do |h|
+            h.remove_all_groups
+            h.remove_all_hostvars
+            h.destroy
+          end
+
+          Groupvar.all.each(&:destroy)
+          Hostvar.all.each(&:destroy)
+
+        else
+          @db.drop_table(:hosts, :hostvars,
+                         :groups,  :groupvars, :group_hosts,
+                         if_exists: true, cascade: true)
+        end
+      end
+
+      #--------------------
+      def self.create_tables # rubocop:disable Metrics/AbcSize
+        unless @db.table_exists? :hosts
+          @db.create_table(:hosts) do
+            primary_key :id
+            column :name, :text, unique: true
+          end
+        end
+
+        unless @db.table_exists? :hostvars
+          @db.create_table(:hostvars) do
+            primary_key :id
+            foreign_key :host_id
+            column :name, :text
+            column :value, :text
+          end
+        end
+
+        unless @db.table_exists? :groups
+          @db.create_table(:groups) do
+            primary_key :id
+            column :name, :text, unique: true
+          end
+        end
+
+        unless @db.table_exists? :groupvars
+          @db.create_table(:groupvars) do
+            primary_key :id
+            foreign_key :group_id
+            column :name, :text
+            column :value, :text
+          end
+        end
+
+        unless @db.table_exists? :groups_hosts
+          @db.create_table(:groups_hosts) do
+            primary_key :id
+            foreign_key :host_id,  :hosts
+            foreign_key :group_id, :groups
+          end
+        end
+      end
+
+      #--------------------
+      def self.connect
+        return unless @db.nil?
+
+        adapter = Moose::Inventory::Config._settings[:config][:db][:adapter]
+        adapter.downcase!
+
+        case adapter
+        when 'sqlite3'
+          init_sqlite3
+
+        when 'msqsql'
+          init_mysql
+
+        when 'postgresql'
+          init_postgresql
+
+        else
+          fail @exceptions[:moose ], 
+            "database adapter #{adapter} is not yet supported."
+        end
+      end
+
+      #--------------------
+      def self.init_sqlite3 # rubocop:disable Metrics/AbcSize
+        require 'sqlite3'
+
+        # 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"
+          end
+        end
+        config[:file].empty? && fail("SQLite3 DB 'file' cannot be empty")
+
+        # Make sure the directory exists
+        dbfile = File.expand_path(config[:file])
+        dbdir = File.dirname(dbfile)
+        Dir.mkdir(dbdir) unless Dir.exist?(dbdir)
+
+        # Create and/or open the database file
+        @db = Sequel.sqlite(dbfile)
+      end
+
+      #--------------------
+      def self.init_mysql
+        require 'mysql'
+
+        # 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, :password].each do |key|
+          if config[key].nil?
+            fail @exceptions[:moose ],
+              "Expected key #{key} missing in mysql configuration"
+          end
+        end
+
+        @db = Sequel.mysql(user: config[:user],
+                           password: config[:password],
+                           host: config[:host],
+                           database: config[:database]
+                          )
+      end
+    end
+  end
+end

data/lib/moose/inventory/db/exceptions.rb

@@ -0,0 +1,14 @@
+module Moose
+  module Inventory
+    module DB
+      ##
+      # This class provides a Moose-specific db exception error
+      class MooseDBException < RuntimeError
+        attr_reader :message
+        def initialize(message)
+          @message = message || 'An undefined Moose exception occurred'
+        end
+      end
+    end
+  end
+end

data/lib/moose/inventory/db/models.rb

@@ -0,0 +1,32 @@
+module Moose
+  module Inventory
+    module DB
+      ##
+      # Model for the hosts table
+      class Host < Sequel::Model
+        many_to_many :groups
+        one_to_many :hostvars
+      end
+
+      ##
+      # Model for the groups table
+      class Group < Sequel::Model
+        # TODO: Groups of groups? (i.e. a group with children?)
+        many_to_many :hosts
+        one_to_many :groupvars
+      end
+
+      ##
+      # Model for the hostvars table
+      class Hostvar < Sequel::Model
+        many_to_one :hosts
+      end
+
+      ##
+      # Model for the groupvars table
+      class Groupvar < Sequel::Model
+        many_to_one :groups
+      end
+    end
+  end
+end

data/lib/moose/inventory/moose_inventory_cli.rb

@@ -0,0 +1,25 @@
+require 'thor'
+require_relative './config/config.rb'
+require_relative './db/db.rb'
+require_relative './cli/application.rb'
+
+module Moose
+  module Inventory
+    ##
+    # Module implementing the CLI for moose-inventory
+    module Cli
+      # rubocop:disable Style/ModuleFunction
+      extend self
+      # rubocop:enable Style/ModuleFunction
+
+      def start(args)
+        # initialization stuff.
+        Moose::Inventory::Config.init(args)
+        Moose::Inventory::DB.init
+
+        # Start the main application
+        Moose::Inventory::Cli::Application.start(Moose::Inventory::Config._argv)
+      end
+    end
+  end
+end

data/lib/moose/inventory/version.rb

@@ -0,0 +1,7 @@
+module Moose
+  ##
+  # The Moose-Tools dynanic inventory management library
+  module Inventory
+    VERSION = '0.1.0'
+  end
+end

data/moose-inventory.gemspec

@@ -0,0 +1,45 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'moose/inventory/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'moose-inventory'
+  spec.version       = Moose::Inventory::VERSION
+  spec.authors       = ['Russell Davies']
+  spec.email         = ['russell@blakemere.ca']
+  spec.summary       = 'Moose-tools inventory manager'
+  # rubocop:disable Metrics/LineLength
+  spec.description   = 'The Moosecastle CLI tool for Ansible-compatable dynamic inventory management.'
+  # rubocop:enable Metrics/LineLength
+  spec.homepage      = 'http://www.blakemere.ca'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'indentation', '~> 0.1'
+  spec.add_runtime_dependency 'json',        '~>1.8'
+  spec.add_runtime_dependency 'mysql',       '~>2.9'
+  # spec.add_runtime_dependency 'mysql2',    '~>0.3'
+  spec.add_runtime_dependency 'pg',        '~>0.17'
+  spec.add_runtime_dependency 'sequel',    '~>4.22'
+  spec.add_runtime_dependency 'sqlite3',   '~>1.3'
+  spec.add_runtime_dependency 'thor',      '~>0.19'
+  # spec.add_runtime_dependency   'yaml',      '~>1.0'
+
+  spec.add_development_dependency 'bundler',      '~> 1.10'
+  spec.add_development_dependency 'coveralls',    '~> 0.8'
+  spec.add_development_dependency 'hitimes',      '~> 1.2'
+  spec.add_development_dependency 'guard',        '~> 2.12'
+  spec.add_development_dependency 'guard-rspec',  '~> 4.5'
+  spec.add_development_dependency 'guard-rubocop',  '~> 1.2'
+  spec.add_development_dependency 'rake',         '~> 10.1'
+  spec.add_development_dependency 'rspec',        '~>3.2'
+  spec.add_development_dependency 'rubocop',      '>= 0.19'
+  spec.add_development_dependency 'simplecov',    '~> 0.10'
+end

data/scripts/guard_quality.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+guard -g quality
+

data/scripts/guard_test.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+guard -g test

data/scripts/reports.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+firefox spec/reports/quality/rubocop.html spec/reports/coverage/index.html spec/reports/test/rspec.html
+

data/spec/config/config.yml

@@ -0,0 +1,12 @@
+---
+general:
+  defaultenv: test
+
+test:
+  db:
+    adapter: "sqlite3"
+    file:    "./tmp/test.db"
+
+rspectest:
+  result: "true"
+    

data/spec/lib/moose/inventory/cli/application_spec.rb

@@ -0,0 +1,15 @@
+# require 'spec_helper'
+#
+# RSpec.describe Moose::Inventory::Cli::Group do
+#  before do
+#    # Set up the configuration object
+#    mockargs = "--format yaml --env testing --config ./test.config"
+#    Moose::Inventory::Config
+#  end
+#
+#  describe ".add" do
+#    it '"add test" should add a group called test' do
+#      expect(["group","add","test").to_eq(2)
+#    end
+#  end
+# end

data/spec/lib/moose/inventory/cli/cli_spec.rb

@@ -0,0 +1,26 @@
+ require 'spec_helper'
+
+ RSpec.describe Moose::Inventory::Cli::Application do
+  before do
+    @app = Moose::Inventory::Cli::Application
+  end
+
+  describe ".version" do
+    # --------------------
+    it 'method should be responsive' do
+      result = @app.instance_methods(false).include?(:version)
+      expect(result).to eq(true)
+    end
+    
+    # --------------------
+#    it 'should output version information' do
+#      actual = runner { @app.version }
+#
+#      desired = {}
+#      desired[:STDERR] = "Version #{Moose::Inventory::VERSION}"
+#
+#      expected(actual, desired)
+#    end 
+    
+  end
+ end