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.

Sign up for GitHub

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

Jump to bottom

Autorestore ENV between tests #472

Merged

bkeepers merged 9 commits into master from save-and-restore

Jan 24, 2024

Owner

bkeepers commented Jan 21, 2024 •

edited

Loading

This adds Dotenv.save and Dotenv.restore to save and restore the ENV, and automatially configures Rails apps to use it in tests (RSpec or AS::TestCase).

Disable by setting config.dotenv.autorestore = false in config/enviroments/test.rb or config/application.rb

Prior art:

ice_age cc @dpep
climate_control

Even though those are fine alternatives, I think it's still worth including this in dotenv by default.

bkeepers changed the title ~~Save/restore ENV, automatically load in Rails~~ Preserve ENV between tests


          Add ability to save/restore ENV, automatically load in Rails

6416aa5

bkeepers force-pushed the save-and-restore branch from f02199d to 6416aa5 Compare

January 21, 2024 15:37

bkeepers added 2 commits

January 22, 2024 18:54


          Fix lint error

73d0512


          Try to load deprecator in 7.1

e480e21

bkeepers force-pushed the save-and-restore branch from 7d3a361 to e480e21 Compare

January 23, 2024 01:37

bkeepers added 2 commits

January 22, 2024 20:44


          Fix specs for Rails 7.0

7f3640c


          Fix tests for Rails 6.1

561c94e

bkeepers mentioned this pull request

Log all changes to ENV #473

Merged

bkeepers added 2 commits

January 24, 2024 08:08


          Rename test_help to autorestore

dff63ef


          Configure files for rake test

98c9fc6

bkeepers changed the title ~~Preserve ENV between tests~~ Autorestore ENV between tests

bkeepers added 2 commits

January 24, 2024 11:51


          Update README

234e126


          Use setup+teardown in AS::TestCase

4df96c1

bkeepers merged commit 68dfc56 into master

12 checks passed

bkeepers deleted the save-and-restore branch

January 24, 2024 16:52

bkeepers mentioned this pull request

Handle thread safety for Dotenv.restore, Add Dotenv.modify #475

Merged

indiebrain referenced this pull request in powerhome/power-web-development-interview


          Update dependency dotenv-rails to v3 (#141)

5c0f523

[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [dotenv-rails](https://github.com/bkeepers/dotenv) | `2.8.1` ->
`3.0.0` |
[![age](https://developer.mend.io/api/mc/badges/age/rubygems/dotenv-rails/3.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/rubygems/dotenv-rails/3.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/rubygems/dotenv-rails/2.8.1/3.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/rubygems/dotenv-rails/2.8.1/3.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>bkeepers/dotenv (dotenv-rails)</summary>

###
[`v3.0.0`](https://github.com/bkeepers/dotenv/blob/HEAD/Changelog.md#300)

[Compare
Source](https://github.com/bkeepers/dotenv/compare/v2.8.1...v3.0.0)

**Breaking Changes**

- Ruby >= 3.0 and Rails >= 6.1 are now required. Lock dotenv to `~> 2.0`
if you are using an outdated Ruby or Rails version.
[https://github.com/bkeepers/dotenv/pull/466](https://github.com/bkeepers/dotenv/pull/466),
[https://github.com/bkeepers/dotenv/pull/471](https://github.com/bkeepers/dotenv/pull/471)
- `\n` is no longer expanded into a newline in quoted strings. Use
multi-line strings with real line breaks, or set
`DOTENV_LINEBREAK_MODE=legacy` to preserve the old behavior.
[@&#8203;nitsujri](https://github.com/nitsujri)
[https://github.com/bkeepers/dotenv/pull/423](https://github.com/bkeepers/dotenv/pull/423)
- `ENV` will be [automatically restored between
tests](https://github.com/bkeepers/dotenv#autorestore-in-tests)
(`ActiveSupport::TestCase` and `Rspec`).
[https://github.com/bkeepers/dotenv/pull/472](https://github.com/bkeepers/dotenv/pull/472),
[https://github.com/bkeepers/dotenv/pull/475](https://github.com/bkeepers/dotenv/pull/475)
- Fixed precedence when using `Dotenv::Rails.overload`. So now
`.env.development.local` will overwrite `.env.local`, which will
overwrite `.env.development`, which will overwrite `.env`.
[@&#8203;eriklovmo](https://github.com/eriklovmo) -
[https://github.com/bkeepers/dotenv/pull/460](https://github.com/bkeepers/dotenv/pull/460)
- The instrumentation event `dotenv.load` has been renamed to
`load.dotenv` to properly make use of namespaces in
[ActiveSupport::Notifications](https://guides.rubyonrails.org/active_support_instrumentation.html)
[https://github.com/bkeepers/dotenv/pull/472](https://github.com/bkeepers/dotenv/pull/472)

**Other improvements**

- All changes to ENV will be logged in Rails apps.
[https://github.com/bkeepers/dotenv/pull/473](https://github.com/bkeepers/dotenv/pull/473)
- Fixed an issue where `rake` loaded development files
(`.env*development`) for test-related tasks.
[https://github.com/bkeepers/dotenv/pull/470](https://github.com/bkeepers/dotenv/pull/470)
- Add `-i`/`--ignore` option to `dotenv` CLI to optionally ignore
missing files. [@&#8203;stevenharman](https://github.com/stevenharman)
[https://github.com/bkeepers/dotenv/pull/463](https://github.com/bkeepers/dotenv/pull/463)
- You can [customize which files get
loaded](https://github.com/bkeepers/dotenv#customizing-rails) by
setting `Dotenv::Rails.files`.
[https://github.com/bkeepers/dotenv/pull/468](https://github.com/bkeepers/dotenv/pull/468)

**Deprecations**

- The `dotenv-rails` gem is now superfluous. It's not technically
deprecated yet and will continue to work, but the `dotenv` gem does the
same thing.
[https://github.com/bkeepers/dotenv/pull/468](https://github.com/bkeepers/dotenv/pull/468)
- `Dotenv::Railtie` has been deprecated. Use `Dotenv::Rails`.
[https://github.com/bkeepers/dotenv/pull/468](https://github.com/bkeepers/dotenv/pull/468)
- `Dotenv.overload` has been replaced with `overwrite`. `overload` will
still work and is not technically deprecated, but documentation refers
to `Dotenv.overwrite` now.
[https://github.com/bkeepers/dotenv/pull/469](https://github.com/bkeepers/dotenv/pull/469)

**New Contributors**

- [@&#8203;stevenharman](https://github.com/stevenharman) made their
first contribution in
[https://github.com/bkeepers/dotenv/pull/463](https://github.com/bkeepers/dotenv/pull/463)
- [@&#8203;eriklovmo](https://github.com/eriklovmo) made their first
contribution in
[https://github.com/bkeepers/dotenv/pull/460](https://github.com/bkeepers/dotenv/pull/460)
- [@&#8203;nitsujri](https://github.com/nitsujri) made their first
contribution in
[https://github.com/bkeepers/dotenv/pull/423](https://github.com/bkeepers/dotenv/pull/423)

**Full Changelog**:
bkeepers/dotenv@v2.8.1...v3.0.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/powerhome/power-web-development-interview).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4xNzMuMCIsInVwZGF0ZWRJblZlciI6IjM3LjE3My4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet