@shelf/jest-gremlin

1.0.5 • Public • Published

jest-gremlin CircleCI npm (scoped)

Jest preset to run Gremlin server before tests

Usage

1. Have Docker installed!

Visit Docker to install Docker.

2. Install

$ yarn add @shelf/jest-gremlin --dev

3. Create jest.config.js

module.exports = {
  preset: '@shelf/jest-gremlin',
};

If you have a custom jest.config.js make sure you remove testEnvironment property, otherwise it will conflict with the preset.

4. Create jest-gremlin-config.js

import cwd from 'cwd';

module.exports = {
  port: 8182,
  protocol: 'ws',
  imageName: 'tinkerpop/gremlin-server', // or your custom prebuilt image
  imagePort: 8182, // port on which gremlin server is running inside the container
  containerName: 'gremlin-server', // or your custom container name that would be spin up
  maxTries: 10, // how many times to try to connect to gremlin server ()
  triesInterval: 1000, // interval between tries
};

5. PROFIT! Write tests

it();

Monorepo Support

By default the jest-gremlin-config.js is read from cwd directory, but this might not be suitable for monorepos with nested jest projects with nested jest.config.* files nested in subdirectories.

If your jest-gremlin-config.js file is not located at {cwd}/jest-gremlin-config.js or you are using nested jest projects, you can define the environment variable JEST_GREMLIN_CONFIG with the absolute path of the respective jest-gremlin-config.js file.

Example Using JEST_GREMLIN_CONFIG in nested project

// src/nested/project/jest.config.js
const path = require('path');

// Define path of project level config - extension not required as file will be imported
// via `require(process.env.JEST_GREMLIN_CONFIG)`
process.env.JEST_GREMLIN_CONFIG = path.resolve(__dirname, './jest-gremlin-config');

module.exports = {
  preset: '@shelf/jest-gremlin',
  displayName: 'nested-project',
};

See Also

Publish

$ git checkout master
$ yarn version
$ yarn publish
$ git push origin master --tags

License

MIT © Shelf

Package Sidebar

Install

npm i @shelf/jest-gremlin

Weekly Downloads

30

Version

1.0.5

License

MIT

Unpacked Size

10.5 kB

Total Files

17

Last publish

Collaborators

  • vladmarchuk
  • vadymaslovskyi
  • andrew_batutin
  • marianna-milovanova
  • petro.bodnarchuk
  • kateryna-kochina
  • maksym.tarnavskyi
  • andrii-nastenko
  • mykhailo.yatsko
  • ahavrysh
  • nikita_shelf
  • maciej.orlowski
  • monopotan
  • andrew214
  • bogdan.kolesnyk
  • andrii.batutin
  • kristina.zhak
  • anton-russo
  • mmazurowski
  • mateuszgajdashelf
  • kchlon
  • dmytro.harazdovskiy
  • duch0416
  • i5adovyi
  • olesiamuller
  • mykola.khytra
  • yuliiakovalchuk
  • el_scrambone
  • bodyaflesh
  • andriisermiahin
  • mpushkin
  • batovpavlo
  • domovoj
  • vozemer
  • oleksii.dymnich
  • dima-bond
  • maksym.hayovets
  • oles.zadorozhnyy
  • ss1l
  • gemshelf
  • hartzler
  • vladgolubev
  • hmelenok
  • knupman
  • maaraanas
  • terret
  • chapelskyi.slavik
  • pihorb
  • irynah
  • diana.kryskuv
  • andy.raven
  • rafler
  • sskalp88
  • demiansua
  • yuriil
  • ktv18
  • drews_abuse
  • rostyslav-horytskyi
  • whodeen