capistrano-elb-autoscaling 1.0.0

data/lib/elbas.rb

@@ -0,0 +1,21 @@
+require 'capistrano/all'
+require 'aws-sdk-autoscaling'
+require 'aws-sdk-ec2'
+
+require 'elbas/version'
+require 'elbas/logger'
+require 'elbas/retryable'
+
+require 'elbas/errors/no_launch_template'
+
+require 'elbas/aws/base'
+require 'elbas/aws/taggable'
+require 'elbas/aws/instance_collection'
+require 'elbas/aws/instance'
+require 'elbas/aws/autoscale_group'
+require 'elbas/aws/launch_template'
+require 'elbas/aws/ami'
+require 'elbas/aws/snapshot'
+
+module Elbas
+end

data/spec/aws/ami_spec.rb

@@ -0,0 +1,140 @@
+describe Elbas::AWS::AMI do
+  subject { Elbas::AWS::AMI.new 'test' }
+
+  describe '#initialize' do
+    it 'sets the id' do
+      expect(subject.id).to eq 'test'
+    end
+
+    it 'has an aws-sdk counterpart' do
+      expect(subject.aws_counterpart).to be_a_kind_of ::Aws::EC2::Image
+      expect(subject.aws_counterpart.id).to eq 'test'
+    end
+
+    context 'with snapshots' do
+      subject do
+        Elbas::AWS::AMI.new 'test', [
+          double(:bdm, ebs: double(:ebs, snapshot_id: 'snap-1'))
+        ]
+      end
+
+      it 'sets snapshots to Snapshot objects' do
+        expect(subject.snapshots.size).to eq 1
+        expect(subject.snapshots[0]).to be_a_kind_of Elbas::AWS::Snapshot
+      end
+
+      it 'sets the ID on the Snapshots' do
+        expect(subject.snapshots[0].id).to eq 'snap-1'
+      end
+    end
+  end
+
+  describe '#deploy_id' do
+    it 'returns the ELBAS-Deploy-id tag, if set' do
+      webmock :post, /ec2/ => 201, with: Hash[body: /Action=CreateTags/]
+      subject.tag 'ELBAS-Deploy-id', 'test'
+      expect(subject.deploy_id).to eq 'test'
+    end
+
+    it 'returns nil if the tag was never set' do
+      expect(subject.deploy_id).to be_nil
+    end
+  end
+
+  describe '#deploy_group' do
+    it 'returns the ELBAS-Deploy-group tag, if set' do
+      webmock :post, /ec2/ => 201, with: Hash[body: /Action=CreateTags/]
+      subject.tag 'ELBAS-Deploy-group', 'test'
+      expect(subject.deploy_group).to eq 'test'
+    end
+
+    it 'returns nil if the tag was never set' do
+      expect(subject.deploy_group).to be_nil
+    end
+  end
+
+  describe '#ancestors' do
+    before do
+      webmock :post, /ec2/ => 201, with: Hash[body: /Action=CreateTags/]
+      subject.tag 'ELBAS-Deploy-group', 'test'
+      subject.tag 'ELBAS-Deploy-id', 'test'
+
+      webmock :post, %r{ec2.(.*).amazonaws.com\/\z} => 'DescribeImages.200.xml',
+        with: Hash[body: /Action=DescribeImages/]
+    end
+
+    it 'includes AMIs from the same deploy group, different deploy ID' do
+      expect {
+        subject.tag 'ELBAS-Deploy-id', 'not-test'
+      }.to change {
+        subject.ancestors.size
+      }.by 1
+    end
+  end
+
+  describe '#delete' do
+    before do
+      webmock :post, /ec2/ => 201, with: Hash[body: /Action=DeregisterImage/]
+    end
+
+    it 'calls the deregister AMI API' do
+      subject.delete
+      expect(WebMock)
+        .to have_requested(:post, /ec2/)
+        .with body: /Action=DeregisterImage&ImageId=test/
+    end
+
+    context 'with snapshots' do
+      subject do
+        Elbas::AWS::AMI.new 'test', [
+          double(:bdm, ebs: double(:ebs, snapshot_id: 'snap-1'))
+        ]
+      end
+
+      it 'deletes the AMIs snapshots too' do
+        webmock :post, /ec2/ => 201, with: Hash[body: /Action=DeleteSnapshot/]
+
+        subject.delete
+        expect(WebMock)
+          .to have_requested(:post, /ec2/)
+          .with body: /Action=DeleteSnapshot&SnapshotId=snap-1/
+      end
+    end
+  end
+
+  describe '.create' do
+    subject { described_class }
+    let(:instance) { Elbas::AWS::Instance.new 'i-1234567890', nil, nil }
+
+    before do
+      webmock :post, %r{ec2.(.*).amazonaws.com\/\z} => 'CreateImage.200.xml',
+        with: Hash[body: /Action=CreateImage/]
+    end
+
+    it 'calls the API with the instance given' do
+      subject.create instance
+      expect(WebMock)
+        .to have_requested(:post, /ec2/)
+        .with body: /Action=CreateImage&InstanceId=i-1234567890&Name=ELBAS-ami-(\d+)/
+    end
+
+    it 'uses the no_reboot option by default' do
+      subject.create instance
+      expect(WebMock)
+        .to have_requested(:post, /ec2/)
+        .with(body: /NoReboot=true/)
+    end
+
+    it 'uses no_reboot as false, if given' do
+      subject.create instance, no_reboot: false
+      expect(WebMock)
+        .to have_requested(:post, /ec2/)
+        .with(body: /NoReboot=false/)
+    end
+
+    it 'returns the an AMI object with the new id' do
+      ami = subject.create instance
+      expect(ami.id).to eq 'ami-4fa54026' # from stub
+    end
+  end
+end

data/spec/aws/autoscale_group_spec.rb

@@ -0,0 +1,67 @@
+describe Elbas::AWS::AutoscaleGroup do
+  subject { Elbas::AWS::AutoscaleGroup.new 'test-asg' }
+
+  before do
+    webmock :post, %r{autoscaling.(.*).amazonaws.com\/\z} => 'DescribeAutoScalingGroups.200.xml',
+      with: Hash[body: /Action=DescribeAutoScalingGroups/]
+
+    webmock :post, %r{ec2.(.*).amazonaws.com\/\z} => 'DescribeInstances.200.xml',
+      with: Hash[body: /Action=DescribeInstances/]
+  end
+
+  describe '#initialize' do
+    it 'sets the name' do
+      expect(subject.name).to eq 'test-asg'
+    end
+
+    it 'has an aws-sdk counterpart' do
+      expect(subject.aws_counterpart).to be_a_kind_of ::Aws::AutoScaling::Types::AutoScalingGroup
+      expect(subject.aws_counterpart.auto_scaling_group_name).to eq 'test-asg'
+    end
+  end
+
+  describe '#instance_ids' do
+    it 'returns every instance ID in the ASG' do
+      expect(subject.instance_ids).to eq ['i-1234567890', 'i-500']
+    end
+  end
+
+  describe '#instances' do
+    it 'returns an instance collection with all instances' do
+      instances = subject.instances
+      expect(instances.count).to eq 2
+    end
+  end
+
+  describe '#launch_template' do
+    it 'throws an error if there is no launch template' do
+      expect { subject.launch_template }.to raise_error(Elbas::Errors::NoLaunchTemplate)
+    end
+
+    it 'returns a LaunchTemplate object with the id/name/version set' do
+      allow(subject.aws_counterpart).to receive(:launch_template) do
+        double(:lt, launch_template_id: 'test-1', launch_template_name: 'Test', version: '$Latest')
+      end
+
+      expect(subject.launch_template.id).to eq 'test-1'
+      expect(subject.launch_template.name).to eq 'Test'
+      expect(subject.launch_template.version).to eq '$Latest'
+    end
+
+    it 'returns a LauchTemplate object for fleet composition' do
+      allow(subject.aws_counterpart).to receive(:launch_template) { nil }
+      allow(subject.aws_counterpart).to receive_message_chain(
+        :mixed_instances_policy, :launch_template,
+        :launch_template_specification) do
+        double(launch_template_id: 'test-2',
+               launch_template_name: 'mixed_instance',
+               version: '$Latest')
+      end
+
+      expect(subject.launch_template.id).to eq 'test-2'
+      expect(subject.launch_template.name).to eq 'mixed_instance'
+      expect(subject.launch_template.version).to eq '$Latest'
+    end
+
+  end
+end

data/spec/aws/instance_collection_spec.rb

@@ -0,0 +1,38 @@
+describe Elbas::AWS::InstanceCollection do
+  subject { Elbas::AWS::InstanceCollection.new ['i-1234567890', 'i-500'] }
+
+  scenarios = [
+    { context: 'Single AWS reservation', mock_response_file: 'DescribeInstances.200.xml' },
+    { context: 'Multiple AWS reservation', mock_response_file: 'DescribeInstances_MultipleReservations.200.xml' }
+  ]
+
+  scenarios.each do |scenario|
+    context scenario[:context] do
+      before do
+        webmock :post, %r{ec2.(.*).amazonaws.com\/\z} => scenario[:mock_response_file],
+          with: Hash[body: /Action=DescribeInstances/]
+      end
+
+      describe '#instances' do
+        it 'returns Instance objects with name/hostname/state' do
+          expect(subject.instances[0].id).to eq 'i-1234567890'
+          expect(subject.instances[0].hostname).to eq 'ec2-1234567890.amazonaws.com'
+          expect(subject.instances[0].state).to eq 16
+
+          expect(subject.instances[1].id).to eq 'i-500'
+          expect(subject.instances[1].hostname).to eq 'ec2-500.amazonaws.com'
+          expect(subject.instances[1].state).to eq 32
+        end
+      end
+
+      describe '#running' do
+        it 'returns only running instances' do
+          expect(subject.instances.size).to eq 2
+          expect(subject.running.size).to eq 1
+          expect(subject.running[0].id).to eq 'i-1234567890'
+        end
+      end
+    end
+  end
+
+end

data/spec/aws/instance_spec.rb

@@ -0,0 +1,30 @@
+describe Elbas::AWS::Instance do
+  subject { Elbas::AWS::Instance.new 'i-1234567890', 'ec2-1234567890.amazonaws.com', 16 }
+
+  describe '#initialize' do
+    it 'sets the AWS counterpart' do
+      expect(subject.aws_counterpart).to be_a_kind_of ::Aws::EC2::Instance
+      expect(subject.aws_counterpart.id).to eq 'i-1234567890'
+    end
+  end
+
+  describe '#hostname' do
+    it 'returns the public DNS' do
+      expect(subject.hostname).to eq 'ec2-1234567890.amazonaws.com'
+    end
+  end
+
+  describe '#running?' do
+    it 'returns true if the state code is 16 ("running")' do
+      expect(subject).to receive(:state) { 16 }
+      expect(subject).to be_running
+    end
+
+    it 'returns false for every other state code' do
+      [0, 32, 48, 64, 80].each do |code|
+        expect(subject).to receive(:state) { code }
+        expect(subject).to_not be_running
+      end
+    end
+  end
+end

data/spec/aws/launch_template_spec.rb

@@ -0,0 +1,52 @@
+describe Elbas::AWS::LaunchTemplate do
+  subject { Elbas::AWS::LaunchTemplate.new 'test-lt', 'test', '1' }
+
+  before do
+    webmock :post, %r{ec2.(.*).amazonaws.com\/\z} => 'CreateLaunchTemplateVersion.200.xml',
+      with: Hash[body: /Action=CreateLaunchTemplateVersion/]
+  end
+
+  describe '#initialize' do
+    it 'sets the id' do
+      expect(subject.id).to eq 'test-lt'
+    end
+
+    it 'sets the name' do
+      expect(subject.name).to eq 'test'
+    end
+
+    it 'sets the version' do
+      expect(subject.version).to eq '1'
+    end
+  end
+
+  describe '#update' do
+    it 'hits the CreateLaunchTemplateVersion API' do
+      subject.update double(:ami, id: 'ami-123')
+      expect(WebMock)
+        .to have_requested(:post, /ec2/)
+        .with(body: %r{Action=CreateLaunchTemplateVersion})
+    end
+
+    it 'creates a new launch template from the given AMI' do
+      subject.update double(:ami, id: 'ami-123')
+      expect(WebMock)
+        .to have_requested(:post, /ec2/)
+        .with(body: %r{LaunchTemplateData.ImageId=ami-123})
+    end
+
+    it 'uses itself as the source' do
+      subject.update double(:ami, id: 'ami-123')
+      expect(WebMock)
+        .to have_requested(:post, /ec2/)
+        .with(body: %r{LaunchTemplateId=test-lt&SourceVersion=1})
+    end
+
+    it 'returns a new launch template' do
+      launch_template = subject.update double(:ami, id: 'ami-123')
+      expect(launch_template.id).to eq 'lt-1234567890'
+      expect(launch_template.name).to eq 'elbas-test'
+      expect(launch_template.version).to eq 123
+    end
+  end
+end

data/spec/aws/taggable_spec.rb

@@ -0,0 +1,53 @@
+describe Elbas::AWS::Taggable do
+  TestTaggable = Class.new do
+    include Elbas::AWS::Taggable
+
+    def aws_counterpart
+      @aws_counterpart ||= ::Aws::EC2::Instance.new 'test'
+    end
+  end
+
+  let(:subject) { TestTaggable.new }
+
+
+
+  context 'Tagging fails because resource is not created yet' do
+    before do
+      stub_request(:post, %r{amazonaws.com\/\z}).
+        to_raise(StandardError).then.
+        to_raise(StandardError).then.
+        to_return(body: '')
+    end
+
+    describe '#tag' do
+      it 'retries the tag up to 3 times' do
+        expect(subject.aws_counterpart).to receive(:create_tags).exactly(3).times.and_call_original
+        subject.tag 'test', 'true'
+      end
+    end
+
+  end
+
+  context 'Tagging succeeds' do
+    before do
+      webmock :post, %r{amazonaws.com\/\z} => 'CreateTags.200.xml',
+        with: Hash[body: /Action=CreateTags/]
+    end
+
+    describe '#tag' do
+      it 'hits the CreateTags API' do
+        subject.tag 'test', 'true'
+        expect(WebMock)
+          .to have_requested(:post, /aws/)
+          .with body: /Action=CreateTags/
+      end
+
+      it 'sends the resource, key, and value' do
+        subject.tag 'test', 'true'
+        expect(WebMock)
+          .to have_requested(:post, /aws/)
+          .with body: /ResourceId.1=test&Tag.1.Key=test&Tag.1.Value=true/
+      end
+    end
+  end
+end

data/spec/capistrano_spec.rb

@@ -0,0 +1,77 @@
+require 'elbas/capistrano'
+
+describe '#autoscale' do
+  before do
+    Capistrano::Configuration.reset!
+    Rake::Task.define_task('deploy') {}
+
+    webmock :post, %r{autoscaling.(.*).amazonaws.com\/\z} => 'DescribeAutoScalingGroups.200.xml',
+      with: Hash[body: /Action=DescribeAutoScalingGroups/]
+  end
+
+  context 'one server'  do
+    before do
+      webmock :post, %r{ec2.(.*).amazonaws.com\/\z} => 'DescribeInstances.200.xml',
+      with: Hash[body: /Action=DescribeInstances/]
+    end
+
+    it 'adds the server hostname' do
+      autoscale 'test-asg'
+      expect(env.servers.count).to eq 1
+      expect(env.servers.first.hostname).to eq 'ec2-1234567890.amazonaws.com'
+    end
+
+    it 'passes along the properties' do
+      autoscale 'test-asg', roles: [:db], primary: true
+      expect(env.servers.first.properties.roles).to match_array [:db]
+      expect(env.servers.first.properties.primary).to eq true
+    end
+  end
+
+  context 'multiple servers' do
+    before do
+      webmock :post, %r{ec2.(.*).amazonaws.com\/\z} => 'DescribeInstances_MultipleRunning.200.xml',
+        with: Hash[body: /Action=DescribeInstances/]
+    end
+
+    it 'adds multiple server hostnames' do
+      autoscale 'test-asg'
+      expect(env.servers.count).to eq 2
+      expect(env.servers.map(&:hostname)).to match_array ['ec2-1234567890.amazonaws.com', 'ec2-1122334455.amazonaws.com']
+    end
+
+    it 'passes along the properties' do
+      autoscale 'test-asg', roles: [:db], primary: true
+      count = 0
+      env.servers.each do |server|
+        count = count + 1
+        expect(server.properties.roles).to match_array [:db]
+        expect(server.properties.primary).to eq true
+      end
+      expect(count).to eq 2
+    end
+
+    it 'yields to find properties if a block is given' do
+      autoscale 'test-asg', roles: [:web] do |server, i|
+        { roles: [:web, :db], primary: true } if i == 0
+      end
+
+      expect(env.servers.to_a[0].properties.roles).to match_array [:web, :db]
+      expect(env.servers.to_a[0].properties.primary).to eq true
+
+      expect(env.servers.to_a[1].properties.roles).to match_array [:web]
+      expect(env.servers.to_a[1].properties.keys).to_not include :primary
+    end
+  end
+
+  context 'no servers' do
+    before do
+      webmock :post, %r{ec2.(.*).amazonaws.com\/\z} => 'DescribeInstances_Empty.200.xml',
+        with: Hash[body: /Action=DescribeInstances/]
+    end
+
+    it 'logs as an error' do
+      expect { autoscale 'test-asg' }.to output.to_stderr
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'webmock'
+require 'capistrano/all'
+require 'byebug'
+
+ENV['AWS_REGION'] = 'us-east-1'
+ENV['AWS_ACCESS_KEY_ID'] = 'test-access'
+ENV['AWS_SECRET_ACCESS_KEY'] = 'test-secret'
+
+require 'elbas'
+require 'webmock/rspec'
+
+# Hack for webmock-rspec-helper
+Rails = Class.new do
+  def self.root
+    Pathname.new(__dir__).join('..')
+  end
+end
+
+require 'webmock-rspec-helper'
+
+WebMock.disable_net_connect!
+
+Dir[File.join(File.expand_path('../..', __FILE__), 'spec', 'support', '**', '*.rb')].each { |f| require f }
+
+RSpec.configure do |c|
+  c.include Capistrano::DSL
+end

data/spec/support/stubs/CreateImage.200.xml

@@ -0,0 +1,4 @@
+<CreateImageResponse xmlns="http://ec2.amazonaws.com/doc/2014-10-01/">
+   <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>
+   <imageId>ami-4fa54026</imageId>
+</CreateImageResponse>

data/spec/support/stubs/CreateLaunchConfiguration.200.xml

@@ -0,0 +1,5 @@
+<CreateLaunchConfigurationResponse xmlns="http://autoscaling.amazonaws.com/doc/2011-01-01/">
+<ResponseMetadata>
+   <RequestId>7c6e177f-f082-11e1-ac58-3714bEXAMPLE</RequestId>
+</ResponseMetadata>
+</CreateLaunchConfigurationResponse>

data/spec/support/stubs/CreateLaunchTemplateVersion.200.xml

@@ -0,0 +1,16 @@
+<CreateLaunchTemplateVersionResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
+    <requestId>6657423a-2616-461a-9ce5-3c65example</requestId>
+    <launchTemplateVersion>
+        <createTime>2017-10-31T11:56:00.000Z</createTime>
+        <createdBy>arn:aws:iam::123456789012:root</createdBy>
+        <defaultVersion>false</defaultVersion>
+        <launchTemplateData>
+            <imageId>ami-aabbccdd</imageId>
+            <instanceType>t2.micro</instanceType>
+        </launchTemplateData>
+        <launchTemplateId>lt-1234567890</launchTemplateId>
+        <launchTemplateName>elbas-test</launchTemplateName>
+        <versionDescription>VersionWithNewAMI</versionDescription>
+        <versionNumber>123</versionNumber>
+    </launchTemplateVersion>
+</CreateLaunchTemplateVersionResponse>

data/spec/support/stubs/CreateTags.200.xml

@@ -0,0 +1,5 @@
+<CreateTagsResponse
+xmlns="http://ec2.amazonaws.com/doc/2014-10-01/">
+  <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>
+  <return>true</return>
+</CreateTagsResponse>

data/spec/support/stubs/DeleteLaunchConfiguration.200.xml

@@ -0,0 +1,5 @@
+<DeleteLaunchConfigurationResponse xmlns="http://autoscaling.amazonaws.com/doc/2011-01-01/">
+  <ResponseMetadata>
+    <RequestId>7347261f-97df-11e2-8756-35eEXAMPLE</RequestId>
+  </ResponseMetadata>
+</DeleteLaunchConfigurationResponse>

data/spec/support/stubs/DeleteSnapshot.200.xml

@@ -0,0 +1,4 @@
+<DeleteSnapshotResponse xmlns="http://ec2.amazonaws.com/doc/2016-09-15/">
+  <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>
+  <return>true</return>
+</DeleteSnapshotResponse>

data/spec/support/stubs/DeregisterImage.200.xml

@@ -0,0 +1,4 @@
+<DeregisterImageResponse xmlns="http://ec2.amazonaws.com/doc/2014-10-01/">
+  <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>
+  <return>true</return>
+</DeregisterImageResponse>

data/spec/support/stubs/DescribeAutoScalingGroups.200.xml

@@ -0,0 +1,60 @@
+<DescribeAutoScalingGroupsResponse xmlns="http://autoscaling.amazonaws.com/doc/2011-01-01/">
+  <DescribeAutoScalingGroupsResult>
+    <AutoScalingGroups>
+      <member>
+        <HealthCheckType>ELB</HealthCheckType>
+        <LoadBalancerNames>
+          <member>my-loadbalancer</member>
+        </LoadBalancerNames>
+        <Instances>
+          <member>
+            <LaunchConfigurationName>my-lc</LaunchConfigurationName>
+            <LifecycleState>InService</LifecycleState>
+            <InstanceId>i-1234567890</InstanceId>
+            <ProtectedFromScaleIn>false</ProtectedFromScaleIn>
+            <AvailabilityZone>us-east-1c</AvailabilityZone>
+          </member>
+          <member>
+            <LaunchConfigurationName>my-lc</LaunchConfigurationName>
+            <LifecycleState>Terminating</LifecycleState>
+            <InstanceId>i-500</InstanceId>
+            <ProtectedFromScaleIn>false</ProtectedFromScaleIn>
+            <AvailabilityZone>us-east-1c</AvailabilityZone>
+          </member>
+        </Instances>
+        <TerminationPolicies>
+          <member>Default</member>
+        </TerminationPolicies>
+        <DefaultCooldown>300</DefaultCooldown>
+        <AutoScalingGroupARN>arn:aws:autoscaling:us-east-1:123456789012:autoScalingGroup:12345678-1234-1234-1234-123456789012:autoScalingGroupName/test-asg</AutoScalingGroupARN>
+        <EnabledMetrics />
+        <AvailabilityZones>
+          <member>us-east-1b</member>
+          <member>us-east-1a</member>
+        </AvailabilityZones>
+        <Tags>
+          <member>
+            <ResourceId>test-asg</ResourceId>
+            <PropagateAtLaunch>true</PropagateAtLaunch>
+            <Value>test</Value>
+            <Key>environment</Key>
+            <ResourceType>auto-scaling-group</ResourceType>
+          </member>
+        </Tags>
+        <LaunchConfigurationName>my-lc</LaunchConfigurationName>
+        <AutoScalingGroupName>test-asg</AutoScalingGroupName>
+        <HealthCheckGracePeriod>300</HealthCheckGracePeriod>
+        <NewInstancesProtectedFromScaleIn>false</NewInstancesProtectedFromScaleIn>
+        <SuspendedProcesses />
+        <CreatedTime>2015-05-06T17:47:15.107Z</CreatedTime>
+        <MinSize>2</MinSize>
+        <MaxSize>10</MaxSize>
+        <DesiredCapacity>2</DesiredCapacity>
+        <VPCZoneIdentifier>subnet-12345678,subnet-98765432</VPCZoneIdentifier>
+      </member>
+    </AutoScalingGroups>
+  </DescribeAutoScalingGroupsResult>
+  <ResponseMetadata>
+    <RequestId>7c6e177f-f082-11e1-ac58-3714bEXAMPLE</RequestId>
+  </ResponseMetadata>
+</DescribeAutoScalingGroupsResponse>