omf_sfa 0.1.1

data/lib/omf-sfa/model/ontology.rb

@@ -0,0 +1,169 @@
+
+# This file is parsing OWL and RDF files and is generating data 
+# modesl from it.
+#
+require 'nokogiri'   
+require "omf_common/lobject"
+
+
+module OMF; module SFA; end end
+
+require 'omf-sfa/model/model_class_description'
+require 'omf-sfa/model/model_obj_prop_description'
+require 'omf-sfa/model/model_data_prop_description'
+
+module OMF::SFA
+  module Model
+    
+    OWL_NS = "http://www.w3.org/2002/07/owl#"
+    RDF_NS = "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+    
+    #
+    # Return a fully qualified name. Specifically, if +name+
+    # starts with '#', the default namespace of +context_el+ is
+    # going to prepended.
+    #
+    def xml_full_name(name, context_el)
+      if name.start_with? '#'
+        name = context_el.namespaces["xmlns"] + name
+        name.gsub!('##', '#') # remove '##' if ns also ends in '#'
+      end
+      name
+    end
+    
+    class Ontology < OMF::Base::LObject
+      
+      # URL prefix which we serve from local directory
+      LOCAL_PREFIX = 'http://geni-orca.renci.org/owl/'
+      LOCAL_DIR = "#{File.dirname(__FILE__)}/../../../owl/"
+      
+      @@uri2inst = {}
+      
+      def self.import(uri)
+        unless onto = @@uri2inst[uri]
+          info "Loading ontology '#{uri}'"
+          if uri.kind_of?(String) && uri.start_with?(LOCAL_PREFIX)
+            file_name = uri.gsub(LOCAL_PREFIX, LOCAL_DIR)
+            begin
+              onto = @@uri2inst[uri] = self.new(file_name, true)
+            rescue Errno::ENOENT
+              puts ">>>> Unknown ontology '#{uri}'"
+            end
+          else
+            raise "don't know how to import '#{uri}'"
+          end
+        end
+        onto
+      end
+      
+      def initialize(uri, is_file = false)
+        @uri = uri
+        if is_file
+          f = File.open(uri)
+          @doc = Nokogiri::XML(f) do |config|
+            config.strict.noent.noblanks
+          end
+          f.close
+        else
+          raise "don't know how to import '#{uri}'"          
+        end
+        
+        parse()
+      end
+      
+      def parse()
+        def_ns = @doc.namespaces["xmlns"]
+        
+        @doc.root.children.each do |el|
+          case el.node_name
+          when 'Ontology'
+            parse_onotology(el)
+          when 'Class'
+            ModelClassDescription.create_from_xml(el)
+          when 'comment'
+            # ignore
+          when 'ObjectProperty'
+            ModelObjectPropertyDescription.create_from_xml(el)
+          when 'DatatypeProperty'
+            ModelDataPropertyDescription.create_from_xml(el)
+          when 'AnnotationProperty'
+            # ignore
+          else
+            warn "Unknown element '#{el.node_name}' in '#{@uri}'"
+          end
+        end
+
+
+        # @doc.xpath('//owl:Class', 'owl' => OWL_NS).each do |cel|
+          # debug ModelClassDescription.create_from_xml(cel)
+          # #debug c.attribute_with_ns('about', RDF_NS)
+          # #debug c.namespaces["xmlns"].inspect #def_ns
+          # #debug c.inspect
+          # #exit
+        # end
+      end
+      
+      private
+      
+      # <owl:Ontology rdf:about="">
+          # <rdfs:label rdf:datatype="&xsd;string"
+              # >Collections v. 1.2</rdfs:label>
+          # <owl:versionInfo rdf:datatype="&xsd;string">1.2</owl:versionInfo>
+          # <dc:date rdf:datatype="&xsd;string"
+              # >January 14, 2009</dc:date>
+          # <dc:contributor rdf:datatype="&xsd;string">Marco Ocana</dc:contributor>
+          # <dc:contributor rdf:datatype="&xsd;string">Paolo Ciccarese</dc:contributor>
+          # <dc:format rdf:datatype="&xsd;string">rdf/xml</dc:format>
+          # <dc:language>en</dc:language>
+          # <dc:title xml:lang="en"
+              # >Collections ontology</dc:title>
+      # </owl:Ontology>
+      #
+      
+      def parse_onotology(el)
+        el.children.each do |el|
+          case el.node_name
+          when 'imports'
+            res = el.attribute_with_ns('resource', RDF_NS)
+            self.class.import(res.value)
+          else
+            #warn "Unknown eleement '#{el.node_name}' in 'owl:Ontology'"
+          end
+        end
+        
+      end
+    end
+  end # Model
+end # OMF::SFA
+
+if $0 == __FILE__
+  OMF::Base::Loggable.init_log 'owl'
+  include OMF::SFA::Model
+  
+  #f = "#{File.dirname(__FILE__)}/../../../owl/topology.owl"
+  
+  ['topology', 'domain', 'storage', 'compute'].each do |o|
+    u = "http://geni-orca.renci.org/owl/#{o}.owl"
+    Ontology.import(u)
+  end
+  
+  AbstractPropertyDescription.each do |p|
+    p.validate
+  end
+  
+  ModelClassDescription.each do |c|
+    c.validate
+  end
+  
+  roots = ModelClassDescription.models.select do |c|
+    c.superklass.nil?
+  end
+  
+  roots.each do |c|
+    c.describe
+  end
+  
+
+end
+
+  

