Update TESTING.md for running tests in lib directory #42857
Merged
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
katleiahramos
commented
Oct 6, 2021
| * Pegasus directory | ||
| * Ruby tests - Test server side logic, caching, graphics, etc. | ||
|
|
||
| ### When tests are run | ||
|
|
||
| <!---- Can use http://markdowntable.com/ for reformatting help ---> | ||
|
|
||
| | | ruby lint | scss lint | haml lint | JavaScript eslint (everywhere) | apps test | dashboard unit tests | UI tests (Chrome) | UI tests (all browsers) | eyes UI tests | pegasus unit tests | shared unit tests | | ||
| | | ruby lint | scss lint | haml lint | JavaScript eslint (everywhere) | apps test | dashboard unit tests | UI tests (Chrome) | UI tests (all browsers) | eyes UI tests | pegasus unit tests | shared and lib unit tests | |
There was a problem hiding this comment.
Can someone confirm this is true? haha that both shared and lib share run in circle CI and test build? Happy to update this to be more accurate if needed!
TESTING.md
Outdated
Comment on lines
13
to
14
| * Shared and Lib directory | ||
| * Ruby tests - Unit tests over Ruby code in the shared and lib directory. |
There was a problem hiding this comment.
nit: "directory" should be "directories" now
There was a problem hiding this comment.
updated here: 4cb57af
| * Pegasus directory | ||
| * Ruby tests - Test server side logic, caching, graphics, etc. | ||
|
|
||
| ### When tests are run | ||
|
|
||
| <!---- Can use http://markdowntable.com/ for reformatting help ---> | ||
|
|
||
| | | ruby lint | scss lint | haml lint | JavaScript eslint (everywhere) | apps test | dashboard unit tests | UI tests (Chrome) | UI tests (all browsers) | eyes UI tests | pegasus unit tests | shared unit tests | | ||
| | | ruby lint | scss lint | haml lint | JavaScript eslint (everywhere) | apps test | dashboard unit tests | UI tests (Chrome) | UI tests (all browsers) | eyes UI tests | pegasus unit tests | shared and lib unit tests | |
TESTING.md
Outdated
Comment on lines
64
to
70
| Tests in the `shared/` and `lib/` directories need to be run slightly differently since they are outside of our Rails environment. | ||
|
|
||
| `cd shared && ruby -Itest ./test/path/to/your/test.rb` will run the specified | ||
| test file in the shared directory. | ||
|
|
||
| `cd lib && ruby -Itest ./test/path/to/your/test.rb` will run the specified | ||
| test file in the lib directory. |
There was a problem hiding this comment.
nit: i think we can simplify/deduplicate this for clarity. maybe something like
Suggested change
| Tests in the `shared/` and `lib/` directories need to be run slightly differently since they are outside of our Rails environment. | |
| `cd shared && ruby -Itest ./test/path/to/your/test.rb` will run the specified | |
| test file in the shared directory. | |
| `cd lib && ruby -Itest ./test/path/to/your/test.rb` will run the specified | |
| test file in the lib directory. | |
| Tests in the `shared/` and `lib/` directories are run slightly differently than `dashboard/` since they are outside of our Rails environment. To run a test file in either directory, `cd` into it before running the tests. Example: | |
| ```bash | |
| cd shared | |
| ruby -Itest ./test/path/to/your/test.rb |
There was a problem hiding this comment.
my suggestion got kind of messed up because there are nested code blocks 😢 this is the example code block i tried to write above (using bash for syntax highlighting):
cd shared
ruby -Itest ./test/path/to/your/test.rbThere was a problem hiding this comment.
updated here: 4cb57af
maddiedierker
approved these changes
Oct 6, 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.
Small updates to TESTING.md instructions to include information about running tests in
lib/directory