omf_sfa 0.1.1

data/lib/omf-sfa/resource/link.rb

@@ -0,0 +1,29 @@
+
+
+require 'omf-sfa/resource/channel'
+#require 'omf-sfa/resource/link_property'
+
+module OMF::SFA::Resource
+
+      # <link component_id="urn:publicid:IDN+emulab.net+link+link-pc102%3Aeth2-internet%3Aborder" component_name="link-pc102:eth2-internet:border">
+        # <component_manager name="urn:publicid:IDN+emulab.net+authority+cm"/>
+          # <interface_ref component_id="urn:publicid:IDN+emulab.net+interface+pc102:eth2"/>
+          # <interface_ref component_id="urn:publicid:IDN+emulab.net+interface+internet:border"/>
+        # <property capacity="100000" dest_id="urn:publicid:IDN+emulab.net+interface+internet:border" latency="0" packet_loss="0" source_id="urn:publicid:IDN+emulab.net+interface+pc102:eth2"/>
+        # <property capacity="100000" dest_id="urn:publicid:IDN+emulab.net+interface+pc102:eth2" latency="0" packet_loss="0" source_id="urn:publicid:IDN+emulab.net+interface+internet:border"/>
+          # <link_type name="ipv4"/>
+      # </link>
+
+  class Link < Channel
+
+    oproperty :link_type, String
+    #has 2, :interfaces
+
+    sfa_class 'link'
+    sfa :link_type, :content_attribute => :name
+    #sfa :properties, LinkProperty, :inline => true, :has_many => true
+
+  end
+
+end # OMF::SFA::Resource
+

data/lib/omf-sfa/resource/node.rb

@@ -0,0 +1,75 @@
+
+require 'omf-sfa/resource/ocomponent'
+require 'omf-sfa/resource/interface'
+
+module OMF::SFA::Resource
+
+  class Node < OComponent
+
+
+    oproperty :hardware_type, String, :required => false
+    oproperty :available, Boolean, :default => true
+    #oproperty :sliver_type, String, :required => false
+    oproperty :interfaces, :interface, :functional => false
+    oproperty :exclusive, Boolean, :default => true
+    #belongs_to :sliver
+
+    sfa_class 'node'
+    sfa :hardware_type, :inline => true, :has_many => true
+    sfa :available, :attr_value => 'now'  # <available now="true">
+    #sfa :sliver_type, :attr_value => 'name'
+    sfa :interfaces, :inline => true, :has_many => true
+#    sfa :exclusive, :attribute => true
+
+    # Override xml serialization of 'interface'
+    def _to_sfa_property_xml(pname, value, res_el, pdef, obj2id, opts)
+      if pname == 'interfaces'
+        value.each do |iface|
+          iface.to_sfa_ref_xml(res_el, obj2id, opts)
+        end
+        return
+      end
+      super
+    end
+
+    def _from_sfa_interfaces_property_xml(resource_el, props, context)
+      resource_el.children.each do |el|
+        next unless el.is_a? Nokogiri::XML::Element
+        next unless el.name == 'interface' # should check namespace as well
+        unless client_id_attr = el.attributes['client_id']
+          raise "Expected 'client_id' attr for interface in '#{el}'"
+        end
+        client_id = client_id_attr.value
+        interface = self.interfaces.find do |ifs|
+          ifs.name == client_id
+        end
+        unless interface
+          # doesn't exist yet, create new one
+          interface = context[client_id] = Interface.new(:name => client_id)
+        end
+        interface.from_sfa(el)
+        interface.node = self
+        #puts "INTERFACE '#{interface.inspect}'"
+        self.interfaces << interface
+      end
+    end
+
+    def xx_to_sfa_interfaces_property_hash(interfaces, pdef, href2obj, opts)
+      # opts = opts.dup
+      # opts[:href_prefix] = (opts[:href_prefix] || '/') + 'interfaces/'
+      #interfaces.collect do |o|
+      interfaces.map do |o|
+        puts "INTERFACE: #{o}"
+        #o.to_sfa_hash(href2obj, opts)
+        'hi'
+      end
+    end
+
+    before :save do
+      resource_type |= 'node'
+    end
+
+  end
+
+end # OMF::SFA
+

data/lib/omf-sfa/resource/oaccount.rb

@@ -0,0 +1,94 @@
+
+#require 'time'
+require 'omf-sfa/resource/oresource'
+require 'omf-sfa/resource/ocomponent'
+require 'omf-sfa/resource/project'
+
+module OMF::SFA::Resource
+
+  # This class represents a users or team's account. Each resource
+  # belongs to an account.
+  #
+  class OAccount < OGroup
+
+    @@def_duration = 100 * 86400 # 100 days
+
+    def self.default_duration=(duration)
+      @@def_duration = duration
+    end
+
+    def self.urn_type
+      'account'
+    end
+
+    oproperty :created_at, DataMapper::Property::Time
+    oproperty :valid_until, DataMapper::Property::Time
+    oproperty :closed_at, DataMapper::Property::Time
+
+
+    oproperty :project, :project, :inverse => :project
+    oproperty :active_components, :ocomponent, :functional => false, :inverse => :account
+    # has n, :active_components, :model => 'OResource', :child_key  => [ :account_id ] #, :required => false
+    # belongs_to :project, :required => false
+
+    def active?
+      return false unless self.closed_at.nil?
+
+      valid_until = self.valid_until
+      unless valid_until.kind_of? Time
+        valid_until = Time.parse(valid_until) # seem to not be returned as Time
+      end
+      if Time.now > valid_until
+        self.close()
+        return false
+      end
+      true
+    end
+
+    def closed?
+      ! active?
+    end
+
+    # Close account
+    def close
+      self.closed_at = Time.now
+      save
+    end
+
+    def initialize(*args)
+      super
+      props = Hash.new
+      args.each do |a|
+        props.merge!(a)
+      end
+      self.created_at = Time.now
+      if self.valid_until == nil
+        self.valid_until = Time.now + @@def_duration
+      end
+    end
+
+    def valid_until
+      v = oproperty_get(:valid_until)
+      if v && !v.kind_of?(Time)
+        oproperty_set(:valid_until, v = Time.parse(v))
+      end
+      v
+    end
+
+    def resource_type()
+      'account'
+    end
+
+    # def to_hash_long(h, objs, opts = {})
+      # super
+      # h[:sub_accounts] = h.delete(:resources)
+      # href_only = opts[:level] >= opts[:max_level]
+      # # h[:active_resources] = self.active_components.map do |r|
+        # # href_only ? r.href : r.to_hash(objs, opts)
+      # # end
+      # h
+    # end
+
+
+  end # OAccount
+end # OMF::SFA::Resource

data/lib/omf-sfa/resource/ocomponent.rb

@@ -0,0 +1,134 @@
+
+require 'omf-sfa/resource/oresource'
+require 'omf-sfa/resource/ogroup'
+require 'omf-sfa/resource/sfa_base'
+require 'omf-sfa/resource/olease'
+
+module OMF::SFA::Resource
+
+  # Components are resources with a management interface.
+  #
+  class OComponent < OResource
+
+    oproperty :domain, String #, readonly => true
+    oproperty :exclusive, DataMapper::Property::Boolean
+    oproperty :component_manager_gurn, OMF::SFA::Resource::GURN
+
+    # Status of component. Should be any of configuring, ready, failed, and unknown
+    oproperty :status, String, :default => 'unknown'
+
+    # Beside the set of 'physical' resources, most resources are actually provided
+    # by other resources. Currently we assume that to be a one-to-many relation and
+    # we maintain links in both directions (A.provides B; B.provided_by A).
+    #
+    oproperty :provides, self, :functional => false
+    oproperty :provided_by, self
+
+    oproperty :account, :account, :inverse => :active_components
+
+    has n, :component_leases, :child_key => [:component_id]
+    has n, :leases, :model => 'OLease', :through => :component_leases, :via => :lease
+
+    extend OMF::SFA::Resource::Base::ClassMethods
+    include OMF::SFA::Resource::Base::InstanceMethods
+
+    sfa_add_namespace :omf, 'http://schema.mytestbed.net/sfa/rspec/1'
+    #sfa_add_namespace :ol, 'http://nitlab.inf.uth.gr/schema/sfa/rspec/1'
+
+    sfa :component_id, :attribute => true, :prop_name => :urn # "urn:publicid:IDN+plc:cornell+node+planetlab3-dsl.cs.cornell.edu"
+
+    sfa :client_id, :attribute => true, :prop_name => :name
+    alias_method :client_id, :name
+
+    sfa :component_manager_id, :attribute => true, :prop_name => :component_manager_gurn # "urn:publicid:IDN+plc+authority+am"
+    sfa :component_name, :attribute => true # "plane
+    sfa :leases, :inline => true, :has_many => true
+
+    #def component_id
+    #  res = oproperty_get(:id)
+    #end
+
+    def component_name
+      # the name property may have the full component name including domain and type
+      self.name.split('+')[-1]
+    end
+
+    def update_from_xml(modifier_el, opts)
+      if modifier_el.children.length > 0
+        warn "'update_from_xml' not implememted '#{modifier_el}'"
+      end
+    end
+
+    def create_from_xml(modifier_el, opts)
+      if modifier_el.children.length > 0
+        warn "'update_from_xml' not implememted '#{modifier_el}'"
+      end
+    end
+
+    # Return true if this is an independent component or not. Independent
+    # components are listed as assignable, reservable resources, while
+    # dependent ones are are tied to some other resource and need to
+    # 'stick' with their master. Interface is such an example.
+    #
+    def independent_component?
+      true
+    end
+
+    # Override xml serialization of 'leases'
+    def _to_sfa_property_xml(pname, value, res_el, pdef, obj2id, opts)
+      if pname == 'leases'
+        value.each do |lease|
+          lease.to_sfa_ref_xml(res_el, obj2id, opts)
+        end
+        return
+      end
+      super
+    end
+
+
+    def clone
+      clone = super
+      # we don't want to clone the following attributes
+      # from the base resource
+      clone.provides = []
+      clone.component_leases = []
+      clone.leases = []
+      clone
+    end
+
+    def destroy
+      #debug "OCOMPONENT destroy #{self}"
+      if !self.provides.empty?
+        raise OMF::SFA::AM::MissingImplementationException.new("Don't know yet how to delete resource which still provides other resources")
+      end
+      provider = self.provided_by
+
+      if provider
+        pa = provider.provides
+        pa.delete self
+        provider.provides = pa
+        # This assumes that base resources can only provide one virtual resource
+        # TODO: This doesn't really test if the provider is a base resource
+        provider.available = true
+        provider.save
+      end
+
+      self.component_leases.each do |l|
+        # unlink the resource with all its leases
+        raise "Couldn't unlink resource with lease: #{l}" unless l.destroy
+      end
+
+      super
+    end
+
+    before :save do
+      self.urn = GURN.create(self.name, self)
+    end
+
+    def destroy!
+      #debug "OCOMPONENT destroy! #{self}"
+      #destroy #no need for this. OResource.destroy! will call OComponent.destroy -> OResource.destroy
+      super
+    end
+  end  # OComponent
+end # OMF::SFA::Resource

data/lib/omf-sfa/resource/ogroup.rb

@@ -0,0 +1,106 @@
+
+require 'set'
+require 'omf-sfa/resource/oresource'
+
+module OMF::SFA::Resource
+
+  # Groups contain other resources including other groups
+  #
+  class OGroup < OResource
+    #include DataMapper::Resource
+    #property :id,   Serial
+
+    has n, :group_memberships, :child_key => [ :group_id ]
+    has n, :contains_resources, OResource, :through => :group_memberships, :via => :o_resource
+
+    # Return true if this resource is a Group
+    def group?
+      true
+    end
+
+    # Unlink all resources within this group.
+    #
+    # Note: Maybe should trigger
+    # an event for those resources no longer belonging to any group
+    #
+    def empty_group
+      self.group_memberships.each {|m| m.destroy}
+    end
+
+    # Set membership to +member_a+. Removes any existing members which aren't listed
+    # in +member_a+.
+    #
+    def members=(member_a)
+      ms = member_a.to_set
+      self.group_memberships.each do |m|
+        unless ms.delete?(m.o_resource)
+          m.destroy # no longer member
+        end
+      end
+      # add remaining, new members
+      ms.each do |m| self.contains_resources << m end
+      self.contains_resources
+    end
+
+    def members
+      self.contains_resources
+    end
+
+    def add_members(member_a)
+      member_a.each do |r|
+        unless member?(r)
+          self.contains_resources << r
+        end
+      end
+    end
+
+    # Return true if +resource+ is a DIRECT member of this group
+    #
+    def member?(resource)
+      # NOTE: most likely very inefficient
+      self.group_memberships.first(:o_resource => resource) != nil
+    end
+
+    def each_resource(&block)
+      self.contains_resources().each &block
+    end
+
+    def resource_type
+      'group'
+    end
+
+    # Add this resource and all contained to +set+.
+    def all_resources(set = Set.new)
+      set << self
+      self.each_resource { |r| r.all_resources(set) }
+      set
+    end
+
+    def to_hash_long(h, objs, opts = {})
+      super
+      href_only = opts[:level] >= opts[:max_level]
+      h[:resources] = self.contains_resources.map do |r|
+        href_only ? r.href : r.to_hash(objs, opts)
+      end
+      h
+    end
+
+    # def to_hash(objs = {}, opts = {})
+      # already_described = objs.key?(self)
+      # h = super(objs, opts)
+      # return h if already_described
+#
+      # # if (prefix = opts[:href_prefix]) && ! self.name.start_with?('_')
+        # # opts = opts.dup
+        # # opts[:href_prefix] = "#{prefix}/#{self.name}"
+      # # end
+      # h[:resources] = self.contains_resources.collect do |r|
+        # #puts ">>> self: #{self} - child: #{r}"
+        # r.to_hash(objs, opts)
+      # end
+      # h
+    # end
+
+  end
+
+end # OMF::SFA

data/lib/omf-sfa/resource/olease.rb

@@ -0,0 +1,61 @@
+
+require 'omf-sfa/resource/oresource'
+require 'omf-sfa/resource/ocomponent'
+require 'omf-sfa/resource/component_lease'
+
+module OMF::SFA::Resource
+
+  class OLease < OResource
+
+    oproperty :valid_from, DataMapper::Property::Time
+    oproperty :valid_until, DataMapper::Property::Time
+    oproperty :status, DataMapper::Property::Enum[:pending, :accepted, :active, :past, :cancelled], :default => "pending"
+
+    has n, :component_leases, :child_key => [:lease_id]
+    has n, :components, :model => 'OComponent', :through => :component_leases, :via => :component
+
+    extend OMF::SFA::Resource::Base::ClassMethods
+    include OMF::SFA::Resource::Base::InstanceMethods
+
+    sfa_add_namespace :ol, 'http://nitlab.inf.uth.gr/schema/sfa/rspec/1'
+
+    sfa_class 'lease', :namespace => :ol
+    sfa :name, :attribute => true
+    #sfa :uuid, :attribute => true
+    sfa :valid_from, :attribute => true
+    sfa :valid_until, :attribute => true
+
+    [:pending, :accepted, :active, :past, :cancelled].each do |s|
+      define_method(s.to_s + '?') do
+        if self.status.eql?(s.to_s)
+          true
+        else
+          false
+        end
+      end
+    end
+
+#     def status
+# #       puts "status call"
+#       s = oproperty_get(:status)
+#       if s.nil?
+# #         puts "setting"
+#         oproperty_set(:status, "pending")
+#       else
+# #         puts "hmm"
+#         s
+#       end
+#     end
+
+    def to_sfa_ref_xml(res_el, obj2id, opts)
+      if obj2id.key?(self)
+        el = res_el.add_child(Nokogiri::XML::Element.new("ol:lease_ref", res_el.document))
+        #el.set_attribute('component_id', self.component_id.to_s)
+        el.set_attribute('id_ref', self.uuid.to_s)
+      else
+        self.to_sfa_xml(res_el, obj2id, opts)
+      end
+    end
+
+  end
+end

data/lib/omf-sfa/resource/oproperty.rb

@@ -0,0 +1,178 @@
+require 'omf-sfa/resource/oresource'
+require 'json'
+require 'time'
+
+# We use the JSON serialization for Time objecs from 'json/add/core' in order to avoid
+# the conflicts with the 'active_support/core_ext' which is included in 'omf_base'
+# and overrides Time objects serialization. We want 'JSON.load' to return actual Time
+# objects instead of Strings.
+#
+class Time
+  def to_json(*args)
+    {
+      JSON.create_id => self.class.name,
+      's' => tv_sec,
+      'n' => respond_to?(:tv_nsec) ? tv_nsec : tv_usec * 1000
+    }.to_json(*args)
+  end
+
+  def self.json_create(object)
+    if usec = object.delete('u') # used to be tv_usec -> tv_nsec
+      object['n'] = usec * 1000
+    end
+    if instance_methods.include?(:tv_nsec)
+      at(object['s'], Rational(object['n'], 1000))
+    else
+      at(object['s'], object['n'] / 1000)
+    end
+  end
+end
+
+raise "JSON deserialisation no longer working - require 'json' early" unless JSON.load(Time.now.to_json).is_a? Time
+
+module OMF::SFA::Resource
+
+  # Each resource will have a few properties.
+  #
+  #
+  class OProperty
+    include DataMapper::Resource
+    property :id,   Serial
+
+    property :name, String
+    property :value, String # actually serialized Object
+
+    belongs_to :o_resource
+
+    module ArrayProxy
+      def << (val)
+        if @on_set_block
+          val = @on_set_block.call(val)
+          return if val.nil?
+        end
+        @oproperty << val
+        @on_modified_block.call(val, true) if @on_add_block
+        super
+      end
+
+      def clear()
+        _remove { super }
+      end
+
+      def delete(obj)
+        _remove { super }
+      end
+
+      def delete_at(index)
+        _remove { super }
+      end
+
+      def delete_if(&block)
+        _remove { super }
+      end
+
+      # Callback to support 'reverse' operation
+      def on_modified(&block)
+        @on_modified_block = block
+      end
+
+      def on_set(&block)
+        @on_set_block = block
+      end
+
+      private
+      def _remove(&block)
+        old = self.dup
+        r = block.call()
+        removed = old - self
+        unless removed.empty?
+          if @on_remove_block
+            removed.each {|it| @on_modified_block.call(it, false) }
+          end
+          @oproperty.value = self
+        end
+        r
+      end
+    end
+
+    def value=(val)
+      attribute_set(:value, JSON.generate([val]))
+      save
+    end
+
+    def value()
+      js = attribute_get(:value)
+      # http://www.ruby-lang.org/en/news/2013/02/22/json-dos-cve-2013-0269/
+      val = JSON.load(js)[0]
+      #puts "VALUE: #{js.inspect}-#{val.inspect}-#{val.class}"
+      if val.kind_of? Array
+        val.tap {|v| v.extend(ArrayProxy).instance_variable_set(:@oproperty, self) }
+      end
+      val
+    end
+
+    def << (val)
+      v = attribute_get(:value)
+      v = JSON.load(v)[0]
+      v << val
+      attribute_set(:value, JSON.generate([v]))
+      save
+    end
+
+    #def value()
+    #  #puts "VALUE() @value_:'#{@value_.inspect}'"
+    #  unless @value_
+    #    js = attribute_get(:value)
+    #    puts "JS #{js.inspect}"
+    #    if js
+    #      @value_ = JSON.parse(js)[0]
+    #      if @value_.kind_of? Array
+    #        @old_value_ = @value_.dup
+    #      end
+    #    end
+    #  end
+    #  #puts "VALUE()2 @value_:'#{@value_.inspect}'"
+    #  @value_
+    #end
+
+    def valid?(context = :default)
+      self.name != nil #&& self.value != nil
+    end
+
+    # alias_method :_dirty_attributes, :dirty_attributes
+    # def dirty_attributes
+      # dirty = _dirty_attributes
+      # #puts "DIRTY ATTRIBUTE #{dirty.inspect}"
+      # dirty
+    # end
+
+    alias_method :_dirty_self?, :dirty_self?
+    def dirty_self?
+      #puts "#{object_id} DIRTY CHECK #{@value_dirty}"
+      return true if @value_dirty || _dirty_self?
+      if @old_value_
+        return @old_value_ != @value_
+      end
+      false
+    end
+
+    def to_s()
+      super() + " - name: #{self.name} value: #{self.value}"
+    end
+
+    #before :save do
+    #  #puts "SAVING BEFORE @value_dirty:'#{@value_dirty}', @old_value_:'#{@old_value_}', @value_:'#{@value_}'"
+    #  begin
+    #    if @value_dirty || (@old_value_ ? @old_value_ != @value_ : false)
+    #      attribute_set(:value, JSON.generate([@value_]))
+    #      @value_dirty = false
+    #    end
+    #  rescue Exception => ex
+    #    puts ">>>>>>>>> ERROR #{ex}"
+    #  end
+    #  #puts "SAVING AFTER @value_dirty:'#{@value_dirty}', @old_value_:'#{@old_value_}', @value_:'#{@value_}'"
+    #end
+
+  end # OProperty
+
+end # OMF::SFA::Resource

data/lib/omf-sfa/resource/oreference.rb

@@ -0,0 +1,15 @@
+
+require 'omf-sfa/resource/oresource'
+
+module OMF::SFA::Resource
+
+  # A reference to a resource held somewhere else.
+  #
+  class OReference < OResource
+    oproperty :href, String
+
+    def to_hash(objs = {}, opts = {})
+      self.href()
+    end
+  end
+end