polytrix 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8655afabebaa23eba72bb5028b0efb5d22ecc7d7
+  data.tar.gz: 336634653e22e6b814edbb9fc00598fc32c431f5
+SHA512:
+  metadata.gz: 16ee58b313175b50b7b446a9bbcfc3699b80261ab3502d26c2b785ce51e121b7d50ced60f72edd61396ec75c42167da7ca6ea4049799af9ce9eb531e8c47c39b
+  data.tar.gz: 4e0cdb6e135581bbdaee0eb5fb06d0771335448f4b944eb345cec16772e4a2447a28a3e3bc0d93dd256fd9f123e22e137ed50bd06784b7265e77b9a9ffe198ce

data/.gitignore

@@ -0,0 +1,13 @@
+Gemfile.lock
+pacto.log
+**/.bundle/*.log
+reports/
+.rbenv-vars
+.packer-creds.json
+**/tmp/
+node_modules/
+.tokens.json
+docs/
+/polytrix/
+pkg/
+coverage/

data/.groc.json

@@ -0,0 +1,7 @@
+{
+  "glob": ["docs/src/*/challenges/**.*"],
+  "strip": ["docs/src"],
+  "github": false,
+  "index": "README.md",
+  "out": "docs/groc"
+}

data/.rspec

@@ -0,0 +1,11 @@
+-I features
+--format MatrixFormatter::Formatters::JSONFormatter
+--out reports/matrix<%= ENV['TEST_ENV_NUMBER'].to_i %>.json
+--format MatrixFormatter::Formatters::HTMLFormatter
+--out reports/matrix.html
+--format html
+--out reports/rspec.html
+--format documentation
+--color
+--require features_helper.rb
+

data/.rspec_parallel

@@ -0,0 +1,10 @@
+-I features
+--format MatrixFormatter::Formatters::JSONFormatter --out reports/matrix<%= ENV['TEST_ENV_NUMBER'].to_i %>.json
+--format ParallelTests::RSpec::SummaryLogger --out reports/spec_summary.log
+--format ParallelTests::RSpec::FailuresLogger --out reports/failing_specs.log
+--format RspecJunitFormatter --out reports/junit/rspec<%= ENV['TEST_ENV_NUMBER'].to_i %>.xml
+--format documentation
+--color
+--require features_helper.rb
+--failure-exit-code 0
+

data/Gemfile

@@ -0,0 +1,23 @@
+# A sample Gemfile
+source "https://rubygems.org"
+gemspec
+
+gem "pacto", :git => 'https://github.com/thoughtworks/pacto', :branch => 'uri_templates'
+# uriTemplate support merged  into webmock but not yet released - webmock#334
+gem "webmock", :git => 'https://github.com/bblimke/webmock', :branch => 'master'
+# optional param fix merged but not yet released - addressable#140
+gem "addressable", :git => 'https://github.com/sporkmonger/addressable.git', :branch => 'master'
+gem "fog", '~> 1.19'
+gem "vcr"
+gem "goliath"
+gem "excon"
+gem "em-http-request"
+gem "rspec_junit_formatter"
+gem "pry"
+gem "matrix_formatter", :git => 'https://github.com/maxlinc/matrix_formatter', :branch => 'html5'
+gem "highline"
+gem "parallel_tests"
+gem "rake-notes"
+gem "simplecov"
+gem "mixlib-shellout"
+

data/README.md

@@ -0,0 +1,48 @@
+# DRG Tests #
+
+This repo contains smoke tests for Rackspace SDKs.  In order to run it you'll either need:
+  - Lots of dependencies installed on your laptop
+  - VirtualBox & Vagrant, so you can install the necessary dependencies inside a local VM
+  - Packer and Vagrant-Rackspace, so you can build images and use images on the Rackspace cloud to run tests
+
+The last option can also be combined with Jenkins JClouds plugin in order to setup CI builds using the images produced by Packer.
+
+## Dependencies
+
+The tests will use package managers for each SDK where appropriate (e.g. bundler for fog, npm for pkgcloud, etc.)  You need to be setup at least to the point where those package managers can run.  You'll also need dnsmasq in order to intercept some of the HTTP transactions for testing purposes.  It is possible to set this all up on your own machine - but the easiest way is to use Vagrant, Packer, or anything else that will let you use the Chef scripts in the project (targeted for Ubuntu).
+
+## Creating a DRG Image
+
+### Packer
+
+The easiest way to create an image is with [Packer](http://www.packer.io).
+
+### Rackspace credentials
+
+You need to create a `.rbenv-vars` file with your Rackspace credentials.  These will be loaded as environment variables when the tests run.  The file should contain:
+
+```
+RAX_USERNAME=<your_rackspace_username>
+RAX_API_KEY=<your_rackspace_api_key>
+```
+
+### Getting a DRG box
+
+There is a Vagrantfile in the project.  It uses a "DRG" box.  There isn't currently a published DRG box, so you'll need to produce your own.  You can:
+
+* Comment out `config.vm.box = "drg"` and uncomment the other lines with an alternate box.
+* Run `vagrant up`, `vagrant provision`, and then `vagrant package --output drg.box`.  These steps will take a while.
+* Run `vagrant box add drg drg.box`
+* You now have a drg box, and can restore the Vagrant file to it's original state.
+
+### Running tests
+
+
+
+### (Tenative) Roadmap
+* Use standard, shared images (travis-images? vagrantcloud?)
+* Integrate with travis-build for .travis.yml support
+* Separate Polytrix framework from reference tests
+
+### BHAG
+* Run tests as an interactive course via a browser

data/Rakefile

@@ -0,0 +1,143 @@
+require 'polytrix'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'pacto/rake_task'
+require 'rake/notes/rake_task'
+require 'highline/import'
+require 'json'
+
+NOT_SETUP = "You need to set RAX_USERNAME and RAX_API_KEY env vars in order to run tests"
+
+RSpec::Core::RakeTask.new('features') do |t|
+  t.rspec_opts = "-I features"
+  t.pattern = 'features/**/*_spec.rb'
+end
+
+RSpec::Core::RakeTask.new('spec') do |t|
+  t.rspec_opts = "-f documentation"
+end
+
+task :default => :spec
+
+desc 'Run all the SDK tests'
+task :features => [:check_setup]
+
+desc 'Check pre-requisites'
+task :check_setup do
+  fail NOT_SETUP unless ENV['RAX_USERNAME'] && ENV['RAX_API_KEY']
+end
+
+desc 'Remove reports and other generated artifacts'
+task :clean do
+  FileUtils.rm_rf 'docs'
+  FileUtils.rm_rf 'reports'
+end
+
+desc 'Fetch dependencies for each SDK'
+task :bootstrap do
+  Bundler.with_clean_env do
+    Dir['sdks/*'].each do |sdk_dir|
+      Dir.chdir sdk_dir do
+        if is_windows?
+          system "PowerShell -NoProfile -ExecutionPolicy Bypass .\\scripts\\bootstrap"
+        else
+          system "scripts/bootstrap"
+        end
+      end
+    end
+  end
+end
+
+desc 'Configure the test framework'
+task :setup do
+  username = ask "Enter your Rackspace Username: "
+  api_key  = ask("Enter your Rackspace API KEY: "){|q| q.echo = "*"}
+  password = ask("Enter your Rackspace Password (for Packer): "){|q| q.echo = "*"}
+
+  puts "Creating .rbenv-vars"
+  File.open(".rbenv-vars", 'w') do |f|
+    f.puts "RAX_USERNAME=#{username}"
+    f.puts "RAX_API_KEY=#{api_key}"
+    f.puts
+  end
+
+  puts "Creating .packer-creds.json"
+  packer_creds = {
+    "RAX_USERNAME" => username,
+    "RAX_PASSWORD" => password
+  }
+  File.open(".packer-creds.json", "w") do |f|
+    f.puts JSON.pretty_generate packer_creds
+  end
+end
+
+namespace :documentation do
+  desc 'Generate annoted source code'
+  task :annotated do
+    system "groc"
+  end
+
+  task :copy_src do
+    sdks = Dir['sdks/*'].each do |sdk|
+      sdk = File.basename sdk
+      FileUtils.mkdir_p "docs/src/#{sdk}"
+      FileUtils.cp_r "sdks/#{sdk}/challenges/", "docs/src/#{sdk}"
+    end
+  end
+
+  desc 'Generate the Feature Matrix dashboard'
+  task :dashboard => [:copy_src, :annotated] do
+    $: << 'features'
+    require  'features_helper'
+    require "matrix_formatter/assets/generator"
+    require "matrix_formatter/formatters/html5_report_writer"
+    require 'fileutils'
+
+    asset_generator_options = {
+      :extra_resource_paths => ['lib/formatter/resources']
+    }
+    asset_generator = MatrixFormatter::Assets::Generator.new asset_generator_options
+    asset_generator.generate
+
+    output = File.open("docs/dashboard.html", 'w')
+    options = {:view => 'angular.html.slim', :layout => 'default_layout.html.slim'}
+    formatter = MatrixFormatter::Formatters::HTML5ReportWriter.new output, options
+    matrix = formatter.parse_results Dir['reports/matrix*.json']
+    # puts MultiJson.encode formatter.matrix
+    formatter.write_report
+    output.close
+
+    fail "Combined results contain failures - check the reports" if formatter.has_failures?
+  end
+end
+
+desc "Run the tests in parallel, split by SDK.  Doesn't work on Windows, but you can use rspec_parallel to split by file instead."
+task :parallel_spec do
+  tags = Dir['sdks/*'].map{|sdk| File.basename sdk}
+  puts "Detected SDKs: #{tags}"
+  threads = []
+  Thread.main[:results] = []
+  tags.each_with_index do | tag, index |
+    threads << Thread.new do
+      puts "Starting #{tag} on process #{index}"
+      Thread.main[:results] << {
+        :tag => tag,
+        :success  => sh("TEST_ENV_NUMBER=#{index} bundle exec rspec --options .rspec_parallel -t #{tag} features")
+      }
+    end
+  end
+  threads.each do |thread|
+    thread.join
+  end
+end
+
+namespace :image do
+  desc 'Build a Rackspace image (using Packer)'
+  task :rackspace do
+    system "cd packer; packer build -var-file=../.packer-creds.json -only openstack packer.json"
+  end
+end
+
+def is_windows?
+  RbConfig::CONFIG['host_os'] =~ /mswin(\d+)|mingw/i
+end

data/Vagrantfile

@@ -0,0 +1,41 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# Vagrantfile API/syntax version. Don't touch unless you know what you're doing!
+VAGRANTFILE_API_VERSION = "2"
+
+Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
+  config.vm.box = "drg"
+
+  # Original box used to build pre-packaged DRG box
+  # config.vm.box = "ubuntu1310"
+  # config.vm.box_url = "https://dl.dropboxusercontent.com/s/ng79gg5bg24r38p/ubuntu1310.box?token_hash=AAGKH9rJTMozemrLMLw8n8Htvg8-gGhb7xo8cwh0TaYCaw&dl=1"
+
+  config.cache.auto_detect = true
+
+  config.vm.provision :shell, :inline => "curl -L https://opscode.com/chef/install.sh | bash"
+
+  config.vm.define :polytrix do |vm|
+  end
+
+  config.vm.provider :rackspace do |rs, override|
+    override.vm.box = "dummy"
+    override.ssh.private_key_path = '~/.ssh/id_rsa'
+    rs.public_key_path = '~/.ssh/id_rsa.pub'
+    rs.username = ENV['RAX_USERNAME']
+    rs.api_key  = ENV['RAX_API_KEY']
+    rs.flavor   = /2 GB Performance/
+    rs.image    = "DRG" # image created by packer.  See ./packer/
+    rs.rackspace_region = :ord
+  end
+
+  config.vm.provision :chef_solo do |chef|
+    chef.cookbooks_path = ["packer/cookbooks", "packer/vendor/cookbooks"]
+    chef.add_recipe "drg"
+    # chef.log_level = :debug
+    chef.json = {
+      :instance_role => "vagrant"
+    }
+  end
+
+end

data/features/0_identity_spec.rb

@@ -0,0 +1,40 @@
+describe 'Getting Started', :markdown =>
+  """
+  Welcome to the SDK guide!
+
+  In this section, you will learn how to connect to OpenStack by authenticating against the [Identity service](http://docs.openstack.org/api/openstack-identity-service/2.0/content/).
+
+  By the end of the section, you will know:
+  - You have valid, working credentials
+  - You are able to load use the SDK of your choice
+
+  In the sections that follow, we will build the cloud infrastructure for a sample application using the OpenStack services.
+  """ do
+  code_sample 'authenticate token', """
+  Please use the SDK to [authenticate](http://docs.rackspace.com/auth/api/v2.0/auth-client-devguide/content/POST_authenticate_v2.0_tokens_Token_Calls.html) using a username and API key.
+  """, standard_env_vars, [:Authenticate] do
+    # Assertions
+    expect(Pacto).to have_validated_service('Identity', 'Authenticate')
+    expect(Pacto).to_not have_failed_validations
+    expect(Pacto).to_not have_unmatched_requests
+  end
+
+  code_sample 'all connections', """
+  Let's make a connection to each of the available OpenStack products
+  """, standard_env_vars, [] do
+    expect(Pacto).to have_validated_service('Identity', 'Authenticate')
+    expect(Pacto).to have_validated_service('Cloud Servers', 'List Servers')
+    expect(Pacto).to have_validated_service('Cloud Networks', 'List Networks')
+    expect(Pacto).to have_validated_service('Cloud Files', 'List Containers')
+    expect(Pacto).to have_validated_service('Cloud Load Balancers', 'List Load Balancers')
+    expect(Pacto).to have_validated_service('Cloud Databases', 'List Instances')
+    expect(Pacto).to have_validated_service('DNS', 'List Domains')
+    # Only a few SDKs have implemented monitoring
+    # expect(Pacto).to have_validated_service('Cloud Monitoring', 'Get Account')
+    expect(Pacto).to have_validated_service('Cloud Block Storage', 'List Volumes')
+    expect(Pacto).to have_validated_service('Autoscale', 'List Groups')
+    expect(Pacto).to have_validated_service('Cloud Queues', 'List Queues')
+    expect(Pacto).to_not have_failed_validations
+    # expect(Pacto).to_not have_unmatched_requests
+  end
+end

data/features/1_cloud_files_spec.rb

@@ -0,0 +1,48 @@
+describe 'Cloud Files', :markdown =>
+  """
+  In this section we'll cover Cloud Files.  We'll start with a few simple services.  In the final example for this section, we will upload static assets to a CDN-enabled Cloud Files container that will be used by our sample application.
+  """ do
+  env = standard_env_vars
+  file = build :file, env
+  env.merge!(
+    'TEST_DIRECTORY' => file.directory.key,
+    'TEST_FILE' => file.key
+  )
+
+  vars = standard_env_vars
+  code_sample "List Containers", """
+  Use the SDK to list your existing cloud Cloud Files containers.
+  """, vars, [] do |success|
+    # Assertions
+    expect(Pacto).to have_validated_service('Cloud Files', 'List Containers')
+    expect(Pacto).to_not have_failed_validations
+    expect(Pacto).to_not have_unmatched_requests
+  end
+
+  code_sample "Get object metadata", """
+  Now, use the SDK to retrieve a file from Cloud Files.
+  """, env, [] do
+    expect(Pacto).to have_validated_service('Cloud Files', 'Get Object Metadata')
+    # Not that we're validated it did *not* get the data
+    expect(Pacto).to_not have_validated('Cloud Files', 'Get Object Data')
+  end
+
+  code_sample "Upload a single file", """
+  Now, let's upload logo.png to Cloud Files so we can start building a website.
+  """, env, [] do
+    pending
+  end
+
+  code_sample "Upload static assets", """
+  Finally, let's upload static assets (javascript, css, images, fonts) for a website.
+  """, env, [] do
+    pending
+  end
+
+  code_sample "Upload static assets", """
+  Let's enable the CDN for our assets.
+  """, env, [] do
+    pending
+  end
+
+end

data/features/2_servers_spec.rb

@@ -0,0 +1,19 @@
+describe 'Cloud Servers', :markdown =>
+  """
+  
+  Scenarios using [Next Generation Cloud Servers API V2](http://docs.rackspace.com/servers/api/v2/cs-devguide/content/ch_preface.html).
+  """ do
+    code_sample "Create Server", """
+    [Create a Server](http://docs.rackspace.com/servers/api/v2/cs-devguide/content/CreateServers.html)
+    using the image and flavor, and region specified in the environment.
+    """, standard_env_vars.merge({
+      'RAX_REGION' => 'DFW',
+      'SERVER1_IMAGE' => 'f70ed7c7-b42e-4d77-83d8-40fa29825b85',
+      'SERVER1_FLAVOR' => 'performance1-1'
+    }),  [] do |success|
+      # Assertions
+      expect(Pacto).to have_validated_service('Cloud Servers', 'Create Server')
+      expect(Pacto).to_not have_failed_validations
+      expect(Pacto).to_not have_unmatched_requests
+  end
+end

data/features/features_helper.rb

@@ -0,0 +1,46 @@
+$:.unshift File.expand_path('../pacto', File.dirname(__FILE__))
+require 'polytrix/rspec'
+require 'webmock/rspec'
+require 'matrix_formatter'
+require 'helpers/pacto_helper'
+require 'pacto/extensions/matchers'
+require 'pacto/extensions/loaders/simple_loader'
+require 'pacto/extensions/loaders/api_blueprint_loader'
+require 'helpers/teardown_helper'
+require 'helpers/cloudfiles_helper'
+
+SDKs = Dir['sdks/*'].map{|sdk| File.basename sdk}
+
+Polytrix.implementors = SDKs.map{ |sdk|
+  Polytrix::Implementor.new :name => sdk #, :language => lang
+}
+
+require 'polytrix/runners/middleware/pacto'
+Polytrix.configure do |c|
+  c.middleware.insert 0, Polytrix::Runners::Middleware::Pacto, {}
+end
+
+RSpec.configure do |c|
+  c.matrix_implementors = SDKs
+  c.treat_symbols_as_metadata_keys_with_true_values = true
+  c.include Polytrix::RSpec::Helper
+end
+
+def standard_env_vars
+  @standard_env_vars ||= {
+    'RAX_USERNAME'   => ENV['RAX_USERNAME'],
+    'RAX_API_KEY'    => ENV['RAX_API_KEY'],
+    'RAX_REGION'     => 'ORD', # FIXME: stubbing multiple hosts
+    # 'RAX_REGION'     => ENV['RAX_REGION'] || %w{DFW ORD IAD SYD HKG}.sample, # omitted LON since it requires UK account
+    'RAX_AUTH_URL'   => PACTO_SERVER || 'https://identity.api.rackspacecloud.com'
+  }
+end
+
+def redact(data)
+  Hash[data.map do |k,v|
+    if k =~ /password|api_key/i
+      v = '******'
+    end
+    [k, v]
+  end]
+end

data/features/helpers/cloudfiles_helper.rb

@@ -0,0 +1,31 @@
+require 'fog'
+
+def build type, env = {}
+  case type
+  when :file
+    build_file env
+  else
+    raise ArgumentError.new "Don't know how to be a #{type}"
+  end
+end
+
+def build_file env
+  without_webmock do
+    service = Fog::Storage.new({
+      :provider             => 'rackspace',
+      :rackspace_username   => env['RAX_USERNAME'],
+      :rackspace_api_key    => env['RAX_API_KEY'],
+      :rackspace_region     => env['RAX_REGION']
+    })
+
+    directory = service.directories.create :key => 'asdf'
+    file = directory.files.create :key => 'asdf', :body => 'efgh'
+  end
+end
+
+def without_webmock
+  WebMock.disable!
+  ret_val = yield
+  WebMock.enable!
+  ret_val
+end

data/features/helpers/pacto_helper.rb

@@ -0,0 +1,33 @@
+require 'pacto'
+require 'pacto/rspec'
+require 'pacto_server'
+require 'goliath/test_helper'
+
+def test_env_number
+  ENV['TEST_ENV_NUMBER'].to_i
+end
+
+def pacto_port
+  @pacto_port ||= 9900 + test_env_number
+end
+
+COVERAGE_FILE = "reports/api_coverage#{test_env_number}.yaml"
+PACTO_SERVER = "http://identity.api.rackspacecloud.dev:#{pacto_port}" unless ENV['NO_PACTO']
+
+RSpec.configure do |c|
+  c.include Goliath::TestHelper
+  c.before(:each)  { Pacto.clear! }
+  c.after(:each) { save_coverage }
+end
+
+def generate?
+  ENV['PACTO_GENERATE'] == 'true'
+end
+
+def save_coverage
+  data = YAML::load(File.read(COVERAGE_FILE)) if File.exists?(COVERAGE_FILE)
+  data ||= {}
+  validations = Pacto::ValidationRegistry.instance.validations
+  data[example.full_description] = validations.reject{|v| v.contract.nil?}.map{|v| v.contract.name }
+  File.open(COVERAGE_FILE, 'w') {|f| f.write data.to_yaml }
+end

data/features/helpers/teardown_helper.rb

@@ -0,0 +1,49 @@
+RSpec.configure do |c|
+  c.after(:each) { auto_teardown }
+end
+
+def auth_token
+  @auth_token ||= Pacto::ValidationRegistry.instance.validations.map do | val |
+    token = val.request.headers['X-Auth-Token']
+  end.compact.reject(&:empty?).first
+end
+
+def auto_teardown
+  # HACK: This should be simplified and moved to Pacto
+
+  created_resources = auto_find_prg
+  auto_delete created_resources, auth_token
+end
+
+REDIRECTS = [201, 202, (300...400).to_a.flatten]
+
+def auto_find_prg
+  # Find URLs that were the "Get" part of a Post-Redirect-Get pattern
+  created_uris = Pacto::ValidationRegistry.instance.validations.map {|validation|
+    validation.response.headers['Location'] if validation.request.method == :post and REDIRECTS.include? validation.response.status
+  }.compact
+
+  created_uris.map do | created_uri |
+    Addressable::URI.parse created_uri
+  end
+end
+
+def auto_delete uris, auth_token
+  uris.group_by(&:site).each do | site, uris |
+    connection = Excon.new(site)
+    uris.each do | uri |
+      puts "Removing #{uri}"
+      connection.delete(:path => uri.path,
+        :debug_request => true,
+        :debug_response => true,
+        :expects => [204],
+        :headers => {
+          "User-Agent" => "fog/1.18.0",
+          "Content-Type" => "application/json",
+          "Accept" => "application/json",
+          "X-Auth-Token" => auth_token
+        }
+      )
+    end
+  end
+end

data/features/pacto/extensions/loaders/api_blueprint_loader.rb

@@ -0,0 +1,63 @@
+require 'multi_json'
+require 'yaml'
+require 'jsonpath'
+require 'pacto'
+
+module Pacto
+  module Extensions
+    module Loaders
+      class APIBlueprintLoader < YamlOrJsonLoader
+        def self.load(file)
+          data = super
+          contracts = []
+          resources = JsonPath.on(data, '$..resources[(@.uriTemplate)]')
+          resources.each do |resource|
+            resource['actions'].each do |action|
+              contract = load_action(action, resource, file)
+              Pacto.contract_registry.register(contract)
+              contracts << contract
+            end
+          end
+          Pacto::ContractList.new contracts
+        end
+
+        private
+
+        def self.load_action(action, resource, file)
+          # contract_definition = File.read(contract_path)
+          # definition = JSON.parse(contract_definition)
+          # schema.validate definition
+          # request = RequestClause.new(host, definition['request'])
+          # response = ResponseClause.new(definition['response'])
+          # Contract.new(request, response, contract_path, definition['name'])
+
+          # FIXME: Host info not available in blueprint.
+          host = 'http://localhost'
+          request_clause = RequestClause.new(host, {
+            'method' => action['method'],
+            'headers' => [], #not supporting this yet, probably needs conversion
+            'path' => resource['uriTemplate']
+          })
+          response = action['examples'].first['responses'].first
+          response_clause = ResponseClause.new({
+            'status' => response['name'],
+            'headers' => [], #not supporting this yet, probably needs conversion
+            'body' => schema_from(response)
+          })
+          Contract.new(request_clause, response_clause, file, resource['name'])
+        end
+
+        def self.schema_from(response)
+          schema = response['schema']
+          if schema.nil? or schema.empty?
+            {}
+          else
+            MultiJson.load schema
+          end
+        end
+      end
+    end
+  end
+end
+
+# contracts = Pacto::Extensions::Loaders::APIBlueprintLoader.load('pacto/blueprints/otter.json')