ec2ssh 3.1.0.rc1 → 5.0.0

data/lib/ec2ssh/cli.rb

@@ -2,16 +2,15 @@ require 'thor'
 require 'highline'
 require 'ec2ssh/ssh_config'
 require 'ec2ssh/exceptions'
-require 'ec2ssh/migrator'
 
 module Ec2ssh
   class CLI < Thor
+    class_option :path, banner: "/path/to/ssh_config"
     class_option :dotfile, banner: '$HOME/.ec2ssh', default: "#{ENV['HOME']}/.ec2ssh"
-    class_option :verbose, banner: 'enable debug log', default: false
+    class_option :verbose, banner: 'enable debug log', type: 'boolean'
 
     desc 'init', 'Add ec2ssh mark to ssh_config'
     def init
-      check_dotfile_version
       command = make_command :init
       command.run
     rescue MarkAlreadyExists
@@ -21,7 +20,6 @@ module Ec2ssh
     desc 'update', 'Update ec2 hosts list in ssh_config'
     def update
       check_dotfile_existence
-      check_dotfile_version
       set_aws_logging
       command = make_command :update
       command.run
@@ -36,7 +34,6 @@ module Ec2ssh
     desc 'remove', 'Remove ec2ssh mark from ssh_config'
     def remove
       check_dotfile_existence
-      check_dotfile_version
       command = make_command :remove
       command.run
       green "Removed mark from #{command.ssh_config_path}"
@@ -44,12 +41,6 @@ module Ec2ssh
       red "Marker not found in #{command.ssh_config_path}"
     end
 
-    desc 'migrate', 'Migrate dotfile from old versions'
-    def migrate
-      command = make_command :migrate
-      command.run
-    end
-
     desc 'shellcomp [-]', 'Initialize shell completion for bash/zsh'
     def shellcomp(_ = false)
       if args.include?("-")
@@ -89,16 +80,6 @@ EOS
     end
 
     no_tasks do
-      def check_dotfile_version
-        return unless File.exist?(options.dotfile)
-        migrator = Migrator.new options.dotfile
-        if migrator.check_version < '3'
-          red "#{options.dotfile} is old style."
-          red "Try '#{$0} migrate' to migrate to version 3"
-          abort
-        end
-      end
-
       def check_dotfile_existence
         unless File.exist?(options.dotfile)
           red "#{options.dotfile} doesn't exist."
@@ -116,10 +97,10 @@ EOS
       def set_aws_logging
         if options.verbose
           require 'logger'
-          require 'aws-sdk'
+          require 'aws-sdk-core'
           logger = ::Logger.new($stdout)
           logger.level = ::Logger::DEBUG
-          ::AWS.config logger: logger
+          ::Aws.config.update logger: logger
         end
       end
 

data/lib/ec2ssh/command.rb

@@ -14,7 +14,7 @@ module Ec2ssh
       end
 
       def ssh_config_path
-        cli.options.path || dotfile.path || "#{$ENV['HOME']}/.ssh/config"
+        cli.options.path || dotfile.path || "#{ENV['HOME']}/.ssh/config"
       end
 
       def dotfile_path

data/lib/ec2ssh/command/init.rb

@@ -33,13 +33,7 @@ module Ec2ssh
       def write_dotfile_example
         example = <<-DOTFILE
 path '#{ENV['HOME']}/.ssh/config'
-aws_keys(
-  default: {
-    access_key_id: ENV['AWS_ACCESS_KEY_ID'],
-    secret_access_key: ENV['AWS_SECRET_ACCESS_KEY']
-  },
-  # my_key1: { access_key_id: '...', secret_access_key: '...' }, ...
-)
+profiles 'default', 'myprofile'
 regions ENV['AWS_REGION'] || ENV['AMAZON_REGION'] || ENV['AWS_DEFAULT_REGION'] || 'us-east-1'
 # Enable regions as you like
 # regions *%w(ap-northeast-1 ap-southeast-1 ap-southeast-2 eu-west-1 sa-east-1 us-east-1 us-west-1 us-west-2)
@@ -47,8 +41,8 @@ regions ENV['AWS_REGION'] || ENV['AMAZON_REGION'] || ENV['AWS_DEFAULT_REGION'] |
 # You can use methods of AWS::EC2::Instance.
 # See http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/EC2/Instance.html
 host_line <<END
-Host <%= tags['Name'] %>.<%= availability_zone %>
-  HostName <%= dns_name || private_ip_address %>
+Host <%= tag('Name') %>.<%= placement.availability_zone %>
+  HostName <%= public_dns_name || private_ip_address %>
 END
         DOTFILE
 

data/lib/ec2ssh/command/update.rb

@@ -3,7 +3,6 @@ require 'ec2ssh/command'
 require 'ec2ssh/ssh_config'
 require 'ec2ssh/builder'
 require 'ec2ssh/dsl'
