cloudstack_spec 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61f87ea881f5a0783f43f8e36f9b2f8dc259bdfc
+  data.tar.gz: 8f00617d2bb2afa76eb774d1a681a9cd40ffa668
+SHA512:
+  metadata.gz: ccb5830c0d4742e25ab50502ac30ac58bf93869e7a83380f314ab6df177008b23736ecbe54c74e56c39b4ea35829a81b8eee25623aa080eab2385c123ce98245
+  data.tar.gz: cc861a825f3833307b487398bb6265802ec5968386af83526d7be96e6088b44aca63dcc710b81de3a19d3017d9e6437369d4c47244de21190896fd882cb92a4d

data/.gitignore

@@ -0,0 +1,16 @@
+notes.txt
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cloudstack_spec.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2014 Pierre-Luc Dion
+
+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,127 @@
+# CloudstackSpec
+
+...Work In Progress...
+
+[Apache CloudStack](http://cloudstack.apache.org/) test framework based on Rspec library. Similar to [serverspec](http://serverspec.org/) it is used to test and validate CloudStack installation and configurations.
+
+
+## Installation
+
+install as gem:
+
+    $ gem install cloudstack_spec
+
+Create a test repo folder:
+  
+    $ mkdir my_cloudstack_spec
+    $ cd my_cloudstack_spec
+
+Initialize cloudstack_spec:
+
+    $ cloudstackspec-init
+    Create base for cloudstack_spec? y/n: y
+     + spec/
+     + spec/lib/
+     + spec/config.yml
+     + spec/lib/001_zone_spec.rb
+     + spec/spec_helper.rb
+    Make sure to Update file: spec/config.yml
+    $
+
+or
+
+Clone this repo:
+
+    $ git clone https://github.com/pdion891/cloudstack_spec.git
+    $ cd cloudstack_spec
+
+
+## Configuration
+
+Update ``spec/config.yml`` to reflect your environment
+
+```yaml
+cloudstack:
+  url:        http://[cloustack_management_ip]:8080/client/api
+  api_key:    rkVsYauTGYkR2I0aX3Qmh4s3cfdtR5LNnw7cNKCpHnzKsA-zaXUn7k__fbBga-l0BQl9Qlmq57tkaj67L7W_bg
+  secret_key: dS0grBtPMbg5PTr62VLeApd55pssU5fObcW-hmGjiUNyBWw67BRPWRJrXQ5OfO0LTzLRdN-pHiDz25K1o3qLeA
+  use_ssl:    false
+```
+
+## Usage
+
+Create test definition file in ``spec/lib/[test]_spec.rb`` as example in the directory.
+
+### test example
+
+```spec
+require 'spec_helper'
+
+describe zone do
+  it { should exist }
+  it { should be_allocated }
+  its(:local_storage) { should be_set }
+  its(:security_group) { should_not be_set }
+  its(:network_type) { should match("Advanced") }
+end
+
+%w(consoleproxy secondarystoragevm).each do |svm|
+  describe system_vm(svm) do
+    it { should exist }
+    it { should be_running }
+    it { should be_reachable }
+  end
+end
+
+```
+
+### Execute test run
+
+Simply run ``rspec`` or define test case file as follow:
+
+```bash
+rspec spec/lib/[test_scenario]_spec.rb
+
+#ex:
+
+rspec spec/lib/001_zone_spec.rb
+```
+
+Output example:
+
+    $ rspec spec/lib/1_zone_spec.rb
+    Testing system:     http://123.123.123.123:8080/client/api
+    CloudStack version: 4.4.1
+    executed at:        2014-11-16 19:28:49 -0500
+    
+    Zone "preprod2_zone1"
+      should exist
+      should be allocated (Enabled)
+      local_storage
+        should be enabled
+      security_group
+        should not be enabled
+      network_type
+        should match "Advanced"
+    
+    System Vm "consoleproxy"
+      should exist
+      should be running
+      should be reachable
+    
+    System Vm "secondarystoragevm"
+      should exist
+      should be running
+      should be reachable
+    
+    Finished in 2.24 seconds (files took 1.2 seconds to load)
+    11 examples, 0 failures
+
+
+## Contributing
+
+1. Fork it ( https://github.com/pdion891/cloudstack_spec/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/cloudstackspec-init

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib/cloudstack_spec/setup])
+
+require 'cloudstack_spec/setup'
+
+CloudstackSpec::Setup.run

data/cloudstack_spec.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cloudstack_spec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cloudstack_spec"
+  spec.version       = CloudstackSpec::VERSION
+  spec.authors       = ["Pierre-Luc Dion"]
+  spec.email         = ["pdion891@apache.org"]
+  spec.summary       = %q{RSpec tests for Apache CloudStack.}
+  spec.description   = %q{Servespec like tests for Apache CloudStack using Rspec.}
+  spec.homepage      = "https://github.com/pdion891/cloudstack_spec"
+  spec.license       = "Apache 2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'yaml', '~> 0'
+  spec.add_runtime_dependency "rspec-its", '~> 1'
+  spec.add_runtime_dependency "rspec", '~> 3'
+  spec.add_runtime_dependency "uuid", '~> 2'
+  spec.add_runtime_dependency "cloudstack_ruby_client", '~> 1.0', '>= 1.0.2'
+
+end

data/examples/output_example.txt

@@ -0,0 +1,56 @@
+Testing system:     http://172.16.21.126:8080/client/api
+CloudStack version: 4.4.1
+
+Zone "preprod2_zone1"
+  should exist
+  should be allocated (Enabled)
+  local_storage
+    should be enabled
+  security_group
+    should not be enabled
+  network_type
+    should match "Advanced"
+
+System Vm "consoleproxy"
+  should exist
+  should be running
+  should be reachable
+
+System Vm "secondarystoragevm"
+  should exist
+  should be running
+  should be reachable
+
+Network "test1"
+  should exist
+  should be ready (FAILED - 1)
+
+Template "CentOS 5.6(64-bit) no GUI (XenServer)"
+  should exist
+  should be ready
+
+Template "Ubuntu 14.04 LTS"
+  should exist
+  should be ready (FAILED - 2)
+
+Failures:
+
+  1) Network "test1" should be ready
+     Failure/Error: it { should be_ready }
+       status: VR state: Stopped
+
+     # ./spec/lib/network_spec.rb:3:in `block (2 levels) in <top (required)>'
+
+  2) Template "Ubuntu 14.04 LTS" should be ready
+     Failure/Error: it { should be_ready }
+       status: 7% Downloaded
+
+     # ./spec/lib/template_spec.rb:10:in `block (2 levels) in <top (required)>'
+
+Finished in 24.68 seconds (files took 1.47 seconds to load)
+17 examples, 2 failures
+
+Failed examples:
+
+rspec ./spec/lib/network_spec.rb:3 # Network "test1" should be ready
+rspec ./spec/lib/template_spec.rb:10 # Template "Ubuntu 14.04 LTS" should be ready

data/lib/cloudstack_spec.rb

@@ -0,0 +1,56 @@
+require 'rspec'
+require 'rspec/its'
+require 'specinfra'
+require 'cloudstack_spec/version'
+require 'cloudstack_spec/resource'
+require 'cloudstack_spec/helper'
+require 'cloudstack_spec/matcher'
+require 'cloudstack_spec/setup'
+require 'cloudstack_spec/resource/base'
+
+
+module CloudstackSpec
+
+  #output the url + version under test
+  @client = CloudstackSpec::Helper::Api.new
+  puts "Testing system:     #{@client.url}"
+  puts "CloudStack version: #{@client.version}"
+  puts "executed at:        " + Time.now.to_s
+
+end
+
+class String
+  def to_snake_case
+    self.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("-", "_").
+    downcase
+  end
+
+  def to_camel_case
+    return self if self !~ /_/ && self =~ /[A-Z]+.*/
+    split('_').map{|e| e.capitalize}.join
+  end
+end
+
+module RSpec::Core::Notifications
+  class FailedExampleNotification 
+    def failure_lines
+      @failure_lines ||=
+        begin
+          lines = []
+#          lines << "On host `#{host}'" if host
+          lines << "Failure/Error: #{read_failed_line.strip}"
+#          lines << "#{exception_class_name}:" unless exception_class_name =~ /RSpec/
+          exception.message.to_s.split("\n").each do |line|
+            lines << "  #{line}" if exception.message
+          end
+#          lines << "  #{example.metadata[:command]}"
+#          lines << "  #{example.metadata[:stdout]}" if example.metadata[:stdout]
+#          lines << "  #{example.metadata[:stderr]}" if example.metadata[:stderr]
+#          lines
+        end
+    end
+  end
+end

data/lib/cloudstack_spec/helper.rb

