Merge pull request #21 from gemini-testing/TESTPLANE-71.autoscreensho…

…tSelector

feat: add ability to specify autoscreenshotSelector in story-files

README.md

@@ -101,6 +101,7 @@ const meta: WithTestplane<Meta<typeof Button>> = {
     component: Button,
     testplane: {
         skip: false, // if true, skips all Testplane tests from this story file
+        autoscreenshotSelector: ".my-selector", // Custom selector to auto-screenshot elements
         browserIds: ["chrome"], // Testplane browsers to run tests from this story file
         assertViewOpts: { // override default assertView options for tests from this file
             ignoreDiffPixelCount: 5

src/storybook/story-test-runner/extend-stories.ts

@@ -44,6 +44,7 @@ export function extendStoriesFromStoryFile(stories: StorybookStory[]): Storybook
                 story.skip = testplaneStoryOpts.skip || false;
                 story.assertViewOpts = testplaneStoryOpts.assertViewOpts || {};
                 story.browserIds = testplaneStoryOpts.browserIds || null;
+                story.autoscreenshotSelector = testplaneStoryOpts.autoscreenshotSelector || null;
             });
 
             continue;

src/storybook/story-test-runner/index.ts

@@ -24,7 +24,7 @@ function createTestplaneTests(story: StorybookStoryExtended, { autoScreenshots }
 
                 const result = await openStoryStep(ctx.browser, story);
 
-                await autoScreenshotStep(ctx.browser, result.rootSelector);
+                await autoScreenshotStep(ctx.browser, story.autoscreenshotSelector || result.rootSelector);
             });
         }
 

src/storybook/story-test-runner/open-story/index.ts

@@ -34,7 +34,7 @@ export async function openStory(browser: WebdriverIO.Browser, story: StorybookSt
             throw new PlayFunctionError(storyLoadResult.playFunctionError);
         }
 
-        if (!storyLoadResult.rootSelector) {
+        if (!story.autoscreenshotSelector && !storyLoadResult.rootSelector) {
             throw new Error("Story root selector is not found");
         }
 

src/storybook/story-test-runner/types.ts

@@ -7,6 +7,7 @@ export interface StorybookStoryExtended extends StorybookStory {
     assertViewOpts: AssertViewOpts;
     browserIds: Array<string | RegExp> | null;
     extraTests?: Record<string, TestplaneTestFunction>;
+    autoscreenshotSelector: string | null;
 }
 
 export type ExecutionContextExtended = WebdriverIO.Browser["executionContext"] & {

src/types.ts

@@ -22,6 +22,7 @@ export type TestplaneMetaConfig<T = void> = Combined<
         skip?: boolean;
         assertViewOpts?: AssertViewOpts;
         browserIds?: Array<string | RegExp>;
+        autoscreenshotSelector?: string;
     }>,
     T
 >;