Skip to content

Document OVERRIDES_CMD_VERBOSE env var for API Fuzzing and DAST API

What does this MR do?

Documents new support to the new variable _OVERRIDES_CMD_VERBOSE. This variable is available in API Fuzzing as FUZZAPI_OVERRIDES_CMD_VERBOSE and DAST API as DAST_API_OVERRIDES_CMD_VERBOSE.

  • Document new variable _OVERRIDES_CMD_VERBOSE in API Fuzz and DAST API. The new variable _OVERRIDES_CMD_VERBOSE allows the users to show or hide the output of external commands. The external command is provided by _OVERRIDES_CMD (already documented).
  • Document variable _PRE_SCRIPT. The variable was already available in the application, but the documentation was not present. The documentation has been included in this MR because the example provided for _OVERRIDES_CMD_VERBOSE is complemented with the use of the variable _PRE_SCRIPT.
  • Document _POST_SCRIPT. The variable is not documented, a simple reference to it has been added in listed variables.

In the related MR by default output of the command is hidden, unless an error is detected. However, if DAST_API_OVERRIDES_CMD_VERBOSE is set to any value (but empty), then the output of the comment is shown as part of the job output.

Additionally, this MR adds an example of how to produce a log file related to the override command.

Related issues

#334578 (closed)

Depends on MR

https://gitlab.com/gitlab-org/security-products/analyzers/api-fuzzing-src/-/merge_requests/537

Author's checklist

Review checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.
Edited by Herber Madrigal

Merge request reports