Merge pull request #11 from platformsh/local-vars

Improve error handling for missing property variables.

Author: chadwcarlson

src/Config.php

@@ -485,39 +485,26 @@ protected function decode($variable)
      */
     public function __get($property)
     {
-        $isBuildVar = in_array($property, array_keys($this->directVariables));
-        $isRuntimeVar = in_array($property, array_keys($this->directVariablesRuntime));
         // For now, all unprefixed variables are also runtime variables.  If that ever changes this
         // logic will change with it.
+        $isBuildVar = in_array($property, array_keys($this->directVariables));
+        $isRuntimeVar = in_array($property, array_keys($this->directVariablesRuntime));
         $isUnprefixedVar = in_array($property, array_keys($this->unPrefixedVariablesRuntime));
 
-        if ($this->inBuild() && $isRuntimeVar) {
-            throw new BuildTimeVariableAccessException(sprintf('The %s variable is not available during build time.', $property));
+        if (!($isBuildVar || $isUnprefixedVar || $isRuntimeVar)) {
+            throw new \InvalidArgumentException(sprintf('No such variable defined: %s', $property));
         }
 
-        if ($isBuildVar) {
-            $value = $this->getValue($this->directVariables[$property]);
-            if (is_null($value)) {
-                throw new NotValidPlatformException(sprintf('The %s variable is not defined. Are you sure you\'re running on Platform.sh?', $property));
-            }
-            return $value;
-        }
-        if ($isUnprefixedVar) {
-            $value = $this->environmentVariables[$this->unPrefixedVariablesRuntime[$property]] ?? null;
-            if (is_null($value)) {
-                throw new NotValidPlatformException(sprintf('The %s variable is not defined. Are you sure you\'re running on Platform.sh?', $property));
-            }
-            return $value;
-        }
-        if ($isRuntimeVar) {
-            $value = $this->getValue($this->directVariablesRuntime[$property]);
-            if (is_null($value)) {
-                throw new NotValidPlatformException(sprintf('The %s variable is not defined. Are you sure you\'re running on Platform.sh?', $property));
+        $value = $this->getPropertyValue($property);
+
+        if (is_null($value)) {
+            if ($this->inBuild() && !$isBuildVar) {
+                throw new BuildTimeVariableAccessException(sprintf('The %s variable is not available during build time.', $property));
             }
-            return $value;
+            throw new NotValidPlatformException(sprintf('The %s variable is not defined. Are you sure you\'re running on Platform.sh?', $property));
         }
 
-        throw new \InvalidArgumentException(sprintf('No such variable defined: %s', $property));
+        return $value;
     }
 
     /**
@@ -531,21 +518,40 @@ public function __get($property)
      */
     public function __isset($property)
     {
-        $isBuildVar = in_array($property, array_keys($this->directVariables));
-        $isRuntimeVar = in_array($property, array_keys($this->directVariablesRuntime));
+        $value = $this->getPropertyValue($property);
+
+        return !is_null($value);
+    }
+
+    /**
+     * Returns the value of a dynamic property, whatever it's configuration.
+     *
+     * @param string $property
+     *   The property value to get.
+     * @return string|null
+     */
+    protected function getPropertyValue(string $property) : ?string
+    {
         // For now, all unprefixed variables are also runtime variables.  If that ever changes this
         // logic will change with it.
+        $isBuildVar = in_array($property, array_keys($this->directVariables));
+        $isRuntimeVar = in_array($property, array_keys($this->directVariablesRuntime));
         $isUnprefixedVar = in_array($property, array_keys($this->unPrefixedVariablesRuntime));
 
-        if ($this->inBuild()) {
-            return $isBuildVar && !is_null($this->$property);
+        if ($isBuildVar) {
+            $value = $this->getValue($this->directVariables[$property]);
         }
-
-        if ($isBuildVar || $isRuntimeVar || $isUnprefixedVar) {
-            return !is_null($this->$property);
+        else if ($isUnprefixedVar) {
+            $value = $this->environmentVariables[$this->unPrefixedVariablesRuntime[$property]] ?? null;
+        }
+        else if ($isRuntimeVar) {
+            $value = $this->getValue($this->directVariablesRuntime[$property]);
+        }
+        else {
+            $value = null;
         }
 
-        return false;
+        return $value;
     }
 
     /**

tests/ConfigTest.php

@@ -324,6 +324,35 @@ public function test_build_and_deploy_properties_in_deploy_exists() : void
         $this->assertTrue(isset($config->socket));
     }
 
+    public function test_build_and_deploy_properties_mocked_in_local_exists() : void
+    {
+        $env = $this->mockEnvironmentDeploy;
+        unset($env['PLATFORM_APPLICATION'], $env['PLATFORM_ENVIRONMENT'], $env['PLATFORM_BRANCH']);
+        $config = new Config($env);
+
+        $this->assertEquals('/app', $config->appDir);
+        $this->assertEquals('app', $config->applicationName);
+        $this->assertEquals('test-project', $config->project);
+        $this->assertEquals('abc123', $config->treeId);
+        $this->assertEquals('def789', $config->projectEntropy);
+
+        $this->assertEquals('/app/web', $config->documentRoot);
+        $this->assertEquals('1.2.3.4', $config->smtpHost);
+        $this->assertEquals('8080', $config->port);
+        $this->assertEquals('unix://tmp/blah.sock', $config->socket);
+
+        $this->assertTrue(isset($config->appDir));
+        $this->assertTrue(isset($config->applicationName));
+        $this->assertTrue(isset($config->project));
+        $this->assertTrue(isset($config->treeId));
+        $this->assertTrue(isset($config->projectEntropy));
+
+        $this->assertTrue(isset($config->documentRoot));
+        $this->assertTrue(isset($config->smtpHost));
+        $this->assertTrue(isset($config->port));
+        $this->assertTrue(isset($config->socket));
+    }
+
     public function test_deploy_property_in_build_throws() : void
     {
         $this->expectException(BuildTimeVariableAccessException::class);