mirage 2.2.3 → 2.3.0

data/Gemfile

@@ -1,8 +1,10 @@
 source :rubygems
 
 gem 'sinatra'
+gem "eventmachine", "1.0.0.rc.4"
 gem 'childprocess'
 gem "waitforit"
+gem "thor"
 
 group :development do
   gem "thin"

data/Gemfile.lock

@@ -16,14 +16,17 @@ GEM
     diff-lcs (1.1.3)
     domain_name (0.5.1)
       unf (~> 0.0.3)
-    eventmachine (0.12.10)
-    eventmachine (0.12.10-java)
+    eventmachine (1.0.0.rc.4)
+    eventmachine (1.0.0.rc.4-java)
+    eventmachine (1.0.0.rc.4-x86-mingw32)
     ffi (1.0.11)
     ffi (1.0.11-java)
     gherkin (2.7.2)
       json (>= 1.4.6)
     gherkin (2.7.2-java)
       json (>= 1.4.6)
+    gherkin (2.7.2-x86-mingw32)
+      json (>= 1.4.6)
     git (1.2.5)
     jeweler (1.6.4)
       bundler (~> 1.0)
@@ -44,6 +47,7 @@ GEM
     net-http-persistent (2.3.3)
     nokogiri (1.5.0)
     nokogiri (1.5.0-java)
+    nokogiri (1.5.0-x86-mingw32)
     ntlm-http (0.1.1)
     rack (1.4.0)
     rack-protection (1.2.0)
@@ -75,10 +79,12 @@ GEM
       daemons (>= 1.0.9)
       eventmachine (>= 0.12.6)
       rack (>= 1.0.0)
+    thor (0.15.4)
     tilt (1.3.3)
     unf (0.0.4)
       unf_ext
     unf_ext (0.0.4)
+    unf_ext (0.0.4-x86-mingw32)
     waitforit (0.0.1)
     webrobots (0.0.12)
       nokogiri (>= 1.4.4)
@@ -86,10 +92,12 @@ GEM
 PLATFORMS
   java
   ruby
+  x86-mingw32
 
 DEPENDENCIES
   childprocess
   cucumber
+  eventmachine (= 1.0.0.rc.4)
   jeweler
   jruby-openssl
   mechanize
@@ -99,4 +107,5 @@ DEPENDENCIES
   sinatra
   sinatra-contrib
   thin
+  thor
   waitforit

data/HISTORY

@@ -1,3 +1,4 @@
+V2.3.0 - Enhanced commandline/programmatic api
 V2.2.3 - fix bug where mirage is already running a client calls exit.
 V2.2.1/2 - Code tidy up
 V2.2.0 - Api for starting and stopping Mirage locally

data/VERSION

@@ -1 +1 @@
-2.2.3
+2.3.0

data/bin/mirage

@@ -1,16 +1,14 @@
 #!/usr/bin/env ruby
 require 'rubygems'
 
+
 $LOAD_PATH.unshift("#{File.dirname(__FILE__)}/../lib")
 require 'mirage/client'
 
-
-
-if ARGV.include?('start')
-  Mirage.start ARGV
-elsif ARGV.include?('stop')
-  Mirage.stop
-else
-  Mirage::CLI.parse_options ['--help']
+begin
+  Mirage::Runner.start
+rescue Mirage::ClientError => e
+  puts e.message
   exit 1
 end
+

data/features/client/clear.feature

@@ -1,4 +1,4 @@
-Feature: The client can be used for clearing responses from Mirage
+Feature: The client can be used for clearing response templates from Mirage
 
   Background:
     Given the following gems are required to run the Mirage client test code:
@@ -7,22 +7,22 @@ Feature: The client can be used for clearing responses from Mirage
     require 'rspec'
     require 'mirage/client'
     """
-    
+
     And I send PUT to 'http://localhost:7001/mirage/templates/greeting' with request entity
     """
     Hello
     """
     And I send GET to 'http://localhost:7001/mirage/responses/greeting' with parameters:
       | message | hello there |
-    
+
     And I send PUT to 'http://localhost:7001/mirage/templates/leaving' with request entity
     """
     Goodbye
     """
     And I send GET to 'http://localhost:7001/mirage/responses/greeting' with parameters:
-    | message | I'm going |
+      | message | I'm going |
+
 
-    
   Scenario: Clearing everything
     When I run
     """
@@ -51,12 +51,12 @@ Feature: The client can be used for clearing responses from Mirage
 
     When I send GET to 'http://localhost:7001/mirage/requests/2'
     Then a 404 should be returned
-    
+
     When I send GET to 'http://localhost:7001/mirage/responses/greeting'
     Then a 200 should be returned
     When I send GET to 'http://localhost:7001/mirage/responses/leaving'
     Then a 200 should be returned
-    
+
 
   Scenario: Clearning a response
     Given I run
@@ -71,7 +71,7 @@ Feature: The client can be used for clearing responses from Mirage
     Then a 200 should be returned
     When I send GET to 'http://localhost:7001/mirage/requests/2'
     Then a 200 should be returned
-    
+
 
   Scenario: Clearning a request
     Given I run

data/features/client/put.feature

@@ -66,7 +66,6 @@ Feature: the Mirage client provides methods for setting responses and loading de
     Then 'default greeting' should be returned
 
 
-
   Scenario: Setting the content type
     Given I run
     """
@@ -132,3 +131,12 @@ Feature: the Mirage client provides methods for setting responses and loading de
     """
     When I send GET to 'http://localhost:7001/mirage/responses/greeting'
     Then a 203 should be returned
+
+
+  Scenario: Setting a response with a delay
+    Given I run
+    """
+    Mirage::Client.new.put('greeting', 'hello'){|response| response.delay = 2}
+    """
+    When I send GET to 'http://localhost:7001/mirage/responses/greeting'
+    Then it should take at least '2' seconds

data/features/client/running.feature

@@ -0,0 +1,49 @@
+@command_line
+Feature: Use the mirage client api to check if Mirage is running either on the local machine or on a remote host.
+
+
+  Background:
+    Given the following gems are required to run the Mirage client test code:
+    """
+    require 'rubygems'
+    require 'rspec'
+    require 'mirage/client'
+    """
+
+
+  Scenario: Check if mirage is running on the local machine on the default port
+    Given Mirage is not running
+    Then I run
+    """
+      Mirage.running?.should == false
+    """
+    Given Mirage is running
+    Then I run
+    """
+      Mirage.running?.should == true
+    """
+
+
+  Scenario: Check if mirage is running on the local machine on a non standard port
+    Given I run 'mirage start -p 9001'
+    Then I run
+    """
+      Mirage.running?(:port => 9001).should == true
+    """
+
+
+  Scenario: Checking if mirage is running on remote machine
+    Given I run 'mirage start -p 9001'
+    Then I run
+    """
+      Mirage.running? "http://localhost:9001/mirage"
+    """
+
+
+  Scenario: Check if mirage is running using the client directly
+    Given I run 'mirage start -p 9001'
+    Then I run
+    """
+      client = Mirage::Client.new "http://localhost:9001/mirage"
+      client.running?.should == true
+    """

data/features/client/{command_line_interface.feature → start.feature}

@@ -1,4 +1,3 @@
-@command_line
 Feature: The Mirage client provides a programmatic interface equivalent to the command line interface. This gives an
   easy method for bringing a local instance of Mirage in situ inside a test suite.
 
@@ -14,7 +13,6 @@ Feature: The Mirage client provides a programmatic interface equivalent to the c
 
 
   Scenario: Starting mirage with defaults
