pairhost 0.0.2 → 0.0.3

data/README.md

@@ -1,11 +1,10 @@
 # Pairhost
 
-Create an EC2 instance for Relevance, Inc. remote pairing!  It creates the instance and reports the public DNS name right from the command line.
+Manage EC2 instances for remote pairing the style that Relevance prefers.
 
-## How To Use
+## How to Use
 
-    # install bundler
-    bundle install
-    cp config.example.yml config.yml
-    # edit the config to use real EC2 & AMI stuff (ask me if you need it)
-    #TODO: ./pairhost up
+    gem install pairhost
+    pairhost init
+    # edit ~/.pairhost/config.yml to use your real EC2 & AMI settings
+    pairhost up

data/Rakefile

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

data/lib/pairhost/version.rb

@@ -1,3 +1,3 @@
 module Pairhost
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/pairhost.rb

@@ -12,14 +12,18 @@ module Pairhost
   def self.config
     @config ||= begin
       unless File.exists?(config_file)
-        abort "No pairhost config found. First run 'pairhost init'."
+        abort "pairhost: No config found. First run 'pairhost init'."
       end
       YAML.load_file(config_file)
     end
   end
 
   def self.instance_id
-    @instance_id ||= File.read(File.expand_path('~/.pairhost/instance')).chomp
+    return @instance_id unless @instance_id.nil?
+
+    file = File.expand_path('~/.pairhost/instance')
+    @instance_id = File.read(file).chomp if File.exists?(file)
+    return @instance_id
   end
 
   def self.connection
@@ -38,7 +42,7 @@ module Pairhost
 
   def self.create(name)
     server_options = {
-      "tags" => {"Name" => name, 
+      "tags" => {"Name" => name,
                  "Created-By-Pairhost-Gem" => VERSION},
       "image_id" => config['ami_id'],
       "flavor_id" => config['flavor_id'],
@@ -58,6 +62,7 @@ module Pairhost
     File.open(File.expand_path('~/.pairhost/instance'), "w") do |f|
       f.write(instance_id)
     end
+    @instance_id = nil
   end
 
   def self.start(server)
@@ -70,32 +75,56 @@ module Pairhost
     server.wait_for { state == "stopped" }
   end
 
+  def self.fetch!
+    server = fetch
+    abort "pairhost: No instance found. Please create or attach to one." if server.nil?
+    server
+  end
+
   def self.fetch
-    connection.servers.get(instance_id) if instance_id
+    config
+    return instance_id.nil? ? nil : connection.servers.get(instance_id)
   end
 
   class CLI < Thor
     include Thor::Actions
 
-    desc "ssh", "SSH to your pairhost"
-    def ssh
-      server = Pairhost.fetch
-      exec "ssh -A -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -o LogLevel=QUIET pair@#{server.dns_name}"
+    desc "verify", "Verify the config is in place"
+    def verify
+      Pairhost.config
     end
 
-    desc "status", "Print the status of your pairhost"
-    def status
-      server = Pairhost.fetch
-      puts "#{server.id}: #{server.tags['Name']}"
-      puts "State: #{server.state}"
-      puts server.dns_name if server.dns_name
+    desc "init", "Setup your ~/.pairhost directory with default config"
+    def init
+      if File.exists?(Pairhost.config_file)
+        STDERR.puts "pairhost: Already initialized."
+      else
+        FileUtils.mkdir_p File.dirname(Pairhost.config_file)
+        FileUtils.cp(File.dirname(__FILE__) + '/../config.example.yml', Pairhost.config_file)
+      end
+    end
+
+    desc "create [NAME]", "Provision a new pairhost; all future commands affect this pairhost"
+    def create(name=nil)
+      invoke :verify, []
+
+      if name == nil
+        initials = `git config user.initials`.chomp.split("/").map(&:upcase).join(" ")
+        name = "Pairhost (#{initials})"
+      end
+
+      puts "Provisioning \"#{name}\"..."
+      server = Pairhost.create(name)
+      puts "provisioned!"
+      invoke :status, []
     end
 
     map "start" => :resume
 
     desc "resume", "Start a stopped pairhost"
     def resume
-      server = Pairhost.fetch
+      invoke :verify
+      server = Pairhost.fetch!
       puts "Starting..."
       Pairhost.start(server.reload)
       puts "started!"
@@ -103,20 +132,9 @@ module Pairhost
       invoke :status
     end
 
-    desc "create", "Provision a new pairhost; all future commands affect this pairhost"
-    def create
-      initials = `git config user.initials`.chomp.split("/").map(&:upcase).join(" ")
-      default_name = "something1 #{initials}"
-      name = ask_with_default("What to name your pairhost? [#{default_name}]", default_name)
-      puts "Name will be: #{name}"
-      puts "Provisioning..."
-      # server = Pairhost.create(name)
-      # puts "provisioning!"
-      # invoke :status
-    end
-
     desc "up", "Create a new pairhost or start your stopped pairhost"
     def up
+      invoke :verify
       server = Pairhost.fetch
 
       if server
@@ -126,32 +144,42 @@ module Pairhost
       end
     end
 
+    desc "status", "Print the status of your pairhost"
+    def status
+      invoke :verify
+      server = Pairhost.fetch!
+      puts "#{server.id}: #{server.tags['Name']}"
+      puts "State: #{server.state}"
+      puts server.dns_name if server.dns_name
+    end
+
+    desc "ssh", "SSH to your pairhost"
+    def ssh
+      invoke :verify
+      server = Pairhost.fetch!
+      exec "ssh -A -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -o LogLevel=QUIET pair@#{server.dns_name}"
+    end
+
     map "halt" => :stop
     map "shutdown" => :stop
     map "suspend" => :stop
 
     desc "stop", "Stop your pairhost"
     def stop
-      server = Pairhost.fetch
+      invoke :verify
+      server = Pairhost.fetch!
       puts "Shutting down..."
       Pairhost.stop(server)
       puts "shutdown!"
     end
 
-    desc "attach", "All future commands affect this pairhost"
-    def attach
-      instance_id = ask("EC2 Instance?")
-      Pairhost.write_instance_id(instance_id)
-      invoke :status
-    end
-
     map "terminate" => :destroy
 
     desc "destroy", "Terminate your pairhost"
     def destroy
-      server = Pairhost.fetch
+      invoke :verify
+      server = Pairhost.fetch!
       confirm = ask("Type 'yes' to confirm deleting '#{server.tags['Name']}'.\n>")
-
       return unless confirm == "yes"
 
       puts "Destroying..."
@@ -160,15 +188,25 @@ module Pairhost
       puts "destroyed!"
     end
 
-    desc "init", "Setup your ~/.pairhost directory with default config"
-    def init
-      FileUtils.mkdir_p File.dirname(Pairhost.config_file)
-      FileUtils.cp(File.dirname(__FILE__) + '/../config.example.yml', Pairhost.config_file)
-    end
-
     desc "provision", "Freshen the Chef recipes"
     def provision
-      puts "coming soon..."
+      invoke :verify
+      # TODO implement
+      puts "Coming soon..."
+    end
+
+    desc "attach INSTANCE", "All future commands affect the pairhost with the given EC2 instance ID"
+    def attach(instance_id)
+      invoke :verify, []
+      Pairhost.write_instance_id(instance_id)
+      invoke :status, []
+    end
+
+    desc "detach", "Forget the currently-attached pairhost"
+    def detach
+      invoke :verify
+      # TODO implement
+      puts "Coming soon..."
     end
 
     private

data/pairhost.gemspec

@@ -8,13 +8,17 @@ Gem::Specification.new do |s|
   s.authors     = ["Larry Karnowski"]
   s.email       = ["larry@hickorywind.org"]
   s.homepage    = "http://www.github.com/karnowski/pairhost"
-  s.summary     = %q{Automate creation of Relevance pairhost EC2 instances.}
-  s.description = %q{A Vagrant-like command line interface for creating, managing, and using EC2 instances for remote pairing.}
+  s.summary     = %q{Automate creation of Relevance-style pairhost EC2 instances.}
+  s.description = %q{A Vagrant-like command line interface for creating, managing, and using EC2 instances for remote pairing like we do at Relevance.}
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
 
-  s.add_runtime_dependency "fog", "1.1.2"
-  s.add_runtime_dependency "thor", "0.14.6"
+  s.add_runtime_dependency "fog", "1.3.1"
+  s.add_runtime_dependency "thor", "~> 0.15.2"
+
+  s.add_development_dependency 'rspec', '~> 2.9.0'
+  s.add_development_dependency 'bahia', '~> 0.7.2'
+  s.add_development_dependency 'rake', '~> 0.9.2.2'
 end

data/spec/pairhost_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+require 'fileutils'
+
+def ensure_config_file
+  config_file = File.expand_path('~/.pairhost/config.yml')
+  return if File.exist?(config_file)
+  abort "Pairhost config file was NOT found."
+end
+
+def safely_move(source, target)
+  if File.exist?(source)
+    FileUtils.rm_rf(target)
+    FileUtils.mv(source, target)
+  end
+end
+
+describe Pairhost do
+  context "when NO pairhost config is present" do
+    let(:config_dir)  { File.expand_path('~/.pairhost') }
+    let(:backup_dir)  { File.expand_path('~/.pairhost_test_backup') }
+    let(:config_file) { File.expand_path('~/.pairhost/config.yml') }
+
+    before(:all) { safely_move config_dir, backup_dir }
+    after(:all)  { safely_move backup_dir, config_dir }
+
+    the "attach command returns an error message and failure exit code" do
+      pairhost "attach some-instance"
+      stderr.should == "pairhost: No config found. First run 'pairhost init'.\n"
+      process.should_not be_success
+    end
+
+    %w{create up provision detach status ssh resume stop destroy}.each do |method|
+      the "#{method} command returns an error message and failure exit code" do
+        pairhost method
+        stderr.should == "pairhost: No config found. First run 'pairhost init'.\n"
+        process.should_not be_success
+      end
+    end
+
+    it "init creates a config directory and file" do
+      config_dir.should_not exist_on_filesystem
+
+      pairhost "init"
+
+      config_dir.should exist_on_filesystem
+      config_file.should exist_on_filesystem
+    end
+  end
+
+  context "when a valid pairhost config is present" do
+    # NOTE: this assumes that as a developer you're also
+    # a user of pairhost and have already called "pairhost init"
+    # and configured real AWS credentials.
+    before(:all) { ensure_config_file }
+
+    the "init command complains that the config is already present" do
+      pairhost "init"
+      stderr.should == "pairhost: Already initialized.\n"
+      process.should be_success
+    end
+
+    context "when an instance has NOT been provisioned" do
+      let(:instance_file) { File.expand_path('~/.pairhost/instance') }
+      let(:backup_file)   { File.expand_path('~/.pairhost/instance_test_backup') }
+
+      before(:all) { FileUtils.mv(instance_file, backup_file) if File.exist?(instance_file) }
+      after(:all)  { FileUtils.mv(backup_file, instance_file) if File.exist?(backup_file) }
+
+      # create --> asks to confirm creation
+      # up --> asks to confirm creation
+      # attach --> multiple branches; with instance id specific and without
+      # provision --> not implemented yet
+      # detach --> not implemented yet
+
+      %w{status ssh resume stop destroy}.each do |method|
+        the "#{method} command returns an error message and failure exit code" do
+          pairhost method
+          stderr.should == "pairhost: No instance found. Please create or attach to one.\n"
+          process.should_not be_success
+        end
+      end
+    end
+
+    context "when an instance has been provisioned" do
+      # TODO: make sure the instance_id file exists;
+      # provision an EC2 instance?
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'bahia'
+require 'pairhost'
+
+RSpec.configure do |config|
+  config.include Bahia
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focused => true
+  config.filter_run_excluding :disabled => true
+  config.alias_example_to :fit, :focused => true
+  config.alias_example_to :the
+  config.color_enabled = true
+end
+
+RSpec::Matchers.define :exist_on_filesystem do |name|
+  match do |name|
+    File.exist?(name)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pairhost
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-25 00:00:00.000000000 Z
+date: 2012-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 1.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,25 +26,73 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 1.3.1
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.14.6
+        version: 0.15.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.15.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+- !ruby/object:Gem::Dependency
+  name: bahia
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.14.6
+        version: 0.9.2.2
 description: A Vagrant-like command line interface for creating, managing, and using
-  EC2 instances for remote pairing.
+  EC2 instances for remote pairing like we do at Relevance.
 email:
 - larry@hickorywind.org
 executables:
@@ -61,6 +109,8 @@ files:
 - lib/pairhost.rb
 - lib/pairhost/version.rb
 - pairhost.gemspec
+- spec/pairhost_spec.rb
+- spec/spec_helper.rb
 - update-nx.sh
 homepage: http://www.github.com/karnowski/pairhost
 licenses: []
@@ -85,5 +135,7 @@ rubyforge_project:
 rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
-summary: Automate creation of Relevance pairhost EC2 instances.
-test_files: []
+summary: Automate creation of Relevance-style pairhost EC2 instances.
+test_files:
+- spec/pairhost_spec.rb
+- spec/spec_helper.rb