occi 3.0.0 → 3.1.0.beta.1

data/lib/occi/api/client/http/authn_utils.rb

@@ -0,0 +1,82 @@
+require 'openssl'
+
+if defined? JRUBY_VERSION
+  require 'java'
+end
+
+module Occi
+  module Api
+    module Client
+
+      class AuthnUtils
+        # Reads credentials from a PKCS#12 compliant file. Returns
+        # X.509 certificate and decrypted private key in PEM
+        # formatted string.
+        #
+        # @example
+        #    extract_pem_from_pkcs12 "~/.globus/usercert.p12", "123456"
+        #      # => #<String>
+        #
+        # @param [String] Path to a PKCS#12 file with credentials
+        # @param [String] Password needed to unlock the PKCS#12 file
+        # @return [String] Decrypted credentials in a PEM formatted string
+        def self.extract_pem_from_pkcs12(path_to_p12_file, p12_password)
+          # decode certificate and its private key
+          pem_from_pkcs12 = ""
+          if defined? JRUBY_VERSION
+            # Java-based Ruby, read PKCS12 manually
+            # using KeyStore
+            keystore = Java::JavaSecurity::KeyStore.getInstance("PKCS12")
+            p12_input_stream = Java::JavaIo::FileInputStream.new(path_to_p12_file)
+            pass_char_array = Java::JavaLang::String.new(p12_password).to_char_array
+
+            # load and unlock PKCS#12 store
+            keystore.load p12_input_stream, pass_char_array
+
+            # read the first certificate and PK
+            cert = keystore.getCertificate("1")
+            pk = keystore.getKey("1", pass_char_array)
+
+            pem_from_pkcs12 << "-----BEGIN CERTIFICATE-----\n"
+            pem_from_pkcs12 << Java::JavaxXmlBind::DatatypeConverter.printBase64Binary(cert.getEncoded())
+            pem_from_pkcs12 << "\n-----END CERTIFICATE-----"
+
+            pem_from_pkcs12 << "\n"
+
+            pem_from_pkcs12 << "-----BEGIN PRIVATE KEY-----\n"
+            pem_from_pkcs12 << Java::JavaxXmlBind::DatatypeConverter.printBase64Binary(pk.getEncoded())
+            pem_from_pkcs12 << "\n-----END PRIVATE KEY-----"
+          else
+            # C-based Ruby, use OpenSSL::PKCS12
+            pkcs12 = OpenSSL::PKCS12.new(
+              File.open(
+                path_to_p12_file,
+                'rb'
+              ),
+              p12_password
+            )
+
+            # store cert and private key in a single PEM formatted string
+            pem_from_pkcs12 << pkcs12.certificate.to_pem << pkcs12.key.to_pem
+          end
+
+          pem_from_pkcs12
+        end
+
+        # Reads X.509 certificates from a file to an array.
+        #
+        # @example
+        #    certs_to_file_ary "~/.globus/usercert.pem"
+        #      # => [#<String>, #<String>, ...]
+        #
+        # @param [String] Path to a PEM file containing certificates
+        # @return [Array<String>] An array of read certificates
+        def self.certs_to_file_ary(ca_file)
+          # TODO: read and separate multiple certificates
+          [] << File.open(ca_file).read
+        end
+      end
+
+    end
+  end
+end

data/lib/occi/bin/helpers.rb

@@ -1,6 +1,6 @@
 # a bunch of OCCI client helpers for bin/occi
 
-def helper_list(options)
+def helper_list(options, output = nil)
   found = []
 
   if resource_types.include? options.resource
@@ -10,17 +10,23 @@ def helper_list(options)
     Occi::Log.debug "#{options.resource} is a mixin type."
     found = mixins options.resource
   else
-    Occi::Log.debug "I have no idea what #{options.resource} is ..."
-    puts "Unknown resource #{options.resource}, there is nothing to list here!"
+    Occi::Log.warn "I have no idea what #{options.resource} is ..."
+    raise "Unknown resource #{options.resource}, there is nothing to list here!"
   end
 
-  found
+  return found if output.nil?
+
+  if Occi::Bin::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)
+def helper_describe(options, output = nil)
   found = []
 
-  if resource_types.include? options.resource or options.resource.start_with? options.endpoint
+  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)
@@ -37,15 +43,37 @@ def helper_describe(options)
     mxn_type,mxn = options.resource.split('#')
     found << mixin(mxn, mxn_type, true)
   else
-    Occi::Log.debug "I have no idea what #{options.resource} is ..."
+    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?
 
-    puts "Unknown resource #{options.resource}, there is nothing to describe here!"
+  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
 
-  found
+  if Occi::Bin::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)
+def helper_create(options, output = nil)
   location = nil
 
   if resource_types.include? options.resource
@@ -55,37 +83,67 @@ def helper_create(options)
     res = resource options.resource
 
     Occi::Log.debug "Creating #{options.resource}:\n#{res.inspect}"
-    Occi::Log.debug "with mixins:#{options.mixin}"
 
-    options.mixin.keys.each do |type|
-      Occi::Log.debug "Adding mixins of type #{type} to #{options.resource}"
-      options.mixin[type].each do |name|
-        mxn = mixin name, type
+    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
+
+        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
+
+    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}"
 
-        raise "Unknown mixin #{type}##{name}, stopping here!" if mxn.nil?
-        Occi::Log.debug "Adding mixin #{mxn} to #{options.resource}"
-        res.mixins << mxn
+        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
     end
 
     #TODO: set other attributes
-    res.title = options.resource_title
+    res.title = options.attributes[:title]
 
     Occi::Log.debug "Creating #{options.resource}:\n#{res.inspect}"
 
     location = create res
   else
-    Occi::Log.debug "I have no idea what #{options.resource} is ..."
-    puts "Unknown resource #{options.resource}, there is nothing to create here!"
+    Occi::Log.warn "I have no idea what #{options.resource} is ..."
+    raise "Unknown resource #{options.resource}, there is nothing to create here!"
   end
 
-  location
+  return location if output.nil?
+
+  puts location
 end
 
-def helper_delete(options)
-  delete options.resource
+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
+
+  true
 end
 
-def helper_trigger(options)
+def helper_trigger(options, output = nil)
   raise "Not yet implemented!"
-end
+end

data/lib/occi/bin/occi_opts.rb

@@ -1,5 +1,7 @@
 require 'ostruct'
 require 'optparse'
+require 'uri'
+
 require 'occi/bin/resource_output_factory'
 
 module Occi
@@ -12,7 +14,9 @@ module Occi
       ACTIONS = [:list, :describe, :create, :delete, :trigger].freeze
       LOG_OUTPUTS = [:stdout, :stderr].freeze
 
-      def self.parse(args)
+      def self.parse(args, test_env = false)
+
+        @@quiet = test_env
 
         options = OpenStruct.new
         
@@ -39,13 +43,31 @@ module Occi
         options.auth[:proxy_ca] = nil
 
         options.output_format = :plain
+
+        options.mixins = nil
+        options.links = nil
+        options.attributes = nil
+        options.context_vars = nil
         
         # TODO: change media type back to occi+json after the rOCCI-server update
         #options.media_type = "application/occi+json"
         options.media_type = "text/plain,text/occi"
 
         opts = OptionParser.new do |opts|
