feat: ability to generate multiple sets of autotests #28
Conversation
KuznetsovRoman
force-pushed
the
TESTPLANE-320.autoscreenshot_globals
branch
2 times, most recently
from
6364eca to
05b5365
Compare
| const result = await openStoryStep(ctx.browser, story, globals); | ||
|
|
||
| await autoScreenshotStep(ctx.browser, story.autoscreenshotSelector || result.rootSelector); | ||
| }); | ||
| await autoScreenshotStep(ctx.browser, story.autoscreenshotSelector || result.rootSelector); |
There was a problem hiding this comment.
I dont want to separate "update globals" to different step because it is extra http request and we would need to re-render the story itself. Because of this, globals are updated right before story setting, so we would have to do this only once.
| ? story.autoScreenshotStorybookGlobals | ||
| : autoScreenshotStorybookGlobals; |
There was a problem hiding this comment.
Picking "which autoScreenshotStorybookGlobals to use" betweenautoScreenshotStorybookGlobals from testplane.config.ts and autoScreenshotStorybookGlobals from storyfile, preferring the storyfile one.
If storyfile globals are defined, using it without merging with testplane.config.ts version
There was a problem hiding this comment.
I thought we might encounter situation, when user does not need to test some component with multiple themes.
On the other hand, if this case will happen, we could bring another PR and make story.autoScreenshotStorybookGlobals to be type of either Record, either function, where config defaults are passed as first argument, so user will be able to do it.
So, i will merge them
| done: (result: string) => void, | ||
| ) => void; | ||
| __TESTPLANE_STORYBOOK_INITIAL_GLOBALS__?: Record<string, unknown>; | ||
| __STORYBOOK_PREVIEW__?: { storeInitializationPromise?: Promise<void> }; |
There was a problem hiding this comment.
Storybook preview. Here is storeInitializationPromise is stored. We can't emit "updateGlobals" until storybook preview is initialized
| remountOnly: boolean, | ||
| done: (result: string) => void, | ||
| ) => void; | ||
| __TESTPLANE_STORYBOOK_INITIAL_GLOBALS__?: Record<string, unknown>; |
There was a problem hiding this comment.
storybook does not save initial (default) globals, so we have to do it ourselves
| const storybookPreview = (window as StorybookWindow).__STORYBOOK_PREVIEW__; | ||
| const isStorybookPreviewAvailable = storybookPreview && storybookPreview.storeInitializationPromise; | ||
| const shouldUpdateStorybookGlobals = storybookGlobals && isStorybookPreviewAvailable; | ||
|
|
||
| if (shouldUpdateStorybookGlobals) { | ||
| (storybookPreview.storeInitializationPromise as Promise<void>).then(function () { | ||
| let defaultGlobals = (window as StorybookWindow).__TESTPLANE_STORYBOOK_INITIAL_GLOBALS__; | ||
|
|
||
| if (!defaultGlobals) { | ||
| const setGlobalCalls = (window as StorybookWindow).__STORYBOOK_ADDONS_CHANNEL__.data?.setGlobals; | ||
| const initValue = (setGlobalCalls && setGlobalCalls[0].globals) || {}; | ||
|
|
||
| defaultGlobals = (window as StorybookWindow).__TESTPLANE_STORYBOOK_INITIAL_GLOBALS__ = initValue; | ||
| } |
There was a problem hiding this comment.
Saving first setGlobal call in order to handle these cases:
- test1 sets globals {a: "b"}
- test2 sets globals {c: "d"}
In this scenario, test2 has globals {a:"b"} already set and he only updates {c:"d"}. So, in order to make tests independent from order, we are merging default globals with user-called globals
In other tests in this session we can reuse these default globals from "TESTPLANE_STORYBOOK_INITIAL_GLOBALS" as long as we don't reload the page. And in case if we do, we could pull initial globals from setGlobalCalls
| if (!channel) { | ||
| result.loadError = "Couldn't find storybook channel. Looks like the opened page is not storybook preview"; | ||
|
|
||
| if (shouldRemount) { | ||
| channel.emit("setCurrentStory", { storyId: "" }); | ||
| doneJson(result); | ||
| } |
There was a problem hiding this comment.
This error is thrown if loaded url is not storybook url (for example, if our baseUrl was invalidly changed by some other plugin)
| channel.emit("setCurrentStory", { storyId }); | ||
| const storybookPreview = (window as StorybookWindow).__STORYBOOK_PREVIEW__; | ||
| const isStorybookPreviewAvailable = storybookPreview && storybookPreview.storeInitializationPromise; | ||
| const shouldUpdateStorybookGlobals = storybookGlobals && isStorybookPreviewAvailable; |
There was a problem hiding this comment.
Even if storybookGlobals is empty, we should updateGlobals, because previous test might set something, and we need to reset it
| ? story.autoScreenshotStorybookGlobals | ||
| : autoScreenshotStorybookGlobals; |
KuznetsovRoman
force-pushed
the
TESTPLANE-320.autoscreenshot_globals
branch
5 times, most recently
from
a5dd1d0 to
432ac7a
Compare
KuznetsovRoman
force-pushed
the
TESTPLANE-320.autoscreenshot_globals
branch
from
432ac7a to
63eb93c
Compare
What is done
autoScreenshotStorybookGlobalsoption (can be specified in storyfile and in plugin config).It can be specified in order to create multiple sets of autoscreenshot tests with different storybook global values
For example, with
autoScreenshotStorybookGlobalsis set to:{ "default": {}, "light theme": { "theme": "light" }, "dark theme": { "theme": "dark" } }there would be 3 screenshot tests for each story, with each having corresponding storybook
globalsvalue:... Autoscreenshot default... Autoscreenshot light theme... Autoscreenshot dark theme