wright 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a0cff940afe911d53174b8b173b8da4bcadb20b
-  data.tar.gz: 0e2dcf9ded68e473d56dc7c9bf261f6be674b932
+  metadata.gz: 47536c6118c669e09c7e4d7c0310c68f2374abdc
+  data.tar.gz: 3fec1bac94bc0b78d8aa88a8803787ea1411b71e
 SHA512:
-  metadata.gz: b2eb2f9487c34f0d55cbca65effdcab1946e4169c956c668de29408076f4ada2bfe1a6b076cb371e7709dada23d538c01ace02221bea7b2edf57727497b29f41
-  data.tar.gz: c2729f48749672ddb2e4bee3cc675d1dfb6d39bb1e2d1b69d6c1b58652c3dcffea712acf6ae8ea853d01016343095fd5441a3736c03e0a188192c9e581607680
+  metadata.gz: 32ea02f6ac0f991cb76a22c72bfad585fc1500a91d9a6ea0070954d62a4c5ae7063e17d19093987ee3b600422b319b98fe7fb984435fa3ba7c5f7a22b80dec67
+  data.tar.gz: dd1df84d7f344d0e2388c4f3e58be1e5bf4397939ad6be6396258e6126dec8d805ba3fc2891f7e05015521af22a8cf5f7f36db3d8793f662edd0a1c21f477544

data/NEWS.md

@@ -1,4 +1,11 @@
 # wright NEWS
