Update api_spec to not use capyabara #106
Open
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
baffers
requested review from
brettfishman,
bwebster and
a team
as code owners
| @@ -47,7 +47,7 @@ def bootstrap_api | |||
| copy_file "app/models/api_client.rb" | |||
| copy_file "config/initializers/stitches.rb" | |||
| copy_file "lib/tasks/generate_api_key.rake" | |||
| template "spec/features/api_spec.rb.erb", "spec/features/api_spec.rb" | |||
| template "spec/requests/api_spec.rb.erb", "spec/requests/api_spec.rb" | |||
There was a problem hiding this comment.
I wonder if rather than moving to request specs, we should be migrating to system specs which (IIRC) provide the benefits of feature tests (e.g. integration tests) without the need of the capybara gem? Whereas request specs are essentially testing from the controller perspective. Nix that whole comment :)
There was a problem hiding this comment.
Whoops, looks like I misremembered that! System tests also use Capybara under the hood.
brettfishman
approved these changes
Oct 26, 2021
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.
Problem
The
api_specis a feature test, which means it requires the capybara gem. Most services probably don't need capybara since it's usually for testing front end interactions. We can achieve the same result as the feature test by using a request spec, which means that services won't require capybara off the bat.Solution
Update
api_specto be a request spec instead of a feature test (also opening a PR in app-template)