test_file_finder 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f430ea47bf579ef3674aaf0e0dc9cd41dcb667496e095fe5186a3fdf4763e3d0
-  data.tar.gz: f22662e4c8e9e20af318eeca9d6a6de2f24ef494a962406e202781c464cd38c9
+  metadata.gz: 395e0c675e1c2f892395a6706c5c0505f8bf53a28416b3d60f424613b6eaefd1
+  data.tar.gz: 7d574bfda0a48abce40083fbaed0ab007e56ea051bcb1a056dfee1ef6dc2f052
 SHA512:
-  metadata.gz: 01da410e1a12bd34d58d0d3d0212d793ba99bdaef7d7b97d3fb03fb68a9b059af700a4da5a695be1976a61ef0dec7385f19e89660630b219acaf88be4b4e7601
-  data.tar.gz: 3e3cf7a6f6a74a7d7fcef43b462ad0b78e971cc1f1116ddf37607aa2837dce44e1b42635b7d0e275929f3d74146ba74151d3c32f717c6bdb151c49ec4afc73bb
+  metadata.gz: f15af7348a90fd1f3eb13b48359f57db714e7f4badce355544b35fe1a261fe7881555f6852415fdcdc4544f49341efb8ffac968675c36a355530a6d4c86cb20f
+  data.tar.gz: 2e7592eb12c547e5346362cdef16e3356d75b2cee3156390e720c55a0c45428b4a8f004dfe4750c9429b89d6fef9ca2b2a134d27493c3d3e15104b049586d0e6

data/.gitlab-ci.yml

@@ -1,3 +1,9 @@
+image: ruby:2.7.2
+
+stages:
+  - test
+  - deploy
+
 rspec:
   script: bundle; bundle exec rspec
   rules:
@@ -7,3 +13,7 @@ check-executable:
   script: bundle; bundle exec rspec feature
   rules:
     - if: $CI
+
+include:
+  - project: 'gitlab-org/quality/pipeline-common'
+    file: '/ci/gem-release.yml'

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/ci-cd/test_file_finder/commits/master that will be included in the release. -->
+- Diff: https://gitlab.com/gitlab-org/ci-cd/test_file_finder/compare/v4.5.0...e18d76b309e42888759c1effe96767f13e34ae55
+
+- Release notes:
+
+<!-- Keep the sections order but remove the empty sections -->
+
+```markdown
+### New features and features updates
+
+- !aaa <Title of the aaa MR>.
+
+### Fixes
+
+- !bbb <Title of the bbb MR>.
+
+### Doc changes
+
+- !ccc <Title of the ccc MR>.
+
+### Other changes (tooling, technical debt)
+
+- !ddd <Title of the ddd MR>.
+```
+
+- Checklist before merging:
+  - [ ] Diff link is up-to-date.
+  - [ ] Based on the diff, `lib/test_file_finder/version.rb` is updated, according to [SemVer](https://semver.org).
+  - [ ] Release notes are accurate.
+
+- Checklist after merging:
+  - [ ] [Update the release notes for the newly created tag](docs/release_process.md#how-to).
+
+/label ~tooling ~"tooling::workflow"

data/Gemfile.lock

@@ -1,13 +1,22 @@
 PATH
   remote: .
   specs:
-    test_file_finder (0.1.1)
+    test_file_finder (0.1.3)
+      faraday (~> 1.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     byebug (11.1.3)
+    crack (0.4.4)
     diff-lcs (1.3)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (1.0.1)
+    multipart-post (2.1.1)
+    public_suffix (4.0.6)
     rake (10.5.0)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -22,6 +31,10 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
+    webmock (3.12.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
@@ -32,6 +45,7 @@ DEPENDENCIES
   rake (~> 10.0)
   rspec (~> 3.0)
   test_file_finder!
+  webmock (~> 3.12)
 
 BUNDLED WITH
-   1.17.3
+   2.1.4

data/README.md

@@ -119,6 +119,25 @@ tff.test_files
 
 An example mapping file is available in `fixtures/mapping.json`.
 
+##### `--project-path project_path` and `--merge-request-iid merge_request_iid`
+
+`TestFileFinder` can be used with both GitLab project path and merge request IID to get the test files that failed in the project merge request.
+
+Command line example:
+
+```bash
+$ tff --project-path project/path --merge-request-iid 123
+spec/models/widget_spec.rb
+```
+
+Ruby example:
+
+```ruby
+tff = TestFileFinder::FileFinder.new(paths: file_paths)
+tff.use TestFileFinder::MappingStrategies::GitlabMergeRequestRspecFailure.new(project_path: 'project/path', merge_request_iid: 123)
+tff.test_files
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/docs/release_process.md

@@ -0,0 +1,34 @@
+# 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-triage` 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/ci-cd/test_file_finder/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/test_file_finder/version.rb`] to an appropriate [semantic version](https://semver.org) in a new merge request using the [release template](https://gitlab.com/gitlab-org/ci-cd/test_file_finder/blob/master/.gitlab/merge_request_templates/Release.md)
+    and title the MR like `"Bump version to <version>"`.
+- Merge the merge request.
+- The new version should automatically be tagged and pushed to Rubygems by the `release` job in the merge commit pipeline.
+- Update the release notes for the newly created tag (https://gitlab.com/gitlab-org/ci-cd/test_file_finder/-/tags):
+  * **Release notes**: Copy the release notes from the merge request.
+
+Note: The `bundle exec release` command uses the `GEM_HOST_API_KEY` environment variable to authenticate against the
+`rubygems.org`.
+
+[`lib/test_file_finder/version.rb`]: https://gitlab.com/gitlab-org/ci-cd/test_file_finder/blob/master/lib/test_file_finder/version.rb#L2

data/exe/tff

@@ -10,6 +10,9 @@ TestFileFinder::FileFinder.new(paths: ARGV).tap do |file_finder|
   if options.mapping_file
     file_finder.use TestFileFinder::MappingStrategies::PatternMatching.load(options.mapping_file)
   end
+  if options.project_path && options.merge_request_iid
+    file_finder.use TestFileFinder::MappingStrategies::GitlabMergeRequestRspecFailure.new(project_path: options.project_path, merge_request_iid: options.merge_request_iid)
+  end
 
   if file_finder.strategies.empty?
     file_finder.use TestFileFinder::MappingStrategies::PatternMatching.default_rails_mapping

data/fixtures/test_reports.json

@@ -0,0 +1,194 @@
+{
+  "status": "failed",
+  "summary": {
+    "total": 262819,
+    "resolved": 0,
+    "failed": 1,
+    "errored": 0
+  },
+  "suites": [
+    {
+      "name": "jest",
+      "status": "success",
+      "summary": {
+        "total": 27913,
+        "resolved": 0,
+        "failed": 0,
+        "errored": 0
+      },
+      "new_failures": [
+        {
+          "status": "failed",
+          "name": "javascript test",
+          "classname": "javascript.test",
+          "file": "./spec/frontend/javascript_spec.js",
+          "execution_time": 0.1,
+          "system_output": "Test failure",
+          "stack_trace": null,
+          "recent_failures": {
+            "count": 1,
+            "base_branch": "master"
+          }
+        }
+      ],
+      "existing_failures": [],
+      "resolved_failures": [],
+      "new_errors": [],
+      "existing_errors": [],
+      "resolved_errors": [],
+      "suite_errors": null
+    },
+    {
+      "name": "rspec unit pg11",
+      "status": "success",
+      "summary": {
+        "total": 70649,
+        "resolved": 0,
+        "failed": 0,
+        "errored": 0
+      },
+      "new_failures": [
+        {
+          "status": "failed",
+          "name": "rspec unit pg 11 test",
+          "classname": "rspec.unit.pg.11.test",
+          "file": "./spec/app/rspec_unit_pg11_spec.rb",
+          "execution_time": 0.534931,
+          "system_output": "Failure/Error",
+          "stack_trace": null,
+          "recent_failures": {
+            "count": 6,
+            "base_branch": "master"
+          }
+        }
+      ],
+      "existing_failures": [],
+      "resolved_failures": [
+        {
+          "status": "success",
+          "name": "resolved rspec unit pg 11 test",
+          "classname": "resolved.rspec.unit.pg.11.test",
+          "file": "./spec/resolved/rspec_unit_pg11_spec.rb",
+          "execution_time": 0.534931,
+          "system_output": "Failure/Error",
+          "stack_trace": null,
+          "recent_failures": {
+            "count": 6,
+            "base_branch": "master"
+          }
+        }
+      ],
+      "new_errors": [],
+      "existing_errors": [],
+      "resolved_errors": [],
+      "suite_errors": null
+    },
+    {
+      "name": "rspec system pg11-as-if-foss",
+      "status": "success",
+      "summary": {
+        "total": 6735,
+        "resolved": 0,
+        "failed": 0,
+        "errored": 0
+      },
+      "new_failures": [],
+      "existing_failures": [
+        {
+          "status": "failed",
+          "name": "rspec system pg 11 as if foss test",
+          "classname": "rspec.system.pg.11.as.if.foss.test",
+          "file": "./spec/features/rspec_system_pg11_as_if_foss_spec.rb",
+          "execution_time": 0.534931,
+          "system_output": "Failure/Error",
+          "stack_trace": null,
+          "recent_failures": {
+            "count": 6,
+            "base_branch": "master"
+          }
+        }
+      ],
+      "resolved_failures": [],
+      "new_errors": [],
+      "existing_errors": [],
+      "resolved_errors": [],
+      "suite_errors": null
+    },
+    {
+      "name": "rspec-ee integration pg11",
+      "status": "failed",
+      "summary": {
+        "total": 5713,
+        "resolved": 0,
+        "failed": 1,
+        "errored": 0
+      },
+      "new_failures": [
+        {
+          "status": "failed",
+          "name": "rspec-ee integration pg 11 test",
+          "classname": "rspec-ee.integration.pg.11.test",
+          "file": "./ee/spec/rspec_integration_pg11_spec.rb",
+          "execution_time": 0.534931,
+          "system_output": "Failure/Error",
+          "stack_trace": null,
+          "recent_failures": {
+            "count": 6,
+            "base_branch": "master"
+          }
+        }
+      ],
+      "existing_failures": [],
+      "resolved_failures": [],
+      "new_errors": [],
+      "existing_errors": [],
+      "resolved_errors": [],
+      "suite_errors": null
+    },
+    {
+      "name": "rspec-ee system pg11",
+      "status": "success",
+      "summary": {
+        "total": 1993,
+        "resolved": 0,
+        "failed": 0,
+        "errored": 0
+      },
+      "new_failures": [],
+      "existing_failures": [
+        {
+          "status": "failed",
+          "name": "rspec-ee system pg 11 test",
+          "classname": "rspec-ee.system.pg.11.test",
+          "file": "./ee/spec/features/rspec_system_pg11_spec.rb",
+          "execution_time": 0.534931,
+          "system_output": "Failure/Error",
+          "stack_trace": null,
+          "recent_failures": {
+            "count": 6,
+            "base_branch": "master"
+          }
+        }
+      ],
+      "resolved_failures": [
+        {
+          "status": "success",
+          "name": "resolved rspec system pg 11 test",
+          "classname": "resolved.rspec.system.pg.11.test",
+          "file": "./ee/spec/features/resolved/rspec_system_pg11_spec.rb",
+          "execution_time": 0.534931,
+          "system_output": "Failure/Error",
+          "stack_trace": null,
+          "recent_failures": {
+            "count": 6,
+            "base_branch": "master"
+          }
+        }
+      ],
+      "new_errors": [],
+      "existing_errors": [],
+      "resolved_errors": [],
+      "suite_errors": null
+    }
+  ]
+}

data/lib/test_file_finder.rb

@@ -8,4 +8,5 @@ module TestFileFinder
   class Error < StandardError; end
 
   InvalidMappingFileError = Class.new(Error)
+  TestReportError = Class.new(Error)
 end

data/lib/test_file_finder/mapping_strategies.rb

@@ -1,4 +1,5 @@
 require 'test_file_finder/mapping_strategies/direct_matching'
+require 'test_file_finder/mapping_strategies/gitlab_merge_request_rspec_failure'
 require 'test_file_finder/mapping_strategies/pattern_matching'
 
 module TestFileFinder

data/lib/test_file_finder/mapping_strategies/gitlab_merge_request_rspec_failure.rb

@@ -0,0 +1,78 @@
+require 'faraday'
+require 'json'
+require 'set'
+
+module TestFileFinder
+  module MappingStrategies
+    ##
+    # GitlabMergeRequestRSpecFailure strategy finds test files that failed
+    # in a GitLab merge request, using the Unit Test Reports feature
+    # https://docs.gitlab.com/ee/ci/unit_test_reports.html
+    #
+    # It uses the project path and merge request iid to fetch
+    # the test report of the merge request, which contains the test suites
+    # that ran in the CI pipeline.
+    #
+    # It returns file names of rspec failures in the pipeline.
+    class GitlabMergeRequestRspecFailure
+      TEST_REPORTS_URL_TEMPLATE = 'https://gitlab.com/%{project_path}/-/merge_requests/%{merge_request_iid}/test_reports.json'.freeze
+
+      attr_reader :project_path, :merge_request_iid
+
+      def initialize(project_path:, merge_request_iid:)
+        @project_path = project_path
+        @merge_request_iid = merge_request_iid
+      end
+
+      def match(_files = nil)
+        test_suites.each_with_object(Set.new) do |suite, result|
+          unresolved_failures(suite).each do |failure|
+            rspec_file(failure) do |spec|
+              result << spec
+            end
+          end
+        end.to_a
+      end
+
+      private
+
+      def test_suites
+        return to_enum(__method__) unless block_given?
+
+        @test_suites ||= merge_request_test_reports['suites']
+        @test_suites.each { |suite| yield suite }
+      end
+
+      def unresolved_failures(suite)
+        return to_enum(__method__, suite) unless block_given?
+
+        suite['new_failures'].each { |failure| yield failure }
+        suite['existing_failures'].each { |failure| yield failure }
+      end
+
+      def rspec_file(failure)
+        file = failure['file'].sub('./', '')
+
+        if file.end_with?('spec.rb')
+          yield file
+        end
+      end
+
+      def merge_request_test_reports
+        test_reports_url = format(TEST_REPORTS_URL_TEMPLATE, { project_path: project_path, merge_request_iid: merge_request_iid })
+
+        response = Faraday.get(test_reports_url, {}, {'Accept' => 'application/json'})
+
+        if response.status == 204
+          raise TestFileFinder::TestReportError, "Test report for merge request #{merge_request_iid} is not ready, please try again later."
+        elsif response.status == 400
+          raise TestFileFinder::TestReportError, "The project #{project_path} does not have test reports configured."
+        elsif response.status == 500
+          raise TestFileFinder::TestReportError, 'Unable to retrieve test report, please try again later.'
+        end
+
+        JSON.parse(response.body)
+      end
+    end
+  end
+end

data/lib/test_file_finder/option_parser.rb

@@ -1,7 +1,7 @@
 require 'optparse'
 
 module TestFileFinder
-  Options = Struct.new(:mapping_file, :json)
+  Options = Struct.new(:mapping_file, :json, :project_path, :merge_request_iid)
 
   class OptionParser
     def self.parse!(argv)
@@ -20,6 +20,14 @@ module TestFileFinder
           opts.on('--json FILE', String, 'Use a JSON mapping file') do |json|
             options.json = json
           end
+
+          opts.on('--project-path PROJECT_PATH', String, 'Path of GitLab project, e.g `gitlab-org/gitlab`') do |project_path|
+            options.project_path = project_path
+          end
+
+          opts.on('--merge-request-iid MERGE_REQUEST_IID', Integer, 'Merge request internal id') do |merge_request_iid|
+            options.merge_request_iid = merge_request_iid
+          end
         end.parse!(argv)
       end
     end

data/lib/test_file_finder/version.rb

@@ -1,3 +1,3 @@
 module TestFileFinder
-  VERSION = '0.1.1'
+  VERSION = '0.1.3'
 end

data/test_file_finder.gemspec

@@ -33,8 +33,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_runtime_dependency 'faraday', '~> 1.0.1'
+
   spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'byebug'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'webmock', '~> 3.12'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: test_file_finder
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - GitLab
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-13 00:00:00.000000000 Z
+date: 2021-04-13 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -53,19 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.12'
 description: A command-line tool for guessing which spec files are relavant to a passed-in
   set of file paths.
 email:
@@ -77,6 +105,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".gitlab-ci.yml"
+- ".gitlab/merge_request_templates/Release.md"
 - ".rspec"
 - Gemfile
 - Gemfile.lock
@@ -84,6 +113,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- docs/release_process.md
 - exe/tff
 - feature/tff_exe_spec.rb
 - fixtures/mapping.json
@@ -92,11 +122,13 @@ files:
 - fixtures/spec/db/schema_spec.rb
 - fixtures/spec/models/project_spec.rb
 - fixtures/spec/models/test_file_finder_gem_executable_widget_spec.rb
+- fixtures/test_reports.json
 - lib/test_file_finder.rb
 - lib/test_file_finder/file_finder.rb
 - lib/test_file_finder/mapping.rb
 - lib/test_file_finder/mapping_strategies.rb
 - lib/test_file_finder/mapping_strategies/direct_matching.rb
+- lib/test_file_finder/mapping_strategies/gitlab_merge_request_rspec_failure.rb
 - lib/test_file_finder/mapping_strategies/pattern_matching.rb
 - lib/test_file_finder/option_parser.rb
 - lib/test_file_finder/version.rb
@@ -109,7 +141,7 @@ metadata:
   homepage_uri: https://gitlab.com/gitlab-org/ci-cd/test_file_finder
   source_code_uri: https://gitlab.com/gitlab-org/ci-cd/test_file_finder
   changelog_uri: https://gitlab.com/gitlab-org/ci-cd/test_file_finder/-/blob/master/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -124,8 +156,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.1.4
+signing_key: 
 specification_version: 4
 summary: Guesses spec file paths given input file paths.
 test_files: []