occi-core 4.3.6 → 5.0.0.alpha.1

data/lib/occi/core/resource.rb

@@ -1,82 +1,118 @@
 module Occi
   module Core
-    class Resource < Occi::Core::Entity
-
-      attr_accessor :links
+    # Implements the base class for all OCCI resources, this
+    # class can be used directly to create resource instances.
+    #
+    # @attr links [Set] set of links associated with this resource instance
+    # @attr summary [String] simple human-readable description of this resource instance
+    #
+    # @author Boris Parak <parak@cesnet.cz>
+    class Resource < Entity
+      attr_reader :links
+
+      # @return [String] resource summary
+      def summary
+        self['occi.core.summary']
+      end
 
-      self.attributes = Occi::Core::Attributes.new(Occi::Core::Entity.attributes)
+      # @param summary [String] resource summary
+      def summary=(summary)
+        self['occi.core.summary'] = summary
+      end
 
-      self.attributes['occi.core.summary'] = {:mutable => true}
+      # @param links [Set] set of links
+      def links=(links)
+        unless links
+          raise Occi::Core::Errors::InstanceValidationError,
+                'Missing valid links'
+        end
+        @links ||= Set.new
+        @links.each { |l| remove_link(l) }
+        links.each { |l| add_link(l) }
+
+        @links
+      end
 
-      self.kind = Occi::Core::Kind.new scheme='http://schemas.ogf.org/occi/core#',
-                                       term='resource',
-                                       title='resource',
-                                       attributes=self.attributes,
-                                       parent=Occi::Core::Entity.kind
+      # :nodoc:
+      def <<(object)
+        case object
+        when Occi::Core::Link
+          add_link(object)
+          return self
+        end
 
-      # @param [String] kind
-      # @param [Array] mixins
-      # @param [Occi::Core::Attributes,Hash] attributes
-      # @param [Array] links
-      # @return [Occi::Core::Resource]
-      def initialize(kind=self.kind, mixins=[], attributes={}, actions=[], links=[], location=nil)
-        super(kind, mixins, attributes, actions, location)
-        @links = Occi::Core::Links.new(links)
+        super
       end
 
-      def model=(model)
-        super model
-        @links.model = model
-      end
+      # :nodoc:
+      def remove(object)
+        case object
+        when Occi::Core::Link
+          remove_link(object)
+          return self
+        end
 
-      # @return [String] summary attribute of the resource
-      def summary
-        self.attributes.occi_.core_.summary
+        super
       end
 
-      # set summary attribute of resource
-      # @param [String] summary
-      def summary=(summary)
-        self.attributes.occi!.core!.summary = summary
+      # Adds the given link to this instance.
+      #
+      # @param link [Occi::Core::Link] link to be added
+      def add_link(link)
+        unless link
+          raise Occi::Core::Errors::MandatoryArgumentError,
+                'Cannot add a non-existent link'
+        end
+        link.source = location
+        link.source_kind = kind
+        links << link
       end
 
-      def link(target, kind=Occi::Core::Link.kind, mixins=[], attributes=Occi::Core::Attributes.new, rel=Occi::Core::Resource.type_identifier)
-        link = kind.entity_type.new
+      # Removes the given link from this instance.
+      #
+      # @param link [Occi::Core::Link] link to be removed
+      def remove_link(link)
+        unless link
+          raise Occi::Core::Errors::MandatoryArgumentError,
+                'Cannot remove a non-existent link'
+        end
+        link.source = nil
+        link.source_kind = nil
+        links.delete link
+      end
 
-        link.rel = rel
-        link.attributes = attributes
-        link.id ||= UUIDTools::UUID.random_create.to_s
-        link.target = target
-        link.source = self
-        link.mixins = mixins
+      # See `#valid!` on `Occi::Core::Entity`.
+      def valid!
+        unless links
+          raise Occi::Core::Errors::InstanceValidationError,
+                'Missing valid links'
+        end
+        links.each(&:valid!)
+        super
+      end
 
-        @links << link
+      protected
 
-        link
+      # :nodoc:
+      def defaults
+        super.merge(links: Set.new, summary: nil)
       end
 
-      # @return [String] text representation
-      def to_text
-        text = super
-        @links.each { |link| text << "\n#{link.to_text_link}" }
-        text
-      end
+      # :nodoc:
+      def sufficient_args!(args)
+        super
 
