wright 0.0.1 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4644d39c9505dda9fce4adb9a0a5bd5a5e0dfe0a
+  data.tar.gz: 33c6ed57fc54bff76b3cfd9c91f2969f8b978d1e
+SHA512:
+  metadata.gz: 350373a47cdcd38005c8deb56ab835130c2a946aaf69751344318765797e388f4785d8be34b79fbfccdb85d3cae878312f531d30912b1d6d022f86c77fe5c284
+  data.tar.gz: 63e0cff72088b5d73174c3dd75f26dbb7ad48b97bede920c2625b7c63746a8873c01c46da1c25a9bfa9363494ee255a4b4e8ba3926989855efe01bb7be438932

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Sebastian Boehm
+Copyright (c) 2012, 2013, 2014, 2015 Sebastian Boehm
 
 MIT License
 
@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/NEWS

@@ -0,0 +1,8 @@
+* wright NEWS
+** 0.1.0 (2015-01-16)
+
+ - First public release
+
+# Local Variables:
+# mode: org
+# End:

data/README.md

@@ -0,0 +1,70 @@
+wright
+======
+
+Lightweight configuration management.
+
+Requirements
+------------
+
+ - Ruby ≥1.9
+
+Documentation
+-------------
+
+There is not too much useful documentation that is targeted towards
+users at the moment.
+
+Run `bundle exec rake rdoc` to generate HTML docs for wright
+developers.
+
+Hacking
+-------
+
+To get started with wright, simply install the development
+dependencies via bundler:
+
+ - `bundle install --path .bundle`
+ - `bundle exec rake test`
+
+All tests should pass.
+
+Getting Started
+---------------
+
+To start a wright IRB session, simply run:
+
+    $ bundle console
+
+In order to create some resources using the wright DSL:
+
+    extend Wright::DSL
+    
+    foo_dir = directory '/tmp/foo'
+    fstab = symlink '/tmp/foo/fstab' do |s|
+      s.to = '/etc/fstab'
+    end
+    
+    puts File.directory? '/tmp/foo'
+    puts File.symlink? '/tmp/foo/fstab'
+    
+    fstab.remove
+    foo_dir.remove
+
+If you don't want to use the DSL:
+
+    foo_dir = Wright::Resource::Directory.new('/tmp/foo')
+    foo_dir.create
+    fstab = Wright::Resource::Symlink.new('/tmp/foo/fstab')
+    fstab.to = '/etc/fstab'
+    fstab.create
+   
+    puts File.directory? '/tmp/foo'
+    puts File.symlink? '/tmp/foo/fstab'
+    
+    fstab.remove
+    foo_dir.remove
+
+Copyright
+---------
+
+Copyright (c) 2012-2015 Sebastian Boehm. See LICENSE for details.

data/Rakefile

@@ -1,2 +1,21 @@
 #!/usr/bin/env rake
 require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rdoc/task'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+RDoc::Task.new(clobber_rdoc: 'rdoc:clobber',
+               rerdoc: 'rdoc:force') do |t|
+  t.rdoc_files.include('lib/**/*.rb')
+  t.options << '--markup=tomdoc'
+end
+
+namespace :rdoc do
+  desc 'Show RDoc coverage report'
+  task :coverage do
+    exec 'rdoc --markup=tomdoc --coverage-report lib/'
+  end
+end

data/lib/wright/config.rb

@@ -0,0 +1,64 @@
+require 'forwardable'
+
+module Wright
+  # Public: Configuration container, wraps a regular Ruby hash.
+  #
+  # Useful for getting and setting configuration values, such as
+  # logging verbosity, colour output and provider configuration.
+  #
+  # Examples
+  #
+  #   Wright::Config[:foo] = { bar: :baz }
+  #   Wright::Config[:foo][:bar]
+  #   # => :baz
+  class Config
+    @config_hash = {}
+    class << self
+      extend Forwardable
+      def_delegators :@config_hash, :[], :[]=, :size
+    end
+    private_class_method :new
+
+    # Public: Check if a (nested) configuration value is set.
+    #
+    # path - The configuration item as an argument list.
+    #
+    # Examples
+    #
+    #   Wright::Config[:foo] = { bar: :baz }
+    #   Wright::Config.nested_key?(:foo, :bar)
+    #   # => true
+    #
+    #   Wright::Config.nested_key?(:this, :doesnt, :exist)
+    #   # => false
+    #
+    # Returns true if the configuration value is set and false
+    #   otherwise.
+    def self.nested_key?(*path)
+      last_key = path.pop
+      last_hash = path.reduce(@config_hash) do |hash, key|
+        return false unless hash.respond_to?(:fetch)
+        hash.fetch(key, {})
+      end
+      last_hash.respond_to?(:key?) && last_hash.key?(last_key)
+    end
+
+    # Public: Retrieve a (nested) configuration value.
+    #
+    # path - The configuration item as an argument list.
+    #
+    # Examples
+    #
+    #   Wright::Config[:foo] = { bar: :baz }
+    #   Wright::Config.nested_value(:foo, :bar)
+    #   # => :baz
+    #
+    #   Wright::Config.nested_value(:this, :doesnt, :exist)
+    #   # => nil
+    #
+    # Returns the configuration value or nil if the value is not set.
+    def self.nested_value(*path)
+      nested_key?(*path) ? path.reduce(@config_hash) { |a, e| a[e] } : nil
+    end
+  end
+end

data/lib/wright/dry_run.rb

@@ -0,0 +1,33 @@
+module Wright # rubocop:disable Documentation
+  @dry_run = false
+
+  # Public: Checks if dry-run mode is currently active.
+  #
+  # Examples
+  #
+  #   puts 'Just a dry-run...' if Wright.dry_run?
+  #
+  # Returns true if dry-run mode is currently active and false otherwise.
+  def self.dry_run?
+    @dry_run
+  end
+
+  # Public: Runs a block in dry-run mode.
+  #
+  # Examples
+  #
+  #   Wright.dry_run do
+  #     symlink '/tmp/fstab' do |s|
+  #       s.to = '/etc/fstab'
+  #     end
+  #   end
+  #
+  # Returns the block's return value.
+  def self.dry_run
+    saved_dry_run = @dry_run
+    @dry_run = true
+    yield
+  ensure
+    @dry_run = saved_dry_run
+  end
+end

data/lib/wright/dsl.rb

@@ -0,0 +1,63 @@
+require 'wright/util'
+
+module Wright
+  # Public: Includable Wright script DSL.
+  #
+  # Contains resource methods for all registered resources.
+  #
+  # Examples
+  #
+  #   # define a new resource at runtime
+  #   class KitchenSink < Wright::Resource; end
+  #
+  #   # register the resource
+  #   Wright::DSL.register_resource KitchenSink
+  #
+  #   extend Wright::DSL
+  #
+  #   kitchen_sink "I don't do anything"
+  #
+  #   # resource methods accept blocks
+  #   kitchen_sink 'I am sooo useful' do |k|
+  #     puts k.name
+  #   end
+  #   # output: I am sooo useful
+  #
+  #   # save resource for later use
+  #   a_sink_to_remember = kitchen_sink 'Me too, me too!'
+  #   a_sink_to_remember.class
+  #   # => KitchenSink
+  module DSL
+    # Public: Register a class as a resource.
+    #
+    # Creates a resource method in the DSL module. Uses the
+    # snake-cased class name as method name.
+    #
+    # resource_class - The resource class. Usually a subclass of
+    #                  Wright::Resource. Will be initialized with the
+    #                  resource's name as an argument.
+    #
+    # Returns nothing.
+    def self.register_resource(resource_class)
+      method_name = Util.class_to_resource_name(resource_class)
+      this_module = self
+      define_method(method_name) do |name = nil, &block|
+        this_module.yield_resource(resource_class, name, &block)
+      end
+    end
+
+    # Internal: Instantiate a resource_class object and perform its
+    # default action.
+    #
+    # Implicitly invoking a block from within another block does not
+    # work: http://blog.sidu.in/2007/11/ruby-blocks-gotchas.html
+    #
+    # Returns nothing.
+    def self.yield_resource(resource_class, name)
+      r = resource_class.new(name)
+      yield(r) if block_given?
+      r.run_action if r.respond_to?(:run_action)
+      r
+    end
+  end
+end

data/lib/wright/logger.rb

@@ -0,0 +1,73 @@
+require 'logger'
+
+require 'wright/config'
+require 'wright/util/color'
+
+module Wright # rubocop:disable Documentation
+  # Public: Default logger for Wright.
+  class Logger < ::Logger
+    # Public: Default formatter for Wright log messages.
+    class Formatter < ::Logger::Formatter
+      # Internal: Called by Wright::Logger to format log messages.
+      #
+      # severity - The String log severity.
+      # time     - The time for the log entry. Ignored.
+      # progname - The program name for the log entry. Ignored.
+      # message  - The actual log message.
+      #
+      # Returns the formatted String log entry.
+      def call(severity, _time, _progname, message)
+        log_entry = "#{severity}: #{message}\n"
+        if Wright::Config[:log][:colorize]
+          colorize(log_entry, severity)
+        else
+          log_entry
+        end
+      end
+
+      private
+
+      # Internal: ANSI-Colorize a log message according to its
+      # severity.
+      #
+      # string   - The String log message to be colorized.
+      # severity - The String severity of the log message.
+      #
+      # Returns the colorized String.
+      def colorize(string, severity)
+        case severity
+        when 'ERROR', 'FATAL'
+          Wright::Util::Color.red(string)
+        when 'WARN'
+          Wright::Util::Color.yellow(string)
+        when 'INFO'
+          string
+        else
+          string
+        end
+      end
+    end
+
+    # Public: Initialize a Logger.
+    #
+    # Enables log colorization if the log device is a TTY and
+    # colorization was not disabled before initialization.
+    #
+    # logdev - The log device used by the Logger.
+    def initialize(logdev = $stdout)
+      super
+      Wright::Config[:log] ||= {}
+      return unless Wright::Config[:log][:colorize].nil?
+
+      Wright::Config[:log][:colorize] = logdev.tty?
+    end
+  end
+
+  class << self
+    # Public: Get/Set Wright's Logger.
+    attr_accessor :log
+  end
+  @log = Wright::Logger.new
+  @log.formatter = Wright::Logger::Formatter.new
+  @log.level = Wright::Logger::INFO
+end

