Fix sorbet-static-and-runtime version in tests
#406
Merged
+1
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Because we do not fix the version of Sorbet used in the Spoom Gemfile, the Spoom tests have always been run on the newest version of Sorbet. This can cause tests to fail when a breaking change is made to Sorbet, without it being obvious to developers why the tests are failing. This commit fixes the version of `sorbet-static-and-runtime` in the context of the tests to whatever is currently listed by Gemfile.lock. Breaking changes in Sorbet will not cause tests to fail until the Sorbet version is bumped in Gemfile.lock, which leads to test failures that are easier to identify and fix.
KaanOzkan
approved these changes
Jun 22, 2023
Morriar
reviewed
Jun 26, 2023
| @@ -30,6 +30,7 @@ def spoom_gemfile | |||
| source("https://rubygems.org") | |||
| gemspec name: "spoom", path: "#{SPOOM_PATH}" | |||
| gem "sorbet-static-and-runtime", "#{Gem::Specification.find_by_name("sorbet-static-and-runtime").version}" | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #404
Description
Spoom tests install gems on an instance of
TestProject, including the most recent version of Sorbet. When Sorbet implements a change that breaks existing Spoom tests, that change will likely be surfaced on CI in an unrelated Spoom PR, which creates a lot of confusion amongst developers as they try to track down the reason for the change.This PR adds a line that fixes the Sorbet version in Spoom tests to the version in Spoom's Gemfile.lock. This is adapted from the approach we take in Tapioca. Now, tests will only break when Sorbet is bumped in Gemfile.lock, which will make it easier to identify the cause of these breaking tests and reduce confusion.
Questions
It looks like all the tests are passing with this change -- are there any tests that should be opted out of this approach?
Testing
To test this, I reverted two recent PRs that bumped Sorbet and fixed a test failure related to the new version of Sorbet; when I ran the test without my change, it failed, and then once my change was implemented, it passed.