Create GraphQL mutation to create/update/delete a policy
What does this MR do?
Addresses: #333383 (closed)
This MR introduces a new graphql mutation to create/update/delete a scan policy that is persisted in Scan Policy Project. This feature is still behind a feature flag (security_orchestration_policies_configuration
)
Setup Instructions
- Clone and create a project from https://gitlab.com/sashi_kumar/security-orchestration-policies
- Enable
security_orchestration_policies_configuration
for the target project for which the scan policies should be enabled for by doing:
Feature.enable(:security_orchestration_policies_configuration, Project.find(<target_project.id>))
- Go to
Security & Compliance
->Scan Policies
for the target project - Select the policy project (
security-orchestration-policies
) that was created in step 1 and click save
Mutation Sample
Mutation
mutation createPolicy{
scanExecutionPolicyCommit(input:{
projectPath:"root/rails-demo",
operationMode:REPLACE,
policyYaml: "name: INVALID\ntype: scan_execution_policy\ndescription: This policy enforces pipeline configuration to have a job with DAST scan\nenabled: true\nrules:\n- type: pipeline\n branches: \n - master\nactions:\n- scan: dast\n scanner_profile: Scanner Profile\n site_profile: Site Profile"
}) {
clientMutationId
branch
errors
}
}
Response
{
"data": {
"scanExecutionPolicyCommit": {
"clientMutationId": null,
"branch": "update-policy-1624288106",
"errors": []
}
}
}
Screenshots (strongly suggested)
Case | Screenshot |
---|---|
Append a policy | |
Append a policy with existing name | |
Replace a policy with existing name | |
Replace a policy with new name | |
Remove a policy with existing name | |
Remove a policy with new name |
Does this MR meet the acceptance criteria?
Conformity
-
I have included changelog trailers, or none are needed. (Does this MR need a changelog?) -
I have added/updated documentation, or it's not needed. (Is documentation required?) -
I have properly separated EE content from FOSS, or this MR is FOSS only. (Where should EE code go?) -
I have added information for database reviewers in the MR description, or it's not needed. (Does this MR have database related changes?) -
I have self-reviewed this MR per code review guidelines. -
This MR does not harm performance, or I have asked a reviewer to help assess the performance impact. (Merge request performance guidelines) -
I have followed the style guides. -
This change is backwards compatible across updates, or this does not apply.
Availability and Testing
-
I have added/updated tests following the Testing Guide, or it's not needed. (Consider all test levels. See the Test Planning Process.) -
I have tested this MR in all supported browsers, or it's not needed. -
I have informed the Infrastructure department of a default or new setting change per definition of done, or it's not needed.
Security
Does this MR contain changes to processing or storing of credentials or tokens, authorization and authentication methods or other items described in the security review guidelines? If not, then delete this Security section.
-
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 Sashi Kumar Kumaresan