data/lib/wright/provider/directory.rb

@@ -0,0 +1,78 @@
+require 'fileutils'
+require 'wright/provider'
+require 'wright/util/file'
+require 'wright/util/user'
+require 'wright/util/file_permissions'
+
+module Wright
+  class Provider
+    # Public: Directory provider. Used as a Provider for Resource::Directory.
+    class Directory < Wright::Provider
+      # Public: Create or update the directory.
+      #
+      # Returns nothing.
+      def create
+        if ::File.directory?(dirname) && permissions.uptodate?
+          Wright.log.debug "directory already created: '#{@resource.name}'"
+          return
+        end
+
+        fail Errno::EEXIST, dirname if regular_file?
+        create_directory
+        @updated = true
+      end
+
+      # Public: Remove the directory.
+      #
+      # Returns nothing.
+      def remove
+        if ::File.exist?(dirname) && !::File.directory?(dirname)
+          fail "'#{dirname}' exists but is not a directory"
+        end
+
+        if ::File.directory?(dirname)
+          remove_directory
+          @updated = true
+        else
+          Wright.log.debug "directory already removed: '#{@resource.name}'"
+        end
+      end
+
+      private
+
+      def permissions
+        Wright::Util::FilePermissions.create_from_resource(@resource,
+                                                           :directory)
+      end
+
+      def create_directory
+        dir_permissions = permissions
+
+        if Wright.dry_run?
+          Wright.log.info "(would) create directory: '#{@resource.name}'"
+        else
+          Wright.log.info "create directory: '#{@resource.name}'"
+          FileUtils.mkdir_p(dirname)
+          dir_permissions.update
+        end
+      end
+
+      def remove_directory
+        if Wright.dry_run?
+          Wright.log.info "(would) remove directory: '#{@resource.name}'"
+        else
+          Wright.log.info "remove directory: '#{@resource.name}'"
+          FileUtils.rmdir(dirname)
+        end
+      end
+
+      def regular_file?
+        ::File.exist?(dirname) && !::File.directory?(dirname)
+      end
+
+      def dirname
+        ::File.expand_path(@resource.name)
+      end
+    end
+  end
+end

data/lib/wright/provider/file.rb

@@ -0,0 +1,104 @@
+require 'wright/provider'
+require 'wright/util/file_permissions'
+require 'wright/util/user'
+require 'fileutils'
+require 'digest'
+require 'tempfile'
+require 'tmpdir'
+
+module Wright
+  class Provider
+    # Public: File provider. Used as a Provider for Resource::File.
+    class File < Wright::Provider
+      # Public: Create or update the File.
+      #
+      # Returns nothing.
+      def create
+        fail Errno::EISDIR, filename if ::File.directory?(filename)
+
+        if uptodate?
+          Wright.log.debug "file already created: '#{@resource.name}'"
+          return
+        end
+
+        create_file
+        @updated = true
+      end
+
+      # Public: Remove the File.
+      #
+      # Returns nothing.
+      def remove
+        fail Errno::EISDIR, filename if ::File.directory?(filename)
+
+        if ::File.exist?(filename) || ::File.symlink?(filename)
+          remove_file
+          @updated = true
+        else
+          Wright.log.debug "file already removed: '#{@resource.name}'"
+        end
+      end
+
+      private
+
+      def create_file
+        file_permissions = permissions
+
+        if Wright.dry_run?
+          Wright.log.info "(would) create file: '#{@resource.name}'"
+        else
+          Wright.log.info "create file: '#{@resource.name}'"
+          write_content_to_file
+          file_permissions.update
+        end
+      end
+
+      def write_content_to_file
+        tempfile = Tempfile.new(::File.basename(filename))
+        tempfile.write(@resource.content) if @resource.content
+        move_tempfile(tempfile)
+      ensure
+        tempfile.close!
+      end
+
+      def move_tempfile(tempfile)
+        # do not overwrite existing files if content was not specified
+        return if @resource.content.nil? && ::File.exist?(filename)
+        FileUtils.mv(tempfile.path, filename)
+      end
+
+      def remove_file
+        if Wright.dry_run?
+          Wright.log.info "(would) remove file: '#{@resource.name}'"
+        else
+          Wright.log.info "remove file: '#{@resource.name}'"
+          FileUtils.rm(filename)
+        end
+      end
+
+      def permissions
+        Wright::Util::FilePermissions.create_from_resource(@resource, :file)
+      end
+
+      def checksum(content)
+        Digest::SHA256.hexdigest(content)
+      end
+
+      def content_uptodate?
+        return false unless ::File.exist?(filename)
+        content = @resource.content || ''
+        target_checksum = checksum(content)
+        current_checksum = checksum(::File.read(filename))
+        current_checksum == target_checksum
+      end
+
+      def uptodate?
+        content_uptodate? && permissions.uptodate?
+      end
+
+      def filename
+        ::File.expand_path(@resource.name)
+      end
+    end
+  end
+end

data/lib/wright/provider/package/apt.rb

@@ -0,0 +1,93 @@
+require 'open3'
+
+require 'wright/dry_run'
+require 'wright/provider'
+require 'wright/provider/package'
+
+module Wright
+  class Provider
+    class Package
+      # Public: AptPackage provider. Used as a Provider for
+      # Resource::Package on Debian-based systems.
+      class Apt < Wright::Provider::Package
+        # Public: Get the installed package version.
+        #
+        # Returns an array of installed package version Strings.
+        def installed_versions
+          cmd = "dpkg-query -s #{@resource.name}"
+          cmd_stdout, _cmd_stderr, cmd_status = Open3.capture3(env, cmd)
+          installed_re = /^Status: install ok installed$/
+
+          if cmd_status.success? && installed_re =~ cmd_stdout
+            /^Version: (?<version>.*)$/ =~ cmd_stdout
+            [version]
+          else
+            []
+          end
+        end
+
+        # Public: Install the package.
+        #
+        # Returns nothing.
+        def install
+          if uptodate?(:install)
+            Wright.log.debug "package already installed: '#{@resource.name}'"
+            return
+          end
+
+          install_package
+          @updated = true
+        end
+
+        # Public: Remove the package.
+        #
+        # Returns nothing.
+        def remove
+          if uptodate?(:remove)
+            Wright.log.debug "package already removed: '#{@resource.name}'"
+            return
+          end
+
+          remove_package
+          @updated = true
+        end
+
+        private
+
+        def install_package
+          package = @resource.name
+          if Wright.dry_run?
+            Wright.log.info "(would) install package: '#{package}'"
+          else
+            Wright.log.info "install package: '#{package}'"
+            apt_get(:install, package, @resource.version)
+          end
+        end
+
+        def remove_package
+          package = @resource.name
+          if Wright.dry_run?
+            Wright.log.info "(would) remove package: '#{package}'"
+          else
+            Wright.log.info "remove package: '#{package}'"
+            apt_get(:remove, package)
+          end
+        end
+
+        def apt_get(action, package, version = nil)
+          package_version = version.nil? ? '' : "=#{version}"
+          apt_cmd = "apt-get #{action} -qy #{package}#{package_version}"
+          _cmd_stdout, cmd_stderr, cmd_status = Open3.capture3(env, apt_cmd)
+          return if cmd_status.success?
+
+          apt_error = cmd_stderr.chomp
+          fail %(cannot #{action} package '#{package}': "#{apt_error}")
+        end
+
+        def env
+          { 'DEBIAN_FRONTEND' => 'noninteractive' }
+        end
+      end
+    end
+  end
+end

data/lib/wright/provider/package.rb

@@ -0,0 +1,38 @@
+require 'wright/provider'
+
+module Wright
+  class Provider
+    # Public: Package provider. Used as a Provider base class for
+    # Resource::Package.
+    class Package < Wright::Provider
+      private
+
+      # Public: Check if the package is up-to-date for a given
+      # action.
+      #
+      # action - The action symbol. Currently supports :install and
+      #          :remove.
+      #
+      # Returns true if the package is up-to-date and false otherwise.
+      # Raises ArgumentError if the action is invalid.
+      def uptodate?(action)
+        case action
+        when :install
+          package_installed?
+        when :remove
+          !package_installed?
+        else
+          fail ArgumentError, "invalid action '#{action}'"
+        end
+      end
+
+      def package_installed?
+        if @resource.version
+          installed_versions.include?(@resource.version)
+        else
+          !installed_versions.empty?
+        end
+      end
+    end
+  end
+end