cuke4php 0.9.6.c → 0.9.8

data/HISTORY

@@ -18,3 +18,6 @@
   * utilizes cucumber 0.10.2's ability to use erb templates in .wire files to listen to a specific port
   * release 0.9.3
   * modify cuke4php runner script to dynamically pick an unused port
+
+2011-08-30 -- 0.9.8
+  * add support for a forking socket listener

data/Rakefile

@@ -27,6 +27,9 @@ begin
   Install PHPUnit:
   pear install phpunit/PHPUnit
 
+  Optional:  Use PEAR/Net_Server for a remote forking server implementation
+             (requires PHP with pcntl extensions)
+
 ********************************************************************************
 eos
   end

data/VERSION

@@ -1 +1 @@
-0.9.6.c
+0.9.8

data/bin/cuke4php_forking_server

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+exec File.dirname(__FILE__) + "/../php_bin/cuke4php_forking_server.php #{ARGV.join(' ')}"

data/cuke4php.gemspec

@@ -5,14 +5,14 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cuke4php}
-  s.version = "0.9.6.c"
+  s.version = "0.9.8"
 
-  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Kevin Olbrich", "Alessandro Dal Grande"]
-  s.date = %q{2011-05-07}
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Kevin Olbrich}, %q{Alessandro Dal Grande}]
+  s.date = %q{2011-08-31}
   s.description = %q{Using this protocol it is possible to directly interact with PHP code at any level without the need for a web server.  To accomplish this, when cucumber is running against a directory containing feature files and it cannot resolve a particular step definition, it will ask a known wire server (as defined in a .wire file) to interpret and run those steps.}
-  s.email = ["kevin.olbrich+cuke4php@gmail.com", "aledalgrande@gmail.com"]
-  s.executables = ["cuke4php_server", "cuke4php"]
+  s.email = [%q{kevin.olbrich+cuke4php@gmail.com}, %q{aledalgrande@gmail.com}]
+  s.executables = [%q{cuke4php_forking_server}, %q{cuke4php_server}, %q{cuke4php}]
   s.extra_rdoc_files = [
     "LICENSE",
     "README.md"
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "bin/cuke4php",
+    "bin/cuke4php_forking_server",
     "bin/cuke4php_server",
     "cucumber.yml",
     "cuke4php.gemspec",
@@ -40,11 +41,12 @@ Gem::Specification.new do |s|
     "lib/CucumberScenario.php",
     "lib/CucumberSteps.php",
     "lib/Cuke4Php.php",
+    "lib/Cuke4PhpForkingServer.php",
+    "php_bin/cuke4php_forking_server.php",
     "php_bin/cuke4php_server.php",
     "tests/lib/CucumberScenarioTest.php",
     "tests/lib/Cuke4PhpTest.php"
   ]
-  s.has_rdoc = false
   s.homepage = %q{http://github.com/olbrich/cuke4php}
   s.post_install_message = %q{********************************************************************************
 
@@ -58,15 +60,17 @@ Gem::Specification.new do |s|
   Install PHPUnit:
   pear install phpunit/PHPUnit
 
+  Optional:  Use PEAR/Net_Server for a remote forking server implementation
+             (requires PHP with pcntl extensions)
+
 ********************************************************************************
 }
-  s.require_paths = ["lib"]
-  s.requirements = ["PHP 5.2+", "PHPUnit 3.0+"]
-  s.rubygems_version = %q{1.3.7}
+  s.require_paths = [%q{lib}]
+  s.requirements = [%q{PHP 5.2+}, %q{PHPUnit 3.0+}]
+  s.rubygems_version = %q{1.8.5}
   s.summary = %q{Implementation of the Cucumber wire protocol for PHP projects}
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then

data/features/Cuke4Php.feature

@@ -54,4 +54,7 @@ Scenario Outline: Error Handling
 @exception
 Scenario: Exception Handling
   When an "Exception" is thrown with message "generic exception"
-  Then an "Exception" should be caught  
+  Then an "Exception" should be caught  
+  
+Scenario: nested capture groups work fine
+  Given the losing code "one" has the prize "two"

data/features/step_definitions/Cuke4Php.wire

@@ -1,4 +1,2 @@
 host: localhost
 port: <%= ENV['CUKE4PHP_PORT'] || 16816 %>
-invoke:
-    timeout: 0.1

data/features/step_definitions/WireSteps.php

@@ -231,6 +231,13 @@ class WireSteps extends CucumberSteps {
         self::assertInternalType($sTypeName, $this->$sKey);
     }
     
+    /**
+    * Given /^the(?: losing)? code "([^"]*)"(?: has the prize "([^"]*)")?$/
+    **/
+    public function stepTheLosingCodeParameterHasThePrizeParameter($sCode, $sPrize) {
+        $this->$sCode = $sPrize;
+    }
+    
 }
 
 ?>

data/lib/CucumberScenario.php

@@ -66,6 +66,7 @@ class CucumberScenario {
          if (array_key_exists('tags', $aBeforeHook)) {
            if (count($aBeforeHook['tags']) == 0 || count(array_intersect($aTags, $aBeforeHook['tags'])) > 0) {
              $oStep = CucumberSteps::getInstance($aBeforeHook['class'], $this->aGlobals);
+             syslog(LOG_DEBUG,"Invoking Before Hook \"{$aBeforeHook['method']}\"");
              $oResult = $oStep->invoke($aBeforeHook['method']);
              if ($oResult === false) {
                return array('failure');
@@ -89,6 +90,7 @@ class CucumberScenario {
          if (array_key_exists('tags', $aAfterHook)) {
            if (count($aAfterHook['tags']) == 0 || count(array_intersect($aTags, $aAfterHook['tags'])) > 0) {
              $oStep = CucumberSteps::getInstance($aAfterHook['class'], $this->aGlobals);
+             syslog(LOG_DEBUG,"Invoking After Hook \"{$aAfterHook['method']}\"");
              $oResult = $oStep->invoke($aAfterHook['method']);
              if ($oResult === false) {
                return array('failure');
@@ -132,14 +134,19 @@ class CucumberScenario {
           
         }
         try {
+            syslog(LOG_DEBUG,"Invoking Step \"{$aStep['method']}\"");
             call_user_func_array(array($oStep, $aStep['method']),$aArgs);
         } catch (PHPUnit_Framework_IncompleteTestError $e) {
+            syslog(LOG_DEBUG,"Step Pending");
             return array('pending',$e->getMessage());
         } catch (PHPUnit_Framework_SkippedTestError $e) {
+            syslog(LOG_DEBUG,"Step Pending");
             return array('pending',$e->getMessage());
         } catch (PHPUnit_Framework_ExpectationFailedException $e) {
+            syslog(LOG_DEBUG,"Step Failed due to unmet expectation: " . $e->getMessage());
             return array('fail', array('message' => $e->getMessage()));
         } catch (Exception $e) {
+            syslog(LOG_DEBUG,"Step failed due to ". get_class($e) ." exception :" . $e->getMessage());
             return array('fail', array('message' => $e->getMessage() . " " . $e->getFile() . ":" . $e->getLine(), 'exception' => get_class($e), 'backtrace' => $e->getTraceAsString()));
         }
         return array('success');

data/lib/Cuke4Php.php

@@ -26,6 +26,7 @@ class Cuke4Php {
     );
 
     function __construct($_sFeaturePath, $_iPort = 16816) {
+        openlog("cuke4php", LOG_PID, LOG_DAEMON);
         if (is_file($_sFeaturePath)) {
           $_sFeaturePath = dirname($_sFeaturePath);
         }
@@ -119,21 +120,40 @@ class Cuke4Php {
     }
 
     function run() {
-        print "Cuke4Php listening on port $this->iPort\n";
+        syslog(LOG_INFO,"Cuke4Php listening on port $this->iPort\n");
         $this->oSocket = socket_create_listen($this->iPort);
         $this->bRun = true;
         while ($this->bRun && ($connection = socket_accept($this->oSocket))) {
             socket_getpeername($connection, $raddr, $rport);
-            while ($this->bRun && ($input = socket_read($connection, 1024 * 4))) {
-                $data = trim($input);
-                if ($data !== "") {
-                    $output = json_encode($this->process($data)) . "\n";
-                    if ($this->bRun) {
-                      socket_write($connection, $output);
+            syslog(LOG_INFO,"Connection from $raddr");
+            try {
+                while ($this->bRun && ($input = socket_read($connection, 4096, PHP_NORMAL_READ))) {
+                    $data = trim($input);
+                    if ($data !== "") {
+                        $output = json_encode($this->process($data)) . "\n";
+                        if ($this->bRun) {
+                          socket_write($connection, $output);
+                        }
                     }
+                }                
+            } catch (Exception $e) {
+                switch (socket_last_error($connection)) {
+                    case 54:
+                        // connection closed by peer
+                    case 104:
+                        // unable to read from socket
+                        // these errors just mean we are done and the connection should be closed.
+                        // it does not mean we should stop listening for new connections.
+                        break;
+
+                    default:
+                        syslog(LOG_ERR,$e->getMessage());
+                        throw $e;
+                        break;
                 }
             }
             socket_close($connection);
+            syslog(LOG_INFO,"Connection closed");
             sleep(1);
         }
     }
@@ -183,6 +203,7 @@ class Cuke4Php {
      * run any before hooks for a scenario
      */
     function beginScenario($aTags) {
+        syslog(LOG_DEBUG,"Begin Scenario:  Tags: " . implode(", ", $aTags));
         $this->setScenario(CucumberScenario::getInstance($this->aWorld));
         return $this->oScenario->invokeBeforeHooks($aTags);
     }
@@ -216,6 +237,7 @@ class Cuke4Php {
      */
     function endScenario($aTags) {
         $oResult = $this->oScenario->invokeAfterHooks($aTags);
+        syslog(LOG_DEBUG,"End Scenario");
         $this->oScenario = null;
         return $oResult;
     }

data/lib/Cuke4PhpForkingServer.php

@@ -0,0 +1,34 @@
+<?php
+
+/**
+ * This class allows multiple concurrent connections to the same Cuke4php port.  Each connection forks a process that 
+ * loads the same feature files and then runs the step definitions.  This is useful for cases where the Cuke4php server
+ * is deployed to a remote machine and multiple automation scripts are simultaneously connecting to the server.
+ *
+ * Uses the PEAR Net_Server package
+ **/
+
+require_once "Cuke4Php.php";
+require_once "Net/Server.php";
+require_once "Net/Server/Handler.php";
+
+class Cuke4PhpForkingServer extends Net_Server_Handler
+{
+	private $cuke4php;
+
+	function __construct($_sFeaturePath, $_iPort) {
+		$this->cuke4php = new Cuke4Php($_sFeaturePath, $_iPort);
+	}
+
+	function onReceiveData($iClientId = 0, $data = "") {
+		$output = json_encode($this->cuke4php->process($data)) . "\n";
+		$this->_server->sendData($iClientId, $output);
+	}
+
+	function onClose($iClientId) {
+		// Do nothing
+	}
+}
+
+
+?>

data/php_bin/cuke4php_forking_server.php

@@ -0,0 +1,24 @@
+#!/usr/bin/env php
+<?php
+/**
+ * main entry point for starting a Cuke4Php wire server
+ * @package Cuke4Php
+ */
+
+/**
+ * load the Cuke4PhpForkingServer server
+ */
+require_once dirname(__FILE__) . "/../lib/Cuke4PhpForkingServer.php";
+
+$aOptions = getopt("p:");
+if (array_key_exists('p',$aOptions)) {
+    $iPort = $aOptions['p'];
+} else {
+    $iPort = 16816;
+}
+
+$oServer = &Net_Server::create('fork','0.0.0.0', $iPort);
+$oServerHandler = &new Cuke4PhpForkingServer(realpath($argv[$argc-1]), $iPort);
+$oServer->setCallbackObject($oServerHandler);
+$oServer->start();
+?>

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cuke4php
 version: !ruby/object:Gem::Version 
-  hash: 120
-  prerelease: true
+  hash: 43
+  prerelease: 
   segments: 
   - 0
   - 9
-  - 6
-  - c
-  version: 0.9.6.c
+  - 8
+  version: 0.9.8
 platform: ruby
 authors: 
 - Kevin Olbrich
@@ -17,11 +16,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-07 00:00:00 -04:00
-default_executable: 
+date: 2011-08-31 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -33,11 +31,11 @@ dependencies:
         - 2
         version: 0.10.2
   type: :runtime
-  name: cucumber
+  requirement: *id001
   prerelease: false
-  version_requirements: *id001
+  name: cucumber
 - !ruby/object:Gem::Dependency 
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -48,11 +46,11 @@ dependencies:
         - 0
         version: "1.0"
   type: :development
-  name: bundler
+  requirement: *id002
   prerelease: false
-  version_requirements: *id002
+  name: bundler
 - !ruby/object:Gem::Dependency 
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -62,14 +60,15 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  name: jeweler
+  requirement: *id003
   prerelease: false
-  version_requirements: *id003
+  name: jeweler
 description: Using this protocol it is possible to directly interact with PHP code at any level without the need for a web server.  To accomplish this, when cucumber is running against a directory containing feature files and it cannot resolve a particular step definition, it will ask a known wire server (as defined in a .wire file) to interpret and run those steps.
 email: 
 - kevin.olbrich+cuke4php@gmail.com
 - aledalgrande@gmail.com
 executables: 
+- cuke4php_forking_server
 - cuke4php_server
 - cuke4php
 extensions: []
@@ -86,6 +85,7 @@ files:
 - Rakefile
 - VERSION
 - bin/cuke4php
+- bin/cuke4php_forking_server
 - bin/cuke4php_server
 - cucumber.yml
 - cuke4php.gemspec
@@ -100,10 +100,11 @@ files:
 - lib/CucumberScenario.php
 - lib/CucumberSteps.php
 - lib/Cuke4Php.php
+- lib/Cuke4PhpForkingServer.php
+- php_bin/cuke4php_forking_server.php
 - php_bin/cuke4php_server.php
 - tests/lib/CucumberScenarioTest.php
 - tests/lib/Cuke4PhpTest.php
-has_rdoc: false
 homepage: http://github.com/olbrich/cuke4php
 licenses: []
 
@@ -120,6 +121,9 @@ post_install_message: |
     Install PHPUnit:
     pear install phpunit/PHPUnit
   
+    Optional:  Use PEAR/Net_Server for a remote forking server implementation
+               (requires PHP with pcntl extensions)
+  
   ********************************************************************************
 
 rdoc_options: []
@@ -138,19 +142,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
-      hash: 25
+      hash: 3
       segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: 
 - PHP 5.2+
 - PHPUnit 3.0+
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Implementation of the Cucumber wire protocol for PHP projects