gitlab-qa 4.7.1 → 4.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d521a2696e2c3b1bfeeebc33c63f9380c85bded122e27bac3212f7062466c1f
-  data.tar.gz: 7739221d04288e6f4db261486e9ca6cb09cf84d32286bf52794d080a064931ce
+  metadata.gz: c369a98179f8f30c64babf5884b9919b14bf2016a15e0c4a172a5516c870be87
+  data.tar.gz: d790e55c6879463128dcee0a76437f0d98ae66e0aa5a8a72cfa827da385d11ab
 SHA512:
-  metadata.gz: ccbd5e903fa8b48ff4ebcec8112edab52f65350f17c99d8d046ed17adbbbac355ab89a13a1ce18950012d2f8f7db1bb1def403217ee4b445b913fe16dc2bf9ff
-  data.tar.gz: 4ad1e1211e80cddafe8150cb73963b8eb7f713138bfec5af40277aad38ca6462b6134362eb6eca5f441d5f2ed6632e7471d3a5c7ffb6b22f5d055b2cd3a7ccd6
+  metadata.gz: ed4335697822edc553edbaa5d7a8bad7fa498e80773e16a5b9f6a7e7bddd42893a4954d3bcd37849e4cb5cb1c6c954fca669a0074e1aaf21d8dc6335cbaa16b7
+  data.tar.gz: a8de7ca6b1c86abb91b628266f1eaa293fd70ead1a1944469d5513c200ef5e5f452772ff021f5b8b8b8890f02c725974dfad35da2ec49c0b6ecdd46680f4d970

data/.gitlab-ci.yml

@@ -1,8 +1,11 @@
+image: ruby:2.6
+
 services:
  - docker:1.13-dind
 
 stages:
   - check
+  - release
   - test
   - notify
 
@@ -13,8 +16,14 @@ variables:
   QA_ARTIFACTS_DIR: $CI_PROJECT_DIR
   QA_CAN_TEST_GIT_PROTOCOL_V2: 'false'
 
+cache:
+  key: "ruby:2.6"
+  paths:
+    - vendor/ruby
+
 before_script:
-  - bundle install
+  - bundle version
+  - bundle install --clean --jobs=$(nproc) --path=vendor --retry=3 --quiet && bundle check
   - if [ -n "$TRIGGERED_USER" ] && [ -n "$TRIGGER_SOURCE" ]; then
       echo "Pipeline triggered by $TRIGGERED_USER at $TRIGGER_SOURCE";
     fi
@@ -717,3 +726,40 @@ staging:
     - .high-capacity
     - .only-qa
   when: manual
+
+release:
+  stage: release
+  rules:
+    - if: '$CI_PIPELINE_SOURCE == "schedule" || $CI_PIPELINE_SOURCE == "pipeline" || $CI_COMMIT_REF_NAME != "master"'
+      when: never
+    - if: '$CI_COMMIT_TAG'
+      when: on_success
+    - when: manual
+  script:
+    - gem update --system
+    - ruby --version
+    - gem env version
+    - bundle exec rake release
+  artifacts:
+    paths:
+      - pkg/
+    expire_in: 30 days
+
+.notify_slack:
+  image: alpine
+  stage: notify
+  dependencies: []
+  cache: {}
+  before_script:
+    - apk update && apk add git curl bash
+  only:
+    variables:
+      - $TOP_UPSTREAM_SOURCE_JOB
+      - $NOTIFY_CHANNEL
+
+notify_slack:
+  extends:
+    - .notify_slack
+  script:
+    - bin/slack $NOTIFY_CHANNEL "☠️ Pipeline against $RELEASE failed! ☠️ See $CI_PIPELINE_URL (triggered from $TOP_UPSTREAM_SOURCE_JOB)" ci_failing
+  when: on_failure

data/.gitlab/merge_request_templates/Release.md

@@ -0,0 +1,35 @@
+<!-- Replace `v4.5.0` with the previous release here, and `e18d76b309e42888759c1effe96767f13e34ae55`
+with the latest commit from https://gitlab.com/gitlab-org/gitlab-qa/commits/master that will be included in the release. -->
+- Diff: https://gitlab.com/gitlab-org/gitlab-qa/compare/v4.5.0...e18d76b309e42888759c1effe96767f13e34ae55
+
+- Release notes:
+
+<!-- Keep the sections order but remove the empty sections -->
+
+```markdown
+### New scenarios and scenario updates
+
+- !aaa <Title of the aaa MR>.
+
+### Fixes
+
+- !bbb <Title of the bbb MR>.
+
+### Doc changes
+
+- !ccc <Title of the ccc MR>.
+
+### Other changes (CI, backstage)
+
+- !ddd <Title of the ddd MR>.
+```
+
+- Checklist before merging:
+  - [ ] Diff link is up-to-date.
+  - [ ] Based on the diff, `lib/gitlab/qa/version.rb` is updated, according to [SemVer](https://semver.org).
+  - [ ] Release notes are accurate.
+
+- Checklist after merging:
+  - [ ] [Create a tag for the new release version](docs/release_process.md#how-to).
+
+/label ~Quality ~backstage

data/CONTRIBUTING.md

@@ -11,18 +11,4 @@ terms.
 
 _This notice should stay as the first item in the CONTRIBUTING.md file._
 
-## Releasing a new version
-
-To release a new version you can follow these steps:
-
-1. Bump the [version](lib/gitlab/qa/version.rb#L3) using [semantic versioning](https://semver.org/).
-   * You may find it helpful to fill out the description of the merge request 
-     using the same format as for existing [tags](https://gitlab.com/gitlab-org/gitlab-qa/tags), as this will help in
-     step 3.
-2. Pull the change locally and run `bundle exec rake release` to build, tag,
-   and push the new version to [RubyGems](https://rubygems.org/gems/gitlab-qa).
-   * Note: you will need an account on [RubyGems.org](https://rubygems.org/)
-     and permission to push `gitlab-qa`. Open an issue in this project to
-     request access.
-3. Update the release notes for the new [tag](https://gitlab.com/gitlab-org/gitlab-qa/tags).
-4. If any pipelines are locked to a specific version, update them if required.
+## [Releasing a new version](docs/release_process.md)

data/bin/merge_html_reports

@@ -14,11 +14,12 @@ unless base_artifact_url
   exit 1
 end
 
-# Create the base report with empty body tag
+# Create the base report with body tag (empty except for the onload method)
 new_report = Nokogiri::HTML.parse(File.read(ARGV[0]))
 new_report.at_css('body').remove
-empty_body = Nokogiri::XML::Node.new('body', new_report)
-new_report.at_css('head').add_next_sibling(empty_body)
+body = Nokogiri::XML::Node.new('body', new_report)
+body[:onload] = "apply_filters()"
+new_report.at_css('head').add_next_sibling(body)
 
 ARGV.each do |report_file|
   report = Nokogiri::HTML.parse(File.read(report_file))
@@ -34,6 +35,9 @@ ARGV.each do |report_file|
   next if tests.empty?
 
   header.search("//h1/text()").first.content = "Test results for job: #{report_file.slice(/rspec-(.*)\.htm/, 1)}"
+  header.css("#display-filters input").each do |filter|
+    filter.remove_attribute('checked') if filter[:id] != "failed_checkbox"
+  end
 
   tests.each do |test|
     title = test.parent

data/docs/release_process.md

@@ -0,0 +1,35 @@
+# Release Process
+
+## Versioning
+
+We follow [Semantic Versioning](https://semver.org).  In short, this means that the new version should reflect the types of changes that are about to be released.
+
+*summary from semver.org*
+
+MAJOR.MINOR.PATCH
+
+- MAJOR version when you make incompatible API changes,
+- MINOR version when you add functionality in a backwards compatible manner, and
+- PATCH version when you make backwards compatible bug fixes.
+
+## When we release
+
+We release `gitlab-qa` on an ad-hoc basis.  There is no regularity to when we release, we just release
+when we make a change - no matter the size of the change.
+
+## How-to
+
+- Check if there is an [open merge request to bump the version](https://gitlab.com/gitlab-org/gitlab-qa/merge_requests?scope=all&utf8=%E2%9C%93&state=opened&search=bump+version) (to avoid creating a duplicate).
+  - If there is one, update it if necessary.
+  - If not, update [`lib/gitlab/qa/version.rb`] to an appropriate [semantic version](https://semver.org) in a new merge request using the [release template](https://gitlab.com/gitlab-org/gitlab-qa/blob/master/.gitlab/merge_request_templates/Release.md)
+    and title the MR like `"Bump version to <version>"`.
+- Merge the merge request.
+- Create a new tag via the UI (https://gitlab.com/gitlab-org/gitlab-qa/-/tags/new).
+  * **Tag name**: The same version found in [`lib/gitlab/qa/version.rb`], prefixed with `v`, e.g. if the version is `4.7.1`, the tag would be `v4.7.1`.
+  * **Message**: This can be something simple such as "<version> release".
+  * **Release notes**: Copy the release notes from the merge request.
+  * Click *Create Tag*.
+  
+GitLab will then start a pipeline for this new tag, and the `release` job will build and push the new version of `gitlab-qa` to RubyGems.
+
+[`lib/gitlab/qa/version.rb`]: https://gitlab.com/gitlab-org/gitlab-qa/blob/master/lib/gitlab/qa/version.rb#L3

data/docs/what_tests_can_be_run.md

@@ -82,6 +82,32 @@ For more details on the internals, please read the
 It is possible to enable a feature flag before running tests. See the [QA
 framework documentation](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/qa/README.md#running-tests-with-a-feature-flag-enabled) for details.
 
+## Specifying the GitLab version
+
+In each of the examples below, it is possible to test a specific version of GitLab
+by providing the full image name, or an abbreviation followed by the image tag.
+
+For example, to test GitLab version `12.4.0-ee`, the image tag is [`12.4.0-ee.0`](https://hub.docker.com/layers/gitlab/gitlab-ee/12.4.0-ee.0/images/sha256-65df19d8abbb0debdccb64bfe96871563806098cd84da0b818ae8cfdd928b9aa)
+and so you could run the tests with the command:
+
+```
+$ gitlab-qa Test::Instance::Image gitlab/gitlab-ee:12.4.0-ee.0
+```
+
+Or with the command:
+
+```
+$ gitlab-qa Test::Instance::Image EE:12.4.0-ee.0
+```
+
+If you only provide the abbreviation, it will run the tests against the latest nightly image.
+
+For example, the following command would use the image named `gitlab/gitlab-ee:nightly`
+
+```
+$ gitlab-qa Test::Instance::Image EE
+```
+
 ## Examples
 
 ### `Test::Instance::Image CE|EE|<full image address>`

data/lib/gitlab/qa/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module QA
-    VERSION = '4.7.1'.freeze
+    VERSION = '4.8.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-qa
 version: !ruby/object:Gem::Version
-  version: 4.7.1
+  version: 4.8.0
 platform: ruby
 authors:
 - Grzegorz Bizon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-23 00:00:00.000000000 Z
+date: 2019-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -133,7 +133,7 @@ files:
 - ".dockerignore"
 - ".gitignore"
 - ".gitlab-ci.yml"
-- ".gitlab/issue_templates/Release.md"
+- ".gitlab/merge_request_templates/Release.md"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -151,6 +151,7 @@ files:
 - docs/README.md
 - docs/architecture.md
 - docs/how_it_works.md
+- docs/release_process.md
 - docs/run_qa_against_gdk.md
 - docs/running_against_remote_grid.md
 - docs/trainings.md
@@ -233,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Integration tests for GitLab

data/.gitlab/issue_templates/Release.md

@@ -1,33 +0,0 @@
-<!-- Replace `v4.5.0` with the previous release here, and `e18d76b309e42888759c1effe96767f13e34ae55`
-with the latest commit from https://gitlab.com/gitlab-org/gitlab-qa/commits/master that will be included in the release. -->
-Diff: https://gitlab.com/gitlab-org/gitlab-qa/compare/v4.5.0...e18d76b309e42888759c1effe96767f13e34ae55
-
-Release notes:
-
-```markdown
-### Fixes
-
-- !xxx Fix a broken OAuth scenario.
-
-### New scenarios
-
-- !xxx Add a new Awesome scenario.
-
-### Scenario changes
-
-- !xxx Scenario `Foo` now accepts a new `--bar` option.
-
-### Doc changes
-
-- !xxx Document the new `QA_FOO_BAR` variable.
-
-### CI changes
-
-- !xxx Add a new staging job.
-
-### Other changes
-
-- !xxx Description of the other change.
-```
-
-/label ~backstage