outliers 0.0.0 → 0.0.1

data/outliers.gemspec

@@ -8,10 +8,10 @@ Gem::Specification.new do |spec|
   spec.version       = Outliers::VERSION
   spec.authors       = ["Brett Weaver"]
   spec.email         = ["brett@weav.net"]
-  spec.description   = %q{To Be Announced.}
-  spec.summary       = %q{To Be Announced.}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.description   = %q{Configuraiton verification framework.}
+  spec.summary       = %q{Configuration verification framework.}
+  spec.homepage      = "https://github.com/brettweavnet/outliers"
+  spec.license       = "Apache2"
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -19,5 +19,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake", "~> 10.1.0"
+  spec.add_development_dependency "rspec", "~> 2.13.0"
+
+  spec.add_runtime_dependency "aws-sdk", "1.14.1"
+  spec.add_runtime_dependency "github_api", "0.10.1"
 end

data/spec/collection_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+
+describe Outliers::Collection do
+  let(:provider) { mock 'provider' }
+  let(:resource1) { mock 'resource1' }
+  let(:resource2) { mock 'resource2' }
+  let(:resource_class) { stub 'resource_class', key: 'name',
+                                                verifications_requiring_target: ['target_me?'] }
+
+  subject { Outliers::Collection.new provider }
+
+  before do
+    stub_logger
+    resource1.stub name: 'resource1', key: 'name', id: 'resource1'
+    resource2.stub name: 'resource2', key: 'name', id: 'resource2'
+    subject.stub :load_all => [resource1, resource2],
+                 :class => Outliers::Resources::Aws::Ec2::SecurityGroupCollection
+  end
+
+  context "#to_human" do
+    it "should return the human name for this resource" do
+      expect(Outliers::Resources::Aws::Ec2::SecurityGroupCollection.to_human).to eq('aws_ec2_security_group')
+      expect(Outliers::Resources::Github::RepoCollection.to_human).to eq('github_repo')
+    end
+  end
+
+  context "#each" do
+    it "should iterate over all resources when block given" do
+      expect(subject.each {|r| r}).to eq([resource1, resource2])
+    end
+  end
+
+  context "#exclude" do
+    it "should exclude the given array of resources" do
+      subject.exclude_by_key ['resource1']
+      expect(subject.all).to eq([resource2])
+    end
+  end
+
+  context "#key" do
+    it "should return the key for the resource" do
+      expect(subject.key).to eq('name')
+    end
+  end
+
+  context "#resource_class" do
+    it "should return the resource_class for the resource" do
+      expect(subject.resource_class).to eq(Outliers::Resources::Aws::Ec2::SecurityGroup)
+    end
+  end
+
+  context "#verify" do
+    before do
+      Outliers::Collection.stub :resource_class => resource_class
+    end
+
+    it "should verify the given verification against the colection" do
+      expect(subject.verify 'none?', {}).to be_false
+    end
+
+    it "should verify the given verification against the colection with options" do
+      expect(subject.verify 'equals?', :keys => ['resource1', 'resource2']).to be_true
+    end
+
+    it "should verify the given verification against each resource in the collection" do
+      [resource1, resource2].each {|r| r.define_singleton_method :valid_resource?, lambda { true } }
+      expect(subject.verify 'valid_resource?').to be_true
+    end
+
+    it "should appaned a ? to the policy" do
+      expect(subject.verify 'none').to be_false
+    end
+
+    it "should remove all but the target resources if one is required and given" do
+      subject.targets = ['resource1', 'in-valid']
+      resource1.should_receive(:method).with('target_me?').and_return(stub 'method', :arity => 0)
+      resource1.should_receive(:target_me?)
+      expect(subject.verify 'target_me?').to be_true
+    end
+
+    it "should raise an error if the target resources does not exist" do
+      subject.targets = ['in-valid']
+      expect { subject.verify 'target_me?' }.to raise_error(Outliers::Exceptions::TargetNotFound)
+    end
+                 
+    it "should raise an error if the verification requires arguments and none given" do
+      resource1.define_singleton_method :valid_resource?, lambda { |required_args| true }
+      expect { subject.verify 'valid_resource?' }.to raise_error(Outliers::Exceptions::ArgumentRequired)
+    end
+
+    it "should raise an error if the verification does not require arguments and arguments are given" do
+      resource1.define_singleton_method :valid_resource?, lambda { true }
+      expect { subject.verify 'valid_resource?', 'unneeded argument' => 3 }.to raise_error(Outliers::Exceptions::NoArgumentRequired)
+    end
+
+    it "should verify the given verification against each resource in the collection with options" do
+      resource1.should_receive(:valid_resource?).with('test_arg' => 2).and_return true
+      resource2.should_receive(:valid_resource?).with('test_arg' => 2).and_return true
+      expect(subject.verify 'valid_resource?', 'test_arg' => 2).to be_true
+    end
+  end
+
+end

data/spec/credentials_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Outliers::Credentials do
+  subject { Outliers::Credentials }
+  let(:credentials1) { fixture_file 'credentials1.yml' }
+  let(:credentials2) { fixture_file 'credentials2.yml' }
+  context "#load_from_config_folder" do
+    before { Outliers.config_path '/test' }
+    it "should load the credentials from each file in the directory" do
+      Dir.should_receive(:entries).with('/test/credentials').
+          and_return ['.', '..', 'test1.yml', 'test2.yml']
+      File.should_receive(:read).with('/test/credentials/test1.yml').and_return credentials1
+      File.should_receive(:read).with('/test/credentials/test2.yml').and_return credentials2
+      results = { "test_credentials_1" => 
+                  { "region"            => "us-west-1",
+                    "provider"          => "aws_ec2", 
+                    "access_key_id"     => "01234567890123456789",
+                    "secret_access_key" =>"0123456789012345678901234567890123456789" },
+                  "test_credentials_2" =>
+                    { "region"            => "us-west-1",
+                      "provider"          => "aws_ec2",
+                      "access_key_id"     => "01234567890123456789",
+                      "secret_access_key" => "0123456789012345678901234567890123456789" }
+                 }
+      expect(subject.load_from_config_folder).to eq(results)
+    end
+  end
+
+  context "#load_from_file" do
+    it "should load the credentials from the given yaml file" do
+      File.should_receive(:read).with('/home/user/outliers.yml').and_return credentials1
+      results = { "test_credentials_1" => 
+                  { "region"            => "us-west-1",
+                    "provider"          => "aws_ec2", 
+                    "access_key_id"     => "01234567890123456789",
+                    "secret_access_key" =>"0123456789012345678901234567890123456789" }
+                }
+      expect(subject.load_from_file '/home/user/outliers.yml').to eq(results)
+    end
+  end
+
+end

data/spec/evaluation_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+describe Outliers::Evaluation do
+  let(:run) { mock 'run' }
+  let(:result) { mock 'result' }
+  let(:connect) { subject.connect('test_credentials_1') }
+  let(:resources) { subject.resources('security_group') }
+  subject { Outliers::Evaluation.new :run => run, :name => 'test' }
+
+  before do
+    stub_logger
+    run.stub :credentials => credentials
+  end
+
+  context "#connect" do
+    it "should connect to the provider" do
+      connect
+      expect(subject.provider_name_array).to eq(['Aws', 'Ec2'])
+    end
+
+    it "should connect to the provider specified as an option" do
+      subject.connect('test_credentials_1', { 'provider' => 'aws_rds' })
+      expect(subject.provider_name_array).to eq(['Aws', 'Rds'])
+    end
+
+    it "should throw an error if the provider if the provider class is unkown" do
+      expect { subject.connect('test_credentials_1', { 'provider' => 'bad_provider' }) }.
+        to raise_error(Outliers::Exceptions::UnknownProvider)
+    end
+
+    it "should override a valid provider with one provided" do
+      subject.connect('test_credentials_1', { 'provider' => 'aws_ec2' })
+      expect(subject.provider_name_array).to eq(['Aws', 'Ec2'])
+    end
+  end
+
+  context "with connection and resources" do 
+    before do
+      connect
+      resources
+    end
+
+    context "#resources" do
+      it "should assign the collection_object" do
+        expect(subject.collection.class).
+          to eq(Outliers::Resources::Aws::Ec2::SecurityGroupCollection)
+        expect(subject.collection.provider.class).
+          to eq(Outliers::Providers::Aws::Ec2)
+      end
+
+      it "should throw an error when given an invalid collection" do
+        expect { subject.resources('bad_collection') }.
+          to raise_error(Outliers::Exceptions::UnknownCollection)
+      end
+
+      it "should test that over ride options are applied when selecting colleciton" do
+        subject.connect('test_credentials_1', :provider => 'aws_rds')
+        subject.resources('db_instance')
+        expect(subject.collection.provider.class).
+          to eq(Outliers::Providers::Aws::Rds)
+      end
+
+      it "should set the collection targets if specified" do
+        subject.connect('test_credentials_1', :provider => 'aws_rds')
+        expect(subject.resources('db_instance', 'instance-123').targets).to eq ['instance-123']
+      end
+    end
+
+    context "#exclude" do
+      it "should convert input to array and send call exclude_by_key with value" do
+        resources.should_receive(:exclude_by_key).with(['test'])
+        subject.exclude 'test'
+      end
+    end
+
+    context "#verify" do
+      before do
+        resources.should_receive(:load_all)
+        Outliers::Result.should_receive(:new).with(description: 'test', :passed => true).and_return result
+        run.should_receive(:results).and_return([])
+      end
+
+      it "should verify the given method" do
+        resources.should_receive(:verify).with('test_verification?', {}).and_return(true)
+        expect(subject.verify('test_verification?', {})).to eq([result])
+      end
+
+      it "should convert all options to symbols" do
+        resources.should_receive(:verify).with('test_verification?', :test => false).and_return(true)
+        expect(subject.verify('test_verification?', { 'test' => false } )).to eq([result])
+      end
+    end
+
+  end
+
+end

data/spec/fixtures/credentials1.yml

@@ -0,0 +1,5 @@
+test_credentials_1:
+  region: us-west-1
+  provider: aws_ec2
+  access_key_id: 01234567890123456789
+  secret_access_key: 0123456789012345678901234567890123456789

data/spec/fixtures/credentials2.yml

@@ -0,0 +1,5 @@
+test_credentials_2:
+  region: us-west-1
+  provider: aws_ec2
+  access_key_id: 01234567890123456789
+  secret_access_key: 0123456789012345678901234567890123456789

data/spec/helpers/fixtures.rb

@@ -0,0 +1,8 @@
+module Fixtures
+
+  def fixture_file(file)
+    path = File.expand_path(File.join(__FILE__, '..', '..', 'fixtures', file))
+    IO.read path
+  end
+
+end

data/spec/mixins_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+module TestModule
+  module TestSubModule
+    class TestClass
+    end
+  end
+end
+
+describe do
+  context "#all_the_modules" do
+    it "should return all the modules and classes for a object recursivley" do
+      expect(TestModule.all_the_modules).
+        to eq([TestModule, TestModule::TestSubModule, TestModule::TestSubModule::TestClass])
+    end
+  end
+  context "#keys_to_sym" do
+    it "should convert all hash keys to symbols" do
+      expect({ 'key' => 'val' }.keys_to_sym).to eq({ key: 'val' })
+    end
+  end
+  context "#keys_to_string" do
+    it "should convert all hash keys to string" do
+      expect({ key: 'val' }.keys_to_s).to eq({ 'key' => 'val' })
+    end
+  end
+  context "#underscore" do
+    it "should convert camel case to snack case" do
+      expect('TestCamelCase123'.underscore).to eq('test_camel_case123')
+      expect('Test123CamelCase'.underscore).to eq('test123_camel_case')
+    end
+  end
+end

data/spec/provider_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Outliers::Provider do
+  subject { Outliers::Provider }
+
+  context "#connect_to" do
+    let(:credentials) { ( { :name      => "test_credentials_1",
+                            "provider" => "github",
+                            "token"    => "abc" } ) }
+
+    it "should connect to the provider specified in the given credentials" do
+      expect(subject.connect_to(credentials).class).to eq(Outliers::Providers::Github)
+    end
+
+    it "should set the credentials instance variable" do
+      expect(subject.connect_to(credentials).credentials).
+        to eq({ :name => "test_credentials_1", "provider" => "github", "token" => "abc" })
+    end
+  end
+
+  context "#to_human" do
+    it "should return the name a human would use to access the provider" do
+      expect(Outliers::Providers::Github.to_human).to eq('github')
+    end
+
+    it "should return the name a human would use to access the provider" do
+      expect(Outliers::Providers::Aws::Rds.to_human).to eq('aws_rds')
+    end
+
+    it "should return the name a human would use to access the provider" do
+      expect(Outliers::Providers::Aws::CloudFormation.to_human).to eq('aws_cloud_formation')
+    end
+  end
+
+end

data/spec/providers_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Outliers::Providers do
+  subject { Outliers::Providers }
+  before do
+    subject.stub :all_the_modules => [Outliers::Providers::Aws, Outliers::Providers::Aws::Ec2]
+  end
+
+  it "should return all the providers" do
+    expect(subject.all).to eq([Outliers::Providers::Aws::Ec2])
+  end
+
+  context "#name_map" do
+    it "should return a map of resource human names to objects" do
+      expect(subject.name_map).to eq({ 'aws_ec2' => Outliers::Providers::Aws::Ec2 })
+    end
+  end
+end

data/spec/resource_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Outliers::Resource do
+  let(:provider) { mock 'provider' }
+  subject { Outliers::Resource.new provider }
+
+  context "#method_missing" do
+    it "should send missing methods to the source object" do
+      provider.stub :test_method => true
+      expect(subject.send 'test_method').to be_true
+    end
+  end
+
+  context "#self.key" do
+    it "should valid key returns name" do
+      expect(Outliers::Resource.key).to eq('name')
+    end
+  end
+end

data/spec/resources_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Outliers::Resources do
+  subject { Outliers::Resources }
+
+  context "#collections" do
+    it "should return all the collections" do
+      Outliers::Resources.stub :all_the_modules => [Outliers::Resources::Aws::Ec2, 
+                                                    Outliers::Resources::Aws::Ec2::SecurityGroup,
+                                                    Outliers::Resources::Aws::Ec2::SecurityGroupCollection]
+      expect(subject.collections).to eq([Outliers::Resources::Aws::Ec2::SecurityGroupCollection])
+    end
+  end
+
+end

data/spec/results_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Outliers::Result do
+  context "passing" do
+    subject { Outliers::Result.new description: 'stuff', passed: true }
+    it "should return passed" do
+      expect(subject.to_s).to eq 'passed'
+    end
+
+    it "should return true for passing verification" do
+      expect(subject.passed?).to be_true
+    end
+
+    it "should return false for passing verification" do
+      expect(subject.failed?).to be_false
+    end
+  end
+
+  context "failing" do
+    subject { Outliers::Result.new description: 'stuff', passed: false }
+    it "should return passed" do
+      expect(subject.to_s).to eq 'failed'
+    end
+
+    it "should return false for failing verification" do
+      expect(subject.passed?).to be_false
+    end
+
+    it "should return true for failing verification" do
+      expect(subject.failed?).to be_true
+    end
+  end
+end

data/spec/run_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Outliers::Run do
+  let(:evaluation1) { mock "evaluation1" }
+  let(:evaluation2) { mock "evaluation2" }
+
+  before do
+    stub_logger
+  end
+
+  describe "#process_evaluations_in_config_folder" do
+    it "should process all evaluation files in config folder" do
+      Dir.should_receive(:entries).with('/test').and_return ['.', '..', 'test1.rb', 'test2.rb']
+      File.should_receive(:read).with('/test/test1.rb').and_return evaluation1
+      File.should_receive(:read).with('/test/test2.rb').and_return evaluation2
+ 
+      subject.should_receive(:instance_eval).with(evaluation1)
+      subject.should_receive(:instance_eval).with(evaluation2)
+      subject.process_evaluations_in_config_folder
+    end
+
+    it "should skip directories"
+    it "should only evaluate .rb files"
+  end
+
+  describe "#evaluate" do
+    it "should kick off a new evaluation and yield it to the block" do
+      Outliers::Evaluation.should_receive(:new).with(:name => 'my evaluation', :run => subject).and_return evaluation1
+      subject.evaluate('my evaluation') do |e|
+        expect(e).to eq(evaluation1)
+      end
+    end
+  end
+
+  context "returning results" do
+    let(:result1) { Outliers::Result.new description: 'result1', passed: true }
+    let(:result2) { Outliers::Result.new description: 'result2', passed: false }
+    before do
+      subject.results << result1
+      subject.results << result2
+    end
+
+    describe "#passed" do
+      it "should return an array of all passing results" do
+        expect(subject.passed).to eq([result1])
+      end
+    end
+
+    describe "#failed" do
+      it "should return an array of all failing results" do
+        expect(subject.failed).to eq([result2])
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'outliers'
+
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'helpers', '*.rb'))].each do |f|
+  require f
+end
+
+def credentials
+  YAML.load(fixture_file 'credentials1.yml')
+end
+
+def stub_logger
+  Outliers.logger stub 'test'
+  Outliers.logger.stub :debug => true, :info => true, :warn => true
+end
+         
+RSpec.configure do |config|
+  config.include Fixtures
+end

data/spec/verifications/shared_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Outliers::Verifications::Shared do
+  subject { Object.new.extend Outliers::Verifications::Shared }
+
+  before do
+    logger_stub = stub 'logger', :debug => true
+    subject.stub :logger => logger_stub
+  end
+
+  context "#none_exist?" do
+    it "should be true if no resources returned" do
+      subject.stub :all => []
+      expect(subject.none_exist?).to be_true
+    end
+
+    it "should be false if  resources returned" do
+      subject.stub :all_by_key => ['test']
+      subject.stub :all => ['test']
+      expect(subject.none_exist?).to be_false
+    end
+  end
+
+  context "#equals?" do
+    it "should verify the list of resources equals the list of keys" do
+      subject.stub :all_by_key => ['test'], :all => ['test_resource']
+      expect(subject.equals?(:keys => ['test'])).to be_true
+    end
+
+    it "should verify the list of resources equals the single key" do
+      subject.stub :all_by_key => ['test'], :all => ['test_resource']
+      expect(subject.equals?(:keys => 'test')).to be_true
+    end
+  end
+end