datasift / storyplayer

src/php/DataSift/Storyplayer/Cli/StaticConfigManager.php

Indentation +72 added lines, -72 removed lines

@@ -59,87 +59,87 @@
  */
 class StaticConfigManager extends ConfigManagerBase
 {
-	const USER_DOTFILE = 'storyplayer.json';
+    const USER_DOTFILE = 'storyplayer.json';
 
-	/**
-	 * load the default config file
-	 *
-	 * @param StaticConfig $config
-	 * @return void
-	 */
-	public function loadDefaultConfig($config, $defaultConfigFilename)
-	{
-		// load the default config file
-		$this->configHelper->loadConfigFile($config, $defaultConfigFilename);
-	}
+    /**
+     * load the default config file
+     *
+     * @param StaticConfig $config
+     * @return void
+     */
+    public function loadDefaultConfig($config, $defaultConfigFilename)
+    {
+        // load the default config file
+        $this->configHelper->loadConfigFile($config, $defaultConfigFilename);
+    }
 
-	/**
-	 * @param  StaticConfig $config
-	 * @return void
-	 */
-	public function loadUserConfig($config)
-	{
-		try {
-			// We start with an empty config
-			$this->configHelper->loadDotFileConfig($config, self::APP_NAME, self::USER_DOTFILE);
-		}
-		catch (E4xx_ConfigFileNotFound $e) {
-			// we don't care - user configs are optional
-		}
-		// all done
-	}
+    /**
+     * @param  StaticConfig $config
+     * @return void
+     */
+    public function loadUserConfig($config)
+    {
+        try {
+            // We start with an empty config
+            $this->configHelper->loadDotFileConfig($config, self::APP_NAME, self::USER_DOTFILE);
+        }
+        catch (E4xx_ConfigFileNotFound $e) {
+            // we don't care - user configs are optional
+        }
+        // all done
+    }
 
-	/**
-	 *
-	 * @return array<string>
-	 */
-	public function getListOfConfigFiles($dirs)
-	{
-		// do we have a credible search list?
-		if (!is_array($dirs)) {
-			// fraid not
-			return [];
-		}
+    /**
+     *
+     * @return array<string>
+     */
+    public function getListOfConfigFiles($dirs)
+    {
+        // do we have a credible search list?
+        if (!is_array($dirs)) {
+            // fraid not
+            return [];
+        }
 
-		$return = [];
-		foreach ($dirs as $dirToSearch)
-		{
-			// find JSON config files
-			$files = $this->configHelper->getListOfConfigFilesIn($dirToSearch, 'json');
-			foreach ($files as $filename) {
-				$return[basename($filename, '.json')] = $filename;
-			}
-		}
+        $return = [];
+        foreach ($dirs as $dirToSearch)
+        {
+            // find JSON config files
+            $files = $this->configHelper->getListOfConfigFilesIn($dirToSearch, 'json');
+            foreach ($files as $filename) {
+                $return[basename($filename, '.json')] = $filename;
+            }
+        }
 
-		// all done
-		return $return;
-	}
+        // all done
+        return $return;
+    }
 
-	public function loadConfigFilesFrom($dirs)
-	{
-		// our list of loaded config files
-		$return = [];
+    public function loadConfigFilesFrom($dirs)
+    {
+        // our list of loaded config files
+        $return = [];
 
-		// the files to load
-		$filenames = $this->getListOfConfigFiles($dirs);
+        // the files to load
+        $filenames = $this->getListOfConfigFiles($dirs);
 
-		// load the files
-		foreach ($filenames as $filename)
-		{
-			$config = new BaseObject();
-			$this->configHelper->loadConfigFile($config, $filename);
-			$return[basename($filename, '.json')] = $config;
-		}
+        // load the files
+        foreach ($filenames as $filename)
+        {
+            $config = new BaseObject();
+            $this->configHelper->loadConfigFile($config, $filename);
+            $return[basename($filename, '.json')] = $config;
+        }
 
-		// all done
-		return $return;
-	}
+        // all done
+        return $return;
+    }
 
-	public function loadConfigFile($filename)
-	{
-		$config = new BaseObject();
-		$this->configHelper->loadConfigFile($config, $filename);
+    public function loadConfigFile($filename)
+    {
+        $config = new BaseObject();
+        $this->configHelper->loadConfigFile($config, $filename);
 
-		return $config;
-	}
+        return $config;
+    }
 }

Braces +2 added lines, -4 removed lines

@@ -102,8 +102,7 @@ 
 		}
 
 		$return = [];
-		foreach ($dirs as $dirToSearch)
-		{
+		foreach ($dirs as $dirToSearch) {
 			// find JSON config files
 			$files = $this->configHelper->getListOfConfigFilesIn($dirToSearch, 'json');
 			foreach ($files as $filename) {
@@ -124,8 +123,7 @@ 
 		$filenames = $this->getListOfConfigFiles($dirs);
 
 		// load the files
-		foreach ($filenames as $filename)
-		{
+		foreach ($filenames as $filename) {
 			$config = new BaseObject();
 			$this->configHelper->loadConfigFile($config, $filename);
 			$return[basename($filename, '.json')] = $config;

src/php/DataSift/Storyplayer/CommandLib/CommandRunner.php

Spacing +4 added lines, -4 removed lines

@@ -72,9 +72,9 @@ 
 
         // how we will talk with the command
         $pipesSpec = [
-            [ 'file', 'php://stdin', 'r' ],
-            [ 'pipe', 'w' ],
-            [ 'pipe', 'w' ]
+            ['file', 'php://stdin', 'r'],
+            ['pipe', 'w'],
+            ['pipe', 'w']
         ];
         $pipes = [];
 
@@ -110,7 +110,7 @@ 
             // timeout has happened
             //
             // this makes sure that we do not burn CPU for the sake of it
-            $readable = [ $pipes[1], $pipes[2] ];
+            $readable = [$pipes[1], $pipes[2]];
             $writeable = $except = [];
             stream_select($readable, $writeable, $except, 1);
 

Braces +1 added lines, -2 removed lines

@@ -104,8 +104,7 @@
         //
         // best thing to do is to keep reading from our pipes until
         // the pipes no longer exist
-        while (!feof($pipes[1]) || !feof($pipes[2]))
-        {
+        while (!feof($pipes[1]) || !feof($pipes[2])) {
             // block until there is something to read, or until the
             // timeout has happened
             //

src/php/DataSift/Storyplayer/CommandLib/LocalClient.php

Indentation +4 added lines, -4 removed lines

@@ -152,8 +152,8 @@ 
         // build the full command
         //
         $fullCommand = 'cp '
-                     . "'" . $sourceFilename . "' "
-                     . "'" . $destFilename . "'";
+                        . "'" . $sourceFilename . "' "
+                        . "'" . $destFilename . "'";
 
         // run the command
         $commandRunner = $this->st->getNewCommandRunner();
@@ -182,8 +182,8 @@ 
         // build the full command
         //
         $fullCommand = 'cp '
-                     . "'" . $sourceFilename . "' "
-                     . "'" . $destFilename . "'";
+                        . "'" . $sourceFilename . "' "
+                        . "'" . $destFilename . "'";
 
         // run the command
         $commandRunner = $this->st->getNewCommandRunner();

src/php/DataSift/Storyplayer/CommandLib/SshClient.php

Indentation +17 added lines, -17 removed lines

@@ -158,7 +158,7 @@ 
     {
         return [
             '-o StrictHostKeyChecking=no', // avoid prompting for accepting
-                                           // a host key
+                                            // a host key
         ];
     }
 
@@ -166,9 +166,9 @@ 
     {
         return [
             '-o StrictHostKeyChecking=no', // avoid prompting for accepting
-                                           // a host key
+                                            // a host key
             '-n' // attach stdin to /dev/null - req to run SSH when not
-                 // connected to a terminal
+                    // connected to a terminal
         ];
     }
 
@@ -384,10 +384,10 @@ 
         //    the command to run on the remote/guest OS
         //    (assumes the command will be globbed by the remote shell)
         $fullCommand = 'ssh '
-                     . ' ' . $this->getSshKeyForUse()
-                     . ' ' . $this->getSshOptionsForUse()
-                     . ' ' . $this->getSshUsername() . '@' . $this->getIpAddress()
-                     . ' "' . str_replace('"', '\"', $command) . '"';
+                        . ' ' . $this->getSshKeyForUse()
+                        . ' ' . $this->getSshOptionsForUse()
+                        . ' ' . $this->getSshUsername() . '@' . $this->getIpAddress()
+                        . ' "' . str_replace('"', '\"', $command) . '"';
 
         // run the command
         //$log->startStep("run command via SSH: {$fullCommand}");
@@ -435,11 +435,11 @@ 
         // <additional SSH options>
         //    any other flags, such as -n to force non-interactive session
         $fullCommand = 'scp '
-                     . ' ' . $this->getSshKeyForUse()
-                     . ' ' . $this->getScpOptionsForUse()
-                     . ' "' . $this->getSshUsername() . '@' . $this->getIpAddress()
-                     . ':' . $sourceFilename . '"'
-                     . ' "' . $destFilename . '"';
+                        . ' ' . $this->getSshKeyForUse()
+                        . ' ' . $this->getScpOptionsForUse()
+                        . ' "' . $this->getSshUsername() . '@' . $this->getIpAddress()
+                        . ':' . $sourceFilename . '"'
+                        . ' "' . $destFilename . '"';
 
         // run the command
         $commandRunner = $this->st->getNewCommandRunner();
@@ -486,11 +486,11 @@ 
         // <additional SSH options>
         //    any other flags, such as -n to force non-interactive session
         $fullCommand = 'scp '
-                     . ' ' . $this->getSshKeyForUse()
-                     . ' ' . $this->getScpOptionsForUse()
-                     . ' "' . $sourceFilename . '" '
-                     . ' "' . $this->getSshUsername() . '@' . $this->getIpAddress()
-                     . ':' . $destFilename . '"';
+                        . ' ' . $this->getSshKeyForUse()
+                        . ' ' . $this->getScpOptionsForUse()
+                        . ' "' . $sourceFilename . '" '
+                        . ' "' . $this->getSshUsername() . '@' . $this->getIpAddress()
+                        . ':' . $destFilename . '"';
 
         // run the command
         $commandRunner = $this->st->getNewCommandRunner();

src/php/DataSift/Storyplayer/ConfigLib/ConfigList.php

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);
         }
     }

Doc Comments +8 added lines, -3 removed lines

@@ -90,6 +90,9 @@ 
 
     /**
      * constructor
+     * @param string $configType
+     * @param string[] $searchFolders
+     * @param ConfigFinder[] $configFinders
      */
     public function __construct($configType, $searchFolders, $configFinders)
     {
@@ -186,6 +189,7 @@ 
     /**
      * load a SPv2.0-style JSON configs
      *
+     * @param string $filename
      * @return object
      */
     protected function loadJsonConfig($filename)
@@ -204,7 +208,8 @@ 
      * @todo we need (at some point) to move the check for a return value
      *       out to somewhere else
      *
-     * @return object
+     * @param string $filename
+     * @return TestEnvironment_Definition
      */
     protected function loadPhpConfig($filename)
     {
@@ -360,7 +365,7 @@ 
     /**
      * returns our list of all known configs
      *
-     * @return array
+     * @return SystemUnderTestConfig[]
      */
     public function getEntries()
     {
@@ -370,7 +375,7 @@ 
     /**
      * returns the names of all of the entries in our list
      *
-     * @return array<string>
+     * @return integer[]
      */
     public function getEntryNames()
     {

src/php/DataSift/Storyplayer/ConfigLib/HardCodedList.php

Indentation +23 added lines, -23 removed lines

@@ -55,10 +55,10 @@ 
  */
 class HardCodedList
 {
-	/**
-	 * our list of configs
-	 * @var array<object>
-	 */
+    /**
+     * our list of configs
+     * @var array<object>
+     */
     private $configs = [];
 
     /**
@@ -76,7 +76,7 @@ 
      */
     public function __construct($configType)
     {
-    	$this->setConfigType($configType);
+        $this->setConfigType($configType);
     }
 
     /**
@@ -86,7 +86,7 @@ 
      */
     public function getConfigType()
     {
-    	return $this->configType;
+        return $this->configType;
     }
 
     /**
@@ -99,11 +99,11 @@ 
      */
     public function setConfigType($configType)
     {
-    	if (!class_exists($configType)) {
-    		throw new E4xx_NoSuchConfigClass($configType);
-    	}
+        if (!class_exists($configType)) {
+            throw new E4xx_NoSuchConfigClass($configType);
+        }
 
-    	$this->configType = $configType;
+        $this->configType = $configType;
     }
 
     /**
@@ -118,15 +118,15 @@ 
      */
     public function newConfig($name)
     {
-    	// create our return object
-    	$classname = $this->configType;
-    	$obj = new $classname();
-    	$obj->setName($name);
+        // create our return object
+        $classname = $this->configType;
+        $obj = new $classname();
+        $obj->setName($name);
 
-    	// add this to the list
-    	$this->addConfig($obj);
+        // add this to the list
+        $this->addConfig($obj);
 
-    	return $obj;
+        return $obj;
     }
 
     /**
@@ -137,13 +137,13 @@ 
      */
     public function addConfig($config)
     {
-    	// make sure the config is compatible first
-    	if (! $config instanceof $this->configType) {
-    		throw new E4xx_IncompatibleConfigClass($this->configType, get_class($config));
-    	}
+        // make sure the config is compatible first
+        if (! $config instanceof $this->configType) {
+            throw new E4xx_IncompatibleConfigClass($this->configType, get_class($config));
+        }
 
-    	// if we get here, then we're good to go
-    	$name = $config->getName();
+        // if we get here, then we're good to go
+        $name = $config->getName();
         $this->configs[$name] = $config;
 
         // keep the list sorted

Spacing +1 added lines, -1 removed lines

@@ -138,7 +138,7 @@
     public function addConfig($config)
     {
     	// make sure the config is compatible first
-    	if (! $config instanceof $this->configType) {
+    	if (!$config instanceof $this->configType) {
     		throw new E4xx_IncompatibleConfigClass($this->configType, get_class($config));
     	}
 

src/php/DataSift/Storyplayer/ConfigLib/StoryplayerConfig.php

Spacing +1 added lines, -1 removed lines

@@ -82,7 +82,7 @@
             throw new E4xx_StoryplayerDefaultsSectionMustBeAnArray($this->getFilename());
         }
 
-        foreach($config->defaults as $defaultValue) {
+        foreach ($config->defaults as $defaultValue) {
             if (!is_string($defaultValue)) {
                 throw new E4xx_StoryplayerDefaultsMustBeStrings($this->getFilename());
             }

src/php/DataSift/Storyplayer/Console/Console.php

Indentation +2 added lines, -2 removed lines

@@ -422,8 +422,8 @@
         if ($trace !== null) {
             $this->write(PHP_EOL . "-----" . PHP_EOL, $this->writer->commentStyle);
             $this->write("This is the stack trace for this failure:"
-                 . PHP_EOL . PHP_EOL
-                 . CodeFormatter::indentBySpaces($trace, 4) . PHP_EOL . PHP_EOL);
+                    . PHP_EOL . PHP_EOL
+                    . CodeFormatter::indentBySpaces($trace, 4) . PHP_EOL . PHP_EOL);
         }
 
         // all done

Doc Comments +1 added lines

@@ -92,6 +92,7 @@
     /**
      * called when Storyplayer exits
      *
+     * @param boolean $summary
      * @return void
      */
     public function writeFinalReport($duration, $summary)

Braces +3 added lines, -6 removed lines

@@ -112,11 +112,9 @@ 
 
         // this is our opportunity to tell the user how our story(ies)
         // went in detail
-        foreach ($this->results as $result)
-        {
+        foreach ($this->results as $result) {
             // so what happened?
-            switch ($result->resultCode)
-            {
+            switch ($result->resultCode) {
                 case PhaseGroup_Result::OKAY:
                     // this is a good result
                     $succeededGroups[] = $result;
@@ -303,8 +301,7 @@ 
 
         // does the phase have an exception?
         $e = $phaseResult->getException();
-        if ($e)
-        {
+        if ($e) {
             $stackTrace = $e->getTrace();
             $trace = $e->getTraceAsString();
         }

src/php/DataSift/Storyplayer/Console/DevModeConsole.php

Indentation +2 added lines, -2 removed lines

@@ -270,8 +270,8 @@
     public function logCliErrorWithException($msg, $e)
     {
         $this->write("*** error: $msg" . PHP_EOL . PHP_EOL
-             . "This was caused by an unexpected exception " . get_class($e) . PHP_EOL . PHP_EOL
-             . $e->getTraceAsString() . PHP_EOL);
+                . "This was caused by an unexpected exception " . get_class($e) . PHP_EOL . PHP_EOL
+                . $e->getTraceAsString() . PHP_EOL);
     }
 
     /**

Spacing +2 added lines, -2 removed lines

@@ -60,7 +60,7 @@ 
  */
 class DevModeConsole extends Console
 {
-    protected $resultStrings  = array();
+    protected $resultStrings = array();
 
     public function __construct()
     {
@@ -124,7 +124,7 @@ 
         //$this->write('-------------------------------------------------------------' . PHP_EOL, $this->writer->commentStyle);
         $this->write('----' . PHP_EOL, $this->writer->commentStyle);
         $this->write("Result: ");
-        if ($result->getPhaseGroupSucceeded()){
+        if ($result->getPhaseGroupSucceeded()) {
             $this->write($resultString, $this->writer->successStyle);
         }
         else if ($result->getPhaseGroupFailed()) {

Braces +1 added lines, -1 removed lines

@@ -124,7 +124,7 @@
         //$this->write('-------------------------------------------------------------' . PHP_EOL, $this->writer->commentStyle);
         $this->write('----' . PHP_EOL, $this->writer->commentStyle);
         $this->write("Result: ");
-        if ($result->getPhaseGroupSucceeded()){
+        if ($result->getPhaseGroupSucceeded()) {
             $this->write($resultString, $this->writer->successStyle);
         }
         else if ($result->getPhaseGroupFailed()) {