Move UserAction to Action

src/lib/y2users/linux/user_action.rb → src/lib/y2users/linux/action.rb

@@ -23,12 +23,12 @@
 
 module Y2Users
   module Linux
-    # Abstract base class for actions to perform over a user
+    # Abstract base class for actions over the system (e.g., create a user, delete a group, etc)
     #
     # Derived classes must implement #run_action method.
     #
     # @example
-    #   class ActionTest < UserAction
+    #   class ActionTest < Action
     #     def run_action
     #       print("test")
     #       true
@@ -39,13 +39,13 @@ module Linux
     #   result = action.perform
     #   result.success?       #=> true
     #   result.issues.empty?  #=> true
-    class UserAction
+    class Action
       # Constructor
       #
-      # @param user [User]
+      # @param action_element [Object] object to perform the action (e.g., a user)
       # @param commit_config [CommitConfig, nil] optional configuration for the commit
-      def initialize(user, commit_config = nil)
-        @user = user
+      def initialize(action_element, commit_config = nil)
+        @action_element = action_element
         @commit_config = commit_config
       end
 
@@ -60,8 +60,8 @@ def perform
 
     private
 
-      # @return [User]
-      attr_reader :user
+      # @return [Object]
+      attr_reader :action_element
 
       # @return [CommitConfig]
       attr_reader :commit_config

src/lib/y2users/linux/create_user_action.rb

@@ -21,18 +21,18 @@
 require "yast/i18n"
 require "yast2/execute"
 require "y2issues/issue"
-require "y2users/linux/user_action"
+require "y2users/linux/action"
 
 module Y2Users
   module Linux
     # Action for creating a new user
-    class CreateUserAction < UserAction
+    class CreateUserAction < Action
       include Yast::I18n
       include Yast::Logger
 
       # Constructor
       #
-      # @see UserAction
+      # @see Action
       def initialize(user, commit_config = nil)
         textdomain "users"
 
@@ -41,6 +41,8 @@ def initialize(user, commit_config = nil)
 
     private
 
+      alias_method :user, :action_element
+
       # Command for creating new users
       USERADD = "/usr/sbin/useradd".freeze
       private_constant :USERADD
@@ -50,7 +52,7 @@ def initialize(user, commit_config = nil)
       USERADD_E_HOMEDIR = 12
       private_constant :USERADD_E_HOMEDIR
 
-      # @see UserAction#run_action
+      # @see Action#run_action
       #
       # Issues are generated when the user cannot be created.
       def run_action

src/lib/y2users/linux/delete_user_action.rb

@@ -21,18 +21,18 @@
 require "yast/i18n"
 require "yast2/execute"
 require "y2issues/issue"
-require "y2users/linux/user_action"
+require "y2users/linux/action"
 
 module Y2Users
   module Linux
     # Action for deleting an existing user
-    class DeleteUserAction < UserAction
+    class DeleteUserAction < Action
       include Yast::I18n
       include Yast::Logger
 
       # Constructor
       #
-      # @see UserAction
+      # @see Action
       def initialize(user, commit_config = nil)
         textdomain "users"
 
@@ -41,11 +41,13 @@ def initialize(user, commit_config = nil)
 
     private
 
+      alias_method :user, :action_element
+
       # Command for deleting a user
       USERDEL = "/usr/sbin/userdel".freeze
       private_constant :USERDEL
 
-      # @see UserAction#run_action
+      # @see Action#run_action
       #
       # Issues are generated when the user cannot be deleted.
       def run_action

src/lib/y2users/linux/delete_user_password_action.rb

@@ -21,18 +21,18 @@
 require "yast/i18n"
 require "yast2/execute"
 require "y2issues/issue"
-require "y2users/linux/user_action"
+require "y2users/linux/action"
 
 module Y2Users
   module Linux
     # Action for deleting the user password
-    class DeleteUserPasswordAction < UserAction
+    class DeleteUserPasswordAction < Action
       include Yast::I18n
       include Yast::Logger
 
       # Constructor
       #
-      # @see UserAction
+      # @see Action
       def initialize(user, commit_config = nil)
         textdomain "users"
 
@@ -41,11 +41,13 @@ def initialize(user, commit_config = nil)
 
     private
 
+      alias_method :user, :action_element
+
       # Command for editing a password (i.e., used for deleting the password)
       PASSWD = "/usr/bin/passwd".freeze
       private_constant :PASSWD
 
-      # @see UserAction#run_action
+      # @see Action#run_action
       #
       # Issues are generated when the password cannot be deleted
       def run_action

src/lib/y2users/linux/edit_user_action.rb

@@ -21,18 +21,18 @@
 require "yast/i18n"
 require "yast2/execute"
 require "y2issues/issue"
-require "y2users/linux/user_action"
+require "y2users/linux/action"
 
 module Y2Users
   module Linux
     # Action for editing an existing user
-    class EditUserAction < UserAction
+    class EditUserAction < Action
       include Yast::I18n
       include Yast::Logger
 
       # Constructor
       #
-      # @see UserAction
+      # @see Action
       def initialize(initial_user, target_user, commit_config = nil)
         textdomain "users"
 
@@ -43,6 +43,8 @@ def initialize(initial_user, target_user, commit_config = nil)
 
     private
 
+      alias_method :user, :action_element
+
       # Initial state of the user
       #
       # It is used to calculate the changes to apply over the user.
@@ -54,7 +56,7 @@ def initialize(initial_user, target_user, commit_config = nil)
       USERMOD = "/usr/sbin/usermod".freeze
       private_constant :USERMOD
 
-      # @see UserAction#run_action
+      # @see Action#run_action
       #
       # Issues are generated when the user cannot be edited.
       def run_action

src/lib/y2users/linux/remove_home_content_action.rb

@@ -21,7 +21,7 @@
 require "yast/i18n"
 require "yast2/execute"
 require "y2issues/issue"
-require "y2users/linux/user_action"
+require "y2users/linux/action"
 
 module Y2Users
   module Linux
@@ -30,13 +30,13 @@ module Linux
     # Note that this action is not intended to remove the home itself, but only its content.
     # Basically, this action exists to supply the use case of creating a home without skel files,
     # which is not currently supported by the shadow tools.
-    class RemoveHomeContentAction < UserAction
+    class RemoveHomeContentAction < Action
       include Yast::I18n
       include Yast::Logger
 
       # Constructor
       #
-      # @see UserAction
+      # @see Action
       def initialize(user, commit_config = nil)
         textdomain "users"
 
@@ -45,11 +45,13 @@ def initialize(user, commit_config = nil)
 
     private
 
+      alias_method :user, :action_element
+
       # Command for finding files
       FIND = "/usr/bin/find".freeze
       private_constant :FIND
 
-      # @see UserAction#run_action
+      # @see Action#run_action
       #
       # Removes the content of the user home, even the hidden files.
       #

src/lib/y2users/linux/set_auth_keys_action.rb

@@ -21,18 +21,18 @@
 require "yast/i18n"
 require "y2issues/issue"
 require "users/ssh_authorized_keyring"
-require "y2users/linux/user_action"
+require "y2users/linux/action"
 
 module Y2Users
   module Linux
     # Action for setting the authorized keys of a user
-    class SetAuthKeysAction < UserAction
+    class SetAuthKeysAction < Action
       include Yast::I18n
       include Yast::Logger
 
       # Constructor
       #
-      # @see UserAction
+      # @see Action
       def initialize(user, commit_config = nil)
         textdomain "users"
 
@@ -41,7 +41,9 @@ def initialize(user, commit_config = nil)
 
     private
 
-      # @see UserAction#run_action
+      alias_method :user, :action_element
+
+      # @see Action#run_action
       #
       # Issues are generated when the authorized keys cannot be set.
       def run_action

src/lib/y2users/linux/set_home_ownership_action.rb

@@ -21,21 +21,21 @@
 require "yast/i18n"
 require "yast2/execute"
 require "y2issues/issue"
-require "y2users/linux/user_action"
+require "y2users/linux/action"
 
 module Y2Users
   module Linux
     # Action for changing the ownership of the home
     #
     # This action is needed when reusing an existing home in order to adapt home ownership to the
     # user.
-    class SetHomeOwnershipAction < UserAction
+    class SetHomeOwnershipAction < Action
       include Yast::I18n
       include Yast::Logger
 
       # Constructor
       #
-      # @see UserAction
+      # @see Action
       def initialize(user, commit_config = nil)
         textdomain "users"
 
@@ -44,11 +44,13 @@ def initialize(user, commit_config = nil)
 
     private
 
+      alias_method :user, :action_element
+
       # Command for changing ownership
       CHOWN = "/usr/bin/chown".freeze
       private_constant :CHOWN
 
-      # @see UserAction#run_action
+      # @see Action#run_action
       #
       # Issues are generated when ownership cannot be changed.
       def run_action

src/lib/y2users/linux/set_user_password_action.rb

@@ -21,18 +21,18 @@
 require "yast/i18n"
 require "yast2/execute"
 require "y2issues/issue"
-require "y2users/linux/user_action"
+require "y2users/linux/action"
 
 module Y2Users
   module Linux
     # Action for setting the user password
-    class SetUserPasswordAction < UserAction
+    class SetUserPasswordAction < Action
       include Yast::I18n
       include Yast::Logger
 
       # Constructor
       #
-      # @see UserAction
+      # @see Action
       def initialize(user, commit_config = nil)
         textdomain "users"
 
@@ -41,7 +41,9 @@ def initialize(user, commit_config = nil)
 
     private
 
-      # @see UserAction#run_action
+      alias_method :user, :action_element
+
+      # @see Action#run_action
       def run_action
         set_password_value && set_password_attributes
       end

test/lib/y2users/linux/users_writer_test.rb

@@ -94,7 +94,7 @@ def issues(messages)
 
     before do
       # Prevent to perform real actions into the system
-      allow_any_instance_of(Y2Users::Linux::UserAction).to receive(:perform).and_return(success)
+      allow_any_instance_of(Y2Users::Linux::Action).to receive(:perform).and_return(success)
       allow(Yast::MailAliases).to receive(:SetRootAlias)
     end
 
@@ -343,7 +343,7 @@ def issues(messages)
         end
 
         it "does not perform more actions" do
-          expect_any_instance_of(Y2Users::Linux::UserAction).to_not receive(:perform)
+          expect_any_instance_of(Y2Users::Linux::Action).to_not receive(:perform)
 
           subject.write
         end
@@ -560,7 +560,7 @@ def issues(messages)
         end
 
         it "does not perform more actions" do
-          expect_any_instance_of(Y2Users::Linux::UserAction).to_not receive(:perform)
+          expect_any_instance_of(Y2Users::Linux::Action).to_not receive(:perform)
 
           subject.write
         end