-          opts.banner = "Usage: occi [OPTIONS]"
+          opts.banner = %{Usage: occi [OPTIONS]
+
+Examples:
+  occi --interactive --endpoint https://localhost:3300/ --auth x509
+
+  occi --endpoint https://localhost:3300/ --action list --resource os_tpl --auth x509
+
+  occi --endpoint https://localhost:3300/ --action list --resource resource_tpl --auth x509
+
+  occi --endpoint https://localhost:3300/ --action describe --resource os_tpl#debian6 --auth x509
+
+  occi --endpoint https://localhost:3300/ --action create --resource compute --mixin os_tpl#debian6 --mixin resource_tpl#small --attributes title="My rOCCI VM" --auth x509
+
+  occi --endpoint https://localhost:3300/ --action delete --resource /compute/65sd4f654sf65g4-s5fg65sfg465sfg-sf65g46sf5g4sdfg --auth x509}
 
           opts.separator ""
           opts.separator "Options:"
@@ -60,7 +82,7 @@ module Occi
                   "--endpoint URI",
                   String,
                   "OCCI server URI, defaults to '#{options.endpoint}'") do |endpoint|
-            options.endpoint = endpoint
+            options.endpoint = URI(endpoint).to_s
           end
 
           opts.on("-n",
@@ -80,36 +102,56 @@ module Occi
           opts.on("-p",
                   "--password PASSWORD",
                   String,
-                  "Password for basic, digest and x509 authentication or an auth. token for KeyStone") do |password|
+                  "Password for basic, digest and x509 authentication or an auth. token from OS Keystone") do |password|
             options.auth[:password] = password
             options.auth[:user_cert_password] = password
             options.auth[:token] = password
           end
 
           opts.on("-c",
-                  "--ca-path PATH", String, "Path to CA certificates directory, defaults to '#{options.auth[:ca_path]}'") do |ca_path|
+                  "--ca-path PATH",
+                  String,
+                  "Path to CA certificates directory, defaults to '#{options.auth[:ca_path]}'") do |ca_path|
+            raise ArgumentError, "Path specified in --ca-path is not a directory!" unless File.directory? ca_path
+            raise ArgumentError, "Path specified in --ca-path is not readable!" unless File.readable? ca_path
+
             options.auth[:ca_path] = ca_path
           end
 
           opts.on("-f",
-                  "--ca-file PATH", String, "Path to CA certificates in a file") do |ca_file|
+                  "--ca-file PATH",
+                  String,
+                  "Path to CA certificates in a file") do |ca_file|
+            raise ArgumentError, "File specified in --ca-file is not a file!" unless File.file? ca_file
+            raise ArgumentError, "File specified in --ca-file is not readable!" unless File.readable? ca_file
+
             options.auth[:ca_file] = ca_file
           end
 
           opts.on("-F",
-                  "--filter CATEGORY", String, "Category type identifier to filter categories from model, must be used together with the -m option") do |filter|
+                  "--filter CATEGORY",
+                  String,
+                  "Category type identifier to filter categories from model, must be used together with the -m option") do |filter|
             options.filter = filter
           end
 
           opts.on("-x",
-                  "--user-cred PATH",
+                  "--user-cred FILE",
                   String,
                   "Path to user's x509 credentials, defaults to '#{options.auth[:user_cert]}'") do |user_cred|
+            raise ArgumentError, "File specified in --user-cred is not a file!" unless File.file? user_cred
+            raise ArgumentError, "File specified in --user-cred is not readable!" unless File.readable? user_cred
+
             options.auth[:user_cert] = user_cred
           end
 
           opts.on("-X",
-                  "--proxy-ca PATH", String, "Path to a file with GSI proxy's CA certificate(s)") do |proxy_ca|
+                  "--proxy-ca FILE",
+                  String,
+                  "Path to a file with GSI proxy's CA certificate(s)") do |proxy_ca|
+            raise ArgumentError, "File specified in --proxy-ca is not a file!" unless File.file? proxy_ca
+            raise ArgumentError, "File specified in --proxy-ca is not readable!" unless File.readable? proxy_ca
+
             options.auth[:proxy_ca] = proxy_ca
           end
 
