wright 0.0.1 → 0.1.0

data/lib/wright/util/user.rb

@@ -0,0 +1,75 @@
+require 'etc'
+
+module Wright
+  module Util
+    # Internal: Various user utility functions.
+    module User
+      # Internal: Get a user's uid.
+      #
+      # user - The user name or uid.
+      #
+      # Examples
+      #
+      #   Wright::Util::User.user_to_uid('root')
+      #   # => 0
+      #
+      #   Wright::Util::User.user_to_uid(0)
+      #   # => 0
+      #
+      # Returns the integer uid of the given user or nil if user was
+      # nil.
+      def self.user_to_uid(user)
+        return nil if user.nil?
+        user.is_a?(String) ? Etc.getpwnam(user).uid : user.to_i
+      end
+
+      # Internal: Get a group's gid.
+      #
+      # group - The group name or gid.
+      #
+      # Examples
+      #
+      #   Wright::Util::User.group_to_gid('root')
+      #   # => 0
+      #
+      #   Wright::Util::User.group_to_gid(0)
+      #   # => 0
+      #
+      # Returns the integer gid of the given group or nil if group was
+      # nil.
+      def self.group_to_gid(group)
+        return nil if group.nil?
+        group.is_a?(String) ? Etc.getgrnam(group).gid : group.to_i
+      end
+
+      # Internal: Split a colon-separated owner string into owner and
+      #           group.
+      #
+      # owner - The owner string
+      #
+      # Examples
+      #
+      #   Wright::Util::User.owner_to_owner_group('foo:bar')
+      #   # => ["foo", "bar"]
+      #
+      #   Wright::Util::User.owner_to_owner_group('foo')
+      #   # => ["foo", nil]
+      #
+      #   Wright::Util::User.owner_to_owner_group(23)
+      #   # => [23, nil]
+      #
+      # Returns the owner and group. Returns nil if no group was
+      #   specified. Non-string owners are returned unmodified.
+      # Raises ArgumentError if the owner string contains more than
+      #   one colon.
+      def self.owner_to_owner_group(owner)
+        group = nil
+        return [owner, group] unless owner.is_a?(String)
+
+        fail ArgumentError, "Invalid owner: '#{owner}'" if owner.count(':') > 1
+        owner, group = owner.split(':')
+        [owner, group]
+      end
+    end
+  end
+end

data/lib/wright/util.rb

@@ -0,0 +1,72 @@
+require 'wright/util/stolen_from_activesupport'
+
+module Wright
+  # Internal: Various utility functions.
+  module Util
+    # Internal: Get the resource name corresponding to a class.
+    #
+    # klass - The class constant for which to get the resource name.
+    #
+    # Examples
+    #
+    #   Wright::Util.class_to_resource_name(Wright::Resource::Package)
+    #   # => "package"
+    #
+    #   Wright::Util.class_to_resource_name(Foo::Bar::BazQux)
+    #   # => "baz_qux"
+    #
+    # Returns the String resource name of the given class.
+    def self.class_to_resource_name(klass)
+      ActiveSupport.underscore(klass.name).split('/').last
+    end
+
+    # Internal: Get the class name corresponding to a file path.
+    #
+    # filename - The filename for which to get the class name.
+    #
+    # Examples
+    #
+    #   Wright::Util.filename_to_classname("foo/bar/baz.rb")
+    #   # => "Foo::Bar::Baz"
+    #
+    #   Wright::Util.filename_to_classname("foo/bar/")
+    #   # => "Foo::Bar"
+    #
+    # Returns the String class name for the given filename.
+    def self.filename_to_classname(filename)
+      ActiveSupport.camelize(filename.chomp('.rb').chomp('/'))
+    end
+
+    def self.distro
+      os_release = ::File.read('/etc/os-release')
+      /^ID_LIKE=(?<id_like>.*)$/ =~ os_release
+      /^ID=(?<id>.*)$/ =~ os_release
+      id_like || id || 'linux'
+    end
+    private_class_method :distro
+
+    # Internal: Get the system's OS family.
+    #
+    # Examples
+    #
+    #   Wright::Util.os_family
+    #   # => "debian"
+    #
+    #   Wright::Util.os_family
+    #   # => "macosx"
+    #
+    # Returns the String system OS family (base distribution for
+    # GNU/Linux systems) or 'other' for unknown operating systems.
+    def self.os_family
+      system_arch = RbConfig::CONFIG['target_os']
+      case system_arch
+      when /darwin/
+        'macosx'
+      when /linux/
+        distro
+      else
+        'other'
+      end
+    end
+  end
+end

