vault-test-tools 0.2.3 → 0.3.0

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in vault-dev-tools.gemspec
 gemspec
+
+group :test do
+  gem 'fakeweb'
+end

data/README.md

@@ -1,6 +1,7 @@
 # Vault::Test
 
-Test Tools for the Heroku Vault Team.
+Test is the English phrase for テスト.  Test tools for the Heroku
+Vault Team.
 
 ## Installation
 

data/bin/t

@@ -1,4 +1,4 @@
 #! /usr/bin/env ruby
 
 ENV['CPUPROFILE'] = './test/.test.profile'
-exec('bundle exec turn -r perftools -I test -I lib test')
+exec('bundle exec turn -r perftools -I test -I lib test/**/*.rb test/*.rb')

data/lib/vault-test-tools.rb

@@ -8,7 +8,9 @@ require "vault-test-tools/spec"
 require "vault-test-tools/environment_helpers"
 require "vault-test-tools/html_helpers"
 require "vault-test-tools/db_helpers"
+require "vault-test-tools/spec_helpers"
 
+# TODO: Deprecate
 module Vault
   module Test
     def self.include_in_all(*modules)

data/lib/vault-test-tools/environment_helpers.rb

@@ -2,7 +2,7 @@ module Vault::Test::EnvironmentHelpers
   # Override an ENV variable for the current test.  The original value will be
   # restored automatically when the test finishes.
   def set_env(key, value)
-    overrides[key] = ENV[key] unless overrides[key]
+    overrides[key] = ENV[key] unless overrides.has_key?(key)
     ENV[key] = value
   end
 

data/lib/vault-test-tools/spec_helpers.rb

@@ -0,0 +1,39 @@
+# TODO: move to vault-test-tools
+require 'fileutils'
+
+module Vault::Test
+  module SpecHelpers
+    extend self
+
+    def usage_json
+      @usage_json ||= read_spec('usage')
+    end
+
+    def statement_json
+      @statement_json ||= read_spec('statement')
+    end
+
+    protected
+    def json_url(name)
+      "http://vault-specs.herokuapp.com/#{name}.json"
+    end
+
+    def json_file(name)
+      "./test/support/#{name}.json"
+    end
+
+    # Uses JSON at URL when it can, but will use
+    # the cached statement when it can't
+    def read_spec(name)
+      @statement_json ||= begin
+         data = Net::HTTP.get(URI.parse(json_url(name)))
+         FileUtils.mkdir_p(File.dirname(json_file(name)))
+         File.open(json_file(name), 'w') { |f| f << data }
+         data
+       rescue => e
+         $stderr.puts "Using cached #{name}.json"
+         File.read(json_file(name))
+       end
+    end
+  end
+end

data/lib/vault-test-tools/version.rb

@@ -1,5 +1,5 @@
 module Vault
   module Test
-    VERSION = "0.2.3"
+    VERSION = "0.3.0"
   end
 end

data/test/environment_helpers_test.rb

@@ -5,18 +5,27 @@ class EnvironmentHelpersTest < Vault::TestCase
   include Vault::Test::EnvironmentHelpers
 
   def test_set_env_ovverides_env
-    ENV['FOO'] = 'bar'
-    set_env('FOO', 'baz')
-    assert_equal('baz', ENV['FOO'])
+    ENV['FOO_1'] = 'bar'
+    set_env('FOO_1', 'baz')
+    assert_equal('baz', ENV['FOO_1'])
   end
 
   def test_teardown_restores_env_to_original_value
-    ENV['FOO'] = 'bar'
-    set_env('FOO', 'baz')
-    assert_equal('baz', ENV['FOO'])
-    set_env('FOO', 'buzz')
-    assert_equal('buzz', ENV['FOO'])
+    ENV['FOO_2'] = 'bar'
+    set_env('FOO_2', 'baz')
+    assert_equal('baz', ENV['FOO_2'])
+    set_env('FOO_2', 'buzz')
+    assert_equal('buzz', ENV['FOO_2'])
     teardown
-    assert_equal('bar', ENV['FOO'])
+    assert_equal('bar', ENV['FOO_2'])
+  end
+
+  def test_restores_empty_env_to_empty
+    set_env('EMPTY', 'baz')
+    assert_equal('baz', ENV['EMPTY'])
+    set_env('EMPTY', 'buzz')
+    assert_equal('buzz', ENV['EMPTY'])
+    teardown
+    assert_equal(nil, ENV['EMPTY'])
   end
 end

data/test/helper.rb

@@ -1 +1,3 @@
 require 'vault-test-tools'
+require 'fakeweb'
+require 'rr'

data/test/spec_helpers_test.rb

@@ -0,0 +1,79 @@
+require 'helper'
+
+class SpecHelpersTest < Vault::TestCase
+  include Vault::Test::SpecHelpers
+  include RR::Adapters::MiniTest
+  STATEMENT_FILE = './test/support/statement.json'
+
+  def setup
+    super
+    @url = 'http://vault-specs.herokuapp.com'
+    @statement_json = nil
+    FakeWeb.allow_net_connect = false
+  end
+
+  def teardown
+    super
+    FakeWeb.clean_registry
+    FakeWeb.allow_net_connect = true
+    # Using the filesystem - dirrrty
+    File.unlink(STATEMENT_FILE) if File.exists?(STATEMENT_FILE)
+    reset #for RR
+  end
+
+  # Happy path is to use the request from the service
+  def test_requests_spec_from_service
+    url = "#{@url}/statement.json"
+    FakeWeb.register_uri(:get, url, body: "USAGE JSON")
+    stub(File).open(STATEMENT_FILE, 'w')
+    assert_equal("USAGE JSON", statement_json)
+  end
+
+  # Call both methods with stubbed HTTP endpoints
+  def test_all_endpoints
+    stub(File).open
+    %w{usage statement}.each do |type|
+      url = "#{@url}/#{type}.json"
+      FakeWeb.register_uri(:get, url, body: "USAGE JSON")
+      capture_io do
+        assert_equal("USAGE JSON", self.send("#{type}_json"))
+      end
+    end
+  end
+
+  # If request blows up use cached JSON
+  def test_uses_json_on_request_failure
+    stub(URI).parse { raise RuntimeError }
+    mock(File).read(STATEMENT_FILE) { "USAGE JSON" }
+    stdout, stderr = capture_io do
+      assert_equal("USAGE JSON", statement_json)
+    end
+    assert_includes(stderr, "statement.json")
+  end
+
+  # Make sure we save it when we get it so we don't have
+  # to manually cache it
+  def test_caches_json_file_on_succsss
+    # successful request
+    url = "#{@url}/statement.json"
+    FakeWeb.register_uri(:get, url, body: "USAGE JSON")
+    assert_equal("USAGE JSON", statement_json)
+    @statement_json = nil
+    # now no network
+    stub(URI).parse { raise RuntimeError }
+    capture_io do
+      assert_equal("USAGE JSON", statement_json)
+    end
+  end
+
+  # This is the real error scenario
+  def test_bombs_if_no_cached_json
+    stub(URI).parse { raise RuntimeError }
+    stub(File).read { raise RuntimeError }
+    capture_io do
+      assert_raises RuntimeError do
+        statement_json
+      end
+    end
+  end
+end

data/vault-test-tools.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'rdoc'
   gem.add_dependency 'yard'
   gem.add_dependency 'redcarpet'
+  gem.add_dependency 'rr'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vault-test-tools
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-13 00:00:00.000000000 Z
+date: 2013-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: turn
@@ -140,6 +140,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Basic tools for Heroku Vault's Ruby projects
 email:
 - chriscontinanza@gmail.com
@@ -166,10 +182,12 @@ files:
 - lib/vault-test-tools/html_helpers.rb
 - lib/vault-test-tools/rake_task.rb
 - lib/vault-test-tools/spec.rb
+- lib/vault-test-tools/spec_helpers.rb
 - lib/vault-test-tools/test_case.rb
 - lib/vault-test-tools/version.rb
 - test/environment_helpers_test.rb
 - test/helper.rb
+- test/spec_helpers_test.rb
 - test/test_spec.rb
 - vault-test-tools.gemspec
 homepage: ''
@@ -186,7 +204,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1086311466377128168
+      hash: 2085097193621949794
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -195,7 +213,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1086311466377128168
+      hash: 2085097193621949794
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -205,5 +223,6 @@ summary: Test classes and stuff you want in your dev, but not prod, environment.
 test_files:
 - test/environment_helpers_test.rb
 - test/helper.rb
+- test/spec_helpers_test.rb
 - test/test_spec.rb
 has_rdoc: