aws codebuild integration (Checkmarx#4790)

Signed-off-by: joaorufi <[email protected]>
nikitakoselev · Feb 14, 2022 · f8870c8 · f8870c8
1 parent c6c24e7
commit f8870c8
Show file tree

Hide file tree

Showing 6 changed files with 56 additions and 17 deletions.
diff --git a/docs/img/codebuild-report-section.png b/docs/img/codebuild-report-section.png
diff --git a/docs/img/codebuild-report.png b/docs/img/codebuild-report.png
diff --git a/docs/img/codebuild-test-cases.png b/docs/img/codebuild-test-cases.png
diff --git a/docs/integrations.md b/docs/integrations.md
@@ -7,30 +7,31 @@ We provide plugins for some CI/CD tools. For some others we provide a tutorial o
 
 Integrate KICS with:
 
-- [Azure Pipelines](integrations_azurepipelines.md)
-- [Bamboo](integrations_bamboo.md)
-- [Bitbucket Pipelines](integrations_bitbucketpipelines.md)
-- [CircleCI](integrations_circleci.md)
-- [Github Actions](integrations_ghactions.md)
-- [GitLab CI](integrations_gitlabci.md)
-- [Jenkins](integrations_jenkins.md)
-- [TeamCity](integrations_teamcity.md)
-- [Travis](integrations_travisci.md)
-- [Pre-commit hooks](integrations_pre_commit.md)
-- [Terraform Cloud](integration_tfcloud.md)
-- [Terraformer](integrations_terraformer.md)
-- More soon...
+-   [Azure Pipelines](integrations_azurepipelines.md)
+-   [Bamboo](integrations_bamboo.md)
+-   [Bitbucket Pipelines](integrations_bitbucketpipelines.md)
+-   [CircleCI](integrations_circleci.md)
+-   [Github Actions](integrations_ghactions.md)
+-   [GitLab CI](integrations_gitlabci.md)
+-   [Jenkins](integrations_jenkins.md)
+-   [TeamCity](integrations_teamcity.md)
+-   [Travis](integrations_travisci.md)
+-   [Pre-commit hooks](integrations_pre_commit.md)
+-   [Terraform Cloud](integration_tfcloud.md)
+-   [Terraformer](integrations_terraformer.md)
+-   [AWS CodeBuild](integrations_aws_codebuild.md)
+-   More soon...
 
 The pipelines examples can be found in our [GitHub Repository](https://github.com/Checkmarx/kics/tree/master/examples)
 
 ### MegaLinter
 
 KICS is natively embedded in [MegaLinter](https://megalinter.github.io/), a 100% Open-Source tool for CI/CD workflows that analyzes consistency and quality of:
 
-- 48 languages
-- 22 formats
-- 20 tooling formats
-- excessive copy-pastes and spelling mistakes
+-   48 languages
+-   22 formats
+-   20 tooling formats
+-   excessive copy-pastes and spelling mistakes
 
 It also generates various reports, and can apply formatting and auto-fixes, to ensure all your projects sources are clean, whatever IDE/toolbox are used by their developers.
 

diff --git a/docs/integrations_aws_codebuild.md b/docs/integrations_aws_codebuild.md
@@ -0,0 +1,37 @@
+# Running KICS on AWS CodeBuild
+
+You can integrate KICS into your AWS CodeBuild workflows.
+
+This provides you the ability to run KICS scans to find vulnerabilities and misconfiguration checks to your infrastructure as code (IaC).
+
+## Example setup with GitHub
+
+Enable AWS CodeBuild to access your personal profile or GitHub organization.
+
+Create a `buildspec.yml` file on the root of your repository, for example:
+
+```yaml
+version: 0.2
+
+phases:
+    build:
+        commands:
+            - echo Starting Kics scan
+            - docker run -v $PWD:/path checkmarx/kics scan --no-progress --ignore-on-exit all -p /path -o /path --report-formats junit --output-name kics-report
+reports:
+    kics-report:
+        files:
+            - junit-kics-report.xml
+```
+
+After running the pipeline, you can see the logs and the reports section:
+
+<img src="https://raw.githubusercontent.com/Checkmarx/kics/master/docs/img/codebuild-report.png" width="850">
+
+Go to report section to see reports:
+
+<img src="https://raw.githubusercontent.com/Checkmarx/kics/master/docs/img/codebuild-report-section.png" width="850">
+
+Select the desired report to see the test cases:
+
+<img src="https://raw.githubusercontent.com/Checkmarx/kics/master/docs/img/codebuild-test-cases.png" width="850">
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -69,6 +69,7 @@ nav:
       - Travis CI: integrations_travisci.md
       - Terraform Cloud: integration_tfcloud.md
       - AWS CDK: cdk.md
+      - AWS CodeBuild: integrations_aws_codebuild.md
       - Badge: BADGE.md
       - Using pre-commit hooks: integrations_pre_commit.md
       - Terraformer: integrations_terraformer.md