-      # @return [Hash] hash containing the HTTP headers of the text/occi rendering
-      def to_header
-        header = super
-        header['Link'] = @links.collect {|link| link.to_string }.join(',') if @links.any?
-        header
+        return unless args[:links].nil?
+        raise Occi::Core::Errors::MandatoryArgumentError,
+              "Links is a mandatory argument for #{self.class}"
       end
 
-      # @param [Hash] options
-      # @return [Hashie::Mash] link as Hashie::Mash to be parsed into a JSON object
-      def as_json(options={})
-        resource = super
-        resource.links = @links.as_json if @links.any?
-        resource
+      # :nodoc:
+      def post_initialize(args)
+        super
+        self.links = args.fetch(:links)
+        self.summary = args.fetch(:summary) if attributes['occi.core.summary']
       end
-
     end
   end
 end

data/lib/occi/core/version.rb

@@ -0,0 +1,17 @@
+module Occi
+  module Core
+    MAJOR_VERSION = 5                # Major update constant
+    MINOR_VERSION = 0                # Minor update constant
+    PATCH_VERSION = 0                # Patch/Fix version constant
+    STAGE_VERSION = 'alpha.1'.freeze # use `nil` for production releases
+
+    unless defined?(::Occi::Core::VERSION)
+      VERSION = [
+        MAJOR_VERSION,
+        MINOR_VERSION,
+        PATCH_VERSION,
+        STAGE_VERSION
+      ].compact.join('.').freeze
+    end
+  end
+end

data/lib/occi/core/warehouse/kinds/attributes/occi.core.id.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/class String
+required: true
+mutable: false
+default: ~
+description: Identifier assigned to this entity sub-type instance.
+pattern: !ruby/regexp '/^[[:alnum:]]([[:alnum:]]|-|_)*$/'

data/lib/occi/core/warehouse/kinds/attributes/occi.core.source.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/module URI
+required: true
+mutable: true
+default: ~
+description: Source resource sub-type instance of this link sub-type instance.
+pattern: ~

data/lib/occi/core/warehouse/kinds/attributes/occi.core.summary.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/class String
+required: false
+mutable: true
+default: ~
+description: Brief textual description of this entity sub-type instance.
+pattern: !ruby/regexp '/^.*$/'

data/lib/occi/core/warehouse/kinds/attributes/occi.core.target.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/module URI
+required: true
+mutable: true
+default: ~
+description: Target resource sub-type instance of this link sub-type instance.
+pattern: ~

data/lib/occi/core/warehouse/kinds/attributes/occi.core.title.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/class String
+required: false
+mutable: true
+default: ~
+description: Title assigned to this entity sub-type instance.
+pattern: !ruby/regexp '/^[[:word:]]([[:blank:]]|[[:word:]]|\-)*$/'

data/lib/occi/core/warehouse/kinds/entity.yml

@@ -0,0 +1,10 @@
+---
+term: entity
+schema: http://schemas.ogf.org/occi/core#
+title: OCCI Core Entity
+parent: ~
+location: /entity/
+attributes:
+  - occi.core.id
+  - occi.core.title
+actions: []

data/lib/occi/core/warehouse/kinds/link.yml

@@ -0,0 +1,10 @@
+---
+term: link
+schema: http://schemas.ogf.org/occi/core#
+title: OCCI Core Link
+parent: http://schemas.ogf.org/occi/core#entity
+location: /link/
+attributes:
+  - occi.core.source
+  - occi.core.target
+actions: []

data/lib/occi/core/warehouse/kinds/resource.yml

@@ -0,0 +1,9 @@
+---
+term: resource
+schema: http://schemas.ogf.org/occi/core#
+title: OCCI Core Resource
+parent: http://schemas.ogf.org/occi/core#entity
+location: /resource/
+attributes:
+  - occi.core.summary
+actions: []

data/lib/occi/core/warehouse.rb

@@ -0,0 +1,115 @@
+module Occi
+  module Core
+    # Base loader for static categories defined in the OCCI Core Standard
+    # published by OGF's OCCI WG. This warehouse is meant to be used as a
+    # quick bootstrap tools for `Occi::Core::Model` instances.
+    #
+    # @author Boris Parak <parak@cesnet.cz>
+    class Warehouse
+      include Yell::Loggable
+
+      # YAML DIR constants
+      BASE    = 'warehouse'.freeze
+      KINDS   = 'kinds'.freeze
+      ACTIONS = 'actions'.freeze
+      MIXINS  = 'mixins'.freeze
+      ATTRIBS = 'attributes'.freeze
+
+      # YAML file pattern
+      FILE_SUFFIX = '.yml'.freeze
+      YAML_GLOB   = "*#{FILE_SUFFIX}".freeze
+
+      class << self
+        # Bootstraps the given model instance with pre-defined category
+        # instances.
+        #
+        # @example
+        #    model = Occi::Core::Model.new
+        #    Occi::Core::Warehouse.bootstrap! model
+        #
+        # @param model [Occi::Core::Model] model to be bootstrapped
+        def bootstrap!(model)
+          actions! model
+          kinds! model
+          mixins! model
+          nil # TODO: return something sensible
+        end
+
+        protected
+
+        # :nodoc:
+        def whereami
+          File.expand_path(File.dirname(__FILE__))
+        end
+
+        # :nodoc:
+        def warehouse_path
+          File.join(whereami, BASE)
+        end
+
+        # :nodoc:
+        def kinds_path
+          File.join(warehouse_path, KINDS)
+        end
+
+        # :nodoc:
+        def actions_path
+          File.join(warehouse_path, ACTIONS)
+        end
+
+        # :nodoc:
+        def mixins_path
+          File.join(warehouse_path, MIXINS)
+        end
+
+        # :nodoc:
+        def kinds!(model)
+          attribute_definitions = attribute_definitions_for(kinds_path)
+          yamls_in(kinds_path).each do |file|
+            model << Occi::Core::Kind.from_yaml(file, model, attribute_definitions)
+          end
+        end
+
+        # :nodoc:
+        def mixins!(model)
+          attribute_definitions = attribute_definitions_for(mixins_path)
+          yamls_in(mixins_path).each do |file|
+            model << Occi::Core::Mixin.from_yaml(file, model, attribute_definitions)
+          end
+        end
+
+        # :nodoc:
+        def actions!(model)
+          # TODO: work with separate attribute definitions
+          attribute_definitions = {}
+          yamls_in(actions_path).each do |file|
+            model << Occi::Core::Action.from_yaml(file, model, attribute_definitions)
+          end
+        end
+
+        # :nodoc:
+        def attribute_definitions_for(categories_path)
+          attribute_definitions = {}
+
+          attr_defs_path = File.join(categories_path, ATTRIBS)
+          yamls_in(attr_defs_path).each do |file|
+            name = attribute_name_from(file)
+            attribute_definitions[name] = Occi::Core::AttributeDefinition.from_yaml(file)
+          end
+
+          attribute_definitions
+        end
+
+        # :nodoc:
+        def attribute_name_from(path)
+          path.split(File::SEPARATOR).last.gsub(FILE_SUFFIX, '')
+        end
+
+        # :nodoc:
+        def yamls_in(path)
+          Dir[File.join(path, YAML_GLOB)].sort
+        end
+      end
+    end
+  end
+end

data/lib/occi/core.rb

@@ -1,30 +1,66 @@
-require 'occi/core/properties'
-require 'occi/core/attributes'
-require 'occi/core/category'
-require 'occi/core/categories'
-require 'occi/core/kind'
-require 'occi/core/kinds'
-require 'occi/core/mixin'
-require 'occi/core/mixins'
-require 'occi/core/dependencies'
-require 'occi/core/action'
-require 'occi/core/action_instance'
-require 'occi/core/actions'
-require 'occi/core/entities'
-require 'occi/core/entity'
-require 'occi/core/link'
-require 'occi/core/links'
-require 'occi/core/resource'
-require 'occi/core/resources'
+# external deps
+require 'active_support/all'
+require 'uri'
+require 'yaml'
+require 'ipaddr'
+require 'singleton'
+require 'yell'
+require 'json'
+require 'json-schema'
 
+# Contains all OCCI-related classes and modules. This module
+# does not provide any additional functionality aside from
+# acting as a wrapper and a namespace-defining mechanisms.
+# Please, defer to specific classes and modules within this
+# namespace for details and functionality descriptions.
+#
+# @author Boris Parak <parak@cesnet.cz>
 module Occi
+  # Contains all OCCI-Core-related classes and modules. This
+  # module does not provide any additional functionality aside
+  # from acting as a wrapped, a namespace-defining mechanism,
+  # and versioning wrapper. Please, defer to specific classes
+  # and modules within this namespace for details and
+  # functionality descriptions.
+  #
+  # @example
+  #   Occi::Core::VERSION       # => '5.0.0.alpha.1'
+  #   Occi::Core::MAJOR_VERSION # => 5
+  #   Occi::Core::MINOR_VERSION # => 0
+  #   Occi::Core::PATCH_VERSION # => 0
+  #   Occi::Core::STAGE_VERSION # => 'alpha.1'
+  #
+  # @author Boris Parak <parak@cesnet.cz>
   module Core
+    autoload :Constants, 'occi/core/constants'
+    autoload :Errors, 'occi/core/errors'
+    autoload :Renderers, 'occi/core/renderers'
+    autoload :Helpers, 'occi/core/helpers'
+    autoload :Parsers, 'occi/core/parsers'
+    autoload :RendererFactory, 'occi/core/renderer_factory'
 
-    extend Occi
+    autoload :AttributeDefinition, 'occi/core/attribute_definition'
+    autoload :Category, 'occi/core/category'
+    autoload :Kind, 'occi/core/kind'
+    autoload :Action, 'occi/core/action'
+    autoload :Mixin, 'occi/core/mixin'
 
-    def self.kinds
-      Occi::Core::Kinds.new << Occi::Core::Entity.kind << Occi::Core::Link.kind << Occi::Core::Resource.kind
-    end
+    autoload :Attribute, 'occi/core/attribute'
+    autoload :ActionInstance, 'occi/core/action_instance'
+    autoload :Entity, 'occi/core/entity'
+    autoload :Link, 'occi/core/link'
+    autoload :Resource, 'occi/core/resource'
 
+    autoload :Collection, 'occi/core/collection'
+    autoload :Model, 'occi/core/model'
+    autoload :Warehouse, 'occi/core/warehouse'
+    autoload :InstanceBuilder, 'occi/core/instance_builder'
   end
-end
+end
+
+# Explicitly load monkey patches
+require 'occi/monkey_island/boolean'
+require 'occi/monkey_island/hash'
+
+# Explicitly pull in versioning information
+require 'occi/core/version'

data/lib/occi/infrastructure/compute.rb

@@ -1,126 +1,9 @@
 module Occi
   module Infrastructure
-    class Compute < Occi::Core::Resource
-
-      start = Occi::Core::Action.new scheme='http://schemas.ogf.org/occi/infrastructure/compute/action#',
-                                     term='start',
-                                     title='start compute instance'
-
-      stop = Occi::Core::Action.new scheme='http://schemas.ogf.org/occi/infrastructure/compute/action#',
-                                    term='stop',
-                                    title='stop compute instance'
-      stop.attributes['method'] = {:mutable => true,
-                                   :pattern => 'graceful|acpioff|poweroff',
-                                   :default => 'poweroff'}
-
-      restart = Occi::Core::Action.new scheme='http://schemas.ogf.org/occi/infrastructure/compute/action#',
-                                       term='restart',
-                                       title='restart compute instance'
-      restart.attributes['method'] = {:mutable => true,
-                                      :pattern => 'graceful|warm|cold',
-                                      :default => 'cold'}
-
-      suspend = Occi::Core::Action.new scheme='http://schemas.ogf.org/occi/infrastructure/compute/action#',
-                                       term='suspend',
-                                       title='suspend compute instance'
-      suspend.attributes['method'] = {:mutable => true,
-                                     :pattern => 'hibernate|suspend',
-                                     :default => 'suspend'}
-
-      self.actions = Occi::Core::Actions.new << start << stop << restart << suspend
-
-      self.attributes = Occi::Core::Attributes.new(Occi::Core::Resource.attributes)
-      self.attributes['occi.compute.architecture'] = {:mutable => true,
-                                                      :pattern => 'x86|x64'}
-      self.attributes['occi.compute.cores'] = {:type => 'number',
-                                               :mutable => true}
-      self.attributes['occi.compute.hostname'] = {:mutable => true,
-                                                  :pattern => '(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*'}
-      self.attributes['occi.compute.memory'] = {:type => 'number',
-                                                :mutable => true}
-      self.attributes['occi.compute.speed'] = {:type => 'number',
-                                                :mutable => true}
-      self.attributes['occi.compute.state'] = {:type => 'string',
-                                               :pattern => 'inactive|active|suspended|error',
-                                               :default => 'inactive',
-                                               :mutable => false}
-
-      self.kind = Occi::Core::Kind.new scheme='http://schemas.ogf.org/occi/infrastructure#',
-                                       term='compute',
-                                       title = 'compute resource',
-                                       attributes=Occi::Core::Attributes.new(self.attributes),
-                                       parent=Occi::Core::Resource.kind,
-                                       actions = Occi::Core::Actions.new(self.actions),
-                                       location = '/compute/'
-
-      require 'occi/infrastructure/resource_tpl'
-      require 'occi/infrastructure/os_tpl'
-      self.mixins = Occi::Core::Mixins.new << Occi::Infrastructure::ResourceTpl.mixin << Occi::Infrastructure::OsTpl.mixin
-
-      def architecture
-        @attributes.occi_.compute_.architecture
-      end
-
-      def architecture=(architecture)
-        @attributes.occi!.compute!.architecture = architecture
-      end
-
-      def cores
-        @attributes.occi_.compute_.cores
-      end
-
-      def cores=(cores)
-        @attributes.occi!.compute!.cores = cores
-      end
-
-      def hostname
-        @attributes.occi_.compute_.hostname
-      end
-
-      def hostname=(hostname)
-        @attributes.occi!.compute!.hostname = hostname
-      end
-
-      def speed
-        @attributes.occi_.compute_.speed
-      end
-
-      def speed=(speed)
-        @attributes.occi!.compute!.speed = speed
-      end
-
-      def memory
-        @attributes.occi_.compute_.memory
-      end
-
-      def memory=(memory)
-        @attributes.occi!.compute!.memory = memory
-      end
-
-      def state
-        @attributes.occi_.compute_.state
-      end
-
-      def state=(state)
-        @attributes.occi!.compute!.state = state
-      end
-
-      def storagelink(target, mixins=[], attributes=Occi::Core::Attributes.new, kind=Occi::Infrastructure::Storagelink.kind)
-        link(target, kind, mixins, attributes, rel=Occi::Infrastructure::Storage.type_identifier)
-      end
-
-      def networkinterface(target, mixins=[], attributes=Occi::Core::Attributes.new, kind=Occi::Infrastructure::Networkinterface.kind)
-        link(target, kind, mixins, attributes, rel=Occi::Infrastructure::Network.type_identifier)
-      end
-
-      def storagelinks
-        @links.select { |link| link.kind == Occi::Infrastructure::Storagelink.kind }
-      end
-
-      def networkinterfaces
-        @links.select { |link| link.kind == Occi::Infrastructure::Networkinterface.kind }
-      end
-
-    end
+    # Dummy sub-class of `Occi::Core::Resource` meant to simplify handling
+    # of known instances of the given sub-class. Does not contain any functionality.
+    #
+    # @author Boris Parak <parak@cesnet.cz>
+    class Compute < Occi::Core::Resource; end
   end
 end

data/lib/occi/infrastructure/constants.rb

@@ -0,0 +1,25 @@
+module Occi
+  module Infrastructure
+    # Module containing important constats defined in OGF's Infrastructure document.
+    # Here, you can find commonly used kind identifiers for `Compute`, `Network`,
+    # `Storage`, and others.
+    #
+    # @author Boris Parak <parak@cesnet.cz>
+    module Constants
+      # Resource sub-types
+      COMPUTE_KIND        = 'http://schemas.ogf.org/occi/infrastructure#compute'.freeze
+      NETWORK_KIND        = 'http://schemas.ogf.org/occi/infrastructure#network'.freeze
+      STORAGE_KIND        = 'http://schemas.ogf.org/occi/infrastructure#storage'.freeze
+
+      # Link sub-types
+      NETWORKINTERFACE_KIND    = 'http://schemas.ogf.org/occi/infrastructure#networkinterface'.freeze
+      STORAGELINK_KIND         = 'http://schemas.ogf.org/occi/infrastructure#storagelink'.freeze
+
+      # Mixins
+      IPNETWORK_MIXIN          = 'http://schemas.ogf.org/occi/infrastructure/network#ipnetwork'.freeze
+      IPNETWORKINTERFACE_MIXIN = 'http://schemas.ogf.org/occi/infrastructure/networkinterface#ipnetworkinterface'.freeze
+      OS_TPL_MIXIN             = 'http://schemas.ogf.org/occi/infrastructure#os_tpl'.freeze
+      RESOURCE_TPL_MIXIN       = 'http://schemas.ogf.org/occi/infrastructure#resource_tpl'.freeze
+    end
+  end
+end