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/ConfigLib/ConfigList.php

Doc Comments +5 added lines, -2 removed lines

@@ -83,6 +83,8 @@ 
 
     /**
      * constructor
+     * @param string $configType
+     * @param string[] $searchFolders
      */
     public function __construct($configType, $searchFolders)
     {
@@ -195,6 +197,7 @@ 
     /**
      * build a list of the config files in the $searchFolder
      *
+     * @param string $searchPattern
      * @return array<string>
      */
     protected function findConfigFilenames($searchPattern)
@@ -329,7 +332,7 @@ 
     /**
      * returns our list of all known configs
      *
-     * @return array
+     * @return SystemUnderTestConfig[]
      */
     public function getEntries()
     {
@@ -339,7 +342,7 @@ 
     /**
      * returns the names of all of the entries in our list
      *
-     * @return array<string>
+     * @return integer[]
      */
     public function getEntryNames()
     {

Braces +1 added lines, -2 removed lines

@@ -356,8 +356,7 @@
     {
         $list = $hardCodedDefaults->getConfigs();
 
-        foreach ($list as $name => $config)
-        {
+        foreach ($list as $name => $config) {
             $this->addEntry($name, $config);
         }
     }

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/Prose/BaseRuntimeTable.php

Doc Comments +1 added lines, -1 removed lines

@@ -59,7 +59,7 @@
      * __construct
      *
      * @param StoryTeller $st The StoryTeller object
-     * @param array $args Any arguments to be used in this Prose module
+     * @param string[] $args Any arguments to be used in this Prose module
      *
      * @return parent::__construct
      */

Spacing +2 added lines, -2 removed lines

@@ -65,8 +65,8 @@
      */
     public function __construct(StoryTeller $st, $args = array())
     {
-        if (!isset($args[0])){
-            throw new E4xx_MissingArgument(__METHOD__, "You must provide a table name to ".get_class($this)."::__construct");
+        if (!isset($args[0])) {
+            throw new E4xx_MissingArgument(__METHOD__, "You must provide a table name to " . get_class($this) . "::__construct");
         }
 
         // normalise

Braces +1 added lines, -1 removed lines

@@ -65,7 +65,7 @@
      */
     public function __construct(StoryTeller $st, $args = array())
     {
-        if (!isset($args[0])){
+        if (!isset($args[0])) {
             throw new E4xx_MissingArgument(__METHOD__, "You must provide a table name to ".get_class($this)."::__construct");
         }
 

src/php/Prose/FromEc2Instance.php

Doc Comments +3 added lines

@@ -99,6 +99,9 @@
         return array();
     }
 
+    /**
+     * @return string
+     */
     public function getPublicDnsName()
     {
         // make sure we have a host to work with

src/php/Prose/FromPDOStatement.php

Doc Comments +4 added lines

@@ -62,6 +62,10 @@
  */
 class FromPDOStatement extends Prose
 {
+    /**
+     * @param \DataSift\Storyplayer\PlayerLib\StoryTeller $st
+     * @param PDOStatement[] $args
+     */
     public function __construct($st, $args)
     {
         // call our parent first

Braces +8 added lines, -16 removed lines

@@ -81,8 +81,7 @@ 
         // what are we doing?
         $log = usingLog()->startAction("fetch all rows from the PDO query result");
 
-        try
-        {
+        try {
             $rows = $this->args[0]->fetchAll();
 
             // all done
@@ -90,8 +89,7 @@ 
 
             return $rows;
         }
-        catch (Exception $e)
-        {
+        catch (Exception $e) {
             throw new E5xx_ActionFailed(__METHOD__, $e->getMessage());
         }
     }
@@ -101,8 +99,7 @@ 
         // what are we doing?
         $log = usingLog()->startAction("fetch 1 row from the PDO query result");
 
-        try
-        {
+        try {
             $row = $this->args[0]->fetch(PDO::FETCH_ASSOC);
 
             // all done
@@ -110,8 +107,7 @@ 
 
             return $row;
         }
-        catch (Exception $e)
-        {
+        catch (Exception $e) {
             throw new E5xx_ActionFailed(__METHOD__, $e->getMessage());
         }
     }
@@ -121,8 +117,7 @@ 
         // what are we doing?
         $log = usingLog()->startAction("fetch 1 row from the PDO query result");
 
-        try
-        {
+        try {
             $row = $this->args[0]->fetch(PDO::FETCH_NUM);
 
             // all done
@@ -130,8 +125,7 @@ 
 
             return $row;
         }
-        catch (Exception $e)
-        {
+        catch (Exception $e) {
             throw new E5xx_ActionFailed(__METHOD__, $e->getMessage());
         }
     }
@@ -141,8 +135,7 @@ 
         // what are we doing?
         $log = usingLog()->startAction("fetch 1 row from the PDO query result");
 
-        try
-        {
+        try {
             $row = $this->args[0]->fetch(PDO::FETCH_OBJ);
 
             // all done
@@ -150,8 +143,7 @@ 
 
             return $row;
         }
-        catch (Exception $e)
-        {
+        catch (Exception $e) {
             throw new E5xx_ActionFailed(__METHOD__, $e->getMessage());
         }
     }