ref: refs/heads/master
commit 136cf239e6b5ce406bd2f346abe359e54262df8b
Author: Duncan Mac-Vicar P
Date: Thu Aug 6 11:14:38 2009 +0200
refactoring user module code as discussed in the mailing list
TODO: complete the user_test testcase
---
plugins/users/app/controllers/users_controller.rb | 189 ++++----------------
plugins/users/app/models/user.rb | 185 +++++++++++++++-----
.../users/test/functional/users_controller_test.rb | 12 +-
plugins/users/test/unit/user_test.rb | 25 +++
4 files changed, 213 insertions(+), 198 deletions(-)
diff --git a/plugins/users/app/controllers/users_controller.rb b/plugins/users/app/controllers/users_controller.rb
index 59a0f1e..0e3d4e2 100644
--- a/plugins/users/app/controllers/users_controller.rb
+++ b/plugins/users/app/controllers/users_controller.rb
@@ -1,5 +1,4 @@
# import YastService class FIXME move into the model...
-require "yast_service"
include ApplicationHelper
@@ -8,132 +7,7 @@ class UsersController < ApplicationController
before_filter :login_required
def initialize
- @scr = Scr.instance
end
-
-#--------------------------------------------------------------------------------
-#
-#local methods
-#
-#--------------------------------------------------------------------------------
- def get_user_list
- @users = []
- parameters = {
- # how to index hash with users
- "index" => ["s", "uid"],
- # attributes to return for each user
- "user_attributes" => ["as", [ "cn" ]]
- }
- users_map = YastService.Call("YaPI::USERS::UsersGet", parameters)
- if users_map.nil?
- puts "something wrong happened -------------------------------------"
- else
- users_map.each do |key, val|
- user = User.new
- user.uid = key
- user.cn = val["cn"]
- @users << user
- end
- end
- end
-
- def get_user (id)
- parameters = {
- # user to find
- "uid" => [ "s", id ],
- # list of attributes to return;
- "user_attributes" => [ "as", [
- "cn", "uidNumber", "homeDirectory",
- "grouplist", "uid", "loginShell", "groupname"
- ]]
- }
- user_map = YastService.Call("YaPI::USERS::UserGet", parameters)
- # TODO check if it is not empty
-
- @user = User.new
-
- #FIXME why User.new (user_map) does not work?
-
- # convert camel-cased YaST keys to ruby's under_scored ones
- @user.grouplist = user_map["grouplist"]
- @user.home_directory = user_map["homeDirectory"]
- @user.groupname = user_map["groupname"]
- @user.login_shell = user_map["loginShell"]
- @user.uid = id
- @user.uid_number = user_map["uidNumber"]
- @user.cn = user_map["cn"]
-
- return true
- end
-
- # -------------------------------------------------------
- # modify existing user
- def update_user userId
- config = {
- "type" => [ "s", "local" ],
- "uid" => [ "s", @user.uid ]
- }
- # => FIXME convert ruby's under_scored keys to YaST's camel-cased ones
- data = {
- "uid" => [ "s", @user.uid]
- }
-
- ret = YastService.Call("YaPI::USERS::UserModify", config, data)
-
- logger.debug "Command returns: #{ret.inspect}"
-
- @error_string = ret
- return (ret == "")
- end
-
- # -------------------------------------------------------
- # add the new local user
- def add_user
-
- # FIXME mandatory parameters must be required on web-client side...
- config = {
- "type" => [ "s", "local" ]
- }
- data = {
- "uid" => [ "s", @user.uid]
- }
- # FIXME convert ruby's under_scored keys to YaST's camel-cased ones
- data["cn"] = [ "s", @user.cn ] unless @user.cn.blank?
- data["userPassword"] = [ "s", @user.user_password ] unless @user.user_password.blank?
- data["homeDirectory"] = [ "s", @user.home_directory ] unless @user.home_directory.blank?
- data["loginShell"] = [ "s", @user.login_shell ] unless @user.login_shell.blank?
- data["uidNumber"] = [ "s", @user.uid_number ] unless @user.uid_number.blank?
- data["groupname"] = [ "s", @user.groupname ] unless @user.groupname.blank?
-
- ret = YastService.Call("YaPI::USERS::UserAdd", config, data)
-
- logger.debug "Command returns: #{ret.inspect}"
-
- @error_string = ret
- return (ret == "")
- end
-
- # -------------------------------------------------------
- # delete existing local user
- def delete_user
-
- config = {
- "type" => [ "s", "local" ],
- "uid" => [ "s", @user.uid ]
- }
-
- ret = YastService.Call("YaPI::USERS::UserDelete", config)
- logger.debug "Command returns: #{ret}"
-
- @error_string = ret
- return (ret == "")
- end
-
-#--------------------------------------------------------------------------------
-#
-# actions
-#
-#--------------------------------------------------------------------------------
# GET /users
# GET /users.xml
@@ -142,7 +16,7 @@ class UsersController < ApplicationController
unless permission_check("org.opensuse.yast.modules.yapi.users.usersget")
render ErrorResult.error(403, 1, "no permission") and return
end
- get_user_list
+ @users = User.find_all
end
# GET /users/1
@@ -154,9 +28,17 @@ class UsersController < ApplicationController
if params[:id].blank?
render ErrorResult.error(404, 2, "empty parameter") and return
end
- unless get_user params[:id]
- render ErrorResult.error(404, 2, "user not found") and return
+
+ begin
+ # try to find the user, and 404 if it does not exist
+ @user = User.find(params[:id])
+ if @user.nil?
+ render ErrorResult.error(404, 2, "user not found") and return
+ end
+ rescue Exception => e
+ render ErrorResult.error(500, 2, e.message) and return
end
+
end
@@ -168,15 +50,12 @@ class UsersController < ApplicationController
render ErrorResult.error(403, 1, "no permission") and return
end
- @user = User.new
- if @user.update_attributes(params[:users])
- add_user
- if @error_string != ""
- render ErrorResult.error(404, @error_id, @error_string) and return
- end
- else
- render ErrorResult.error(404, 2, "wrong parameter") and return
+ begin
+ @user = User.create(params[:users])
+ rescue Exception => e
+ render ErrorResult.error(404, @error_id, @error_string) and return
end
+
render :show
end
@@ -186,19 +65,23 @@ class UsersController < ApplicationController
unless permission_check("org.opensuse.yast.modules.yapi.users.usermodify")
render ErrorResult.error(403, 1, "no permission") and return
end
- @user = User.new
+
if params[:users] && params[:users][:uid]
params[:id] = params[:users][:uid] #for sync only
end
- get_user params[:id]
- if @user.update_attributes(params[:users])
- update_user params[:id]
- if @error_string != ""
- render ErrorResult.error(404, @error_id, @error_string) and return
+
+ begin
+ begin
+ @user = User.find(params[:id])
+ rescue Exception => e
+ render ErrorResult.error(404, 2, e.message) and return
end
- else
- render ErrorResult.error(404, 2, "wrong parameter") and return
- end
+ @user.load_attributes(params[:users])
+ @user.save
+ rescue Exception => e
+ # FIXME here should be internal error I guess
+ render ErrorResult.error(404, 2, e.message) and return
+ end
render :show
end
@@ -209,14 +92,14 @@ class UsersController < ApplicationController
unless permission_check("org.opensuse.yast.modules.yapi.users.userdelete")
render ErrorResult.error(403, 1, "no permission") and return
end
- get_user params[:id]
- delete_user
- logger.debug "DELETE: #{@user.inspect}"
- if @error_string != ""
- render ErrorResult.error(404, @error_id, @error_string) and return
- else
- render :show
+
+ begin
+ @user = User.find(params[:id])
+ @user.destroy
+ rescue Exception => e
+ render ErrorResult.error(404, @error_id, e.message) and return
end
+ render :show
end
end
diff --git a/plugins/users/app/models/user.rb b/plugins/users/app/models/user.rb
index ba13e5b..8a0396f 100644
--- a/plugins/users/app/models/user.rb
+++ b/plugins/users/app/models/user.rb
@@ -1,55 +1,159 @@
+require 'yast_service'
+
+# User model, not ActiveRecord based, but a
+# thin model over the YaPI, with some
+# ActiveRecord like convenience API
class User
- attr_accessor :cn,
- :uid,
- :uid_number,
- :gid_number,
- :grouplist,
- :groupname,
- :home_directory,
- :login_shell,
- :user_password,
- :addit_data,
- :type
+ attr_accessor_with_default :cn, ""
+ attr_accessor_with_default :uid, ""
+ attr_accessor_with_default :uid_number, ""
+ attr_accessor_with_default :gid_number, ""
+ attr_accessor_with_default :grouplist, {}
+ attr_accessor_with_default :groupname, ""
+ attr_accessor_with_default :home_directory, ""
+ attr_accessor_with_default :login_shell, ""
+ attr_accessor_with_default :user_password, ""
+ attr_accessor_with_default :type, "local"
- def id
- @uid
+ def initialize
+ end
+
+ # users = User.find_all
+ def self.find_all
+ users = []
+ parameters = {
+ # how to index hash with users
+ "index" => ["s", "uid"],
+ # attributes to return for each user
+ "user_attributes" => ["as", [ "cn" ]]
+ }
+ users_map = YastService.Call("YaPI::USERS::UsersGet", parameters)
+ if users_map.nil?
+ raise "Can't get user list"
+ else
+ users_map.each do |key, val|
+ user = User.new
+ user.uid = key
+ user.cn = val["cn"]
+ users << user
+ end
+ end
+ users
end
- def id=(id_val)
- @uid = id_val
+ # load the attributes of the user
+ def self.find(id)
+ user = User.new
+ parameters = {
+ # user to find
+ "uid" => [ "s", id ],
+ # list of attributes to return;
+ "user_attributes" =>
+ [ "as", [ "cn", "uidNumber", "homeDirectory",
+ "grouplist", "uid", "loginShell", "groupname" ] ]
+ }
+ user_map = YastService.Call("YaPI::USERS::UserGet", parameters)
+
+ raise "Got no data while loading user attributes" if user_map.empty?
+
+ load_data(user_map)
+ user.uid = id
+ end
+
+ # User.destroy("joe")
+ def self.destroy(uid)
+ # delete existing local user
+ config = {
+ "type" => [ "s", "local" ],
+ "uid" => [ "s", uid ]
+ }
+
+ ret = YastService.Call("YaPI::USERS::UserDelete", config)
+ Rails.logger "Command returns: #{ret}"
+ # @error_string = ret
+ return (ret == "")
+ end
+
+ # user.destroy
+ def destroy
+ self.class.destroy(uid)
+ end
+
+ def save
+ config = { "type" => [ "s", "local" ],
+ "uid" => [ "s", @user.uid ]
+ }
+ data = retrieve_data
+ ret = YastService.Call("YaPI::USERS::UserModify", config, data)
+
+ logger.debug "Command returns: #{ret.inspect}"
+ raise ret if not ret.blank?
+ true
end
- def initialize
- @cn = ""
- @uid = ""
- @uid_number = ""
- @gid_number = ""
- @grouplist = {}
- @groupname = ""
- @home_directory = ""
- @login_shell = ""
- @user_password = ""
- @type = "local"
+ # load a internally used data hash
+ # with camel-cased values
+ def load_data(data)
+ attrs = {}
+ data.each do |key, value|
+ attrs.store(key.underscore, value)
+ end
+ load_attribures(attrs)
end
- def update_attributes usr
- return false if usr==nil
- @grouplist = usr[:grouplist]
- @home_directory = usr[:home_directory]
- @type = usr[:type]
- @groupname = usr[:groupname]
- @login_shell = usr[:login_shell]
- @user_password = usr[:user_password]
- @uid = usr[:uid]
- @uid_number = usr[:uid_number]
- @gid_number = usr[:gid_number]
- @cn = usr[:cn]
-
- return true
+ # load a hash of attributes
+ def load_attributes(attrs)
+ return false if attrs.nil?
+ attrs.each do |key, value|
+ if self.respond_to?(key.to_sym)
+ self.send("#{key}=".to_sym, value)
+ end
+ end
+ true
end
+ # retrieves the internally used data
+ # hash with camel-cased values
+ def retrieve_data
+ data = { }
+ [ :cn, :uid, :uid_number, :gid_number, :grouplist, :groupname, :home_directory, :login_shell, :user_password, :addit_data, :type ].each do |attr_name|
+ if self.respond_to?(attr_name)
+ attr = self.send(attr_name)
+ data.store(attr_name.to_s.camelize(:lower), ['s', attr]) unless attr.blank?
+ end
+ end
+ data
+ end
+
+ # create a user in the local system
+ def self.create(attrs)
+ config = {}
+ user = User.new
+ user.load_attributes(attrs)
+ data = user.retrieve_data
+
+ config.store("type", [ "s", "local" ])
+ data.store("uid", [ "s", user.uid])
+
+ ret = YastService.Call("YaPI::USERS::UserAdd", config, data)
+
+ Rails.logger.debug "Command returns: #{ret.inspect}"
+ # @error_string = ret
+ raise ret if not ret.blank?
+ user
+ end
+
+ def id
+ @uid
+ end
+
+ def id=(id_val)
+ @uid = id_val
+ end
+
+
def to_xml( options = {} )
xml = options[:builder] ||= Builder::XmlMarkup.new(options)
xml.instruct! unless options[:skip_instruct]
@@ -80,5 +184,4 @@ class User
return hash.to_json
end
-
end
diff --git a/plugins/users/test/functional/users_controller_test.rb b/plugins/users/test/functional/users_controller_test.rb
index fa977bb..fdd7067 100644
--- a/plugins/users/test/functional/users_controller_test.rb
+++ b/plugins/users/test/functional/users_controller_test.rb
@@ -2,6 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
require 'test/unit'
require 'rubygems'
require "scr"
+require "yast_service"
require 'mocha'
@@ -12,11 +13,11 @@ class UsersControllerTest < ActionController::TestCase
@request = ActionController::TestRequest.new
# http://railsforum.com/viewtopic.php?id=1719
@request.session[:account_id] = 1 # defined in fixtures
- Scr.any_instance.stubs(:initialize)
- Scr.any_instance.stubs(:execute).with(['/sbin/yast2', 'users', 'list']).returns({:stderr=>"schubi19 \nschubi2 \nschubi5 \ntuxtux \n", :exit=>16, :stdout=>""})
- Scr.any_instance.stubs(:execute).with(['/sbin/yast2', 'users', 'show', 'username=schubi5']).returns({:stderr=>"Full Name:\n\tschubi5\nList of Groups:\n\t\nDefault Group:\n\tusers\nHome Directory:\n\t/home/schubi5\nLogin Shell:\n\t/bin/bash\nLogin Name:\n\tschubi5\nUID:\n\t1005\n", :exit=>16, :stdout=>""})
+
+ User.stubs(:find_all).returns([])
end
+
test "access index" do
get :index
assert_response :success
@@ -37,12 +38,15 @@ class UsersControllerTest < ActionController::TestCase
end
test "access show" do
+ u = User.new
+ u.load_attributes({:uid => "schubi5"})
+ User.stubs(:find).with("schubi5").returns(u)
get :show, :id => "schubi5"
assert_response :success
end
test "access show with wrong user" do
- Scr.any_instance.stubs(:execute).with(['/sbin/yast2', 'users', 'show', 'username=schubi_not_found']).returns({:stderr=>"There is no such user.\n", :exit=>0, :stdout=>""})
+ User.stubs(:find).with("schubi_not_found").returns(nil)
get :show, :id => "schubi_not_found"
assert_response 404
end
diff --git a/plugins/users/test/unit/user_test.rb b/plugins/users/test/unit/user_test.rb
new file mode 100644
index 0000000..ac5519d
--- /dev/null
+++ b/plugins/users/test/unit/user_test.rb
@@ -0,0 +1,25 @@
+require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
+require 'test/unit'
+require 'rubygems'
+require "yast_service"
+#require 'mocha'
+require 'pp'
+
+class UserTest < Test::Unit::TestCase
+
+ def setup
+
+ #parameters = { "index" => ["s", "uid"], "user_attributes" => ["as", [ "cn" ]] }
+ #YastService.stubs(:Call).with("YaPI::USERS::UsersGet", parameters)
+
+
+ end
+
+ def test_user
+ parameters = { "index" => ["s", "uid"], "user_attributes" => ["as", [ "cn" ]] }
+ YastService.stubs(:Call).with("YaPI::USERS::UsersGet", parameters)
+ reply = YastService.Call("YaPI::USERS::UsersGet", parameters)
+ assert_equal({}, reply)
+ end
+
+end
--
To unsubscribe, e-mail: yast-commit+unsubscribe@opensuse.org
For additional commands, e-mail: yast-commit+help@opensuse.org