-    Given Mirage is not running
     When I run
     """
     Mirage.start
@@ -22,16 +20,6 @@ Feature: The Mirage client provides a programmatic interface equivalent to the c
     Then mirage should be running on 'http://localhost:7001/mirage'
 
 
-  Scenario: Stopping Mirage
-    Given Mirage is not running
-    When I run
-    """
-    Mirage.start
-    Mirage.stop
-    """
-    Then Connection should be refused to 'http://localhost:7001/mirage'
-
-
   Scenario: Starting Mirage on a custom port
     Given Mirage is not running
     And the file './custom_responses_location/default_greetings.rb' contains:

data/features/client/stop.feature

@@ -0,0 +1,85 @@
+Feature: The Mirage client provides a programmatic interface equivalent to the command line interface. This gives an
+  easy method for bringing a local instance of Mirage in situ inside a test suite.
+
+  The client can only be used to stop Mirage if it is was used to start the running instance.
+
+  Background:
+    Given the following gems are required to run the Mirage client test code:
+    """
+    require 'rubygems'
+    require 'rspec'
+    require 'mirage/client'
+    """
+
+
+  Scenario: Stopping Mirage
+    Given Mirage is not running
+    When I run
+    """
+    Mirage.start
+    Mirage.stop :port => 7001
+    """
+    Then Connection should be refused to 'http://localhost:7001/mirage'
+
+  Scenario: Stopping Mirage on custom port
+    Given Mirage is not running
+    And I run 'mirage start -p 7001'
+    And I run 'mirage start -p 9001'
+    When I run
+    """
+    Mirage.stop :port => 9001
+    """
+    Then mirage should be running on 'http://localhost:7001/mirage'
+    Then mirage should not be running on 'http://localhost:9001/mirage'
+
+  Scenario: Stopping multiple instances of Mirage
+    Given Mirage is not running
+    And I run 'mirage start -p 7001'
+    And I run 'mirage start -p 9001'
+    And I run 'mirage start -p 10001'
+    When I run
+    """
+    Mirage.stop :port => [9001,10001]
+    """
+    Then mirage should be running on 'http://localhost:7001/mirage'
+    Then mirage should not be running on 'http://localhost:9001/mirage'
+    Then mirage should not be running on 'http://localhost:10001/mirage'
+
+  Scenario: Stopping all instances of Mirage
+    Given Mirage is not running
+    And I run 'mirage start -p 7001'
+    And I run 'mirage start -p 9001'
+    And I run 'mirage start -p 10001'
+    When I run
+    """
+    Mirage.stop :all
+    """
+    Then mirage should not be running on 'http://localhost:7001/mirage'
+    Then mirage should not be running on 'http://localhost:9001/mirage'
+    Then mirage should not be running on 'http://localhost:10001/mirage'
+
+
+
+  Scenario: Using client to stop mirage
+    Given Mirage is not running
+    And I run 'mirage start -p 7001'
+    And I run 'mirage start -p 9001'
+    When I run
+    """
+    begin
+      Mirage.stop
+      raise "should have errored"
+    rescue Mirage::ClientError => ce
+    end
+    """
+    Then mirage should be running on 'http://localhost:7001/mirage'
+    And mirage should be running on 'http://localhost:9001/mirage'
+
+  Scenario: Stopping Mirage without specifying the port when more than one instance of Mirage is running
+    Given Mirage is not running
+    When I run
+    """
+    client = Mirage.start
+    client.stop
+    """
+    Then Connection should be refused to 'http://localhost:7001/mirage'

data/features/server/commandline_interface/help.feature

@@ -0,0 +1,16 @@
+@command_line
+Feature: Mirage is started from the command line.
+  Mirage logs to mirage.log at the path where Mirage is started from
+
+
+  Background: Mirage usage
+    Given usage information:
+      | Tasks:                                                                                       |
+      | mirage help [TASK]                           # Describe available tasks or one specific task |
+#      | mirage start                                 # Starts mirage                                 |
+#      | mirage stop -p, --port=[port_1 port_2\|all]  # stops mirage                                  |
+
+
+  Scenario: Starting with help option
+    Given I run 'mirage help'
+    Then the usage information should be displayed

data/features/server/commandline_interface/start.feature

@@ -0,0 +1,30 @@
+@command_line
+Feature: Mirage is started from the command line.
+  more than instance of Mirage can be started on different ports at the same time.
+
+
+  Scenario: Starting mirage
+    Given Mirage is not running
+    When I run 'mirage start'
+    Then mirage should be running on 'http://localhost:7001/mirage'
+    And 'mirage.log' should exist
+
+
+  Scenario: Starting Mirage on a custom port
+    Given Mirage is not running
+    When I run 'mirage start -p 9001'
+    Then mirage should be running on 'http://localhost:9001/mirage'
+
+
+  Scenario: Starting multiple instances of Mirage
+    Given Mirage is not running
+    When I run 'mirage start -p 7001'
+    And I run 'mirage start -p 9001'
+    Then mirage should be running on 'http://localhost:7001/mirage'
+    And mirage should be running on 'http://localhost:9001/mirage'
+
+
+  Scenario: Starting Mirage when it is already running
+    Given Mirage is running
+    When I run 'mirage start -p 7001'
+    Then I should see 'Mirage is already running' on the command line

data/features/server/commandline_interface/stop.feature

@@ -0,0 +1,42 @@
+@command_line
+Feature: stop
+
+  Scenario: Calling stop without specifying the port when only one instance is running
+    Given I run 'mirage start -p 7001'
+    When I run 'mirage stop'
+    Then mirage should not be running on 'http://localhost:7001/mirage'
+
+
+  Scenario: Calling stop without specifying the port when more than one instance is running
+    Given I run 'mirage start -p 7001'
+    Given I run 'mirage start -p 9001'
+    When I run 'mirage stop'
+    Then I should see 'Mirage is running on ports 7001, 9001. Please run mirage stop -p [PORT(s)] instead' on the command line
+    And mirage should be running on 'http://localhost:7001/mirage'
+    And mirage should be running on 'http://localhost:9001/mirage'
+
+
+  Scenario: stopping on a single instance
+    Given I run 'mirage start -p 7001'
+    And I run 'mirage start -p 9001'
+    When I run 'mirage stop -p 7001'
+    Then mirage should be running on 'http://localhost:9001/mirage'
+    Then mirage should not be running on 'http://localhost:7001/mirage'
+
+  Scenario: stop more than one instance
+    Given I run 'mirage start -p 7001'
+    And I run 'mirage start -p 9001'
+    And I run 'mirage start -p 10001'
+    When I run 'mirage stop -p 7001 9001'
+    Then mirage should be running on 'http://localhost:10001/mirage'
+    Then mirage should not be running on 'http://localhost:7001/mirage'
+    Then mirage should not be running on 'http://localhost:9001/mirage'
+
+  Scenario: stop all instances
+    Given I run 'mirage start -p 7001'
+    And I run 'mirage start -p 9001'
+    When I run 'mirage stop -p all'
+    Then mirage should not be running on 'http://localhost:10001/mirage'
+    Then mirage should not be running on 'http://localhost:7001/mirage'
+    Then mirage should not be running on 'http://localhost:9001/mirage'
+

data/features/server/prime.feature

@@ -4,7 +4,7 @@ Feature: Mirage can be primed with a set of responses.
   of your choosing
 
   Responses can be added to the responses directory and used to prime Mirage after Mirage has been started.
-  
+
   Priming mirage causes any modifications to its state to be lost
 
 
@@ -36,13 +36,14 @@ Feature: Mirage can be primed with a set of responses.
 
 
   Scenario: Mirage is started pointing with a full path for the responses
-    Given the file '/tmp/responses/default_greetings.rb' contains:
+    Given Mirage is not running
+    And the file '/tmp/responses/default_greetings.rb' contains:
     """
     prime do |mirage|
       mirage.put('greeting', 'hello')
     end
     """
-    And I run 'mirage start -d /tmp/responses'
+    And I run 'mirage start --defaults /tmp/responses'
     When I send PUT to 'http://localhost:7001/mirage/defaults'
     And I send GET to 'http://localhost:7001/mirage/responses/greeting'
     Then 'hello' should be returned
@@ -58,9 +59,9 @@ Feature: Mirage can be primed with a set of responses.
     And I run 'mirage start'
     And I send DELETE to 'http://localhost:7001/mirage/templates'
     And I send PUT to 'http://localhost:7001/mirage/templates/a_new_response' with request entity
-      """
-      new response
-      """
+    """
+    new response
+    """
 
     When I send PUT to 'http://localhost:7001/mirage/defaults'
     When I send GET to 'http://localhost:7001/mirage/responses/greeting'
@@ -68,7 +69,7 @@ Feature: Mirage can be primed with a set of responses.
     When I send GET to 'http://localhost:7001/mirage/responses/a_new_response'
     Then a 404 should be returned
 
-
+  @command_line
   Scenario: Mirage is started with a bad file
     Given the file 'responses/default_greetings.rb' contains:
     """

data/features/step_definitions/my_steps.rb

@@ -1,11 +1,3 @@
-Before('@command_line') do
-  stop_mirage
-end
-
-After('@command_line') do
-  stop_mirage
-end
-
 Then /^'([^']*)' should be returned$/ do |expected_response|
   response_text = @response.body
   if response_text != expected_response
@@ -23,20 +15,31 @@ Then /^it should take at least '(.*)' seconds$/ do |time|
 end
 
 
-Then /^mirage should be running on '(.*)'$/ do |url|
-  http_get(url).code.to_i.should == 200
+Then /^mirage (should|should not) be running on '(.*)'$/ do |should, url|
+  running = false
+  begin
+    running = http_get(url).code.to_i.should == 200
+  rescue
+  end
+
+  should == "should" ? running.should == true : running.should == false
 end
 
 Given /^I run '(.*)'$/ do |command|
-  path = ENV['mode'] == 'regression' ? '' : "../bin/"
+  if ENV['mode'] == 'regression' && ChildProcess.windows?
+    command.gsub!(/^mirage/, MIRAGE_CMD)
+  else
+    path = "#{RUBY_CMD} ../bin/"
+  end
+
   @commandline_output = normalise(run("#{path}#{command}"))
 end
 
 Given /^Mirage (is|is not) running$/ do |running|
   if running == 'is'
-    start_mirage unless $mirage.running?
+    start_mirage_in_scratch_dir unless Mirage.running?
   else
-    stop_mirage if $mirage.running?
+    Mirage.stop :all
   end
 end
 
@@ -61,8 +64,9 @@ Given /^the file '(.*)' contains:$/ do |file_path, content|
 end
 
 Then /^the usage information should be displayed$/ do
-  @usage.each { |line| @commandline_output.should =~ /#{line}/ }
+  @usage.each { |line| @commandline_output.should include(line) }
 end
+
 Given /^usage information:$/ do |table|
   @usage = table.raw.flatten.collect { |line| normalise(line) }
 end
@@ -70,7 +74,7 @@ end
 Then /^I run$/ do |text|
   text.gsub!("\"", "\\\\\"")
   Dir.chdir SCRATCH do
-    raise "run failed" unless system "#{RUBY_CMD} -e \"#{@code_snippet}\n#{text}\""
+    raise "run failed" unless system "#{RUBY_CMD} -I #{SOURCE_PATH} -e \"#{@code_snippet}\n#{text}\""
   end
 end
 
@@ -126,7 +130,7 @@ When /^I send PUT to '(http:\/\/localhost:7001\/mirage\/([^']*))' with body '([^
 end
 
 Then /^I should see '(.*?)' on the command line$/ do |content|
-  @commandline_output.should =~/#{content}/
+  @commandline_output.should include(content)
 end
 
 Then /^'(.*)' should exist$/ do |path|

data/features/support/command_line.rb

@@ -0,0 +1,22 @@
+require 'tempfile'
+module CommandLine
+  def run command
+    output = Tempfile.new("child")
+    Dir.chdir SCRATCH do
+      process = ChildProcess.build(*("#{command}".split(' ')))
+      process.detach
+      process.io.stdout = output
+      process.io.stderr = output
+      process.start
+      wait_until(:timeout_after => 30.seconds) { process.exited? }
+    end
+    File.read(output.path)
+  end
+
+  def normalise text
+    text.gsub(/[\n]/, ' ').gsub(/\s+/, ' ')
+  end
+end
+
+World CommandLine
+include CommandLine