Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/antman261/tiny-fixtures
A very simple javascript package for database fixtures
https://github.com/antman261/tiny-fixtures
database database-fixtures database-testing fixture-test fixtures nodejs testing testing-javascript testing-tools typescript
Last synced: 2 months ago
JSON representation
A very simple javascript package for database fixtures
- Host: GitHub
- URL: https://github.com/antman261/tiny-fixtures
- Owner: Antman261
- License: mit
- Created: 2021-05-04T13:00:19.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-19T02:23:34.000Z (over 1 year ago)
- Last Synced: 2024-04-26T21:21:12.414Z (9 months ago)
- Topics: database, database-fixtures, database-testing, fixture-test, fixtures, nodejs, testing, testing-javascript, testing-tools, typescript
- Language: TypeScript
- Homepage: https://tiny-fixtures.com
- Size: 626 KB
- Stars: 6
- Watchers: 2
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Tiny Fixtures [](https://app.circleci.com/pipelines/github/Antman261/tiny-fixtures) [](https://www.npmjs.com/package/tiny-fixtures) [](https://www.npmjs.com/package/tiny-fixtures) [](http://commitizen.github.io/cz-cli/)
## Installation
Run `npm i -D tiny-fixtures` to save to your dev dependencies.
## Compatibility
Currently, only tested against Postgres flavoured SQL assuming a node-postgres connection pool.
## Usage
Initialise a fixture manager by providing it with a connection pool.
TinyFixtures will return an object with a `createFixtures` function.
```ts
import { tinyFixtures } from 'tiny-fixtures';
import { pool } from './db/connection';
import { getUsers } from '/db/users';
const { createFixtures } = tinyFixtures(pool)
describe('my test cases', () => {
const [setupUserFixtures, teardownUserFixtures] = createFixtures('users', [
{
email: '[email protected]',
username: 'tinyAnt'
}, {
email: '[email protected]',
username: 'antTiny',
}
]);
beforeEach(async () => {
await setupUserFixtures();
});
afterEach(async () => {
await teardownUserFixtures();
});
it('should have two users in the database', async () => {
expect((await getUsers()).length).to.equal(2);
});
})
```
`createFixtures` takes
* a table name
* an array of objects
Each object in the array is a row to insert. The setup function uses each row object's keys as column names.
In the example above, tiny-fixtures will insert into columns `email` and `username`.
`createFixtures` returns two functions:
* setupFixtures,
* teardownFixtures
Call these functions in your before each and after each hook respectively. Tiny fixtures will then ensure you have clean data for each test. Additionally, it will preserve existing data in the database, improving the local development experience.
To create fixtures across foreign keys use the third value returned
by `createFixtures` to populate the next table, being sure to correctly order your
setup and teardown steps.
```ts
import { tinyFixtures } from 'tiny-fixtures';
import { pool } from './db/connection';
import { getUsers } from '/db/users';
const { createFixtures } = tinyFixtures(pool);
describe('my test cases', () => {
const [setupUserFixtures, teardownUserFixtures, users] = createFixtures('users', [
{
email: '[email protected]',
username: 'tinyAnt'
}, {
email: '[email protected]',
username: 'antTiny',
}
]);
const [setupUserMessageFixtures, teardownUserMessageFixtures] = createFixtures(
'user_messages',
[{
user_id: users[0].getRefByKey('id'),
message: 'Foobar did the bar foo good',
},
{
user_id: users[0].getRefByKey('id'),
message: 'I am a meat popsicle',
}]
)
beforeEach(async () => {
await setupUserFixtures();
await setupUserMessageFixtures();
});
afterEach(async () => {
await teardownUserMessageFixtures();
await teardownUserFixtures();
});
it('should have a user with two messages, and one with none', async () => {
const users = await getUsers();
expect(users.length).to.equal(2);
expect(users[0].messages.length).to.equal(2);
expect(users[1].messages.length).to.equal(0);
});
})
```
Pay attention to the ordering -- following these simple patterns is what keeps tiny-fixtures tiny!
### Explaining `user_id: users[0].getRefByKey('id')`
Because the fixture hasn't been inserted into the database yet, tiny-fixtures doesn't have any serial/sequence values in the row array returned as the 3rd return value. `getRefByKey` takes the column name of the primary key for the parent object in the foreign key, allowing the value to be resolved when the setup step occurs.
Tiny-fixtures resolves the value at setup by inspecting the row objects you provided for functions. When it finds one, it looks up the result for that column in the original object, and populates its value before continuing the insert.
Tiny-fixtures is then able to create and destroy fixtures across foreign keys for each test run.
### Docs
Full documentation located at [https://www.tiny-fixtures.com/modules.html](https://www.tiny-fixtures.com/modules.html)
## Changelog
See [CHANGELOG.md](https://github.com/Antman261/tiny-fixtures/blob/main/CHANGELOG.md)