+## 0.4.0 (2015-06-11)
+- Add --dry-run option
+- Add support for virtual packages to apt provider
+- Add yum support to package provider
+- Use GNU passwd group and user providers on CentOS/RHEL
+- Add options attribute to package resource
+
 ## 0.3.2 (2015-06-01)
 - Expand script file path (#11)
 

data/README.md

@@ -1,80 +1,85 @@
 wright
 ======
-
 [![Gem Version](https://img.shields.io/gem/v/wright.svg?style=flat-square)][gem]
 [![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.
 
-Requirements
-------------
-
- - Ruby ≥1.9
-
 Getting Started
 ---------------
+Performing simple administrative tasks with wright is easy.
 
-To start a wright IRB session, simply run:
+```ruby
+#!/usr/bin/env wright
 
-    $ bundle console
+package 'sudo'
 
-In order to create some resources using the wright DSL:
+file '/etc/sudoers.d/env_keep-editor' do |f|
+  f.content = "Defaults env_keep += EDITOR\n"
+  f.owner   = 'root:root'
+  f.mode    = '440'
+end
+```
 
-```ruby
-require 'wright'
-extend Wright::DSL
+Scripts can also be run directly from the shell.
 
-foo_dir = directory '/tmp/foo'
-fstab = symlink '/tmp/foo/fstab' do |s|
-  s.to = '/etc/fstab'
-end
+    wright -e "package('tmux')"
 
-puts File.directory? '/tmp/foo'
-puts File.symlink? '/tmp/foo/fstab'
+If you would rather see the effects of running a wright script first,
+use the dry-run option:
 
-fstab.remove
-foo_dir.remove
-```
+    wright --dry-run -e "package('tmux')"
 
-If you don't want to use the DSL:
+For a list of command-line parameters, see
+[the manpage][wright-manpage]. For a more in-depth list of tasks you
+can perform using wright, check the [resource list][wright-resources].
 
-```ruby
-require 'wright'
+Installation
+------------
+Since wright does not have any runtime dependencies apart from Ruby
+≥1.9, it can safely be installed system-wide via rubygems:
 
-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
+    sudo gem install wright
 
-puts File.directory? '/tmp/foo'
-puts File.symlink? '/tmp/foo/fstab'
+Installation on Debian-based systems
+------------------------------------
+If you use a Debian-based GNU/Linux distribution such as Ubuntu, you
+can also install wright via the PPA [sometimesfood/wright][ppa]:
 
-fstab.remove
-foo_dir.remove
-```
+    sudo apt-get install software-properties-common
+    sudo add-apt-repository -y ppa:sometimesfood/wright
+    sudo apt-get update && sudo apt-get install wright
+
+If you use a Debian-based distribution that is not Ubuntu, you have to
+update your apt sources manually before installing wright:
+
+    export DISTRO="$(lsb_release -sc)"
+    export PPA_LIST="sometimesfood-wright-${DISTRO}.list"
+    sudo sed -i "s/${DISTRO}/trusty/g" /etc/apt/sources.list.d/${PPA_LIST}
 
 Documentation
 -------------
+As a wright user, the following documents are probably going to be of
+interest to you:
 
-There is not too much useful documentation that is targeted towards
-users at the moment.
+- [wright manpage][wright-manpage]
+- [list of wright resources][wright-resources]
+- [wright is just Ruby][wright-is-ruby]
 
-Run `bundle exec yard` to generate
-[HTML docs for wright developers](http://rubydoc.info/gems/wright/).
+As a wright developer, you might also be interested in the
+[wright developer docs](http://www.rubydoc.info/gems/wright/) which
+can also be generated via `bundle exec yard`.
 
-Hacking
--------
+Contributing
+------------
+Contributions to wright are greatly appreciated. If you would like to
+contribute to wright, please have a look at the
+[contribution guidelines](CONTRIBUTING.md).
 
-To get started with wright, simply install the development
+To start hacking on wright, simply install the development
 dependencies via bundler:
 
  - `bundle install --path .bundle`
@@ -82,15 +87,16 @@ dependencies via bundler:
 
 All tests should pass.
 
-Contributing
-------------
-
-Contributions to wright are greatly appreciated. If you would like to
-contribute to wright, please have a look at the
-[contribution guidelines](CONTRIBUTING.md).
-
 Copyright
 ---------
-
 Copyright (c) 2012-2015 Sebastian Boehm. See [LICENSE](LICENSE) for
 details.
+
+[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
+[ppa]: http://launchpad.net/~sometimesfood/+archive/ubuntu/wright
+[wright-manpage]: http://wright.sometimesfood.org/man/wright.1.html
+[wright-resources]: http://wright.sometimesfood.org/doc/resources.html
+[wright-is-ruby]: http://wright.sometimesfood.org/doc/wright-is-ruby.html

data/lib/wright/cli.rb

@@ -6,8 +6,9 @@ module Wright
   class CLI
     def initialize(main)
       @commands = []
+      @requires = []
       @main = main
-      @parser = option_parser
+      set_up_parser
     end
 
     # Runs a wright script with the supplied arguments.
@@ -17,16 +18,17 @@ module Wright
       arguments = parse(argv)
       return if @quit
 
+      Wright.activate_dry_run if @dry_run
       Wright.log.level = @log_level if @log_level
       @main.extend Wright::DSL
+      @requires.each { |r| require r }
 
       run_script(arguments)
     end
 
     private
 
-    attr_reader :commands
-    attr_reader :log_level
+    attr_reader :commands, :requires, :dry_run, :log_level
 
     def parse(argv)
       # use OptionParser#order! instead of #parse! so CLI#run does not
@@ -44,24 +46,48 @@ module Wright
       end
     end
 
-    def option_parser
-      OptionParser.new do |opts|
-        opts.on('-e COMMAND', 'Run COMMAND') do |e|
-          @commands << e
-        end
+    def set_up_parser
+      @parser = OptionParser.new
+      set_up_command_option
+      set_up_require_option
+      set_up_dry_run_option
+      set_up_verbosity_options
+      set_up_version_option
+    end
 
-        opts.on('-v', '--verbose', 'Increase verbosity') do
-          @log_level = Wright::Logger::DEBUG
-        end
+    def set_up_command_option
+      @parser.on('-e COMMAND', 'Run COMMAND') do |e|
+        @commands << e
+      end
+    end
 
-        opts.on('-q', '--quiet', 'Decrease verbosity') do
-          @log_level = Wright::Logger::ERROR
-        end
+    def set_up_require_option
+      @parser.on('-r LIBRARY',
+                 'Require LIBRARY before running the script') do |r|
+        @requires << r
+      end
+    end
+
+    def set_up_dry_run_option
+      @parser.on('-n', '--dry-run', 'Enable dry-run mode') do
+        @dry_run = true
+      end
+    end
+
+    def set_up_verbosity_options
+      @parser.on('-v', '--verbose', 'Increase verbosity') do
+        @log_level = Wright::Logger::DEBUG
+      end
+
+      @parser.on('-q', '--quiet', 'Decrease verbosity') do
+        @log_level = Wright::Logger::ERROR
+      end
+    end
 
-        opts.on_tail('--version', 'Show wright version') do
-          puts "wright version #{Wright::VERSION}"
-          @quit = true
-        end
+    def set_up_version_option
+      @parser.on_tail('--version', 'Show wright version') do
+        puts "wright version #{Wright::VERSION}"
+        @quit = true
       end
     end
   end

data/lib/wright/dry_run.rb

@@ -29,4 +29,11 @@ module Wright # rubocop:disable Documentation
   ensure
     @dry_run = saved_dry_run
   end
+
+  # @api private
+  # Activates dry-run mode.
+  # @return [void]
+  def self.activate_dry_run
+    @dry_run = true
+  end
 end

data/lib/wright/provider/directory.rb

@@ -12,11 +12,14 @@ module Wright
       #
       # @return [void]
       def create
-        fail Errno::EEXIST, dirname if regular_file?
+        fail Errno::EEXIST, dirname_expanded if regular_file?
 
-        dir = @resource.name
-        unless_uptodate(:create, "directory already created: '#{dir}'") do
-          create_directory
+        dir_permissions = permissions
+        unless_uptodate(:create, "directory already created: '#{dir_name}'") do
+          unless_dry_run("create directory: '#{dir_name}'") do
+            FileUtils.mkdir_p(dirname_expanded)
+            dir_permissions.update unless dir_permissions.uptodate?
+          end
         end
       end
 
@@ -24,25 +27,22 @@ module Wright
       #
       # @return [void]
       def remove
-        if ::File.exist?(dirname) && !::File.directory?(dirname)
-          fail "'#{dirname}' exists but is not a directory"
+        if ::File.exist?(dirname_expanded) &&
+           !::File.directory?(dirname_expanded)
+          fail "'#{dirname_expanded}' exists but is not a directory"
         end
 
-        dir = @resource.name
-        unless_uptodate(:remove, "directory already removed: '#{dir}'") do
-          remove_directory
+        unless_uptodate(:remove, "directory already removed: '#{dir_name}'") do
+          unless_dry_run("remove directory: '#{dir_name}'") do
+            FileUtils.rmdir(dirname_expanded)
+          end
         end
       end
 
       private
 
-      def uptodate?(action)
-        case action
-        when :create
-          ::File.directory?(dirname) && permissions.uptodate?
-        when :remove
-          !::File.exist?(dirname) && !::File.directory?(dirname)
-        end
+      def dir_name
+        @resource.name
       end
 
       def permissions
@@ -50,26 +50,22 @@ module Wright
                                                            :directory)
       end
 
-      def create_directory
-        dir_permissions = permissions
-        unless_dry_run("create directory: '#{@resource.name}'") do
-          FileUtils.mkdir_p(dirname)
-          dir_permissions.update unless dir_permissions.uptodate?
-        end
-      end
-
-      def remove_directory
-        unless_dry_run("remove directory: '#{@resource.name}'") do
-          FileUtils.rmdir(dirname)
+      def uptodate?(action)
+        case action
+        when :create
+          ::File.directory?(dirname_expanded) && permissions.uptodate?
+        when :remove
+          !::File.exist?(dirname_expanded) &&
+            !::File.directory?(dirname_expanded)
         end
       end
 
       def regular_file?
-        ::File.exist?(dirname) && !::File.directory?(dirname)
+        ::File.exist?(dirname_expanded) && !::File.directory?(dirname_expanded)
       end
 
-      def dirname
-        ::File.expand_path(@resource.name)
+      def dirname_expanded
+        ::File.expand_path(dir_name)
       end
     end
   end

data/lib/wright/provider/file.rb

@@ -18,9 +18,12 @@ module Wright
       #   the specified name
       def create
         fail_if_directory
-        file = @resource.name
-        unless_uptodate(:create, "file already created: '#{file}'") do
-          create_file
+        file_permissions = permissions
+        unless_uptodate(:create, "file already created: '#{file_name}'") do
+          unless_dry_run("create file: '#{file_name}'") do
+            write_content_to_file
+            file_permissions.update unless file_permissions.uptodate?
+          end
         end
       end
 
@@ -31,25 +34,30 @@ module Wright
       #   specified name
       def remove
         fail_if_directory
-        file = @resource.name
-        unless_uptodate(:remove, "file already removed: '#{file}'") do
-          remove_file
+        unless_uptodate(:remove, "file already removed: '#{file_name}'") do
+          unless_dry_run("remove file: '#{file_name}'") do
+            FileUtils.rm(filename_expanded)
+          end
         end
       end
 
       private
 
-      def create_file
-        file_permissions = permissions
-        unless_dry_run("create file: '#{@resource.name}'") do
-          write_content_to_file
-          file_permissions.update unless file_permissions.uptodate?
-        end
+      def file_name
+        @resource.name
+      end
+
+      def content
+        @resource.content
+      end
+
+      def permissions
+        Wright::Util::FilePermissions.create_from_resource(@resource, :file)
       end
 
       def write_content_to_file
-        tempfile = Tempfile.new(::File.basename(filename))
-        tempfile.write(@resource.content) if @resource.content
+        tempfile = Tempfile.new(::File.basename(filename_expanded))
+        tempfile.write(content) if content
         move_tempfile(tempfile)
       ensure
         tempfile.close!
@@ -57,18 +65,8 @@ module Wright
 
       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
-        unless_dry_run("remove file: '#{@resource.name}'") do
-          FileUtils.rm(filename)
-        end
-      end
-
-      def permissions
-        Wright::Util::FilePermissions.create_from_resource(@resource, :file)
+        return if content.nil? && ::File.exist?(filename_expanded)
+        FileUtils.mv(tempfile.path, filename_expanded)
       end
 
       def checksum(content)
@@ -76,10 +74,10 @@ module Wright
       end
 
       def content_uptodate?
-        return false unless ::File.exist?(filename)
-        content = @resource.content || ''
-        target_checksum = checksum(content.to_s)
-        current_checksum = checksum(::File.read(filename))
+        return false unless ::File.exist?(filename_expanded)
+        target_content = content || ''
+        target_checksum = checksum(target_content.to_s)
+        current_checksum = checksum(::File.read(filename_expanded))
         current_checksum == target_checksum
       end
 
@@ -88,16 +86,18 @@ module Wright
         when :create
           content_uptodate? && permissions.uptodate?
         when :remove
-          !::File.exist?(filename) && !::File.symlink?(filename)
+          !::File.exist?(filename_expanded) &&
+            !::File.symlink?(filename_expanded)
         end
       end
 
-      def filename
-        ::File.expand_path(@resource.name)
+      def filename_expanded
+        ::File.expand_path(file_name)
       end
 
       def fail_if_directory
-        fail Errno::EISDIR, filename if ::File.directory?(filename)
+        return unless ::File.directory?(filename_expanded)
+        fail Errno::EISDIR, filename_expanded
       end
     end
   end

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

@@ -9,28 +9,29 @@ module Wright
       class DarwinDirectoryService < Wright::Provider::Group
         private
 
-        def add_group(group_name, gid, system)
-          gid ||= next_system_gid if system
-          options = gid.nil? ? [] : ['-i', gid.to_s]
+        def create_group
+          target_gid = gid
+          target_gid ||= next_system_gid if system_group?
+          options = target_gid.nil? ? [] : ['-i', target_gid.to_s]
           cmd = 'dseditgroup'
           args = ['-o', 'create', *options, group_name]
           exec_or_fail(cmd, args, "cannot create group '#{group_name}'")
         end
 
-        def delete_group(group_name)
+        def remove_group
           cmd = 'dseditgroup'
           args = ['-o', 'delete', group_name]
           exec_or_fail(cmd, args, "cannot remove group '#{group_name}'")
         end
 
-        def set_members(group_name, members)
+        def set_members
           options = ['GroupMembership', *members]
           cmd = 'dscl'
           args = ['.', 'create', "/Groups/#{group_name}", *options]
           exec_or_fail(cmd, args, "cannot create group '#{group_name}'")
         end
 
-        def set_gid(group_name, gid)
+        def set_gid
           cmd = 'dseditgroup'
           args = ['-o', 'edit',
                   '-i', gid.to_s,
@@ -41,7 +42,7 @@ module Wright
         # Overrides Provider::Group#group_data to work around caching
         # issues with getgrnam(3) on OS X.
         def group_data
-          Etc.group { |g| break g if g.name == @resource.name }
+          Etc.group { |g| break g if g.name == group_name }
         end
 
         def next_system_gid

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

@@ -9,28 +9,28 @@ module Wright
       class GnuPasswd < Wright::Provider::Group
         private
 
-        def add_group(group_name, gid, system)
+        def create_group
           options = []
-          options << '--system' if system
+          options << '--system' if system_group?
           options += ['-g', gid.to_s] if gid
           cmd = 'groupadd'
           args = [*options, group_name]
           exec_or_fail(cmd, args, "cannot create group '#{group_name}'")
         end
 
-        def delete_group(group_name)
+        def remove_group
           cmd = 'groupdel'
           args = [group_name]
           exec_or_fail(cmd, args, "cannot remove group '#{group_name}'")
         end
 
-        def set_members(group_name, members)
+        def set_members
           cmd = 'gpasswd'
           args = ['-M', members.join(','), group_name]
           exec_or_fail(cmd, args, "cannot create group '#{group_name}'")
         end
 
-        def set_gid(group_name, gid)
+        def set_gid
           cmd = 'groupmod'
           args = ['-g', gid.to_s, group_name]
           exec_or_fail(cmd, args, "cannot create group '#{group_name}'")