data/lib/wright/version.rb

@@ -1,3 +1,4 @@
-module Wright
-  VERSION = '0.0.1'
+module Wright # rubocop:disable Documentation
+  # Public: Current wright version
+  VERSION = '0.1.0'
 end

data/lib/wright.rb

@@ -1,4 +1,13 @@
-require 'wright/version'
+require 'wright/config'
+require 'wright/dsl'
+require 'wright/provider'
+require 'wright/resource'
 
+require 'wright/resource/directory'
+require 'wright/resource/file'
+require 'wright/resource/package'
+require 'wright/resource/symlink'
+
+# Public: TODO: Add some documentation
 module Wright
 end

data/spec/config_spec.rb

@@ -0,0 +1,37 @@
+require_relative 'spec_helper'
+
+require 'wright/config'
+
+describe Wright::Config do
+  before(:each) do
+    @config = Wright::Config.config_hash.clone
+    Wright::Config.config_hash.clear
+  end
+
+  after(:each) do
+    Wright::Config.config_hash = @config
+  end
+
+  it 'should behave like a Hash' do
+    Wright::Config.size.must_equal 0
+    Wright::Config[:foo] = :bar
+    Wright::Config[:bar] = :baz
+    Wright::Config[:foo].must_equal :bar
+    Wright::Config[:bar].must_equal :baz
+    Wright::Config.size.must_equal 2
+  end
+
+  it 'should handle nested key checks' do
+    Wright::Config[:foo] = { bar: :baz }
+    Wright::Config.nested_key?(:foo, :bar).must_equal true
+    Wright::Config.nested_key?(:foo, :bar, :qux).must_equal false
+    Wright::Config.nested_key?(:nonexistent).must_equal false
+    Wright::Config.nested_key?(:nonexistent1, :nonexistent2).must_equal false
+  end
+
+  it 'should return values for nested keys' do
+    Wright::Config[:foo] = { bar: :baz }
+    Wright::Config.nested_value(:foo, :bar).must_equal :baz
+    Wright::Config.nested_value(:im, :not, :there).must_be_nil
+  end
+end

data/spec/dsl_spec.rb

@@ -0,0 +1,65 @@
+require_relative 'spec_helper'
+
+require 'wright/dsl'
+
+describe Wright::DSL do
+  before(:each) do
+    # duplicate Wright::DSL for testing
+    dsl = Wright::DSL.dup
+    @recipe = Class.new do
+      extend dsl
+    end
+    @wright_dsl = dsl
+  end
+
+  it 'should register new resources at runtime' do
+    resource_class = Class.new do
+      def self.name
+        'ResourceKlass'
+      end
+      def initialize(_name); end
+    end
+
+    @wright_dsl.register_resource(resource_class)
+
+    resource_name = 'resource_klass'
+    @recipe.must_respond_to(resource_name)
+    resource = @recipe.send(resource_name)
+    resource.must_be_instance_of(resource_class)
+  end
+
+  it 'should execute the default action for a resource' do
+    resource_class = Class.new do
+      def self.name
+        'Hello'
+      end
+
+      def initialize(name)
+        @name = name
+      end
+
+      def run_action
+        puts "Hello #{@name}"
+      end
+    end
+    @wright_dsl.register_resource(resource_class)
+    resource_name = Wright::Util.class_to_resource_name(resource_class)
+    -> { @recipe.send(resource_name, 'world') }.must_output("Hello world\n")
+  end
+
+  it 'should call blocks passed to a resource function' do
+    resource_class = Class.new do
+      def self.name
+        'ResourceKlass'
+      end
+
+      def initialize(_name); end
+    end
+    @wright_dsl.register_resource(resource_class)
+
+    resource_name = Wright::Util.class_to_resource_name(resource_class)
+    block = ->(resource) { throw resource.class }
+
+    -> { @recipe.send(resource_name, nil, &block) }.must_throw resource_class
+  end
+end

data/spec/logger_spec.rb

@@ -0,0 +1,65 @@
+require_relative 'spec_helper'
+
+require 'wright/logger'
+require 'wright/config'
+
+FORMATS = {
+  debug: :none,
+  info:  :none,
+  warn:  :yellow,
+  error: :red,
+  fatal: :red
+}
+
+describe Wright::Logger do
+  before(:each) do
+    @config = Wright::Config.config_hash.clone
+    Wright::Config.config_hash.clear
+    @message = 'Soylent Green is STILL made out of people!'
+  end
+
+  after(:each) do
+    Wright::Config.config_hash = @config
+  end
+
+  it 'should enable colors on TTYs' do
+    Wright::Logger.new
+    Wright::Config[:log][:colorize].must_equal true
+  end
+
+  it 'should disable colors if the log device is not a TTY' do
+    Wright::Logger.new(StringIO.new)
+    Wright::Config[:log][:colorize].must_equal false
+  end
+
+  it 'should not change predefined color preferences' do
+    Wright::Config[:log] = { colorize: false }
+    Wright::Logger.new
+    Wright::Config[:log][:colorize].must_equal false
+  end
+
+  it 'should format log messages according to the config' do
+    [true, false].each do |enable_color|
+      Wright::Config[:log] = { colorize: enable_color }
+
+      FORMATS.each do |severity, color|
+        log_entry = "#{severity.upcase}: #{@message}\n"
+        output = if enable_color && color != :none
+                   Wright::Util::Color.send(color, log_entry)
+                 else
+                   log_entry
+                 end
+
+        lambda do
+          stdout = $stdout.dup
+          def stdout.tty?
+            true
+          end
+          logger = Wright::Logger.new(stdout)
+          logger.formatter = Wright::Logger::Formatter.new
+          logger.send(severity, @message)
+        end.must_output output
+      end
+    end
+  end
+end

data/spec/provider/directory_spec.rb

@@ -0,0 +1,114 @@
+require_relative '../spec_helper'
+
+require 'wright/provider/directory'
+require 'wright/dry_run'
+
+describe Wright::Provider::Directory do
+  before(:each) do
+    @dir_resource = OpenStruct.new(name: '/tmp/foo',
+                                   owner: 23,
+                                   group: 42,
+                                   mode: 0700)
+
+    dir = "'#{@dir_resource.name}'"
+    @create_message = "INFO: create directory: #{dir}\n"
+    @create_message_dry = "INFO: (would) create directory: #{dir}\n"
+    @create_message_debug = "DEBUG: directory already created: #{dir}\n"
+    @remove_message = "INFO: remove directory: #{dir}\n"
+    @remove_message_dry = "INFO: (would) remove directory: #{dir}\n"
+    @remove_message_debug = "DEBUG: directory already removed: #{dir}\n"
+  end
+
+  after(:each) { FakeFS::FileSystem.clear }
+
+  def create_target_dir
+    dir = @dir_resource.name
+    FileUtils.mkdir_p(dir)
+    FileUtils.chmod(@dir_resource.mode, dir)
+    FileUtils.chown(@dir_resource.owner, @dir_resource.group, dir)
+  end
+
+  describe '#updated?' do
+    it 'should return the update status if a directory was created' do
+      dir = Wright::Provider::Directory.new(@dir_resource)
+      lambda do
+        reset_logger
+        FakeFS { dir.create }
+      end.must_output @create_message
+      assert dir.updated?
+    end
+
+    it 'should return the update status if a directory was not created' do
+      dir = Wright::Provider::Directory.new(@dir_resource)
+      lambda do
+        reset_logger
+        FakeFS do
+          create_target_dir
+          dir.create
+        end
+        assert !dir.updated?
+      end.must_output @create_message_debug
+    end
+
+    it 'should return the update status if a directory was changed' do
+      dir = Wright::Provider::Directory.new(@dir_resource)
+      lambda do
+        reset_logger
+        FakeFS do
+          create_target_dir
+          FileUtils.chown(0, 0, @dir_resource.name)
+          dir.create
+        end
+      end.must_output @create_message
+      assert dir.updated?
+    end
+
+    it 'should return the update status if a directory was removed' do
+      dir = Wright::Provider::Directory.new(@dir_resource)
+      lambda do
+        reset_logger
+        FakeFS do
+          create_target_dir
+          dir.remove
+        end
+        assert dir.updated?
+      end.must_output @remove_message
+    end
+
+    it 'should return the update status if a directory was not removed' do
+      dir = Wright::Provider::Directory.new(@dir_resource)
+      lambda do
+        reset_logger
+        FakeFS { dir.remove }
+        assert !dir.updated?
+      end.must_output @remove_message_debug
+    end
+  end
+
+  describe 'dry_run' do
+    it 'should not actually create directories' do
+      dir = Wright::Provider::Directory.new(@dir_resource)
+      Wright.dry_run do
+        lambda do
+          reset_logger
+          FakeFS { dir.create }
+        end.must_output @create_message_dry
+        FakeFS { assert !File.directory?(@dir_resource.name) }
+      end
+    end
+
+    it 'should not actually remove directories' do
+      dir = Wright::Provider::Directory.new(@dir_resource)
+      Wright.dry_run do
+        lambda do
+          reset_logger
+          FakeFS do
+            create_target_dir
+            dir.remove
+          end
+        end.must_output @remove_message_dry
+      end
+      FakeFS { assert File.directory?(@dir_resource.name) }
+    end
+  end
+end

