phmLabs / Smoke

src/Extensions/SmokeResponseRetriever/Retriever/Koalamon/Retriever.php

Doc Comments +5 added lines

@@ -42,6 +42,11 @@
         return json_decode($systems->getBody());
     }
 
+    /**
+     * @param string $url
+     *
+     * @return string
+     */
     private function prepareUrl($url)
     {
         $preparedUrl = str_replace("#project#", $this->project, $url);

src/Http/Response.php

Doc Comments +3 added lines

@@ -13,6 +13,9 @@
         return $this->getStatusCode();
     }
 
+    /**
+     * @return string
+     */
     public function getContentType()
     {
         $exploded = explode(';', $this->hasHeader('Content-Type') ? $this->getHeader('Content-Type')[0] : null);

src/Extensions/SmokeReporter/Reporter/KoalamonReporter.php

Doc Comments +4 added lines

@@ -159,6 +159,10 @@
         }
     }
 
+    /**
+     * @param string $identifier
+     * @param string $message
+     */
     public function send($identifier, $system, $message, $status, $url = '', $value = 0)
     {
         $event = new Event($identifier, $system, $status, $this->tool, $message, $value);

Spacing +16 added lines, -16 removed lines

@@ -95,7 +95,7 @@ 
 
     public function finish()
     {
-        $this->output->writeln('Sending results to ' . $this->server . " ... \n");
+        $this->output->writeln('Sending results to '.$this->server." ... \n");
 
         if ($this->groupBy === 'prefix') {
             $this->sendGroupedByPrefix();
@@ -126,7 +126,7 @@ 
 
         foreach ($this->getRuleKeys() as $rule) {
             foreach ($systems as $system) {
-                $identifier = $this->tool . '_' . $this->getPrefix($rule) . '_' . $system;
+                $identifier = $this->tool.'_'.$this->getPrefix($rule).'_'.$system;
                 $failureMessages[$identifier]['message'] = '';
                 $failureMessages[$identifier]['system'] = $system;
                 $failureMessages[$identifier]['tool'] = $this->getPrefix($rule);
@@ -143,15 +143,15 @@ 
                         $system = $this->retriever->getSystem(($result->getUrl()));
                     }
 
-                    $identifer = $this->tool . '_' . $this->getPrefix($ruleLKey) . '_' . $system;
+                    $identifer = $this->tool.'_'.$this->getPrefix($ruleLKey).'_'.$system;
 
                     if ($failureMessages[$identifer]['message'] === '') {
-                        $failureMessages[$identifer]['message'] = 'The ' . $this->getPrefix($ruleLKey) . ' test for #system_name# failed.<ul>';
+                        $failureMessages[$identifer]['message'] = 'The '.$this->getPrefix($ruleLKey).' test for #system_name# failed.<ul>';
                     }
                     ++$counter[$identifer];
-                    $message = '<li>' . $message . '<br>url: ' . $result->getUrl();
+                    $message = '<li>'.$message.'<br>url: '.$result->getUrl();
                     if ($this->addComingFrom) {
-                        $message .= ', coming from: ' . $this->retriever->getComingFrom($result->getUrl());
+                        $message .= ', coming from: '.$this->retriever->getComingFrom($result->getUrl());
                     }
                     $message .= '</li>';
                     $failureMessages[$identifer]['message'] .= $message;
@@ -161,9 +161,9 @@ 
 
         foreach ($failureMessages as $key => $failureMessage) {
             if ($failureMessage['message'] !== '') {
-                $this->send($this->identifier . '_' . $key, $failureMessage['system'], $failureMessage['message'] . '</ul>', self::STATUS_FAILURE, '', $counter[$key], $failureMessage['tool']);
+                $this->send($this->identifier.'_'.$key, $failureMessage['system'], $failureMessage['message'].'</ul>', self::STATUS_FAILURE, '', $counter[$key], $failureMessage['tool']);
             } else {
-                $this->send($this->identifier . '_' . $key, $failureMessage['system'], '', self::STATUS_SUCCESS, '', 0, $failureMessage['tool']);
+                $this->send($this->identifier.'_'.$key, $failureMessage['system'], '', self::STATUS_SUCCESS, '', 0, $failureMessage['tool']);
             }
         }
     }
@@ -175,7 +175,7 @@ 
             $failedTests = array();
             if ($result->isFailure()) {
                 foreach ($result->getMessages() as $ruleLKey => $message) {
-                    $identifier = 'smoke_' . $ruleLKey . '_' . $result->getUrl();
+                    $identifier = 'smoke_'.$ruleLKey.'_'.$result->getUrl();
 
                     if ($this->system === '') {
                         $system = str_replace('http://', '', $result->getUrl());
@@ -188,7 +188,7 @@ 
             }
             foreach ($rules as $rule) {
                 if (!in_array($rule, $failedTests, true)) {
-                    $identifier = 'smoke_' . $rule . '_' . $result->getUrl();
+                    $identifier = 'smoke_'.$rule.'_'.$result->getUrl();
 
                     if ($this->systemUseRetriever) {
                         $system = $this->retriever->getSystem($result->getUrl());
@@ -197,7 +197,7 @@ 
                     } else {
                         $system = $this->system;
                     }
-                    $this->send($identifier, $system, 'smoke_' . $rule . '_' . $result->getUrl(), self::STATUS_SUCCESS, (string) $result->getUrl());
+                    $this->send($identifier, $system, 'smoke_'.$rule.'_'.$result->getUrl(), self::STATUS_SUCCESS, (string) $result->getUrl());
                 }
             }
         }
@@ -221,17 +221,17 @@ 
                         $system = $this->retriever->getSystem(new Uri($result->getUrl()));
                     }
                     if ($failureMessages[$ruleLKey] === '') {
-                        $failureMessages[$ruleLKey]['message'] = '    The smoke test for #system_name# failed (Rule: ' . $ruleLKey . ').<ul>';
+                        $failureMessages[$ruleLKey]['message'] = '    The smoke test for #system_name# failed (Rule: '.$ruleLKey.').<ul>';
                     }
                     ++$counter[$ruleLKey];
 
                     $comingFrom = '';
 
                     if ($this->addComingFrom && $this->retriever->getComingFrom($result->getUrl())) {
-                        $comingFrom = ', coming from: ' . $this->retriever->getComingFrom($result->getUrl());
+                        $comingFrom = ', coming from: '.$this->retriever->getComingFrom($result->getUrl());
                     }
 
-                    $failureMessages[$ruleLKey]['message'] .= '<li>' . $message . ' (url: ' . $result->getUrl() . $comingFrom . ')</li > ';
+                    $failureMessages[$ruleLKey]['message'] .= '<li>'.$message.' (url: '.$result->getUrl().$comingFrom.')</li > ';
                     $failureMessages[$ruleLKey]['system'] = $system;
                 }
             }
@@ -239,9 +239,9 @@ 
 
         foreach ($failureMessages as $key => $failureMessage) {
             if ($failureMessage !== '') {
-                $this->send($this->identifier . '_' . $key, $this->system, $failureMessage['message'] . ' </ul > ', self::STATUS_FAILURE, '', $counter[$key]);
+                $this->send($this->identifier.'_'.$key, $this->system, $failureMessage['message'].' </ul > ', self::STATUS_FAILURE, '', $counter[$key]);
             } else {
-                $this->send($this->identifier . '_' . $key, $this->system, '', self::STATUS_SUCCESS, '', 0);
+                $this->send($this->identifier.'_'.$key, $this->system, '', self::STATUS_SUCCESS, '', 0);
             }
         }
     }

src/Rules/Html/RegExExistsRule.php

Doc Comments -1 removed lines

@@ -15,7 +15,6 @@
     protected $contentTypes = array('text/html');
 
     /**
-     * @param int $string The string that the document must contain
      */
     public function init(array $regExs)
     {

Spacing +5 added lines, -5 removed lines

@@ -29,12 +29,12 @@ 
 
         foreach ($this->regExs as $regEx) {
             if ($regEx['isRegEx']) {
-                if (preg_match('^' . $regEx['pattern'] . '^', (string) $response->getBody()) === 0) {
-                    $errors[] = 'Regular expression: ' . $regEx['pattern'];
+                if (preg_match('^'.$regEx['pattern'].'^', (string) $response->getBody()) === 0) {
+                    $errors[] = 'Regular expression: '.$regEx['pattern'];
                 }
             } else {
-                if (preg_match('^' . preg_quote($regEx['pattern']) . '^', (string) $response->getBody()) === 0) {
-                    $errors[] = 'Text: ' . $regEx['pattern'];
+                if (preg_match('^'.preg_quote($regEx['pattern']).'^', (string) $response->getBody()) === 0) {
+                    $errors[] = 'Text: '.$regEx['pattern'];
                 }
             }
         }
@@ -43,7 +43,7 @@ 
             $errorString = 'The following text elements where not found: <ul>';
 
             foreach ($errors as $error) {
-                $errorString .= '<li>' . $error . '</li>';
+                $errorString .= '<li>'.$error.'</li>';
             }
 
             $errorString .= '</ul>';

src/Yaml/EnvAwareYaml.php

Spacing +2 added lines, -2 removed lines

@@ -11,10 +11,10 @@
         preg_match_all('^\${(.*)}^', $fileContent, $matches);
         foreach ($matches[1] as $varName) {
             if (!getenv($varName)) {
-                throw new \RuntimeException('The mandatory env variable (' . $varName . ') from the config file was not set.');
+                throw new \RuntimeException('The mandatory env variable ('.$varName.') from the config file was not set.');
             }
 
-            $fileContent = str_replace('${' . $varName . '}', getenv($varName), $fileContent);
+            $fileContent = str_replace('${'.$varName.'}', getenv($varName), $fileContent);
         }
 
         return Yaml::parse($fileContent);

src/Rules/Js/SyntaxRule.php

Spacing +5 added lines, -5 removed lines

@@ -30,18 +30,18 @@
             return;
         }
 
-        $filename = $this->tmpDir . DIRECTORY_SEPARATOR . md5($response->getBody()) . '.js';
+        $filename = $this->tmpDir.DIRECTORY_SEPARATOR.md5($response->getBody()).'.js';
         file_put_contents($filename, $response->getBody());
-        $conf = __DIR__ . DIRECTORY_SEPARATOR . 'jsHint.conf';
+        $conf = __DIR__.DIRECTORY_SEPARATOR.'jsHint.conf';
 
-        $command = $this->jsHintExecutable . ' --config ' . $conf . ' --verbose ' . $filename . ' | grep -E E[0-9]+.$';
+        $command = $this->jsHintExecutable.' --config '.$conf.' --verbose '.$filename.' | grep -E E[0-9]+.$';
         $validationResult = shell_exec($command);
 
         unlink($filename);
 
         if (!is_null($validationResult)) {
-            $errorMsg = str_replace($filename . ':', '', $validationResult);
-            throw new ValidationFailedException('JavaScript error found: ' . $errorMsg);
+            $errorMsg = str_replace($filename.':', '', $validationResult);
+            throw new ValidationFailedException('JavaScript error found: '.$errorMsg);
         }
     }
 }

src/Rules/Http/Header/SuccessStatusRule.php

Spacing +1 added lines, -1 removed lines

@@ -21,7 +21,7 @@
     public function validate(Response $response)
     {
         if ($response->getStatus() > $this->maxStatusCode) {
-            throw new ValidationFailedException('Status code ' . $response->getStatus() . ' found.');
+            throw new ValidationFailedException('Status code '.$response->getStatus().' found.');
         }
     }
 }

src/Rules/Http/Header/HttpStatusRule.php

Spacing +1 added lines, -1 removed lines

@@ -25,7 +25,7 @@
     public function validate(Response $response)
     {
         if ($response->getStatus() !== $this->expectedStatus) {
-            throw new ValidationFailedException('Status code ' . $response->getStatus() . ' found, ' . $this->expectedStatus . ' expected.');
+            throw new ValidationFailedException('Status code '.$response->getStatus().' found, '.$this->expectedStatus.' expected.');
         }
     }
 }

src/Rules/Html/SizeRule.php

Spacing +1 added lines, -1 removed lines

@@ -26,6 +26,6 @@
     protected function doValidation(Response $response)
     {
         $size = strlen($response->getBody()) / 1000;
-        $this->assert($size <= $this->maxSize, 'The size of this html file is too big (' . $size . ' KB)');
+        $this->assert($size <= $this->maxSize, 'The size of this html file is too big ('.$size.' KB)');
     }
 }