also made the parameters optional for updateVariable(), refactored …

…tests for `addVariable()`, added tests for `updateVariable()`
GitLabPHP · Sep 20, 2017 · cadc605 · cadc605
1 parent 2771dc9
commit cadc605
Show file tree

Hide file tree

Showing 2 changed files with 88 additions and 30 deletions.
diff --git a/lib/Gitlab/Api/Projects.php b/lib/Gitlab/Api/Projects.php
@@ -594,13 +594,21 @@ public function addVariable($project_id, $key, $value, $protected = null, $envir
      * @param string $environment_scope
      * @return mixed
      */
-    public function updateVariable($project_id, $key, $value, $protected = false, $environment_scope ="*")
+    public function updateVariable($project_id, $key, $value, $protected = null, $environment_scope = null)
     {
-        return $this->put($this->getProjectPath($project_id, 'variables/'.$this->encodePath($key)), array(
+        $payload = array(
             'value' => $value,
-//            'protected' => $protected,
-//            'environment_scope' => $environment_scope,
-        ));
+        );
+
+        if ($protected) {
+            $payload['protected'] = $protected;
+        }
+
+        if ($environment_scope) {
+            $payload['environment_scope'] = $environment_scope;
+        }
+
+        return $this->put($this->getProjectPath($project_id, 'variables/'.$this->encodePath($key)), $payload);
     }
 
     /**

diff --git a/test/Gitlab/Tests/Api/ProjectsTest.php b/test/Gitlab/Tests/Api/ProjectsTest.php
@@ -870,13 +870,9 @@ public function shouldAddVariable()
      */
     public function shouldAddVariableWithProtected()
     {
-        $expectedKey   = 'ftp_port';
-        $expectedValue = '21';
-        $expectedProtection = true;
-
         $expectedArray = array(
-            'key'   => $expectedKey,
-            'value' => $expectedValue,
+            'key'   => 'DEPLOY_SERVER',
+            'value' => 'stage.example.com',
             'protected' => true,
         );
 
@@ -887,23 +883,18 @@ public function shouldAddVariableWithProtected()
             ->will($this->returnValue($expectedArray))
         ;
 
-        $this->assertEquals($expectedArray, $api->addVariable(1, $expectedKey, $expectedValue, $expectedProtection));
+        $this->assertEquals($expectedArray, $api->addVariable(1, 'DEPLOY_SERVER', 'stage.example.com', true));
     }
 
     /**
      * @test
      */
     public function shouldAddVariableWithEnvironment()
     {
-        $expectedKey   = 'ftp_port';
-        $expectedValue = '21';
-        $expectedProtection = null;
-        $expectedEnvironment = 'production';
-
         $expectedArray = array(
-            'key'   => $expectedKey,
-            'value' => $expectedValue,
-            'environment_scope' => $expectedEnvironment,
+            'key'   => 'DEPLOY_SERVER',
+            'value' => 'stage.example.com',
+            'environment_scope' => 'staging',
         );
 
         $api = $this->getApiMock();
@@ -913,24 +904,19 @@ public function shouldAddVariableWithEnvironment()
             ->will($this->returnValue($expectedArray))
         ;
 
-        $this->assertEquals($expectedArray, $api->addVariable(1, $expectedKey, $expectedValue, $expectedProtection, $expectedEnvironment));
+        $this->assertEquals($expectedArray, $api->addVariable(1, 'DEPLOY_SERVER', 'stage.example.com', null, 'staging'));
     }
 
     /**
      * @test
      */
     public function shouldAddVariableWithProtectionAndEnvironment()
     {
-        $expectedKey   = 'ftp_port';
-        $expectedValue = '21';
-        $expectedProtection = true;
-        $expectedEnvironment = 'production';
-
         $expectedArray = array(
-            'key'   => $expectedKey,
-            'value' => $expectedValue,
+            'key'   => 'DEPLOY_SERVER',
+            'value' => 'stage.example.com',
             'protected' => true,
-            'environment_scope' => $expectedEnvironment,
+            'environment_scope' => 'staging',
         );
 
         $api = $this->getApiMock();
@@ -940,7 +926,7 @@ public function shouldAddVariableWithProtectionAndEnvironment()
             ->will($this->returnValue($expectedArray))
         ;
 
-        $this->assertEquals($expectedArray, $api->addVariable(1, $expectedKey, $expectedValue, $expectedProtection, $expectedEnvironment));
+        $this->assertEquals($expectedArray, $api->addVariable(1, 'DEPLOY_SERVER', 'stage.example.com', true, 'staging'));
     }
 
     /**
@@ -966,6 +952,70 @@ public function shouldUpdateVariable()
         $this->assertEquals($expectedArray, $api->updateVariable(1, $expectedKey, $expectedValue));
     }
 
+    /**
+     * @test
+     */
+    public function shouldUpdateVariableWithProtected()
+    {
+        $expectedArray = array(
+            'key'   => 'DEPLOY_SERVER',
+            'value' => 'stage.example.com',
+            'protected' => true,
+        );
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('put')
+            ->with('projects/1/variables/DEPLOY_SERVER', array('value' => 'stage.example.com', 'protected' => true))
+            ->will($this->returnValue($expectedArray))
+        ;
+
+        $this->assertEquals($expectedArray, $api->updateVariable(1, 'DEPLOY_SERVER', 'stage.example.com', true));
+    }
+
+    /**
+     * @test
+     */
+    public function shouldUpdateVariableWithEnvironment()
+    {
+        $expectedArray = array(
+            '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', array('value' => 'stage.example.com', 'environment_scope' => 'staging'))
+            ->will($this->returnValue($expectedArray))
+        ;
+
+        $this->assertEquals($expectedArray, $api->updateVariable(1, 'DEPLOY_SERVER', 'stage.example.com', null, 'staging'));
+    }
+
+    /**
+     * @test
+     */
+    public function shouldUpdateVariableWithProtectedAndEnvironment()
+    {
+        $expectedArray = array(
+            'key'   => 'DEPLOY_SERVER',
+            'value' => 'stage.example.com',
+            'protected' => true,
+            'environment_scope' => 'staging',
+        );
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('put')
+            ->with('projects/1/variables/DEPLOY_SERVER', array('value' => 'stage.example.com', 'protected' => true, 'environment_scope' => 'staging'))
+            ->will($this->returnValue($expectedArray))
+        ;
+
+        $this->assertEquals($expectedArray, $api->updateVariable(1, 'DEPLOY_SERVER', 'stage.example.com', true, 'staging'));
+    }
+
     /**
      * @test
      */