debian-mirror-gitlab/scripts/verify-tff-mapping

165 lines
5 KiB
Text
Raw Normal View History

2020-11-24 15:15:51 +05:30
#!/usr/bin/env ruby
2021-03-11 19:13:27 +05:30
# frozen_string_literal: true
2020-11-24 15:15:51 +05:30
require 'set'
# These tests run a sanity check on the mapping file `tests.yml`
# used with the `test_file_finder` gem (`tff`) to identify matching test files.
# The verification depend on the presence of actual test files,
# so they would fail if one of the test files mentioned here is deleted.
# To minimize the chance of this test failing due to unrelated changes,
2021-04-29 21:17:54 +05:30
# the test files are chosen to be critical files that are unlikely to be deleted in a typical merge request
2020-11-24 15:15:51 +05:30
tests = [
{
explanation: 'EE code should map to respective spec',
source: 'ee/app/controllers/admin/licenses_controller.rb',
expected: ['ee/spec/controllers/admin/licenses_controller_spec.rb']
},
{
explanation: 'FOSS code should map to respective spec',
source: 'app/finders/admin/projects_finder.rb',
expected: ['spec/finders/admin/projects_finder_spec.rb']
},
{
explanation: 'EE extension should map to its EE extension spec and its FOSS class spec',
source: 'ee/app/finders/ee/projects_finder.rb',
expected: ['ee/spec/finders/ee/projects_finder_spec.rb', 'spec/finders/projects_finder_spec.rb']
},
{
2021-02-22 17:27:13 +05:30
explanation: 'Some EE extensions have specs placement that do not follow the recommendation: https://docs.gitlab.com/ee/development/ee_features.html#testing-ee-features-based-on-ce-features. `tff` should still find these misplaced specs.',
source: 'ee/app/models/ee/project.rb',
expected: ['ee/spec/models/project_spec.rb', 'spec/models/project_spec.rb']
2020-11-24 15:15:51 +05:30
},
{
explanation: 'FOSS lib should map to respective spec',
source: 'lib/gitaly/server.rb',
expected: ['spec/lib/gitaly/server_spec.rb']
},
{
explanation: 'Tooling should map to respective spec',
2021-03-08 18:12:59 +05:30
source: 'tooling/lib/tooling/helm3_client.rb',
expected: ['spec/tooling/lib/tooling/helm3_client_spec.rb']
2020-11-24 15:15:51 +05:30
},
{
explanation: 'FOSS spec code should map to itself',
source: 'spec/models/issue_spec.rb',
expected: ['spec/models/issue_spec.rb']
},
{
explanation: 'EE spec code should map to itself',
2021-02-22 17:27:13 +05:30
source: 'ee/spec/models/ee/user_spec.rb',
expected: ['ee/spec/models/ee/user_spec.rb', 'spec/models/user_spec.rb']
2020-11-24 15:15:51 +05:30
},
{
explanation: 'EE extension spec should map to itself and the FOSS class spec',
source: 'ee/spec/services/ee/notification_service_spec.rb',
expected: ['ee/spec/services/ee/notification_service_spec.rb', 'spec/services/notification_service_spec.rb']
},
{
explanation: 'FOSS factory should map to factories spec',
source: 'spec/factories/users.rb',
expected: ['spec/factories_spec.rb']
},
{
explanation: 'EE factory should map to factories spec',
source: 'ee/spec/factories/users.rb',
expected: ['spec/factories_spec.rb']
},
{
explanation: 'Initializers should map to respective spec',
source: 'config/initializers/action_mailer_hooks.rb',
expected: ['spec/initializers/action_mailer_hooks_spec.rb']
},
{
explanation: 'FOSS views should map to respective spec',
2021-09-04 01:27:46 +05:30
source: 'app/views/admin/dashboard/index.html.haml',
expected: ['spec/views/admin/dashboard/index.html.haml_spec.rb']
2020-11-24 15:15:51 +05:30
},
{
explanation: 'EE views should map to respective spec',
2021-09-30 23:02:18 +05:30
source: 'ee/app/views/subscriptions/new.html.haml',
expected: ['ee/spec/views/subscriptions/new.html.haml_spec.rb']
2020-11-24 15:15:51 +05:30
},
{
explanation: 'DB structure should map to schema spec',
source: 'db/structure.sql',
expected: ['spec/db/schema_spec.rb']
},
{
explanation: 'Migration should map to its non-timestamped spec',
2021-12-11 22:18:48 +05:30
source: 'db/migrate/20210818220234_add_default_project_approval_rules_vuln_allowed.rb',
expected: ['spec/migrations/add_default_project_approval_rules_vuln_allowed_spec.rb']
2020-11-24 15:15:51 +05:30
},
{
explanation: 'Migration should map to its timestamped spec',
2021-11-18 22:05:49 +05:30
source: 'db/post_migrate/20210915022415_cleanup_bigint_conversion_for_ci_builds.rb',
expected: ['spec/migrations/20210915022415_cleanup_bigint_conversion_for_ci_builds_spec.rb']
2021-04-17 20:07:23 +05:30
},
{
explanation: 'Whats New should map to its respective spec',
source: 'data/whats_new/202101140001_13_08.yml',
expected: ['spec/lib/release_highlights/validator_spec.rb']
2020-11-24 15:15:51 +05:30
}
]
class MappingTest
def initialize(explanation:, source:, expected:, mapping: 'tests.yml')
@explanation = explanation
@source = source
@mapping = mapping
@expected_set = Set.new(expected)
@actual_set = Set.new(actual)
end
def passed?
expected_set.eql?(actual_set)
end
def failed?
!passed?
end
def failure_message
"#{explanation}: #{source}: Expected #{expected_set.to_a}, got #{actual_set.to_a}."
end
private
attr_reader :explanation, :source, :expected_set, :actual_set, :mapping
def actual
`tff -f #{mapping} #{source}`.split(' ')
end
end
results = tests.map { |test| MappingTest.new(test) }
failed_tests = results.select(&:failed?)
if failed_tests.any?
puts <<~MESSAGE
tff mapping verification failed:
#{failed_tests.map(&:failure_message).join("\n")}
MESSAGE
exit 1
end
puts 'tff mapping verification passed.'