ec2ssh 3.1.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82094a4ffb0cc7177a3174c0eb775bb77806541076133d515af86172ecb83bf6
-  data.tar.gz: 575e64da09628b5469c974133d2fcde4508498ca07c1a5bc9e55921e4fb9b5ee
+  metadata.gz: c3ea6bd5f9d58e822861e9bcdb35c18df8da80bbc3273a8645483bac6d1d53cf
+  data.tar.gz: d5326d28bfbc630696d42c692dc90e3eae03a0240bece33f6893ac0584f3763d
 SHA512:
-  metadata.gz: d14febefd3c85a7b3288fc60bf2836b303d3e5b89874c26bed96b4626c78f37fb1ebde3cd0b68f1f335e7330bb963295bef2174e6a1c3efbd44ef4f0cac26b27
-  data.tar.gz: 1f001fef1061f9e3ce41abea0984a7f36662699ad7290d945701bfd769c056cbd902661e405698673e5d876cb055cfb5535c4d0dee3cae3510fada99ef12d403
+  metadata.gz: d22a8bcdc6c4317c09d2b36aee3aaf0a06b5f7412f7e318f40579fb5d6bdeaa3f24d10eaea0a294e253c31ee1e23f2719c5f66bdf20dc46da8931addf471f69c
+  data.tar.gz: 53d4f48c7a7a3dbbbd48d0f0382dfe0715c7af1750b978b9e14183d16adc4bbfaff8872ab65ed2c5ced36debe570682f34c94cb8824735fa800a29ac349f2cea

data/ChangeLog.md

@@ -1,4 +1,12 @@
 # Change Log
+## 4.0.0
+* Use aws-sdk v2 and stop using v1 (#44)
+* Support AssumeRole with `~/.aws/credentials` (#44)
+* `aws_keys` requires region (#44)
+  Thanks to @yujideveloper
+* Support `filters` for listing ec2 instances (#43)
+  Thanks to @satotakumi
+
 ## 3.1.1
 * Fix a bug in `--verbose` option (#41)
   Thanks to @adamlazz

data/README.md

@@ -41,17 +41,22 @@ $ ec2ssh init
 ```
 $ vi ~/.ec2ssh
 ---
-profiles 'default', 'myprofile'
-regions 'us-east-1'
+profiles 'default', 'myprofile', ...
+regions 'us-east-1', 'ap-northeast-1', ...
 
 # Ignore unnamed instances
-reject {|instance| !instance.tags['Name'] }
+reject {|instance| !instance.tag('Name') }
 
-# You can use methods of AWS::EC2::Instance.
-# See http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/EC2/Instance.html
+# You can specify filters on DescribeInstances (default: lists 'running' instances only)
+filters([
+  { name: 'instance-state-name', values: ['running', 'stopped'] }
+])
+
+# You can use methods of AWS::EC2::Instance and tag(key) method.
+# See https://docs.aws.amazon.com/sdkforruby/api/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
 ```
 
@@ -115,26 +120,23 @@ Host db-server-1.ap-southeast-1
 
 `ec2ssh remove` command removes the mark lines.
 
-# How to upgrade from 1.x to 2.x
-If you have used ec2ssh-1.x, it seems that you may not have '~/.ec2ssh'.
-So you need execute `ec2ssh init` once to create `~/.ec2ssh`, and edit it as you like.
-
-```
-$ ec2ssh init
-$ vi ~/.ec2ssh
-```
-
-# How to upgrade from 2.x to 3.x
-Dotfile (`.ec2ssh`) format has been changed from YAML to Ruby DSL.
+# How to upgrade from 3.x
+Dotfile (`.ec2ssh`) format has been changed from 3.x.
 
-Don't panic and run `ec2ssh migrate` if you have ec2ssh-2.x styled dotfile.
+* A instance tag access I/F has been changed from `tags['Name']` to `tag('Name')`
+* `Aws::EC2::Instance` methods have been changed to AWS SDK v2
+* The `aws_keys` structure have benn changed
+  * `aws_keys[profile_name][region] # => Aws::Credentials`
+  * For example:
 
 ```
-$ ec2ssh migrate
+aws_keys(
+  my_prof1: {
+    'ap-northeast-1' => Aws::Credentials.new(ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'])
+  }
+)
 ```
 
-This command converts your existing `.ec2ssh` file into 3.x style.
-
 # Notice
 `ec2ssh` command updates your `.ssh/config` file default. You should make a backup of it.
 
@@ -142,4 +144,4 @@ This command converts your existing `.ec2ssh` file into 3.x style.
 Use `zsh/_ec2ssh`.
 
 # License
-Copyright (c) 2014 Issei Naruta. ec2ssh is released under the MIT license.
+Copyright (c) 2019 Issei Naruta. ec2ssh is released under the MIT license.

data/bash/ec2ssh.bash

@@ -6,7 +6,7 @@ _ec2ssh() {
     cur=$2
     prev=$3
 
-    subcmds="help init migrate remove update version"
+    subcmds="help init remove update version"
     common_opts="--dotfile --verbose"
 
     # contextual completion
@@ -50,4 +50,4 @@ _ec2ssh() {
 
 }
 
-complete -F _ec2ssh ec2ssh
+complete -F _ec2ssh ec2ssh

data/ec2ssh.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.rubyforge_project = "ec2ssh"
   s.add_dependency "thor", "~> 0.14"
   s.add_dependency "highline", "~> 1.6"
-  s.add_dependency 'aws-sdk', '~> 1.8'
+  s.add_dependency "aws-sdk", "~> 2"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/example/example.ec2ssh

@@ -1,9 +1,9 @@
 path "#{ENV['HOME']}/.ssh/config"
 profiles 'default', 'myprofile'
 regions 'ap-northeast-1', 'us-east-1'
-reject {|instance| instance.tags['Name'] =~ /.../ }
+reject {|instance| instance.tag('Name') =~ /.../ }
 
 host_line <<END
-Host <%= tags['Name'] %>
+Host <%= tag('Name') %>
   HostName <%= private_ip_address %>
 END

data/lib/ec2ssh/builder.rb

@@ -26,19 +26,29 @@ module Ec2ssh
     end
 
     def ec2s
-      @ec2s ||= Ec2Instances.new aws_keys, @container.regions
+      @ec2s ||= Ec2Instances.new aws_keys, filters
     end
 
     def aws_keys
       @aws_keys ||= if @container.profiles
                       keys = {}
                       @container.profiles.each do |profile_name|
-                        keys[profile_name] = Ec2Instances.expand_profile_name_to_credential profile_name
+                        keys[profile_name] = {}
+                        @container.regions.each do |region|
+                          keys[profile_name][region] = Ec2Instances.expand_profile_name_to_credential profile_name, region
+                        end
                       end
                       keys
                     else
                       @container.aws_keys
                     end
     end
+
+    def filters
+      @filters = @container.filters || [{
+        name: 'instance-state-name',
+        values: ['running']
+      }]
+    end
   end
 end

data/lib/ec2ssh/cli.rb

@@ -2,7 +2,6 @@ require 'thor'
 require 'highline'
 require 'ec2ssh/ssh_config'
 require 'ec2ssh/exceptions'
-require 'ec2ssh/migrator'
 
 module Ec2ssh
   class CLI < Thor
@@ -12,7 +11,6 @@ module Ec2ssh
 
     desc 'init', 'Add ec2ssh mark to ssh_config'
     def init
-      check_dotfile_version
       command = make_command :init
       command.run
     rescue MarkAlreadyExists
@@ -22,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
@@ -37,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}"
@@ -45,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?("-")
@@ -90,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."
@@ -120,7 +100,7 @@ EOS
           require 'aws-sdk'
           logger = ::Logger.new($stdout)
           logger.level = ::Logger::DEBUG
-          ::AWS.config logger: logger
+          ::Aws.config.update logger: logger
         end
       end
 

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'
 
 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,73 @@
-require 'aws-sdk-v1'
+require 'aws-sdk'
 
 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 +78,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.1'
+  VERSION = '4.0.0'
 end

data/spec/aws_sdk_compatibility_spec.rb

@@ -8,8 +8,8 @@ describe 'aws-sdk compatibility' do
   let!(:ec2_instances) do
     VCR.use_cassette('ec2-instances') do
       Ec2ssh::Ec2Instances.new(
-        {'foo' => {access_key_id: '', secret_access_key: ''}},
-        ['us-west-1']
+        {'foo' => {'us-west-1' => Aws::Credentials.new('access_key_id', 'secret_access_key')}},
+        [{ name: 'instance-state-name', values: ['running'] }]
       ).instances('foo')
     end
   end
@@ -18,54 +18,52 @@ describe 'aws-sdk compatibility' do
 
   it { expect(ec2_instances.count).to be == 1 }
 
-  it { expect(ins.tags['Name']).to match /.+/ }
-  it { expect(ins.tags['Role']).to match /.+/ }
+  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 { expect(ins.attachments.to_h).to match( root_device => an_instance_of(AWS::EC2::Attachment) ) }
-  it { expect(ins.availability_zone).to match /\A#{region}[a-c]\z/ }
-  it { expect(ins.block_device_mappings.to_h).to match( root_device => an_instance_of(AWS::EC2::Attachment) ) }
+  it { expect(ins.architecture).to be == 'x86_64' }
   it do
-    expect(ins.block_devices.to_a).to match [{
+    expect(ins.block_device_mappings).to match [
+      have_attributes(
       device_name: root_device,
-      ebs: {
+      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.dedicated_tenancy?).to be_falsy }
-  it { expect(ins.dns_name).to match /\Aec2-[\d\.\-]+\.#{region}\.compute\.amazonaws\.com\z/ }
+  # it { expect(ins.cpu_options).to be_nil }
   it { expect(ins.ebs_optimized).to be_falsy }
-  it do
-    expect(ins.group_set.to_a).to all match(
-      group_id: /\Asg-\w+\z/,
-      group_name: /\A.+\z/,
-    )
-  end
-  it { expect(ins.groups.to_a).to all match(AWS::EC2::SecurityGroup) }
-  it { expect(ins.hypervisor).to be == :xen }
-  it { expect(ins.iam_instance_profile_arn).to match /\Aarn:aws:iam::\d+:instance-profile\/[\w\-]+\z/ }
-  it { expect(ins.iam_instance_profile_id).to match /\A\w{21}\z/ }
+  # 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.identifiers).to match(id: /\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.ip_address).to match /\A[\d\.]+\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::KeyPair) }
+  # it { expect(ins.key_pair).to be_a(Aws::EC2::KeyPairInfo) }
   it { expect(ins.launch_time).to be_a(Time) }
-  it { expect(ins.monitoring).to be == :disabled }
-  it { expect(ins.monitoring_enabled?).to be_falsy }
-  it { expect(ins.network_interfaces.to_a).to all match(an_instance_of(AWS::EC2::NetworkInterface)) }
-  # it { expect(ins.owner_id).to match /\A\d{12}\z/ }
-  it { expect(ins.placement.to_h).to match( availability_zone: /\A#{region}[a-c]\z/, group_name: nil, tenancy: 'default' ) }
+  # 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/ }
@@ -73,19 +71,23 @@ describe 'aws-sdk compatibility' do
   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.requester_id).to be_nil }
-  # it { expect(ins.reservation_id).to match /\Ar-\w+\z/ }
   it { expect(ins.root_device_name).to eq root_device }
-  it { expect(ins.root_device_type).to be == :ebs }
-  it { expect(ins.security_groups.to_a).to all match(an_instance_of(AWS::EC2::SecurityGroup)) }
-  it { expect(ins.spot_instance?).to be_falsy }
-  it { expect(ins.state_transition_reason).to be_nil }
-  it { expect(ins.status).to be == :running }
-  it { expect(ins.status_code).to be == 16 }
-  it { expect(ins.subnet).to be_a(AWS::EC2::Subnet) }
+  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?).to be_truthy }
+  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

@@ -19,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

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

@@ -9,6 +9,7 @@ describe Ec2ssh::Command::Update do
     let(:command) do
       described_class.new(cli).tap do |cmd|
         allow(cmd).to receive(:options).and_return(options)
+        allow(cmd.builder).to receive(:aws_keys) { aws_keys }
         allow(cmd.builder.ec2s).to receive(:instances) { instances }
       end
     end
@@ -18,10 +19,13 @@ describe Ec2ssh::Command::Update do
     let(:cli) do
       double(:cli, options: options, red: nil, yellow: nil, green: nil)
     end
+    let(:aws_keys) do
+      {'default' => {'us-west-1' => Aws::Credentials.new('access_key_id', 'secret_access_key')}}
+    end
     let(:instances) do
       [
-        double('instance', tags: {'Name' => 'srv1'}, private_ip_address: '10.0.0.1'),
-        double('instance', tags: {'Name' => 'srv2'}, private_ip_address: '10.0.0.2')
+        double('instance', private_ip_address: '10.0.0.1').tap {|m| allow(m).to receive(:tag).with('Name').and_return('srv1') },
+        double('instance', private_ip_address: '10.0.0.2').tap {|m| allow(m).to receive(:tag).with('Name').and_return('srv2') }
       ]
     end
 
@@ -34,11 +38,10 @@ describe Ec2ssh::Command::Update do
       let(:ssh_config_str) { '' }
       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
@@ -60,11 +63,10 @@ EOS
 
       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

data/spec/lib/ec2ssh/dsl_spec.rb

@@ -27,10 +27,9 @@ END
     let(:dsl_str) do
 <<-END
 aws_keys(
-  key1: { access_key_id: 'ACCESS_KEY1', secret_access_key: 'SECRET1' },
-  key2: { access_key_id: 'ACCESS_KEY2', secret_access_key: 'SECRET2' }
+  'key1' => { 'ap-northeast-1' => Aws::Credentials.new('ACCESS_KEY1', 'SECRET1') },
+  'key2' => { 'us-east-1' => Aws::Credentials.new('ACCESS_KEY2', 'SECRET2') }
 )
-regions 'ap-northeast-1', 'us-east-1'
 host_line 'host lines'
 reject {|instance| instance }
 path 'path'
@@ -40,13 +39,12 @@ END
     subject(:result) { Ec2ssh::Dsl::Parser.parse dsl_str }
 
     its(:profiles) { should be_nil }
-    its(:aws_keys) do
-      should == {
-        key1: { access_key_id: 'ACCESS_KEY1', secret_access_key: 'SECRET1' },
-        key2: { access_key_id: 'ACCESS_KEY2', secret_access_key: 'SECRET2' }
-      }
+    it do
+      expect(result.aws_keys).to match(
+        'key1' => { 'ap-northeast-1' => be_a(Aws::Credentials).and(have_attributes(access_key_id: 'ACCESS_KEY1', secret_access_key: 'SECRET1')) } ,
+        'key2' => { 'us-east-1' => be_a(Aws::Credentials).and(have_attributes(access_key_id: 'ACCESS_KEY2', secret_access_key: 'SECRET2')) }
+      )
     end
-    its(:regions) { should == ['ap-northeast-1', 'us-east-1'] }
     its(:host_line) { should == 'host lines' }
     it { expect(result.reject.call(123)).to eq(123) }
     its(:path) { should == 'path' }
@@ -56,8 +54,8 @@ END
     let(:dsl_str) do
 <<-END
 aws_keys(
-  key1: { access_key_id: 'ACCESS_KEY1', secret_access_key: 'SECRET1' },
-  key2: { access_key_id: 'ACCESS_KEY2', secret_access_key: 'SECRET2' }
+  'key1' => { 'ap-northeast-1' => Aws::Credentials.new('ACCESS_KEY1', 'SECRET1') },
+  'key2' => { 'us-east-1' => Aws::Credentials.new('ACCESS_KEY2', 'SECRET2') }
 )
 profiles 'default', 'myprofile'
 regions 'ap-northeast-1', 'us-east-1'
@@ -71,4 +69,39 @@ END
       expect { Ec2ssh::Dsl::Parser.parse dsl_str }.to raise_error Ec2ssh::DotfileValidationError
     end
   end
+
+  context 'with old structure aws_keys' do
+    let(:dsl_str) do
+<<-END
+aws_keys(
+  key1: { access_key_id: 'ACCESS_KEY1', secret_access_key: 'SECRET1' },
+  key2: { access_key_id: 'ACCESS_KEY2', secret_access_key: 'SECRET2' }
+)
+regions 'ap-northeast-1', 'us-east-1'
+host_line 'host lines'
+reject {|instance| instance }
+path 'path'
+END
+    end
+
+    it { expect { Ec2ssh::Dsl::Parser.parse dsl_str }.to raise_error Ec2ssh::DotfileValidationError }
+  end
+
+  context 'with filters' do
+    let(:dsl_str) do
+<<-END
+regions 'ap-northeast-1', 'us-east-1'
+filters [{
+  name: 'instance-state-name',
+  values: ['running', 'stopped']
+}]
+END
+    end
+
+    subject(:result) { Ec2ssh::Dsl::Parser.parse dsl_str }
+
+    it do
+      expect(result.filters).to eq([{name:'instance-state-name', values:['running', 'stopped']}])
+    end
+  end
 end

data/spec/lib/ec2ssh/ec2_instances_spec.rb

@@ -12,9 +12,11 @@ describe Ec2ssh::Ec2Instances do
     }
 
     let(:mock) do
-      described_class.new(profiles='', regions=[region]).tap do |e|
+      described_class.new(
+        {key_name => {region => ''}},
+        [{ name: 'instance-state-name', values: ['running'] }]
+      ).tap do |e|
         allow(e).to receive(:ec2s) { ec2s }
-        allow(e).to receive(:regions) { [region] }
       end
     end
 
@@ -37,9 +39,9 @@ describe Ec2ssh::Ec2Instances do
     context 'with non-empty names' do
       let(:mock_instances) {
         [
-          double('instance', n: 1, tags: {'Name' => 'srvB' }),
-          double('instance', n: 2, tags: {'Name' => 'srvA' }),
-          double('instance', n: 3, tags: {'Name' => 'srvC' })
+          double('instance', n: 1, tags: [double('tag', key: 'Name', value: 'srvB')]),
+          double('instance', n: 2, tags: [double('tag', key: 'Name', value: 'srvA')]),
+          double('instance', n: 3, tags: [double('tag', key: 'Name', value: 'srvC')])
         ]
       }
 
@@ -52,9 +54,9 @@ describe Ec2ssh::Ec2Instances do
     context 'with names including empty one' do
       let(:mock_instances) {
         [
-          double('instance', n: 1, tags: {'Name' => 'srvA'}),
-          double('instance', n: 2, tags: {}),
-          double('instance', n: 3, tags: {'Name' => 'srvC' })
+          double('instance', n: 1, tags: [double('tag', key: 'Name', value: 'srvA')]),
+          double('instance', n: 2, tags: []),
+          double('instance', n: 3, tags: [double('tag', key: 'Name', value: 'srvC')])
         ]
       }
 
@@ -63,6 +65,22 @@ describe Ec2ssh::Ec2Instances do
         expect(result.map {|ins| ins.n}).to match_array([2, 1, 3])
       end
     end
+  end
+
+  describe Ec2ssh::Ec2Instances::InstanceWrapper do
+    let(:mock_instance) {
+      double('instance', n: 1, tags: [double('tag', key: 'Name', value: 'srvA')])
+    }
+    let(:instance) { described_class.new(mock_instance) }
 
+    describe '#tag' do
+      it { expect(instance.tag('Name')).to eq 'srvA' }
+    end
+
+    describe '#tags' do
+      it { expect(instance.tags).to match_array(have_attributes(key: 'Name', value: 'srvA')) }
+      it { expect(instance.tags[0]).to have_attributes(key: 'Name', value: 'srvA') }
+      it { expect { instance.tags['Name'] }.to raise_error Ec2ssh::DotfileValidationError }
+    end
   end
 end

data/zsh/_ec2ssh

@@ -7,12 +7,6 @@ _ec2ssh-init() {
     return $ret
 }
 
-_ec2ssh-migrate() {
-    local ret
-    _call_function ret __ec2ssh_noarg_cmd
-    return $ret
-}
-
 _ec2ssh-remove() {
     local ret
     _call_function ret __ec2ssh_noarg_cmd
@@ -80,7 +74,6 @@ _ec2ssh_commands() {
     _values 'command' \
         'help[Describe available commands or one specific command]' \
         'init[Add ec2ssh mark to ssh_config]' \
-        'migrate[Migrate dotfile from old versions]' \
         'remove[Remove ec2ssh mark from ssh_config]' \
         'update[Update ec2 hosts list in ssh_config]' \
         'version[Show version]'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ec2ssh
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 4.0.0
 platform: ruby
 authors:
 - Issei Naruta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-22 00:00:00.000000000 Z
+date: 2019-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2'
 description: ec2ssh is a ssh_config manager for AWS EC2
 email:
 - mimitako@gmail.com
@@ -79,24 +79,20 @@ files:
 - lib/ec2ssh/cli.rb
 - lib/ec2ssh/command.rb
 - lib/ec2ssh/command/init.rb
-- lib/ec2ssh/command/migrate.rb
 - lib/ec2ssh/command/remove.rb
 - lib/ec2ssh/command/update.rb
 - lib/ec2ssh/dsl.rb
 - lib/ec2ssh/ec2_instances.rb
 - lib/ec2ssh/exceptions.rb
-- lib/ec2ssh/migrator.rb
 - lib/ec2ssh/ssh_config.rb
 - lib/ec2ssh/version.rb
 - spec/aws_sdk_compatibility_spec.rb
 - spec/lib/ec2ssh/builder_spec.rb
 - spec/lib/ec2ssh/command/init_spec.rb
-- spec/lib/ec2ssh/command/migrate_spec.rb
 - spec/lib/ec2ssh/command/remove_spec.rb
 - spec/lib/ec2ssh/command/update_spec.rb
 - spec/lib/ec2ssh/dsl_spec.rb
 - spec/lib/ec2ssh/ec2_instances_spec.rb
-- spec/lib/ec2ssh/migrator_spec.rb
 - spec/lib/ec2ssh/ssh_config_spec.rb
 - spec/spec_helper.rb
 - zsh/_ec2ssh
@@ -118,8 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: ec2ssh
-rubygems_version: 2.7.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A ssh_config manager for AWS EC2
@@ -127,11 +122,9 @@ test_files:
 - spec/aws_sdk_compatibility_spec.rb
 - spec/lib/ec2ssh/builder_spec.rb
 - spec/lib/ec2ssh/command/init_spec.rb
-- spec/lib/ec2ssh/command/migrate_spec.rb
 - spec/lib/ec2ssh/command/remove_spec.rb
 - spec/lib/ec2ssh/command/update_spec.rb
 - spec/lib/ec2ssh/dsl_spec.rb
 - spec/lib/ec2ssh/ec2_instances_spec.rb
-- spec/lib/ec2ssh/migrator_spec.rb
 - spec/lib/ec2ssh/ssh_config_spec.rb
 - spec/spec_helper.rb

data/lib/ec2ssh/command/migrate.rb

@@ -1,34 +0,0 @@
-require 'ec2ssh/exceptions'
-require 'ec2ssh/command'
-require 'ec2ssh/migrator'
-
-module Ec2ssh
-  module Command
-    class Migrate < Base
-      def initialize(cli)
-        super
-      end
-
-      def run
-        migrator = Migrator.new dotfile_path
-        version = migrator.check_version
-        case version
-        when '2'
-          cli.red "Current dotfile version is #{version} (#{dotfile_path})"
-          new_dotfile_str = migrator.migrate_from_2
-          cli.red "Ec2ssh is migrating your dotfile to version 3 style as follows:"
-          cli.yellow new_dotfile_str
-          if cli.yes? "Are you sure to migrate #{dotfile_path} to version 3 style? (y/n)"
-            backup_path = migrator.backup!
-            puts "Creating backup as #{backup_path}"
-            migrator.replace! new_dotfile_str
-            cli.green 'Migrated successfully.'
-          end
-        when '3'
-          cli.green "Current dotfile version is #{version} (#{dotfile_path})"
-          cli.green 'Your dotfile is up-to-date.'
-        end
-      end
-    end
-  end
-end

data/lib/ec2ssh/migrator.rb

@@ -1,77 +0,0 @@
-require 'yaml'
-require 'stringio'
-require 'ec2ssh/dsl'
-
-module Ec2ssh
-  class Migrator
-    def initialize(dotfile_path)
-      @dotfile_path = dotfile_path
-    end
-
-    def dotfile_str
-      @dotfile_str ||= File.read(@dotfile_path)
-    end
-
-    def check_version
-      begin
-        hash = YAML.load dotfile_str
-        return '2' if hash.is_a?(Hash) && hash.keys.include?('aws_keys')
-      rescue Psych::SyntaxError
-      end
-
-      begin
-        Dsl::Parser.parse dotfile_str
-        return '3'
-      rescue DotfileSyntaxError
-      end
-
-      raise InvalidDotfile
-    end
-
-    def migrate_from_2
-      hash = YAML.load dotfile_str
-      out = StringIO.new
-
-      out.puts "path '#{hash['path']}'" if hash['path']
-
-      out.puts 'aws_keys('
-      out.puts hash['aws_keys'].map {|name, key|
-        "  #{name}: { access_key_id: '#{key['access_key_id']}', secret_access_key: '#{key['secret_access_key']}' }"
-      }.join(",\n")
-      out.puts ')'
-
-      if hash['regions']
-        regions = hash['regions'].map{|r| "'#{r}'" }.join(', ')
-        out.puts "regions #{regions}"
-      end
-
-      out.puts <<-END
-
-# Ignore unnamed instances
-reject {|instance| !instance.tags['Name'] }
-
-# You can use methods of AWS::EC2::Instance.
-# See http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/EC2/Instance.html
-host_line <<EOS
-Host <%= tags['Name'] %>.<%= availability_zone %>
-  HostName <%= dns_name || private_ip_address %>
-EOS
-      END
-
-      out.puts
-      out.puts dotfile_str.gsub(/^/m, '# ')
-
-      out.string
-    end
-
-    def replace!(new_dotfile_str)
-      File.open(@dotfile_path, 'w') {|f| f.write new_dotfile_str }
-    end
-
-    def backup!
-      backup_path = "#{@dotfile_path}.#{Time.now.strftime("%Y%m%d%H%M%S")}"
-      File.open(backup_path, 'w') {|f| f.write dotfile_str }
-      backup_path
-    end
-  end
-end

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

@@ -1,113 +0,0 @@
-require 'spec_helper'
-require 'ec2ssh/command/migrate'
-
-describe Ec2ssh::Command::Migrate do
-  include FakeFS::SpecHelpers
-
-  describe '#run' do
-    let(:cli) do
-      double(:cli,
-             options: options, yes?: nil,
-             red: nil, yellow: nil, green: nil)
-    end
-    let(:command) do
-      described_class.new cli
-    end
-    let(:options) do
-      double(:options, dotfile: '/dotfile')
-    end
-
-    before do
-      File.open('/dotfile', 'w') {|f| f.write dotfile_str }
-    end
-
-    around do |example|
-      silence_stdout { example.run }
-    end
-
-    context 'version 2' do
-      let(:dotfile_str) { <<-END }
----
-path: /path/to/ssh/config
-aws_keys:
-  key1:
-    access_key_id: ACCESS_KEY1
-    secret_access_key: SECRET1
-      END
-
-      context 'yes' do
-        before do
-          expect(cli).to receive(:yes?).and_return(true)
-          Timecop.freeze(Time.utc(2014, 1, 1)) do
-            command.run
-          end
-        end
-
-        it do
-          expect(File.read('/dotfile')).to eq <<-END
-path '/path/to/ssh/config'
-aws_keys(
-  key1: { access_key_id: 'ACCESS_KEY1', secret_access_key: 'SECRET1' }
-)
-
-# Ignore unnamed instances
-reject {|instance| !instance.tags['Name'] }
-
-# You can use methods of AWS::EC2::Instance.
-# See http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/EC2/Instance.html
-host_line <<EOS
-Host <%= tags['Name'] %>.<%= availability_zone %>
-  HostName <%= dns_name || private_ip_address %>
-EOS
-
-# ---
-# path: /path/to/ssh/config
-# aws_keys:
-#   key1:
-#     access_key_id: ACCESS_KEY1
-#     secret_access_key: SECRET1
-          END
-        end
-
-        it do
-          expect(File.read('/dotfile.20140101000000')).to eq(dotfile_str)
-        end
-      end
-
-      context 'no' do
-        before do
-          expect(cli).to receive(:yes?).and_return(false)
-          command.run
-        end
-
-        it do
-          expect(File.read('/dotfile')).to eq(dotfile_str)
-        end
-      end
-    end
-
-    context 'version 3' do
-      let(:dotfile_str) { <<-END }
-path '/path/to/ssh/config'
-aws_keys(
-  key1: { access_key_id: 'ACCESS_KEY1', secret_access_key: 'SECRET1' }
-)
-
-# You can use methods of AWS::EC2::Instance.
-# See http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/EC2/Instance.html
-host_line <<EOS
-Host <%= tags['Name'] %>.<%= availability_zone %>
-  HostName <%= dns_name || private_ip_address %>
-EOS
-      END
-
-      before do
-        command.run
-      end
-
-      it do
-        expect(File.read('/dotfile')).to eq(dotfile_str)
-      end
-    end
-  end
-end

data/spec/lib/ec2ssh/migrator_spec.rb

@@ -1,64 +0,0 @@
-require 'spec_helper'
-require 'ec2ssh/migrator'
-
-describe Ec2ssh::Migrator do
-  include FakeFS::SpecHelpers
-
-  subject(:migrator) { described_class.new '/dotfile' }
-
-  before do
-    File.open('/dotfile', 'w') {|f| f.write dotfile_str }
-  end
-
-  context 'from version 2' do
-    let(:dotfile_str) { <<-END }
----
-path: /path/to/ssh/config
-aws_keys:
-  key1:
-    access_key_id: ACCESS_KEY1
-    secret_access_key: SECRET1
-  key2:
-    access_key_id: ACCESS_KEY2
-    secret_access_key: SECRET2
-regions:
-- ap-northeast-1
-- us-east-1
-    END
-
-    let(:new_dotfile_str) { <<-END }
-path '/path/to/ssh/config'
-aws_keys(
-  key1: { access_key_id: 'ACCESS_KEY1', secret_access_key: 'SECRET1' },
-  key2: { access_key_id: 'ACCESS_KEY2', secret_access_key: 'SECRET2' }
-)
-regions 'ap-northeast-1', 'us-east-1'
-
-# Ignore unnamed instances
-reject {|instance| !instance.tags['Name'] }
-
-# You can use methods of AWS::EC2::Instance.
-# See http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/EC2/Instance.html
-host_line <<EOS
-Host <%= tags['Name'] %>.<%= availability_zone %>
-  HostName <%= dns_name || private_ip_address %>
-EOS
-
-# ---
-# path: /path/to/ssh/config
-# aws_keys:
-#   key1:
-#     access_key_id: ACCESS_KEY1
-#     secret_access_key: SECRET1
-#   key2:
-#     access_key_id: ACCESS_KEY2
-#     secret_access_key: SECRET2
-# regions:
-# - ap-northeast-1
-# - us-east-1
-    END
-
-    it { expect(migrator.check_version).to eq('2') }
-    it { expect(migrator.migrate_from_2).to eq(new_dotfile_str) }
-  end
-end