[11.1] Added CI schedule variables endpoints (#569)

Co-authored-by: Graham Campbell <[email protected]>

Author: mgrundkoetter

src/Api/Schedules.php

@@ -70,4 +70,47 @@ public function remove($project_id, int $schedule_id)
     {
         return $this->delete($this->getProjectPath($project_id, 'pipeline_schedules/'.self::encodePath($schedule_id)));
     }
+
+    /**
+     * @param int|string $project_id
+     * @param int        $schedule_id
+     * @param array      $params
+     *
+     * @return mixed
+     */
+    public function addVariable($project_id, int $schedule_id, array $params)
+    {
+        $path = 'pipeline_schedules/'.self::encodePath($schedule_id).'/variables';
+
+        return $this->post($this->getProjectPath($project_id, $path), $params);
+    }
+
+    /**
+     * @param int|string $project_id
+     * @param int        $schedule_id
+     * @param string     $variable_key
+     * @param array      $params
+     *
+     * @return mixed
+     */
+    public function updateVariable($project_id, int $schedule_id, string $variable_key, array $params)
+    {
+        $path = 'pipeline_schedules/'.self::encodePath($schedule_id).'/variables/'.self::encodePath($variable_key);
+
+        return $this->put($this->getProjectPath($project_id, $path), $params);
+    }
+
+    /**
+     * @param int|string $project_id
+     * @param int        $schedule_id
+     * @param string     $variable_key
+     *
+     * @return mixed
+     */
+    public function removeVariable($project_id, int $schedule_id, string $variable_key)
+    {
+        $path = 'pipeline_schedules/'.self::encodePath($schedule_id).'/variables/'.self::encodePath($variable_key);
+
+        return $this->delete($this->getProjectPath($project_id, $path));
+    }
 }

tests/Api/ScheduleTest.php

@@ -135,6 +135,73 @@ public function shouldRemoveSchedule(): void
         $this->assertEquals($expectedBool, $api->remove(1, 2));
     }
 
+    /**
+     * @test
+     */
+    public function shouldCreateScheduleVariable(): void
+    {
+        $expectedArray = [
+            'key'           => 'FOO_BAR',
+            'variable_type' => 'env_var',
+            'value'         => 'BAZ',
+        ];
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('post')
+            ->with('projects/1/pipeline_schedules/2/variables', $expectedArray)
+            ->will($this->returnValue($expectedArray));
+
+        $this->assertEquals($expectedArray, $api->addVariable(
+            1,
+            2,
+            $expectedArray
+        ));
+    }
+
+    /**
+     * @test
+     */
+    public function shouldUpdateScheduleVariable(): void
+    {
+        $variabelName = 'FOO_BAR';
+        $expectedArray = [
+            'key'           => $variabelName,
+            'variable_type' => 'env_var',
+            'value'         => 'BAZ',
+        ];
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('put')
+            ->with('projects/1/pipeline_schedules/2/variables/' . $variabelName, $expectedArray)
+            ->will($this->returnValue($expectedArray));
+
+        $this->assertEquals($expectedArray, $api->updateVariable(
+            1,
+            2,
+            $variabelName,
+            $expectedArray
+        ));
+    }
+
+    /**
+     * @test
+     */
+    public function shouldRemoveScheduleVariable(): void
+    {
+        $expectedBool = true;
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('delete')
+            ->with('projects/1/pipeline_schedules/2/variables/FOO_BAR')
+            ->will($this->returnValue($expectedBool))
+        ;
+
+        $this->assertEquals($expectedBool, $api->removeVariable(1, 2, 'FOO_BAR'));
+    }
+
     protected function getApiClass()
     {
         return Schedules::class;