wright 0.3.2 → 0.4.0

data/lib/wright/provider/group.rb

@@ -6,13 +6,15 @@ module Wright
     # Group provider. Used as a base class for {Resource::Group}
     # providers.
     class Group < Wright::Provider
-      # Adds the group.
+      # Creates or updates the group.
       #
       # @return [void]
       def create
-        group = @resource.name
-        unless_uptodate(:create, "group already created: '#{group}'") do
-          create_group
+        unless_uptodate(:create, "group already created: '#{group_name}'") do
+          unless_dry_run("create group: '#{group_name}'") do
+            ensure_group_exists
+            set_members unless members_uptodate?
+          end
         end
       end
 
@@ -20,14 +22,39 @@ module Wright
       #
       # @return [void]
       def remove
-        group = @resource.name
-        unless_uptodate(:remove, "group already removed: '#{group}'") do
-          remove_group
+        unless_uptodate(:remove, "group already removed: '#{group_name}'") do
+          unless_dry_run("remove group: '#{group_name}'") do
+            remove_group
+          end
         end
       end
 
       private
 
+      def group_name
+        @resource.name
+      end
+
+      def gid
+        @resource.gid
+      end
+
+      def members
+        @resource.members
+      end
+
+      def system_group?
+        @resource.system
+      end
+
+      def ensure_group_exists
+        if group_exists?
+          set_gid unless gid_uptodate?
+        else
+          create_group
+        end
+      end
+
       # @api public
       # Checks if the group is up-to-date for a given action.
       #
@@ -48,37 +75,16 @@ module Wright
         end
       end
 
-      def create_group
-        group = @resource.name
-        unless_dry_run("create group: '#{group}'") do
-          if group_exists?
-            set_gid(group, @resource.gid) unless gid_uptodate?
-          else
-            add_group(group, @resource.gid, @resource.system)
-          end
-          set_members(group, @resource.members) unless members_uptodate?
-        end
-      end
-
-      def remove_group
-        group = @resource.name
-        unless_dry_run("remove group: '#{group}'") do
-          delete_group(group)
-        end
-      end
-
       def group_data
-        Etc.getgrnam(@resource.name)
-      rescue ArgumentError
-        nil
+        Wright::Util::User.safe_getgrnam(group_name)
       end
 
       def gid_uptodate?
-        @resource.gid.nil? || group_data.gid == @resource.gid
+        gid.nil? || group_data.gid == gid
       end
 
       def members_uptodate?
-        @resource.members.nil? || group_data.mem == @resource.members
+        members.nil? || group_data.mem == members
       end
 
       def group_exists?
@@ -86,11 +92,22 @@ module Wright
       end
 
       def set_members
-        group = @resource.name
-        new_members = @resource.members - group_data.mem
-        unwanted_members = group_data.mem - @resource.members
-        new_members.each { |m| add_member(m, group) }
-        unwanted_members.each { |m| remove_member(m, group) }
+        new_members = members - group_data.mem
+        unwanted_members = group_data.mem - members
+        new_members.each { |m| add_member(m, group_name) }
+        unwanted_members.each { |m| remove_member(m, group_name) }
+      end
+
+      def create_group
+        fail NotImplementedError
+      end
+
+      def remove_group
+        fail NotImplementedError
+      end
+
+      def set_gid
+        fail NotImplementedError
       end
 
       def add_member(_member, _group)

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

@@ -1,3 +1,5 @@
+require 'ostruct'
+
 require 'wright/provider'
 require 'wright/provider/package'
 
@@ -9,33 +11,55 @@ module Wright
       class Apt < Wright::Provider::Package
         # @return [Array<String>] the installed package versions
         def installed_versions
-          package = @resource.name
-          err = "Cannot determine installed versions for package '#{package}'"
-          apt_policy = exec_or_fail('apt-cache', ['policy', package], err)
+          package = "package '#{package_name}'"
+          err = "Cannot determine installed versions for #{package}"
+          apt_policy = exec_or_fail('apt-cache', ['policy', package_name], err)
 
           version_re = /(?!\(none\)).*/
           installed_re = /^  Installed: (?<version>#{version_re})$/
           match = installed_re.match(apt_policy)
-          match ? [match['version']] : []
+          match ? [match['version']] : virtual_package_versions
         end
 
         private
 
         def install_package
-          apt_get(:install, @resource.name, @resource.version)
+          apt_get(:install, package_options, package_name, package_version)
         end
 
         def remove_package
-          apt_get(:remove, @resource.name)
+          apt_get(:remove, package_options, package_name)
         end
 
-        def apt_get(action, package, version = nil)
+        def apt_get(action, options, package, version = nil)
           package_version = version.nil? ? '' : "=#{version}"
           cmd = 'apt-get'
-          args = [action.to_s, '-qy', package + package_version]
+          args = [*options, action.to_s, '-qy', package + package_version]
           exec_or_fail(cmd, args, "cannot #{action} package '#{package}'")
         end
 
+        def virtual_package_versions
+          virtual_package_installed? ? ['virtual'] : []
+        end
+
+        # @todo replace the OpenStruct hack below by a direct
+        #   instantiation of {Wright::Resource::Package} as soon as
+        #   the resource-provider mapping can be changed more easily
+        def virtual_package_installed?
+          reverse_provides.any? do |name, version|
+            resource = OpenStruct.new(name: name, version: version)
+            package = Wright::Provider::Package::Apt.new(resource)
+            package.installed?
+          end
+        end
+
+        def reverse_provides
+          err = 'Error executing apt-cache'
+          showpkg = exec_or_fail('apt-cache', ['showpkg', package_name], err)
+          packages = showpkg.partition("Reverse Provides: \n").last.split("\n")
+          Hash[packages.map { |p| p.split(' ', 2) }]
+        end
+
         def env
           { 'DEBIAN_FRONTEND' => 'noninteractive' }
         end

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

@@ -13,7 +13,7 @@ module Wright
         # @return [Array<String>] the installed package versions
         def installed_versions
           cmd = 'brew'
-          args = ['info', '--json=v1', @resource.name]
+          args = ['info', '--json=v1', package_name]
           cmd_stdout, _, cmd_status = Wright::Util.bundler_clean_env do
             Open3.capture3(env, cmd, *args)
           end
@@ -28,11 +28,11 @@ module Wright
         private
 
         def install_package
-          brew(:install, @resource.name, @resource.version)
+          brew(:install, package_name, package_version)
         end
 
         def remove_package
-          brew(:uninstall, @resource.name)
+          brew(:uninstall, package_name)
         end
 
         def brew(action, package, version = nil)
@@ -40,13 +40,14 @@ module Wright
 
           Wright::Util.bundler_clean_env do
             error_message = "cannot #{action} package '#{package}'"
-            exec_or_fail('brew', [action.to_s, package], error_message)
+            args = [action.to_s, *package_options, package]
+            exec_or_fail('brew', args, error_message)
           end
         end
 
         def ignore_version(version)
           return unless version
-          package_info = "#{@resource.name} (#{version})"
+          package_info = "#{package_name} (#{version})"
           Wright.log.warn "ignoring package version: '#{package_info}'"
         end
       end

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

@@ -0,0 +1,39 @@
+require 'open3'
+
+require 'wright/provider'
+require 'wright/provider/package'
+
+module Wright
+  class Provider
+    class Package
+      # Yum package provider. Used as a provider for
+      # {Resource::Package} on Fedora-based systems.
+      class Yum < Wright::Provider::Package
+        # @return [Array<String>] the installed package versions
+        def installed_versions
+          version_format = '%{VERSION}-%{RELEASE}'
+          rpm_args = %W(-q #{package_name} --qf #{version_format})
+          stdout, _, status = Open3.capture3(env, 'rpm', *rpm_args)
+          status.success? ? [stdout] : []
+        end
+
+        private
+
+        def install_package
+          yum(:install, package_options, package_name, package_version)
+        end
+
+        def remove_package
+          yum(:remove, package_options, package_name)
+        end
+
+        def yum(action, options, package, version = nil)
+          cmd = 'yum'
+          package_version = version.nil? ? '' : "-#{version}"
+          args = [*options, action.to_s, '-y', package + package_version]
+          exec_or_fail(cmd, args, "cannot #{action} package '#{package}'")
+        end
+      end
+    end
+  end
+end

data/lib/wright/provider/package.rb

@@ -9,9 +9,9 @@ module Wright
       #
       # @return [void]
       def install
-        package = @resource.name
-        unless_uptodate(:install, "package already installed: '#{package}'") do
-          unless_dry_run("install package: '#{package}'") do
+        unless_uptodate(:install,
+                        "package already installed: '#{package_name}'") do
+          unless_dry_run("install package: '#{package_name}'") do
             install_package
           end
         end
@@ -21,9 +21,9 @@ module Wright
       #
       # @return [void]
       def remove
-        package = @resource.name
-        unless_uptodate(:remove, "package already removed: '#{package}'") do
-          unless_dry_run("remove package: '#{package}'") do
+        unless_uptodate(:remove,
+                        "package already removed: '#{package_name}'") do
+          unless_dry_run("remove package: '#{package_name}'") do
             remove_package
           end
         end
@@ -34,8 +34,30 @@ module Wright
         fail NotImplementedError
       end
 
+      # @return [Bool] true if the package is installed, false
+      #   otherwise
+      def installed?
+        if package_version
+          installed_versions.include?(package_version)
+        else
+          !installed_versions.empty?
+        end
+      end
+
       private
 
+      def package_name
+        @resource.name
+      end
+
+      def package_version
+        @resource.version
+      end
+
+      def package_options
+        @resource.options
+      end
+
       # @api public
       # Checks if the package is up-to-date for a given action.
       #
@@ -48,22 +70,14 @@ module Wright
       def uptodate?(action)
         case action
         when :install
-          package_installed?
+          installed?
         when :remove
-          !package_installed?
+          !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
-
       def install_package
         fail NotImplementedError
       end

data/lib/wright/provider/symlink.rb

@@ -10,11 +10,13 @@ module Wright
       #
       # @return [void]
       def create
-        fail Errno::EEXIST, link_name if regular_file?
+        fail Errno::EEXIST, link_name_expanded if regular_file?
 
-        symlink = symlink_to_s(@resource.name, @resource.to)
+        symlink = symlink_to_s
         unless_uptodate(:create, "symlink already created: #{symlink}") do
-          create_link
+          unless_dry_run("create symlink: #{symlink}") do
+            Wright::Util::File.ln_sfn(link_to_expanded, link_name_expanded)
+          end
         end
       end
 
@@ -22,54 +24,51 @@ module Wright
       #
       # @return [void]
       def remove
-        fail "'#{link_name}' is not a symlink" if regular_file?
+        fail "'#{link_name_expanded}' is not a symlink" if regular_file?
 
-        symlink = @resource.name
-        unless_uptodate(:remove, "symlink already removed: '#{symlink}'") do
-          remove_symlink
+        unless_uptodate(:remove, "symlink already removed: '#{link_name}'") do
+          unless_dry_run("remove symlink: '#{link_name}'") do
+            FileUtils.rm(link_name_expanded)
+          end
         end
       end
 
       private
 
-      def uptodate?(action)
-        case action
-        when :create
-          ::File.symlink?(link_name) &&
-            ::File.readlink(link_name) == link_to
-        when :remove
-          !::File.symlink?(link_name)
-        end
+      def link_name
+        @resource.name
       end
 
-      def create_link
-        symlink = symlink_to_s(@resource.name, @resource.to)
-        unless_dry_run("create symlink: #{symlink}") do
-          Wright::Util::File.ln_sfn(link_to, link_name)
-        end
+      def link_to
+        @resource.to
       end
 
-      def symlink_to_s(link_name, target)
-        "'#{link_name}' -> '#{target}'"
+      def link_to_expanded
+        return nil if link_to.nil?
+        Wright::Util::File.expand_tilde_path(link_to)
       end
 
-      def remove_symlink
-        unless_dry_run("remove symlink: '#{@resource.name}'") do
-          FileUtils.rm(link_name)
-        end
+      def link_name_expanded
+        Wright::Util::File.expand_tilde_path(link_name)
       end
 
-      def regular_file?
-        ::File.exist?(link_name) && !::File.symlink?(link_name)
+      def symlink_to_s
+        "'#{link_name}' -> '#{link_to}'"
       end
 
-      def link_to
-        return nil if @resource.to.nil?
-        Wright::Util::File.expand_tilde_path(@resource.to)
+      def uptodate?(action)
+        case action
+        when :create
+          ::File.symlink?(link_name_expanded) &&
+            ::File.readlink(link_name_expanded) == link_to_expanded
+        when :remove
+          !::File.symlink?(link_name_expanded)
+        end
       end
 
-      def link_name
-        Wright::Util::File.expand_tilde_path(@resource.name)
+      def regular_file?
+        ::File.exist?(link_name_expanded) &&
+          !::File.symlink?(link_name_expanded)
       end
     end
   end

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

@@ -9,53 +9,50 @@ module Wright
       class DarwinDirectoryService < User
         private
 
-        def add_user
-          user = @resource.name
+        def create_user
           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}'")
+            exec_or_fail('dscl', args, "cannot create user '#{user_name}'")
           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}'")
+            exec_or_fail('dscl', args, "cannot create user '#{user_name}'")
           end
         end
 
-        def delete_user
-          user = @resource.name
+        def remove_user
           exec_or_fail('dscl',
-                       %W(. -delete /Users/#{user}),
-                       "cannot remove user '#{user}'")
+                       %W(. -delete /Users/#{user_name}),
+                       "cannot remove user '#{user_name}'")
         end
 
         def dscl_args(cmd, key, value)
-          %W(. -#{cmd} /Users/#{@resource.name} #{key} #{value})
+          %W(. -#{cmd} /Users/#{user_name} #{key} #{value})
         end
 
         def default_attributes
-          uid_range = @resource.system ? 1...500 : 500...1000
+          uid_range = system_user? ? 1...500 : 500...1000
           {
             'UniqueID' => Wright::Util::User.next_free_uid(uid_range),
             'UserShell' => '/bin/bash',
             'RealName' => '',
-            'NFSHomeDirectory' => "/Users/#{@resource.name}",
+            'NFSHomeDirectory' => "/Users/#{user_name}",
             'PrimaryGroupID' => Wright::Util::User.group_to_gid('staff'),
             'Password' => '*'
           }
         end
 
         def resource_attributes
-          gid = Wright::Util::User.group_to_gid(@resource.primary_group)
+          gid = Wright::Util::User.group_to_gid(primary_group)
           {
-            'UniqueID' => @resource.uid,
-            'UserShell' => @resource.shell,
-            'RealName' => @resource.full_name,
-            'NFSHomeDirectory' => @resource.home,
+            'UniqueID' => uid,
+            'UserShell' => shell,
+            'RealName' => full_name,
+            'NFSHomeDirectory' => home,
             'PrimaryGroupID' => gid
           }.reject { |_k, v| v.nil? }
         end

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

@@ -9,44 +9,43 @@ module Wright
       class GnuPasswd < Wright::Provider::User
         private
 
-        def add_user
-          user = @resource.name
+        def create_user
           exec_or_fail('useradd',
-                       [*user_options, user],
-                       "cannot create user '#{user}'")
+                       [*user_options, user_name],
+                       "cannot create user '#{user_name}'")
         end
 
         def update_user
-          user = @resource.name
           exec_or_fail('usermod',
-                       [*user_options, user],
-                       "cannot create user '#{user}'")
+                       [*user_options, user_name],
+                       "cannot create user '#{user_name}'")
+        end
+
+        def remove_user
+          exec_or_fail('userdel',
+                       [user_name],
+                       "cannot remove user '#{user_name}'")
         end
 
         def user_options
           options = {
-            '-u' => @resource.uid,
-            '-g' => @resource.primary_group,
+            '-u' => uid,
+            '-g' => primary_group,
             '-c' => comment,
-            '-G' => groups,
-            '-s' => @resource.shell,
-            '-d' => @resource.home
+            '-G' => group_list,
+            '-s' => shell,
+            '-d' => home
           }.reject { |_k, v| v.nil? }.flatten
-          options << '-r' if @resource.system
+          options << '-r' if system_user?
           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(',')
+          full_name.nil? ? nil : "#{full_name},,,"
         end
 
-        def delete_user
-          user = @resource.name
-          exec_or_fail('userdel', [user], "cannot remove user '#{user}'")
+        def group_list
+          groups.nil? ? nil : groups.join(',')
         end
       end
     end