Document globalSetup usage

[adamyonk]

In the documentation there is reference to setting up authentication in globalSetup and then sharing that login across all test runs:

1. Run tests (for example, with npm run test).
2. Login via UI and retrieve authentication state.
   • In Jest, this can be executed in globalSetup.
3. In each test, load authentication state in beforeEach or beforeAll step.

This seems to suggest a setup like:

// jest.config.js
module.exports = {
  globalSetup: '<rootDir>/jest.globalSetup.js',
  preset: 'jest-playwright-preset',
  setupFilesAfterEnv: ['expect-playwright', '<rootDir>/jest.setup.js'],
}

But there is nothing playwright-related setup when globalSetup runs:

// jest.globalSetup.js
module.exports = async function globalSetup() {
  console.log('setting up', Object.keys(global));
};

So does going this route require manually setting up playwright, or is there some way to get access to the instance that jest-playwright-preset creates?

[mmarkelov]

@adamyonk it seems like that documentation is not correct.
globalSetup and globalTeardown are relative to Jest. These methods are run before starting Jest tests.

So i think you can use beforeAll in your test.

There was some workaround in jest-puppeteer, and that i can try to implement

[adamyonk]

Yeah, correct me if I'm wrong, but beforeAll is run before every test in that test file, but if you want to do something only once for the whole test suite it needs to be in globalSetup? I think the once-per-test-suite is what I'm after, so I can login once and not have to do it over and over.

[adamyonk]

Perhaps there is some way to serialize the context.storageState() into memory once and then have it available to any other browser instances?

[mmarkelov]

Yeah, correct me if I'm wrong, but beforeAll is run before every test in that test file, but if you want to do something only once for the whole test suite it needs to be in globalSetup? I think the once-per-test-suite is what I'm after, so I can login once and not have to do it over and over.

@adamyonk that's true. But I think you can move it to setupFilesAfterEnv block:

// jest.config.js
module.exports = {
    "setupFilesAfterEnv": [
        "expect-playwright",
        "jest-playwright-preset/lib/extends.js",
        "./setup.js"
    ],
    preset: 'jest-playwright-preset',
}

// setup.js
beforeAll(async () => {
    // some login stuff
})

[adamyonk]

Cool, thanks for the info!

setupFilesAfterEnv
A list of paths to modules that run some code to configure or set up the testing framework before each test file in the suite is executed.

I think it would be nice to somehow have that happen once-per-suite and not before each test file, but that will work for now.

[mmarkelov]

I think it would be nice to somehow have that happen once-per-suite and not before each test file, but that will work for now.

@adamyonk yes. But i'm not sure in other ways to handle with it. I can try to make it available in globalSetup, but i suppose it will be complicated. Right now starting browser occurs in custom environment and we can’t pass playwright stuff to globalSetup.

[Xezed]

I would like to see this feature too.
So... can find some time to dive into package myself and try to implement it.
Are you interested in it @mmarkelov ?

[mmarkelov]

@Xezed I'm going to work on this. I think it can be helpful. But it will quite difficult to rewrite

[Xezed]

Just FYI I was looking for authentication solution and stumbled upon this thread.
Thank you for being this fast :)

[Xezed]

@mmarkelov how long do you think this will take you to implement? Any estimations?
I've just started to implement the solution for my company and this feature is crucial.
Sorry for being pushy but I need to give my management some estimations to not feel dorky 😄

[mmarkelov]

@Xezed hello! I just made some investigation on it. And just didn't find any suitable solution. It's very treaky to pass playwright object correctly. I thought about the solution that used in jest-puppeteer. But this won't cover all cases and will be able to use only if we will launch browser server. So to be honest that’s all what I've done here