outliers 0.2.0 → 0.3.0

data/lib/outliers/verifications/shared.rb

@@ -3,25 +3,13 @@ module Outliers
     module Shared
 
       def none_exist?
-        all
+        list
       end
 
       def equals?(args)
-        list = Array(args[:keys])
-        logger.debug "Verifying '#{list.join(',')}' equals '#{all.empty? ? 'no resources' : all_by_key.join(',')}'."
-        all.reject {|r| list.include? r.id}
-      end
-
-      module_function
-
-      def verifications
-         [
-           { name: 'none_exist',
-             description: 'Verify no resources exist.' },
-           { name: 'equals',
-             description: 'Verify resources match the given list of keys.',
-             args: 'keys: [KEY1,KEY2]' }
-         ]
+        keys = Array(args[:keys])
+        logger.debug "Verifying '#{list.join(',')}' equals '#{list.empty? ? 'no resources' : list_by_key.join(',')}'."
+        list.reject {|r| keys.include? r.id}
       end
 
     end

data/lib/outliers/version.rb

@@ -1,3 +1,3 @@
 module Outliers
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/outliers.rb

@@ -3,6 +3,7 @@ require "outliers/verifications"
 
 require "outliers/collection"
 require "outliers/credentials"
+require "outliers/info"
 require "outliers/exceptions"
 require "outliers/evaluation"
 require "outliers/filters"

data/reference.yaml

@@ -0,0 +1,128 @@
+all:
+  credentials:
+    access_key_id: AWS Account Access Key
+    secret_access_key: AWS Account Secret Key
+    region: AWS Region (Default us-east-1)
+  resources:
+    shared:
+      description: Verifications which are available to all resources.
+      verifications:
+        none_exist:
+          description: Verify no resources exist in list.
+        equals:
+          description: Verify no resources match the given list of keys.
+          args: 'keys: [KEY1,KEY2]'
+
+aws_cloud_formation:
+  credentials:
+    access_key_id: AWS Account Access Key
+    secret_access_key: AWS Account Secret Key
+    region: AWS Region (Default us-east-1)
+  resources:
+    stack:
+      description: AWS Cloud Formation Stack
+      verifications: {}
+
+aws_ec2:
+  credentials:
+    access_key_id: AWS Account Access Key
+    secret_access_key: AWS Account Secret Key
+    region: AWS Region (Default us-east-1)
+  resources:
+    instance:
+      description: AWS EC2 Instance
+      verifications:
+        classic:
+          description: Instance is in AWS Classic (No VPC).
+        source_dest_check:
+          description: Instance source dest check set to true.
+        running:
+          description: Instance status is running.
+        valid_image_id:
+          description: ami_ids=ami_id1,ami_id2 - Instances Image ID (AMI) is in given list.
+          args: 'image_ids: [IMAGE_ID1, IMAGEID2]'
+        vpc:
+          description: Instance is in a VPC.
+    security_group:
+      description: AWS EC2 Security Group
+      verifications:
+        no_public_internet_ingress:
+          description: Security Group has no rules open to 0.0.0.0/0.
+    image:
+      description: AWS EC2 AMI
+      verifications: {}
+
+aws_elb:
+  credentials:
+    access_key_id: AWS Account Access Key
+    secret_access_key: AWS Account Secret Key
+    region: AWS Region (Default us-east-1)
+  resources:
+    load_balancer:
+      description: AWS ELB (Elastic Load Balancer)
+      verifications:
+        ssl_certificates_valid:
+          description: Validates all SSL certificates associated with an ELB are valid for given number of days.
+          args: 'days: DAYS'
+
+aws_iam:
+  credentials:
+    access_key_id: AWS Account Access Key
+    secret_access_key: AWS Account Secret Key
+    region: AWS Region (Default us-east-1)
+  resources:
+    user:
+      description: AWS IAM User
+      verifications:
+        mfa_enabled:
+          description: Verify MFA enabled for user.
+        no_access_keys:
+          description: Verify user has no access keys.
+        no_password_set:
+          description: Verify password not set for user.
+
+aws_rds:
+  credentials:
+    access_key_id: AWS Account Access Key
+    secret_access_key: AWS Account Secret Key
+    region: AWS Region (Default us-east-1)
+  resources:
+    db_instance:
+      description: AWS RDS Database Instance
+      verifications:
+        backup_retention_period:
+          description: Validate the backup retention period equals given days for the db_instance.
+          args: 'days: DAYS'
+        multi_az:
+          description: RDS Multi AZ set to yes.
+    db_snapshot:
+      description: AWS RDS Database Snapshot
+      verifications: {}
+
+aws_s3:
+  credentials:
+    access_key_id: AWS Account Access Key
+    secret_access_key: AWS Account Secret Key
+    region: AWS Region (Default us-east-1)
+  resources:
+    bucket:
+      description: AWS S3 Bucket
+      verifications:
+        empty:
+          description: Bucket has no objects.
+        no_public_objects:
+          description: Bucket has no public accessible objects.
+        configured_as_website:
+          description: Bucket is configured as a website.
+        not_configured_as_website:
+          description: Bucket is not configured as a website.
+
+aws_sqs:
+  credentials:
+    access_key_id: AWS Account Access Key
+    secret_access_key: AWS Account Secret Key
+    region: AWS Region (Default us-east-1)
+  resources:
+    queue:
+      description: AWS SQS Queue
+      verifications: {}

data/spec/collection_spec.rb

@@ -31,7 +31,7 @@ describe Outliers::Collection do
   context "#exclude" do
     it "should exclude the given array of resources" do
       subject.exclude_by_key ['resource1']
-      expect(subject.all).to eq([resource2])
+      expect(subject.list).to eq([resource2])
     end
   end
 
@@ -39,7 +39,7 @@ describe Outliers::Collection do
     it "should apply the given filter to resources" do
       subject.should_receive('filter_tag').with('Name:test123').and_return [resource1]
       subject.filter 'tag' => 'Name:test123'
-      expect(subject.all).to eq([resource1])
+      expect(subject.list).to eq([resource1])
     end
 
     it "should raise an exception if the filter does not exist" do
@@ -120,7 +120,7 @@ describe Outliers::Collection do
         to raise_error(Outliers::Exceptions::NoArgumentRequired)
     end
 
-    it "should return empty passing and failing arrays if no resources exist in all" do
+    it "should return empty passing and failing arrays if no resources exist in list" do
       subject.stub :load_all => []
       expect(subject.verify 'valid_resource?', {}).to eq( { failing_resources: [], passing_resources: [] } )
     end

data/spec/filters/aws/ec2/tags_spec.rb

@@ -15,7 +15,7 @@ describe Outliers::Filters::Aws::Ec2::Tags do
 
   before do
     subject.stub :logger => logger
-    subject.stub :all => [resource1, resource2]
+    subject.stub :list => [resource1, resource2]
   end
 
   it "should return the list of instances filtered by the given tag name and value" do

data/spec/info_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Outliers::Info do
+  context "#reference" do
+    before do
+      @resources = []
+      subject.reference.each_pair do |name,data|
+        data['resources'].keys.each do |key|
+          @resources << "#{name}_#{key}"
+        end
+      end
+    end
+
+    it "should be able to load reference.yaml" do
+      expect(subject.reference.keys.include?('all')).to be_true
+    end
+
+    it "should verify each provider class has a entry in reference.yaml" do
+      expect(subject.reference.keys - ['all']).to eq(Outliers::Providers.name_map.keys)
+    end
+
+    it "should verify each resource method has a entry in reference.yaml" do
+      expect((@resources - ['all_shared']).sort).to eq(Outliers::Resources.list.map {|r| r.to_human}.sort)
+    end
+
+    it "should validate each resource has a verification list and description" do
+      subject.reference.each_value do |provider_data|
+        provider_data['resources'].each_value do |resource_data|
+          expect(resource_data['verifications'].class).to eq(Hash)
+          expect(resource_data['description'].class).to eq(String)
+        end
+      end
+    end
+
+    it "should validate each resource has a list of credentials" do
+      subject.reference.each_value do |provider_data|
+        expect(provider_data['credentials'].class).to eq(Hash)
+      end
+    end
+  end
+end

data/spec/run_spec.rb

@@ -9,8 +9,8 @@ describe Outliers::Run do
     Outliers.config_path '/test'
   end
 
-  describe "#process_evaluations_in_config_folder" do
-    it "should process all .rb files in config folder and sub folders" do
+  describe "#process_evaluations_in_dir" do
+    before 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
 