@@ -0,0 +1,9 @@
+# Subject type helper
+require 'cloudstack_spec/helper/resource'
+require 'cloudstack_spec/helper/api'
+
+extend CloudstackSpec::Helper::Resource
+class RSpec::Core::ExampleGroup
+  extend CloudstackSpec::Helper::Resource
+  include CloudstackSpec::Helper::Resource
+end

data/lib/cloudstack_spec/helper/api.rb

@@ -0,0 +1,40 @@
+# API call to Apache CloudStack
+module CloudstackSpec::Helper
+  class Api
+    def connection
+      configs     = YAML.load_file("spec/config.yml")
+      _url        = configs['cloudstack']['url']
+      _api_key    = configs['cloudstack']['api_key']
+      _secret_key = configs['cloudstack']['secret_key']
+      _use_ssl    = configs['cloudstack']['use_ssl']
+      @client     = CloudstackRubyClient::Client.new(
+                    "#{_url}",
+                    "#{_api_key}",
+                    "#{_secret_key}", 
+                    _use_ssl)
+    end
+  
+    def connection2
+      configs     = YAML.load_file("spec/config.yml")
+      _url        = configs['cloudstack']['url']
+      _use_ssl    = configs['cloudstack']['use_ssl']
+      _api_key    = $api_key
+      _secret_key = $secret_key
+      @client     = CloudstackRubyClient::Client.new(
+                    "#{_url}",
+                    "#{_api_key}",
+                    "#{_secret_key}", 
+                    _use_ssl)
+    end
+
+    def url
+      connection.instance_variable_get(:@api_url)
+    end
+    
+    def version
+      connection.list_capabilities["capability"]["cloudstackversion"]
+    end
+  end
+end
+
+

data/lib/cloudstack_spec/helper/resource.rb

@@ -0,0 +1,19 @@
+module CloudstackSpec
+  module Helper
+    module Resource
+      resources = %w(
+        base template zone system_vm network virtual_machine vpc snapshot 
+        template_from_snapshot vpc_tier domain account project
+      )
+
+      resources.each {|resource| require "cloudstack_spec/resource/#{resource}" }
+
+      resources.each do |resource|
+        define_method resource do |*args|
+          name = args.first
+          eval "CloudstackSpec::Resource::#{resource.to_camel_case}.new(name)"
+        end
+      end
+    end
+  end
+end

data/lib/cloudstack_spec/matcher.rb

@@ -0,0 +1,12 @@
+# GENERIC
+require 'cloudstack_spec/matcher/be_set'
+require 'cloudstack_spec/matcher/be_running'
+
+# ZONE
+require 'cloudstack_spec/matcher/be_allocated'
+
+# TEMPLATE
+require 'cloudstack_spec/matcher/be_ready'
+
+# VIRTUAL-MACHINE
+require 'cloudstack_spec/matcher/be_created'

data/lib/cloudstack_spec/matcher/be_allocated.rb

@@ -0,0 +1,23 @@
+# If the zone is allocated (Enabled)
+
+RSpec::Matchers.define :be_allocated do |expected|
+  match do |actual|
+    actual.allocated? == true
+  end
+
+  failure_message do |actual|
+    "status: #{actual.allocated?}"
+  end
+ 
+  description do
+    "be allocated (Enabled)"
+  end
+
+  failure_message_when_negated do |actual|
+    "Status: #{actual}"
+  end
+
+  chain :with_level do |level|
+    @level = level
+  end
+end

data/lib/cloudstack_spec/matcher/be_created.rb

@@ -0,0 +1,30 @@
+RSpec::Matchers.define :created do |expected|
+  match do |actual|
+    #UUID.validate(actualz) == true
+    #puts "actual = #{actual}"
+    #puts "#{actual.name}"
+    #if UUID.validate(actual.is_created?) == true
+    #  jobstatus = @connection.query_async_job_result(jobid: actual)['jobstatus']
+    #  until jobstatus != 0
+    #    jobstatus = @connection.query_async_job_result(jobid: actual)['jobstatus']
+    #    sleep(5)
+    #  end
+    #  jobstatus == 1
+    #else
+    #  false
+    #end
+  end
+
+  failure_message do |actual|
+    "#{actual} status: #{actual.is_creating}"
+  end
+ 
+  description do
+    "#{actual} be created, #{actual.is_creating}"
+  end
+
+  failure_message_when_negated do |actual|
+    "VM creation not should not be possible"
+  end
+
+end