Async setup of environment with Jest

Question

Before running e2e tests in Jest I need to get an authentication token from the server.

Is it possible to do this globally one and set it somehow to the global environment / context for each test ?

I tried it with globalSetup config option:

const auth = require('./src/auth')
const ctx = require('./src/context')

module.exports = () => {
    return new Promise(res => {
        auth.getToken()
            .then(token => {
                ctx.init({token})
                global.token = token
                res()
            })

    })
}

context.js

let _token

const init = ({token}) => {
    _token = token
}

const getToken = () => {
    return _token
}

module.exports = {
    init,
    getToken

}

But both global.token nor ctx.getToken() return undefined.

I need to use helper script and to pass token as env var which is then set as global.

  "scripts": {
    "test": "TOKEN=$(node src/get-token.js) jest"
  },

Is there a better approach (which does not involve shell) ?

Answer 1

There's a CLI/config option called: setupFiles, it runs immediately before executing the test code itself.

"jest": {
  "globals": {
    "__DEV__": true,
    ...
  },
  "setupFiles": [
    "./setup.js"
  ]
}

setup.js might look something like:

(async function() {
    // const { authToken } = await fetchAuthTokens()
    global.authToken = '123'
})()

And then you can access authToken directly in each test suites (files) like beforeAll(_ => console.log(authToken)) // 123.

---

However, if you want a global setup that runs per worker(cpu core) instead of per test file (recommended by default since test suites are sandboxed). Based on current jest API constraints, you may choose to customize your test's runtime environment through the testEnvironment option. Then you need to implement a custom class that extends jsdom/node environment exposes setup/runScript/teardown api.

Example:

customEnvironment.js

// my-custom-environment
const NodeEnvironment = require('jest-environment-node');

class CustomEnvironment extends NodeEnvironment {
  constructor(config) {
    super(config);
  }

  async setup() {
    await super.setup();
    const token = await someSetupTasks();
    this.global.authToken = token;
  }

  async teardown() {
    await super.teardown();
    await someTeardownTasks();
  }

  runScript(script) {
    return super.runScript(script);
  }
}

my-test.js

let authToken;

beforeAll(() => {
  authToken = global.authToken;
});

Answer 2

Ini my case, I had to get the token for current session once. Here I used globalSetup property in jest config. Ref: https://jestjs.io/docs/en/configuration#globalsetup-string

My jest.config:

module.exports = {
  globalSetup: "./tests/global-setup.js",
  // ..other config... 
  globals: {
      TEST_EMAIL: '[email protected]',
      TEST_PASSWORD: 'some_password',
  }
}

global-setup.js:

 module.exports = async function() {
  const getSessionToken = () => {
    // api call to get SessionToken
    /* return fetch() */
  }

  sessionToken = await getSessionToken();
  process.env.SESSION_TOKEN = sessionToken;
 }