ec2ssh 2.0.8 → 3.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12075149108b54ade580b209a7a4f0967a9e9f0a
-  data.tar.gz: c6c0a09938f2136ab34e0e93217a57be96716517
+  metadata.gz: 4ba8b5318372505cf30fc98a44565ae291d35c70
+  data.tar.gz: f2e69c94b92e1f8f795fe894e84ee6779a3906bd
 SHA512:
-  metadata.gz: f3b15ed5fec14c3d0b729eaa0ed3a0c5d511fd75ef99785e2d4f0cdb400a8e7d42c42fb6e4d844046635c22d35a795aec62d9a9f627a8c0b16f2cd95bbca0cd8
-  data.tar.gz: 1e7a933fc01d5d39fbe664801abce52be7a76afaae392b3fcdeb383a76ec5564114ded1b5f3ed97424815bb2eeea3538204b61473098db88b4ffadbba47c258d
+  metadata.gz: bc87a5021187606885dbed6ef6e9f297af5544477ce6ce4063e0f7d3b64ee114507e16c721e64d6c29abb5e6c53e82854e826399bd9aabfc50cbf097bb2d66e0
+  data.tar.gz: 91b1bedabe6f6409251df5415ff0b53ad9d65afb2a9a13dc5396e5f0ac9af24ab8212dc446630206d192c31a54d9fb4672ebe489e2a1227ced631f4d8f8105b3

data/.gitignore

@@ -1,7 +1,17 @@
-vendor
-.bundle
-tmp
 *.gem
+*.rbc
+.bundle
+.config
+.yardoc
 Gemfile.lock
-.ruby-version
-.rvmrc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0.0
+  - 2.1.3
 script: 'bundle exec rspec spec'

data/ChangeLog.md

@@ -1,9 +1,4 @@
 # Change Log
-## 2.0.8
-
-* Update EC2 API endpoint (#16, #20)
-  Thanks to @a2ikm and @wnoguchi
-
 ## 2.0.7
 
 * Add ssh_options (#11)

data/Gemfile

@@ -1,8 +1,10 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'rspec', '~> 2.12'
-gem 'guard-rspec', '~> 2.4'
+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', require: 'fakefs/safe'

data/Guardfile

@@ -1,9 +1,5 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-guard 'rspec' do
+guard :rspec, cmd: 'bundle exec rspec' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }
 end
-

data/README.md

@@ -26,13 +26,21 @@ $ ec2ssh init
 ```
 $ vi ~/.ec2ssh
 ---
-path: /path/to/ssh_config
-aws_keys:
-  default:
-    access_key_id: YOUR_ACCESS_KEY_ID
-    secret_access_key: YOUR_SECRET_ACCESS_KEY
-regions:
-  - ap-northeast-1
+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: '...' }, ...
+)
+regions 'us-east-1'
+
+# 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 %>
+END
 ```
 
 ### 5. Execute `ec2ssh update`
@@ -45,7 +53,7 @@ Then host-names of your instances are generated and wrote to .ssh/config
 ### 6. And you can ssh to your instances with your tagged name.
 
 ```
-$ ssh app-server-1.us-west-1
+$ ssh app-server-1.us-east-1a
 ```
 
 # Commands
@@ -57,13 +65,6 @@ $ ec2ssh remove       # Remove ec2ssh mark from ssh_config
 ```
 
 ## Options
-### --path
-Each command can use `--path` option to set ssh_config path. `~/.ssh/config` is default.
-
-```
-$ ec2ssh init --path /path/to/ssh_config
-```
-
 ### --dotfile
 Each command can use `--dotfile` option to set dotfile (.ec2ssh) path. `~/.ec2ssh` is default.
 
@@ -71,14 +72,6 @@ Each command can use `--dotfile` option to set dotfile (.ec2ssh) path. `~/.ec2ss
 $ ec2ssh init --dotfile /path/to/ssh_config
 ```
 
-### --aws-key
-`ec2ssh update` allows `--aws-key` option. If you have multiple aws keys, you can choose from them as you like using this option. See Dotfile section for details.
-
-```
-$ ec2ssh update --aws-key my_key1
-```
-
-
 # ssh_config and mark lines
 `ec2ssh init` command inserts mark lines your `.ssh/config` such as:
 
@@ -110,85 +103,28 @@ Host db-server-1.ap-southeast-1
 
 `ec2ssh remove` command removes the mark lines.
 
-# Dotfile (.ec2ssh)
-Dotfile (`.ec2ssh`) is a feature which is released at v2.0.0. A template of `.ec2ssh` is created when you execute `ec2ssh init`.
+# 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
-$ cat ~/.ec2ssh
----
-path: /home/yourname/.ssh/config
-aws_keys:
-  default:
-    access_key_id: ...(Filled by ENV['AMAZON_ACCESS_KEY_ID']
-    secret_access_key: ...(Filled by ENV['AMAZON_SECRET_ACCESS_KEY'])
-regions:
-  - ap-northeast-1
-```
-
-## multiple aws keys
-You can use multiple aws keys at `ec2ssh update` with `--aws-key` option.
-
-```
-$ cat ~/.ec2ssh
----
-path: /home/yourname/.ssh/config
-aws_keys:
-  default:
-    access_key_id: ...
-    secret_access_key: ...
-  my_key1:
-    access_key_id: ...
-    secret_access_key: ...
-regions:
-  - ap-northeast-1
-```
-
-Updating ssh_config by 'default' aws key:
-
-```
-$ ec2ssh update
+$ vi ~/.ec2ssh
 ```
 
-Updates ssh_config by 'my_key1' aws key:
-
-```
-$ ec2ssh update --aws-key my_key1
-```
+# How to upgrade from 2.x to 3.x
+Dotfile (`.ec2ssh`) format has been changed from YAML to Ruby DSL.
 
-## ssh options
-You can set other ssh options such as IdentityFile or User.
+Don't panic and run `ec2ssh migrate` if you have ec2ssh-2.x styled dotfile.
 
 ```
-$ cat ~/.ec2ssh
----
-path: /home/yourname/.ssh/config
-aws_keys:
-  default:
-    access_key_id: ...
-    secret_access_key: ...
-  my_key1:
-    access_key_id: ...
-    secret_access_key: ...
-regions:
-  - ap-northeast-1
-ssh_options:
-  - "IdentityFile ~/.ssh/ec2.id_rsa"
-  - "User ec2-user"
-  - "TCPKeepAlive yes"
+$ ec2ssh migrate
 ```
 
-# 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
-```
+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.
 
 # License
-ec2ssh is released under the MIT license.
+Copyright (c) 2014 Issei Naruta. ec2ssh is released under the MIT license.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/example/example.ec2ssh

@@ -0,0 +1,17 @@
+path '~/.ssh/config'
+aws_keys(
+  {
+    access_key_id: ENV['AWS_ACCESS_KEY_ID'],
+    secret_access_key: ENV['AWS_SECRET_ACCESS_KEY']
+  },
+  #{
+  #  access_key_id: '...'
+  #  secret_access_key: '...'
+  #}
+)
+regions 'ap-northeast-1', 'us-east-1'
+reject {|instance| instance.tags['Name'] =~ /.../ }
+host_lines <<END
+Host <%= tags['Name'] %>
+  HostName <%= private_ip_address %>
+END

data/lib/ec2ssh/builder.rb

@@ -0,0 +1,29 @@
+require 'ec2ssh/ec2_instances'
+require 'erb'
+require 'stringio'
+
+module Ec2ssh
+  class Builder
+    def initialize(container)
+      @container = container
+      @host_lines_erb = ERB.new @container.host_line
+    end
+
+    def build_host_lines
+      out = StringIO.new
+      @container.aws_keys.each do |name, key|
+        out.puts "# section: #{name}"
+        ec2s.instances(name).each do |instance|
+          bind = instance.instance_eval { binding }
+          next if @container.reject && @container.reject.call(instance)
+          out.puts @host_lines_erb.result(bind)
+        end
+      end
+      out.string
+    end
+
+    def ec2s
+      @ec2s ||= Ec2Instances.new @container.aws_keys, @container.regions
+    end
+  end
+end

data/lib/ec2ssh/cli.rb

@@ -1,79 +1,93 @@
 require 'thor'
 require 'highline'
-require 'ec2ssh/hosts'
 require 'ec2ssh/ssh_config'
-require 'ec2ssh/dotfile'
+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 :dotfile, banner: '$HOME/.ec2ssh', default: "#{ENV['HOME']}/.ec2ssh"
+    class_option :verbose, banner: 'enable debug log', default: false
 
-    desc "init", "Add ec2ssh mark to ssh_config"
+    desc 'init', 'Add ec2ssh mark to ssh_config'
     def init
-      config = SshConfig.new(config_path)
-      if config.mark_exist?
-        red "Marker already exists on #{config_path}"
-      else
-        config.append_mark!
-        green "Added mark to #{config_path}"
-      end
-      dotfile = Dotfile.update_or_create(options.dotfile, 'path' => config_path)
-      yellow "Please check and edit #{options.dotfile} before run `ec2ssh update`"
+      check_dotfile_version
+      command = make_command :init
+      command.run
+    rescue MarkAlreadyExists
+      red "Marker already exists in #{command.ssh_config_path}"
     end
 
-    desc "update", "Update ec2 hosts list in ssh_config"
-    method_option :aws_key, :banner => 'aws key name', :default => 'default'
+    desc 'update', 'Update ec2 hosts list in ssh_config'
+    method_option :aws_key, banner: 'aws key name', default: 'default'
     def update
-      config = SshConfig.new(config_path, options.aws_key)
-      unless config.mark_exist?
-        red "Marker not found on #{config_path}"
-        red "Execute '#{$0} init --path=/path/to/ssh_config' first!"
-        return
-      end
-
-      config.parse!
-      sections = merge_sections(config)
-      config_str = config.wrap(sections.join("\n"))
-      config.replace! config_str
-      yellow config_str
-      green "Updated #{hosts.size} hosts on #{config_path}"
-    rescue AwsEnvNotDefined, AwsKeyNotFound
-      red "Set aws keys at #{options.dotfile}"
+      check_dotfile_existence
+      check_dotfile_version
+      set_aws_logging
+      command = make_command :update
+      command.run
+      green "Updated #{command.ssh_config_path}"
+    rescue AwsKeyNotFound
+      red "Set aws keys at #{command.dotfile_path}"
+    rescue MarkNotFound
+      red "Marker not found in #{command.ssh_config_path}"
+      red "Execute '#{$0} init' first!"
     end
 
-    desc "remove", "Remove ec2ssh mark from ssh_config"
+    desc 'remove', 'Remove ec2ssh mark from ssh_config'
     def remove
-      config = SshConfig.new(config_path)
-      unless config.mark_exist?
-        red "Marker not found on #{config_path}"
-        return
-      end
-      config.replace! ""
-      green "Removed mark from #{config_path}"
+      check_dotfile_existence
+      check_dotfile_version
+      command = make_command :remove
+      command.run
+      green "Removed mark from #{command.ssh_config_path}"
+    rescue MarkNotFound
+      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
 
     no_tasks do
-      def hl
-        @hl ||= HighLine.new
+      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."
+          red "Try '#{$0} init' to generate it or specify the path with --dotfile option"
+          abort
+        end
       end
 
-      def hosts
-        @hosts ||= Hosts.new(dotfile, options.aws_key).all
+      def make_command(cmd)
+        require "ec2ssh/command/#{cmd}"
+        cls = eval "Ec2ssh::Command::#{cmd.capitalize}"
+        cls.new(self)
       end
 
-      def dotfile
-        @dotfile ||= begin
-          if File.exist?(options.dotfile)
-            Dotfile.load(options.dotfile)
-          else
-            Dotfile.new
-          end
+      def set_aws_logging
+        if options.verbose
+          require 'logger'
+          require 'aws-sdk'
+          logger = ::Logger.new($stdout)
+          logger.level = ::Logger::DEBUG
+          ::AWS.config logger: logger
         end
       end
 
-      def config_path
-        options.path || dotfile['path'] || "#{ENV['HOME']}/.ssh/config"
+      def hl
+        @hl ||= ::HighLine.new
       end
 
       [:red,:green,:yellow].each do |col|
@@ -81,45 +95,6 @@ module Ec2ssh
           puts hl.color(str, col)
         end
       end
-
-      def merge_sections(config)
-        ssh_options = dotfile['ssh_options']
-
-        section_str = hosts.map { |h|
-          section = <<-END
-Host #{h[:host]}
-  HostName #{h[:dns_name]}
-          END
-
-          unless ssh_options.nil?
-            ssh_options.each {|line|
-              section << "  #{line}\n"
-            }
-          end
-
-          section
-        }.join
-
-        config.sections[options.aws_key] ||= SshConfig::Section.new(
-          options.aws_key,
-          section_str
-        )
-
-        sections = config.sections.values.map do |section|
-          if (
-              # section is matched
-              (section.name == options.aws_key) ||
-
-              # for backward compatibility
-              (config.sections.size == 1 && options.aws_key != 'default')
-          )
-            section.name = options.aws_key
-            section.replace!(section_str)
-          end
-
-          section.to_s
-        end
-      end
     end
   end
 end