discourse/lib/turbo_tests/flaky/failures_logger_formatter.rb

# frozen_string_literal: true

module TurboTests
  module Flaky
    # This class is responsible for logging the failed examples in JSON format with the necessary debugging information
    # to debug the test failures. See `TurboTests::Flaky::FailedExample#to_h` for the debugging information that we log.
    class FailuresLoggerFormatter
      def dump_summary(notification, _timings)
        Manager.log_potential_flaky_tests(notification.failed_examples)
      end
    end
  end
end
DEV: Introduce automatic reruns to RSpec tests on Github actions (#24811) What motivated this change? Our builds on Github actions have been extremely flaky mostly due to system tests. This has led to a drop in confidence in our test suite where our developers tend to assume that a failed job is due to a flaky system test. As a result, we have had occurrences where changes that resulted in legitimate test failures are merged into the `main` branch because developers assumed it was a flaky test. What does this change do? This change seeks to reduce the flakiness of our builds on Github Actions by automatically re-running RSpec tests once when they fail. If a failed test passes subsequently in the re-run, we mark the test as flaky by logging it into a file on disk which is then uploaded as an artifact of the Github workflow run. We understand that automatically re-runs will lead to lower accuracy of our tests but we accept this as an acceptable trade-off since a fragile build has a much greater impact on our developers' time. Internally, the Discourse development team will be running a service to fetch the flaky tests which have been logged for internal monitoring. How is the change implemented? 1. A `--retry-and-log-flaky-tests` CLI flag is added to the `bin/turbo_rspec` CLI which will then initialize `TurboTests::Runner` with the `retry_and_log_flaky_tests` kwarg set to `true`. 2. When the `retry_and_log_flaky_tests` kwarg is set to `true` for `TurboTests::Runner`, we will register an additional formatter `Flaky::FailuresLoggerFormatter` to the `TurboTests::Reporter` in the `TurboTests::Runner#run` method. The `Flaky::FailuresLoggerFormatter` has a simple job of logging all failed examples to a file on disk when running all the tests. The details of the failed example which are logged can be found in `TurboTests::Flaky::FailedExample.to_h`. 3. Once all the tests have been run once, we check the result for any failed examples and if there are, we read the file on disk to fetch the `location_rerun_location` of the failed examples which is then used to run the tests in a new RSpec process. In the rerun, we configure a `TurboTests::Flaky::FlakyDetectorFormatter` with RSpec which removes all failed examples from the log file on disk since those examples are not flaky tests. Note that if there are too many failed examples on the first run, we will deem the failures to likely not be due to flaky tests and not re-run the test failures. As of writing, the threshold of failed examples is set to 10. If there are more than 10 failed examples, we will not re-run the failures. 2023-12-13 07:18:27 +08:00			`# frozen_string_literal: true`

			`module TurboTests`
			`module Flaky`
			`# This class is responsible for logging the failed examples in JSON format with the necessary debugging information`
			# to debug the test failures. See `TurboTests::Flaky::FailedExample#to_h` for the debugging information that we log.
			`class FailuresLoggerFormatter`
			`def dump_summary(notification, _timings)`
			`Manager.log_potential_flaky_tests(notification.failed_examples)`
			`end`
			`end`
			`end`
			`end`