1
0
mirror of https://github.com/OpenNebula/one.git synced 2025-01-10 01:17:40 +03:00

B #6425: document_type instance method for OpenNebula::Document (#2867)

This commit is contained in:
Daniel Clavijo Coca 2023-12-12 07:01:28 -06:00 committed by GitHub
parent 4cf60b07b4
commit 9b37568548
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 61 additions and 58 deletions

View File

@ -38,16 +38,16 @@ module OpenNebula
#######################################################################
DOCUMENT_METHODS = {
:allocate => "document.allocate",
:delete => "document.delete",
:info => "document.info",
:update => "document.update",
:chown => "document.chown",
:chmod => "document.chmod",
:clone => "document.clone",
:rename => "document.rename",
:lock => "document.lock",
:unlock => "document.unlock"
:allocate => 'document.allocate',
:delete => 'document.delete',
:info => 'document.info',
:update => 'document.update',
:chown => 'document.chown',
:chmod => 'document.chmod',
:clone => 'document.clone',
:rename => 'document.rename',
:lock => 'document.lock',
:unlock => 'document.unlock'
}
# Creates a Document Object description with just its identifier
@ -55,14 +55,14 @@ module OpenNebula
# @param [Integer] pe_id the id of the object
#
# @return [Nokogiri::XML::Node, REXML::Element] the empty xml
def Document.build_xml(pe_id=nil)
def self.build_xml(pe_id = nil)
if pe_id
obj_xml = "<DOCUMENT><ID>#{pe_id}</ID></DOCUMENT>"
else
obj_xml = "<DOCUMENT></DOCUMENT>"
obj_xml = '<DOCUMENT></DOCUMENT>'
end
XMLElement.build_xml(obj_xml,'DOCUMENT')
XMLElement.build_xml(obj_xml, 'DOCUMENT')
end
# Class constructor
@ -78,7 +78,7 @@ module OpenNebula
def initialize(xml, client)
LockableExt.make_lockable(self, DOCUMENT_METHODS)
super(xml,client)
super(xml, client)
end
#######################################################################
@ -92,14 +92,14 @@ module OpenNebula
def info(decrypt = false)
rc = super(DOCUMENT_METHODS[:info], 'DOCUMENT', decrypt)
if !OpenNebula.is_error?(rc) && self['TYPE'].to_i != document_type
if !OpenNebula.is_error?(rc) && document_type != self.class::DOCUMENT_TYPE
return OpenNebula::Error.new("[DocumentInfo] Error getting document [#{@pe_id}].")
end
return rc
end
alias_method :info!, :info
alias info! info
# Allocates a new Document in OpenNebula
#
@ -108,17 +108,17 @@ module OpenNebula
# @return [nil, OpenNebula::Error] nil in case of success, Error
# otherwise
def allocate(description)
super(DOCUMENT_METHODS[:allocate], description, document_type)
super(DOCUMENT_METHODS[:allocate], description, self.class::DOCUMENT_TYPE)
end
alias_method :allocate_xml, :allocate
alias allocate_xml allocate
# Deletes the Document
#
# @return [nil, OpenNebula::Error] nil in case of success, Error
# otherwise
def delete()
rc = check_type()
def delete
rc = check_type
return rc if OpenNebula.is_error?(rc)
return call(DOCUMENT_METHODS[:delete], @pe_id)
@ -132,8 +132,8 @@ module OpenNebula
#
# @return [nil, OpenNebula::Error] nil in case of success, Error
# otherwise
def update(new_template, append=false)
rc = check_type()
def update(new_template, append = false)
rc = check_type
return rc if OpenNebula.is_error?(rc)
super(DOCUMENT_METHODS[:update], new_template, append ? 1 : 0)
@ -147,8 +147,8 @@ module OpenNebula
#
# @return [nil, OpenNebula::Error] nil in case of success, Error
# otherwise
def update_raw(template_raw, append=false)
rc = check_type()
def update_raw(template_raw, append = false)
rc = check_type
return rc if OpenNebula.is_error?(rc)
return call(DOCUMENT_METHODS[:update], @pe_id, template_raw, append ? 1 : 0)
@ -162,7 +162,7 @@ module OpenNebula
# @return [nil, OpenNebula::Error] nil in case of success, Error
# otherwise
def chown(uid, gid)
rc = check_type()
rc = check_type
return rc if OpenNebula.is_error?(rc)
super(DOCUMENT_METHODS[:chown], uid, gid)
@ -175,7 +175,7 @@ module OpenNebula
# @return [nil, OpenNebula::Error] nil in case of success, Error
# otherwise
def chmod_octet(octet)
rc = check_type()
rc = check_type
return rc if OpenNebula.is_error?(rc)
super(DOCUMENT_METHODS[:chmod], octet)
@ -187,8 +187,8 @@ module OpenNebula
# @return [nil, OpenNebula::Error] nil in case of success, Error
# otherwise
def chmod(owner_u, owner_m, owner_a, group_u, group_m, group_a, other_u,
other_m, other_a)
rc = check_type()
other_m, other_a)
rc = check_type
return rc if OpenNebula.is_error?(rc)
super(DOCUMENT_METHODS[:chmod], owner_u, owner_m, owner_a, group_u,
@ -202,10 +202,10 @@ module OpenNebula
# @return [Integer, OpenNebula::Error] The new Document ID in case
# of success, Error otherwise
def clone(name)
rc = check_type()
rc = check_type
return rc if OpenNebula.is_error?(rc)
return Error.new('ID not defined') if !@pe_id
return Error.new('ID not defined') unless @pe_id
rc = @client.call(DOCUMENT_METHODS[:clone], @pe_id, name)
@ -241,7 +241,7 @@ module OpenNebula
# Returns true if the GROUP_U permission bit is set
# @return [true, false] true if the GROUP_U permission bit is set
def public?
if self['PERMISSIONS/GROUP_U'] == "1" || self['PERMISSIONS/OTHER_U'] == "1"
if self['PERMISSIONS/GROUP_U'] == '1' || self['PERMISSIONS/OTHER_U'] == '1'
true
else
false
@ -249,10 +249,10 @@ module OpenNebula
end
def document_type
self.class::DOCUMENT_TYPE
self['TYPE'].to_i
end
private
private
def set_publish(published)
group_u = published ? 1 : 0
@ -260,7 +260,7 @@ module OpenNebula
chmod(-1, -1, -1, group_u, -1, -1, -1, -1, -1)
end
def check_type()
def check_type
type = self['TYPE']
if type.nil? && @pe_id
@ -274,12 +274,15 @@ module OpenNebula
type = xmldoc['TYPE']
end
if !type.nil? && type.to_i != document_type
if !type.nil? && document_type != self.class::DOCUMENT_TYPE
return OpenNebula::Error.new(
"[DocumentInfo] Error getting document [#{@pe_id}].")
"[DocumentInfo] Error getting document [#{@pe_id}]."
)
end
return nil
return
end
end
end