data/lib/omf-sfa/resource/README.md

@@ -0,0 +1,24 @@
+@startuml
+hide members
+
+OResource <|-- OComponent
+OResource <|-- OGroup
+OGroup <|-- OAccount
+OResource <|-- OLease
+OResource <|-- OProject
+OResource <|-- User
+@enduml
+
+@startuml
+hide members
+
+OGroup "*" -- "*" OComponent : contains >
+OGroup "1" -- "*" OGroup : contains >
+OComponent "*" -- "1" OAccount : charged_to >
+OComponent "1" -- "*" OComponent : provided_by >
+OLease "*" -- "0,1" OComponent: < leased_by 
+OProject "1" -- "1" OAccount : account >
+OProject "*" -- "*" User: member > 
+OAccount "*" -- "1" OLease : holds_lease >
+OProject "*" -- "1" OProject: parent_project > 
+@enduml

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

@@ -0,0 +1,49 @@
+
+require 'omf-sfa/resource/ocomponent'
+
+module OMF::SFA::Resource
+
+  class Channel < OComponent
+
+    oproperty :interface, :interface, :functional => false
+    oproperty :number, Integer
+    oproperty :frequency, String
+
+    # we have already added that in olease
+    #sfa_add_namespace :ol, 'http://nitlab.inf.uth.gr/schema/sfa/rspec/1'
+
+    sfa_class 'channel', :namespace => :ol
+    sfa :number, :attribute => true
+    sfa :frequency, :attribute => true
+    sfa :interfaces, :inline => true, :has_many => true
+
+    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_ref' # should check namespace as well
+
+        unless client_id_attr = el.attributes['client_id']
+          raise "Expected 'client_id' attr in '#{el}'"
+        end
+        unless interface = context[client_id_attr.value]
+          raise "Referencing unknown interface '#{client_id_attr.value} in '#{el}'"
+        end
+        #puts "INTERFACE '#{client_id_attr.value}' => '#{interface}'"
+        self.interfaces << interface
+      end
+    end
+
+    # 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
+
+  end
+
+end # OMF::SFA

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

@@ -0,0 +1,41 @@
+
+
+require 'omf-sfa/resource/ogroup'
+require 'omf-sfa/resource/sfa_base'
+
+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>  
+  
+  # This class defines a group of resources which can be described through
+  # an extension of RSpec
+  #
+  class CompGroup < OGroup
+    extend OMF::SFA::Resource::Base::ClassMethods
+    include OMF::SFA::Resource::Base::InstanceMethods
+
+    sfa_class 'omf:group'
+
+    sfa :component_id, :attribute => true # "urn:publicid:IDN+plc:cornell+node+planetlab3-dsl.cs.cornell.edu" 
+    sfa :component_manager_id, :attribute => true # "urn:publicid:IDN+plc+authority+am" 
+    sfa :component_name, :attribute => true # "plane
+    
+    def to_sfa_xml(parent, obj2id = {}, opts = {})
+      gel = _to_sfa_xml(parent, obj2id, opts)
+      self.each_resource do |r|
+        puts "CHILD #{r}"
+        r.to_sfa_xml(gel, obj2id, opts)
+      end
+      parent
+    end    
+  end
+  
+end # OMF::SFA::Resource
+

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

@@ -0,0 +1,10 @@
+
+module OMF::SFA::Resource
+
+  class ComponentLease
+    include DataMapper::Resource
+
+    belongs_to :lease, :model => 'OLease', :key => true
+    belongs_to :component, :model => 'OComponent', :key => true
+  end
+end

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

@@ -0,0 +1,24 @@
+
+module OMF::SFA::Resource
+  module Constants
+    
+    @@default_domain = "omf:nitos"
+    @@default_component_manager_id = GURN.create("authority+am").to_s
+    
+    def self.default_domain=(dname)
+      @@default_domain = dname
+    end   
+    
+    def self.default_domain()
+      @@default_domain
+    end   
+    
+    def self.default_component_manager_id=(gurn)
+      @@default_component_manager_id = GURN.create(gurn).to_s 
+    end   
+
+    def self.default_component_manager_id()
+      @@default_component_manager_id
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+require 'omf-sfa/resource/ogroup'
+require 'omf-sfa/resource/sfa_base'
+
+module OMF::SFA::Resource
+  
+  # A +GroupComponent+ is a group with a component interface. This allows it
+  # to be addressed and used in an SFA context.
+  #
+  class GroupComponent < OGroup
+    extend OMF::SFA::Resource::Base::ClassMethods
+    include OMF::SFA::Resource::Base::InstanceMethods
+    
+    sfa_class 'group'
+    sfa :component_id, :attribute => true # "urn:publicid:IDN+plc:cornell+node+planetlab3-dsl.cs.cornell.edu" 
+    sfa :component_manager_id, :attribute => true # "urn:publicid:IDN+plc+authority+am" 
+    sfa :component_name, :attribute => true # "plane
+
+    sfa :components, :has_many => true, :include_level => 0 # only include components when top group
+    
+    def components
+      self.contains_resources
+    end
+    
+    def _to_sfa_components_property_hash(resources, pdef, href2obj, opts)
+      opts = opts.dup
+      # TODO: What was that used for? Does this assume that prefix include slice name?
+      #opts[:href_prefix] = (opts[:href_prefix] || '/') + 'resources/'
+      resources.collect do |o|
+        o.to_sfa_hash(href2obj, opts)
+      end
+    end
+
+  end
+  
+end # OMF::SFA::Resource

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

@@ -0,0 +1,17 @@
+
+
+module OMF::SFA::Resource
+  
+  # Provides a many-to-many relationship 
+  # between resources and groups
+  #
+  class GroupMembership
+    include DataMapper::Resource
+
+    belongs_to :o_resource
+    belongs_to :o_group
+    #has n, :groups
+    
+    property :id,   Serial    
+  end
+end

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

@@ -0,0 +1,187 @@
+
+require 'omf_base/lobject'
+
+module OMF::SFA::Resource
+#
+  class GURN #< OMF::Base::MObject
+
+    @@def_domain = 'omf:nitos'
+    @@name2obj = {}
+
+    # Create a GURN
+    #
+    # @param [String] name Name of GURN
+    # @param [Hash] opts options to further describe GURN components
+    # @option opts [String] :type GURN's type
+    # @option opts [Class] :model Class responding to either :sfa_class or :urn_type
+    # @option opts [String] :domain GURN's domain
+    #
+    def self.create(name, opts = {})
+      return name if name.kind_of? self
+      #puts "GUID: #{name}###{opts}"
+
+      obj = @@name2obj[name]
+      return obj if obj
+
+      if name.start_with?('urn')
+        return parse(name)
+      end
+
+      unless type = opts[:type]
+        model = opts[:model]
+        if model && model.respond_to?(:sfa_class)
+          type =  model.sfa_class
+        elsif model && model.respond_to?(:resource_type)
+          type =  model.resource_type
+        end
+      end
+      domain = opts[:domain] || @@def_domain
+      return @@name2obj[name] = self.new(name, type, domain)
+    end
+
+    def self.sfa_create(name, context = nil)
+      return create(name, :model => context)
+    end
+
+    # Create a GURN object from +urn_str+.
+    #
+    def self.parse(urn_str)
+      if urn_str.start_with? 'urn:publicid:IDN'
+        a = urn_str.split('+')
+        a.delete_at(0) # get rid of "urn:publicid:IDN"
+        if a.length == 3
+          prefix, type, name = a
+        elsif a.length == 2
+          prefix, name = a
+          type = nil
+        else
+          raise "unknown format '#{urn_str}' for GURN (#{a.inspect})."
+        end
+        @@name2obj[urn_str] = self.new(name, type, prefix)
+      else
+        raise "unknown format '#{urn_str}' for GURN - expected it to start with 'urn:publicid:IDN'."
+      end
+    end
+
+    def self.default_domain=(domain)
+      @@def_domain = domain
+    end
+
+    def self.default_domain()
+      @@def_domain
+    end
+
+    # This class maintains a cache between object name and it's GURN.
+    # As this may get in the way of testing, this method provides a way
+    # of clear that cache
+    #
+    def self.clear_cache
+      @@name2obj.clear
+    end
+
+    attr_reader :name, :short_name, :type, :domain, :urn
+
+    def initialize(short_name, type = nil, domain = nil)
+      @short_name = short_name
+      @domain = domain || @@def_domain
+      if type
+        @type =  type
+        @name = "#{@domain}+#{type}+#{short_name}"
+      else
+        @name = "#{@domain}+#{short_name}"
+      end
+      @urn = 'urn:publicid:IDN+' + name
+    end
+
+    def uuid
+      unless @uuid
+        @uuid = UUIDTools::UUID.parse(short_name)
+      end
+      @uuid
+    rescue ArgumentError
+      @uuid = nil
+    end
+
+    def to_s
+      @urn
+    end
+
+  end # GURN
+end # OMF::SFA
+
+require 'dm-core'
+
+module DataMapper
+  class Property
+    class GURN < DataMapper::Property::String
+
+      # Maximum length chosen based on recommendation:
+      length 256
+
+      def custom?
+        true
+      end
+
+      def primitive?(value)
+        value.kind_of?(OMF::SFA::Resource::GURN)
+      end
+
+      def valid?(value, negated = false)
+        super || primitive?(value) #|| value.kind_of?(::String)
+      end
+
+      # We don't want this to be called, but the Model::Property calls
+      # this one first before calling #set! on this instance again with
+      # the value returned here. Hopefully this is the only place this
+      # happens. Therefore, we just return +value+ unchanged and take care
+      # of casting in +load2+
+      #
+      def load(value)
+        if value
+          if value.start_with?('urn')
+            return OMF::SFA::Resource::GURN.create(value)
+          end
+          raise "BUG: Shouldn't be called anymore (#{value})"
+        end
+        nil
+      end
+
+      def load2(value, context_class)
+        if value
+          #puts "LOAD #{value}||#{value.class}||#{context.inspect}"
+          return OMF::SFA::Resource::GURN.create(value, context_class)
+        end
+        nil
+      end
+
+      def dump(value)
+        value.to_s unless value.nil?
+      end
+
+      # Typecasts an arbitrary value to a GURN
+      #
+      # @param [Hash, #to_mash, #to_s] value
+      #   value to be typecast
+      #
+      # @return [GURN]
+      #   GURN constructed from value
+      #
+      # @api private
+      def typecast_to_primitive(value)
+        raise "BUG: Shouldn't be called anymore"
+      end
+
+      # @override
+      def set(resource, value)
+        #puts ">>> SET: #{resource}"
+        set!(resource, load2(value, resource.class))
+      end
+
+
+
+    end # class GURN
+  end # class Property
+end #module DataMapper
+
+
+

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

@@ -0,0 +1,78 @@
+require 'omf-sfa/resource/ocomponent'
+require 'omf-sfa/resource/ip'
+
+module OMF::SFA::Resource
+
+  class Interface < OComponent
+
+    #property :hardware_type, String
+    oproperty :role, String
+    oproperty :node, :node
+    oproperty :channel, :channel
+    oproperty :ip_addresses, OMF::SFA::Resource::Ip, :functional => false
+
+    has 1, :ip
+
+    def sliver
+      node.sliver
+    end
+
+    sfa_class 'interface'
+
+    #sfa :hardware_type, String, :attr_value => :name, :has_many => true
+    #sfa :public_ipv4, :ip4, :attribute => true
+    sfa :role, :attribute => true
+    sfa :ip
+
+    # @see IComponent
+    #
+    def independent_component?
+      false
+    end
+
+    def to_sfa_ref_xml(res_el, obj2id, opts)
+      if obj2id.key?(self)
+        el = res_el.add_child(Nokogiri::XML::Element.new('interface_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
+
+    #Override xml serialization of 'ip'
+    def _to_sfa_property_xml(pname, value, res_el, pdef, obj2id, opts)
+      if pname == 'ip'
+        value.to_sfa_xml(res_el, obj2id, opts)
+        return
+      end
+      super
+    end
+
+    def _from_sfa_ip_property_xml(resource_el, props, context)
+      resource_el.children.each do |el|
+        next unless el.is_a? Nokogiri::XML::Element
+        next unless el.name == 'ip' # should check namespace as well
+
+        unless address_attr = el.attributes['address']
+          raise "Expected 'address' attr for ip in '#{el}'"
+        end
+        address = address_attr.value
+        ip = self.ip_addresses.find do |r|
+          r.address == address
+        end
+        unless ip
+          # doesn't exist yet, create new one
+          ip = Ip.new(:interface => self)
+        end
+        #puts "IP -----"
+        ip.from_sfa(el)
+        #puts "IP '#{ip.inspect}'"
+        self.ip_addresses << ip
+      end
+    end
+
+
+  end # Interface
+
+end # OMF::SFA::Resource

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

@@ -0,0 +1,48 @@
+require 'omf-sfa/resource/sfa_base'
+
+module OMF::SFA::Resource
+
+  class Ip < OResource
+
+    oproperty :address, String
+    oproperty :netmask, String
+    oproperty :ip_type, String
+
+    belongs_to :interface, :required => false
+
+    extend OMF::SFA::Resource::Base::ClassMethods
+    include OMF::SFA::Resource::Base::InstanceMethods
+
+    sfa_class 'ip_address'
+    sfa :address, :attribute => true
+    sfa :netmask, :attribute => true
+    sfa :ip_type, :attribute => true, :attribute_name => 'type' # we need to override 'type' with 'ip_type' because there is conflict with 'type' property of OResource
+
+    # override xml serialization of "ip_type" to "type"
+    def _to_sfa_property_xml(pname, value, res_el, pdef, obj2id, opts)
+      if pname == 'ip_type'
+        res_el.set_attribute('type', value.to_s)
+      else
+        super
+      end
+    end
+
+    # def _from_sfa_ip_type_property_xml(resource_el, props, context)
+      # puts ">>>>> ADDRESSE #{resource_el}"
+    # end
+
+    def to_hash(objs = {}, opts = {})
+      h = {}
+      uuid = h[:uuid] = self.uuid.to_s
+      objs[self] = true
+      to_hash_long(h, objs.merge(brief: true), opts)
+      h
+    end
+
+    def to_hash_brief(opts = {})
+      to_hash(opts)
+    end
+  end
+
+end # OMF::SFA::Resource
+