aws-must-templates 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf3a6e500d517d701c0215e0477fa9a8d595b979
-  data.tar.gz: 1b2ac0944b78a61036e66e217c39eb47623a2a5e
+  metadata.gz: ecd754daf7d055170eebd8f71822e307d16bc46b
+  data.tar.gz: 26abbd64a494b9bd110404d5e6ee12665d55de48
 SHA512:
-  metadata.gz: 0c17f5daae17aabf52b9cd254f9cd13e5d5189c7cd8125f1299fc1e4ab15a30e28693da298a50447fc2cac4dacd8ba86f3db744a448f80bcdf9487ffce2cf9dd
-  data.tar.gz: 075de499bb571c08655a4a35df483ceaa4993bcae8c8ee75fe5a458a0420f8832df17a617c4b89a81ca3edf7656af809d5d72aff59361ce7c5898dad4bcf41eb
+  metadata.gz: 3b2d31cc6043c8980ae42827ffb0f5bfba188ab84fa74d294c01eaa1a3bde46dc213639d6942a204a786fc4f819b0353cb5ce88756100360274360a61b051ba8
+  data.tar.gz: 0ae4e92ade9306216892a408a71a4cf599c696cf6d934ac946bc401fef20d9d8fd48e8046356ec095f918d0fffc3391fe9e209273293cacae14ca31445293e61

data/README.md

@@ -1,4 +1,4 @@
-# aws-must-templates - cloudformation templates for aws-must - $Release:0.1.2$
+# aws-must-templates - cloudformation templates for aws-must - $Release:0.1.3$
 
 Set of [extensible](#OVERRIDE)
 [templates](https://rawgit.com/jarjuk/aws-must-templates/master/generated-docs/aws-must-templates.html)
@@ -181,25 +181,23 @@ To use the **aws-must-templates** Test Runner
 
 ### Setup for Test Runner<a id="SETUP-TEST-RUNNER"/>
 
-Ensure that `Gemfile` includes
-
-	gem 'rake'
-	gem 'rspec'
-	gem 'serverspec'
-	gem 'aws-must-templates'
-
-Run `bundle install`, if new gems were added to the `Gemfile`.
-
 Add following lines to `Rakefile`
 
 	spec = Gem::Specification.find_by_name 'aws-must-templates'
 	load "#{spec.gem_dir}/lib/tasks/suite.rake"
 	
+create an empty `test-suites.yaml`	 -file
+
+	touch test-suites.yaml
+
 and run 	
 
 	bundle exec rake -T suite
 	
-to show new tasks for the Test Runner.
+For an empty test-suites.yaml the result shows
+
+	rake suite:all[gen_opts]  # Run all suites
+
 
 ### Prepare Test Context <a id="TEST-CONTEXT"/>
 
@@ -263,29 +261,30 @@ with the code shown:
     end
 
 
-See [test report](generated-docs/test-suites.md) created when running
-suites defined in [test-suites.yaml](test-suites.yaml), and
-[diagram](generated-docs/xref_suite_X_test.pdf) presenting Test Cases
-used in Test Suites.
+For more information on Test Cases, see
+[test report](generated-docs/test-suites.md) created, when running
+[test-suites](test-suites.yaml) in **aws-must-templates** development,
+and a [diagram](generated-docs/xref_suite_X_test.pdf) for an overview.
+
 
 ### Configure Test Suites <a id="TEST-SUITES"/>
 
-Test suites are configured in `test-suites.yaml`. Test runner search
-this file in current working directory. 
+Test Suites are configured in `test-suites.yaml`. Test Runner searches
+this file in current working directory.
 
 The picture below present main elements used in `test-suites.yaml`.
 
 ![test-suites.yaml elements](./pics/test-suites.jpg)
 
-A Test Suite validates the correctness of a CloudFormation Stack. One
-Test Suite defines tests for multiple EC2 Instances. Each EC2 Instance
-must have a corresponding SSH Connection prepared in
+A Test Suite validates correctness of a CloudFormation Stack. One Test
+Suite defines tests for multiple EC2 Instances. Each EC2 Instance must
+have a corresponding SSH Connection prepared in
 [ssh/config](#TEST-CONTEXT) -file. An EC2 Instance acts in many
 Roles. A Role maps to a [Test Case](#TEST_CASES), and and defines
 values for the Test Case Parameters. The parameter may be a constant,
 or a reference to Stack Parameter, or to Stack Output.
 
-An example Test Case for `mystack` is shown below
+As an example, the Test Suite for `mystack` is 
 
     - mystack:
        desc: Copy of suite1 EC2 instance with s3 access
@@ -297,22 +296,22 @@ An example Test Case for `mystack` is shown below
               - S3ReadAccessAllowed:
                     Bucket: "@Outputs.Bucket"
 
-This configuration validates stack `mystack` by running two Test Cases
+The Suite validates stack `mystack` by running two Test Cases
 `ValidOSVersion` and `S3ReadAccessAllowed` on EC2 instance
 `myInstance`.
 
-Test Case ValidOSVersion was presented [earlier](#TEST_CASES). It uses
-parameter `Codename` to validate operating system version. In this
-configuration, the parameter value is constant `utopic`. Effectively
-this validates that CloudFormation mapping used to
-[override](#OVERRIDE) the default implementation in
+Test Case `ValidOSVersion` was presented [earlier](#TEST_CASES). It
+uses parameter `Codename` to validate operating system version. In
+this configuration, the parameter value is constant
+`utopic`. Effectively this validates that CloudFormation mapping used
+to [override](#OVERRIDE) the default implementation in
 **aws-must-templates** is successfully provisioned.
 
 Test Case `S3ReadAccessAllowed` is passed a parameter, which gets its
 value from stack output variable `Bucket`.
 
-See [test-suites.yaml](test-suites.yaml) in **aws-must-templatest**
-for more detailed explanation, and for more examples.
+See [test-suites.yaml](test-suites.yaml) in **aws-must-templates** for
+a more detailed explanation, and for more examples.
 
 ### Running test suites <a id="RUN-TESTS"/>
 

data/spec/aws-must-templates/AwsCommandLineInterfaceInstalled/AwsCommandLineInterfaceInstalled_spec.rb

@@ -0,0 +1,10 @@
+require  'spec_helper'
+
+describe "AwsCommandLineInterfaceInstalled" do 
+
+  describe command('type aws') do
+      its( :exit_status ) { should eq 0 }
+  end
+
+
+end

data/spec/aws-must-templates/AwsMustTestRunnerProperties/AwsMustTestRunnerProperties_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+
+
+# ------------------------------------------------------------------
+# Configuration
+# 
+
+current_test = "AwsMustTestRunnerProperties"
+
+# every suite should define these paramentes
+system_properties = [
+                     [:stack_id ],
+                     [:suite_id ],
+                     ["Outputs" ],
+                     ["Parameters" ],
+                    ]
+
+# ------------------------------------------------------------------
+# 
+
+describe current_test do 
+
+  # ------------------------------------------------------------------
+  # 
+  describe "System properties" do
+
+    system_properties.each do | keys |
+
+      describe valid_property( keys ) do
+        its( :value ) { should_not eq nil } 
+      end
+
+    end
+  end
+
+
+end
+

data/spec/aws-must-templates/CloudFormationHelperScriptsInstalled/CloudFormationHelperScriptsInstalled_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe "CloudFormationHelperScriptsInstalled" do 
+
+  describe command('type cfn-init') do
+      its( :exit_status ) { should eq 0 }
+  end
+
+  describe command('type cfn-signal') do
+      its( :exit_status ) { should eq 0 }
+  end
+
+  describe command('type cfn-get-metadata') do
+      its( :exit_status ) { should eq 0 }
+  end
+
+  describe command('type cfn-hup') do
+      its( :exit_status ) { should eq 0 }
+  end
+
+end

data/spec/aws-must-templates/ParameterTest/ParameterTest_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+
+current_test = "ParameterTest"
+
+describe  current_test do |ex|
+
+
+  # ------------------------------------------------------------------
+  # test parameters
+  parameter1 = test_parameter( current_test, "param1" )
+  parameter2 = test_parameter( current_test, "param2" )
+  parameter3 = test_parameter( current_test, "param3" )
+
+
+  # ------------------------------------------------------------------
+  # Test paramters defined
+
+  describe "Test parameter definition" do
+
+    describe parameter1 do
+      its( :definition_in_test_suite ) { should_not  eq nil }
+    end
+
+    describe parameter2 do
+      its( :definition_in_test_suite ) { should_not eq nil }
+    end
+
+    describe parameter3 do
+      its( :definition_in_test_suite ) { should_not eq nil }
+    end
+
+  end #  describe "Test parameters" do
+
+end

data/spec/aws-must-templates/S3NoAccess/S3NoAccess_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+# ------------------------------------------------------------------
+# config
+
+current_test = "S3NoAccess"
+
+# ------------------------------------------------------------------
+# Tests
+
+describe current_test  do 
+
+  # ------------------------------------------------------------------
+  # test parameters
+
+  bucket_name = test_parameter( current_test, "Bucket" )
+
+  # ------------------------------------------------------------------
+  # Context NO access granted
+
+  context "When Bucket exists" do 
+
+    before(:all) do
+      cmd =  "aws s3 ls s3://#{bucket_name.value}"
+      `#{cmd}`
+      raise "Error in '#{cmd}' " unless $? == 0
+    end
+
+    describe "#cannot  list Bucket" do 
+      describe command('aws s3 ls') do
+        its( :exit_status ) { should_not eq 0 }
+      end
+    end
+
+    test_file="ttest22.tmp"
+
+
+    context "When Object exists in Bucket" do 
+
+      # File copy succeed --> bucket exists
+      before() do
+        cmd =  "echo tst | aws s3 cp - s3://#{bucket_name.value}/#{test_file}"
+        `#{cmd}`
+        raise "Error in '#{cmd}' " unless $? == 0
+      end
+
+      after(:all) do
+        cmd = "aws s3 rm  s3://#{bucket_name.value}/#{test_file}"
+        `#{cmd}`
+        raise "Error in '#{cmd}' " unless $? == 0
+      end
+
+      describe "#cannot list S3 bucket keys" do 
+        describe command( "aws s3 ls s3://#{bucket_name.value} --region $(aws s3api get-bucket-location --bucket #{bucket_name.value} --output text)") do
+          its( :exit_status ) { should_not eq 0 }
+        end
+      end
+
+      describe "#cannot cp S3 bucket object" do 
+        describe command("aws s3 cp s3://#{bucket_name.value}/#{test_file} /tmp/#{test_file} --region $(aws s3api get-bucket-location --bucket #{bucket_name.value} --output text)") do
+          its( :exit_status ) { should_not eq 0 }
+        end
+      end
+
+    end # conttext
+
+  end
+
+
+
+
+end

data/spec/aws-must-templates/S3ReadAccessAllowed/S3ReadAccessAllowed_spec.rb

@@ -0,0 +1,144 @@
+require 'spec_helper'
+
+current_test = "S3ReadAccessAllowed"
+
+describe current_test do
+
+  # ------------------------------------------------------------------
+  # test parameters
+
+  bucket_name = test_parameter( current_test, "Bucket" )
+
+  # bucket_name =  stack_output( 'Bucket' ).value 
+
+  # ------------------------------------------------------------------
+  # constanst used in test
+
+  test_file="ttest.tmp"
+
+  # ------------------------------------------------------------------
+  # Test paramters defined
+
+  describe "Test parameter definition" do
+
+    describe bucket_name do
+      its( :definition_in_test_suite ) { should_not  eq nil }
+    end
+
+  end
+
+  describe "Test parameter values" do
+
+    describe bucket_name do
+      its( :value ) { should_not  eq nil }
+    end
+
+  end
+
+
+  # # ------------------------------------------------------------------
+  # # Stack parameters && outputs
+
+  # describe "Stack" do 
+
+  #   it "#defines bucket_name"  do
+  #     expect( bucket_name ).not_to eql( nil )
+  #   end
+
+  # end
+
+  # ------------------------------------------------------------------
+  # aws Command line interface installed
+
+  context "Operating system context" do 
+
+    describe "Aws Commad Line Interface (CLI) is installed" do 
+      describe command('type aws') do
+        its( :exit_status ) { should eq 0 }
+      end
+    end
+
+  end
+
+  # ------------------------------------------------------------------
+  # Context
+
+  context "When read access to a S3 bucket granted" do 
+
+    describe "Can list S3 buckets" do 
+      describe command('aws s3 ls') do
+        its( :exit_status ) { should eq 0 }
+      end
+    end
+
+    describe "Can list S3 bucket keys" do 
+      default_ls = "aws s3 ls s3://#{bucket_name.value}"
+      region_ls  = "aws s3 ls s3://#{bucket_name.value} --region $(aws s3api get-bucket-location --bucket #{bucket_name.value} --output text)"
+      describe command( "#{default_ls} || #{region_ls}" ) do
+        its ( :exit_status ) { should eq 0 }
+      end
+    end
+
+
+    context "When an Object exists in S3 bucket" do 
+
+      before(:context) do
+        cmd =  "echo tst | aws s3 cp - s3://#{bucket_name.value}/#{test_file}"
+        `#{cmd}`
+        raise "Error in '#{cmd}' " unless $? == 0
+      end
+
+      after(:context) do
+        cmd = "aws s3 rm  s3://#{bucket_name.value}/#{test_file}"
+        `#{cmd}`
+        raise "Error in '#{cmd}' " unless $? == 0
+      end
+
+      # Using "serverspec" style here
+      describe "Can read the Object from a S3 bucket" do 
+        default_cp = "aws s3 cp s3://#{bucket_name.value}/#{test_file} /tmp/#{test_file}"
+        region_cp = "aws s3 cp s3://#{bucket_name.value}/#{test_file} /tmp/#{test_file} --region $(aws s3api get-bucket-location --bucket #{bucket_name.value} --output text)"
+        describe command( "#{default_cp} || #{region_cp}" ) do
+          its( :exit_status ) { should eq 0 }
+        end
+
+      end
+
+      # using subject + expect style
+      describe "Cannot modify (= delete) the  Object in bucket" do
+
+        describe  command("aws s3 rm s3://#{bucket_name.value}/#{test_file} --region $(aws s3api get-bucket-location --bucket #{bucket_name.value} --output text)") do
+          its ( :exit_status )  { should_not eql 0 }
+        end
+
+      end
+
+    end # context test_file in bucket
+
+    # subject + it is_expected one liner
+    describe "Cannot write to bucket" do 
+
+      describe "Create an Object in bucket should fail" do
+        describe command("aws s3 cp /etc/hosts  s3://#{bucket_name.value}/#{test_file} --region $(aws s3api get-bucket-location --bucket #{bucket_name.value} --output text)") do
+          its( :exit_status ) { should_not eql 0  }
+        end
+      end
+    end
+  end
+
+  # ------------------------------------------------------------------
+  # 
+
+  context "When bucket does not exists" do 
+
+    describe "Cannot list S3 bucket keys" do 
+
+      describe command( "aws s3 ls s3://DASKLjwKLJ4534Buckert --region $(aws s3api get-bucket-location --bucket #{@bucket_name} --output text)") do
+        its( :exit_status ) { should_not eq 0 }
+      end
+    end
+
+  end
+
+
+end