datasift / storyplayer

src/php/DataSift/Storyplayer/ConfigLib/ActiveConfig.php

Doc Comments +6 added lines

@@ -105,11 +105,17 @@
         $activeConfig->roles = $rolesTable->$testEnvName;
 	}
 
+	/**
+	 * @param Injectables $injectables
+	 */
 	public function mergeStoryplayerConfig($injectables, $spConf)
 	{
 		$this->mergeData('storyplayer', $spConf);
 	}
 
+	/**
+	 * @param Injectables $injectables
+	 */
 	public function mergeSystemUnderTestConfig($injectables, SystemUnderTestConfig $sutConfig = null)
 	{
         // do we have a system under test?

Indentation +27 added lines, -27 removed lines

@@ -75,43 +75,43 @@ 
  */
 class ActiveConfig extends WrappedConfig
 {
-	public function init(Injectables $injectables)
-	{
-		// we start off with the built-in config
-		$this->mergeData('storyplayer', $injectables->defaultConfig);
-
-		// these are the initial variables we want
-		$this->setData('storyplayer.ipAddress', $this->getHostIpAddress());
-		$this->setData('storyplayer.currentDir', getcwd());
-		$this->setData('storyplayer.user.home', getenv('HOME'));
-
-		// we also want to link in the hosts and roles tables, to make
-		// it a lot easier for Prose modules
-		$activeConfig         = $this->getConfig();
+    public function init(Injectables $injectables)
+    {
+        // we start off with the built-in config
+        $this->mergeData('storyplayer', $injectables->defaultConfig);
+
+        // these are the initial variables we want
+        $this->setData('storyplayer.ipAddress', $this->getHostIpAddress());
+        $this->setData('storyplayer.currentDir', getcwd());
+        $this->setData('storyplayer.user.home', getenv('HOME'));
+
+        // we also want to link in the hosts and roles tables, to make
+        // it a lot easier for Prose modules
+        $activeConfig         = $this->getConfig();
         $runtimeConfig        = $injectables->getRuntimeConfig();
         $runtimeConfigManager = $injectables->getRuntimeConfigManager();
         $testEnvName          = $injectables->activeTestEnvironmentName;
 
-		$hostsTable = $runtimeConfigManager->getTable($runtimeConfig, 'hosts');
+        $hostsTable = $runtimeConfigManager->getTable($runtimeConfig, 'hosts');
         if (!isset($hostsTable->$testEnvName)) {
             $hostsTable->$testEnvName = new BaseObject;
         }
         $activeConfig->hosts = $hostsTable->$testEnvName;
 
-		$rolesTable = $runtimeConfigManager->getTable($runtimeConfig, 'roles');
+        $rolesTable = $runtimeConfigManager->getTable($runtimeConfig, 'roles');
         if (!isset($rolesTable->$testEnvName)) {
             $rolesTable->$testEnvName = new BaseObject;
         }
         $activeConfig->roles = $rolesTable->$testEnvName;
-	}
+    }
 
-	public function mergeStoryplayerConfig($injectables, $spConf)
-	{
-		$this->mergeData('storyplayer', $spConf);
-	}
+    public function mergeStoryplayerConfig($injectables, $spConf)
+    {
+        $this->mergeData('storyplayer', $spConf);
+    }
 
-	public function mergeSystemUnderTestConfig($injectables, SystemUnderTestConfig $sutConfig = null)
-	{
+    public function mergeSystemUnderTestConfig($injectables, SystemUnderTestConfig $sutConfig = null)
+    {
         // do we have a system under test?
         if (!isset($injectables->activeSystemUnderTestName) || $sutConfig === null) {
             $this->setData('systemundertest', null);
@@ -123,7 +123,7 @@ 
 
         // merge in the loaded config
         $this->mergeData('systemundertest', $sutConfig->getConfig());
-	}
+    }
 
     /**
      *
@@ -131,8 +131,8 @@ 
      * @param  \DataSift\Storyplayer\TestEnvironmentsLib\TestEnvironmentsConfig|\DataSift\Storyplayer\DefinitionLib\TestEnvironment_Definition $envConfig
      * @return void
      */
-	public function mergeTestEnvironmentConfig($injectables, $envConfig = null)
-	{
+    public function mergeTestEnvironmentConfig($injectables, $envConfig = null)
+    {
         // do we have a test environment?
         if (!isset($injectables->activeTestEnvironmentName) || $envConfig === null) {
             $this->setData('target', null);
@@ -143,8 +143,8 @@ 
         $this->setData('target.name', $injectables->activeTestEnvironmentName);
 
         // merge in the loaded config
-		$this->mergeData('target', $envConfig->getConfig());
-	}
+        $this->mergeData('target', $envConfig->getConfig());
+    }
 
     protected function getHostIpAddress()
     {

Spacing +3 added lines, -3 removed lines

@@ -87,7 +87,7 @@ 
 
 		// we also want to link in the hosts and roles tables, to make
 		// it a lot easier for Prose modules
-		$activeConfig         = $this->getConfig();
+		$activeConfig = $this->getConfig();
         $runtimeConfig        = $injectables->getRuntimeConfig();
         $runtimeConfigManager = $injectables->getRuntimeConfigManager();
         $testEnvName          = $injectables->activeTestEnvironmentName;
@@ -179,7 +179,7 @@ 
                 // does the adapter have an IP address?
                 try {
                     $ipAddress = $netifaces->getIpAddress($adapterToTest);
-                } catch(NetifacesException $e){
+                } catch (NetifacesException $e) {
                     // We couldn't get an IP address
                     $ipAddress = null;
                 }
@@ -213,7 +213,7 @@ 
             // this sucks
             throw new NetifacesException("Unable to determine IP address");
 
-        } catch (NetifacesException $e){
+        } catch (NetifacesException $e) {
             throw new Exception("could not determine IP address of host machine");
         }
     }

Braces +4 added lines, -2 removed lines

@@ -179,7 +179,8 @@ 
                 // does the adapter have an IP address?
                 try {
                     $ipAddress = $netifaces->getIpAddress($adapterToTest);
-                } catch(NetifacesException $e){
+                }
+                catch(NetifacesException $e) {
                     // We couldn't get an IP address
                     $ipAddress = null;
                 }
@@ -213,7 +214,8 @@ 
             // this sucks
             throw new NetifacesException("Unable to determine IP address");
 
-        } catch (NetifacesException $e){
+        }
+        catch (NetifacesException $e) {
             throw new Exception("could not determine IP address of host machine");
         }
     }

src/php/DataSift/Storyplayer/DefinitionLib/TestEnvironment/GroupDefinition.php

Doc Comments +2 added lines, -2 removed lines

@@ -220,7 +220,7 @@ 
     /**
      * how should we provision this environment?
      *
-     * @return array<ProvisioningAdapters>
+     * @return ProvisioningAdapter[]
      */
     public function getProvisioningAdapters()
     {
@@ -265,7 +265,7 @@ 
     /**
      * what hosts exist in this group?
      *
-     * @return array<TestEnvironment_HostDefinition>
+     * @return TestEnvironmentHost[]
      */
     public function getHosts()
     {

src/php/DataSift/Storyplayer/DefinitionLib/TestEnvironment/HostDefinition.php

Doc Comments +3 added lines

@@ -74,6 +74,9 @@
      */
     protected $storySettings;
 
+    /**
+     * @param string $hostId
+     */
     public function __construct(TestEnvironment_GroupDefinition $parentGroup, $hostId)
     {
         $this->setParentGroup($parentGroup);

src/php/DataSift/Storyplayer/functions.php

Doc Comments +2 added lines, -2 removed lines

@@ -53,7 +53,7 @@ 
  * this function avoids reset()ing the array, so it will not mess with
  * any iteration that you may currently be part-way through
  *
- * @param  array $arrayToSearch
+ * @param  Storyplayer\TestEnvironments\ProvisioningAdapter[] $arrayToSearch
  *         the array to get the first element of
  * @return mixed
  *         the first element of $array, or NULL if the array is empty
@@ -95,7 +95,7 @@ 
 /**
  * Create a new test environment object
  *
- * @return TestEnvironment
+ * @return TestEnvironment_Definition
  *         the test environment object to use in the script
  */
 function newTestEnvironment()

Braces +2 added lines, -1 removed lines

@@ -115,7 +115,8 @@
  * @param  callback $callback the action(s) to attempt
  * @return void
  */
-function tryTo($callback) {
+function tryTo($callback)
+{
     try {
         $callback();
     }

src/php/DataSift/Storyplayer/Reports/TapReport.php

Doc Comments -1 removed lines

@@ -177,7 +177,6 @@
     }
 
     /**
-     * @param integer $level
      * @param string $msg
      * @return void
      */

src/php/Storyplayer/TestEnvironments/Vagrant/VirtualboxHostAdapter.php

Doc Comments +1 added lines, -1 removed lines

@@ -69,7 +69,7 @@
 	 *         the group that we belong to
 	 * @param  string $hostId
 	 *         the alias for this host
-	 * @return object
+	 * @return Vagrant_VirtualboxHostDefinition
 	 *         a host definition to populate
 	 */
 	public function newHostDefinition(TestEnvironment_GroupDefinition $groupDef, $hostId)

Indentation +14 added lines, -14 removed lines

@@ -62,18 +62,18 @@
 
 class Vagrant_VirtualboxHostAdapter extends Vagrant_HostAdapter
 {
-	/**
-	 * create an empty host definition for this kind of host
-	 *
-	 * @param  TestEnvironment_GroupDefinition $groupDef
-	 *         the group that we belong to
-	 * @param  string $hostId
-	 *         the alias for this host
-	 * @return object
-	 *         a host definition to populate
-	 */
-	public function newHostDefinition(TestEnvironment_GroupDefinition $groupDef, $hostId)
-	{
-		return new Vagrant_VirtualboxHostDefinition($groupDef, $hostId, $this);
-	}
+    /**
+     * create an empty host definition for this kind of host
+     *
+     * @param  TestEnvironment_GroupDefinition $groupDef
+     *         the group that we belong to
+     * @param  string $hostId
+     *         the alias for this host
+     * @return object
+     *         a host definition to populate
+     */
+    public function newHostDefinition(TestEnvironment_GroupDefinition $groupDef, $hostId)
+    {
+        return new Vagrant_VirtualboxHostDefinition($groupDef, $hostId, $this);
+    }
 }
\ No newline at end of file

src/php/DataSift/Storyplayer/Cli/BuildTestEnvironment/Command.php

Indentation +1 added lines, -1 removed lines

@@ -302,7 +302,7 @@
         // do we skip destroying the test environment?
         if ($this->st->getPersistTestEnvironment()) {
             echo PHP_EOL . "* Warning: NOT destroying test environment" . PHP_EOL
-                 .         "           --reuse-target flag is set" . PHP_EOL;
+                    .         "           --reuse-target flag is set" . PHP_EOL;
         }
 
         // cleanup

Braces +1 added lines, -2 removed lines

@@ -218,8 +218,7 @@
         // $this->playerList contains one or more things to play
         //
         // let's play each of them in order
-        foreach ($this->playerList as $player)
-        {
+        foreach ($this->playerList as $player) {
             // execute each player in turn
             //
             // they may also have their own list of nested players

Spacing +1 added lines, -1 removed lines

@@ -231,7 +231,7 @@
 
         // setup signal handling
         pcntl_signal(SIGTERM, array($this, 'sigtermHandler'));
-        pcntl_signal(SIGINT , array($this, 'sigtermHandler'));
+        pcntl_signal(SIGINT, array($this, 'sigtermHandler'));
     }
 
     /**

src/php/DataSift/Storyplayer/Cli/E4xx/NoSystemUnderTestSpecified.php

Indentation +1 added lines, -1 removed lines

@@ -61,7 +61,7 @@
     public function __construct()
     {
         $msg = "You need to use -s to specify which system to test." . PHP_EOL . PHP_EOL
-             . "Use 'storyplayer --list-systems' to see the list of known systems under test.";
+                . "Use 'storyplayer --list-systems' to see the list of known systems under test.";
         parent::__construct(400, $msg, $msg);
     }
 }
\ No newline at end of file

src/php/DataSift/Storyplayer/Cli/Feature/ColorSupport.php

Indentation +12 added lines, -12 removed lines

@@ -78,20 +78,20 @@
 
     public function initBeforeModulesAvailable(CliEngine $engine, CliCommand $command, Injectables $injectables)
     {
-    	// which colour mode are we in?
-    	switch ($engine->options->color) {
-    		case Feature_ColorSwitch::NO_COLOR:
-    			$injectables->output->disableColourSupport();
-    			break;
+        // which colour mode are we in?
+        switch ($engine->options->color) {
+            case Feature_ColorSwitch::NO_COLOR:
+                $injectables->output->disableColourSupport();
+                break;
 
-    		case Feature_ColorSwitch::ALWAYS_COLOR:
-    			$injectables->output->enforceColourSupport();
-    			break;
+            case Feature_ColorSwitch::ALWAYS_COLOR:
+                $injectables->output->enforceColourSupport();
+                break;
 
-    		case Feature_ColorSwitch::AUTO_COLOR:
-    			$injectables->output->enableColourSupport();
-    			break;
-    	}
+            case Feature_ColorSwitch::AUTO_COLOR:
+                $injectables->output->enableColourSupport();
+                break;
+        }
     }
 
     public function initAfterModulesAvailable(StoryTeller $st, CliEngine $engine, Injectables $injectables)