Merge pull request #34 from raphaelstolt/fix-evaluable-return-code

Exit with an evaluable return code

Author: Paul M. Jones

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 All notable changes to this publication will be documented in this file.
 
+## 1.0.1 - 2017-??-??
+The validate command returns an evaluable return code.
+
 ## 1.0.0 - 2017-25-01
 
 First stable release.

bin/pds-skeleton

@@ -22,4 +22,5 @@ if (! $autoload) {
 require $autoload;
 
 $console = new \Pds\Skeleton\Console();
-$console->execute($argv);
+$executeState = $console->execute($argv);
+$executeState === true ? exit(0) : exit(1);

src/ComplianceValidator.php

@@ -9,13 +9,19 @@ class ComplianceValidator
     const STATE_INCORRECT_PRESENT = 4;
 
     protected $files = null;
+    protected $compliant = true;
 
     public function execute($root = null)
     {
         $lines = $this->getFiles($root);
         $results = $this->validate($lines);
         $this->outputResults($results);
-        return true;
+        return $this->getCompliant();
+    }
+
+    public function getCompliant()
+    {
+        return $this->compliant;
     }
 
     public function validate($lines)
@@ -39,6 +45,11 @@ public function validate($lines)
             $state = $complianceResult[0];
             $expected = $complianceResult[1];
             $actual = $complianceResult[2];
+
+            if ($expected !== $actual && ($state == self::STATE_INCORRECT_PRESENT || $state == self::STATE_RECOMMENDED_NOT_PRESENT)) {
+                $this->compliant = false;
+            }
+
             $results[$expected] = [
                 'label' => $label,
                 'state' => $state,

tests/ComplianceValidatorTest.php

@@ -9,6 +9,8 @@ public static function run()
     {
         $tester = new ComplianceValidatorTest();
         $tester->testValidate_WithIncorrectBin_ReturnsIncorrectBin();
+        $tester->testValidate_WithNonCompliance_SetsNonCompliantState();
+        $tester->testValidate_WithCompliance_SetsCompliantState();
         echo __CLASS__ . " errors: {$tester->numErrors}" . PHP_EOL;
     }
 
@@ -51,4 +53,37 @@ public function testValidate_WithIncorrectBin_ReturnsIncorrectBin()
             }
         }
     }
-}
+
+    public function testValidate_WithNonCompliance_SetsNonCompliantState()
+    {
+        $paths = [
+            'cli/',
+            'test/',
+        ];
+
+        $validator = new ComplianceValidator();
+        $results = $validator->validate($paths);
+
+        if ($validator->getCompliant() == true) {
+            $this->numErrors++;
+            echo __FUNCTION__ . ": Expected a non compliant state" . PHP_EOL;
+        }
+    }
+
+    public function testValidate_WithCompliance_SetsCompliantState()
+    {
+        $paths = [
+            'bin/',
+            'tests/',
+            'LICENSE.md',
+        ];
+
+        $validator = new ComplianceValidator();
+        $results = $validator->validate($paths);
+
+        if ($validator->getCompliant() == false) {
+            $this->numErrors++;
+            echo __FUNCTION__ . ": Expected a compliant state" . PHP_EOL;
+        }
+    }
+}