@@ -21,24 +21,71 @@ describe Outliers::Run do
 
       File.should_receive(:read).with('/test/test1.rb').and_return evaluation1
       File.should_receive(:read).with('/test/dir/test2.rb').and_return evaluation2
- 
+    end
+
+    it "should process all .rb files in config folder and sub folders" do
+      subject.should_receive(:instance_eval).with(evaluation1)
+      subject.should_receive(:instance_eval).with(evaluation2)
+      subject.process_evaluations_in_dir
+    end
+
+    it "each thread created for an evaluation should be re-joined" do
+      thread_mock = mock 'thread'
+      subject.threaded = true
+      subject.threads = [thread_mock]
       subject.should_receive(:instance_eval).with(evaluation1)
       subject.should_receive(:instance_eval).with(evaluation2)
-      subject.process_evaluations_in_config_folder
+      thread_mock.should_receive(:join)
+      subject.process_evaluations_in_dir
     end
   end
 
   describe "#evaluate" 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
-      evaluation1.should_receive(:connect).with('test')
-      subject.evaluate 'my evaluation' do
-        connect 'test'
+    context "with name" do
+      before do
+        Outliers::Evaluation.should_receive(:new).with(:name => 'my evaluation', :run => subject).
+          and_return evaluation1
+        evaluation1.should_receive(:connect).with('test')
+      end
+
+      it "should kick off a new evaluation and pass the block for execuation" do
+        subject.evaluate 'my evaluation' do
+          connect 'test'
+        end
+      end
+
+      it "should sleep if more than thread_count threads running" do
+        list_stub = stub "list"
+        list_stub.stub(:count).and_return(6,1)
+        Thread.stub :list => list_stub
+        subject.should_receive(:sleep).with(2)
+        subject.evaluate 'my evaluation' do
+          connect 'test'
+        end
+      end
+
+      describe "testing threads" do
+        it "should kick off a new thread if threaded is set to true" do
+          subject.threaded = true
+          Thread.should_receive(:new).and_yield { 'a thread' }
+          subject.evaluate 'my evaluation' do
+            connect 'test'
+          end
+          subject.threads.count == 1
+        end
+
+        it "should not kick off a new thread if threaded is set to false" do
+          subject.evaluate 'my evaluation' do
+            connect 'test'
+          end
+          subject.threads.count == 0
+        end
       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
+      Outliers::Evaluation.should_receive(:new).with(:name => 'unspecified', :run => subject).
+        and_return evaluation1
       evaluation1.should_receive(:connect).with('test')
       subject.evaluate do
         connect 'test'

data/spec/verifications/shared_spec.rb

@@ -12,30 +12,30 @@ describe Outliers::Verifications::Shared do
 
   context "#none_exist?" do
     it "should be true if no resources returned" do
-      subject.stub :all => []
+      subject.stub :list => []
       expect(subject.none_exist?).to eq([])
     end
 
     it "should be false if  resources returned" do
-      subject.stub :all_by_key => ['resource1']
-      subject.stub :all => ['resource1']
+      subject.stub :list_by_key => ['resource1']
+      subject.stub :list => ['resource1']
       expect(subject.none_exist?).to eq(['resource1'])
     end
   end
 
   context "#equals?" do
     it "should verify the list of resources equals the list of keys and return no failing reosurces" do
-      subject.stub :all_by_key => ['resource1'], :all => [resource1]
+      subject.stub :list_by_key => ['resource1'], :list => [resource1]
       expect(subject.equals?(:keys => ['resource1'])).to eq([])
     end
 
     it "should verify the list of resources equals the single key and return no failing resources" do
-      subject.stub :all_by_key => ['resource1'], :all => [resource1]
+      subject.stub :list_by_key => ['resource1'], :list => [resource1]
       expect(subject.equals?(:keys => 'resource1')).to eq([])
     end
 
     it "should return resources which do not match the given list" do
-      subject.stub :all_by_key => ['resource1', 'resource2'], :all => [resource1, resource2]
+      subject.stub :list_by_key => ['resource1', 'resource2'], :list => [resource1, resource2]
       expect(subject.equals?(:keys => 'resource1')).to eq([resource2])
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: outliers
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Brett Weaver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-19 00:00:00.000000000 Z
+date: 2013-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,10 +86,7 @@ files:
 - bin/outliers
 - lib/outliers.rb
 - lib/outliers/cli.rb
