creevey 0.10.0-beta.4 → 0.10.0-beta.41

package/src/types.ts

@@ -1,11 +1,10 @@
-import type { StoryContextForEnhancers, DecoratorFunction } from '@storybook/csf';
+import type { StoryContextForEnhancers, DecoratorFunction } from '@storybook/types';
 import type { Worker as ClusterWorker } from 'cluster';
 import type Pixelmatch from 'pixelmatch';
 import type { ODiffOptions } from 'odiff-bin';
 import type { expect } from 'chai';
 import type EventEmitter from 'events';
-import type Logger from 'loglevel';
-import { LaunchOptions } from 'playwright-core';
+import type { LaunchOptions } from 'playwright-core';
 // import type { Browser } from 'playwright-core';
 
 /* eslint-disable @typescript-eslint/no-explicit-any */
@@ -103,6 +102,7 @@ export class ChromeConfig {
 }
 */
 export interface BrowserConfigObject {
+  // TODO Restrict browser names for playwright images
   browserName: string;
   // customizeBuilder?: (builder: Builder) => Builder;
   limit?: number;
@@ -145,7 +145,13 @@ export interface BrowserConfigObject {
     [name: string]: unknown;
   };
 
-  playwrightOptions?: Omit<LaunchOptions, 'logger'>;
+  playwrightOptions?: Omit<LaunchOptions, 'logger'> & {
+    trace?: {
+      screenshots?: boolean;
+      snapshots?: boolean;
+      sources?: boolean;
+    };
+  };
 }
 
 export type StorybookGlobals = Record<string, unknown>;
@@ -164,7 +170,7 @@ export interface CreeveyWebdriver {
   openBrowser(fresh?: boolean): Promise<CreeveyWebdriver | null>;
   closeBrowser(): Promise<void>;
   loadStoriesFromBrowser(): Promise<StoriesRaw>;
-  switchStory(story: StoryInput, context: BaseCreeveyTestContext, logger: Logger.Logger): Promise<CreeveyTestContext>;
+  switchStory(story: StoryInput, context: BaseCreeveyTestContext): Promise<CreeveyTestContext>;
   afterTest(test: ServerTest): Promise<void>;
 }
 
@@ -183,7 +189,7 @@ export interface DockerAuth {
 }
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type BaseReporter = new (runner: EventEmitter, options: { reporterOptions: any }) => void;
+export type BaseReporter = new (runner: EventEmitter, options: { reportDir: string; reporterOptions: any }) => void;
 
 export interface Config {
   /**
@@ -200,6 +206,11 @@ export interface Config {
    * Url where storybook hosted on
    */
   resolveStorybookUrl?: () => Promise<string>;
+  /**
+   * Command to automatically start Storybook if it is not running.
+   * For example, `npm run storybook`, `yarn run storybook` etc.
+   */
+  storybookAutorunCmd?: string;
   /**
    * Absolute path to directory with reference images
    * @default path.join(process.cwd(), './images')
@@ -213,8 +224,9 @@ export interface Config {
   /**
    * Specify a custom reporter for test results. Creevey accepts only mocha-like reporters
    * @optional
+   * @default 'creevey'
    */
-  reporter: BaseReporter;
+  reporter: BaseReporter | 'creevey' | 'teamcity' | 'junit';
   /**
    * Options which are used by reporter
    */
@@ -307,6 +319,11 @@ export interface Config {
    * The `--ui` CLI option ignores this option
    */
   failFast: boolean;
+  /**
+   * Start workers in sequential queue
+   * @default false
+   */
+  useWorkerQueue: boolean;
   /**
    * Specify platform for docker images
    */
@@ -348,9 +365,13 @@ export interface Options {
   screenDir?: string;
   reportDir?: string;
   gridUrl?: string;
+  storybookStart?: boolean | string;
   storybookUrl?: string;
+  storybookPort?: string;
+  storybookAutorunCmd?: string;
   failFast?: boolean;
   odiff?: boolean;
+  noDocker?: boolean;
 }
 
 export type WorkerError = 'browser' | 'test' | 'unknown';
@@ -399,10 +420,17 @@ export type TestStatus = 'unknown' | 'pending' | 'running' | 'failed' | 'approve
 
 export interface TestResult {
   status: 'failed' | 'success';
+  retries: number;
   // TODO Remove checks `name == browser` in TestResultsView
   // images?: Partial<{ [name: string]: Images }> | Images;
   images?: Partial<Record<string, Images>>;
   error?: string;
+  // Test metadata for reporting
+  duration?: number;
+  attachments?: string[];
+  sessionId?: string;
+  browserName?: string;
+  workerId?: number;
 }
 
 export class ImagesError extends Error {
@@ -437,8 +465,8 @@ export interface BaseCreeveyTestContext {
    * @internal
    */
   screenshots: { imageName?: string; screenshot: Buffer }[];
-  matchImage: (image: Buffer, imageName?: string) => Promise<void>;
-  matchImages: (images: Record<string, Buffer>) => Promise<void>;
+  matchImage: (image: Buffer | string, imageName?: string) => Promise<void>;
+  matchImages: (images: Record<string, Buffer | string>) => Promise<void>;
 }
 
 export interface CreeveyTestContext extends BaseCreeveyTestContext {
@@ -450,6 +478,8 @@ export interface CreeveyTestContext extends BaseCreeveyTestContext {
 export enum TEST_EVENTS {
   RUN_BEGIN = 'start',
   RUN_END = 'end',
+  SUITE_BEGIN = 'suite',
+  SUITE_END = 'suite end',
   TEST_BEGIN = 'test',
   TEST_END = 'test end',
   TEST_FAIL = 'fail',
@@ -474,16 +504,25 @@ export interface FakeTest {
   title: string;
   fullTitle: () => string;
   titlePath: () => string[];
-  currentRetry: () => number;
+  currentRetry: () => number | undefined;
   retires: () => number;
   slow: () => number;
   duration?: number;
   state?: 'failed' | 'passed';
   // NOTE > duration, > duration / 2, > 0
   speed?: 'slow' | 'medium' | 'fast';
-  err?: unknown;
+  err?: string;
   // NOTE: image files
   attachments?: string[];
+
+  // NOTE: Creevey specific fields
+  creevey: {
+    sessionId: string;
+    browserName: string;
+    workerId: number;
+    willRetry: boolean;
+    images: Partial<Record<string, Partial<Images>>>;
+  };
 }
 
 export interface CreeveyStatus {

package/types/global.d.ts

@@ -1,5 +1,6 @@
 /* eslint-disable no-var */
 
+declare var __CREEVEY_ENV__: boolean;
 declare var __CREEVEY_SERVER_HOST__: string;
 declare var __CREEVEY_SERVER_PORT__: number | null;
 declare var __CREEVEY_CLIENT_PORT__: number | null;

package/.yarnrc.yml

@@ -1 +0,0 @@
-nodeLinker: node-modules

package/chromatic.config.json

@@ -1,5 +0,0 @@
-{
-  "onlyChanged": true,
-  "projectId": "Project:5fd73972015e660021b97564",
-  "zip": true
-}