data/spec/provider/file_spec.rb

@@ -0,0 +1,130 @@
+require_relative '../spec_helper'
+
+require 'wright/provider/file'
+require 'wright/dry_run'
+
+describe Wright::Provider::File do
+  before(:each) do
+    @file_resource = OpenStruct.new(name: 'foo',
+                                    owner: 23,
+                                    group: 42,
+                                    mode: 0600,
+                                    content: 'Hello world')
+
+    file = "'#{@file_resource.name}'"
+    @create_message = "INFO: create file: #{file}\n"
+    @create_message_dry = "INFO: (would) create file: #{file}\n"
+    @create_message_debug = "DEBUG: file already created: #{file}\n"
+    @remove_message = "INFO: remove file: #{file}\n"
+    @remove_message_dry = "INFO: (would) remove file: #{file}\n"
+    @remove_message_debug = "DEBUG: file already removed: #{file}\n"
+
+    FakeFS { FileUtils.mkdir_p Dir.tmpdir }
+  end
+
+  after(:each) { FakeFS::FileSystem.clear }
+
+  def create_target_file
+    file = @file_resource.name
+    File.write(file, @file_resource.content)
+    FileUtils.chmod(@file_resource.mode, file)
+    FileUtils.chown(@file_resource.owner, @file_resource.group, file)
+  end
+
+  describe '#updated?' do
+    it 'should return the update status if a file was created' do
+      file = Wright::Provider::File.new(@file_resource)
+      lambda do
+        reset_logger
+        FakeFS { file.create }
+      end.must_output @create_message
+      assert file.updated?
+    end
+
+    it 'should return the update status if a file was not created' do
+      file = Wright::Provider::File.new(@file_resource)
+      lambda do
+        reset_logger
+        FakeFS do
+          create_target_file
+          file.create
+        end
+        assert !file.updated?
+      end.must_output @create_message_debug
+    end
+
+    it 'should return the update status if permissions were changed' do
+      file = Wright::Provider::File.new(@file_resource)
+      lambda do
+        reset_logger
+        FakeFS do
+          create_target_file
+          File.chmod(0111, @file_resource.name)
+          file.create
+        end
+        assert file.updated?
+      end.must_output @create_message
+    end
+
+    it 'should return the update status if a file was changed' do
+      file = Wright::Provider::File.new(@file_resource)
+      lambda do
+        reset_logger
+        FakeFS do
+          create_target_file
+          File.write(@file_resource.name, 'wrong content')
+          file.create
+        end
+      end.must_output @create_message
+      assert file.updated?
+    end
+
+    it 'should return the update status if a file was removed' do
+      file = Wright::Provider::File.new(@file_resource)
+      lambda do
+        reset_logger
+        FakeFS do
+          create_target_file
+          file.remove
+        end
+        assert file.updated?
+      end.must_output @remove_message
+    end
+
+    it 'should return the update status if a file was not removed' do
+      file = Wright::Provider::File.new(@file_resource)
+      lambda do
+        reset_logger
+        FakeFS { file.remove }
+        assert !file.updated?
+      end.must_output @remove_message_debug
+    end
+  end
+
+  describe 'dry_run' do
+    it 'should not actually create files' do
+      file = Wright::Provider::File.new(@file_resource)
+      Wright.dry_run do
+        lambda do
+          reset_logger
+          FakeFS { file.create }
+        end.must_output @create_message_dry
+        FakeFS { assert !File.exist?(@file_resource.name) }
+      end
+    end
+
+    it 'should not actually remove files' do
+      file = Wright::Provider::File.new(@file_resource)
+      Wright.dry_run do
+        lambda do
+          reset_logger
+          FakeFS do
+            create_target_file
+            file.remove
+          end
+        end.must_output @remove_message_dry
+      end
+      FakeFS { assert File.exist?(@file_resource.name) }
+    end
+  end
+end

data/spec/provider/package/apt/apt-get_install_-qy_abcde=2.5.4-1.return

@@ -0,0 +1 @@
+0

data/spec/provider/package/apt/apt-get_install_-qy_abcde=2.5.4-1.stdout

@@ -0,0 +1,15 @@
+Reading package lists...
+Building dependency tree...
+Reading state information...
+Suggested packages:
+  distmp3 id3 id3v2 normalize-audio vorbisgain mkcue mp3gain atomicparsley
+The following NEW packages will be installed:
+  abcde
+0 upgraded, 1 newly installed, 0 to remove and 0 not upgraded.
+Need to get 0 B/122 kB of archives.
+After this operation, 289 kB of additional disk space will be used.
+Selecting previously unselected package abcde.
+(Reading database ... 
+Unpacking abcde (from .../archives/abcde_2.5.4-1_all.deb) ...
+Processing triggers for man-db ...
+Setting up abcde (2.5.4-1) ...

data/spec/provider/package/apt/apt-get_install_-qy_htop.return

@@ -0,0 +1 @@
+0

data/spec/provider/package/apt/apt-get_install_-qy_htop.stdout

@@ -0,0 +1,19 @@
+Reading package lists...
+Building dependency tree...
+Reading state information...
+Suggested packages:
+  ltrace
+The following NEW packages will be installed:
+  htop
+0 upgraded, 1 newly installed, 0 to remove and 0 not upgraded.
+Need to get 0 B/74.9 kB of archives.
+After this operation, 216 kB of additional disk space will be used.
+Selecting previously unselected package htop.
+(Reading database ... 
+Unpacking htop (from .../htop_1.0.1-1_amd64.deb) ...
+Processing triggers for menu ...
+Processing triggers for man-db ...
+Processing triggers for desktop-file-utils ...
+Processing triggers for gnome-menus ...
+Setting up htop (1.0.1-1) ...
+Processing triggers for menu ...

data/spec/provider/package/apt/apt-get_install_-qy_unknown-package.return

@@ -0,0 +1 @@
+100

data/spec/provider/package/apt/apt-get_install_-qy_unknown-package.stderr

@@ -0,0 +1 @@
+E: Unable to locate package unknown-package

data/spec/provider/package/apt/apt-get_install_-qy_unknown-package.stdout

@@ -0,0 +1,3 @@
+Reading package lists...
+Building dependency tree...
+Reading state information...

data/spec/provider/package/apt/apt-get_remove_-qy_abcde.return

@@ -0,0 +1 @@
+0

data/spec/provider/package/apt/apt-get_remove_-qy_abcde.stdout

@@ -0,0 +1,14 @@
+Reading package lists...
+Building dependency tree...
+Reading state information...
+The following packages were automatically installed and are no longer required:
+  cd-discid cdparanoia libmusicbrainz-discid-perl
+  libwebservice-musicbrainz-perl vorbis-tools
+Use 'apt-get autoremove' to remove them.
+The following packages will be REMOVED:
+  abcde
+0 upgraded, 0 newly installed, 1 to remove and 0 not upgraded.
+After this operation, 289 kB disk space will be freed.
+(Reading database ... 
+Removing abcde ...
+Processing triggers for man-db ...

data/spec/provider/package/apt/dpkg-query_-s_abcde.return

@@ -0,0 +1 @@
+0