datasift / storyplayer

src/php/DataSift/Storyplayer/PlayerLib/Story/Result.php

Spacing +1 added lines, -1 removed lines

@@ -59,7 +59,7 @@
      *
      * @var Story
      */
-    public $story           = null;
+    public $story = null;
 
     /**
      * is this a story where a failure is the expected outcome?

src/php/DataSift/Storyplayer/PlayerLib/StoryTeller.php

Spacing +2 added lines, -2 removed lines

@@ -962,7 +962,7 @@ 
             // we do not need to wrap these in a TRY/CATCH block,
             // as we are already running inside one of the story's
             // phases
-            foreach ($callbacks as $callback){
+            foreach ($callbacks as $callback) {
                 call_user_func($callback, $this);
             }
         }
@@ -1001,7 +1001,7 @@ 
             // we do not need to wrap these in a TRY/CATCH block,
             // as we are already running inside one of the story's
             // phases
-            foreach ($callbacks as $callback){
+            foreach ($callbacks as $callback) {
                 call_user_func($callback, $this);
             }
         }

Braces +20 added lines, -14 removed lines

@@ -281,7 +281,8 @@ 
      *
      * @return Action_Logger
      */
-    public function getActionLogger() {
+    public function getActionLogger()
+    {
         return $this->actionLogger;
     }
 
@@ -291,7 +292,8 @@ 
      * @param Action_Logger $actionLogger
      * @return StoryTeller
      */
-    public function setActionLogger(Action_Logger $actionLogger) {
+    public function setActionLogger(Action_Logger $actionLogger)
+    {
         $this->actionLogger = $actionLogger;
 
         return $this;
@@ -302,7 +304,8 @@ 
      *
      * @return Story_Checkpoint
      */
-    public function getCheckpoint() {
+    public function getCheckpoint()
+    {
         return $this->checkpoint;
     }
 
@@ -312,7 +315,8 @@ 
      * @param Story_Checkpoint $checkpoint
      * @return StoryTeller
      */
-    public function setCheckpoint(Story_Checkpoint $checkpoint) {
+    public function setCheckpoint(Story_Checkpoint $checkpoint)
+    {
         $this->checkpoint = $checkpoint;
 
         return $this;
@@ -323,7 +327,8 @@ 
      *
      * @return PageContext
      */
-    public function getPageContext() {
+    public function getPageContext()
+    {
         return $this->pageContext;
     }
 
@@ -333,7 +338,8 @@ 
      * @param PageContext $pageContext
      * @return StoryTeller
      */
-    public function setPageContext(PageContext $pageContext) {
+    public function setPageContext(PageContext $pageContext)
+    {
         $this->pageContext = $pageContext;
 
         return $this;
@@ -393,7 +399,8 @@ 
      *
      * @return RuntimeConfigManager
      */
-    public function getRuntimeConfigManager() {
+    public function getRuntimeConfigManager()
+    {
         return $this->runtimeConfigManager;
     }
 
@@ -403,7 +410,8 @@ 
      * @param RuntimeConfigManager $runtimeConfigManager
      * @return StoryTeller
      */
-    public function setRuntimeConfigManager(RuntimeConfigManager $runtimeConfigManager) {
+    public function setRuntimeConfigManager(RuntimeConfigManager $runtimeConfigManager)
+    {
         $this->runtimeConfigManager = $runtimeConfigManager;
 
         return $this;
@@ -906,13 +914,11 @@ 
      */
     public function getRunningDevice()
     {
-        if (!is_object($this->deviceAdapter))
-        {
+        if (!is_object($this->deviceAdapter)) {
             $this->startDevice();
         }
 
-        if (!is_object($this->deviceAdapter))
-        {
+        if (!is_object($this->deviceAdapter)) {
             throw new E5xx_CannotStartDevice();
         }
 
@@ -962,7 +968,7 @@ 
             // we do not need to wrap these in a TRY/CATCH block,
             // as we are already running inside one of the story's
             // phases
-            foreach ($callbacks as $callback){
+            foreach ($callbacks as $callback) {
                 call_user_func($callback, $this);
             }
         }
@@ -1001,7 +1007,7 @@ 
             // we do not need to wrap these in a TRY/CATCH block,
             // as we are already running inside one of the story's
             // phases
-            foreach ($callbacks as $callback){
+            foreach ($callbacks as $callback) {
                 call_user_func($callback, $this);
             }
         }

Doc Comments +11 added lines, -2 removed lines

@@ -429,6 +429,7 @@ 
     }
 
     /**
+     * @param Prose_Loader $proseLoader
      * @return void
      */
     public function setProseLoader($proseLoader)
@@ -445,6 +446,9 @@ 
         return $this->phaseLoader;
     }
 
+    /**
+     * @param Phase_Loader $phaseLoader
+     */
     public function setPhaseLoader($phaseLoader)
     {
         $this->phaseLoader = $phaseLoader;
@@ -469,6 +473,9 @@ 
         $this->output = $output;
     }
 
+    /**
+     * @param \DataSift\Storyplayer\OutputLib\DataFormatter $dataFormatter
+     */
     public function setDataFormatter($dataFormatter)
     {
         $this->dataFormatter = $dataFormatter;
@@ -501,6 +508,7 @@ 
     }
 
     /**
+     * @param \DataSift\Storyplayer\ConfigLib\ActiveConfig $config
      * @return void
      */
     public function setConfig($config)
@@ -509,7 +517,7 @@ 
     }
 
     /**
-     * @return object
+     * @return \DataSift\Storyplayer\TestEnvironmentsLib\TestEnvironmentRuntimeConfig
      */
     public function getRuntimeConfig()
     {
@@ -517,6 +525,7 @@ 
     }
 
     /**
+     * @param \DataSift\Storyplayer\TestEnvironmentsLib\TestEnvironmentRuntimeConfig $runtimeConfig
      * @return void
      */
     public function setRuntimeConfig($runtimeConfig)
@@ -764,7 +773,7 @@ 
      *
      * @param  string $methodName
      * @param  array  $methodArgs
-     * @return mixed
+     * @return \Prose\Prose
      */
     public function __call($methodName, $methodArgs)
     {

src/php/DataSift/Storyplayer/PlayerLib/Tale/Loader.php

Indentation +58 added lines, -58 removed lines

@@ -58,70 +58,70 @@
  */
 class Tale_Loader
 {
-	/**
-	 * singleton - do not instantiate
-	 * @codeCoverageIgnore
-	 */
-	protected function __construct()
-	{
-		// do nothing
-	}
+    /**
+     * singleton - do not instantiate
+     * @codeCoverageIgnore
+     */
+    protected function __construct()
+    {
+        // do nothing
+    }
 
-	/**
-	 * load a story, throwing exceptions if problems are detected
-	 *
-	 * @param  string $filename
-	 *         path to the PHP file containing the story
-	 * @return Story
-	 *         the story object
-	 */
-	static public function loadTale($filename)
-	{
-		if (!file_exists($filename)) {
-			throw new E5xx_InvalidStoryListFile("Cannot find file '{$filename}' to load");
-		}
+    /**
+     * load a story, throwing exceptions if problems are detected
+     *
+     * @param  string $filename
+     *         path to the PHP file containing the story
+     * @return Story
+     *         the story object
+     */
+    static public function loadTale($filename)
+    {
+        if (!file_exists($filename)) {
+            throw new E5xx_InvalidStoryListFile("Cannot find file '{$filename}' to load");
+        }
 
-		// load the contents
-		$contents = file_get_contents($filename);
+        // load the contents
+        $contents = file_get_contents($filename);
 
-		// does it decode?
-		$tale = json_decode($contents);
-		if (!$tale) {
-			throw new E4xx_InvalidStoryListFile("Story list '{$filename}' does not contain valid JSON");
-		}
+        // does it decode?
+        $tale = json_decode($contents);
+        if (!$tale) {
+            throw new E4xx_InvalidStoryListFile("Story list '{$filename}' does not contain valid JSON");
+        }
 
-		// does it have the elements we require?
-		if (!isset($tale->stories)) {
-			throw new E4xx_InvalidStoryListFile("Story list '{$filename}' does not contain a 'stories' element");
-		}
-		if (!is_array($tale->stories)) {
-			throw new E4xx_InvalidStoryListFile("The 'stories' element in the story list '{$filename}' must be an array");
-		}
-		if (count($tale->stories) == 0) {
-			throw new E4xx_InvalidStoryListFile("The 'stories' element in the story list '{$filename}' cannot be an empty array");
-		}
+        // does it have the elements we require?
+        if (!isset($tale->stories)) {
+            throw new E4xx_InvalidStoryListFile("Story list '{$filename}' does not contain a 'stories' element");
+        }
+        if (!is_array($tale->stories)) {
+            throw new E4xx_InvalidStoryListFile("The 'stories' element in the story list '{$filename}' must be an array");
+        }
+        if (count($tale->stories) == 0) {
+            throw new E4xx_InvalidStoryListFile("The 'stories' element in the story list '{$filename}' cannot be an empty array");
+        }
 
-		// our base directory to search from
-		$storiesBasedir = dirname($filename);
+        // our base directory to search from
+        $storiesBasedir = dirname($filename);
 
-		// do all of the stories in the list exist?
-		foreach ($tale->stories as $index => $storyFile) {
- 			$realStoryFile = $storiesBasedir . DIRECTORY_SEPARATOR . $storyFile;
-			if (file_exists($realStoryFile)) {
-				throw new E4xx_InvalidStoryListFile("Cannot find the story file '{$realStoryFile}' on disk");
-			}
-			$tale->stories[$index] = $realStoryFile;
-		}
+        // do all of the stories in the list exist?
+        foreach ($tale->stories as $index => $storyFile) {
+                $realStoryFile = $storiesBasedir . DIRECTORY_SEPARATOR . $storyFile;
+            if (file_exists($realStoryFile)) {
+                throw new E4xx_InvalidStoryListFile("Cannot find the story file '{$realStoryFile}' on disk");
+            }
+            $tale->stories[$index] = $realStoryFile;
+        }
 
-		// inject defaults for optional fields
-		if (!isset($tale->options)) {
-			$tale->options = new stdClass();
-		}
-		if (!isset($tale->options->reuseTestEnvironment)) {
-			$tale->options->reuseTestEnvironment = false;
-		}
+        // inject defaults for optional fields
+        if (!isset($tale->options)) {
+            $tale->options = new stdClass();
+        }
+        if (!isset($tale->options->reuseTestEnvironment)) {
+            $tale->options->reuseTestEnvironment = false;
+        }
 
-		// all done
-		return $tale;
-	}
+        // all done
+        return $tale;
+    }
 }
\ No newline at end of file

src/php/DataSift/Storyplayer/PlayerLib/TestEnvironment/Player.php

Braces +1 added lines, -2 removed lines

@@ -103,8 +103,7 @@
 
         // now we need to play whatever runs against this
         // test environment
-        foreach ($this->wrappedPlayers as $wrappedPlayer)
-        {
+        foreach ($this->wrappedPlayers as $wrappedPlayer) {
             // play the wrapped item
             //
             // this is normally a story

src/php/DataSift/Storyplayer/ProvisioningLib/Provisioners/AnsibleProvisioner.php

Indentation +2 added lines, -2 removed lines

@@ -175,8 +175,8 @@
 
         // build the command for Ansible
         $command = 'ansible-playbook -i "' . $inventoryFile . '"'
-                 . ' "--private-key=' . $sshKeyFile . '"'
-                 . ' "--user=' . $sshUsername . '"';
+                    . ' "--private-key=' . $sshKeyFile . '"'
+                    . ' "--user=' . $sshUsername . '"';
 
         $command .= ' "' . $ansibleSettings->dir . DIRECTORY_SEPARATOR . $ansibleSettings->playbook . '"';
 

Spacing +4 added lines, -4 removed lines

@@ -86,7 +86,7 @@ 
             if (isset($machine->params)) {
                 $params = [];
                 foreach ($machine->params as $paramName => $paramValue) {
-                    $params[$paramName] = fromConfig()->get('hosts.' . $hostId . '.params.'.$paramName);
+                    $params[$paramName] = fromConfig()->get('hosts.' . $hostId . '.params.' . $paramName);
                 }
                 if (count($params)) {
                     usingProvisioningDefinition($provDef)->addParams($params)->toHost($hostId);
@@ -111,7 +111,7 @@ 
         $rolesToHosts = array();
 
         // build up the list of roles
-        foreach($hosts as $hostId => $hostProps) {
+        foreach ($hosts as $hostId => $hostProps) {
             // what is the host's IP address?
             $ipAddress = fromHost($hostId)->getIpAddress();
 
@@ -154,7 +154,7 @@ 
         $sshKeyFile  = null;
 
         // now we need to write out the host files
-        foreach($hosts as $hostId => $hostProps) {
+        foreach ($hosts as $hostId => $hostProps) {
             // what is the host's IP address?
             $ipAddress   = fromHost($hostId)->getIpAddress();
             $sshUsername = fromHost($hostId)->getSshUsername();
@@ -236,7 +236,7 @@ 
         // does the target folder exist?
         $hostVarsFolder = dirname($filename);
         if (!file_exists($hostVarsFolder)) {
-            mkdir ($hostVarsFolder);
+            mkdir($hostVarsFolder);
         }
 
         // write the data

src/php/DataSift/Storyplayer/ProvisioningLib/Provisioners/DsbuildProvisioner.php

Spacing +8 added lines, -8 removed lines

@@ -88,7 +88,7 @@ 
             if (isset($machine->params)) {
                 $params = [];
                 foreach ($machine->params as $paramName => $paramValue) {
-                    $params[$paramName]  = fromConfig()->get('hosts.' . $hostId . '.params.'.$paramName);
+                    $params[$paramName] = fromConfig()->get('hosts.' . $hostId . '.params.' . $paramName);
                 }
                 if (count($params)) {
                     usingProvisioningDefinition($provDef)->addParams($params)->toHost($hostId);
@@ -110,7 +110,7 @@ 
         $dsbuildParams = new BaseObject;
 
         // build up the list of settings to write out
-        foreach($hosts as $hostId => $hostProps) {
+        foreach ($hosts as $hostId => $hostProps) {
             // what is the host's IP address?
             $ipAddress = fromHost($hostId)->getIpAddress();
 
@@ -132,7 +132,7 @@ 
         // at this point, we are ready to attempt provisioning
         //
         // provision each host in the order that they're listed
-        foreach($hosts as $hostId => $hostProps) {
+        foreach ($hosts as $hostId => $hostProps) {
             // which dsbuildfile are we going to run?
             $hostDir = fromHost($hostId)->getLocalFolder();
             $dsbuildFilename = $this->getDsbuildFilename($hostDir, $provConfig, $hostId);
@@ -148,11 +148,11 @@ 
             // copy the dsbuildparams files to the target machine using scp
             // NOTE: the "vagrant rsync" command seems not working with some Vagrant provisioners (e.g. OpenStack)
             $command = 'scp'
-                .' '.$dsbuildParams->{'hosts_'.$hostId.'_scpOptions_0'}
-                .' '.$dsbuildParams->{'hosts_'.$hostId.'_scpOptions_1'}
+                .' ' . $dsbuildParams->{'hosts_' . $hostId . '_scpOptions_0'}
+                .' ' . $dsbuildParams->{'hosts_' . $hostId . '_scpOptions_1'}
                 .' dsbuildparams.*'
-                .' '.$dsbuildParams->{'hosts_'.$hostId.'_sshUsername'}
-                .'@'.$dsbuildParams->{'hosts_'.$hostId.'_ipAddress'}
+                .' ' . $dsbuildParams->{'hosts_' . $hostId . '_sshUsername'}
+                .'@' . $dsbuildParams->{'hosts_' . $hostId . '_ipAddress'}
                 .':/vagrant/';
             $result = $commandRunner->runSilently($command);
 
@@ -229,7 +229,7 @@ 
      * @return array
      *         the flattened data
      */
-    protected function flattenData($inputData, $prefix="")
+    protected function flattenData($inputData, $prefix = "")
     {
         $retval = [];
 

Braces +1 added lines, -2 removed lines

@@ -233,8 +233,7 @@
     {
         $retval = [];
 
-        foreach ($inputData as $name => $dataToFlatten)
-        {
+        foreach ($inputData as $name => $dataToFlatten) {
             if (is_object($dataToFlatten) || is_array($dataToFlatten)) {
                 $retval = array_merge($retval, $this->flattenData($dataToFlatten, $prefix . $name . "_"));
             }

src/php/DataSift/Storyplayer/Reports/JUnitReport.php

Spacing +24 added lines, -24 removed lines

@@ -130,40 +130,40 @@ 
     public function endStoryplayer($duration)
     {
         // generate the XML
-        $junitxml = '<?xml version="1.0" encoding="UTF-8"?>'.PHP_EOL;
+        $junitxml = '<?xml version="1.0" encoding="UTF-8"?>' . PHP_EOL;
         $junitxml .= '<testsuite'
-            .' id="'.$this->testsuite['id'].'"'
-            .' name="'.$this->testsuite['name'].'"'
-            .' tests="'.$this->testsuite['tests'].'"'
-            .' disabled="'.$this->testsuite['disabled'].'"'
-            .' errors="'.$this->testsuite['errors'].'"'
-            .' failures="'.$this->testsuite['failures'].'"'
-            .' skipped="'.$this->testsuite['skipped'].'"'
-            .' time="'.round($duration, 6).'"'
-            .' timestamp="'.$this->testsuite['timestamp'].'">'.PHP_EOL;
+            .' id="' . $this->testsuite['id'] . '"'
+            .' name="' . $this->testsuite['name'] . '"'
+            .' tests="' . $this->testsuite['tests'] . '"'
+            .' disabled="' . $this->testsuite['disabled'] . '"'
+            .' errors="' . $this->testsuite['errors'] . '"'
+            .' failures="' . $this->testsuite['failures'] . '"'
+            .' skipped="' . $this->testsuite['skipped'] . '"'
+            .' time="' . round($duration, 6) . '"'
+            .' timestamp="' . $this->testsuite['timestamp'] . '">' . PHP_EOL;
 
         foreach ($this->testsuite['testcase'] as $testcase) {
-            $junitxml .= "\t".'<testcase'
-                .' name="'.$testcase['name'].'"'
-                .' assertions="'.$testcase['assertions'].'"'
-                .' classname="'.$testcase['classname'].'"'
-                .' status="'.$testcase['status'].'"'
-                .' time="'.round($testcase['time'], 6).'">'.PHP_EOL;
+            $junitxml .= "\t" . '<testcase'
+                .' name="' . $testcase['name'] . '"'
+                .' assertions="' . $testcase['assertions'] . '"'
+                .' classname="' . $testcase['classname'] . '"'
+                .' status="' . $testcase['status'] . '"'
+                .' time="' . round($testcase['time'], 6) . '">' . PHP_EOL;
 
             if ($testcase['skipped']) {
-                $junitxml .= "\t\t".'<skipped/>'.PHP_EOL;
+                $junitxml .= "\t\t" . '<skipped/>' . PHP_EOL;
             }
             if ($testcase['failure']) {
-                $junitxml .= "\t\t".'<failure/>'.PHP_EOL;
+                $junitxml .= "\t\t" . '<failure/>' . PHP_EOL;
             }
             if ($testcase['error']) {
-                $junitxml .= "\t\t".'<error/>'.PHP_EOL;
+                $junitxml .= "\t\t" . '<error/>' . PHP_EOL;
             }
 
-            $junitxml .= "\t".'</testcase>'.PHP_EOL;
+            $junitxml .= "\t" . '</testcase>' . PHP_EOL;
         }
 
-        $junitxml .= '</testsuite>'.PHP_EOL;
+        $junitxml .= '</testsuite>' . PHP_EOL;
 
         file_put_contents($this->filename, $junitxml);
     }
@@ -180,10 +180,10 @@ 
         $name = htmlspecialchars($name, ENT_QUOTES | ENT_XML1, 'UTF-8');
         $this->testcase = array(
             'name'       => $name,
-            'assertions' => 0,     // number of assertions in the test case
+            'assertions' => 0, // number of assertions in the test case
             'classname'  => $name, // full class name for the class the test method is in
-            'status'     => '',    // result status string
-            'time'       => 0,     // time taken (in seconds) to execute the test
+            'status'     => '', // result status string
+            'time'       => 0, // time taken (in seconds) to execute the test
             'skipped'    => false,
             'failure'    => false,
             'error'      => false,

src/php/DataSift/Storyplayer/Reports/JsonReport.php

Braces +2 added lines, -1 removed lines

@@ -100,7 +100,8 @@
         $this->silentActivity = true;
     }
 
-    public function __construct($args) {
+    public function __construct($args)
+    {
         if (isset($args['filename'])) {
             $this->filename = $args['filename'];
         }

src/php/DataSift/Storyplayer/TestEnvironmentsLib/HardCodedTestEnvironments.php

Spacing +2 added lines, -2 removed lines

@@ -71,14 +71,14 @@
     {
         // defaults for the local computer
         $rolesConfig = new BaseObject;
-        $rolesConfig->roles = [ '*' ];
+        $rolesConfig->roles = ['*'];
 
         $config = &$this->newConfig('localhost')->getConfig();
         $config->groups = new BaseObject;
         $config->groups->{'0'} = new BaseObject;
         $config->groups->{'0'}->type = "Blackboxes";
         $config->groups->{'0'}->details = new BaseObject;
-        $config->groups->{'0'}->details->machines = [ $rolesConfig ];
+        $config->groups->{'0'}->details->machines = [$rolesConfig];
 
         // all done
     }