Socket
Socket
Sign inDemoInstall

@shelf/jest-elasticsearch

Package Overview
Dependencies
107
Maintainers
53
Versions
13
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @shelf/jest-elasticsearch

Run your tests using jest & elasticsearch-local


Version published
Weekly downloads
1.1K
increased by10.98%
Maintainers
53
Created
Weekly downloads
 

Changelog

Source

4.0.0

  • Upgrade jest to version 28

Readme

Source

jest-elasticsearch

Jest preset for running tests with local ElasticSearch

Usage

0. Install

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

1. Create jest.config.js

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

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

2. Create jest-es-config.js

module.exports = () => {
  return {
    esVersion: '7.6.0', // ! must be exact version. Ref: https://github.com/elastic/elasticsearch-js .
    // don't be shy to fork our code and update deps to correct.
    clusterName: 'your-cluster-name',
    nodeName: 'your-node-name',
    port: 9200,
    indexes: [
      {
        name: 'your-index-name',
        body: {
          settings: {
            number_of_shards: '1',
            number_of_replicas: '1'
          },
          aliases: {
            'your-alias': {}
          },
          mappings: {
            dynamic: false,
            properties: {
              //here you should paste your mapping
              //Example:
              id: {
                type: 'keyword'
              }
            }
          }
        }
      }
    ]
  };
};

4. PROFIT! Write tests

it();

Troubleshooting

Issue running tests locally - Exception in thread "main"
Exception in thread "main'
java.lang.UnsupportedOperationException The Security Manager is deprecated and will be removed in a future release
at java.base/java.lang.System.setSecurityManager(System. java: 416)
at ora.elasticsearch.bootstrap.Elasticsearch.main(Elasticsearch.iava:71

The main reason why this issue appears is that you have an incompatible java version installed to run elastic locally.

What to do?

  1. List current java versions
$ /usr/libexec/java_home -V
  1. If you see version 1.8.xxx Add this command to your bashrc, zshrc, etc
$ /usr/libexec/java_home -v 1.8
  1. If you see no versions or do not have a compatible version installed - Install version 1.8xxx https://www.java.com/en/download/

  2. Reload the console and check the java version with

$ java -version

Output for proper work

$ java -version
java version "1.8.0_333"
Java(TM) SE Runtime Environment (build 1.8.0_333-b02)
Java HotSpot(TM) 64-Bit Server VM (build 25.333-b02, mixed mode)
  1. Go to step 2 and set version 1.8xx as a default for the shell

See Also

Publish

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

License

MIT © Shelf

Keywords

FAQs

Last updated on 27 Jul 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc