Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Separate Appraisal runs from primary test runs #2712

Merged
merged 1 commit into from
Nov 22, 2024

Conversation

nickcharlton
Copy link
Member

With Rails 8, the minimum version of Ruby becomes 3.2. Unless we drop support for prior Ruby versions (and also Rails versions), the way in which we were approaching CI can't work. Maintaining support for older Rails is not difficult because of Administrate itself, but how we approach testing so it feels unreasonable to drop support (which if we didn't test against it, we would effectively be doing) because it made CI harder to do. And we can make it work, so we will.

Previously, we ran the setup for the project as usual, and then ran setup for the Appraisals. This served two functions:

  1. Make Appraisal available in the bundle,
  2. Setup the database for running tests against

However, in the CI matrix, we support multiple different versions of Ruby (3.0 and up to 3.3). As we try and add Rails 8.0, this means we can't run bundle install on those versions of Ruby below 3.2 as it's a dependency constraint on Rails itself.

From experiments, we also can't:

  1. Install Appraisal outside of the bundle, because it references gems in a way that Bundler is there to solve,
  2. Load newer schema.rb files in older versions of Rails. Rails 7 introduced versioned schemas, and future schema versions can't be run with older versions of Rails.

Instead, what we can do is run the project setup inside a container configured to use the database in the CI environment, then manually do what Appraisal is doing to avoid issues bundling.

This container will always use the current development version of Ruby (3.2.2, at the time of this commit) taken from the .ruby-version file, in which we run just enough to setup the database and ensure the later tests can run against it.

It's unlikely that Administrate would do something which wasn't supported at the database level, but not impossible. However these tests would catch that (from experience: Rails falls back to a string on unknown types, so it's even less likely to fail).

We also need to remove the Ruby version specification from the generated Appraisal gemfiles, as otherwise these won't install. Whilst they seemed to be valid outside of this way of running things, here, they are not. We just use sed to remove it in place, as it can be discarded later and removing it would cause problems with Heroku deployment of the demo app.

Finally, we inline the previously extracted Action from #2524. The intent was to reduce duplication, but the order of operations are now so different it's not worth it and it would only be used in one place.

Extracted from #2705.

With Rails 8, the minimum version of Ruby becomes 3.2. Unless we drop
support for prior Ruby versions (and also Rails versions), the way in
which we were approaching CI can't work. Maintaining support for older
Rails is not difficult because of Administrate itself, but how we
approach testing so it feels unreasonable to drop support (which if we
didn't test against it, we would effectively be doing) because it made
CI harder to do. And we _can_ make it work, so we will.

Previously, we ran the setup for the project as usual, and then ran
setup for the Appraisals. This served two functions:

1. Make Appraisal available in the bundle,
2. Setup the database for running tests against

However, in the CI matrix, we support multiple different versions of
Ruby (3.0 and up to 3.3). As we try and add Rails 8.0, this means we
can't run `bundle install` on those versions of Ruby below 3.2 as it's a
dependency constraint on Rails itself.

From experiments, we also can't:

1. Install Appraisal outside of the bundle, because it references gems
   in a way that Bundler is there to solve,
2. Load newer `schema.rb` files in older versions of Rails. Rails 7
   introduced versioned schemas, and future schema versions can't be run
   with older versions of Rails.

Instead, what we _can_ do is run the project setup inside a container
configured to use the database in the CI environment, then manually do
what Appraisal is doing to avoid issues bundling.

This container will always use the current development version of Ruby
(3.2.2, at the time of this commit) taken from the `.ruby-version` file,
in which we run just enough to setup the database and ensure the later
tests can run against it.

It's unlikely that Administrate would do something which wasn't
supported at the database level, but not impossible. However these tests
would catch that (from experience: Rails falls back to a string on
unknown types, so it's even less likely to fail).

We also need to remove the Ruby version specification from the generated
Appraisal gemfiles, as otherwise these won't install. Whilst they seemed
to be valid outside of this way of running things, here, they are not.
We just use `sed` to remove it in place, as it can be discarded later
and removing it would cause problems with Heroku deployment of the demo
app.

Finally, we inline the previously extracted Action from #2524. The
intent was to reduce duplication, but the order of operations are now so
different it's not worth it and it would only be used in one place.

Extracted from #2705.
@nickcharlton nickcharlton added this to the v1.0.0 milestone Nov 21, 2024
@nickcharlton nickcharlton merged commit 52ca6af into main Nov 22, 2024
21 checks passed
@nickcharlton nickcharlton deleted the nc-prepare-ci-for-rails-8 branch November 22, 2024 09:50
nickcharlton added a commit that referenced this pull request Nov 22, 2024
We needed to:

* Bring over quite a few things from `rails app:update`, which hopefully
  should make future upgrades easier,
* Fix a change to the `enum` `ActiveModel` signature, which changed
  between Rails 6.0 and 7.0,
* Add a version check from 7.0 for `raise_on_missing_callback_actions`,
* Make a few changes to CI (on top of #2712) to adjust the Ruby versions
  we run CI against.

https://rubyonrails.org/2024/11/7/rails-8-no-paas-required

Closes #2703
nickcharlton added a commit that referenced this pull request Nov 22, 2024
We needed to:

* Bring over quite a few things from `rails app:update`, which hopefully
  should make future upgrades easier,
* Fix a change to the `enum` `ActiveModel` signature, which changed
  between Rails 6.0 and 7.0,
* Add a version check from 7.0 for `raise_on_missing_callback_actions`,
* Make a few changes to CI (on top of #2712) to adjust the Ruby versions
  we run CI against.

https://rubyonrails.org/2024/11/7/rails-8-no-paas-required

Closes #2703
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant