[10.2] Add $variable_type to addVariable and updateVariable (#596)

Author: pselge-daparto

src/Api/Projects.php

@@ -848,15 +848,19 @@ public function variable($project_id, string $key)
     }
 
     /**
-     * @param int|string  $project_id
-     * @param string      $key
-     * @param string      $value
-     * @param bool|null   $protected
-     * @param string|null $environment_scope
+     * @param int|string          $project_id
+     * @param string              $key
+     * @param string              $value
+     * @param bool|null           $protected
+     * @param string|null         $environment_scope
+     * @param array<string,mixed> $parameters        {
+     *
+     *      @var string $variable_type  env_var (default) or file
+     * }
      *
      * @return mixed
      */
-    public function addVariable($project_id, string $key, string $value, ?bool $protected = null, ?string $environment_scope = null)
+    public function addVariable($project_id, string $key, string $value, ?bool $protected = null, ?string $environment_scope = null, array $parameters = [])
     {
         $payload = [
             'key' => $key,
@@ -871,19 +875,25 @@ public function addVariable($project_id, string $key, string $value, ?bool $prot
             $payload['environment_scope'] = $environment_scope;
         }
 
+        $payload = \array_merge($parameters, $payload);
+
         return $this->post($this->getProjectPath($project_id, 'variables'), $payload);
     }
 
     /**
-     * @param int|string  $project_id
-     * @param string      $key
-     * @param string      $value
-     * @param bool|null   $protected
-     * @param string|null $environment_scope
+     * @param int|string          $project_id
+     * @param string              $key
+     * @param string              $value
+     * @param bool|null           $protected
+     * @param string|null         $environment_scope
+     * @param array<string,mixed> $parameters        {
+     *
+     *      @var string $variable_type  env_var (default) or file
+     *}
      *
      * @return mixed
      */
-    public function updateVariable($project_id, string $key, string $value, ?bool $protected = null, ?string $environment_scope = null)
+    public function updateVariable($project_id, string $key, string $value, ?bool $protected = null, ?string $environment_scope = null, array $parameters = [])
     {
         $payload = [
             'value' => $value,
@@ -897,6 +907,8 @@ public function updateVariable($project_id, string $key, string $value, ?bool $p
             $payload['environment_scope'] = $environment_scope;
         }
 
+        $payload = \array_merge($parameters, $payload);
+
         return $this->put($this->getProjectPath($project_id, 'variables/'.self::encodePath($key)), $payload);
     }
 

tests/Api/ProjectsTest.php

@@ -1609,6 +1609,53 @@ public function shouldAddVariableWithProtectionAndEnvironment(): void
         );
     }
 
+    /**
+     * @test
+     */
+    public function shouldAddVariableWithEnvironmentAndVariableType(): void
+    {
+        $expectedArray = [
+            'key' => 'DEPLOY_SERVER',
+            'value' => 'stage.example.com',
+            'environment_scope' => 'staging',
+            'variable_type' => 'file',
+        ];
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('post')
+            ->with('projects/1/variables', $expectedArray)
+            ->will($this->returnValue($expectedArray));
+
+        $this->assertEquals(
+            $expectedArray,
+            $api->addVariable(1, 'DEPLOY_SERVER', 'stage.example.com', null, 'staging', ['variable_type' => 'file'])
+        );
+    }
+
+    /**
+     * @test
+     */
+    public function shouldAddVariableWithEnvironmentFromParameterList(): void
+    {
+        $expectedArray = [
+            'key' => 'DEPLOY_SERVER',
+            'value' => 'stage.example.com',
+            'environment_scope' => 'staging',
+        ];
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('post')
+            ->with('projects/1/variables', $expectedArray)
+            ->will($this->returnValue($expectedArray));
+
+        $this->assertEquals(
+            $expectedArray,
+            $api->addVariable(1, 'DEPLOY_SERVER', 'stage.example.com', null, 'staging', ['environment_scope' => 'production'])
+        );
+    }
+
     /**
      * @test
      */
@@ -1704,6 +1751,59 @@ public function shouldUpdateVariableWithProtectedAndEnvironment(): void
         );
     }
 
+    /**
+     * @test
+     */
+    public function shouldUpdateVariableWithEnvironmentAndVariableType(): void
+    {
+        $expectedArray = [
+            'key' => 'DEPLOY_SERVER',
+            'value' => 'stage.example.com',
+            'environment_scope' => 'staging',
+            'variable_type' => 'file',
+        ];
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('put')
+            ->with(
+                'projects/1/variables/DEPLOY_SERVER',
+                ['value' => 'stage.example.com', 'environment_scope' => 'staging', 'variable_type' => 'file']
+            )
+            ->will($this->returnValue($expectedArray));
+
+        $this->assertEquals(
+            $expectedArray,
+            $api->updateVariable(1, 'DEPLOY_SERVER', 'stage.example.com', null, 'staging', ['variable_type' => 'file'])
+        );
+    }
+
+    /**
+     * @test
+     */
+    public function shouldUpdateVariableWithEnvironmentFromParameterList(): void
+    {
+        $expectedArray = [
+            'key' => 'DEPLOY_SERVER',
+            'value' => 'stage.example.com',
+            'environment_scope' => 'staging',
+        ];
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('put')
+            ->with(
+                'projects/1/variables/DEPLOY_SERVER',
+                ['value' => 'stage.example.com', 'environment_scope' => 'staging']
+            )
+            ->will($this->returnValue($expectedArray));
+
+        $this->assertEquals(
+            $expectedArray,
+            $api->updateVariable(1, 'DEPLOY_SERVER', 'stage.example.com', null, 'staging', ['environment_scope' => 'production'])
+        );
+    }
+
     /**
      * @test
      */