wright 0.1.2 → 0.2.0

data/lib/wright/provider/symlink.rb

@@ -1,5 +1,6 @@
-require 'wright/provider'
 require 'fileutils'
+require 'wright/provider'
+require 'wright/util/file'
 
 module Wright
   class Provider
@@ -49,10 +50,7 @@ module Wright
 
       def create_link
         symlink = symlink_to_s(@resource.name, @resource.to)
-        if Wright.dry_run?
-          Wright.log.info "(would) create symlink: #{symlink}"
-        else
-          Wright.log.info "create symlink: #{symlink}"
+        unless_dry_run("create symlink: #{symlink}") do
           Wright::Util::File.ln_sfn(link_to, link_name)
         end
       end
@@ -62,10 +60,7 @@ module Wright
       end
 
       def remove_symlink
-        if Wright.dry_run?
-          Wright.log.info "(would) remove symlink: '#{@resource.name}'"
-        else
-          Wright.log.info "remove symlink: '#{@resource.name}'"
+        unless_dry_run("remove symlink: '#{@resource.name}'") do
           FileUtils.rm(link_name)
         end
       end

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

@@ -0,0 +1,55 @@
+require 'wright/dry_run'
+require 'wright/provider'
+require 'wright/provider/user'
+
+module Wright
+  class Provider
+    class User
+      # GNU passwd user provider. Used as a provider for
+      # {Resource::User} on GNU systems.
+      class GnuPasswd < Wright::Provider::User
+        private
+
+        def add_user
+          user = @resource.name
+          cmd = 'useradd'
+          args = [*user_options, user]
+          exec_or_fail(cmd, args, "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}'")
+        end
+
+        def user_options
+          options = {
+            '-u' => @resource.uid,
+            '-g' => @resource.primary_group,
+            '-c' => comment,
+            '-G' => groups,
+            '-s' => @resource.shell,
+            '-d' => @resource.home
+          }.reject { |_k, v| v.nil? }.flatten
+          options << '-r' if @resource.system
+          options.map(&:to_s)
+        end
+
+        def comment
+          @resource.full_name.nil? ? nil : "#{@resource.full_name},,,"
+        end
+
+        def groups
+          @resource.groups.nil? ? nil : @resource.groups.join(',')
+        end
+
+        def delete_user
+          user = @resource.name
+          exec_or_fail('userdel', [user], "cannot remove user '#{user}'")
+        end
+      end
+    end
+  end
+end

data/lib/wright/provider/user.rb

@@ -0,0 +1,137 @@
+require 'etc'
+require 'wright/provider'
+require 'wright/util/user'
+
+module Wright
+  class Provider
+    # User provider. Used as a base class for {Resource::User}
+    # providers.
+    class User < Wright::Provider
+      # Adds the user.
+      #
+      # @return [void]
+      def create
+        if uptodate?(:create)
+          Wright.log.debug "user already created: '#{@resource.name}'"
+          return
+        end
+
+        create_user
+        @updated = true
+      end
+
+      # Removes the user.
+      #
+      # @return [void]
+      def remove
+        if uptodate?(:remove)
+          Wright.log.debug "user already removed: '#{@resource.name}'"
+          return
+        end
+
+        remove_user
+        @updated = true
+      end
+
+      private
+
+      # @api public
+      # Checks if the user is up-to-date for a given action.
+      #
+      # @param action [Symbol] the action. Currently supports
+      #   +:create+ and +:remove+.
+      #
+      # @return [Bool] +true+ if the user is up-to-date and +false+
+      #   otherwise
+      # @raise [ArgumentError] if the action is invalid
+      def uptodate?(action)
+        case action
+        when :create
+          user_exists? && attributes_uptodate?
+        when :remove
+          !user_exists?
+        else
+          fail ArgumentError, "invalid action '#{action}'"
+        end
+      end
+
+      def attributes_uptodate?
+        uid_uptodate? &&
+          full_name_uptodate? &&
+          groups_uptodate? &&
+          shell_uptodate? &&
+          home_uptodate? &&
+          primary_group_uptodate?
+      end
+
+      def create_user
+        unless_dry_run("create user: '#{@resource.name}'") do
+          if user_exists?
+            update_user
+          else
+            add_user
+          end
+        end
+      end
+
+      def remove_user
+        unless_dry_run("remove user: '#{@resource.name}'") do
+          delete_user
+        end
+      end
+
+      def user_data
+        Etc.getpwnam(@resource.name)
+      rescue ArgumentError
+        nil
+      end
+
+      def uid_uptodate?
+        @resource.uid.nil? || user_data.uid == @resource.uid
+      end
+
+      def full_name_uptodate?
+        @resource.full_name.nil? ||
+          user_data.gecos.split(',').first == @resource.full_name
+      end
+
+      def groups_uptodate?
+        return true if @resource.groups.nil?
+        groups = []
+        Etc.group { |g| groups << g.name if g.mem.include?(@resource.name) }
+        groups.uniq.sort == @resource.groups.uniq.sort
+      end
+
+      def shell_uptodate?
+        @resource.shell.nil? || user_data.shell == @resource.shell
+      end
+
+      def home_uptodate?
+        @resource.home.nil? || user_data.dir == @resource.home
+      end
+
+      def primary_group_uptodate?
+        return true if @resource.primary_group.nil?
+
+        gid = Wright::Util::User.group_to_gid(@resource.primary_group)
+        user_data.gid == gid
+      end
+
+      def user_exists?
+        !user_data.nil?
+      end
+
+      def add_user
+        fail NotImplementedError
+      end
+
+      def update_user
+        fail NotImplementedError
+      end
+
+      def delete_user
+        fail NotImplementedError
+      end
+    end
+  end
+end

