occi 3.1.3 → 4.0.0.beta.1

data/lib/occi/bin/occi_opts.rb

@@ -1,384 +0,0 @@
-require 'ostruct'
-require 'optparse'
-require 'uri'
-
-require 'occi/bin/resource_output_factory'
-
-module Occi
-  module Bin
-
-    class OcciOpts
-
-      AUTH_METHODS = [:x509, :basic, :digest, :keystone, :none].freeze
-      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
-
-      def self.parse(args, test_env = false)
-
-        @@quiet = test_env
-
-        options = OpenStruct.new
-        
-        options.debug = false
-        options.verbose = false
-        
-        options.log = {}
-        options.log[:out] = STDERR
-        options.log[:level] = Occi::Log::WARN
-
-        options.filter = nil
-        options.dump_model = false
-
-        options.interactive = false
-
-        options.endpoint = "https://localhost:3300/"
-        
-        options.auth = {}
-        options.auth[:type] = "none"
-        options.auth[:user_cert] = ENV['HOME'] + "/.globus/usercred.pem"
-        options.auth[:ca_path] = "/etc/grid-security/certificates"
-        options.auth[:username] = "anonymous"
-        options.auth[:ca_file] = nil
-        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]
-
-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:"
-
-          opts.on("-i",
-                  "--interactive",
-                  "Run as an interactive client without additional arguments") do |interactive|
-            options.interactive = interactive
-          end
-
-          opts.on("-e",
-                  "--endpoint URI",
-                  String,
-                  "OCCI server URI, defaults to '#{options.endpoint}'") do |endpoint|
-            options.endpoint = URI(endpoint).to_s
-          end
-
-          opts.on("-n",
-                  "--auth METHOD",
-                  AUTH_METHODS,
-                  "Authentication method, defaults to '#{options.auth[:type]}'") do |auth|
-            options.auth[:type] = auth.to_s
-          end
-
-          opts.on("-u",
-                  "--username USER",
-                  String,
-                  "Username for basic or digest authentication, defaults to '#{options.auth[:username]}'") do |username|
-            options.auth[:username] = username
-          end
-
-          opts.on("-p",
-                  "--password PASSWORD",
-                  String,
-                  "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|
-            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|
-            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|
-            options.filter = filter
-          end
-
-          opts.on("-x",
-                  "--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 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
-
-          opts.on("-y",
-                  "--media-type MEDIA_TYPE",
-                  MEDIA_TYPES,
-                  "Media type for client <-> server communication, defaults to '#{options.media_type}'") do |media_type|
-            options.media_type = media_type
-          end
-
-          opts.on("-r",
-                  "--resource RESOURCE",
-                  String,
-                  "Resource to be queried (e.g. network, compute, storage etc.), required") do |resource|
-            options.resource = resource
-          end
-
-          opts.on("-t",
-                  "--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",
-                  "--action ACTION",
-                  ACTIONS,
-                  "Action to be performed on the resource, required") do |action|
-            options.action = action
-          end
-
-          opts.on("-M",
-                  "--mixin NAME",
-                  String,
-                  "Type and name of the mixin as TYPE#NAME (e.g. os_tpl#monitoring, resource_tpl#medium)") do |mixin|
-            parts = mixin.split("#")
-
-            raise "Unknown mixin format! Use TYPE#NAME!" unless parts.length == 2
-
-            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",
-                  "--trigger-action TRIGGER",
-                  String,
-                  "Action to be triggered on the resource") do |trigger_action|
-            options.trigger_action = trigger_action
-          end
-
-          opts.on("-l",
-                  "--log-to OUTPUT",
-                  LOG_OUTPUTS,
-                  "Log to the specified device, defaults to 'STDERR'") do |log_to|
-            options.log[:out] = STDOUT if log_to == :stdout or log_to == :STDOUT
-          end
-
-          opts.on("-o",
-                  "--output-format FORMAT",
-                  Occi::Bin::ResourceOutputFactory.allowed_formats,
-                  "Output format, defaults to human-readable 'plain'") do |output_format|
-            options.output_format = output_format
-          end
-
-          opts.on_tail("-m",
-                       "--dump-model",
-                       "Contact the endpoint and dump its model, cannot be used with the interactive mode") do |dump_model|
-            options.dump_model = dump_model
-          end
-
-          opts.on_tail("-d",
-                       "--debug",
-                       "Enable debugging messages") do |debug|
-            options.debug = debug
-            options.log[:level] = Occi::Log::DEBUG
-          end
-
-          opts.on_tail("-b",
-                       "--verbose",
-                       "Be more verbose, less intrusive than debug mode") do |verbose|
-            options.verbose = verbose
-            options.log[:level] = Occi::Log::INFO unless options.log[:level] == Occi::Log::DEBUG
-          end
-
-          opts.on_tail("-h",
-                       "--help",
-                       "Show this message") do
-            if @@quiet
-              exit true
-            else
-              puts opts
-              exit! true
-            end
-          end
-
-          opts.on_tail("-v",
-                       "--version",
-                       "Show version") do
-            if @@quiet
-              exit true
-            else
-              puts Occi::VERSION
-              exit! true
-            end
-          end
-        end
-
-        begin
-          opts.parse!(args)
-        rescue Exception => ex
-          if @@quiet
-            exit false
-          else
-            puts ex.message.capitalize
-            puts opts
-            exit!
-          end
-        end
-
-        check_restrictions options, opts
-
-        options
-      end
-
-      private
-
-      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
-          if @@quiet
-            exit false
-          else
-            puts "You cannot use '--filter' without '--dump-model'!"
-            puts opts
-            exit!
-          end
-        end
-
-        return if options.interactive || options.dump_model
-
-        mandatory = []
-
-        if options.action == :trigger
-          mandatory << :trigger_action
-        end
-
-        if options.action == :create
-          if !options.links.nil?
-            mandatory << :links
-          else
-            mandatory << :mixins
-          end
-
-          mandatory << :attributes
-          check_attrs = true
-        end
-
-        mandatory.concat [:resource, :action]
-
-        check_hash options, mandatory, opts
-
-        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
-      end
-    end
-
-  end
-end

data/lib/occi/bin/resource_output_factory.rb

@@ -1,97 +0,0 @@
-require 'json'
-require 'erb'
-
-module Occi
-  module Bin
-
-    class ResourceOutputFactory
-
-      @@allowed_formats = [:json, :plain].freeze
-      @@allowed_resource_types = [:compute, :storage, :network, :os_tpl, :resource_tpl].freeze
-      @@allowed_data_types = [:locations, :resources].freeze
-
-      attr_reader :output_format
-
-      def initialize(output_format = :plain)
-        raise "Unsupported output format!" unless @@allowed_formats.include? output_format
-        @output_format = output_format
-      end
-
-      def format(data, data_type, resource_type)
-        raise "Data has to be in an array!" unless data.is_a? Array
-        raise "Unsupported resource type! Got: #{resource_type.to_s}" unless @@allowed_resource_types.include? resource_type
-        raise "Unsupported data type! Got: #{data_type.to_s}" unless @@allowed_data_types.include? data_type
-
-        # validate incoming data
-        if data_type == :resources
-          data.each do |occi_collection|
-            raise "I need the resources to be in a Collection!" unless occi_collection.respond_to? :as_json
-          end
-        end
-
-        # construct method name from data type and output format
-        method = (data_type.to_s + "_to_" + output_format.to_s).to_sym
-
-        ResourceOutputFactory.send method, data, resource_type
-      end
-
-      def self.allowed_formats
-        @@allowed_formats
-      end
-
-      def self.allowed_resource_types
-        @@allowed_resource_types
-      end
-
-      def self.allowed_data_types
-        @@allowed_data_types
-      end
-
-      def self.resources_to_json(occi_resources, resource_type)
-        # generate JSON document from an array of JSON objects 
-        JSON.generate occi_resources
-      end
-
-      def self.resources_to_plain(occi_resources, resource_type)
-        # using ERB templates for known resource and mixin types
-        file = File.expand_path("..", __FILE__) + '/templates/' + resource_type.to_s + ".erb"
-        template = ERB.new File.new(file).read
-
-        formatted_output = ""
-
-        occi_resources.each do |occi_resource|
-          json_resource = occi_resource.as_json
-          formatted_output << template.result(binding) unless json_resource.nil? || json_resource.empty?
-        end
-
-        formatted_output
-      end
-
-      def self.locations_to_json(url_locations, resource_type)
-        # give all locatios a common key and convert to JSON
-        locations = { resource_type => [] }
-
-        url_locations.each do |location|
-          location = location.split("/").last if [:os_tpl, :resource_tpl].include? resource_type
-          locations[resource_type] << location
-        end
-
-        locations.to_json
-      end
-
-      def self.locations_to_plain(url_locations, resource_type)
-        # just an attempt to make the array more readable 
-        output = "\n" + resource_type.to_s.capitalize + " locations:\n"
-
-        url_locations.each do |location|
-          location = location.split("/").last if [:os_tpl, :resource_tpl].include? resource_type
-          output << "\t" << location << "\n"
-        end
-
-        output
-      end
-
-    end
-
-  end
-end