Git lab add trigger pipeline command

Packs/GitLab/Integrations/GitLabv2/GitLabv2.yml

@@ -13,6 +13,12 @@ configuration:
   hiddenusername: true
   required: true
   type: 9
+- displaypassword: Trigger Token
+  additionalinfo: The trigger token to run pipelines. For more info see https://docs.gitlab.com/ee/ci/triggers
+  name: trigger_token
+  hiddenusername: true
+  required: false
+  type: 9
 - display: Project ID
   additionalinfo: The project ID, it can be found under the project name.
   name: project_id
@@ -3258,6 +3264,80 @@ script:
     - contextPath: GitLab.Artifact.artifact_data
       description: Data of the artifact requested.
       type: String
+  - name: gitlab-trigger-pipeline
+    arguments:
+    - default: false
+      description: Project ID on which to run the pipeline.
+      isArray: false
+      name: project_id
+      required: false
+      secret: false
+    - default: false
+      description: The branch on which to run the pipeline. Default is 'master'.
+      isArray: false
+      name: ref_branch
+      required: false
+      secret: false
+    - default: false
+      description: JSON containing the pipeline variables.
+      isArray: false
+      name: trigger_variables
+      required: false
+      secret: false
+    description: Triggers a GitLab pipeline on a selected project and branch.
+    execution: false
+    outputs:
+    - contextPath: GitLab.Pipeline.id
+      description: Pipeline ID.
+      type: Number
+    - contextPath: GitLab.Pipeline.project_id
+      description: Project ID that the pipeline belongs to.
+      type: Number
+    - contextPath: GitLab.Pipeline.status
+      description: Status of the pipeline.
+      type: String
+    - contextPath: GitLab.Pipeline.ref
+      description: Reference of the pipeline.
+      type: String
+    - contextPath: GitLab.Pipeline.sha
+      description: SHA of the pipeline.
+      type: String
+    - contextPath: GitLab.Pipeline.created_at
+      description: Time when the pipeline was created.
+      type: Date
+    - contextPath: GitLab.Pipeline.updated_at
+      description: Time when the pipeline was last updated.
+      type: Date
+    - contextPath: GitLab.Pipeline.started_at
+      description: Time when the pipeline was started.
+      type: Date
+    - contextPath: GitLab.Pipeline.finished_at
+      description: Time when the pipeline was finished.
+      type: Date
+    - contextPath: GitLab.Pipeline.duration
+      description: Duration of the pipeline in seconds.
+      type: Number
+    - contextPath: GitLab.Pipeline.web_url
+      description: Web URL of the pipeline.
+      type: String
+    - contextPath: GitLab.Pipeline.user.name
+      description: Name of the user who triggered the pipeline.
+      type: String
+    - contextPath: GitLab.Pipeline.user.username
+      description: Username that triggered the pipeline.
+      type: String
+    - contextPath: GitLab.Pipeline.user.id
+      description: ID of the user who triggered the pipeline.
+      type: Number
+    - contextPath: GitLab.Pipeline.user.state
+      description: State of the user who triggered the pipeline.
+      type: String
+    - contextPath: GitLab.Pipeline.user.avatar_url
+      description: Avatar URL of the user who triggered the pipeline.
+      type: String
+    - contextPath: GitLab.Pipeline.user.web_url
+      description: Web URL of the user who triggered the pipeline.
+      type: String
   runonce: false
   script: '-'
   type: python

Packs/GitLab/Integrations/GitLabv2/GitLabv2_test.py

@@ -1,12 +1,10 @@
-import io
 import json
-from typing import Dict, List
 import pytest
 from freezegun import freeze_time
 
 
 def util_load_json(path):
-    with io.open(path, mode='r', encoding='utf-8') as f:
+    with open(path, encoding='utf-8') as f:
         return json.loads(f.read())
 
 
@@ -769,7 +767,7 @@ def test_gitlab_pipelines_schedules_list_command(mocker):
                     headers={'PRIVATE-TOKEN': 'api_key'})
     response_client = util_load_json('test_data/commands_test_data.json').get('pipeline_schedule')
     args = {"project_id": 1}
-    expected_outputs: List[Dict] = response_client['expected_outputs']
+    expected_outputs: list[dict] = response_client['expected_outputs']
     expected_prefix: str = response_client['expected_prefix']
     expected_key_field: str = response_client['expected_key_field']
     mocker.patch.object(Client, '_http_request', return_value=response_client['mock_response'])
@@ -796,7 +794,7 @@ def test_gitlab_pipelines_list_command(mocker):
                     headers={'PRIVATE-TOKEN': 'api_key'})
     response_client = util_load_json('test_data/commands_test_data.json').get('pipeline')
     args = {"project_id": "3"}
-    expected_outputs: List[Dict] = response_client['expected_outputs']
+    expected_outputs: list[dict] = response_client['expected_outputs']
     expected_prefix: str = response_client['expected_prefix']
     expected_key_field: str = response_client['expected_key_field']
     mocker.patch.object(Client, '_http_request', return_value=response_client['mock_response'])
@@ -826,7 +824,7 @@ def test_gitlab_jobs_list_command(mocker):
         "project_id": "4",
         "pipeline_id": "12"
     }
-    expected_outputs: List[Dict] = response_client['expected_outputs']
+    expected_outputs: list[dict] = response_client['expected_outputs']
     expected_prefix: str = response_client['expected_prefix']
     expected_key_field: str = response_client['expected_key_field']
     mocker.patch.object(Client, '_http_request', return_value=response_client['mock_response'])
@@ -856,7 +854,7 @@ def test_gitlab_artifact_get_command(mocker):
         "project_id": "45",
         "job_id": "32",
         "artifact_path_suffix": "artifacts/failed_tests.txt"}
-    expected_outputs: List[Dict] = response_client['expected_outputs']
+    expected_outputs: list[dict] = response_client['expected_outputs']
     expected_prefix: str = response_client['expected_prefix']
     expected_key_field: str = response_client['expected_key_field']
     mocker.patch.object(Client, '_http_request', return_value=response_client['mock_response'])
@@ -986,3 +984,46 @@ def test_return_date_arg_as_iso(arg, isValidDate, expected_response):
             return_date_arg_as_iso(arg)
 
         assert str(e.value) == expected_response
+
+
+@pytest.mark.parametrize('trigger_token, args, expected_result', [
+    ('', {}, util_load_json('test_data/commands_test_data.json').get('trigger_pipeline1')),
+    (1111, {'project_id': 2222, 'ref_branch': 'test'},
+     util_load_json('test_data/commands_test_data.json').get('trigger_pipeline2'))
+])
+def test_trigger_pipeline(mocker, trigger_token, args, expected_result):
+    """
+    Given:
+        - client and demisto args
+            - case 1 - client without trigger token.
+            - case 2 - client with trigger token and args with a different project ID than the instance.
+    When:
+        - gitlab_trigger_pipeline_command
+    Then:
+        - The response is as expected
+            - case 1 - Throws an error about the trigger token that is missing
+            - case 2 - The response is correct with the same branch and project_id as in the args.
+    """
+    from GitLabv2 import Client, gitlab_trigger_pipeline_command
+    client = Client(project_id=1234,
+                    base_url="base_url",
+                    verify=False,
+                    proxy=False,
+                    headers={'PRIVATE-TOKEN': 'api_key'},
+                    trigger_token=trigger_token)
+    expected_outputs: list[dict] = expected_result['expected_outputs']
+    expected_prefix: str = expected_result['expected_prefix']
+    expected_key_field: str = expected_result['expected_key_field']
+    mocker.patch.object(Client, '_http_request', return_value=expected_result['mock_response'])
+    mock_error = mocker.patch('GitLabv2.return_error')
+
+    command_result = gitlab_trigger_pipeline_command(client, args)
+
+    if not trigger_token:
+        assert mock_error.call_args[0][0] == 'A trigger token is required in the integration instance configuration'
+    else:
+        assert command_result.outputs_prefix == expected_prefix
+        assert command_result.outputs_key_field == expected_key_field
+        assert command_result.outputs == expected_outputs
+        assert command_result.outputs.get('ref') == args.get('ref_branch')
+        assert command_result.outputs.get('project_id') == args.get('project_id')

Packs/GitLab/Integrations/GitLabv2/README.md

@@ -16,6 +16,7 @@ This integration enables you to:
 - Get a list of files in the GitLab project.
 - Get the contents and details of a file in GitLab.
 - Search for code in the GitLab project.
+- Trigger a pipeline in the GitLab project.
 
 #### Create a Personal Access Token 
 Personal access tokens (PATs) are an alternative to using passwords for authentication to GitLab when using the GitLab API. 
@@ -28,6 +29,22 @@ To generate a new token:
 6. Select the **scopes**, or **permissions**, you want to grant this token. The minimum is read-only on repo.
 7. Click **Create personal access token** and copy the api key generated.-+
 
+#### Create a Trigger Token
+Trigger tokens allow you to trigger a pipeline for a branch using it to authenticate on an API call.
+
+**Prerequisite:**
+
+You must have at least the Maintainer role for the project.
+
+**To generate a new token:**
+
+1. Navigate to your project.
+2. Select **Settings** > **CI/CD**.
+3. Expand Pipeline triggers.
+4. Enter a description and select **Add trigger**.
+   - You can view and copy the full token for all triggers you have created.
+   - You can only see the first 4 characters for tokens created by other project members.
+
 #### Get Project ID
 1. Go to the desired project example gitlab.com/username/project1.
 2. Under the project name get the argument project_id
@@ -42,6 +59,7 @@ To generate a new token:
     | --- | --- | --- |
     | Server URL (e.g. https://gitlab.com/api/v4) |  | False |
     | API Key | The API Key to use for connection | True |
+    | Trigger Token | The trigger token to run pipelines | False |
     | Project ID |  | True |
     | Trust any certificate (not secure) |  | False |
     | Use system proxy settings |  | False |
@@ -2144,3 +2162,42 @@ Gets an artifact from a given artifact path, corresponding to a given job ID.
 | GitLab.Artifact.job_id | String | Job ID from which the artifact was taken. | 
 | GitLab.Artifact.artifact_path_suffix | String | Suffix of the given artifact path. | 
 | GitLab.Artifact.artifact_data | String | Data of the artifact requested. | 
+
+### gitlab-trigger-pipeline
+
+***
+Triggers a GitLab pipeline on a selected project and branch.
+
+#### Base Command
+
+`gitlab-trigger-pipeline`
+
+#### Input
+
+| **Argument Name** | **Description** | **Required** |
+| --- | --- | --- |
+| project_id | Project ID on which to run the pipeline. | Optional | 
+| ref_branch | The branch on which to run the pipeline. Default is 'master'. | Optional | 
+| trigger_variables | JSON containing the pipeline variables. | Optional | 
+
+#### Context Output
+
+| **Path** | **Type** | **Description** |
+| --- | --- | --- |
+| GitLab.Pipeline.id | Number | Pipeline ID. | 
+| GitLab.Pipeline.project_id | Number | Project ID that the pipeline belongs to. | 
+| GitLab.Pipeline.status | String | Status of the pipeline. | 
+| GitLab.Pipeline.ref | String | Reference of the pipeline. | 
+| GitLab.Pipeline.sha | String | SHA of the pipeline. | 
+| GitLab.Pipeline.created_at | Date | Time when the pipeline was created. | 
+| GitLab.Pipeline.updated_at | Date | Time when the pipeline was last updated. | 
+| GitLab.Pipeline.started_at | Date | Time when the pipeline was started. | 
+| GitLab.Pipeline.finished_at | Date | Time when the pipeline was finished. | 
+| GitLab.Pipeline.duration | Number | Duration of the pipeline in seconds. | 
+| GitLab.Pipeline.web_url | String | Web URL of the pipeline. | 
+| GitLab.Pipeline.user.name | String | Name of the user who triggered the pipeline. | 
+| GitLab.Pipeline.user.username | String | Username that triggered the pipeline. | 
+| GitLab.Pipeline.user.id | Number | ID of the user who triggered the pipeline. | 
+| GitLab.Pipeline.user.state | String | State of the user who triggered the pipeline. | 
+| GitLab.Pipeline.user.avatar_url | String | Avatar URL of the user who trigerred the pipeline. | 
+| GitLab.Pipeline.user.web_url | String | Web URL of the user who triggered the pipeline. | 

Packs/GitLab/Integrations/GitLabv2/test_data/commands_test_data.json

@@ -1193,5 +1193,55 @@
     "expected_prefix": "GitLab.PipelineSchedule",
     "expected_url_mock_suffix": "projects/1/pipeline_schedules",
     "expected_key_field": "id"
+  },
+  "trigger_pipeline1": {
+    "mock_response": {
+        "id": 1,
+        "project_id": 1234,
+        "sha": "skd5h31245ljkasl4kj45l324",
+        "ref": "master",
+        "status": "running",
+        "created_at": "2021-06-15T14:31:29.607Z",
+        "updated_at": "2021-06-15T14:31:32.964Z",
+        "web_url": "https://server_url/project/-/pipelines/1"
+    },
+    "expected_outputs": {
+        "id": 1,
+        "project_id": 1234,
+        "sha": "skd5h31245ljkasl4kj45l324",
+        "ref": "master",
+        "status": "running",
+        "created_at": "2021-06-15T14:31:29.607Z",
+        "updated_at": "2021-06-15T14:31:32.964Z",
+        "web_url": "https://server_url/project/-/pipelines/1"
+    },
+    "expected_prefix": "GitLab.Pipeline",
+    "expected_url_mock_suffix": "projects/1234/pipelines",
+    "expected_key_field": "id"
+  },
+  "trigger_pipeline2": {
+    "mock_response": {
+        "id": 1,
+        "project_id": 2222,
+        "sha": "skd5h31245ljkasl4kj45l324",
+        "ref": "test",
+        "status": "running",
+        "created_at": "2021-06-15T14:31:29.607Z",
+        "updated_at": "2021-06-15T14:31:32.964Z",
+        "web_url": "https://server_url/project/-/pipelines/1"
+    },
+    "expected_outputs": {
+        "id": 1,
+        "project_id": 2222,
+        "sha": "skd5h31245ljkasl4kj45l324",
+        "ref": "test",
+        "status": "running",
+        "created_at": "2021-06-15T14:31:29.607Z",
+        "updated_at": "2021-06-15T14:31:32.964Z",
+        "web_url": "https://server_url/project/-/pipelines/1"
+    },
+    "expected_prefix": "GitLab.Pipeline",
+    "expected_url_mock_suffix": "projects/2222/pipelines",
+    "expected_key_field": "id"
   }
 }

Packs/GitLab/ReleaseNotes/2_2_11.md

@@ -0,0 +1,4 @@
+
+#### Integrations
+##### GitLab v2
+Added the new ***gitlab-trigger-pipeline*** command to trigger a GitLab pipeline.

Packs/GitLab/pack_metadata.json

@@ -2,7 +2,7 @@
     "name": "GitLab",
     "description": "Pack for handling gitlab operations",
     "support": "xsoar",
-    "currentVersion": "2.2.10",
+    "currentVersion": "2.2.11",
     "author": "Cortex XSOAR",
     "url": "https://www.paloaltonetworks.com/cortex",
     "email": "",

Tests/conf.json

@@ -4366,7 +4366,8 @@
         {
             "playbookID": "Test-GitLab-v2",
             "fromversion": "6.5.0",
-            "integrations": "GitLabv2"
+            "integrations": "GitLabv2",
+            "is_mockable": false
         },
         {
             "playbookID": "LGTM-test-playbook",