data/lib/wright/provider.rb

@@ -1,4 +1,5 @@
 require 'wright/config'
+require 'wright/dry_run'
 require 'wright/util/recursive_autoloader'
 
 module Wright
@@ -27,5 +28,44 @@ module Wright
       @updated = false
       updated
     end
+
+    private
+
+    # @api public
+    # Logs an info message and runs a code block unless dry run mode
+    # is active.
+    #
+    # @param message [String] the message that is passed to the logger
+    def unless_dry_run(message)
+      if Wright.dry_run?
+        Wright.log.info "(would) #{message}"
+      else
+        Wright.log.info message
+        yield
+      end
+    end
+
+    # @api public
+    # Runs a command or fails with an error message.
+    #
+    # @param command [String] the command to run
+    # @param args [Array<String>] the arguments that are passed to the
+    #   command
+    # @param error_message [String] the error message to display in
+    #   case of an error
+    # @raise [RuntimeError] if the command did not exit successfully
+    # @return [void]
+    def exec_or_fail(command, args, error_message)
+      stdout, stderr, status = Open3.capture3(env, command, *args)
+      return if status.success?
+
+      error = stderr.chomp
+      error = stdout.chomp if error.empty?
+      fail %(#{error_message}: "#{error}")
+    end
+
+    def env
+      {}
+    end
   end
 end

data/lib/wright/resource/file.rb

@@ -13,7 +13,7 @@ module Wright
       # @return [String] the file's intended content
       attr_accessor :content
 
-      # @return [String] the file's intended group.
+      # @return [String] the file's intended group
       attr_accessor :group
 
       # @return [String, Integer] the file's intended mode

data/lib/wright/resource/group.rb

@@ -0,0 +1,64 @@
+require 'wright/resource'
+require 'wright/dsl'
+
+module Wright
+  class Resource
+    # Group resource, represents a group.
+    #
+    # @example
+    #   admins = Wright::Resource::Group.new('admins')
+    #   admins.members = ['root']
+    #   admins.create
+    # @todo Use GnuPasswd provider on all GNU-flavoured systems
+    class Group < Wright::Resource
+      # @return [Array<String>] the group's intended members
+      attr_accessor :members
+
+      # @return [Integer] the group's intended group id
+      attr_accessor :gid
+
+      # @return [Bool] true if the group should be a system
+      #   group. Ignored if {#gid} is set.
+      attr_accessor :system
+
+      # Initializes a Group.
+      #
+      # @param name [String] the group's name
+      def initialize(name)
+        super
+        @action = :create
+        @system = false
+      end
+
+      # Creates or updates the group.
+      #
+      # @return [Bool] true if the group was updated and false
+      #   otherwise
+      def create
+        might_update_resource do
+          @provider.create
+        end
+      end
+
+      # Removes the group.
+      #
+      # @return [Bool] true if the group was updated and false
+      #   otherwise
+      def remove
+        might_update_resource do
+          @provider.remove
+        end
+      end
+    end
+  end
+end
+
+Wright::DSL.register_resource(Wright::Resource::Group)
+
+group_providers = {
+  'debian' => 'Wright::Provider::Group::GnuPasswd',
+  'macosx' => 'Wright::Provider::Group::DarwinDirectoryService'
+}
+Wright::Config[:resources][:group] ||= {}
+Wright::Config[:resources][:group][:provider] ||=
+  group_providers[Wright::Util.os_family]

data/lib/wright/resource/package.rb

@@ -64,10 +64,10 @@ end
 
 Wright::DSL.register_resource(Wright::Resource::Package)
 
+package_providers = {
+  'debian' => 'Wright::Provider::Package::Apt',
+  'macosx' => 'Wright::Provider::Package::Homebrew'
+}
 Wright::Config[:resources][:package] ||= {}
-
-case Wright::Util.os_family
-when 'debian'
-  Wright::Config[:resources][:package][:provider] ||=
-    'Wright::Provider::Package::Apt'
-end
+Wright::Config[:resources][:package][:provider] ||=
+  package_providers[Wright::Util.os_family]

data/lib/wright/resource/user.rb

@@ -0,0 +1,76 @@
+require 'wright/resource'
+require 'wright/dsl'
+
+module Wright
+  class Resource
+    # User resource, represents a user.
+    #
+    # @example
+    #   johndoe = Wright::Resource::User.new('johndoe')
+    #   johndoe.home = '/home/johndoe'
+    #   johndoe.create
+    class User < Wright::Resource
+      # @return [Integer] the user's intended user id
+      attr_accessor :uid
+
+      # @return [String] the user's intended full name
+      attr_accessor :full_name
+
+      # @return [Array<String>] the user's intended groups
+      attr_accessor :groups
+
+      # @return [String] the user's intended shell
+      attr_accessor :shell
+
+      # @return [String] the user's intended home directory path
+      attr_accessor :home
+      alias_method :homedir, :home
+
+      # @return [String, Integer] the user's intended primary group
+      attr_accessor :primary_group
+      alias_method :login_group, :primary_group
+
+      # @return [Bool] true if the user should be a system
+      #   user. Ignored if {#uid} is set.
+      attr_accessor :system
+
+      # Initializes a user.
+      #
+      # @param name [String] the user's name
+      def initialize(name)
+        super
+        @action = :create
+        @system = false
+      end
+
+      # Creates or updates the user.
+      #
+      # @return [Bool] true if the user was updated and false
+      #   otherwise
+      def create
+        might_update_resource do
+          @provider.create
+        end
+      end
+
+      # Removes the user.
+      #
+      # @return [Bool] true if the user was updated and false
+      #   otherwise
+      def remove
+        might_update_resource do
+          @provider.remove
+        end
+      end
+    end
+  end
+end
+
+Wright::DSL.register_resource(Wright::Resource::User)
+
+user_providers = {
+  'debian' => 'Wright::Provider::User::GnuPasswd'
+}
+Wright::Config[:resources][:user] ||= {}
+Wright::Config[:resources][:user][:provider] ||=
+  user_providers[Wright::Util.os_family]

data/lib/wright/util/recursive_autoloader.rb

@@ -78,7 +78,7 @@ module Wright
             subclass = Wright::Util.filename_to_classname(dir)
             ensure_subclass_exists(parent_class, subclass)
             new_parent = Wright::Util.filename_to_classname(
-                                           ::File.join(parent_class, dir))
+              ::File.join(parent_class, dir))
             add_autoloads_unsafe(dir, new_parent)
           end
         end

data/lib/wright/util/stolen_from_activesupport.rb

@@ -168,6 +168,8 @@ module Wright
       # @return [Class, NilClass] the constant or nil if the name is
       #   not in CamelCase or the constant is unknown
       def self.safe_constantize(camel_cased_word)
+        return nil if camel_cased_word.nil?
+
         constantize(camel_cased_word)
       rescue NameError => e
         error_re = /(uninitialized constant|wrong constant name)/

data/lib/wright/util.rb

@@ -1,4 +1,5 @@
 require 'wright/util/stolen_from_activesupport'
+require 'open3'
 
 module Wright
   # @api private
@@ -37,10 +38,14 @@ module Wright
     end
 
     def self.distro
-      os_release = ::File.read('/etc/os-release')
+      default = 'linux'
+      release_file = '/etc/os-release'
+      return default unless ::File.exist?(release_file)
+
+      os_release = ::File.read(release_file)
       /^ID_LIKE=(?<id_like>.*)$/ =~ os_release
       /^ID=(?<id>.*)$/ =~ os_release
-      id_like || id || 'linux'
+      id_like || id || default
     end
     private_class_method :distro
 
@@ -66,5 +71,15 @@ module Wright
         'other'
       end
     end
+
+    # :nocov:
+    def self.bundler_clean_env
+      if defined?(Bundler)
+        Bundler.with_clean_env { yield }
+      else
+        yield
+      end
+    end
+    # :nocov:
   end
 end

data/lib/wright/version.rb

@@ -1,4 +1,4 @@
 module Wright # rubocop:disable Documentation
   # Current wright version
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/lib/wright.rb

@@ -7,8 +7,9 @@ require 'wright/resource/directory'
 require 'wright/resource/file'
 require 'wright/resource/package'
 require 'wright/resource/symlink'
+require 'wright/resource/group'
+require 'wright/resource/user'
 
-# @todo add proper documentation
-# Lightweight configuration management.
+# Top-level namespace for wright.
 module Wright
 end

data/spec/provider/group/darwin_directory_service/dscl_._create_SLASHGroupsSLASHfoobar_GroupMembership.return

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

data/spec/provider/group/darwin_directory_service/dscl_._create_SLASHGroupsSLASHfoobar_GroupMembership_permission-denied-user.return

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

data/spec/provider/group/darwin_directory_service/dscl_._create_SLASHGroupsSLASHfoobar_GroupMembership_permission-denied-user.stderr

@@ -0,0 +1,2 @@
+<main> attribute status: eDSPermissionError
+<dscl_cmd> DS Error: -14120 (eDSPermissionError)

data/spec/provider/group/darwin_directory_service/dscl_._create_SLASHGroupsSLASHfoobar_GroupMembership_user1_user2.return

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

data/spec/provider/group/darwin_directory_service/dseditgroup_-o_create_-i_1234_newgroup.return

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

data/spec/provider/group/darwin_directory_service/dseditgroup_-o_create_-i_499_newgroup.return

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

data/spec/provider/group/darwin_directory_service/dseditgroup_-o_create_-i_ERROR_newgroup.return

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

data/spec/provider/group/darwin_directory_service/dseditgroup_-o_create_-i_ERROR_newgroup.stdout

@@ -0,0 +1 @@
+GID contains non-numeric characters

data/spec/provider/group/darwin_directory_service/dseditgroup_-o_delete_bazqux.return

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

data/spec/provider/group/darwin_directory_service/dseditgroup_-o_delete_bazqux.stderr

@@ -0,0 +1 @@
+Group not found.

data/spec/provider/group/darwin_directory_service/dseditgroup_-o_delete_foobar.return

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

data/spec/provider/group/darwin_directory_service/dseditgroup_-o_delete_foobar.stderr

@@ -0,0 +1 @@
+Group record below will be deleted:

data/spec/provider/group/darwin_directory_service/dseditgroup_-o_delete_foobar.stdout

@@ -0,0 +1,10 @@
+dsAttrTypeStandard:GeneratedUID -
+		56CE5EAF-4311-4C01-A45E-7FBB28C607CC
+dsAttrTypeStandard:PrimaryGroupID -
+		42
+dsAttrTypeStandard:RecordName -
+		foobar
+dsAttrTypeStandard:RecordType -
+		dsRecTypeStandard:Groups
+dsAttrTypeStandard:AppleMetaNodeLocation -
+		/Local/Default

data/spec/provider/group/darwin_directory_service/dseditgroup_-o_edit_-i_52_foobar.return

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

data/spec/provider/group/darwin_directory_service/dseditgroup_-o_edit_-i_ERROR_foobar.return

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

data/spec/provider/group/darwin_directory_service/dseditgroup_-o_edit_-i_ERROR_foobar.stdout

@@ -0,0 +1 @@
+GID contains non-numeric characters