diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-06-23 00:07:53 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-06-23 00:07:53 +0000 |
commit | ec8587780b41c8a895f2b26d60c86bf93be5e038 (patch) | |
tree | 431a7c91e47947ac4a6692569d12db7ce9291f83 /doc | |
parent | 09d9f0d988ccfa8d73efb1b45222c9d4731d1497 (diff) | |
download | gitlab-ce-ec8587780b41c8a895f2b26d60c86bf93be5e038.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/development/profiling.md | 2 | ||||
-rw-r--r-- | doc/development/testing_guide/best_practices.md | 6 | ||||
-rw-r--r-- | doc/development/testing_guide/end_to_end/running_tests_that_require_special_setup.md | 14 | ||||
-rw-r--r-- | doc/development/usage_ping/dictionary.md | 168 |
4 files changed, 179 insertions, 11 deletions
diff --git a/doc/development/profiling.md b/doc/development/profiling.md index 781138a6ade..a58e1d60cc5 100644 --- a/doc/development/profiling.md +++ b/doc/development/profiling.md @@ -135,7 +135,7 @@ starting GitLab. For example: ENABLE_BULLET=true bundle exec rails s ``` -Bullet logs query problems to both the Rails log as well as the Chrome +Bullet logs query problems to both the Rails log as well as the browser console. As a follow up to finding `N+1` queries with Bullet, consider writing a [QueryRecoder test](query_recorder.md) to prevent a regression. diff --git a/doc/development/testing_guide/best_practices.md b/doc/development/testing_guide/best_practices.md index c44e26927fe..e153fa9f334 100644 --- a/doc/development/testing_guide/best_practices.md +++ b/doc/development/testing_guide/best_practices.md @@ -513,14 +513,14 @@ Finished in 34.51 seconds (files took 0.76702 seconds to load) #### Run `:js` spec in a visible browser -Run the spec with `CHROME_HEADLESS=0`, like this: +Run the spec with `WEBDRIVER_HEADLESS=0`, like this: ```shell -CHROME_HEADLESS=0 bin/rspec some_spec.rb +WEBDRIVER_HEADLESS=0 bin/rspec some_spec.rb ``` The test completes quickly, but this gives you an idea of what's happening. -Using `live_debug` with `CHROME_HEADLESS=0` pauses the open browser, and does not +Using `live_debug` with `WEBDRIVER_HEADLESS=0` pauses the open browser, and does not open the page again. This can be used to debug and inspect elements. You can also add `byebug` or `binding.pry` to pause execution and [step through](../pry_debugging.md#stepping) diff --git a/doc/development/testing_guide/end_to_end/running_tests_that_require_special_setup.md b/doc/development/testing_guide/end_to_end/running_tests_that_require_special_setup.md index 859b8f950e3..f200d6c682a 100644 --- a/doc/development/testing_guide/end_to_end/running_tests_that_require_special_setup.md +++ b/doc/development/testing_guide/end_to_end/running_tests_that_require_special_setup.md @@ -27,7 +27,7 @@ docker run \ To run the tests from the `/qa` directory: ```shell -CHROME_HEADLESS=false bin/qa Test::Instance::All http://localhost -- qa/specs/features/ee/browser_ui/3_create/jenkins/jenkins_build_status_spec.rb +WEBDRIVER_HEADLESS=false bin/qa Test::Instance::All http://localhost -- qa/specs/features/ee/browser_ui/3_create/jenkins/jenkins_build_status_spec.rb ``` The test automatically spins up a Docker container for Jenkins and tear down once the test completes. @@ -131,7 +131,7 @@ sudo nginx -s reload You could then run the tests from the `/qa` directory: ```shell -CHROME_HEADLESS=false bin/qa Test::Instance::All http://gitlab-gitaly-cluster.test -- --tag gitaly_cluster +WEBDRIVER_HEADLESS=false bin/qa Test::Instance::All http://gitlab-gitaly-cluster.test -- --tag gitaly_cluster ``` Once you have finished testing you can stop and remove the Docker containers: @@ -160,13 +160,13 @@ You might see NGINX issues when you run `gdk start` or `gdk restart`. In that ca Navigate to the folder in `/your-gdk/gitlab/qa` and issue the command: ```shell -QA_DEBUG=true CHROME_HEADLESS=false GITLAB_ADMIN_USERNAME=rootusername GITLAB_ADMIN_PASSWORD=rootpassword GITLAB_QA_ACCESS_TOKEN=your_token_here GITLAB_QA_ADMIN_ACCESS_TOKEN=your_token_here CLUSTER_API_URL=https://kubernetes.docker.internal:6443 bundle exec bin/qa Test::Instance::All https://[YOUR-PORT].qa-tunnel.gitlab.info/ -- qa/specs/features/browser_ui/8_monitor/all_monitor_core_features_spec.rb --tag kubernetes --tag orchestrated --tag requires_admin +QA_DEBUG=true WEBDRIVER_HEADLESS=false GITLAB_ADMIN_USERNAME=rootusername GITLAB_ADMIN_PASSWORD=rootpassword GITLAB_QA_ACCESS_TOKEN=your_token_here GITLAB_QA_ADMIN_ACCESS_TOKEN=your_token_here CLUSTER_API_URL=https://kubernetes.docker.internal:6443 bundle exec bin/qa Test::Instance::All https://[YOUR-PORT].qa-tunnel.gitlab.info/ -- qa/specs/features/browser_ui/8_monitor/all_monitor_core_features_spec.rb --tag kubernetes --tag orchestrated --tag requires_admin ``` The following includes more information on the command: -`QA_DEBUG` - Set to `true` to verbosely log page object actions. --`CHROME_HEADLESS` - When running locally, set to `false` to allow Chrome tests to be visible - watch your tests being run. +-`WEBDRIVER_HEADLESS` - When running locally, set to `false` to allow browser tests to be visible - watch your tests being run. -`GITLAB_ADMIN_USERNAME` - Admin username to use when adding a license. -`GITLAB_ADMIN_PASSWORD` - Admin password to use when adding a license. -`GITLAB_QA_ACCESS_TOKEN` and `GITLAB_QA_ADMIN_ACCESS_TOKEN` - A valid personal access token with the `api` scope. This is used for API access during tests, and is used in the version that staging is currently running. The `ADMIN_ACCESS_TOKEN` is from a user with admin access. Used for API access as an admin during tests. @@ -279,7 +279,7 @@ Geo end-to-end tests can run locally against a [Geo GDK setup](https://gitlab.co Run from the [`qa/` directory](https://gitlab.com/gitlab-org/gitlab/-/blob/f7272b77e80215c39d1ffeaed27794c220dbe03f/qa) with both GDK Geo primary and Geo secondary instances running: ```shell -CHROME_HEADLESS=false bundle exec bin/qa QA::EE::Scenario::Test::Geo --primary-address http://localhost:3001 --secondary-address http://localhost:3002 --without-setup +WEBDRIVER_HEADLESS=false bundle exec bin/qa QA::EE::Scenario::Test::Geo --primary-address http://localhost:3001 --secondary-address http://localhost:3002 --without-setup ``` ### Using Geo in Docker @@ -455,7 +455,7 @@ To run the LDAP tests on your local with TLS enabled, follow these steps: 1. Run an LDAP test from [`gitlab/qa`](https://gitlab.com/gitlab-org/gitlab/-/tree/d5447ebb5f99d4c72780681ddf4dc25b0738acba/qa) directory: ```shell - GITLAB_LDAP_USERNAME="tanuki" GITLAB_LDAP_PASSWORD="password" QA_DEBUG=true CHROME_HEADLESS=false bin/qa Test::Instance::All https://gitlab.test qa/specs/features/browser_ui/1_manage/login/log_into_gitlab_via_ldap_spec.rb + GITLAB_LDAP_USERNAME="tanuki" GITLAB_LDAP_PASSWORD="password" QA_DEBUG=true WEBDRIVER_HEADLESS=false bin/qa Test::Instance::All https://gitlab.test qa/specs/features/browser_ui/1_manage/login/log_into_gitlab_via_ldap_spec.rb ``` ### Running LDAP tests with TLS disabled @@ -483,5 +483,5 @@ To run the LDAP tests on your local with TLS disabled, follow these steps: 1. Run an LDAP test from [`gitlab/qa`](https://gitlab.com/gitlab-org/gitlab/-/tree/d5447ebb5f99d4c72780681ddf4dc25b0738acba/qa) directory: ```shell - GITLAB_LDAP_USERNAME="tanuki" GITLAB_LDAP_PASSWORD="password" QA_DEBUG=true CHROME_HEADLESS=false bin/qa Test::Instance::All http://localhost qa/specs/features/browser_ui/1_manage/login/log_into_gitlab_via_ldap_spec.rb + GITLAB_LDAP_USERNAME="tanuki" GITLAB_LDAP_PASSWORD="password" QA_DEBUG=true WEBDRIVER_HEADLESS=false bin/qa Test::Instance::All http://localhost qa/specs/features/browser_ui/1_manage/login/log_into_gitlab_via_ldap_spec.rb ``` diff --git a/doc/development/usage_ping/dictionary.md b/doc/development/usage_ping/dictionary.md index cdc9688c602..71c087d86cb 100644 --- a/doc/development/usage_ping/dictionary.md +++ b/doc/development/usage_ping/dictionary.md @@ -17378,6 +17378,18 @@ Status: `data_available` Tiers: `free` +### `usage_activity_by_stage.secure.user_api_fuzzing_scans` + +Number of users who have run a API Fuzzing scan + +[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_all/20210607044126_user_api_fuzzing_scans.yml) + +Group: `category::fuzz testing` + +Status: `data_available` + +Tiers: `ultimate` + ### `usage_activity_by_stage.secure.user_container_scanning_jobs` Distinct count per user of Container Scanning jobs run @@ -17390,6 +17402,18 @@ Status: `data_available` Tiers: `ultimate` +### `usage_activity_by_stage.secure.user_container_scanning_scans` + +Number of users who have run a Container Scanning scan + +[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_all/20210607043902_user_container_scanning_scans.yml) + +Group: `group::composition analysis` + +Status: `data_available` + +Tiers: `ultimate` + ### `usage_activity_by_stage.secure.user_coverage_fuzzing_jobs` Missing description @@ -17402,6 +17426,18 @@ Status: `data_available` Tiers: `free` +### `usage_activity_by_stage.secure.user_coverage_fuzzing_scans` + +Number of users who have run a Coverage Fuzzing scan + +[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_all/20210607044040_user_coverage_fuzzing_scans.yml) + +Group: `category::fuzz testing` + +Status: `data_available` + +Tiers: `ultimate` + ### `usage_activity_by_stage.secure.user_dast_jobs` Count of DAST jobs @@ -17414,6 +17450,18 @@ Status: `data_available` Tiers: `free` +### `usage_activity_by_stage.secure.user_dast_scans` + +Number of users who have run a DAST scan + +[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_all/20210607043109_user_dast_scans.yml) + +Group: `group::dynamic analysis` + +Status: `data_available` + +Tiers: `ultimate` + ### `usage_activity_by_stage.secure.user_dependency_scanning_jobs` Total number of users running Dependency Scanning jobs @@ -17426,6 +17474,18 @@ Status: `data_available` Tiers: `ultimate` +### `usage_activity_by_stage.secure.user_dependency_scanning_scans` + +Number of users who have run a Dependency Scanning scan + +[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_all/20210607043819_user_dependency_scanning_scans.yml) + +Group: `group::composition analysis` + +Status: `data_available` + +Tiers: `ultimate` + ### `usage_activity_by_stage.secure.user_license_management_jobs` Total number of users running License Scanning jobs @@ -17462,6 +17522,18 @@ Status: `data_available` Tiers: `free`, `premium`, `ultimate` +### `usage_activity_by_stage.secure.user_sast_scans` + +Number of users who have run a SAST scan + +[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_all/20210607043741_user_sast_scans.yml) + +Group: `group::static analysis` + +Status: `data_available` + +Tiers: `ultimate` + ### `usage_activity_by_stage.secure.user_secret_detection_jobs` Count of Secret Detection Jobs @@ -17474,6 +17546,18 @@ Status: `data_available` Tiers: `free`, `premium`, `ultimate` +### `usage_activity_by_stage.secure.user_secret_detection_scans` + +Number of users who have run a Secret Detection scan + +[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_all/20210607043957_user_secret_detection_scans.yml) + +Group: `group::static analysis` + +Status: `data_available` + +Tiers: `ultimate` + ### `usage_activity_by_stage.secure.user_unique_users_all_secure_scanners` Missing description @@ -19418,6 +19502,18 @@ Status: `data_available` Tiers: `free` +### `usage_activity_by_stage_monthly.secure.user_api_fuzzing_scans` + +Number of users who have run a API Fuzzing scan + +[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_28d/20210607043622_user_api_fuzzing_scans.yml) + +Group: `category::fuzz testing` + +Status: `data_available` + +Tiers: `ultimate` + ### `usage_activity_by_stage_monthly.secure.user_container_scanning_jobs` Distinct count per user of Container Scanning jobs run monthly @@ -19430,6 +19526,18 @@ Status: `data_available` Tiers: `ultimate` +### `usage_activity_by_stage_monthly.secure.user_container_scanning_scans` + +Number of users who have run a Container Scanning scan + +[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_28d/20210607043336_user_container_scanning_scans.yml) + +Group: `group::composition analysis` + +Status: `data_available` + +Tiers: `ultimate` + ### `usage_activity_by_stage_monthly.secure.user_coverage_fuzzing_jobs` Missing description @@ -19442,6 +19550,18 @@ Status: `data_available` Tiers: `free` +### `usage_activity_by_stage_monthly.secure.user_coverage_fuzzing_scans` + +Number of users who have run a Coverage Fuzzing scan + +[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_28d/20210607043509_user_coverage_fuzzing_scans.yml) + +Group: `category::fuzz testing` + +Status: `data_available` + +Tiers: `ultimate` + ### `usage_activity_by_stage_monthly.secure.user_dast_jobs` Users who run a DAST job @@ -19454,6 +19574,18 @@ Status: `data_available` Tiers: `free` +### `usage_activity_by_stage_monthly.secure.user_dast_scans` + +Number of users who have run a DAST scan + +[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_28d/20210607041718_user_dast_scans.yml) + +Group: `group::dynamic analysis` + +Status: `data_available` + +Tiers: `ultimate` + ### `usage_activity_by_stage_monthly.secure.user_dependency_scanning_jobs` Monthly number of users creating Dependency Scanning jobs @@ -19466,6 +19598,18 @@ Status: `data_available` Tiers: `ultimate` +### `usage_activity_by_stage_monthly.secure.user_dependency_scanning_scans` + +Number of users who have run a Dependency Scanning scan + +[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_28d/20210607043301_user_dependency_scanning_scans.yml) + +Group: `group::composition analysis` + +Status: `data_available` + +Tiers: `ultimate` + ### `usage_activity_by_stage_monthly.secure.user_license_management_jobs` Monthly number of users running License Scanning jobs @@ -19502,6 +19646,18 @@ Status: `data_available` Tiers: `free`, `premium`, `ultimate` +### `usage_activity_by_stage_monthly.secure.user_sast_scans` + +Number of users who have run a SAST scan + +[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_28d/20210607043218_user_sast_scans.yml) + +Group: `group::static analysis` + +Status: `data_available` + +Tiers: `ultimate` + ### `usage_activity_by_stage_monthly.secure.user_secret_detection_jobs` Users who run a Secret Detection job @@ -19514,6 +19670,18 @@ Status: `data_available` Tiers: `free`, `premium`, `ultimate` +### `usage_activity_by_stage_monthly.secure.user_secret_detection_scans` + +Number of users who have run a Secret Detection scan + +[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_28d/20210607043410_user_secret_detection_scans.yml) + +Group: `group::static analysis` + +Status: `data_available` + +Tiers: `ultimate` + ### `usage_activity_by_stage_monthly.secure.user_unique_users_all_secure_scanners` Missing description |