MCLOUD-5532: Add Versioning to Env Variable Schema (magento#714)

Author: oshmyheliuk

config/schema.yaml

@@ -82,7 +82,7 @@ public function execute(InputInterface $input, OutputInterface $output)
     {
         $output->writeln('Starting schema dist file generation');
 
-        $data = $this->schema->getSchema();
+        $data = $this->schema->getVariables();
 
         $this->file->filePutContents(
             $this->fileList->getEnvDistConfig(),

src/Command/GenerateSchema.php

@@ -78,7 +78,7 @@ public function getDefaults(string $stage): array
             return $this->defaults[$stage];
         }
 
-        foreach ($this->getSchema() as $itemName => $itemOptions) {
+        foreach ($this->getVariables() as $itemName => $itemOptions) {
             if (array_key_exists($stage, $itemOptions[self::SCHEMA_DEFAULT_VALUE])) {
                 $this->defaults[$stage][$itemName] = $itemOptions[self::SCHEMA_DEFAULT_VALUE][$stage];
             }
@@ -88,7 +88,7 @@ public function getDefaults(string $stage): array
     }
 
     /**
-     * Returns configuration schema.
+     * Returns variables configuration.
      *
      * Each configuration item can have next options:
      * 'type' - possible types (string, integer, array, etc..)
@@ -99,11 +99,13 @@ public function getDefaults(string $stage): array
      * @return array
      * @throws \Magento\MagentoCloud\Filesystem\FileSystemException
      */
-    public function getSchema(): array
+    public function getVariables(): array
     {
-        return $this->parser->parse(
+        $schema = $this->parser->parse(
             $this->file->fileGetContents($this->systemList->getConfig() . '/schema.yaml'),
             Yaml::PARSE_CONSTANT
         );
+
+        return $schema['variables'] ?? [];
     }
 }

src/Config/Schema.php

@@ -61,7 +61,7 @@ public function __construct(
      */
     public function validate(string $key, string $stage, $value): ResultInterface
     {
-        $schema = $this->schema->getSchema();
+        $schema = $this->schema->getVariables();
         if (!isset($schema[$key])) {
             return $this->resultFactory->error(sprintf(
                 'The %s variable is not allowed in configuration.',

src/Config/Schema/Validator.php

@@ -68,7 +68,7 @@ public function get(string $name)
 
         $value = $decodedValue !== null && json_last_error() === JSON_ERROR_NONE ? $decodedValue : $value;
 
-        $schemaDetails = $this->schema->getSchema()[$name];
+        $schemaDetails = $this->schema->getVariables()[$name];
 
         if ($schemaDetails[Schema::SCHEMA_TYPE] === ['array'] && !is_array($value)) {
             $value = $schemaDetails[Schema::SCHEMA_DEFAULT_VALUE][StageConfigInterface::STAGE_DEPLOY];

src/Config/Stage/Deploy.php

@@ -58,7 +58,7 @@ public function validate(): Validator\ResultInterface
         try {
             $errors = [];
 
-            foreach ($this->schema->getSchema() as $optionName => $optionConfig) {
+            foreach ($this->schema->getVariables() as $optionName => $optionConfig) {
                 if ($optionConfig[Schema::SCHEMA_TYPE] !== ['array'] ||
                     !in_array(StageConfigInterface::STAGE_DEPLOY, $optionConfig[Schema::SCHEMA_STAGES]) ||
                     !is_string($this->mergedConfig->get()[$optionName])

src/Config/Validator/Deploy/JsonFormatVariable.php

@@ -73,7 +73,7 @@ public function testExecute(): void
         $output->expects($this->exactly(2))
             ->method('writeln');
 
-        $this->schemaMock->method('getSchema')
+        $this->schemaMock->method('getVariables')
             ->willReturn(['some' => 'schema']);
         $this->fileListMock->method('getEnvDistConfig')
             ->willReturn('.magento.env.md');

src/Test/Unit/Command/GenerateSchemaTest.php

@@ -120,7 +120,7 @@ public function testValidate(
             ->with('ErrorValidator', ['value1', 'value2'])
             ->willReturn($mockValidatorError);
         $this->schemaMock->expects($this->once())
-            ->method('getSchema')
+            ->method('getVariables')
             ->willReturn($schema);
 
         $this->assertEquals(

src/Test/Unit/Config/Schema/ValidatorTest.php

@@ -208,7 +208,7 @@ public function testGetSchemaItemsExists(): void
         ];
 
         foreach ($requiredItems as $item) {
-            $this->assertArrayHasKey($item, $this->schema->getSchema());
+            $this->assertArrayHasKey($item, $this->schema->getVariables());
         }
     }
 }

src/Test/Unit/Config/SchemaTest.php

@@ -66,11 +66,11 @@ public function testGet(string $name, $expectedValue, array $mergedConfig, array
 
         if ($schema !== null) {
             $this->schemaMock->expects($this->once())
-                ->method('getSchema')
+                ->method('getVariables')
                 ->willReturn($schema);
         } else {
             $this->schemaMock->expects($this->never())
-                ->method('getSchema');
+                ->method('getVariables');
         }
 
         $this->assertEquals($expectedValue, $this->deployConfig->get($name));