-require 'ec2ssh/migrator'
 
 module Ec2ssh
   module Command
@@ -30,10 +29,6 @@ module Ec2ssh
       def dsl
         @dsl ||= Ec2ssh::Dsl::Parser.parse File.read(dotfile_path)
       end
-
-      def migrator
-        @migrator ||= Migrator.new dotfile_path
-      end
     end
   end
 end

data/lib/ec2ssh/dsl.rb

@@ -1,14 +1,24 @@
 require 'ec2ssh/exceptions'
+require 'aws-sdk-core'
 
 module Ec2ssh
   class Dsl
     attr_reader :_result
 
+    CREDENTIAL_CLASSES = [Aws::Credentials, Aws::SharedCredentials, Aws::InstanceProfileCredentials, Aws::AssumeRoleCredentials].freeze
+    private_constant :CREDENTIAL_CLASSES
+
     def initialize
       @_result = Container.new
     end
 
     def aws_keys(keys)
+      unless keys.all? {|_, v| v.is_a?(Hash) && v.each_value.all? {|c| CREDENTIAL_CLASSES.any?(&c.method(:is_a?)) } }
+        raise DotfileValidationError, <<-MSG
+Since v4.0, `aws_keys` in the dotfile must be specified regions as a hash key.
+See: https://github.com/mirakui/ec2ssh#how-to-upgrade-from-3x
+        MSG
+      end
       @_result.aws_keys = keys
     end
 
@@ -28,6 +38,10 @@ module Ec2ssh
       @_result.reject = block
     end
 
+    def filters(filters)
+      @_result.filters = filters
+    end
+
     def path(str)
       @_result.path = str
     end
@@ -38,6 +52,7 @@ module Ec2ssh
       regions
       host_line
       reject
+      filters
       path
     ])
     end

data/lib/ec2ssh/ec2_instances.rb

@@ -1,22 +1,75 @@
-require 'aws-sdk-v1'
+require 'aws-sdk-core'
+require 'aws-sdk-ec2'
+require 'ec2ssh/exceptions'
 
 module Ec2ssh
   class Ec2Instances
     attr_reader :ec2s, :aws_keys
 
-    def initialize(aws_keys, regions)
+    class InstanceWrapper
+      class TagsWrapper
+        def initialize(tags)
+          @tags = tags
+        end
+
+        # simulate
+        def [](key)
+          if key.is_a? ::String
+            raise DotfileValidationError, <<-MSG
+`tags[String]` syntax in the dotfile has been deleted since v4.0. Use `tag(String)` instead.
+See: https://github.com/mirakui/ec2ssh#how-to-upgrade-from-3x
+            MSG
+          end
+          super
+        end
+
+        private
+
+        def method_missing(name, *args, &block)
+          @tags.public_send(name, *args, &block)
+        end
+
+        def respond_to_missing?(symbol, include_private)
+          @tags.respond_to?(symbol, include_private)
+        end
+      end
+
+      def initialize(ec2_instance)
+        @ec2_instance = ec2_instance
+        @_tags ||= @ec2_instance.tags.each_with_object({}) {|t, h| h[t.key] = t.value }
+      end
+
+      def tag(key)
+        @_tags[key]
+      end
+
+      def tags
+        TagsWrapper.new(super)
+      end
+
+      private
+
+      def method_missing(name, *args, &block)
+        @ec2_instance.public_send(name, *args, &block)
+      end
+
+      def respond_to_missing?(symbol, include_private)
+        @ec2_instance.respond_to?(symbol, include_private)
+      end
+    end
+
+    def initialize(aws_keys, filters)
       @aws_keys = aws_keys
-      @regions = regions
+      @filters = filters
     end
 
     def make_ec2s
-      AWS.start_memoizing
       _ec2s = {}
-      aws_keys.each do |name, key|
+      aws_keys.each_pair do |name, keys|
         _ec2s[name] = {}
-        @regions.each do |region|
-          options = key.merge ec2_region: region
-          _ec2s[name][region] = AWS::EC2.new options
+        keys.each_pair do |region, key|
+          client = Aws::EC2::Client.new region: region, credentials: key
+          _ec2s[name][region] = Aws::EC2::Resource.new client: client
         end
       end
       _ec2s
@@ -27,17 +80,18 @@ module Ec2ssh
     end
 
     def instances(key_name)
-      @regions.map {|region|
-        ec2s[key_name][region].instances.
-          filter('instance-state-name', 'running').
-          to_a.
-          sort_by {|ins| ins.tags['Name'].to_s }
+      aws_keys[key_name].each_key.map {|region|
+        ec2s[key_name][region].instances(
+          filters: @filters
+        ).
+        map {|ins| InstanceWrapper.new(ins) }.
+        sort_by {|ins| ins.tag('Name').to_s }
       }.flatten
     end
 
-    def self.expand_profile_name_to_credential(profile_name)
-      provider = AWS::Core::CredentialProviders::SharedCredentialFileProvider.new(profile_name: profile_name)
-      provider.credentials
+    def self.expand_profile_name_to_credential(profile_name, region)
+      client = Aws::STS::Client.new(profile: profile_name, region: region)
+      client.config.credentials
     end
   end
 end

data/lib/ec2ssh/version.rb

@@ -1,3 +1,3 @@
 module Ec2ssh
-  VERSION = '3.1.0.rc1'
+  VERSION = '5.0.0'
 end

data/spec/aws_sdk_compatibility_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+require 'ec2ssh/ec2_instances'
+
+describe 'aws-sdk compatibility' do
+  let(:region) { 'us-west-1' }
+  let(:root_device) { '/dev/xvda' }
+
+  let!(:ec2_instances) do
+    VCR.use_cassette('ec2-instances') do
+      Ec2ssh::Ec2Instances.new(
+        {'foo' => {'us-west-1' => Aws::Credentials.new('access_key_id', 'secret_access_key')}},
+        [{ name: 'instance-state-name', values: ['running'] }]
+      ).instances('foo')
+    end
+  end
+
+  let(:ins) { ec2_instances.first }
+
+  it { expect(ec2_instances.count).to be == 1 }
+
+  it { expect(ins.tag('Name')).to match /.+/ }
+  it { expect(ins.tag('Role')).to match /.+/ }
+  it { expect(ins.tags).to match_array([have_attributes(key: 'Name', value: /.+/), have_attributes(key: 'Role', value: /.+/)]) }
+  it { expect(ins.ami_launch_index).to be == 0 }
+  it { expect(ins.architecture).to be == 'x86_64' }
+  it do
+    expect(ins.block_device_mappings).to match [
+      have_attributes(
+      device_name: root_device,
+      ebs: have_attributes(
+        volume_id: /\Avol-\w+\z/,
+        status: 'attached',
+        attach_time: an_instance_of(Time),
+        delete_on_termination: true
+      )
+    )]
+  end
+  # it { expect(ins.capacity_reservation_id).to be_nil}
+  # it { expect(ins.capacity_reservation_specification).to be_nil }
+  it { expect(ins.classic_address).to be_a(Aws::EC2::ClassicAddress) }
+  it { expect(ins.client).to be_a(Aws::EC2::Client) }
+  it { expect(ins.client_token).to match /\A\w{18}\z/ }
+  # it { expect(ins.cpu_options).to be_nil }
+  it { expect(ins.ebs_optimized).to be_falsy }
+  it { expect(ins.elastic_gpu_associations).to be_nil }
+  # it { expect(ins.elastic_inference_accelerator_associations).to be_nil }
+  it { expect(ins.ena_support).to be_falsy }
+  # it { expect(ins.hibernation_options).to be_nil}
+  it { expect(ins.hypervisor).to be == 'xen' }
+  it { expect(ins.iam_instance_profile).to have_attributes(arn: /\Aarn:aws:iam::\d+:instance-profile\/[\w\-]+\z/, id: /\A\w{21}\z/) }
+  it { expect(ins.id).to match /\Ai-\w+\z/ }
+  it { expect(ins.image).to be_a(Aws::EC2::Image) }
+  it { expect(ins.image_id).to match /\Aami-\w+\z/ }
+  it { expect(ins.instance_id).to match /\Ai-\w+\z/ }
+  it { expect(ins.instance_lifecycle).to be_nil }
+  it { expect(ins.instance_type).to match /\A[trmci][1248]\.\w+\z/ }
+  it { expect(ins.kernel_id).to be_nil }
+  it { expect(ins.key_name).to match /\A.+\.pem\z/ }
+  it { expect(ins.key_pair).to be_a(Aws::EC2::KeyPairInfo) }
+  it { expect(ins.launch_time).to be_a(Time) }
+  # it { expect(ins.licenses).to all have_attributes(license_configuration_arn: '') }
+  it { expect(ins.monitoring).to have_attributes(state: 'disabled') }
+  it { expect(ins.network_interfaces).to all match(an_instance_of(Aws::EC2::NetworkInterface)) }
+  it { expect(ins.placement).to have_attributes(availability_zone: /\A#{region}[a-c]\z/, group_name: '', tenancy: 'default') }
+  it { expect(ins.placement_group).to be_a(Aws::EC2::PlacementGroup) }
+  it { expect(ins.platform).to be_nil }
+  it { expect(ins.private_dns_name).to match /\Aip-[\w\-]+\.#{region}\.compute\.internal\z/ }
+  it { expect(ins.private_ip_address).to match /\A[\d\.]+\z/ }
+  it { expect(ins.product_codes).to be == [] }
+  it { expect(ins.public_dns_name).to match /\Aec2-[\w\-]+\.#{region}\.compute\.amazonaws\.com\z/ }
+  it { expect(ins.public_ip_address).to match /\A[\d\.]+\z/ }
+  it { expect(ins.ramdisk_id).to be_nil }
+  it { expect(ins.root_device_name).to eq root_device }
+  it { expect(ins.root_device_type).to be == 'ebs' }
+  it do
+    expect(ins.security_groups).to all have_attributes(
+      group_id: /\Asg-\w+\z/,
+      group_name: /\A.+\z/
+    )
+  end
+  it { expect(ins.source_dest_check).to be true }
+  it { expect(ins.spot_instance_request_id).to be_nil }
+  it { expect(ins.sriov_net_support).to be_nil }
+  it { expect(ins.state).to have_attributes(code: 16, name: 'running') }
+  it { expect(ins.state_reason).to be_nil }
+  it { expect(ins.state_transition_reason).to be == '' }
+  it { expect(ins.subnet).to be_a(Aws::EC2::Subnet) }
+  it { expect(ins.subnet_id).to match /\Asubnet-\w+\z/ }
+  it { expect(ins.virtualization_type).to be == 'hvm' }
+  it { expect(ins.vpc).to be_a(Aws::EC2::Vpc) }
+  it { expect(ins.vpc_id).to match /\Avpc-\w+\z/ }
+end

data/spec/lib/ec2ssh/builder_spec.rb

@@ -7,10 +7,10 @@ describe Ec2ssh::Builder do
     let(:container) do
       Ec2ssh::Dsl::Container.new.tap do |c|
         c.aws_keys = {
-          key1: { access_key_id: 'KEY1', secret_access_key: 'SEC1' },
-          key2: { access_key_id: 'KEY2', secret_access_key: 'SEC2' }
+          'key1' => { 'us-west-1' => Aws::Credentials.new('KEY1', 'SEC1') },
+          'key2' => { 'us-west-1' => Aws::Credentials.new('KEY2', 'SEC2') }
         }
-        c.host_line = "Host <%= tags['Name'] %>"
+        c.host_line = "Host <%= tag('Name') %>"
       end
     end
 
@@ -28,12 +28,14 @@ describe Ec2ssh::Builder do
 
     let(:instances) do
       {
-        key1: [
-          double('instance', tags: {'Name' => 'srv1'}),
-          double('instance', tags: {'Name' => 'srv2'})],
-        key2: [
-          double('instance', tags: {'Name' => 'srv3'}),
-          double('instance', tags: {'Name' => 'srv4'})]
+        'key1' => [
+          double('instance').tap {|m| allow(m).to receive(:tag).with('Name').and_return('srv1') },
+          double('instance').tap {|m| allow(m).to receive(:tag).with('Name').and_return('srv2') }
+        ],
+        'key2' => [
+          double('instance').tap {|m| allow(m).to receive(:tag).with('Name').and_return('srv3') },
+          double('instance').tap {|m| allow(m).to receive(:tag).with('Name').and_return('srv4') }
+        ]
       }
     end
 
@@ -50,7 +52,7 @@ Host srv4
 
     context 'with #reject' do
       before do
-        container.reject = lambda {|ins| ins.tags['Name'] == 'srv1' }
+        container.reject = lambda {|ins| ins.tag('Name') == 'srv1' }
       end
 
       it do
@@ -67,10 +69,10 @@ Host srv4
     context 'checking erb trim_mode' do
       before do
         container.host_line = <<-END
-% if tags['Name']
-  <%- if tags['Name'] == 'srv3' -%>
-Host <%= tags['Name'] %>
-  HostName <%= tags['Name'] %>
+% if tag('Name')
+  <%- if tag('Name') == 'srv3' -%>
+Host <%= tag('Name') %>
+  HostName <%= tag('Name') %>
   <%- end -%>
 % end
         END

data/spec/lib/ec2ssh/command/remove_spec.rb

@@ -2,6 +2,8 @@ require 'spec_helper'
 require 'ec2ssh/command/remove'
 
 describe Ec2ssh::Command::Remove do
+  include FakeFS::SpecHelpers
+
   describe '#run' do
     let(:command) do
       described_class.new(cli).tap do |cmd|
@@ -17,11 +19,10 @@ describe Ec2ssh::Command::Remove do
 
     let(:dotfile_str) { <<-END }
 path '/dotfile'
-aws_keys(
-  default: { access_key_id: 'ACCESS_KEY1', secret_access_key: 'SECRET1' }
-)
+profiles 'default'
+regions 'us-west-1'
 host_line <<EOS
-Host <%= tags['Name'] %>
+Host <%= tag('Name') %>
   HostName <%= private_ip_address %>
 EOS
     END