-- lib/outliers/cli/evaluate.rb
 - lib/outliers/cli/process.rb
-- lib/outliers/cli/providers.rb
-- lib/outliers/cli/resources.rb
 - lib/outliers/collection.rb
 - lib/outliers/credentials.rb
 - lib/outliers/evaluation.rb
@@ -98,17 +95,18 @@ files:
 - lib/outliers/filters/aws.rb
 - lib/outliers/filters/aws/ec2.rb
 - lib/outliers/filters/aws/ec2/tags.rb
+- lib/outliers/info.rb
 - lib/outliers/mixins.rb
 - lib/outliers/provider.rb
 - lib/outliers/providers.rb
 - lib/outliers/providers/aws.rb
-- lib/outliers/providers/aws/base.rb
 - lib/outliers/providers/aws/cloud_formation.rb
 - lib/outliers/providers/aws/ec2.rb
 - lib/outliers/providers/aws/elb.rb
 - lib/outliers/providers/aws/iam.rb
 - lib/outliers/providers/aws/rds.rb
 - lib/outliers/providers/aws/s3.rb
+- lib/outliers/providers/aws/shared.rb
 - lib/outliers/providers/aws/sqs.rb
 - lib/outliers/resource.rb
 - lib/outliers/resources.rb
@@ -139,6 +137,7 @@ files:
 - lib/outliers/verifications/shared.rb
 - lib/outliers/version.rb
 - outliers.gemspec
+- reference.yaml
 - spec/collection_spec.rb
 - spec/credentials_spec.rb
 - spec/evaluation_spec.rb
@@ -146,6 +145,7 @@ files:
 - spec/fixtures/credentials1.yml
 - spec/fixtures/credentials2.yml
 - spec/helpers/fixtures.rb
+- spec/info_spec.rb
 - spec/mixins_spec.rb
 - spec/provider_spec.rb
 - spec/providers_spec.rb
@@ -187,6 +187,7 @@ test_files:
 - spec/fixtures/credentials1.yml
 - spec/fixtures/credentials2.yml
 - spec/helpers/fixtures.rb
+- spec/info_spec.rb
 - spec/mixins_spec.rb
 - spec/provider_spec.rb
 - spec/providers_spec.rb

data/lib/outliers/cli/evaluate.rb

@@ -1,136 +0,0 @@
-module Outliers
-  module CLI
-    class Evaluate
-      def evaluate
-        @options = { arguments: [], exclude: [], filter: [], credentials: [], target_resources: [] }
-        @credentials = {}
-
-        option_parser.parse!
-
-        Outliers.config_path @options[:config]
-
-        @logger = Outliers.logger
-        @run    = Run.new
-
-        load_credentials
-
-        @options[:parsed_arguments] = parse_arguments
-        @options[:parsed_filters] = parse_filters
-
-        # Make options available global
-        # Required to read by instance_eval in @run.evaluate 
-        @@options = @options
-
-        begin
-          @run.evaluate "Running verification provided via CLI." do
-            connect 'cli'
-            resources @@options[:resource], @@options[:target_resources]
-            exclude @@options[:exclude] if @@options[:exclude].any?
-            filter @@options[:parsed_filters] if @@options[:filter].any?
-            verify @@options[:verification], @@options[:parsed_arguments]
-          end
-        rescue Outliers::Exceptions::Base => e
-          @logger.error e.message
-          exit 1
-        end
-
-        exit 1 if @run.results.first.failed?
-      end
-
-      def command_name
-        'evaluate'
-      end
-
-      def command_summary
-        'Evaluate the given verification.'
-      end
-
-      private
-
-      def load_credentials
-        credentials_name = @options[:credential_name]
-        credentials = Credentials.load_from_file("#{ENV['HOME']}/.outliers.yml").fetch credentials_name
-        credentials.merge! 'provider' => @options[:provider]
-
-        if @options[:credentials].any?
-          @options[:credentials].each do |c|
-            key = c.split('=').first
-            value =  c.split('=').last
-            credentials.merge! key => value
-          end
-        end
-
-        @run.credentials = { 'cli' => credentials }
-      end
-      
-      def parse_filters
-        filters = {}
-
-        @options[:filter].each do |a|
-          key = a.split('=').first
-          value = a.split('=').last
-          filters.merge! key => value
-        end
-
-        filters
-      end
-
-      
-      def parse_arguments
-        arguments = {}
-
-        @options[:arguments].each do |a|
-          key = a.split('=').first
-          value = a.split('=').last
-          value = value.split(',') if value.include?(',')
-          arguments.merge! key => value
-        end
-
-        arguments
-      end
-
-      def option_parser
-        OptionParser.new do |opts|
-          opts.banner = "Usage: outliers evaluate [options]"
-
-          opts.on("-a", "--argument [NAME]", "Equals seperated key and value to pass as argument to verification (can be specified multiple times).") do |o|
-            @options[:arguments] << o
-          end
-
-          opts.on("-c", "--credential_name [CREDENTIAL_NAME]", "Name to load from credentials file.") do |o|
-            @options[:credential_name] = o
-          end
-
-          opts.on("-e", "--exclude [EXCLUDE]", "Exclude resources in collection with the given key (can be specified multiple times).") do |o|
-            @options[:exclude] << o
-          end
-
-          opts.on("-f", "--fitler [FILTER]", "Equals seperated filter name and value (can be specified multiple times).") do |o|
-            @options[:filter] << o
-          end
-
-          opts.on("-p", "--provider [PROVIDER]", "Provider of target resources.") do |o|
-            @options[:provider] = o
-          end
-
-          opts.on("-r", "--resources [RESOURCES]", "Name of resource collection to evaluate.") do |o|
-            @options[:resource] = o
-          end
-
-          opts.on("-t", "--target_resources [TARGET_RESOURCES]", "Target resources with key name (can be specified more than once).") do |o|
-            @options[:target_resources] << o
-          end
-
-          opts.on("-v", "--verification [VERIFICATION]", "Verification to perform against collection of resources.") do |o|
-            @options[:verification] = o
-          end
-
-          opts.on("--credentials [CREDENTIALS]", "Equals seperated key and value to include as credentials (can be specified multiple times).") do |o|
-            @options[:credentials] << o
-          end
-        end
-      end
-
-    end
-  end
-end

data/lib/outliers/cli/providers.rb

@@ -1,29 +0,0 @@
-module Outliers
-  module CLI
-    class Providers
-      def providers
-        option_parser.parse!
-        list = Outliers::Providers.name_map
-        list.each_pair do |k,v|
-          puts k
-          v.credential_arguments.each_pair { |k,v| puts "  #{k}: #{v}" }
-        end
-      end
-
-      def command_name
-        'providers'
-      end
-
-      def command_summary
-        'List available providers.'
-      end
-
-      def option_parser
-        OptionParser.new do |opts|
-          opts.banner = "Usage: outliers providers"
-        end
-      end
-
-    end
-  end
-end

data/lib/outliers/cli/resources.rb

@@ -1,60 +0,0 @@
-module Outliers
-  module CLI
-    class Resources
-      def resources
-        @options = {}
-
-        option_parser.parse!
-
-        provider = @options[:provider]
-
-        @logger = Outliers.logger
-
-        unless provider
-          @logger.error "Required parameter 'provider' not specified."
-          exit 1
-        end
-
-        all = Outliers::Resources.collections
-
-        list = all.select { |r| r.to_human =~ /^#{provider}_.*$/ }
-
-        if list.any?
-          list.each do |r|
-            name = r.to_human
-            name.slice! provider
-            name[0] = ''
-            puts name
-            puts "  Verifications:"
-            r.verifications.each { |v| puts "    #{v[:name]}(#{v[:args]}) #{v[:description]}" }
-            puts "  Filters:"
-            r.filters.each { |v| puts "    #{v[:name]}(#{v[:args]}) #{v[:description]}" }
-          end
-        else
-          puts "No resources found for '#{provider}'."
-        end
-      end
-
-      def command_name
-        'resources'
-      end
-
-      def command_summary
-        'List available resources for a provider.'
-      end
-
-      private
-
-      def option_parser
-        OptionParser.new do |opts|
-          opts.banner = "Usage: outliers resources [options]"
-
-          opts.on("-p", "--provider [PROVIDER]", "Provider to list resources.") do |o|
-            @options[:provider] = o
-          end
-        end
-      end
-
-    end
-  end
-end