Fix scenario and config names in what_tests_can_be_run.md

Anish Kumarrequested to merge
anishisbusy/gitlab-qa:anishisbusy/fix-example-scenario-names into master

What does this MR do and why?

Some commands in docs/what_tests_can_be_run.md no longer work when copied, because the scenario or Omnibus config they name does not exist anymore. This MR fixes them:

  • GitHub OAuth example. The example ran gitlab-qa Test::Integration::OAuth CE / EE, but there is no Test::Integration::OAuth scenario. GitHub OAuth is now set up through the github_oauth Omnibus config (lib/gitlab/qa/runtime/omnibus_configurations/github_oauth.rb), so the example now uses gitlab-qa Test::Instance::Image CE|EE --omnibus-config github_oauth.
  • Google Cloud Storage config name. The object storage section said to pass --omnibus-config object_storage_gcp. The config is called object_storage_gcs (ObjectStorageGcs in object_storage_gcs.rb). Because the runner looks the name up with const_get(config.camelize), object_storage_gcp fails with a NameError.
  • GCS_BUCKET_NAME description. It said "Name of the bucket set in AWS". It is the bucket in GCP.
  • Removed the Test::Integration::Packages section. The scenario was removed in !662 (merged), and the packages Omnibus config was removed in e13293d7 ("Remove package scenario configuration"). The section still told readers to run --omnibus-config packages and linked to the deleted packages.rb, so following it fails.

The Chaos section also has naming problems, but I left it alone because #691 (closed) already covers improving that documentation.

Screenshots or screen recordings

Not applicable (documentation only).

How to set up and validate locally

  1. Check the available Omnibus configs: ls lib/gitlab/qa/runtime/omnibus_configurations/. It lists github_oauth.rb and object_storage_gcs.rb, and no object_storage_gcp.rb or packages.rb.
  2. Check that there is no OAuth or Packages integration scenario: ls lib/gitlab/qa/scenario/test/integration/.
  3. See how the config name is resolved in lib/gitlab/qa/runner.rb (Runtime::OmnibusConfigurations.const_get(config.camelize)): object_storage_gcs resolves to ObjectStorageGcs, while object_storage_gcp would look for ObjectStorageGcp, which does not exist.

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

This contribution was prepared with the help of an AI assistant. I reviewed the changes and take responsibility for them.

Merge request reports