RubyGems - stacker_bee - Versions diffs - 1.0.1 → 2.0.0.pre.pre164 - Mend

stacker_bee 1.0.1 → 2.0.0.pre.pre164

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (31) hide show

checksums.yaml +13 -5
data/.travis.yml +14 -1
data/README.md +117 -67
data/bin/stacker_bee +4 -3
data/lib/faraday_middleware/response/graylog.rb +35 -0
data/lib/stacker_bee/body_parser.rb +11 -1
data/lib/stacker_bee/client.rb +32 -4
data/lib/stacker_bee/connection.rb +8 -9
data/lib/stacker_bee/dictionary_flattener.rb +12 -12
data/lib/stacker_bee/graylog_faraday_middleware.rb +13 -0
data/lib/stacker_bee/request_error.rb +1 -1
data/lib/stacker_bee/version.rb +1 -1
data/lib/stacker_bee.rb +3 -0
data/spec/cassettes/A_request_sent_to_CloudStack_for_console_access/returns_html_for_console_access.yml +34 -0
data/spec/cassettes/A_response_to_a_request_sent_to_the_CloudStack_API/{a_request_parameter_with_a_Map → a_request_parameter_with_a_map}/can_create_an_object.yml +0 -0
data/spec/integration/configure_middleware_spec.rb +30 -0
data/spec/integration/console_spec.rb +23 -0
data/spec/integration/request_spec.rb +2 -31
data/spec/spec_helper.rb +4 -0
data/spec/units/faraday_graylog_middleware_spec.rb +80 -0
data/spec/units/stacker_bee/client_spec.rb +52 -9
data/spec/units/stacker_bee/connection_spec.rb +14 -5
data/spec/units/stacker_bee/console_spec.rb +0 -0
data/spec/units/stacker_bee/graylog_faraday_middleware_spec.rb +51 -0
data/spec/units/stacker_bee/request_error_spec.rb +7 -3
data/spec/units/stacker_bee/response_spec.rb +18 -4
data/stacker_bee.gemspec +9 -2
metadata +58 -15
data/lib/stacker_bee/middleware/logger.rb +0 -47
data/spec/cassettes/A_response_to_a_request_sent_to_the_CloudStack_API/a_request_parameter_with_a_Map/object.yml +0 -153
data/spec/units/stacker_bee/middleware/logger_spec.rb +0 -55

data/spec/integration/console_spec.rb ADDED Viewed

@@ -0,0 +1,23 @@
+require "spec_helper"
+describe "A request sent to CloudStack for console access", :vcr do
+  let(:config_hash) do
+    {
+      url:        CONFIG['url'],
+      api_key:    CONFIG['api_key'],
+      secret_key: CONFIG['secret_key']
+    }
+  end
+  let(:client) do
+    StackerBee::Client.new(config_hash)
+  end
+  let(:vm) { "36f9c08b-f17a-4d0e-ac9b-d45ce2d34fcd" }
+  subject(:console_access) { client.console_access(vm: vm) }
+  it "returns html for console access" do
+    expect(console_access).to match %r{<html>.*<frame src=.*</html>}
+  end
+end

data/spec/integration/request_spec.rb CHANGED Viewed

@@ -2,16 +2,12 @@ require "spec_helper"
 require "logger"
 describe "A response to a request sent to the CloudStack API", :vcr do
-  let(:io)         { StringIO.new }
-  let(:logger)     { Logger.new(io) }
-  let(:log_string) { io.string }
-  let(:url)        { CONFIG["url"] }
+  let(:url) { CONFIG["url"] }
   let(:config_hash) do
     {
       url:        url,
       api_key:    CONFIG["api_key"],
       secret_key: CONFIG["secret_key"],
-      logger:     logger,
       apis_path:  File.join(File.dirname(__FILE__), '../fixtures/4.2.json')
     }
   end
@@ -31,36 +27,11 @@ describe "A response to a request sent to the CloudStack API", :vcr do
     its(["account_type"]) { should be_a Numeric }
   end
-  it "should log request" do
-    subject
-    log_string.should include "listAccounts"
-  end
-  it "should not log response as error" do
-    subject
-    log_string.should_not include "ERROR"
-  end
-  context "containing an error" do
-    subject do
-      client.deploy_virtual_machine
-    end
-    it { expect { subject }.to raise_error StackerBee::ClientError }
-    it "should log response as error" do
-      begin
-        subject
-      rescue StackerBee::ClientError
-        log_string.should include "ERROR"
-      end
-    end
-  end
   context "failing to connect" do
     let(:url) { "http://127.0.0.1:666/client/api" }
     it "should raise helpful exception" do
       klass = StackerBee::ConnectionError
-      expect{ subject }.to raise_error klass, /#{url}/
+      expect { subject }.to raise_error klass, /#{url}/
     end
   end

data/spec/spec_helper.rb CHANGED Viewed

@@ -41,6 +41,10 @@ VCR.configure do |c|
   c.filter_sensitive_data('<CLOUD_STACK_URL>') do
     CONFIG["url"]
   end
+  c.filter_sensitive_data('<CLOUD_STACK_HOST>') do
+    uri = URI.parse(CONFIG["url"])
+    "#{uri.scheme}://#{uri.host}:#{uri.port}"
+  end
   c.filter_sensitive_data('<CLOUD_STACK_API_KEY>') do
     CONFIG["api_key"]
   end

data/spec/units/faraday_graylog_middleware_spec.rb ADDED Viewed

@@ -0,0 +1,80 @@
+require 'spec_helper'
+describe FaradayMiddleware::Graylog do
+  subject { log_data }
+  class DummyLogger
+    attr_accessor :data
+    alias_method :notify, :data=
+  end
+  let(:log_data) { logger.data }
+  let(:logger)   { DummyLogger.new }
+  let(:dummy_adapter) { ->(env) { Faraday::Response.new(env) } }
+  let(:middleware) do
+    described_class.new(dummy_adapter, logger, facility: facility)
+  end
+  let(:env) do
+    {
+      body: "DATA",
+      response_headers: {},
+      response: {},
+      status: status
+    }
+  end
+  let(:facility) { nil }
+  before { middleware.call(env) }
+  context "a basic request" do
+    let(:status) { 200 }
+    its([:facility]) { should eq "faraday-middleware-graylog" }
+    its([:short_message]) { should eq "faraday-middleware-graylog Request" }
+    its([:_data]) do
+      should eq(body: "DATA", response_headers: {}, status: status)
+    end
+  end
+  context "given a facility" do
+    let(:status) { 200 }
+    let(:facility) { "stacker_bee" }
+    its([:facility]) { should eq "stacker_bee" }
+  end
+  context "a successful request" do
+    let(:status) { 200 }
+    its([:level]) { should eq FaradayMiddleware::Graylog::INFO }
+  end
+  context "a failed request" do
+    let(:status) { 500 }
+    its([:level]) { should eq FaradayMiddleware::Graylog::ERROR }
+  end
+  describe "a subclass" do
+    class GrayLogSubclass < FaradayMiddleware::Graylog
+      def short_message(env)
+        "Short message: #{env[:status]}"
+      end
+      def level(env)
+        env[:status]
+      end
+    end
+    let(:middleware) { GrayLogSubclass.new(dummy_adapter, logger) }
+    let(:status) { 401 }
+    it "can override the level determining logic" do
+      log_data[:level].should eq 401
+    end
+    it "can override the short_message logic" do
+      log_data[:short_message].should eq "Short message: 401"
+    end
+  end
+end

data/spec/units/stacker_bee/client_spec.rb CHANGED Viewed

@@ -13,7 +13,7 @@ describe StackerBee::Client, ".api" do
 end
 describe StackerBee::Client, "calling endpoint" do
-  let(:url)         { "cloud-stack.com" }
+  let(:url)         { "http://cloud-stack.com" }
   let(:api_key)     { "cloud-stack-api-key" }
   let(:secret_key)  { "cloud-stack-secret-key" }
   let(:config_hash) do
@@ -42,7 +42,7 @@ describe StackerBee::Client, "calling endpoint" do
     ) do
       request
     end
-    connection.stub(:get).with(request) { raw_response }
+    connection.stub(:get).with(request, "") { raw_response }
     StackerBee::Response.stub(:new).with(raw_response) { response }
   end
@@ -59,7 +59,7 @@ describe StackerBee::Client, "#request" do
   let(:endpoint)    { "listVirtualMachines" }
   let(:params)      { { list: :all } }
-  let(:url)         { "cloud-stack.com" }
+  let(:url)         { "http://cloud-stack.com" }
   let(:api_key)     { "cloud-stack-api-key" }
   let(:secret_key)  { "cloud-stack-secret-key" }
   let(:config_hash) do
@@ -80,7 +80,7 @@ describe StackerBee::Client, "#request" do
     StackerBee::Request.should_receive(:new).with(endpoint, api_key, params) do
       request
     end
-    connection.should_receive(:get).with(request) { raw_response }
+    connection.should_receive(:get).with(request, "") { raw_response }
     StackerBee::Response.should_receive(:new).with(raw_response) { response }
   end
@@ -93,7 +93,7 @@ describe StackerBee::Client, "#request" do
 end
 describe StackerBee::Client, "configuration" do
-  let(:default_url)         { "default_cloud-stack.com" }
+  let(:default_url)         { "http://default_cloud-stack.com" }
   let(:default_api_key)     { "default-cloud-stack-api-key" }
   let(:default_secret_key)  { "default-cloud-stack-secret-key" }
   let(:default_config_hash) do
@@ -101,13 +101,14 @@ describe StackerBee::Client, "configuration" do
       url:        default_url,
       api_key:    default_api_key,
       secret_key: default_secret_key,
-      allow_empty_string_params: false
+      allow_empty_string_params: false,
+      middlewares: ->(*) {}
     }
   end
   let!(:default_configuration) do
     StackerBee::Configuration.new(default_config_hash)
   end
-  let(:instance_url)        { "instance-cloud-stack.com" }
+  let(:instance_url)        { "http://instance-cloud-stack.com" }
   let(:instance_api_key)    { "instance-cloud-stack-api-key" }
   let(:instance_secret_key) { "instance-cloud-stack-secret-key" }
   let(:instance_config_hash) do
@@ -115,7 +116,8 @@ describe StackerBee::Client, "configuration" do
       url:        instance_url,
       api_key:    instance_api_key,
       secret_key: instance_secret_key,
-      allow_empty_string_params: false
+      allow_empty_string_params: false,
+      middlewares: ->(*) {}
     }
   end
   let!(:instance_configuration) do
@@ -161,7 +163,7 @@ describe StackerBee::Client, "configuration" do
     end
     describe "#url" do
-      let(:other_url) { "other-cloud-stack.com" }
+      let(:other_url) { "http://other-cloud-stack.com" }
       before { subject.url = other_url }
       its(:url) { should eq other_url }
     end
@@ -179,3 +181,44 @@ describe StackerBee::Client, "configuration" do
     end
   end
 end
+describe StackerBee::Client, "#console_access" do
+  let(:config_hash) do
+    {
+      url:        CONFIG["url"],
+      api_key:    CONFIG["api_key"],
+      secret_key: CONFIG["secret_key"]
+    }
+  end
+  let(:client) do
+    StackerBee::Client.new(config_hash)
+  end
+  let(:vm) { "36f9c08b-f17a-4d0e-ac9b-d45ce2d34fcd" }
+  let(:body) { "<body></body>" }
+  let(:headers) { { 'content-type' => 'text/html' } }
+  let(:response_stub) do
+    double(StackerBee::Response, success?: true, body: body, headers: headers)
+  end
+  subject(:console_access) { client.console_access(vm: vm) }
+  it "makes a request with the consoleAccess endpoint" do
+    expect(client).to receive(:request).with(
+      "consoleAccess", cmd: 'access', vm: vm
+    )
+    console_access
+  end
+  it "makes a get request to the connection" do
+    expect(client.send(:connection)).to receive(:get) do |request, path|
+      expect(request.endpoint).to eq("consoleAccess")
+      expect(path).to eq("/client/console")
+    end.and_return(response_stub)
+    expect(console_access).to eq(body)
+  end
+end

data/spec/units/stacker_bee/connection_spec.rb CHANGED Viewed

@@ -2,6 +2,7 @@ require "spec_helper"
 describe StackerBee::Connection do
   let(:url)           { "http://test.com:1234/foo/bar/" }
+  let(:path)          { "/foo/bar" }
   let(:secret_key)    { "shhh" }
   let(:configuration) { double url: url, secret_key: secret_key }
   let(:query_params)  { [[:foo, :bar]] }
@@ -9,18 +10,18 @@ describe StackerBee::Connection do
   let(:response)      { double }
   let(:faraday)       { double get: response }
   let(:connection)    { StackerBee::Connection.new configuration }
-  subject { connection.get request }
+  subject(:get) { connection.get request, path }
   before do
     Faraday.stub(:new) { faraday }
   end
   context "successfully connecting" do
     before do
-      faraday.should_receive(:get).with('/foo/bar/', query_params) { response }
+      faraday.should_receive(:get).with('/foo/bar', query_params) { response }
     end
     it { should be response }
     it "specifies url without path when creating connection" do
-      subject
+      get
       Faraday.should have_received(:new).with(url: "http://test.com:1234")
     end
   end
@@ -31,7 +32,7 @@ describe StackerBee::Connection do
     end
     it "should raise helpful exception" do
       klass = StackerBee::ConnectionError
-      expect(-> { subject }).to raise_error klass, /#{url}/
+      expect { get }.to raise_error klass, /#{url}/
     end
   end
@@ -39,7 +40,15 @@ describe StackerBee::Connection do
     let(:url) { "wrong.com" }
     it "should raise helpful exception" do
       klass = StackerBee::ConnectionError
-      expect(-> { subject }).to raise_error klass, /no protocol/
+      expect { get }.to raise_error klass, /no protocol/
+    end
+  end
+  context "when given a path" do
+    let(:path) { '/baz' }
+    it "makes a request to the correct path" do
+      expect(faraday).to receive(:get).with(path, query_params)
+      connection.get request, path
     end
   end
 end

data/spec/units/stacker_bee/console_spec.rb ADDED Viewed

File without changes

data/spec/units/stacker_bee/graylog_faraday_middleware_spec.rb ADDED Viewed

@@ -0,0 +1,51 @@
+require 'spec_helper'
+describe StackerBee::GraylogFaradayMiddleware do
+  subject { log_data }
+  class DummyLogger
+    attr_accessor :data
+    alias_method :notify, :data=
+  end
+  let(:log_data) { logger.data }
+  let(:logger)   { DummyLogger.new }
+  let(:dummy_adapter) { ->(env) { Faraday::Response.new(env) } }
+  let(:middleware) { described_class.new(dummy_adapter, logger) }
+  let(:status) { 200 }
+  let(:env) do
+    {
+      body: "DATA",
+      response_headers: {},
+      response: {},
+      status: status,
+      url: URI.parse("http://a.b/?key=KEY&command=listVirtualMachines&val=val")
+    }
+  end
+  before { middleware.call(env) }
+  it "sets a custom short message" do
+    log_data[:short_message].should eq "StackerBee listVirtualMachines"
+  end
+  its([:facility]) { should == "stacker-bee" }
+  context "without a command in the url" do
+    let(:env) do
+      {
+        body: "DATA",
+        response_headers: {},
+        response: {},
+        status: status,
+        url: URI.parse("http://a.b/?key=KEY&&val=val")
+      }
+    end
+    it "sets a custom short message" do
+      log_data[:short_message].should eq "StackerBee"
+    end
+  end
+end

data/spec/units/stacker_bee/request_error_spec.rb CHANGED Viewed

@@ -1,7 +1,9 @@
 require "spec_helper"
 describe StackerBee::RequestError, ".for" do
-  let(:raw_response) { double status: status, body: '{"foo": "bar"}' }
+  let(:raw_response) do
+    double status: status, body: '{"foo": "bar"}', headers: {}
+  end
   subject { StackerBee::RequestError.for raw_response }
   context "HTTP status in the 400s" do
@@ -21,7 +23,7 @@ end
 describe StackerBee::RequestError do
   let(:http_status) { 431 }
   let(:message) do
-    "Unable to execute API command deployvirtualmachine " +
+    "Unable to execute API command deployvirtualmachine " \
     "due to missing parameter zoneid"
   end
   let(:raw_body) do
@@ -36,7 +38,9 @@ describe StackerBee::RequestError do
     }
     EOS
   end
-  let(:raw_response) { double body: raw_body, :success? => false, status: 431 }
+  let(:raw_response) do
+    double body: raw_body, :success? => false, status: 431, headers: {}
+  end
   let(:client_error) { StackerBee::ClientError.new raw_response }
   subject { client_error }
   its(:status) { should eq http_status }

data/spec/units/stacker_bee/response_spec.rb CHANGED Viewed

@@ -2,8 +2,12 @@ require "spec_helper"
 describe StackerBee::Response do
   let(:raw_body)          { '{ "json": "here" }' }
-  let(:raw_response)  { double body: raw_body, :success? => true }
-  let(:response)      { StackerBee::Response.new raw_response }
+  let(:raw_response) do
+    double(body: raw_body, success?: true, headers: headers)
+  end
+  let(:response)     { StackerBee::Response.new raw_response }
+  let(:headers)      { { 'content-type' => content_type } }
+  let(:content_type) { "application/json; charset=UTF-8" }
   subject { response }
   its(:body) { should == 'here' }
@@ -44,7 +48,8 @@ describe StackerBee::Response do
       double(
         :body     => '{ "foo": "bar" }',
         :success? => false,
-        :status   => 431
+        :status   => 431,
+        :headers  => {}
       )
     end
     it { expect { subject }.to raise_exception StackerBee::ClientError }
@@ -62,7 +67,8 @@ describe StackerBee::Response do
           { "createprojectresponse" :
             {"uuidList":[],"errorcode":401,"errortext":"#{message}"} } ],
         success?: false,
-        status: 401
+        status: 401,
+        headers: {}
       )
     end
     let(:client_error) { StackerBee::AuthenticationError.new raw_response }
@@ -76,4 +82,12 @@ describe StackerBee::Response do
     end
   end
+  context "with an html response" do
+    let(:raw_body) { "<html><body>hi</body><html>" }
+    let(:content_type) { "text/html" }
+    it "returns the raw html without parsing" do
+      expect(response.body).to eq(raw_body)
+    end
+  end
 end

data/stacker_bee.gemspec CHANGED Viewed

@@ -19,8 +19,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
-  spec.add_runtime_dependency "faraday",      "~> 0.8"
-  spec.add_runtime_dependency 'multi_json',   "~> 1.8"
+  spec.add_runtime_dependency "faraday",            "~> 0.8", "< 0.9"
+  spec.add_runtime_dependency 'multi_json',         "~> 1.8"
+  # this is a dependency for FaradayMiddleware::Graylog
+  spec.add_runtime_dependency "faraday_middleware", "~> 0.9"
   spec.add_development_dependency "bundler",  "~> 1.3"
   spec.add_development_dependency "rake",     "~> 10.0"
@@ -28,4 +31,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "webmock",  "~> 1.15"
   spec.add_development_dependency "vcr",      "~> 2.6"
   spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "pry"
+  # Release every merge to master as a prerelease
+  spec.version = "#{spec.version}-pre#{ENV['TRAVIS_BUILD_NUMBER']}" if ENV['TRAVIS']
 end