ec2ssh 3.1.1 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82094a4ffb0cc7177a3174c0eb775bb77806541076133d515af86172ecb83bf6
-  data.tar.gz: 575e64da09628b5469c974133d2fcde4508498ca07c1a5bc9e55921e4fb9b5ee
+  metadata.gz: '093b50c289c52b6442b616dc9cfb0688a5441f540334d9358c1c6e0bf29c1a43'
+  data.tar.gz: e069b0a512b9130c5ae164a8f11ecdc5c7674940cacc312d8d8eb4c220f60130
 SHA512:
-  metadata.gz: d14febefd3c85a7b3288fc60bf2836b303d3e5b89874c26bed96b4626c78f37fb1ebde3cd0b68f1f335e7330bb963295bef2174e6a1c3efbd44ef4f0cac26b27
-  data.tar.gz: 1f001fef1061f9e3ce41abea0984a7f36662699ad7290d945701bfd769c056cbd902661e405698673e5d876cb055cfb5535c4d0dee3cae3510fada99ef12d403
+  metadata.gz: 589991eb9c5dd93c750fec943600f7c4de503e6d944cb8a9ef74b9b5e07b0a0dad666dc1f719b01212820a7b90c66036a141ec68ab4cb612af3e0406a5aabafc
+  data.tar.gz: 6e6bb717dcc3958aa79502356dc1c314d5f0a820ddb4438cc0fa67ea595e5b0d720b809f688ef72fe0ef66cd6eefa7596c7e48dd2af124c6f38d834d26e6546b

data/.github/workflows/main.yml

@@ -0,0 +1,31 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - master
+
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby:
+          - '2.6'
+          - '2.7'
+          - '3.0'
+          - '3.1'
+          - 'head'
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/ChangeLog.md

@@ -1,4 +1,27 @@
 # Change Log
+
+## 5.1.0
+* Drop support outdated Ruby 2.4 and 2.5 (#60, #61)
+* CI against for Ruby 3.0 and 3.1 (#61)
+* Fix arguments warnings of ERB.new on Ruby 3.1 (#61)
+* Migrate CI from TravisCI to GitHub Actions (#62)
+
+## 5.0.0
+* Remove `--aws-key` option and add `--path` option in shellcomp (#56)
+* Use aws-sdk v3 and stop using v2 (#54)
+* Delete `rubyforge_project=` in gemspec (#51)
+* Relax thor and highline versions (#49)
+* CI against Ruby 2.5, 2.6 and 2.7 (#45, #55)
+* Drop support outdated Ruby 2.2 and 2.3 (#59)
+
+## 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/Gemfile

@@ -5,8 +5,10 @@ gem 'rake', '>= 12.0.0'
 gem 'rspec', '~> 3.0'
 gem 'rspec-its', '~> 1.0'
 gem 'guard-rspec', '~> 4.3'
-gem 'webmock', '~> 1.9'
-gem 'rb-fsevent', '~> 0.9.1'
-gem 'timecop', '~> 0.5'
-gem 'fakefs', '~> 0.6.0', require: 'fakefs/safe'
-gem 'vcr', '~> 3.0'
+gem 'webmock', '~> 3.14'
+gem 'rb-fsevent', '~> 0.10'
+gem 'timecop', '~> 0.9'
+gem 'fakefs', '~> 1.4', require: 'fakefs/safe'
+gem 'vcr', '~> 6.1'
+
+gem 'rexml' if RUBY_VERSION >= '3.0.0'

data/README.md

@@ -1,4 +1,5 @@
-[![Build Status](https://travis-ci.org/mirakui/ec2ssh.png?branch=master)](https://travis-ci.org/mirakui/ec2ssh)
+[![Gem Version](https://badge.fury.io/rb/ec2ssh.svg)](https://badge.fury.io/rb/ec2ssh)
+[![Build Status](https://github.com/mirakui/ec2ssh/actions/workflows/main.yml/badge.svg)](https://github.com/mirakui/ec2ssh/actions/workflows/main.yml)
 
 # Introduction
 ec2ssh is a ssh_config manager for Amazon EC2.
@@ -41,17 +42,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/sdk-for-ruby/v3/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 +121,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 v3
+* The `aws_keys` structure has been 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 +145,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) 2022 Issei Naruta. ec2ssh is released under the MIT license.

data/bash/ec2ssh.bash

@@ -6,8 +6,8 @@ _ec2ssh() {
     cur=$2
     prev=$3
 
-    subcmds="help init migrate remove update version"
-    common_opts="--dotfile --verbose"
+    subcmds="help init remove update version"
+    common_opts="--path --dotfile --verbose"
 
     # contextual completion
     case $prev in
@@ -21,11 +21,7 @@ _ec2ssh() {
             esac
             return 0
             ;;
-        --aws-key)
-            COMPREPLY=()
-            return 0;
-            ;;
-        --dotfile)
+        --path | --dotfile)
             COMPREPLY=( $(compgen -o default -- "$cur"))
             return 0;
             ;;
@@ -35,9 +31,6 @@ _ec2ssh() {
     subcmd=${COMP_WORDS[1]}
 
     case $subcmd in
-        update)
-            COMPREPLY=( $(compgen -W "--aws-key $common_opts" -- "$cur") )
-            ;;
         help)
             COMPREPLY=( $(compgen -W "$subcmds" $cur) )
             ;;
@@ -50,4 +43,4 @@ _ec2ssh() {
 
 }
 
-complete -F _ec2ssh ec2ssh
+complete -F _ec2ssh ec2ssh

data/ec2ssh.gemspec

@@ -9,14 +9,15 @@ Gem::Specification.new do |s|
   s.authors     = ["Issei Naruta"]
   s.email       = ["mimitako@gmail.com"]
   s.homepage    = "http://github.com/mirakui/ec2ssh"
+  s.license     = "MIT"
   s.summary     = %q{A ssh_config manager for AWS EC2}
   s.description = %q{ec2ssh is a ssh_config manager for AWS EC2}
-  s.required_ruby_version = ">= 2.2.0"
+  s.required_ruby_version = ">= 2.6.0"
 
-  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 "thor", ">= 0.14", "< 2.0"
+  s.add_dependency "highline", ">= 1.6", "< 3.0"
+  s.add_dependency "aws-sdk-core", "~> 3"
+  s.add_dependency "aws-sdk-ec2", "~> 1"
 
   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

@@ -6,9 +6,7 @@ module Ec2ssh
   class Builder
     def initialize(container)
       @container = container
-      safe_level = nil
-      erb_trim_mode = '%-'
-      @host_lines_erb = ERB.new @container.host_line, safe_level, erb_trim_mode
+      @host_lines_erb = ERB.new @container.host_line, trim_mode: '%-'
     end
 
     def build_host_lines
@@ -26,19 +24,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."
@@ -117,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/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.1'
+  VERSION = '5.1.0'
 end