config_curator 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d51715ab0c44b4986703c025cdcddabbc66e21f2
-  data.tar.gz: a935fba0f244a4fb9bc06033b220228317288f6c
+  metadata.gz: 739cd145342395af3f9bd1629d26006d80d92095
+  data.tar.gz: f34cd95e0a71591d16f01dfef21c3dc7a191bd0d
 SHA512:
-  metadata.gz: e7f3e6fdb5c0842949f058dfd678785154c575035b0aa02fc5eb3355f081f452ea977348550c60cc1353ce2d7aa68e845fa446c146792f1d49312c7fae12720c
-  data.tar.gz: 454d8175fd6ea0186335920a2b1e159a38fef4dc85cdc2bdbb8c16d5a5f22a95993bb8a483017e4745ab66c837e429e1c0c6a29a17fc97095c9e4620ff55fcec
+  metadata.gz: b3fb7a5b09056a397cda636f7975384b023a3012f65f0ca86f3408078faf0634512d0a2b30b37899d41ad23d96384d443c9e10fb904cb8946baac044e0ced7fb
+  data.tar.gz: e2e1ee6b3cf5e4e185fc2ba4e2a9259eeae9f176470539fdf040bf2511d0bd80293d660a9fc2705decc4947350b40707d2daa14ce81a97555447c4da70dae680

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
+cache: bundler
 rvm:
   - 2.0.0
   - 2.1.1
-script: rspec
+script: bundle exec rake travis

data/CHANGELOG.md

@@ -1,5 +1,5 @@
 # Config Curator ChangeLog
 
-## HEAD
+## 0.0.1
 
-- Initial release.
+- Initial development release.

data/Guardfile

@@ -0,0 +1,10 @@
+guard :rspec, cmd: 'bundle exec rspec --color --format Fuubar' do
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/config_curator/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec/.+_spec\.rb$})
+  watch('spec/spec_helper.rb') { 'spec' }
+end
+
+guard :yard do
+  watch(%r{^lib/(.+)\.rb$})
+end

data/README.md

@@ -32,7 +32,7 @@ $ gem install config_curator
 ````
 ## Documentation
 
-The primary documentation for Palimpsest is this README and the YARD source documentation.
+The primary documentation for Config Curator is this README and the YARD source documentation.
 
 YARD documentation for all gem versions is hosted on the
 [Config Curator gem page](https://rubygems.org/gems/config_curator).

data/Rakefile

@@ -5,3 +5,5 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new :spec
 
 task default: :spec
+
+task travis: [:spec]

data/bin/curate

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'config_curator'
+
+ConfigCurator::CLI.start(ARGV)

data/config_curator.gemspec

@@ -20,6 +20,9 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.0.0'
 
+  spec.add_dependency 'activesupport', '~> 4.1.0'
+  spec.add_dependency 'thor', '~> 0.19.1'
+
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake', '~> 10.3.1'
   spec.add_development_dependency 'bump', '~> 0.5.0'

data/lib/config_curator.rb

@@ -1,4 +1,12 @@
 require 'config_curator/version'
+require 'config_curator/package_lookup'
+require 'config_curator/collection'
+require 'config_curator/cli'
+require 'config_curator/unit'
+require 'config_curator/units/config_file'
+require 'config_curator/units/symlink'
+require 'config_curator/units/component'
 
+# Simple and intelligent configuration file management.
 module ConfigCurator
 end

data/lib/config_curator/cli.rb

@@ -0,0 +1,71 @@
+require 'logger'
+require 'thor'
+
+module ConfigCurator
+
+  class CLI < Thor
+
+    class_option :verbose, type: :boolean, aliases: %i(v)
+    class_option :quiet, type: :boolean, aliases: %i(q)
+    class_option :debug, type: :boolean
+
+    # Installs the collection.
+    # @param manifest [String] path to the manifest file to use
+    # @return [Boolean] value of {Collection#install} or {Collection#install?}
+    desc "install", "Installs all units in collection."
+    option :dryrun, type: :boolean, aliases: %i(n),
+      desc: %q{Only simulate the install. Don't make any actual changes.}
+    def install manifest='manifest.yml'
+      unless File.exists? manifest
+        logger.fatal { "Manifest file '#{manifest}' does not exist." }
+        return false
+      end
+
+      collection.load_manifest manifest
+      result = options[:dryrun] ? collection.install? : collection.install
+
+      msg = "Install #{'simulation ' if options[:dryrun]}" + \
+        if result
+          'completed without error.'
+        elsif result.nil?
+          'failed.'
+        else
+          'failed. No changes were made.'
+        end
+
+      if result then logger.info msg else logger.error msg end
+      return result
+    end
+
+    no_commands do
+
+      # Makes a collection object to use for the instance.
+      # @return [Collection] the collection object
+      def collection
+        @collection ||= Collection.new logger: logger
+      end
+
+      # Logger instance to use.
+      # @return [Logger] logger instance
+      def logger
+        @logger ||= Logger.new($stdout).tap do |log|
+          log.progname = 'curate'
+          log.formatter = proc do |severity, _, _, msg|
+            "#{severity} -- #{msg}\n"
+          end
+          log.level = \
+            if options[:debug]
+              Logger::DEBUG
+            elsif options[:verbose]
+              Logger::INFO
+            elsif options[:quiet]
+              Logger::FATAL
+            else
+              Logger::WARN
+            end
+        end
+      end
+    end
+  end
+
+end

data/lib/config_curator/collection.rb

@@ -0,0 +1,137 @@
+require 'active_support/core_ext/string'
+require 'logger'
+require 'yaml'
+
+module ConfigCurator
+
+  class Collection
+
+    # Supported unit types.
+    UNIT_TYPES = %i(unit component config_file symlink)
+
+    # The possible attributes specific to each unit type.
+    # This should not include generic attributes
+    # such as {Unit#source} and {Unit#destination}.
+    UNIT_ATTRIBUTESS = {
+      unit: %i(hosts packages),
+      component: %i(hosts packages fmode dmode owner group),
+      config_file: %i(hosts packages fmode owner group),
+      symlink: %i(hosts packages),
+    }
+
+    attr_accessor :logger, :manifest, :units
+
+    def initialize manifest_path: nil, logger: nil
+      self.logger = logger unless logger.nil?
+      self.load_manifest manifest_path unless manifest_path.nil?
+    end
+
+    # Logger instance to use.
+    # @return [Logger] logger instance
+    def logger
+      @logger ||= Logger.new($stdout).tap do |log|
+        log.progname = self.class.name
+      end
+    end
+
+    # Loads the manifest from file.
+    # @param file [Hash] the yaml file to load
+    # @return [Hash] the loaded manifest
+    def load_manifest file
+      self.manifest = YAML.load_file file
+    end
+
+    # Unit objects defined by the manifest and organized by type.
+    # @return [Hash] keys are pluralized unit types from {UNIT_TYPES}
+    def units
+      @units ||= {}.tap do |u|
+        UNIT_TYPES.each do |type|
+          k = type.to_s.pluralize.to_sym
+          u[k] = []
+
+          if manifest
+            manifest[k].each do |v|
+              u[k] << create_unit(type, attributes: v)
+            end unless manifest[k].nil?
+          end
+        end
+      end
+    end
+
+    # Installs all units from the manifest.
+    # @return [Boolean, nil] if units were installed or nil when fails mid-install
+    def install
+      return false unless install? quiet: !(logger.level == Logger::DEBUG)
+
+      UNIT_TYPES.each do |t|
+        type_name = t.to_s.humanize capitalize: false
+
+        units[t.to_s.pluralize.to_sym].each do |unit|
+          begin
+            if unit.install
+              logger.info { "Installed #{type_name}: #{unit.source} ⇨ #{unit.destination_path}" }
+            end
+          rescue Unit::InstallFailed => e
+            logger.fatal { "Halting install! Install attempt failed for #{type_name}: #{e}" }
+            return nil
+          end
+        end
+      end
+      true
+    end
+
+    # Checks all units in the manifest for any detectable install issues.
+    # @param quiet [Boolean] suppress some {#logger} output
+    # @return [Boolean] if units can be installed
+    def install? quiet: false
+      result = true
+      UNIT_TYPES.each do |t|
+        type_name = t.to_s.humanize capitalize: false
+
+        units[t.to_s.pluralize.to_sym].each do |unit|
+          begin
+            if unit.install?
+              logger.info { "Testing install for #{type_name}: #{unit.source} ⇨ #{unit.destination_path}" }
+            end unless quiet
+          rescue Unit::InstallFailed => e
+            result = false
+            logger.error { "Cannot install #{type_name}: #{e}" }
+          end
+        end
+      end
+      result
+    end
+
+    # Creates a new unit object for the collection.
+    # @param type [Symbol] a unit type in {UNIT_TYPES}
+    # @param attributes [Hash] attributes for the unit from {UNIT_ATTRIBUTESS}
+    # @return [Unit] the unit object of the appropriate subclass
+    def create_unit type, attributes: {}
+      options = {}
+      %i(root).each do |k|
+        options[k] = manifest[k] unless manifest[k].nil?
+      end if manifest
+
+      "#{self.class.name.split('::').first}::#{type.to_s.camelize}".constantize
+      .new(options: options, logger: logger).tap do |unit|
+        {src: :source, dst: :destination}.each do |k, v|
+          unit.send "#{v}=".to_sym, attributes[k] unless attributes[k].nil?
+        end
+
+        UNIT_ATTRIBUTESS[type].each do |v|
+          unit.send "#{v}=".to_sym, defaults[v] unless defaults[v].nil?
+          unit.send "#{v}=".to_sym, attributes[v] unless attributes[v].nil?
+        end
+      end
+    end
+
+    private
+
+    # Hash of any defaults given in the manifest.
+    def defaults
+      return {} unless manifest
+      manifest[:defaults].nil? ? {} : manifest[:defaults]
+    end
+  end
+
+end

data/lib/config_curator/package_lookup.rb

@@ -0,0 +1,77 @@
+require 'mkmf'
+require 'open3'
+
+module ConfigCurator
+
+  class PackageLookup
+
+    # Error when a package lookup cannot be completed.
+    class LookupFailed < RuntimeError; end
+
+    # Default list of supported package tools.
+    TOOLS = %i(dpkg pacman)
+
+    attr_accessor :tool, :tools
+
+    def initialize tool: nil
+      self.tool = tool
+    end
+
+    # Package tools that support package lookup ordered by preference.
+    # @return [Array] list of supported package tools
+    def tools
+      @tools ||= TOOLS
+    end
+
+    # The package tool to use for this instance.
+    # @return [Symbol] tool to use
+    def tool
+      return @tool if @tool
+
+      tools.each do |cmd|
+        if command? cmd
+          return @tool = cmd
+        end
+      end
+      @tool
+    end
+
+    # Checks if package is installed.
+    # @param package [String] package name to check
+    # @return [Boolean] if package is installed
+    def installed? package
+      fail LookupFailed, 'No supported package tool found.' if tool.nil?
+      send tool, package
+    end
+
+    private
+
+    # Checks if command exists.
+    # @param command [String] command name to check
+    # @return [String, nil] full path to command or nil if not found
+    def command? command
+      MakeMakefile::Logging.instance_variable_set :@logfile, File::NULL
+      MakeMakefile::Logging.quiet = true
+      MakeMakefile.find_executable command.to_s
+    end
+
+    #
+    # Tool specific package lookup methods below.
+    #
+
+    def dpkg package
+      cmd = command? 'dpkg'
+      Open3.popen3 cmd, '-s', package do |_, _ , _, wait_thr|
+        wait_thr.value.to_i == 0
+      end
+    end
+
+    def pacman package
+      cmd = command? 'pacman'
+      Open3.popen3 cmd, '-qQ', package do |_, _ , _, wait_thr|
+        wait_thr.value.to_i == 0
+      end
+    end
+  end
+
+end

data/lib/config_curator/unit.rb

@@ -0,0 +1,122 @@
+require 'logger'
+require 'socket'
+
+module ConfigCurator
+
+  class Unit
+
+    # Error if the unit will fail to install.
+    class InstallFailed < RuntimeError; end
+
+    attr_accessor :logger, :source, :destination, :hosts, :packages
+
+    # Default {#options}.
+    DEFAULT_OPTIONS = {
+      # Unit installed relative to this path.
+      root: Dir.home,
+
+      # Package tool to use. See #package_lookup.
+      package_tool: nil,
+    }
+
+    def initialize options: {}, logger: nil
+      self.options options
+      self.logger = logger unless logger.nil?
+    end
+
+    # Uses {DEFAULT_OPTIONS} as initial value.
+    # @param options [Hash] merged with current options
+    # @return [Hash] current options
+    def options options = {}
+      @options ||= DEFAULT_OPTIONS
+      @options = @options.merge options
+    end
+
+    # Logger instance to use.
+    # @return [Logger] logger instance
+    def logger
+      @logger ||= Logger.new($stdout).tap do |log|
+        log.progname = self.class.name
+      end
+    end
+
+    # Full path to source.
+    # @return [String] expanded path to source
+    def source_path
+      File.expand_path source unless source.nil?
+    end
+
+    # Full path to destination.
+    # @return [String] expanded path to destination
+    def destination_path
+      File.expand_path File.join(options[:root], destination) unless destination.nil?
+    end
+
+    # Unit will be installed on these hosts.
+    # If empty, installed on any host.
+    # @return [Array] list of hostnames
+    def hosts
+      @hosts ||= []
+    end
+
+    # Unit installed only if listed packages are installed.
+    # @return [Array] list of package names
+    def packages
+      @packages ||= []
+    end
+
+    # A {PackageLookup} object for this unit.
+    def package_lookup
+      @package_lookup ||= PackageLookup.new tool: options[:package_tool]
+    end
+
+    # Installs the unit.
+    def install
+      return false unless install?
+      true
+    end
+
+    # Checks if the unit should be installed.
+    # @return [Boolean] if the unit should be installed
+    def install?
+      return false unless allowed_host?
+      return false unless packages_installed?
+      true
+    end
+
+    # Checks if the unit should be installed on this host.
+    # @return [Boolean] if the hostname is in {#hosts}
+    def allowed_host?
+      return true if hosts.empty?
+      hosts.include? hostname
+    end
+
+    # Checks if the packages required for this unit are installed.
+    # @return [Boolean] if the packages in {#packages} are installed
+    def packages_installed?
+      packages.map(&method(:pkg_exists?)).delete_if{ |e| e }.empty?
+    end
+
+    private
+
+    # @return [String] the machine hostname
+    def hostname
+      Socket.gethostname
+    end
+
+    # @return [Boolean] if the package exists on the system
+    def pkg_exists? pkg
+      package_lookup.installed? pkg
+    end
+
+    # Checks if command exists.
+    # @param command [String] command name to check
+    # @return [String, nil] full path to command or nil if not found
+    def command? command
+      MakeMakefile::Logging.instance_variable_set :@logfile, File::NULL
+      MakeMakefile::Logging.quiet = true
+      MakeMakefile.find_executable command.to_s
+    end
+  end
+
+end