View File

@ -41,7 +41,7 @@ module OpenNebula
#######################################################################
DOCUMENT_POOL_METHODS = {
:info => "documentpool.info"
:info => 'documentpool.info'
}
#######################################################################
@ -55,10 +55,10 @@ module OpenNebula
# http://docs.opennebula.io/stable/integration/system_interfaces/api.html
#
# @return [DocumentPool] the new object
def initialize(client, user_id=-1)
super('DOCUMENT_POOL','DOCUMENT',client)
def initialize(client, user_id = -1)
super('DOCUMENT_POOL', 'DOCUMENT', client)
@user_id = user_id
@user_id = user_id
end
#######################################################################
@ -71,32 +71,32 @@ module OpenNebula
# otherwise
def info(*args)
case args.size
when 0
info_filter(DOCUMENT_POOL_METHODS[:info],@user_id,-1,-1, document_type)
when 3
info_filter(DOCUMENT_POOL_METHODS[:info],args[0],args[1],args[2], document_type)
when 0
info_filter(DOCUMENT_POOL_METHODS[:info], @user_id, -1, -1,
self.class::DOCUMENT_TYPE)
when 3
info_filter(DOCUMENT_POOL_METHODS[:info], args[0], args[1], args[2],
self.class::DOCUMENT_TYPE)
end
end
def info_all()
return super(DOCUMENT_POOL_METHODS[:info], document_type)
def info_all
return super(DOCUMENT_POOL_METHODS[:info], self.class::DOCUMENT_TYPE)
end
def info_mine()
return super(DOCUMENT_POOL_METHODS[:info], document_type)
def info_mine
return super(DOCUMENT_POOL_METHODS[:info], self.class::DOCUMENT_TYPE)
end
def info_group()
return super(DOCUMENT_POOL_METHODS[:info], document_type)
def info_group
return super(DOCUMENT_POOL_METHODS[:info], self.class::DOCUMENT_TYPE)
end
alias_method :info!, :info
alias_method :info_all!, :info_all
alias_method :info_mine!, :info_mine
alias_method :info_group!, :info_group
alias info! info
alias info_all! info_all
alias info_mine! info_mine
alias info_group! info_group
def document_type
self.class::DOCUMENT_TYPE
end
end
end