occi-cli 4.0.0.alpha.1

data/.gitignore

@@ -0,0 +1,15 @@
+*.gem
+*.swp
+.project
+.idea
+.yardoc
+.bundle
+.rvmrc
+lib/occiantlr/output/
+pkg
+tmp
+log
+coverage
+vendor
+collection
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper --color --format documentation

data/.travis.yml

@@ -0,0 +1,43 @@
+language: ruby
+
+before_install:
+  - sudo apt-get install -qq libonig-dev
+
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+
+jdk:
+  - openjdk7
+  - oraclejdk7
+  - openjdk6
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+  exclude:
+    - rvm: 1.8.7
+      jdk: openjdk7
+    - rvm: 1.8.7
+      jdk: oraclejdk7
+    - rvm: 1.9.3
+      jdk: openjdk7
+    - rvm: 1.9.3
+      jdk: oraclejdk7
+    - rvm: 2.0.0
+      jdk: openjdk7
+    - rvm: 2.0.0
+      jdk: oraclejdk7
+    - rvm: ruby-head
+      jdk: openjdk7
+    - rvm: ruby-head
+      jdk: oraclejdk7
+
+branches:
+  only:
+    - master

data/.yardopts

@@ -0,0 +1 @@
+--title "Documentation of the OCCI gem" --markup markdown --private

data/AUTHORS

