Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jurerotar/opfs-mock
This is an in-memory implementation of the origin private file system for usage in your Jest or Vitest tests.
https://github.com/jurerotar/opfs-mock
browser jest nodejs opfs storage testing vitest
Last synced: 8 days ago
JSON representation
This is an in-memory implementation of the origin private file system for usage in your Jest or Vitest tests.
- Host: GitHub
- URL: https://github.com/jurerotar/opfs-mock
- Owner: jurerotar
- License: mit
- Created: 2024-10-04T16:34:18.000Z (about 1 month ago)
- Default Branch: master
- Last Pushed: 2024-10-04T16:36:52.000Z (about 1 month ago)
- Last Synced: 2024-10-05T16:41:51.061Z (about 1 month ago)
- Topics: browser, jest, nodejs, opfs, storage, testing, vitest
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/opfs-mock
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# opfs-mock
This is a pure JS in-memory implementation of the [origin private file system](https://developer.mozilla.org/en-US/docs/Web/API/File_System_API/Origin_private_file_system). Its main utility is for testing OPFS-dependent code in Node.js.
## Installation
```shell
npm install -save-dev opfs-mock
```
## Usage
It replicates the behavior of origin private file system, except data is not persisted to disk.
The easiest way to use it is to import `opfs-mock`, which will polyfill OPFS API to global scope.
```ts
import "opfs-mock";
```
Alternatively, you can explicitly import `storage`:
```ts
import { storage } from "opfs-mock";
test('Your test', async () => {
const root = await storage.getDirectory();
const directoryHandle = await root.getFileHandle('test-file.txt', { create: true });
// rest of your test
});
```
### Vitest
To use `opfs-mock` in a single Vitest test suite, require `opfs-mock` at the beginning of the test file, as described above.
To use it on all Vitest tests without having to include it in each file, add the auto setup script to the `test.setupFiles` in your Vite config:
```ts
// vite.config.js
{
...
test: {
setupFiles: ['opfs-mock'],
},
}
```
Alternatively you can create a new setup file which then imports this module.
```ts
// vitest-setup.ts
import "opfs-mock";
```
Add that file to your `test.setupFiles` array:
```ts
// vite.config.ts
import { defineConfig } from 'vite'
export default defineConfig({
test: {
setupFiles: ['vitest-setup.ts'],
}
});
```
### Jest
To use `opfs-mock` in a single Jest test suite, require `opfs-mock` at the beginning of the test file, as described above.
To use it on all Jest tests without having to include it in each file, add the auto setup script to the `setupFiles` in your Jest config:
```ts
// jest.config.js
{
...
"setupFiles": [
"opfs-mock"
]
}
```
Alternatively you can create a new setup file which then imports this module.
```ts
// jest-setup.ts
import "opfs-mock";
```
Add that file to your `setupFiles` array:
```ts
// jest.config.js
{
...
"setupFiles": [
"jest-setup"
]
}
```
## Wiping/resetting the OPFS mock for a fresh state
If you are keeping your tests completely isolated you might want to "reset" the state of the mocked OPFS. You can do this by using `resetMockOPFS` function, which creates a completely new instance of the mock.
```ts
import { resetMockOPFS } from 'opfs-mock';
beforeEach(() => {
resetMockOPFS();
});
test('First isolated test', async () => {
// rest of your test
});
test('Second isolated test', async () => {
// rest of your test
});
```