Skip to content

Add license check for group level compliance pipeline configuration

What does this MR do?

While Compliance frameworks is a Premium feature, forced includes is available to only Ultimate tier.

This MR updates the graphql api to allow the attribute pipelineConfigurationFullPath to be set only if the framework is in a namespace with Ultimate license.

API examples

Update API

Query:

mutation {
    updateComplianceFramework(input: {id: "gid://gitlab/ComplianceManagement::Framework/8"
      params: {
        pipelineConfigurationFullPath: ".compliance-gitlab-ci.yml@disney-org/compliance"
      }
    })
    {
      complianceFramework {
        id
        name
        color
        pipelineConfigurationFullPath
      },
      errors
    }
  }

Response:

{
  "data": {
    "updateComplianceFramework": {
      "complianceFramework": {
        "id": "gid://gitlab/ComplianceManagement::Framework/8",
        "name": "pci",
        "color": "#FFFFFF",
        "pipelineConfigurationFullPath": null
      },
      "errors": [
        "Pipeline configuration full path feature is not available"
      ]
    }
  }
}
Create API

Query:

mutation {
    createComplianceFramework(input: {namespacePath: "testgroup", params: {name: "compliance test", description: "this is a test framework", color: "#FFFFFF", pipelineConfigurationFullPath: "compliance/.gitlab-ci.yml"}}) {
      framework {
        id
        name
        color
        description
        pipelineConfigurationFullPath
      }
      errors
    }
  }

Response:

{
  "data": {
    "createComplianceFramework": {
      "framework": null,
      "errors": [
        "Pipeline configuration full path feature is not available"
      ]
    }
  }
}

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • The MR includes necessary changes to maintain consistency between UI, API, email, or other methods
  • Security reports checked/validated by a reviewer from the AppSec team
Edited by Aishwarya Subramanian

Merge request reports