outliers 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96ee1fb7ec544e936e6a55b6c0d4bac0b8a9baea
-  data.tar.gz: 098ddc59e2cd429d938785b42336b592823e38a1
+  metadata.gz: 5dcb9ddc49eb2c32e3716d6dd090fd7d1f98c3d9
+  data.tar.gz: 5516ddb04d0b89be33e4e6d8d7c013f512ed2d3c
 SHA512:
-  metadata.gz: 13c134dbeb4901b3016502c188cbfacf41aef8c8f11db1f1d8a85d8f81b08937759fed1c257039b5259130b46756d66e7b19174d742f43acbfe2ecaf2a28ca2b
-  data.tar.gz: 49dc924d5ea0694f3e8c4e98abae6ea93f327bf2c828309a375e4269430f14117b7169fc4e5dba91562fa8c81bc93e920917d2ab5bfdb73cea5ef63f6ffdb1ed
+  metadata.gz: ea89d2a78e78dbbdb296e4666d4fb1bb1c75d442fe094856f9ea79202b4fe7c02cecb710235e3124b6cbfe46da9d86f1373004836cac231dd1917fc8a28ae501
+  data.tar.gz: 0e6532c2846d0bbda51586a874823102328ba051aa2e2db5dfc7617488d8f3d3c4d7cbadcabe7f74033e3faa8fa2334a593eb2245078d06a524ea544197b5ac8

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.1.0
+
+* Recursively load evaluation files.
+* Updated DSL format.
+
 ## 0.0.1
 
-* Initial release
+* Initial release.

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://secure.travis-ci.org/brettweavnet/outliers.png)](http://travis-ci.org/brettweavnet/outliers)
+
 # Outliers
 
 Outliers is a framework for verifying configuration of resources.
@@ -90,83 +92,83 @@ To process a directory:
 
 To verify all instances are in a VPC, create the file **ec2.rb** and add the following block:
 
-    evaluate do |e|
-      e.connect 'aws_prod', provider: 'aws_ec2'
-      e.resources 'instance'
-      e.verify 'vpc'
+    evaluate do
+      connect 'aws_prod', provider: 'aws_ec2'
+      resources 'instance'
+      verify 'vpc'
     end
 
 Files can have multiple evaluations, to add a validation that overrides the region:
 
-    evaluate do |e|
-      e.connect 'aws_prod', provider: 'aws_ec2'
-      e.resources 'instance'
-      e.verify 'vpc'
+    evaluate do
+      connect 'aws_prod', provider: 'aws_ec2'
+      resources 'instance'
+      verify 'vpc'
     end
 
-    evaluate do |e|
-      e.connect 'aws_prod', provider: 'aws_ec2', region: 'us-west-1'
-      e.resources 'instance'
-      e.verify 'vpc'
+    evaluate do
+      connect 'aws_prod', provider: 'aws_ec2', region: 'us-west-1'
+      resources 'instance'
+      verify 'vpc'
     end
 
 The DSL supports any valid Ruby code. To iterate over multiple regions:
 
     ['us-west-1', 'us-west-2', 'us-east-1'].each do |region|
-      evaluate do |e|
-        e.connect 'aws_prod', provider: 'aws_ec2', region: region
-        e.resources 'instance'
-        e.verify 'vpc'
+      evaluate do
+        connect 'aws_prod', provider: 'aws_ec2', region: region
+        resources 'instance'
+        verify 'vpc'
       end
     end
 
 Evaluations can be given names to help identify Outliers in results.
 
-    evaluate "validate_database_retention_period" do |e|
-      e.connect 'aws_prod', provider: 'aws_rds', region: 'us-west-1'
-      e.resources 'db_instance'
-      e.verify 'backup_retention_period', days: 2
+    evaluate "validate_database_retention_period" do
+      connect 'aws_prod', provider: 'aws_rds', region: 'us-west-1'
+      resources 'db_instance'
+      verify 'backup_retention_period', days: 2
     end
 
 To pass arguments to a verification:
 
-    evaluate do |e|
-      e.connect 'aws_prod', provider: 'aws_rds', region: 'us-west-1'
-      e.resources 'db_instance'
-      e.verify 'backup_retention_period', days: 2
+    evaluate do
+      connect 'aws_prod', provider: 'aws_rds', region: 'us-west-1'
+      resources 'db_instance'
+      verify 'backup_retention_period', days: 2
     end
 
 To pass multiple arguments, specify them as an array:
 
-    evaluate do |e|
-      e.connect 'aws_prod', provider: 'aws_ec2', region: 'us-west-1'
-      e.resources 'instance'
-      e.verify 'valid_image_id', image_ids: ['ami-12345678','ami-87654321']
+    evaluate do
+      connect 'aws_prod', provider: 'aws_ec2', region: 'us-west-1'
+      resources 'instance'
+      verify 'valid_image_id', image_ids: ['ami-12345678','ami-87654321']
     end
 
 To only target a specific resource:
 
-    evaluate do |e|
-      e.connect 'aws_prod', provider: 'aws_ec2', region: 'us-west-1'
-      e.resources 'instance', 'i-12345678'
-      e.verify 'valid_image_id', image_ids: ['ami-12345678','ami-87654321']
+    evaluate do
+      connect 'aws_prod', provider: 'aws_ec2', region: 'us-west-1'
+      resources 'instance', 'i-12345678'
+      verify 'valid_image_id', image_ids: ['ami-12345678','ami-87654321']
     end
 
 To target multiple resources, you can pass an array:
 
-    evaluate do |e|
-      e.connect 'aws_prod', provider: 'aws_ec2', region: 'us-west-1'
-      e.resources 'instance', ['i-12345678', 'i-abcdef12']
-      e.verify 'valid_image_id', image_ids: ['ami-12345678','ami-87654321']
+    evaluate do
+      connect 'aws_prod', provider: 'aws_ec2', region: 'us-west-1'
+      resources 'instance', ['i-12345678', 'i-abcdef12']
+      verify 'valid_image_id', image_ids: ['ami-12345678','ami-87654321']
     end
 
 Sometimes you want to exclude resources that are known exceptions, to exclude an instance from the VPC validation:
 
-    evaluate do |e|
-      e.connect 'aws_prod', provider: 'aws_ec2', region: 'us-west-1'
-      e.resources 'instance'
-      e.exclude 'i-12345678'
-      e.verify 'valid_image_id', image_ids: ['ami-12345678','ami-87654321']
+    evaluate do
+      connect 'aws_prod', provider: 'aws_ec2', region: 'us-west-1'
+      resources 'instance'
+      exclude 'i-12345678'
+      verify 'valid_image_id', image_ids: ['ami-12345678','ami-87654321']
     end
 
 ### Help

data/lib/outliers/credentials.rb

@@ -2,19 +2,6 @@ module Outliers
   module Credentials
     module_function
 
-    # To Do - Remove me once validated not needed
-    def load_from_config_folder
-      credentials = {}
-      files = Dir.entries(File.join(Outliers.config_path, 'credentials')) - ['.', '..']
-      files.each do |file|
-        contents = File.read File.join(Outliers.config_path, 'credentials', file)
-        YAML.load(contents).each_pair do |k,v|
-          credentials[k] = v
-        end
-      end
-      credentials
-    end
-
     def load_from_file(file)
       credentials = {}
       contents = File.read file

data/lib/outliers/run.rb

@@ -8,18 +8,17 @@ module Outliers
 
     def process_evaluations_in_config_folder
       evaluations_path = File.join Outliers.config_path
-      entries = Dir.entries(evaluations_path) - ['.', '..']
-      entries.each do |e|
-        file = File.join(evaluations_path, e)
-        unless File.directory? file
-          logger.info "Processing '#{file}'."
-          self.instance_eval File.read(file)
-        end
+      files = Dir.glob(File.join(evaluations_path, '**', '*'))
+      files.each do |file|
+        next if File.directory? file
+        next if File.extname(file) != '.rb'
+        logger.info "Processing '#{file}'."
+        self.instance_eval File.read(file)
       end
     end
 
-    def evaluate(name='unspecified')
-      yield Evaluation.new :name => name, :run => self
+    def evaluate(name='unspecified', &block)
+      Evaluation.new(:name => name, :run => self).instance_eval &block
     end
 
     def passed

data/lib/outliers/version.rb

@@ -1,3 +1,3 @@
 module Outliers
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/credentials_spec.rb

@@ -4,27 +4,6 @@ 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

data/spec/run_spec.rb

@@ -6,28 +6,42 @@ describe Outliers::Run do
 
   before do
     stub_logger
+    Outliers.config_path '/test'
   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']
+    it "should process all .rb files in config folder and sub folders" do
+      files = ['/test/test1.rb', '/test/dir', '/test/dir/test2.rb', '/test/dir/test_other_file']
+      Dir.should_receive(:glob).with('/test/**/*').and_return files
+
+      ['/test/test1.rb', '/test/dir/test2.rb', '/test/dir/test_other_file'].each do |f|
+        File.should_receive(:directory?).with(f).and_return false
+      end
+      File.should_receive(:directory?).with('/test/dir').and_return true
+
       File.should_receive(:read).with('/test/test1.rb').and_return evaluation1
-      File.should_receive(:read).with('/test/test2.rb').and_return evaluation2
+      File.should_receive(:read).with('/test/dir/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
+    it "should kick off a new evaluation and pass the block for execuation" 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)
+      evaluation1.should_receive(:connect).with('test')
+      subject.evaluate 'my evaluation' do
+        connect 'test'
+      end
+    end
+
+    it "should kick off a new evaluation with unspecified name" do
+      Outliers::Evaluation.should_receive(:new).with(:name => 'unspecified', :run => subject).and_return evaluation1
+      evaluation1.should_receive(:connect).with('test')
+      subject.evaluate do
+        connect 'test'
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: outliers
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Brett Weaver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-11 00:00:00.000000000 Z
+date: 2013-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler