Merge pull request #13 from sroze/file-to-propagate-and-only-if

Vote for the variable's requirement, instead of having a simple boolean
sroze · Feb 19, 2018 · 5d1986d · 5d1986d
2 parents 5222d47 + d3fc621
commit 5d1986d
Show file tree

Hide file tree

Showing 11 changed files with 80 additions and 30 deletions.
diff --git a/features/bootstrap/FeatureContext.php b/features/bootstrap/FeatureContext.php
@@ -31,12 +31,13 @@ public function theFileContains($path, PyStringNode $string)
 
     /**
      * @When I run the companion with the following answers:
+     * @When I run the companion
      */
-    public function iRunTheCompanionWithTheFollowingAnswers(TableNode $table)
+    public function iRunTheCompanionWithTheFollowingAnswers(TableNode $table = null)
     {
         $this->companion = new Companion(
             $this->fileSystem,
-            $this->interaction = new InMemoryInteraction($table->getRowsHash()),
+            $this->interaction = new InMemoryInteraction($table !== null ? $table->getRowsHash() : []),
             new Chained(Application::defaultExtensions())
         );
 
@@ -76,4 +77,19 @@ function_exists('xdiff_string_diff') ? xdiff_string_diff($expected, $found) : $f
             ));
         }
     }
+
+    /**
+     * @Then the companion's output should be empty
+     */
+    public function theCompanionsOutputShouldBeEmpty()
+    {
+        $found = strip_tags(trim($this->interaction->getBuffer()));
+
+        if (!empty($found)) {
+            throw new \RuntimeException(sprintf(
+                'Found the following instead: %s',
+                $found
+            ));
+        }
+    }
 }
diff --git a/features/extensions/file-to-propagate.feature b/features/extensions/file-to-propagate.feature
@@ -25,3 +25,21 @@ Feature:
     """
     SOMETHING
     """
+
+  Scenario: It does not consider the variable as missing if we it not included in the "only-if"
+    Given the file ".env.dist" contains:
+    """
+    ## Y'a know...
+    # This is a configuration.
+    #+file-to-propagate(GOOGLE_CLOUD_AUDIT_LOG_SERVICE_ACCOUNT_PATH)
+    #+only-if(GOOGLE_CLOUD_AUDIT_LOG_SERVICE_ACCOUNT_PATH):(GOOGLE_CLOUD_AUDIT_ENABLED=true)
+    GOOGLE_CLOUD_AUDIT_ENABLED=false
+    GOOGLE_CLOUD_AUDIT_LOG_SERVICE_ACCOUNT_PATH=/runtime/keys/google-cloud-audit-log.json
+    """
+    And the file ".env" contains:
+    """
+    GOOGLE_CLOUD_AUDIT_ENABLED=false
+    GOOGLE_CLOUD_AUDIT_LOG_SERVICE_ACCOUNT_PATH=/runtime/keys/google-cloud-audit-log.json
+    """
+    When I run the companion
+    Then the companion's output should be empty
diff --git a/src/Companienv/Companion.php b/src/Companienv/Companion.php
@@ -114,7 +114,7 @@ private function getVariablesRequiringValues()
             foreach ($block->getVariables() as $variable) {
                 $currentValue = isset($variablesInFile[$variable->getName()]) ? $variablesInFile[$variable->getName()] : null;
 
-                if ($this->extension->isVariableRequiringValue($this, $block, $variable, $currentValue)) {
+                if ($this->extension->isVariableRequiringValue($this, $block, $variable, $currentValue) === Extension::VARIABLE_REQUIRED) {
                     $missingVariables[$variable->getName()] = new MissingVariable($variable, $currentValue);
                 }
             }

diff --git a/src/Companienv/Extension.php b/src/Companienv/Extension.php
@@ -7,6 +7,10 @@
 
 interface Extension
 {
+    const VARIABLE_REQUIRED = 1;
+    const VARIABLE_SKIP = -1;
+    const ABSTAIN = 0;
+
     /**
      * Get the variable value, from a given source.
      *
@@ -23,14 +27,14 @@ public function getVariableValue(Companion $companion, Block $block, Variable $v
     /**
      * Is this variable requiring a new value?
      *
-     * Return true to make sure this variable will be asked for a refreshed value.
+     * The return value is one of the ABSTAINT, VARIABLE_REQUIRED or VARIABLE_SKIP constants.
      *
      * @param Companion $companion
      * @param Block $block
      * @param Variable $variable
      * @param string|null $currentValue
      *
-     * @return bool
+     * @return int
      */
-    public function isVariableRequiringValue(Companion $companion, Block $block, Variable $variable, string $currentValue = null);
+    public function isVariableRequiringValue(Companion $companion, Block $block, Variable $variable, string $currentValue = null) : int;
 }
diff --git a/src/Companienv/Extension/AbstractExtension.php b/src/Companienv/Extension/AbstractExtension.php
@@ -24,8 +24,8 @@ public function getVariableValue(Companion $companion, Block $block, Variable $v
     /**
      * {@inheritdoc}
      */
-    public function isVariableRequiringValue(Companion $companion, Block $block, Variable $variable, string $currentValue = null)
+    public function isVariableRequiringValue(Companion $companion, Block $block, Variable $variable, string $currentValue = null) : int
     {
-        return false;
+        return Extension::ABSTAIN;
     }
 }
diff --git a/src/Companienv/Extension/Chained.php b/src/Companienv/Extension/Chained.php
@@ -39,14 +39,14 @@ public function getVariableValue(Companion $companion, Block $block, Variable $v
     /**
      * {@inheritdoc}
      */
-    public function isVariableRequiringValue(Companion $companion, Block $block, Variable $variable, string $currentValue = null)
+    public function isVariableRequiringValue(Companion $companion, Block $block, Variable $variable, string $currentValue = null) : int
     {
         foreach ($this->extensions as $extension) {
-            if ($extension->isVariableRequiringValue($companion, $block, $variable, $currentValue)) {
-                return true;
+            if (($vote = $extension->isVariableRequiringValue($companion, $block, $variable, $currentValue)) != Extension::ABSTAIN) {
+                return $vote;
             }
         }
 
-        return false;
+        return Extension::ABSTAIN;
     }
 }
diff --git a/src/Companienv/Extension/FileToPropagate.php b/src/Companienv/Extension/FileToPropagate.php
@@ -44,12 +44,14 @@ public function getVariableValue(Companion $companion, Block $block, Variable $v
     /**
      * {@inheritdoc}
      */
-    public function isVariableRequiringValue(Companion $companion, Block $block, Variable $variable, string $currentValue = null)
+    public function isVariableRequiringValue(Companion $companion, Block $block, Variable $variable, string $currentValue = null) : int
     {
         if (null === ($attribute = $block->getAttribute('file-to-propagate', $variable))) {
-            return false;
+            return Extension::ABSTAIN;
         }
 
-        return !$companion->getFileSystem()->exists($variable->getValue());
+        return $companion->getFileSystem()->exists($variable->getValue())
+             ? Extension::VARIABLE_REQUIRED
+             : Extension::ABSTAIN;
     }
 }
diff --git a/src/Companienv/Extension/OnlyIf.php b/src/Companienv/Extension/OnlyIf.php
@@ -27,20 +27,22 @@ public function getVariableValue(Companion $companion, Block $block, Variable $v
     /**
      * {@inheritdoc}
      */
-    public function isVariableRequiringValue(Companion $companion, Block $block, Variable $variable, string $currentValue = null)
+    public function isVariableRequiringValue(Companion $companion, Block $block, Variable $variable, string $currentValue = null) : int
     {
         if (null === ($attribute = $block->getAttribute('only-if', $variable))) {
-            return false;
+            return Extension::ABSTAIN;
         }
 
-        return $this->matchesCondition($companion, $attribute);
+        return $this->matchesCondition($companion, $attribute)
+             ? Extension::ABSTAIN
+             : Extension::VARIABLE_SKIP;
     }
 
     private function matchesCondition(Companion $companion, Attribute $attribute) : bool
     {
         $definedVariablesHash = $companion->getDefinedVariablesHash();
         foreach ($attribute->getLabels() as $otherVariableName => $expectedValue) {
-            if (!isset($definedVariablesHash[$otherVariableName]) || $definedVariablesHash[$otherVariableName] != $expectedValue) {
+            if (isset($definedVariablesHash[$otherVariableName]) && $definedVariablesHash[$otherVariableName] != $expectedValue) {
                 return false;
             }
         }

diff --git a/src/Companienv/Extension/RsaKeys.php b/src/Companienv/Extension/RsaKeys.php
@@ -61,15 +61,18 @@ public function getVariableValue(Companion $companion, Block $block, Variable $v
     /**
      * {@inheritdoc}
      */
-    public function isVariableRequiringValue(Companion $companion, Block $block, Variable $variable, string $currentValue = null)
+    public function isVariableRequiringValue(Companion $companion, Block $block, Variable $variable, string $currentValue = null) : int
     {
         if (null === ($attribute = $block->getAttribute('rsa-pair', $variable))) {
-            return false;
+            return Extension::ABSTAIN;
         }
 
         $fileSystem = $companion->getFileSystem();
 
-        return !$fileSystem->exists($block->getVariable($attribute->getVariableNames()[0])->getValue())
-            || !$fileSystem->exists($block->getVariable($attribute->getVariableNames()[1])->getValue());
+        return (
+            !$fileSystem->exists($block->getVariable($attribute->getVariableNames()[0])->getValue())
+            || !$fileSystem->exists($block->getVariable($attribute->getVariableNames()[1])->getValue())
+        ) ? Extension::VARIABLE_REQUIRED
+          : Extension::ABSTAIN;
     }
 }
diff --git a/src/Companienv/Extension/SslCertificate.php b/src/Companienv/Extension/SslCertificate.php
@@ -64,15 +64,18 @@ public function getVariableValue(Companion $companion, Block $block, Variable $v
     /**
      * {@inheritdoc}
      */
-    public function isVariableRequiringValue(Companion $companion, Block $block, Variable $variable, string $currentValue = null)
+    public function isVariableRequiringValue(Companion $companion, Block $block, Variable $variable, string $currentValue = null) : int
     {
         if (null === ($attribute = $block->getAttribute('ssl-certificate', $variable))) {
             return false;
         }
 
         $fileSystem = $companion->getFileSystem();
 
-        return !$fileSystem->exists($block->getVariable($privateKeyVariableName = $attribute->getVariableNames()[0])->getValue())
-            || !$fileSystem->exists($block->getVariable($attribute->getVariableNames()[1])->getValue());
+        return (
+            !$fileSystem->exists($block->getVariable($privateKeyVariableName = $attribute->getVariableNames()[0])->getValue())
+            || !$fileSystem->exists($block->getVariable($attribute->getVariableNames()[1])->getValue())
+        ) ? Extension::VARIABLE_REQUIRED
+            : Extension::ABSTAIN;
     }
 }
diff --git a/src/Companienv/Interaction/AskVariableValues.php b/src/Companienv/Interaction/AskVariableValues.php
@@ -28,10 +28,12 @@ public function getVariableValue(Companion $companion, Block $block, Variable $v
     /**
      * {@inheritdoc}
      */
-    public function isVariableRequiringValue(Companion $companion, Block $block, Variable $variable, string $currentValue = null)
+    public function isVariableRequiringValue(Companion $companion, Block $block, Variable $variable, string $currentValue = null) : int
     {
-        return $currentValue === null || (
-            $currentValue === '' && $variable->getValue() !== ''
-        );
+        return (
+            $currentValue === null || (
+                $currentValue === '' && $variable->getValue() !== ''
+            )
+        ) ? Extension::VARIABLE_REQUIRED : Extension::ABSTAIN;
     }
 }