refactor(NODE-3717): move gridfs and csfle tests to the integration directory #3062
Conversation
dariakp
changed the title
There was a problem hiding this comment.
Looks good! The test readme changes made sense to me. Since you said this was moving existing tests, I didn't look through the specifics of each test.
One question: the deadlock_tests.js file references https://github.com/mongodb/specifications/blob/b3beada72ae1c992294ae6a8eea572003a274c35/source/client-side-encryption/tests/README.rst#deadlock-tests. Should that file name have .prose in it?
| | TypeScript Definition | `/test/types` | The TypeScript definition tests verify the type definitions are correct. | `npm run check:tsd` | | ||
| | Type of Test | Test Location | About the Tests | How to Run Tests | | ||
| | ----------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | Unit | `/test/unit` | The unit tests test individual pieces of code, typically functions. These tests do **not** interact with a real database, so mocks are used instead. <br><br>The unit test directory mirrors the `/src` directory structure with test file names matching the source file names of the code they test. | `npm run check:unit` | |
There was a problem hiding this comment.
Thanks! And yeah, good call out on the deadlock tests, I didn't look very closely but I think the deadlock tests can be combined into the prose tests (like Neal also pointed out on the thread). The specific file is just the input to the tests, so I think I can rename it to better reflect that fact.
There was a problem hiding this comment.
Just pushed the update
Co-authored-by: Lauren Schaefer <lauren.schaefer@mongodb.com>
4 participants
Description
NODE-3717 - part 1
What is changing?
Moving gridfs and csfle tests from functional to integration. Broke out gridfs spec tests into their own file. Made sure to update the csfle script to reference the new location and confirmed that the csfle test count in evergreen matches their count in main. Made sure the gridfs tests all still run.
Created temporary copies of the legacy spec runner in tools and the shared.js file in integration. Didn't want to touch every other file that's still in /functional by actually moving them. The duplicates that are in functional can be deleted once the entire suite is moved over. I'd love to get rid of the shared.js file altogether, but that would require more invasive refactoring of the individual tests than we presently have time for.
Is there new documentation needed for these changes?
Nothing beyond the update included in this PR to the test readme which explains the integration/functional test split as well as the spec/prose test file naming conventions.
What is the motivation for this change?
Sane organization of our test suite.
Double check the following
npm run check:lintscript<type>(NODE-xxxx)<!>: <description>