@@ -128,10 +170,31 @@ module Occi
           end
 
           opts.on("-t",
-                  "--resource-title TITLE",
-                  String,
-                  "Resource title for new resources") do |resource_title|
-            options.resource_title = resource_title
+                  "--attributes ATTRS",
+                  Array,
+                  "Comma separated attributes for new resources such as title=\"Name\", required") do |attributes|
+            options.attributes = {}
+
+            attributes.each do |attribute|
+              ary = /^(.+?)=(.+)$/.match(attribute).to_a.drop 1
+              raise ArgumentError, "Attributes must always contain ATTR=VALUE pairs!" if ary.length != 2
+
+              options.attributes[ary[0].to_sym] = ary[1]
+            end
+          end
+
+          opts.on("-T",
+                  "--context CTX_VARS",
+                  Array,
+                  "Comma separated context variables for new compute resources such as SSH_KEY=\"ssh-rsa dfsdf...adfdf== user@localhost\"") do |context|
+            options.context_vars = {}
+
+            context.each do |ctx|
+              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]
+            end
           end
 
           opts.on("-a",
@@ -149,9 +212,21 @@ module Occi
 
             raise "Unknown mixin format! Use TYPE#NAME!" unless parts.length == 2
 
-            options.mixin = {} if options.mixin.nil?
-            options.mixin[parts[0]] = [] if options.mixin[parts[0]].nil?
-            options.mixin[parts[0]] << parts[1]
+            options.mixins = {} if options.mixins.nil?
+            options.mixins[parts[0]] = [] if options.mixins[parts[0]].nil?
+            options.mixins[parts[0]] << parts[1]
+          end
+
+          opts.on("-j",
+                  "--link URI",
+                  String,
+                  "Link specified resource to the resource being created, only for action CREATE and resource COMPUTE") do |link|
+            link_relative_path = URI(link).path
+
+            raise ArgumentError, "Specified link URI is not valid!" unless link_relative_path.start_with? '/'
+
+            options.links = [] if options.links.nil?
+            options.links << link_relative_path
           end
 
           opts.on("-g",
@@ -198,68 +273,111 @@ module Occi
           opts.on_tail("-h",
                        "--help",
                        "Show this message") do
-            puts opts
-            exit!(true)
+            if @@quiet
+              exit true
+            else
+              puts opts
+              exit! true
+            end
           end
 
           opts.on_tail("-v",
                        "--version",
                        "Show version") do
-            puts Occi::VERSION
-            exit!(true)
+            if @@quiet
+              exit true
+            else
+              puts Occi::VERSION
+              exit! true
+            end
           end
-
         end
 
         begin
           opts.parse!(args)
         rescue Exception => ex
-          puts ex.message.capitalize
-          puts opts
-          exit!
+          if @@quiet
+            exit false
+          else
+            puts ex.message.capitalize
+            puts opts
+            exit!
+          end
         end
 
-        if options.interactive && options.dump_model
-          puts "You cannot use '--dump-model' and '--interactive' at the same time!"
-          puts opts
+        check_restrictions options, opts
+
+        options
+      end
+
+      private
 
-          exit!
+      def self.check_restrictions(options, opts)
+        if options.interactive && options.dump_model
+          if @@quiet
+            exit false
+          else
+            puts "You cannot use '--dump-model' and '--interactive' at the same time!"
+            puts opts
+            exit!
+          end
         end
 
         if !options.dump_model && options.filter
-          puts "You cannot use '--filter' without '--dump-model'!"
-          puts opts
-
-          exit!
+          if @@quiet
+            exit false
+          else
+            puts "You cannot use '--filter' without '--dump-model'!"
+            puts opts
+            exit!
+          end
         end
 
-        if !(options.interactive or options.dump_model)
-          mandatory = []
+        return if options.interactive || options.dump_model
 
-          if options.action == :trigger
-            mandatory << :trigger_action
-          end
+        mandatory = []
+
+        if options.action == :trigger
+          mandatory << :trigger_action
+        end
 
-          if options.action == :create
-            mandatory << :mixin << :resource_title
+        if options.action == :create
+          if !options.links.nil?
+            mandatory << :links
+          else
+            mandatory << :mixins
           end
 
-          mandatory.concat [:resource, :action]
-          
-          options_hash = options.marshal_dump
+          mandatory << :attributes
+          check_attrs = true
+        end
+
+        mandatory.concat [:resource, :action]
+
+        check_hash options, mandatory, opts
 
-          missing = mandatory.select{ |param| options_hash[param].nil? }
-          if not missing.empty?
+        if check_attrs
+          mandatory = [:title]
+          check_hash options.attributes, mandatory, opts
+        end
+      end
+
+      def self.check_hash(hash, mandatory, opts)
+        if !hash.is_a? Hash
+          hash = hash.marshal_dump
+        end
+
+        missing = mandatory.select{ |param| hash[param].nil? }
+        if !missing.empty?
+          if @@quiet
+            exit false
+          else
             puts "Missing required arguments: #{missing.join(', ')}"
             puts opts
-
             exit!
           end
         end
-
-        options
       end
-
     end
 
   end

data/lib/occi/version.rb

@@ -1,3 +1,3 @@
 module Occi
-  VERSION = "3.0.0" unless defined?(::Occi::VERSION)
+  VERSION = "3.1.0.beta.1" unless defined?(::Occi::VERSION)
 end

data/occi.gemspec

@@ -39,7 +39,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "yard-rspec"
   gem.add_development_dependency "yard-cucumber"
   gem.add_development_dependency "rspec-http"
-  #gem.add_development_dependency "vcr"
+  gem.add_development_dependency "rubygems-tasks"
   gem.add_development_dependency "webmock"
 
   gem.required_ruby_version     = ">= 1.8.7"

data/spec/occi/api/client/client_amqp_spec.rb

@@ -23,9 +23,12 @@ module Occi
 
 =begin
       before(:all) do
-        @client = Occi::Api::Client::ClientAmqp.new("http://localhost:9292/", auth_options = { :type => "none" },
-                                            log_options = { :out => STDERR, :level => Occi::Log::WARN, :logger => nil },
-                                            media_type = "application/occi+json")
+        @client = Occi::Api::Client::ClientAmqp.new({
+          :endpoint => "http://localhost:9292/",
+          :auth => { :type => "none" },
+          :log => { :out => STDERR, :level => Occi::Log::WARN, :logger => nil },
+          :media_type => "application/occi+json"
+        })
       end
 
       it "initialize and connect client" do

data/spec/occi/api/client/client_http_spec.rb

@@ -11,14 +11,14 @@ module Occi
       context "using media type text/plain" do
 
         before(:each) do
-          @client = Occi::Api::Client::ClientHttp.new(
-           'https://localhost:3300',
-           { :type  => "none" },
-           { :out   => "/dev/null",
-             :level => Occi::Log::DEBUG },
-           true,
-           "text/plain,text/occi"
-          )
+          @client = Occi::Api::Client::ClientHttp.new({
+           :endpoint => 'https://localhost:3300',
+           :auth => { :type  => "none" },
+           :log => { :out   => "/dev/null",
+                     :level => Occi::Log::DEBUG },
+           :auto_connect => true,
+           :media_type => "text/plain,text/occi"
+          })
         end
 
         after(:each) do
@@ -189,14 +189,14 @@ module Occi
       context "using media type application/occi+json" do
 
         before(:each) do
-          #@client = Occi::Api::ClientHttp.new(
-          #  'https://localhost:3300',
-          #  { :type  => "none" },
-          #  { :out   => "/dev/null",
-          #    :level => Occi::Log::DEBUG },
-          #  true,
-          #  "application/occi+json"
-          #)
+          #@client = Occi::Api::ClientHttp.new({
+          #  :endpoint => 'https://localhost:3300',
+          #  :auth => { :type  => "none" },
+          #  :log => { :out   => "/dev/null",
+          #            :level => Occi::Log::DEBUG },
+          #  :auto_connect => true,
+          #  :media_type => "application/occi+json"
+          #})
         end
 
         it "establishes connection"