<!-- The first section "Release notes" is required if you want to have your release post blog MR auto generated. Currently in BETA, details on the **release post item generator** can be found in the handbook: https://about.gitlab.com/handbook/marketing/blog/release-posts/#release-post-item-generator and this video: https://www.youtube.com/watch?v=rfn9ebgTwKg. The next four sections: "Problem to solve", "Intended users", "User experience goal", and "Proposal", are strongly recommended in your first draft, while the rest of the sections can be filled out during the problem validation or breakdown phase. However, keep in mind that providing complete and relevant information early helps our product team validate the problem and start working on a solution. --> ### Release notes <!-- What is the problem and solution you're proposing? This content sets the overall vision for the feature and serves as the release notes that will populate in various places, including the [release post blog](https://about.gitlab.com/releases/categories/releases/) and [Gitlab project releases](https://gitlab.com/gitlab-org/gitlab/-/releases). " --> ### Problem to solve As a user of Dependency Scanning, I want the dependency graph exports created by gemnasium-maven and gemnasium-python to be uploaded as CI job artifacts when the scanning job fails, so that I can investigate and report the issue. ~~Also, I want these graph exports to be available when running Dependency Scanning in debug mode, so that I can investigate unexpected results in GitLab UI (Dependency List, Vulnerability Report, etc.) or in the Dependency Scanning report.~~ As developer of Gemnasium, or as a support engineering at GitLab, I also want these graph exports to be easily accessible to users experiencing problems with gemnasium-maven and gemnasium-python, so that I can directly help them without asking them to tweak their CI config file and trigger a new pipeline. ### Intended users <!-- Who will use this feature? If known, include any of the following: types of users (e.g. Developer), personas, or specific company roles (e.g. Release Manager). It's okay to write "Unknown" and fill this field in later. Personas are described at https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/ * [Cameron (Compliance Manager)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#cameron-compliance-manager) * [Parker (Product Manager)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#parker-product-manager) * [Delaney (Development Team Lead)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#delaney-development-team-lead) * [Presley (Product Designer)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#presley-product-designer) * [Sasha (Software Developer)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#sasha-software-developer) * [Devon (DevOps Engineer)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#devon-devops-engineer) * [Sidney (Systems Administrator)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#sidney-systems-administrator) * [Sam (Security Analyst)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#sam-security-analyst) * [Rachel (Release Manager)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#rachel-release-manager) * [Alex (Security Operations Engineer)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#alex-security-operations-engineer) * [Simone (Software Engineer in Test)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#simone-software-engineer-in-test) * [Allison (Application Ops)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#allison-application-ops) * [Priyanka (Platform Engineer)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#priyanka-platform-engineer) * [Dana (Data Analyst)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#dana-data-analyst) * [Eddie (Content Editor)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#eddie-content-editor) --> ### User experience goal As a user, I notice that a Dependency Scanning job has failed in my project pipeline. I then `Browse` the artifacts of the failing job, and download a graph export generated by gemnasium-maven or gemnasium-python. I can attach this graph export to a bug issue I create on GitLab, or to a ZenDesk ticket. ### Proposal Change the job definitions of the Gemnasium CI jobs so that the generated graph exports are uploaded when the job fails ~~OR when `SECURE_LOG_LEVEL` is set to `debug`~~. For instance, change the job definition of `gemnasium-maven` so that it uploads the DOT exports it creates using the `dependencyDot` task of the [sbt-dependency-graph](https://github.com/sbt/sbt-dependency-graph) plugin. The change would be limited to `gemnasium-maven-dependency_scanning` and `gemnasium-python-dependency_scanning` since these are the only Dependency Scanning jobs that generate graph exports. See https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gitlab/ci/templates/Security/Dependency-Scanning.gitlab-ci.yml#L68 See https://docs.gitlab.com/ee/ci/yaml/#artifactswhen ### Further details <!-- Include use cases, benefits, goals, or any other details that will help us understand the problem better. --> ### Implementation plan - [ ] Update Dependency Scanning CI template; see [proposal](#proposal) and [MR](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/72763) - [x] Change existing job integration tests to make them compatible with these changes; see https://gitlab.com/gitlab-org/gitlab/-/issues/343871+ - [ ] Create dedicated job integration tests; see [Availability & Testing](#availability-testing) and https://gitlab.com/gitlab-org/gitlab/-/issues/350896+ - [ ] Update user documentation; see [documentation](#documentation) ### Permissions and Security No change ### Documentation To be documented in the [troubleshooting](https://docs.gitlab.com/ee/user/application_security/dependency_scanning/index.html#troubleshooting) section of [Dependency Scanning user documentation](https://docs.gitlab.com/ee/user/application_security/dependency_scanning/index.html) under a new subsection titled `Gemnasium Dependency Scanning job fails`. Make sure you cover the following items: - Dependency graph exports might be exposed as jobs artifacts to investigate the issue. - These can be used to investigate a bug where the analyzer can't parse these graph exports. - They might not be available, depending on the job and on the bug. ### Availability & Testing To be tested in 2-stage pipelines: 1. The `test` stage runs the scanning job. The job `script` is altered to make it fail with a specific exit code, and the job is allowed to fail on that exit code, so the pipeline isn't stopped. The `artifacts` param of the job isn't altered. 1. The `qa` stage runs a job that compares the CI artifacts/graph exports to what's expected. The Dependency Scanning report isn't checked. The [QA CI template](https://gitlab.com/gitlab-org/security-products/ci-templates/-/blob/master/includes-dev/qa-dependency_scanning.yml) can't be used for this: the `artifacts` param shouldn't be altered because we wouldn't test the upload of the CI artifacts–this feature. Scenarios to be covered: - Graph exports are uploaded as CI artifacts when the `/analyzer` command returns a non-zero exit code. - ~~Graph exports are uploaded as CI artifacts when the command returns a zero exit code and `SECURE_LOG_LEVEL` is `debug`.~~ - ~~Graph exports are NOT uploaded when the command returns a zero exit code and `SECURE_LOG_LEVEL` is `info` (or not set).~~ These don't check the generated security report, so they can't be implemented using the existing [Dependency Scanning QA CI template](https://gitlab.com/gitlab-org/security-products/ci-templates/-/blob/054909a669fa7b8001106078bdb4db1e1e9b065b/includes-dev/qa-dependency_scanning.yml). Instead, we need a new pipeline with a CI job that checks the CI artifacts of the scanning job. This should be tested in complex/composite test projects that generate multiple graph exports: - https://gitlab.com/gitlab-org/security-products/tests/java-gradle-multimodules and - https://gitlab.com/gitlab-org/security-products/tests/java-maven-multimodules - https://gitlab.com/gitlab-org/security-products/tests/scala-sbt-multiproject/ ### Available Tier Ultimate/Gold ### What does success look like, and how can we measure that? Users can easily access the graph exports generated by gemnasium-maven and gemnasium-python scanning jobs when these jobs fail or when they want to investigate unexpected results. ### What is the type of buyer? ~"Enterprise Edition" ### Is this a cross-stage feature? No ### Links / references