wright 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d159205080df87b4a9c8935b0486335c74ef84e
-  data.tar.gz: 35cdf663151ab32900d9be2566574cfc0648f980
+  metadata.gz: e035155341d50577a99a8dedbc1a74c071ac65a7
+  data.tar.gz: fcef2683e975dcee23bf413fbc5ee66b5f4d264e
 SHA512:
-  metadata.gz: 0dd9b03ffecb5ca5bd6bbe272f672fcd8546fdeebc7df4ac307f94148ca10312734ab99afd78720ba1d56e458e6c277424b6479decadbd0181b528fa05451316
-  data.tar.gz: 61b6d41688576e1736bf63d9e75eb4fd25c3a5de1d480f7a546df90f8802b4e91387556b38cbcb1393a2a7094b5f72117a65ddf336a8022bb416008880009475
+  metadata.gz: 2cf56d882eb3350b70fe16dad983dfc9b25d89ca2c403a50874e8b39d71be4fd39e9e63f28134f3afeda334442c4f4148f7f6a10ff3515932c2bd26d0cc96acc
+  data.tar.gz: 54ebbd48c70c41b5699e527e4e3e1d599bb0247befe191ff1b19a7b6cf9799cad6fb659198919e5f5456c31708cc79e120038db823c78c8bc2b522c0342cef81

data/NEWS.md

@@ -1,4 +1,12 @@
 # wright NEWS
+## 0.3.0 (2015-04-23)
+- Add bin/wright
+- Add wright(1) manpage
+- Add OS X user provider
+- Improve performance of the apt provider
+- Improve error message for resources without names (#5)
+- Improve error message for symlinks without target (#6)
+
 ## 0.2.0 (2015-03-13)
 - Add Homebrew package provider for OS X
 - Add group resource

data/README.md

@@ -5,10 +5,12 @@ wright
 [![Build Status](https://img.shields.io/travis/sometimesfood/wright.svg?style=flat-square)][travis]
 [![Code Climate](https://img.shields.io/codeclimate/github/sometimesfood/wright.svg?style=flat-square)][codeclimate]
 [![Test Coverage](https://img.shields.io/codeclimate/coverage/github/sometimesfood/wright.svg?style=flat-square)][codeclimate]
+[![Gem Dependencies](https://img.shields.io/gemnasium/sometimesfood/wright.svg?style=flat-square)][gemnasium]
 
 [gem]: https://rubygems.org/gems/wright
 [travis]: https://travis-ci.org/sometimesfood/wright
 [codeclimate]: https://codeclimate.com/github/sometimesfood/wright
+[gemnasium]: https://gemnasium.com/sometimesfood/wright
 
 Lightweight configuration management.
 

data/Rakefile

@@ -5,3 +5,9 @@ require 'rake/testtask'
 Rake::TestTask.new do |t|
   t.pattern = 'spec/**/*_spec.rb'
 end
+
+file 'man/wright.1' => 'man/wright.1.txt' do
+  sh 'a2x --format manpage man/wright.1.txt'
+end
+
+task build: 'man/wright.1'

data/bin/wright

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require 'wright/cli'
+
+main = self
+wright = Wright::CLI.new(main)
+wright.run(ARGV)

data/lib/wright/cli.rb

@@ -0,0 +1,68 @@
+require 'optparse'
+require 'wright'
+
+module Wright
+  # Wright command-line interface.
+  class CLI
+    def initialize(main)
+      @commands = []
+      @main = main
+      @parser = option_parser
+    end
+
+    # Runs a wright script with the supplied arguments.
+    #
+    # @param argv [Array<String>] the arguments passed to bin/wright
+    def run(argv)
+      arguments = parse(argv)
+      return if @quit
+
+      Wright.log.level = @log_level if @log_level
+      @main.extend Wright::DSL
+
+      run_script(arguments)
+    end
+
+    private
+
+    attr_reader :commands
+    attr_reader :log_level
+
+    def parse(argv)
+      # use OptionParser#order! instead of #parse! so CLI#run does not
+      # consume --arguments passed to wright scripts
+      @parser.order!(argv)
+    end
+
+    def run_script(arguments)
+      if @commands.empty? && arguments.any?
+        script = arguments.shift
+        load script
+      else
+        commands = @commands.empty? ? $stdin.read : @commands.join("\n")
+        @main.instance_eval(commands, '<main>', 1)
+      end
+    end
+
+    def option_parser
+      OptionParser.new do |opts|
+        opts.on('-e COMMAND', 'Run COMMAND') do |e|
+          @commands << e
+        end
+
+        opts.on('-v', '--verbose', 'Increase verbosity') do
+          @log_level = Wright::Logger::DEBUG
+        end
+
+        opts.on('-q', '--quiet', 'Decrease verbosity') do
+          @log_level = Wright::Logger::ERROR
+        end
+
+        opts.on_tail('--version', 'Show wright version') do
+          puts "wright version #{Wright::VERSION}"
+          @quit = true
+        end
+      end
+    end
+  end
+end

data/lib/wright/dsl.rb

@@ -41,7 +41,7 @@ module Wright
     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|
+      define_method(method_name) do |name, &block|
         this_module.yield_resource(resource_class, name, &block)
       end
     end

data/lib/wright/provider/directory.rb

@@ -12,14 +12,12 @@ module Wright
       #
       # @return [void]
       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
+
+        dir = @resource.name
+        unless_uptodate(:create, "directory already created: '#{dir}'") do
+          create_directory
+        end
       end
 
       # Removes the directory.
@@ -30,16 +28,23 @@ module Wright
           fail "'#{dirname}' exists but is not a directory"
         end
 
-        if ::File.directory?(dirname)
+        dir = @resource.name
+        unless_uptodate(:remove, "directory already removed: '#{dir}'") do
           remove_directory
-          @updated = true
-        else
-          Wright.log.debug "directory already removed: '#{@resource.name}'"
         end
       end
 
       private
 
+      def uptodate?(action)
+        case action
+        when :create
+          ::File.directory?(dirname) && permissions.uptodate?
+        when :remove
+          !::File.exist?(dirname) && !::File.directory?(dirname)
+        end
+      end
+
       def permissions
         Wright::Util::FilePermissions.create_from_resource(@resource,
                                                            :directory)
@@ -49,7 +54,7 @@ module Wright
         dir_permissions = permissions
         unless_dry_run("create directory: '#{@resource.name}'") do
           FileUtils.mkdir_p(dirname)
-          dir_permissions.update
+          dir_permissions.update unless dir_permissions.uptodate?
         end
       end
 

data/lib/wright/provider/file.rb

@@ -2,6 +2,7 @@ require 'fileutils'
 require 'digest'
 require 'tempfile'
 require 'tmpdir'
+
 require 'wright/provider'
 require 'wright/util/file_permissions'
 require 'wright/util/user'
@@ -13,29 +14,26 @@ module Wright
       # Creates or updates the file.
       #
       # @return [void]
+      # @raise [Errno::EISDIR] if there is already a directory with
+      #   the specified name
       def create
-        fail Errno::EISDIR, filename if ::File.directory?(filename)
-
-        if uptodate?
-          Wright.log.debug "file already created: '#{@resource.name}'"
-          return
+        fail_if_directory
+        file = @resource.name
+        unless_uptodate(:create, "file already created: '#{file}'") do
+          create_file
         end
-
-        create_file
-        @updated = true
       end
 
       # Removes the file.
       #
       # @return [void]
+      # @raise [Errno::EISDIR] if there is a directory with the
+      #   specified name
       def remove
-        fail Errno::EISDIR, filename if ::File.directory?(filename)
-
-        if ::File.exist?(filename) || ::File.symlink?(filename)
+        fail_if_directory
+        file = @resource.name
+        unless_uptodate(:remove, "file already removed: '#{file}'") do
           remove_file
-          @updated = true
-        else
-          Wright.log.debug "file already removed: '#{@resource.name}'"
         end
       end
 
@@ -45,7 +43,7 @@ module Wright
         file_permissions = permissions
         unless_dry_run("create file: '#{@resource.name}'") do
           write_content_to_file
-          file_permissions.update
+          file_permissions.update unless file_permissions.uptodate?
         end
       end
 
@@ -85,13 +83,22 @@ module Wright
         current_checksum == target_checksum
       end
 
-      def uptodate?
-        content_uptodate? && permissions.uptodate?
+      def uptodate?(action)
+        case action
+        when :create
+          content_uptodate? && permissions.uptodate?
+        when :remove
+          !::File.exist?(filename) && !::File.symlink?(filename)
+        end
       end
 
       def filename
         ::File.expand_path(@resource.name)
       end
+
+      def fail_if_directory
+        fail Errno::EISDIR, filename if ::File.directory?(filename)
+      end
     end
   end
 end

data/lib/wright/provider/group/darwin_directory_service.rb

@@ -1,4 +1,3 @@
-require 'wright/dry_run'
 require 'wright/provider'
 require 'wright/provider/group'
 
@@ -47,13 +46,7 @@ module Wright
 
         def next_system_gid
           system_gid_range = (1...500)
-          used_system_gids = []
-          Etc.group do |g|
-            used_system_gids << g.gid if system_gid_range.include?(g.gid)
-          end
-          free_system_gids = system_gid_range.to_a - used_system_gids
-          fail 'No free gids in system gid range' if free_system_gids.empty?
-          free_system_gids.max
+          Wright::Util::User.next_free_gid(system_gid_range)
         end
       end
     end

data/lib/wright/provider/group/gnu_passwd.rb

@@ -1,4 +1,3 @@
-require 'wright/dry_run'
 require 'wright/provider'
 require 'wright/provider/group'
 

data/lib/wright/provider/group.rb

@@ -10,26 +10,20 @@ module Wright
       #
       # @return [void]
       def create
-        if uptodate?(:create)
-          Wright.log.debug "group already created: '#{@resource.name}'"
-          return
+        group = @resource.name
+        unless_uptodate(:create, "group already created: '#{group}'") do
+          create_group
         end
-
-        create_group
-        @updated = true
       end
 
       # Removes the group.
       #
       # @return [void]
       def remove
-        if uptodate?(:remove)
-          Wright.log.debug "group already removed: '#{@resource.name}'"
-          return
+        group = @resource.name
+        unless_uptodate(:remove, "group already removed: '#{group}'") do
+          remove_group
         end
-
-        remove_group
-        @updated = true
       end
 
       private

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

@@ -1,6 +1,3 @@
-require 'open3'
-
-require 'wright/dry_run'
 require 'wright/provider'
 require 'wright/provider/package'
 
@@ -12,33 +9,24 @@ module Wright
       class Apt < Wright::Provider::Package
         # @return [Array<String>] the installed package versions
         def installed_versions
-          cmd = 'dpkg-query'
-          args = ['-s', @resource.name]
-          cmd_stdout, _, cmd_status = Open3.capture3(env, cmd, *args)
-          installed_re = /^Status: install ok installed$/
+          package = @resource.name
+          err = "Cannot determine installed versions for package '#{package}'"
+          apt_policy = exec_or_fail('apt-cache', ['policy', package], err)
 
-          if cmd_status.success? && installed_re =~ cmd_stdout
-            /^Version: (?<version>.*)$/ =~ cmd_stdout
-            [version]
-          else
-            []
-          end
+          version_re = /(?!\(none\)).*/
+          installed_re = /^  Installed: (?<version>#{version_re})$/
+          match = installed_re.match(apt_policy)
+          match ? [match['version']] : []
         end
 
         private
 
         def install_package
-          package = @resource.name
-          unless_dry_run("install package: '#{package}'") do
-            apt_get(:install, package, @resource.version)
-          end
+          apt_get(:install, @resource.name, @resource.version)
         end
 
         def remove_package
-          package = @resource.name
-          unless_dry_run("remove package: '#{package}'") do
-            apt_get(:remove, package)
-          end
+          apt_get(:remove, @resource.name)
         end
 
         def apt_get(action, package, version = nil)

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

@@ -1,7 +1,6 @@
 require 'open3'
 require 'json'
 
-require 'wright/dry_run'
 require 'wright/provider'
 require 'wright/provider/package'
 
@@ -29,32 +28,20 @@ module Wright
         private
 
         def install_package
-          package = @resource.name
-          unless_dry_run("install package: '#{package}'") do
-            brew(:install, package, @resource.version)
-          end
+          brew(:install, @resource.name, @resource.version)
         end
 
         def remove_package
-          package = @resource.name
-          unless_dry_run("remove package: '#{package}'") do
-            brew(:uninstall, package)
-          end
+          brew(:uninstall, @resource.name)
         end
 
         def brew(action, package, version = nil)
           ignore_version(version)
 
-          cmd = 'brew'
-          args = [action.to_s, package]
-
-          _, cmd_stderr, cmd_status = Wright::Util.bundler_clean_env do
-            Open3.capture3(env, cmd, *args)
+          Wright::Util.bundler_clean_env do
+            error_message = "cannot #{action} package '#{package}'"
+            exec_or_fail('brew', [action.to_s, package], error_message)
           end
-          return if cmd_status.success?
-
-          brew_error = cmd_stderr.chomp
-          fail %(cannot #{action} package '#{package}': "#{brew_error}")
         end
 
         def ignore_version(version)

data/lib/wright/provider/package.rb

@@ -9,26 +9,29 @@ module Wright
       #
       # @return [void]
       def install
-        if uptodate?(:install)
-          Wright.log.debug "package already installed: '#{@resource.name}'"
-          return
+        package = @resource.name
+        unless_uptodate(:install, "package already installed: '#{package}'") do
+          unless_dry_run("install package: '#{package}'") do
+            install_package
+          end
         end
-
-        install_package
-        @updated = true
       end
 
       # Removes the package.
       #
       # @return [void]
       def remove
-        if uptodate?(:remove)
-          Wright.log.debug "package already removed: '#{@resource.name}'"
-          return
+        package = @resource.name
+        unless_uptodate(:remove, "package already removed: '#{package}'") do
+          unless_dry_run("remove package: '#{package}'") do
+            remove_package
+          end
         end
+      end
 
-        remove_package
-        @updated = true
+      # @return [Array<String>] the installed package versions
+      def installed_versions
+        fail NotImplementedError
       end
 
       private
@@ -60,6 +63,14 @@ module Wright
           !installed_versions.empty?
         end
       end
+
+      def install_package
+        fail NotImplementedError
+      end
+
+      def remove_package
+        fail NotImplementedError
+      end
     end
   end
 end

data/lib/wright/provider/symlink.rb

@@ -10,42 +10,36 @@ module Wright
       #
       # @return [void]
       def create
-        if exist?
-          symlink = symlink_to_s(@resource.name, @resource.to)
-          Wright.log.debug "symlink already created: #{symlink}"
-          return
-        end
-
         fail Errno::EEXIST, link_name if regular_file?
-        create_link
-        @updated = true
+
+        symlink = symlink_to_s(@resource.name, @resource.to)
+        unless_uptodate(:create, "symlink already created: #{symlink}") do
+          create_link
+        end
       end
 
       # Removes the symlink.
       #
       # @return [void]
       def remove
-        if ::File.exist?(link_name) && !::File.symlink?(link_name)
-          fail "'#{link_name}' is not a symlink"
-        end
+        fail "'#{link_name}' is not a symlink" if regular_file?
 
-        if ::File.symlink?(link_name)
+        symlink = @resource.name
+        unless_uptodate(:remove, "symlink already removed: '#{symlink}'") do
           remove_symlink
-          @updated = true
-        else
-          Wright.log.debug "symlink already removed: '#{@resource.name}'"
         end
       end
 
       private
 
-      # Checks if the specified link exists.
-      #
-      # Returns true if the link exists and points to the specified
-      # target and false otherwise.
-      def exist?
-        ::File.symlink?(link_name) &&
-          ::File.readlink(link_name) == link_to
+      def uptodate?(action)
+        case action
+        when :create
+          ::File.symlink?(link_name) &&
+            ::File.readlink(link_name) == link_to
+        when :remove
+          !::File.symlink?(link_name)
+        end
       end
 
       def create_link
@@ -70,6 +64,7 @@ module Wright
       end
 
       def link_to
+        return nil if @resource.to.nil?
         Wright::Util::File.expand_tilde_path(@resource.to)
       end
 

data/lib/wright/provider/user/darwin_directory_service.rb

@@ -0,0 +1,65 @@
+require 'wright/provider'
+require 'wright/provider/user'
+
+module Wright
+  class Provider
+    class User
+      # Darwin DirectoryService user provider. Used as a provider for
+      # {Resource::User} on OS X systems.
+      class DarwinDirectoryService < User
+        private
+
+        def add_user
+          user = @resource.name
+          attributes = default_attributes.merge(resource_attributes)
+          attributes.each do |k, v|
+            args = dscl_args(:create, k, v)
+            exec_or_fail('dscl', args, "cannot create user '#{user}'")
+          end
+        end
+
+        def update_user
+          user = @resource.name
+          resource_attributes.each do |k, v|
+            args = dscl_args(:create, k, v)
+            exec_or_fail('dscl', args, "cannot create user '#{user}'")
+          end
+        end
+
+        def delete_user
+          user = @resource.name
+          exec_or_fail('dscl',
+                       %W(. -delete /Users/#{user}),
+                       "cannot remove user '#{user}'")
+        end
+
+        def dscl_args(cmd, key, value)
+          %W(. -#{cmd} /Users/#{@resource.name} #{key} #{value})
+        end
+
+        def default_attributes
+          uid_range = @resource.system ? 1...500 : 500...1000
+          {
+            'UniqueID' => Wright::Util::User.next_free_uid(uid_range),
+            'UserShell' => '/bin/bash',
+            'RealName' => '',
+            'NFSHomeDirectory' => "/Users/#{@resource.name}",
+            'PrimaryGroupID' => Wright::Util::User.group_to_gid('staff'),
+            'Password' => '*'
+          }
+        end
+
+        def resource_attributes
+          gid = Wright::Util::User.group_to_gid(@resource.primary_group)
+          {
+            'UniqueID' => @resource.uid,
+            'UserShell' => @resource.shell,
+            'RealName' => @resource.full_name,
+            'NFSHomeDirectory' => @resource.home,
+            'PrimaryGroupID' => gid
+          }.reject { |_k, v| v.nil? }
+        end
+      end
+    end
+  end
+end

data/lib/wright/provider/user/gnu_passwd.rb

@@ -1,4 +1,3 @@
-require 'wright/dry_run'
 require 'wright/provider'
 require 'wright/provider/user'
 
@@ -12,16 +11,16 @@ module Wright
 
         def add_user
           user = @resource.name
-          cmd = 'useradd'
-          args = [*user_options, user]
-          exec_or_fail(cmd, args, "cannot create user '#{user}'")
+          exec_or_fail('useradd',
+                       [*user_options, user],
+                       "cannot create user '#{user}'")
         end
 
         def update_user
           user = @resource.name
-          cmd = 'usermod'
-          args = [*user_options, user]
-          exec_or_fail(cmd, args, "cannot create user '#{user}'")
+          exec_or_fail('usermod',
+                       [*user_options, user],
+                       "cannot create user '#{user}'")
         end
 
         def user_options