ami_spec 0.3.0 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 791efe6c0784b76689e581dd3d4172d9069471c81e1f06cf6a3671b2edb2e5c3
+  data.tar.gz: bb3c40ff9295d4dafc97cbc7ec6e54b5514d29a13cd39a17647b1170ee6d7839
+SHA512:
+  metadata.gz: c82b27a4a85ac7fbdc3bac38bf4736d8675167349ffb41bf97deaa9358ae54fa2dea58e286c5ead916058266b3cddb5aca6c0fa0e24c1f4b0e1a0d4e2052ac00
+  data.tar.gz: 857dfa433808063a4a64c8dba5cc2e493f3f064e3a94b69565f28eb49a7a4cedd5950f83e09ad5ec784174c291d0f0ddc016fcd1b9ed07b4135da10a67fb3395

data/README.md

@@ -29,32 +29,34 @@ Run `bundle install`
 ```cli
 $ bundle exec ami_spec --help
 Options:
-  -r, --role=<s>                    The role to test, this should map to a directory in the spec folder
-  -a, --ami=<s>                     The ami ID to run tests against
-  -o, --role-ami-file=<s>           A file containing comma separated roles and amis. i.e.
-                                    web_server,ami-id.
-  -s, --specs=<s>                   The directory to find ServerSpecs
-  -u, --subnet-id=<s>               The subnet to start the instance in
-  -k, --key-name=<s>                The SSH key name to assign to instances
-  -e, --key-file=<s>                The SSH private key file associated to the key_name
-  -h, --ssh-user=<s>                The user to ssh to the instance as
-  -w, --aws-region=<s>              The AWS region, defaults to AWS_DEFAULT_REGION environment variable
-  -i, --aws-instance-type=<s>       The ec2 instance type, defaults to t2.micro (default: t2.micro)
-  -c, --aws-security-groups=<s+>    Security groups to associate to the launched instances. May be specified
-                                    multiple times
-  -p, --aws-public-ip               Launch instances with a public IP
-  -t, --ssh-retries=<i>             The number of times we should try sshing to the ec2 instance before
-                                    giving up. Defaults to 30 (default: 30)
-  -d, --debug                       Don't terminate instances on exit
-  -l, --help                        Show this message
-$  bundle exec ami_spec \
---role web_server \
---ami ami-12345678 \
---subnet-id subnet-abcdefgh \
---key-name ec2-key-pair \
---key-file ~/.ssh/ec2-key-pair.pem \
---ssh-user ubuntu \
---specs ./my_project/spec
+  -r, --role=<s>                        The role to test, this should map to a directory in the spec
+                                        folder
+  -a, --ami=<s>                         The ami ID to run tests against
+  -o, --role-ami-file=<s>               A file containing comma separated roles and amis. i.e.
+                                        web_server,ami-id.
+  -s, --specs=<s>                       The directory to find ServerSpecs
+  -u, --subnet-id=<s>                   The subnet to start the instance in
+  -k, --key-name=<s>                    The SSH key name to assign to instances
+  -e, --key-file=<s>                    The SSH private key file associated to the key_name
+  -h, --ssh-user=<s>                    The user to ssh to the instance as
+  -w, --aws-region=<s>                  The AWS region, defaults to AWS_DEFAULT_REGION environment
+                                        variable
+  -i, --aws-instance-type=<s>           The ec2 instance type, defaults to t2.micro (default:
+                                        t2.micro)
+  -c, --aws-security-groups=<s+>        Security groups to associate to the launched instances. May be
+                                        specified multiple times
+  -p, --aws-public-ip                   Launch instances with a public IP
+  -t, --ssh-retries=<i>                 The number of times we should try sshing to the ec2 instance
+                                        before giving up. Defaults to 30 (default: 30)
+  -g, --tags=<s>                        Additional tags to add to launched instances in the form of
+                                        comma separated key=value pairs. i.e. Name=AmiSpec (default: )
+  -d, --debug                           Don't terminate instances on exit
+  -f, --wait-for-rc                     Wait for oldschool SystemV scripts to run before conducting
+                                        tests. Currently only supports Ubuntu with upstart
+  -l, --user-data-file=<s>              File path for aws ec2 user data
+  -m, --iam-instance-profile-arn=<s>    IAM instance profile to use
+  --help                                Show this message
+
 ```
 
 AmiSpec will launch an EC2 instance from the given AMI (`--ami`), in a subnet (`--subnet-id`) with a key-pair (`--key-name`)

data/lib/ami_spec.rb

@@ -40,6 +40,8 @@ module AmiSpec
   #   Additional tags to add to launched instances in the form of comma separated key=value pairs
   # debug::
   #   Don't terminate the instances on exit
+  # buildkite::
+  #   Output section separators for buildkite
   # == Returns:
   # Boolean - The result of all the server specs.
   def self.run(options)
@@ -100,7 +102,10 @@ module AmiSpec
           type: :int, default: 30
       opt :tags, "Additional tags to add to launched instances in the form of comma separated key=value pairs. i.e. Name=AmiSpec", type: :string, default: ""
       opt :debug, "Don't terminate instances on exit"
+      opt :buildkite, "Output section separators for buildkite"
       opt :wait_for_rc, "Wait for oldschool SystemV scripts to run before conducting tests. Currently only supports Ubuntu with upstart"
+      opt :user_data_file, "File path for aws ec2 user data", type: :string
+      opt :iam_instance_profile_arn, "IAM instance profile to use", type: :string
     end
 
     if options[:role] && options[:ami]
@@ -116,6 +121,14 @@ module AmiSpec
       fail "You must specify either role and ami or role_ami_file"
     end
 
+    unless File.exist? options[:key_file]
+      fail "Key file #{options[:key_file]} not found"
+    end
+
+    unless options[:user_data_file] and File.exist? options[:user_data_file]
+      fail "User Data file #{options[:user_data_file]} not found"
+    end
+
     options[:tags] = parse_tags(options[:tags])
 
     exit run(options)

data/lib/ami_spec/aws_instance.rb

@@ -1,5 +1,6 @@
 require 'aws-sdk'
 require 'forwardable'
+require 'base64'
 
 module AmiSpec
   class AwsInstance
@@ -21,6 +22,8 @@ module AmiSpec
       @region = options.fetch(:aws_region)
       @security_group_ids = options.fetch(:aws_security_groups)
       @tags = ec2ify_tags(options.fetch(:tags))
+      @user_data_file = options.fetch(:user_data_file, nil)
+      @iam_instance_profile_arn = options.fetch(:iam_instance_profile_arn, nil)
     end
 
     def_delegators :@instance, :instance_id, :tags, :terminate, :private_ip_address, :public_ip_address
@@ -58,6 +61,14 @@ module AmiSpec
         }]
       }
 
+      params[:user_data] = Base64.encode64(File.read(@user_data_file)) unless @user_data_file.nil?
+
+      unless @iam_instance_profile_arn.nil?
+        params[:iam_instance_profile] = {
+            arn: @iam_instance_profile_arn
+        }
+      end
+
       unless @security_group_ids.nil?
         params[:network_interfaces][0][:groups] = @security_group_ids
       end

data/lib/ami_spec/aws_instance_options.rb

@@ -13,5 +13,7 @@ module AmiSpec
     property :aws_region
     property :aws_security_groups
     property :tags
+    property :user_data_file
+    property :iam_instance_profile_arn
   end
 end

data/lib/ami_spec/server_spec.rb

@@ -15,10 +15,17 @@ module AmiSpec
       @spec = options.fetch(:specs)
       @user = options.fetch(:ssh_user)
       @key_file = options.fetch(:key_file)
+      @buildkite = options.fetch(:buildkite)
+      @user_data_file = options.fetch(:user_data_file)
+      @iam_instance_profile_arn = options.fetch(:user_data_file)
     end
 
     def run
-      puts "Running tests for #{@role}"
+      if @buildkite
+        puts "--- Running tests for #{@role}"
+      else
+        puts "Running tests for #{@role}"
+      end
 
       $LOAD_PATH.unshift(@spec) unless $LOAD_PATH.include?(@spec)
       require File.join(@spec, 'spec_helper')
@@ -38,6 +45,7 @@ module AmiSpec
 
       Specinfra::Backend::Ssh.clear
 
+      puts "^^^ +++" if @buildkite && !result.zero?
       result.zero?
     end
   end

data/lib/ami_spec/server_spec_options.rb

@@ -10,5 +10,8 @@ module AmiSpec
     property :key_file
     property :specs
     property :ssh_user
+    property :buildkite
+    property :user_data_file
+    property :iam_instance_profile_arn
   end
 end

data/lib/ami_spec/version.rb

@@ -1,3 +1,3 @@
 module AmiSpec
-  VERSION = '0.3.0'
+  VERSION = '1.0.0'
 end

data/spec/aws_instance_spec.rb

@@ -1,4 +1,6 @@
 require 'spec_helper'
+require 'base64'
+require 'tempfile'
 
 describe AmiSpec::AwsInstance do
   let(:role) { 'web_server' }
@@ -8,6 +10,9 @@ describe AmiSpec::AwsInstance do
   let(:new_ec2_double) { instance_double(Aws::EC2::Types::Instance) }
   let(:ec2_double) { instance_double(Aws::EC2::Instance) }
   let(:tags) { {} }
+  let(:iam_instance_profile_arn) { nil }
+  let(:user_data_file) { nil }
+
   subject(:aws_instance) do
     described_class.new(
       role: role,
@@ -18,7 +23,9 @@ describe AmiSpec::AwsInstance do
       aws_public_ip: false,
       aws_security_groups: sec_group_id,
       aws_region: region,
-      tags: tags
+      tags: tags,
+      user_data_file: user_data_file,
+      iam_instance_profile_arn: iam_instance_profile_arn
     )
   end
 
@@ -91,6 +98,33 @@ describe AmiSpec::AwsInstance do
       end
     end
 
+    context 'with user_data' do
+      let(:user_data_file) {
+        file = Tempfile.new('user_data.txt')
+        file.write("my file\ncontent")
+        file.close
+        file.path
+      }
+
+      it 'does include user_data' do
+        expect(client_double).to receive(:run_instances).with(
+            hash_including(:user_data =>  Base64.encode64("my file\ncontent"))
+        )
+        start
+      end
+    end
+
+    context 'with iam_instance_profile_arn' do
+      let(:iam_instance_profile_arn) { "my_arn" }
+
+      it 'does include iam_instance_profile_arn' do
+        expect(client_double).to receive(:run_instances).with(
+            hash_including(:iam_instance_profile =>  { arn: 'my_arn'})
+        )
+        start
+      end
+    end
+
     it 'tags the instance with a role' do
       expect(ec2_double).to receive(:create_tags).with(
                                  hash_including(tags: [{ key: 'AmiSpec', value: role}])

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ami_spec
 version: !ruby/object:Gem::Version
-  version: 0.3.0
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Patrick Robinson
@@ -10,118 +9,104 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-15 00:00:00.000000000 Z
+date: 2018-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: serverspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: specinfra
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.45'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.45'
 - !ruby/object:Gem::Dependency
   name: trollop
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
 description: Acceptance testing your AMIs
@@ -131,9 +116,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .ruby-version
-- .travis.yml
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -154,31 +139,29 @@ files:
 - spec/wait_for_ssh_spec.rb
 homepage: https://github.com/envato/ami-spec
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23.2
+rubygems_version: 2.7.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Acceptance testing your AMIs
 test_files:
 - spec/ami_spec_spec.rb
 - spec/aws_instance_spec.rb
 - spec/spec_helper.rb
 - spec/wait_for_ssh_spec.rb
-has_rdoc: