occi-cli 4.0.0.alpha.2 → 4.0.0.alpha.3

data/README.md

@@ -14,8 +14,7 @@ Ruby
 
 The following setup is recommended
 
-* usage of the Ruby Version Manager
-* Ruby 1.9.3
+* Ruby 1.9.3+
 * RubyGems installed
 
 The following libraries / packages may be required to use rOCCI-cli
@@ -42,6 +41,8 @@ To install the most recent beta version
 
 ### Installation from source
 
+**Installation from source is intended for advanced users or developers only!**
+
 To use rOCCI-cli from source it is very much recommended to use RVM. [Install RVM](https://rvm.io/rvm/install/) with
 
     curl -L https://get.rvm.io | bash -s stable --ruby
@@ -53,8 +54,8 @@ To build and install the bleeding edge version from master
     git clone git://github.com/gwdg/rOCCI-cli.git
     cd rOCCI-cli
     rvm install ruby-1.9.3
-    rvm --create --ruby-version use 1.9.3@rOCCI-cli
-    bundle install --deployment
+    gem install bundler
+    bundle install
     rake install
 
 #### Java
@@ -63,8 +64,7 @@ To build a Java jar file from master use
 
     git clone git://github.com/gwdg/rOCCI-cli.git
     cd rOCCI-cli
-    rvm install jruby-1.7.1
-    rvm --create --ruby-version use jruby-1.7.1@rOCCI-cli
+    rvm install jruby-1.7.4
     gem install bundler
     bundle install
     warble
@@ -127,6 +127,12 @@ To delete a compute resource use
 Changelog
 ---------
 
+### Version 4.0
+* added extended support for OCCI-OS
+* updated human-readable output rendering
+* split the code into rOCCI-core, rOCCI-api and rOCCI-cli
+* internal changes, refactoring and some bugfixes
+
 ### Version 3.1
 * added basic OS Keystone support
 * added support for PKCS12 credentials for X.509 authN

data/bin/occi

@@ -21,6 +21,7 @@ require 'highline/import'
 require 'openssl'
 
 extend Occi::Api::Dsl
+extend Occi::Cli::Helpers
 
 # get arguments and validate/parse them to an ostruct
 options = Occi::Cli::OcciOpts.parse ARGV

data/lib/occi/cli/helpers.rb

@@ -1,149 +1,188 @@
 # a bunch of OCCI client helpers for bin/occi
+module Occi::Cli
+  module Helpers
+
+    def helper_list(options, output = nil)
+      found = []
+
+      if resource_types.include? options.resource
+        Occi::Log.debug "#{options.resource} is a resource type."
+        found = list options.resource
+      elsif mixin_types.include? options.resource
+        Occi::Log.debug "#{options.resource} is a mixin type."
+        found = mixins options.resource
+      else
+        Occi::Log.warn "I have no idea what #{options.resource} is ..."
+        raise "Unknown resource #{options.resource}, there is nothing to list here!"
+      end
 
-def helper_list(options, output = nil)
-  found = []
-
-  if resource_types.include? options.resource
-    Occi::Log.debug "#{options.resource} is a resource type."
-    found = list options.resource
-  elsif mixin_types.include? options.resource
-    Occi::Log.debug "#{options.resource} is a mixin type."
-    found = mixins options.resource
-  else
-    Occi::Log.warn "I have no idea what #{options.resource} is ..."
-    raise "Unknown resource #{options.resource}, there is nothing to list here!"
-  end
-
-  return found if output.nil?
+      return found if output.nil?
 
-  if Occi::Cli::ResourceOutputFactory.allowed_resource_types.include? options.resource.to_sym
-    puts output.format(found, :locations, options.resource.to_sym)
-  else
-    Occi::Log.warn "Not printing, the resource type is not supported!"
-  end
-end
+      if Occi::Cli::ResourceOutputFactory.allowed_resource_types.include? options.resource.to_sym
+        puts output.format(found, :locations, options.resource.to_sym)
+      else
+        Occi::Log.warn "Not printing, the resource type is not supported!"
+      end
+    end
 
-def helper_describe(options, output = nil)
-  found = []
+    def helper_describe(options, output = nil)
+      found = []
 
-  if resource_types.include?(options.resource) || options.resource.start_with?(options.endpoint) || options.resource.start_with?('/')
-    Occi::Log.debug "#{options.resource} is a resource type or an actual resource."
+      if resource_types.include?(options.resource) || options.resource.start_with?(options.endpoint) || options.resource.start_with?('/')
+        Occi::Log.debug "#{options.resource} is a resource type or an actual resource."
 
-    found = describe(options.resource)
-  elsif mixin_types.include? options.resource
-    Occi::Log.debug "#{options.resourcre} is a mixin type."
+        found = describe(options.resource)
+      elsif mixin_types.include? options.resource
+        Occi::Log.debug "#{options.resourcre} is a mixin type."
 
-    mixins(options.resource).each do |mxn|
-      mxn = mxn.split("#").last
-      found << mixin(mxn, options.resource, true)
-    end
-  elsif mixin_types.include? options.resource.split('#').first
-    Occi::Log.debug "#{options.resource} is a specific mixin type."
-
-    mxn_type,mxn = options.resource.split('#')
-    found << mixin(mxn, mxn_type, true)
-  else
-    Occi::Log.warn "I have no idea what #{options.resource} is ..."
-    raise "Unknown resource #{options.resource}, there is nothing to describe here!"
-  end
+        mixins(options.resource).each do |mxn|
+          mxn = mxn.split("#").last
+          found << mixin(mxn, options.resource, true)
+        end
+      elsif mixin_types.include? options.resource.split('#').first
+        Occi::Log.debug "#{options.resource} is a specific mixin type."
+
+        mxn_type,mxn = options.resource.split('#')
+        found << mixin(mxn, mxn_type, true)
+      else
+        Occi::Log.warn "I have no idea what #{options.resource} is ..."
+        raise "Unknown resource #{options.resource}, there is nothing to describe here!"
+      end
 
-  return found if output.nil?
-
-  if options.resource.start_with? options.endpoint
-    # resource contains full endpoint URI
-    # e.g., http://localhost:3300/network/adfgadf-daf5a6df4afadf-adfad65f4ad
-    resource_type = options.resource.split('/')[3].to_sym
-  elsif options.resource.start_with? '/'
-    # resource contains a path relative to endpoint URI
-    # e.g., /network/adfgadf-daf5a6df4afadf-adfad65f4ad
-    resource_type = options.resource.split('/')[1].to_sym
-  elsif mixin_types.include? options.resource.split('#').first
-    # resource contains a mixin with a type
-    # e.g., os_tpl#debian6
-    resource_type = options.resource.split('#').first.to_sym
-  else
-    # resource probably contains RAW resource_type
-    resource_type = options.resource.to_sym
-  end
+      return found if output.nil?
+
+      if options.resource.start_with? options.endpoint
+        # resource contains full endpoint URI
+        # e.g., http://localhost:3300/network/adfgadf-daf5a6df4afadf-adfad65f4ad
+        resource_type = options.resource.split('/')[3].to_sym
+      elsif options.resource.start_with? '/'
+        # resource contains a path relative to endpoint URI
+        # e.g., /network/adfgadf-daf5a6df4afadf-adfad65f4ad
+        resource_type = options.resource.split('/')[1].to_sym
+      elsif mixin_types.include? options.resource.split('#').first
+        # resource contains a mixin with a type
+        # e.g., os_tpl#debian6
+        resource_type = options.resource.split('#').first.to_sym
+      else
+        # resource probably contains RAW resource_type
+        resource_type = options.resource.to_sym
+      end
 
-  if Occi::Cli::ResourceOutputFactory.allowed_resource_types.include? resource_type
-    puts output.format(found, :resources, resource_type)
-  else
-    Occi::Log.warn "Not printing, the resource type [#{resource_type.to_s}] is not supported!"
-  end
-end
+      if Occi::Cli::ResourceOutputFactory.allowed_resource_types.include? resource_type
+        puts output.format(found, :resources, resource_type)
+      else
+        Occi::Log.warn "Not printing, the resource type [#{resource_type.to_s}] is not supported!"
+      end
+    end
 
-def helper_create(options, output = nil)
-  location = nil
+    def helper_create(options, output = nil)
+      location = nil
 
-  if resource_types.include? options.resource
-    Occi::Log.debug "#{options.resource} is a resource type."
-    raise "Not yet implemented!" unless options.resource.include? "compute"
+      if resource_types.include? options.resource
+        Occi::Log.debug "#{options.resource} is a resource type."
+        raise "Not yet implemented!" unless options.resource.include? "compute"
 
-    res = resource options.resource
+        res = resource options.resource
 
-    Occi::Log.debug "Creating #{options.resource}:\n#{res.inspect}"
+        Occi::Log.debug "Creating #{options.resource}:\n#{res.inspect}"
 
-    if options.links
-      Occi::Log.debug "with links: #{options.links}"
+        if options.links
+          Occi::Log.debug "with links: #{options.links}"
 
-      options.links.each do |link|
-        link = options.endpoint.chomp('/') + link unless link.start_with? options.endpoint
+          options.links.each do |link|
+            link = options.endpoint.chomp('/') + link unless link.start_with? options.endpoint
 
-        if link.include? "/storage/"
-          Occi::Log.debug "Adding storagelink to #{options.resource}"
-          res.storagelink link
-        elsif link.include? "/network/"
-          Occi::Log.debug "Adding networkinterface to #{options.resource}"
-          res.networkinterface link
-        else
-          raise "Unknown link type #{link}, stopping here!"
+            if link.include? "/storage/"
+              Occi::Log.debug "Adding storagelink to #{options.resource}"
+              res.storagelink link
+            elsif link.include? "/network/"
+              Occi::Log.debug "Adding networkinterface to #{options.resource}"
+              res.networkinterface link
+            else
+              raise "Unknown link type #{link}, stopping here!"
+            end
+          end
         end
-      end
-    end
 
-    if options.mixins
-      Occi::Log.debug "with mixins: #{options.mixins}"
+        if options.mixins
+          Occi::Log.debug "with mixins: #{options.mixins}"
+
+          options.mixins.keys.each do |type|
+            Occi::Log.debug "Adding mixins of type #{type} to #{options.resource}"
+
+            options.mixins[type].each do |name|
+              mxn = mixin name, type
+
+              raise "Unknown mixin #{type}##{name}, stopping here!" if mxn.nil?
+              Occi::Log.debug "Adding mixin #{mxn} to #{options.resource}"
+              res.mixins << mxn
+            end
+          end
+
+          # TODO: find a better/universal way to do contextualization
+          if options.context_vars
+            Occi::Log.debug "with context variables: #{options.context_vars}"
+
+            options.context_vars.each_pair do |var, val|
+              schema = nil
+              mxn_attrs = Occi::Core::Attributes.new
+
+              case var
+              when :public_key
+                schema = "http://schemas.openstack.org/instance/credentials#"
+                mxn_attrs['org.openstack.credentials.publickey.name'] = {}
+                mxn_attrs['org.openstack.credentials.publickey.data'] = {}
+              when :user_data
+                schema = "http://schemas.openstack.org/compute/instance#"
+                mxn_attrs['org.openstack.compute.user_data'] = {}
+              else
+                schema = "http://schemas.ogf.org/occi/core#"
+              end
+
+              mxn = Occi::Core::Mixin.new(schema, var.to_s, 'OS contextualization mixin', mxn_attrs)
+              res.mixins << mxn
+
+              case var
+              when :public_key
+                res.attributes['org.openstack.credentials.publickey.name'] = 'Public SSH key'
+                res.attributes['org.openstack.credentials.publickey.data'] = val
+              when :user_data
+                res.attributes['org.openstack.compute.user_data'] = val
+              else
+                # do nothing
+              end
+            end
+          end
+        end
 
-      options.mixins.keys.each do |type|
-        Occi::Log.debug "Adding mixins of type #{type} to #{options.resource}"
+        #TODO: set other attributes
+        res.title = options.attributes[:title]
 
-        options.mixins[type].each do |name|
-          mxn = mixin name, type
+        Occi::Log.debug "Creating #{options.resource}:\n#{res.inspect}"
 
-          raise "Unknown mixin #{type}##{name}, stopping here!" if mxn.nil?
-          Occi::Log.debug "Adding mixin #{mxn} to #{options.resource}"
-          res.mixins << mxn
-        end
+        location = create res
+      else
+        Occi::Log.warn "I have no idea what #{options.resource} is ..."
+        raise "Unknown resource #{options.resource}, there is nothing to create here!"
       end
-    end
 
-    #TODO: set other attributes
-    res.title = options.attributes[:title]
+      return location if output.nil?
 
-    Occi::Log.debug "Creating #{options.resource}:\n#{res.inspect}"
-
-    location = create res
-  else
-    Occi::Log.warn "I have no idea what #{options.resource} is ..."
-    raise "Unknown resource #{options.resource}, there is nothing to create here!"
-  end
+      puts location
+    end
 
-  return location if output.nil?
+    def helper_delete(options, output = nil)
+      if delete(options.resource)
+        Occi::Log.info "Resource #{options.resource} successfully removed!"
+      else
+        raise "Failed to remove resource #{options.resource}!"
+      end
 
-  puts location
-end
+      true
+    end
 
-def helper_delete(options, output = nil)
-  if delete(options.resource)
-    Occi::Log.info "Resource #{options.resource} successfully removed!"
-  else
-    raise "Failed to remove resource #{options.resource}!"
+    def helper_trigger(options, output = nil)
+      raise "Not yet implemented!"
+    end
   end
-
-  true
-end
-
-def helper_trigger(options, output = nil)
-  raise "Not yet implemented!"
 end

data/lib/occi/cli/occi_opts.rb

@@ -1,6 +1,7 @@
 require 'ostruct'
 require 'optparse'
 require 'uri'
+require 'base64'
 
 require 'occi/cli/resource_output_factory'
 
@@ -12,6 +13,7 @@ module Occi::Cli
     MEDIA_TYPES = ["application/occi+json", "application/occi+xml", "text/plain,text/occi", "text/plain"].freeze
     ACTIONS = [:list, :describe, :create, :delete, :trigger].freeze
     LOG_OUTPUTS = [:stdout, :stderr].freeze
+    ALLOWED_CONTEXT_VARS = [:public_key, :user_data].freeze
 
     def self.parse(args, test_env = false)
 
@@ -188,7 +190,22 @@ occi --endpoint https://localhost:3300/ --action delete --resource /compute/65sd
             ary = /^(.+?)=(.+)$/.match(ctx).to_a.drop 1
             raise ArgumentError, "Context variables must always contain ATTR=VALUE pairs!" if ary.length != 2
 
-            options.context_vars[ary[0].to_sym] = ary[1]
+            symbol = ary[0].to_sym
+            if ALLOWED_CONTEXT_VARS.include?(symbol)
+              context_data = ary[1]
+              if context_data.gsub!(/^file:\/\//,'')
+                raise 'File does not exist! #{context_data}' unless File.exist? context_data
+                context_data = File.read(context_data)
+              end
+
+              if symbol == :user_data
+                context_data = Base64.encode64(context_data)
+              end
+
+              options.context_vars[symbol] = context_data.strip
+            else
+              Occi::Log.warn "Only #{ALLOWED_CONTEXT_VARS.join(', ')} context variables are supported! Skipping #{ary[0].to_s} ..."
+            end
           end
         end
 

data/lib/occi/cli/version.rb

@@ -1,5 +1,5 @@
 module Occi
   module Cli
-    VERSION = "4.0.0.alpha.2" unless defined?(::Occi::Cli::VERSION)
+    VERSION = "4.0.0.alpha.3" unless defined?(::Occi::Cli::VERSION)
   end
 end

data/occi-cli.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |gem|
   gem.version       = Occi::Cli::VERSION
   gem.authors       = ["Florian Feldhaus","Piotr Kasprzak", "Boris Parak"]
   gem.email         = ["florian.feldhaus@gwdg.de", "piotr.kasprzak@gwdg.de", "xparak@mail.muni.cz"]
-  gem.description   = %q{OCCI is a collection of classes to simplify the implementation of the Open Cloud Computing API in Ruby}
-  gem.summary       = %q{OCCI toolkit}
+  gem.description   = %q{This gem is a client implementation of the Open Cloud Computing Interface in Ruby}
+  gem.summary       = %q{Executable OCCI client}
   gem.homepage      = 'https://github.com/gwdg/rOCCI-cli'
   gem.license       = 'Apache License, Version 2.0'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: occi-cli
 version: !ruby/object:Gem::Version
-  version: 4.0.0.alpha.2
+  version: 4.0.0.alpha.3
   prerelease: 6
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-18 00:00:00.000000000 Z
+date: 2013-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: occi-api
@@ -189,8 +189,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: OCCI is a collection of classes to simplify the implementation of the
-  Open Cloud Computing API in Ruby
+description: This gem is a client implementation of the Open Cloud Computing Interface
+  in Ruby
 email:
 - florian.feldhaus@gwdg.de
 - piotr.kasprzak@gwdg.de
@@ -253,5 +253,5 @@ rubyforge_project:
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: OCCI toolkit
+summary: Executable OCCI client
 test_files: []