From 58f00f10cb9f6a4f3d4f61bbd5e8be2676cd6da0 Mon Sep 17 00:00:00 2001 From: Yann Braga Date: Fri, 10 Nov 2023 17:13:49 +0100 Subject: [PATCH] add comparison table --- MIGRATION.test-runner.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/MIGRATION.test-runner.md b/MIGRATION.test-runner.md index 21d75a61..09cadba8 100644 --- a/MIGRATION.test-runner.md +++ b/MIGRATION.test-runner.md @@ -6,6 +6,7 @@ - [Table of Contents](#table-of-contents) - [Pre-requisites](#pre-requisites) - [What is the Storybook Test Runner?](#what-is-the-storybook-test-runner) + - [Storyshots x Test Runner Comparison table](#storyshots-x-test-runner-comparison-table) - [Migration Steps](#migration-steps) - [Replacing `@storybook/addon-storyshots` with `@storybook/test-runner`:](#replacing-storybookaddon-storyshots-with-storybooktest-runner) - [Migrating storyshots features](#migrating-storyshots-features) @@ -35,6 +36,26 @@ The [Storybook test-runner](https://storybook.js.org/docs/react/writing-tests/te Check [this video](https://www.youtube.com/watch?v%253DwEa6W8uUGSA) for a quick look on the test-runner. +## Storyshots x Test Runner Comparison table + +| | Storyshots | Test runner | +| -------------------------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| Coverage reports | ✅ | ✅ | +| Access parameters in tests | ✅ | ✅ | +| DOM snapshots testing | ✅ | ✅ | +| Visual snapshot testing | ✅ with puppeteer | ✅ | +| A11y tests | ✅ | ✅ | +| Extra customization | ✅ via `initStoryshots` | ✅ via `--eject` | +| Run subset of tests | ✅ storyKindRegex + storyNameRegex | ✅ via story tags | +| Skip story via parameter | ✅ via parameters | ✅ via story tags | +| Custom test function | ✅ | ✅ | +| Interaction testing | ❌  | ✅ | +| Real Browser | ❌ | ✅ | +| Cross browser testing | ❌ | ✅ | +| Parallel Testing | ❌ | ✅ | +| storyStoreV7 compatibility | ❌ | ✅ | +| React Native support | ✅ | ✅ via [@storybook/addon-react-native-web](https://storybook.js.org/addons/@storybook/addon-react-native-web) | + ## Migration Steps ### Replacing `@storybook/addon-storyshots` with `@storybook/test-runner`: