ec2ssh 3.1.0.rc1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0fed04d98aec0c6bc32e228fec63e1a7040d7f3e
-  data.tar.gz: 778787d2041ac64d967d03a6bfd07515038308fd
+SHA256:
+  metadata.gz: 392df01c5d38c8c1dc5589258e885cd348646467303abc15cf346101e4a9d441
+  data.tar.gz: b9eb640b664ef6701e50754ff4cf3b3082c66d3132b94350f8a4eb398b764ace
 SHA512:
-  metadata.gz: fac818f9832e2c5f51c754ddad8c6004a16714bd651913062c35874c1be3282cfccf17740a480069355551e71149bc4181f3179c4dece7e6e404b93af21966f7
-  data.tar.gz: 81122aef18a18b74f062e6f2b16aab5f1c84f5c275b82192307c40176823171c1b08ba58e7ad3cbc0097d0d70300cb6a47f6390bc6a8e01a13348b2fbf1a2a33
+  metadata.gz: 331921d24eace17e5ebdfc94aec1c231e7ebd4e7b9fe1619b7e1c28b8f2fd288109530ea3a54eb3d830141d04f35ef43c777d9d4c2071080aaf745bac3b93dcf
+  data.tar.gz: 224f8d90beb435c656c0d50ae1edff0684ace90f4aa9d7a75c1c62f75bfc3aedee1a590deecb5d93f07d42d4c401775c9a892eee86643b169a13493b5473d46e

data/.travis.yml

@@ -1,6 +1,12 @@
 language: ruby
 rvm:
-  - 2.0.0
-  - 2.1.4
-  - 2.2.0
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+  - ruby-head
 script: 'bundle exec rspec spec'
+before_install: gem install bundler -v 1.14.3
+notifications:
+  slack:
+    secure: CYxJDs0jJkrgXfbOyHuF+gJtxgK5JjS0GAFRNOlkWlDUmpEErtcnPuBOrlzkIBJS4eXaDOuSvpyRJSuJZJjEhmp94GEI98GEcyvByHuaehUWhzhUrhXstX/gg/Ntt6jiFR5dC6NrRWAnmKb7cDsfvagGAVNAuNzAtX0Z9iXWQDo=

data/ChangeLog.md

@@ -1,6 +1,29 @@
 # Change Log
+
+## 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
+
 ## 3.1.0
 * Use credentials from `~/.aws/credentials` as default. Credential profiles are set as `profiles` in dotfile.
+* Revive path option for changing ssh config path (#34)
+  Thanks to @cynipe
 
 ## 3.0.3
 * Use "%-" for ERB's trim\_mode at `host\_line` in dotfile (#29)

data/Gemfile

@@ -1,10 +1,14 @@
 source 'https://rubygems.org'
 gemspec
 
+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 'rb-fsevent', '~> 0.10'
 gem 'timecop', '~> 0.5'
-gem 'fakefs', require: 'fakefs/safe'
+gem 'fakefs', '~> 1.2', require: 'fakefs/safe'
+gem 'vcr', '~> 3.0'
+
+gem 'rexml' if RUBY_VERSION >= '2.8.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://travis-ci.org/mirakui/ec2ssh.svg?branch=master)](https://travis-ci.org/mirakui/ec2ssh)
 
 # 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) 2020 Issei Naruta. ec2ssh is released under the MIT license.

data/Rakefile

@@ -1 +1,4 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new("spec")
+task :default => :spec

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.0.0"
+  s.required_ruby_version = ">= 2.4.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/fixtures/vcr_cassettes/ec2-instances.yml

@@ -0,0 +1,178 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://ec2.us-west-1.amazonaws.com/
+    body:
+      encoding: UTF-8
+      string: Action=DescribeInstances&Filter.1.Name=instance-state-name&Filter.1.Value.1=running&Timestamp=2017-02-11T09%3A25%3A44Z&Version=2014-10-01
+    headers:
+      Content-Type:
+      - application/x-www-form-urlencoded; charset=utf-8
+      Accept-Encoding:
+      - ''
+      Content-Length:
+      - '137'
+      User-Agent:
+      - aws-sdk-ruby/1.66.0 ruby/2.3.3 x86_64-darwin15 memoizing
+      Host:
+      - ec2.us-west-1.amazonaws.com
+      X-Amz-Date:
+      - 20170211T092544Z
+      X-Amz-Content-Sha256:
+      - b522eeb0f435881e058aaba87cf05aad80856e36205835b070f61e3a2cea2f66
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - text/xml;charset=UTF-8
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+      Date:
+      - Sat, 11 Feb 2017 09:25:44 GMT
+      Server:
+      - AmazonEC2
+    body:
+      encoding: UTF-8
+      string: |-
+        <?xml version="1.0" encoding="UTF-8"?>
+        <DescribeInstancesResponse xmlns="http://ec2.amazonaws.com/doc/2014-10-01/">
+            <requestId>9b40910f-51b7-44e2-b75b-96078a730000</requestId>
+            <reservationSet>
+                <item>
+                    <reservationId>r-058c6185fab780000</reservationId>
+                    <ownerId>000000000000</ownerId>
+                    <groupSet/>
+                    <instancesSet>
+                        <item>
+                            <instanceId>i-09e547eca106b0000</instanceId>
+                            <imageId>ami-165a0000</imageId>
+                            <instanceState>
+                                <code>16</code>
+                                <name>running</name>
+                            </instanceState>
+                            <privateDnsName>ip-172-31-9-193.us-west-1.compute.internal</privateDnsName>
+                            <dnsName>ec2-54-215-142-250.us-west-1.compute.amazonaws.com</dnsName>
+                            <reason/>
+                            <keyName>aws.pem</keyName>
+                            <amiLaunchIndex>0</amiLaunchIndex>
+                            <productCodes/>
+                            <instanceType>t2.micro</instanceType>
+                            <launchTime>2017-02-11T09:22:47.000Z</launchTime>
+                            <placement>
+                                <availabilityZone>us-west-1c</availabilityZone>
+                                <groupName/>
+                                <tenancy>default</tenancy>
+                            </placement>
+                            <monitoring>
+                                <state>disabled</state>
+                            </monitoring>
+                            <subnetId>subnet-b02b0000</subnetId>
+                            <vpcId>vpc-f8790000</vpcId>
+                            <privateIpAddress>172.31.9.193</privateIpAddress>
+                            <ipAddress>54.215.142.250</ipAddress>
+                            <sourceDestCheck>true</sourceDestCheck>
+                            <groupSet>
+                                <item>
+                                    <groupId>sg-a83f0000</groupId>
+                                    <groupName>default</groupName>
+                                </item>
+                                <item>
+                                    <groupId>sg-4db20000</groupId>
+                                    <groupName>ssh</groupName>
+                                </item>
+                            </groupSet>
+                            <architecture>x86_64</architecture>
+                            <rootDeviceType>ebs</rootDeviceType>
+                            <rootDeviceName>/dev/xvda</rootDeviceName>
+                            <blockDeviceMapping>
+                                <item>
+                                    <deviceName>/dev/xvda</deviceName>
+                                    <ebs>
+                                        <volumeId>vol-02a0f01045aadbf7f</volumeId>
+                                        <status>attached</status>
+                                        <attachTime>2017-02-11T09:22:48.000Z</attachTime>
+                                        <deleteOnTermination>true</deleteOnTermination>
+                                    </ebs>
+                                </item>
+                            </blockDeviceMapping>
+                            <virtualizationType>hvm</virtualizationType>
+                            <clientToken>XDpiz1486804967277</clientToken>
+                            <tagSet>
+                                <item>
+                                    <key>Role</key>
+                                    <value>ec2ssh-test</value>
+                                </item>
+                                <item>
+                                    <key>Name</key>
+                                    <value>ec2ssh-test-02</value>
+                                </item>
+                            </tagSet>
+                            <hypervisor>xen</hypervisor>
+                            <networkInterfaceSet>
+                                <item>
+                                    <networkInterfaceId>eni-f79a7ff6</networkInterfaceId>
+                                    <subnetId>subnet-b02b2ef6</subnetId>
+                                    <vpcId>vpc-f879939d</vpcId>
+                                    <description/>
+                                    <ownerId>000000000000</ownerId>
+                                    <status>in-use</status>
+                                    <macAddress>06:05:50:b3:b3:d8</macAddress>
+                                    <privateIpAddress>172.31.9.193</privateIpAddress>
+                                    <privateDnsName>ip-172-31-9-193.us-west-1.compute.internal</privateDnsName>
+                                    <sourceDestCheck>true</sourceDestCheck>
+                                    <groupSet>
+                                        <item>
+                                            <groupId>sg-a83f0000</groupId>
+                                            <groupName>default</groupName>
+                                        </item>
+                                        <item>
+                                            <groupId>sg-4db20000</groupId>
+                                            <groupName>ssh</groupName>
+                                        </item>
+                                    </groupSet>
+                                    <attachment>
+                                        <attachmentId>eni-attach-e6ce6187</attachmentId>
+                                        <deviceIndex>0</deviceIndex>
+                                        <status>attached</status>
+                                        <attachTime>2017-02-11T09:22:47.000Z</attachTime>
+                                        <deleteOnTermination>true</deleteOnTermination>
+                                    </attachment>
+                                    <association>
+                                        <publicIp>54.215.142.250</publicIp>
+                                        <publicDnsName>ec2-54-215-142-250.us-west-1.compute.amazonaws.com</publicDnsName>
+                                        <ipOwnerId>amazon</ipOwnerId>
+                                    </association>
+                                    <privateIpAddressesSet>
+                                        <item>
+                                            <privateIpAddress>172.31.9.193</privateIpAddress>
+                                            <privateDnsName>ip-172-31-9-193.us-west-1.compute.internal</privateDnsName>
+                                            <primary>true</primary>
+                                            <association>
+                                            <publicIp>54.215.142.250</publicIp>
+                                            <publicDnsName>ec2-54-215-142-250.us-west-1.compute.amazonaws.com</publicDnsName>
+                                            <ipOwnerId>amazon</ipOwnerId>
+                                            </association>
+                                        </item>
+                                    </privateIpAddressesSet>
+                                </item>
+                            </networkInterfaceSet>
+                            <iamInstanceProfile>
+                                <arn>arn:aws:iam::000000000000:instance-profile/ec2ssh-test-role</arn>
+                                <id>AIPAJF7H4IAXZXXXXXXXX</id>
+                            </iamInstanceProfile>
+                            <ebsOptimized>false</ebsOptimized>
+                        </item>
+                    </instancesSet>
+                </item>
+            </reservationSet>
+        </DescribeInstancesResponse>
+    http_version:
+  recorded_at: Sat, 11 Feb 2017 09:25:45 GMT
+recorded_with: VCR 3.0.3

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