@@ -0,0 +1,9 @@
+rOcci was designed and is mainly developed by Florian Feldhaus (GWDG) and Piotr Kasprzak (GWDG) in Germany.
+
+Special thanks to the following extraordinary individuals, whithout whom rOcci would not be possible:
+
+* Hayati Bice - who wrote the initial version of an Occi server rOcci is based on
+* Max Günther - who wrote the EC2 backend
+* Andre Thevapalan - for his input regarding the JSON rendering
+* Boris Parak - especially for his input regarding the Client / Client DSL and CLI
+* the OCCI Working Group - for developing OCCI

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org/"
+
+gemspec
+
+group :development do
+  gem 'warbler', :git => 'git://github.com/jruby/warbler.git', :ref => 'ce3ce4df137504822e4cbb9399dee7e7dd767c44'
+  gem 'rubygems-tasks', :git => 'git://github.com/postmodern/rubygems-tasks.git'
+end
+
+platforms :jruby do
+  gem 'jruby-openssl' if ((defined? JRUBY_VERSION) && (JRUBY_VERSION.split('.')[1].to_i < 7))
+end

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012 GWDG
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,211 @@
+rOCCI-cli - A Ruby OCCI Framework
+=================================
+
+[![Build Status](https://secure.travis-ci.org/gwdg/rOCCI-cli.png)](http://travis-ci.org/gwdg/rOCCI-cli)
+[![Dependency Status](https://gemnasium.com/gwdg/rOCCI-cli.png)](https://gemnasium.com/gwdg/rOCCI-cli)
+[![Gem Version](https://fury-badge.herokuapp.com/rb/occi-cli.png)](https://badge.fury.io/rb/occi-cli)
+[![Code Climate](https://codeclimate.com/github/gwdg/rOCCI-cli.png)](https://codeclimate.com/github/gwdg/rOCCI-cli)
+
+Requirements
+------------
+
+Ruby
+* at least version 1.8.7 is required
+
+The following setup is recommended
+
+* usage of the Ruby Version Manager
+* Ruby 1.9.3
+* RubyGems installed
+
+The following libraries / packages may be required to use rOCCI-cli
+
+* libxslt-dev
+* libxml2-dev
+* **only if using Ruby 1.8.7:** libonig-dev (Linux) or oniguruma (Mac)
+
+To use rOCCI-cli with Java, you need JRE 6 or 7. To build rOCCI-cli for Java, you need JDK 6 or 7.
+
+Installation
+------------
+
+**[Mac OS X has some special requirements for the installation. Detailed information can be found in
+doc/macosx.md.](doc/macosx.md)**
+
+To install the most recent stable version
+
+    gem install occi-cli
+
+To install the most recent beta version
+
+    gem install occi-cli --pre
+
+### Installation from source
+
+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
+
+#### Ruby
+
+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
+    rake install
+
+#### Java
+
+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
+    gem install bundler
+    bundle install
+    warble
+
+For Linux / Mac OS X you can create a OCCI Java executable from the jar file using
+
+    sudo echo '#!/usr/bin/java -jar' | cat - occi.jar > occi ; sudo chmod +x occi
+
+Usage
+-----
+### Client
+The OCCI gem includes a client you can use directly from shell with the following auth methods: x509 (with --password, --user-cred and --ca-path), basic (with --username and --password), digest (with --username and --password), none. If you won't set a password using --password, the client will ask for it later on. There is also an interactive mode, which will allow you to interact with the client through menus and answers to simple questions (this feature is still experimental).
+
+To find out more about available options and defaults use
+
+    occi --help
+
+To run the client in an interactive mode use
+
+    occi --interactive
+    occi --interactive --endpoint https://<ENDPOINT>:<PORT>/
+    occi --interactive --endpoint https://<ENDPOINT>:<PORT>/ --auth x509
+
+To list available resources use
+
+    occi --endpoint https://<ENDPOINT>:<PORT>/ --action list --resource compute --auth x509
+    occi --endpoint https://<ENDPOINT>:<PORT>/ --action list --resource storage --auth x509
+    occi --endpoint https://<ENDPOINT>:<PORT>/ --action list --resource network --auth x509
+
+To describe available resources use
+
+    occi --endpoint https://<ENDPOINT>:<PORT>/ --action describe --resource compute --auth x509
+    occi --endpoint https://<ENDPOINT>:<PORT>/ --action describe --resource storage --auth x509
+    occi --endpoint https://<ENDPOINT>:<PORT>/ --action describe --resource network --auth x509
+
+To describe specific resources use
+
+    occi --endpoint https://<ENDPOINT>:<PORT>/ --action describe --resource /compute/<OCCI_ID> --auth x509
+    occi --endpoint https://<ENDPOINT>:<PORT>/ --action describe --resource /storage/<OCCI_ID> --auth x509
+    occi --endpoint https://<ENDPOINT>:<PORT>/ --action describe --resource /network/<OCCI_ID> --auth x509
+
+To list available OS templates or Resource templates use
+
+    occi --endpoint https://<ENDPOINT>:<PORT>/ --action list --resource os_tpl --auth x509
+    occi --endpoint https://<ENDPOINT>:<PORT>/ --action list --resource resource_tpl --auth x509
+
+To describe a specific OS template or Resource template use
+
+    occi --endpoint https://<ENDPOINT>:<PORT>/ --action describe --resource os_tpl#debian6 --auth x509
+    occi --endpoint https://<ENDPOINT>:<PORT>/ --action describe --resource resource_tpl#small --auth x509
+
+To create a compute resource with mixins use
+
+    occi --endpoint https://<ENDPOINT>:<PORT>/ --action create --resource compute --mixin os_tpl#debian6 --mixin resource_tpl#small --attributes title="My rOCCI VM" --auth x509
+
+To delete a compute resource use
+
+    occi --endpoint https://<ENDPOINT>:<PORT>/ --action delete --resource /compute/<OCCI_ID> --auth x509
+
+Changelog
+---------
+
+### Version 3.1
+* added basic OS Keystone support
+* added support for PKCS12 credentials for X.509 authN
+* updated templates for plain output formatting
+* minor client API changes
+* several bugfixes
+
+### Version 3.0
+
+* many bugfixes
+* rewrote Core classes to use metaprogramming techniques
+* added VCR cassettes for reliable testing against prerecorded server responses
+* several updates to the OCCI Client
+* started work on an OCCI Client using AMQP as transport protocol
+* added support for keystone authentication to be used with the OpenStack OCCI server
+* updated dependencies
+* updated rspec tests
+* started work on cucumber features
+
+### Version 2.5
+
+* improved OCCI Client
+* improved documentation
+* several bugfixes
+
+### Version 2.4
+
+* Changed OCCI attribute properties from lowercase to first letter uppercase (e.g. type -> Type, default -> Default, ...)
+
+### Version 2.3
+
+* OCCI objects are now initialized with a list of attributes instead of a hash. Thus it is easier to check which
+attributes are expected by a class and helps prevent errors.
+* Parsing of a subset of the OVF specification is supported. Further parts of the specification will be covered in
+future versions of rOCCI.
+
+### Version 2.2
+
+* OCCI Client added. The client simplifies the execution of OCCI commands and provides shortcuts for often used steps.
+
+### Version 2.1
+
+* Several improvements to the gem structure and code documentation. First rSpec test were added. Readme has been extended to include instructions how the gem can be used.
+
+### Version 2.0
+
+* Starting with version 2.0 Florian Feldhaus and Piotr Kasprzak took over the development of the OCCI gem. The codebase was taken from the rOCCI framework and improved to be bundled as a standalone gem.
+
+### Version 1.X
+
+* Version 1.X of the OCCI gem has been developed by retr0h and served as a simple way to access the first OpenNebula OCCI implementation.
+
+Development
+-----------
+
+Checkout latest version from GIT:
+
+    git clone git://github.com/gwdg/rOCCI-cli.git
+
+Change to rOCCI-cli folder
+
+    cd rOCCI-cli
+
+Install dependencies for deployment
+
+    bundle install
+
+### Code Documentation
+
+[Code Documentation for rOCCI-cli by YARD](http://rubydoc.info/github/gwdg/rOCCI-cli/)
+
+### Continuous integration
+
+[Continuous integration for rOCCI-cli by Travis-CI](http://travis-ci.org/gwdg/rOCCI-cli/)
+
+### Contribute
+
+1. Fork it.
+2. Create a branch (git checkout -b my_markup)
+3. Commit your changes (git commit -am "My changes")
+4. Push to the branch (git push origin my_markup)
+5. Create an Issue with a link to your branch

data/Rakefile

@@ -0,0 +1,29 @@
+require 'rubygems/tasks'
+
+task :default => 'test'
+
+desc "Run all tests; includes rspec and coverage reports"
+task :test => 'rcov:all'
+
+Gem::Tasks.new(:build => {:tar => true, :zip => true}, :sign => {:checksum => true, :pgp => false})
+
+namespace :rcov do
+
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:rspec) do |t|
+    ENV['COVERAGE'] = "true"
+  end
+
+  desc "Run rspec to generate aggregated coverage"
+  task :all do |t|
+    rm "coverage/coverage.data" if File.exist?("coverage/coverage.data")
+    Rake::Task['rcov:rspec'].invoke
+  end
+
+end
+
+require 'yard'
+YARD::Rake::YardocTask.new(:yard) do |t|
+  t.options = ['--any', '--extra', '--opts'] # optional
+end

data/bin/occi

@@ -0,0 +1,351 @@
+#!/usr/bin/env ruby
+
+# -------------------------------------------------------------------------- #
+# Licensed under the Apache License, Version 2.0 (the "License"); you may    #
+# not use this file except in compliance with the License. You may obtain    #
+# a copy of the License at                                                   #
+#                                                                            #
+# http://www.apache.org/licenses/LICENSE-2.0                                 #
+#                                                                            #
+# Unless required by applicable law or agreed to in writing, software        #
+# distributed under the License is distributed on an "AS IS" BASIS,          #
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
+# See the License for the specific language governing permissions and        #
+# limitations under the License.                                             #
+#--------------------------------------------------------------------------- #
+
+require 'rubygems'
+require 'occi-cli'
+require 'pp'
+require 'highline/import'
+require 'openssl'
+
+extend Occi::Api::Dsl
+
+# get arguments and validate/parse them to an ostruct
+options = Occi::Cli::OcciOpts.parse ARGV
+
+# initialize logger
+logger = Occi::Log.new(options.log[:out])
+logger.level = options.log[:level]
+options.log[:logger] = logger
+
+# initialize output factory
+output = Occi::Cli::ResourceOutputFactory.new options.output_format
+
+Occi::Log.info "Starting OCCI client ..."
+Occi::Log.debug "Options: #{options}"
+
+# running with an empty password, we should ask the user for one
+# if auth method is not "none"
+if options.auth[:password].nil? || options.auth[:user_cert_password].nil?
+  Occi::Log.debug "Password is not set, asking for it now ..."
+
+  say("\n")
+
+  options.auth[:user_cert_password] = ask("Enter a password: ") {
+      |q| q.echo = false
+  } unless options.auth[:type] == "none" || (options.auth[:voms] && options.auth[:type] == "x509")
+
+  options.auth[:password] = options.auth[:user_cert_password]
+end
+
+# establish a connection before entering the loop
+# this will considerably speed-up the interactive mode and has
+# no effect on the non-interactive one
+begin
+  Occi::Log.info "Establishing a connection to #{options.endpoint} ..."
+
+  options.auto_connect = true
+  connect :http, options
+rescue OpenSSL::SSL::SSLError => ssl_ex
+  # generic SSL error raised whilst establishing a connection
+  # possibly an untrusted server cert or invalid user credentials 
+  Occi::Log.error "An SSL error occurred! Please, make sure your credentials " \
+                  "are valid and recognized by the endpoint! Message: #{ssl_ex.message}"
+
+  raise ssl_ex if options.debug
+  exit!
+rescue OpenSSL::PKey::RSAError => key_ex
+  # generic X509 error raised whilst reading user's credentials from a file
+  # possibly a wrong password or mangled/unsupported credential format
+  Occi::Log.error "An X509 error occurred! Please, make sure you are using the " \
+                  "right password and the file contains both your certificate " \
+                  "and your private key! Message: #{key_ex.message}"
+
+  raise key_ex if options.debug
+  exit!
+rescue Errno::ECONNREFUSED
+  # the remote server has refused our connection attempt(s)
+  # there is nothing we can do ...
+  Occi::Log.error "Connection refused by #{options.endpoint}!"
+  exit!
+rescue Exception => ex
+  # something went wrong during the execution
+  # hide the stack trace in non-debug modes
+  Occi::Log.error "An error occurred! Message: #{ex.message}"
+
+  raise ex if options.debug
+  exit!
+end
+
+# dump the occi model provided by the server and exit
+if options.dump_model
+
+  if !model.respond_to? :instance_variables
+    Occi::Log.error "Your Ruby doesn't support 'instance_variables' calls!"
+    exit!
+  end
+
+  collection = model.get options.filter
+
+  # iterate through available instance variables
+  collection.instance_variables.each do |inst_var_sym|
+    puts "#"*79
+    puts "Dumping #{inst_var_sym.to_s}:"
+
+    inst_var = collection.instance_variable_get(inst_var_sym)
+    next unless inst_var.respond_to? :each
+
+    # iterate through collection elements
+    inst_var.each do |coll_elm|
+      # respect user's output-format preferences
+      if options.output_format == :json and coll_elm.respond_to? :as_json
+        puts "\n"
+        pp coll_elm.as_json
+        puts "\n"
+      elsif coll_elm.respond_to? :to_string
+        puts "\n#{coll_elm.to_string}\n"
+      else
+        puts "\n#{coll_elm.inspect}\n"
+      end
+    end
+
+    #
+    puts "#"*79
+  end
+
+  exit! true
+end
+
+# start of the main loop, this part of the code is responsible for
+# interactive menus and actions execution
+# this block will run while options.interactive is True, i.e.
+# only once in the non-interactive mode
+begin
+
+  # display menus in the interactive mode, there are two main variables
+  # that need to be set here: options.action and options.resource
+  if options.interactive
+
+    Occi::Log.debug "Running in an interactive mode ..."
+
+    # reset action and resource, just to be sure
+    options.action = nil
+    options.resource = nil
+
+    # offer just the resource types we will be able to process
+    menu_resources = Occi::Cli::ResourceOutputFactory.allowed_resource_types
+
+    # separate menus from each other
+    say("\n")
+
+    # first we need an action
+    choose do |menu|
+      menu.prompt = "Please, choose an action: "
+
+      # list action requires a resource type
+      menu.choice(:list) {
+        options.action = :list
+
+        # separate menus from each other
+        say("\n")
+
+        choose do |list_menu|
+          list_menu.prompt = "Which one should I list? "
+
+          menu_resources.each do |menu_resource|
+            list_menu.choice(menu_resource) { options.resource = menu_resource.to_s }
+          end
+
+          list_menu.choice(:back) { options.action = :skip }
+        end
+      }
+
+      # describe action requires a resource type or a resource location
+      menu.choice(:describe) {
+        options.action = :describe
+
+        # separate menus from each other
+        say("\n")
+
+        # display the resource types first
+        choose do |describe_menu|
+          describe_menu.prompt = "Which one should I describe? "
+
+          menu_resources.each do |menu_resource|
+            describe_menu.choice(menu_resource) {
+              options.resource = menu_resource.to_s
+
+              # separate menus from each other
+              say("\n")
+
+              # display available resources for this resource type
+              choose do |describe_menu_spec|
+                describe_menu_spec.prompt = "Should I describe a specific resource? "
+
+                describe_menu_spec.choice(:all) {
+                  # leave options.resource set to compute/network/storage
+                }
+
+                found = helper_list options
+                found.each do |found_resource|
+                  describe_menu_spec.choice(found_resource.to_sym) { options.resource = found_resource }
+                end
+
+                describe_menu_spec.choice(:back) { options.action = :skip }
+              end unless menu_resource.to_s.reverse.start_with? "lpt_"
+            }
+          end
+
+          describe_menu.choice(:back) { options.action = :skip }
+        end
+      }
+
+      # create action requires resource type, resource title
+      # and optionally mixins (usually two, os_tpl and resource_tpl)
+      menu.choice(:create) {
+        options.action = :create
+
+        # separate menus from each other
+        say("\n")
+
+        # display the resource types
+        choose do |create_menu|
+          create_menu.prompt = "Which one should I create? "
+
+          menu_resources.each do |menu_resource|
+            create_menu.choice(menu_resource) {
+              options.resource = menu_resource.to_s
+            } unless menu_resource.to_s.reverse.start_with? "lpt_"
+          end
+
+          create_menu.choice(:back) { options.action = :skip }
+        end
+
+        # if the user didn't choose "Back", ask for details
+        # TODO: currently only COMPUTE is supported
+        if options.action == :create
+          options.attributes = {} if options.attributes.nil?
+
+          options.attributes[:title] = ask("What name should I give to the new resource? ")
+          number_of_mixins = ask("How many mixins do you wish me to mix into this resource? ",
+                                 Integer) { |q| q.in = 0..2 }
+
+          options.mixins = {}
+          (1..number_of_mixins).each do |mixin_number|
+            mixin = ask("What mixin should I mix in? ") { |q| q.validate = /\A\w+#\w+\Z/ }
+            parts = mixin.split("#")
+
+            options.mixins[parts[0]] = [] if options.mixins[parts[0]].nil?
+            options.mixins[parts[0]] << parts[1]
+          end
+        end
+      }
+
+      # delete action requires a resource location
+      menu.choice(:delete) {
+        options.action = :delete
+
+        # separate menus from each other
+        say("\n")
+
+        # display the resource types first
+        choose do |delete_menu|
+          delete_menu.prompt = "Please, choose a resource type: "
+
+          menu_resources.each do |menu_resource|
+            delete_menu.choice(menu_resource) {
+
+              # separate menus from each other
+              say("\n")
+
+              # display available resources for this type
+              choose do |delete_menu_spec|
+                delete_menu_spec.prompt = "Which resource should I delete? "
+
+                opts = OpenStruct.new
+                opts.resource = menu_resource.to_s
+
+                found = helper_list opts
+                found.each do |found_resource|
+                  delete_menu_spec.choice(found_resource.to_sym) { options.resource = found_resource }
+                end
+
+                delete_menu_spec.choice(:back) { options.action = :skip }
+              end unless menu_resource.to_s.reverse.start_with? "lpt_"
+            } unless menu_resource.to_s.reverse.start_with? "lpt_"
+          end
+
+          delete_menu.choice(:back) { options.action = :skip }
+        end
+      }
+
+      # TODO: trigger is not yet implemented
+      menu.choice(:trigger) {
+        options.action = :skip
+        say("Not implemented yet!")
+      }
+
+      # refresh the OCCI model structures without exiting/re-launching
+      # the client, useful when adding new os_tpls/resource_tpls on
+      # the server
+      menu.choice(:refresh) {
+        options.action = :refresh
+      }
+
+      # enough is enough, bye!
+      menu.choice(:quit) {
+        say("Good bye!")
+        exit!(true)
+      }
+    end
+  end
+
+  Occi::Log.info "Executing action #{options.action.to_s} on #{options.resource} ..."
+
+  # call the appropriate helper and then format its output
+  case options.action
+    when :list
+      helper_list options, output
+    when :describe
+      helper_describe options, output
+    when :create
+      helper_create options, output
+    when :delete
+      helper_delete options, output
+    when :trigger
+      helper_trigger options, output
+    when :refresh
+      refresh
+    when :skip
+      Occi::Log.info "Skipping this action, probably not implemented yet!"
+    else
+      raise "Unknown action [#{options.action}]!"
+  end
+
+rescue Errno::ECONNREFUSED
+  # remote server refused our connection attempt(s)
+  # even though initial connect was successful
+  Occi::Log.error "Connection refused by #{options.endpoint}!"
+  exit!
+rescue Exception => ex
+  # something went wrong during the execution
+  # hide the stack trace in non-debug modes
+  Occi::Log.error "An error occurred! Message: #{ex.message}"
+
+  raise ex if options.debug
+  exit!
+end while options.interactive
+
+Occi::Log.info "OCCI client is shutting down ..."