creevey 0.8.1-sb7.1 → 0.8.1-sb7.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (235) hide show
  1. package/lib/cjs/cli.js +5 -0
  2. package/lib/cjs/client/addon/Manager.js +264 -0
  3. package/lib/cjs/client/addon/components/Addon.js +55 -0
  4. package/lib/cjs/client/addon/components/Icons.js +46 -0
  5. package/lib/cjs/client/addon/components/Panel.js +72 -0
  6. package/lib/cjs/client/addon/components/TestSelect.js +65 -0
  7. package/lib/cjs/client/addon/components/Tools.js +97 -0
  8. package/lib/cjs/client/addon/decorator.js +11 -0
  9. package/lib/cjs/client/addon/index.js +31 -0
  10. package/lib/cjs/client/addon/preset.ie11.js +74 -0
  11. package/lib/cjs/client/addon/preset.js +62 -0
  12. package/lib/cjs/client/addon/readyForCapture.js +12 -0
  13. package/lib/cjs/client/addon/register.js +74 -0
  14. package/lib/cjs/client/addon/utils.js +42 -0
  15. package/lib/cjs/client/addon/withCreevey.js +351 -0
  16. package/lib/cjs/client/shared/components/ImagesView/BlendView.js +87 -0
  17. package/lib/cjs/client/shared/components/ImagesView/ImagesView.js +92 -0
  18. package/lib/cjs/client/shared/components/ImagesView/SideBySideView.js +154 -0
  19. package/lib/cjs/client/shared/components/ImagesView/SlideView.js +166 -0
  20. package/lib/cjs/client/shared/components/ImagesView/SwapView.js +91 -0
  21. package/lib/cjs/client/shared/components/ImagesView/index.js +45 -0
  22. package/lib/cjs/client/shared/components/PageFooter/PageFooter.js +50 -0
  23. package/lib/cjs/client/shared/components/PageFooter/Paging.js +94 -0
  24. package/lib/cjs/client/shared/components/PageHeader/ImagePreview.js +82 -0
  25. package/lib/cjs/client/shared/components/PageHeader/PageHeader.js +119 -0
  26. package/lib/cjs/client/shared/components/ResultsPage.js +143 -0
  27. package/lib/cjs/client/shared/creeveyClientApi.js +76 -0
  28. package/lib/cjs/client/shared/helpers.js +411 -0
  29. package/lib/cjs/client/shared/viewMode.js +17 -0
  30. package/lib/cjs/client/web/19.js +1 -0
  31. package/lib/cjs/client/web/632.js +43 -0
  32. package/lib/cjs/client/web/794.js +1 -0
  33. package/lib/cjs/client/web/index.html +19 -0
  34. package/lib/cjs/client/web/main.js +79 -0
  35. package/lib/cjs/client/web/main.js.LICENSE.txt +34 -0
  36. package/lib/cjs/creevey.js +69 -0
  37. package/lib/cjs/index.js +39 -0
  38. package/lib/cjs/server/config.js +93 -0
  39. package/lib/cjs/server/docker.js +146 -0
  40. package/lib/cjs/server/extract.js +46 -0
  41. package/lib/cjs/server/index.js +83 -0
  42. package/lib/cjs/server/loaders/babel/creevey-plugin.js +86 -0
  43. package/lib/cjs/server/loaders/babel/helpers.js +469 -0
  44. package/lib/cjs/server/loaders/babel/register.js +124 -0
  45. package/lib/cjs/server/loaders/hooks/mdx.js +30 -0
  46. package/lib/cjs/server/loaders/hooks/svelte.js +65 -0
  47. package/lib/cjs/server/loaders/webpack/compile.js +269 -0
  48. package/lib/cjs/server/loaders/webpack/creevey-loader.js +172 -0
  49. package/lib/cjs/server/loaders/webpack/dummy-hmr.js +39 -0
  50. package/lib/cjs/server/loaders/webpack/mdx-loader.js +72 -0
  51. package/lib/cjs/server/loaders/webpack/start.js +41 -0
  52. package/lib/cjs/server/logger.js +48 -0
  53. package/lib/cjs/server/master/api.js +71 -0
  54. package/lib/cjs/server/master/index.js +152 -0
  55. package/lib/cjs/server/master/master.js +57 -0
  56. package/lib/cjs/server/master/pool.js +197 -0
  57. package/lib/cjs/server/master/runner.js +281 -0
  58. package/lib/cjs/server/master/server.js +131 -0
  59. package/lib/cjs/server/messages.js +264 -0
  60. package/lib/cjs/server/selenium/browser.js +667 -0
  61. package/lib/cjs/server/selenium/index.js +31 -0
  62. package/lib/cjs/server/selenium/selenoid.js +172 -0
  63. package/lib/cjs/server/stories.js +155 -0
  64. package/lib/cjs/server/storybook/entry.js +55 -0
  65. package/lib/cjs/server/storybook/helpers.js +158 -0
  66. package/lib/cjs/server/storybook/providers/browser.js +76 -0
  67. package/lib/cjs/server/storybook/providers/nodejs.js +239 -0
  68. package/lib/cjs/server/update.js +79 -0
  69. package/lib/cjs/server/utils.js +169 -0
  70. package/lib/cjs/server/worker/chai-image.js +142 -0
  71. package/lib/cjs/server/worker/helpers.js +69 -0
  72. package/lib/cjs/server/worker/index.js +15 -0
  73. package/lib/cjs/server/worker/reporter.js +108 -0
  74. package/lib/cjs/server/worker/worker.js +268 -0
  75. package/lib/cjs/shared/index.js +103 -0
  76. package/lib/cjs/shared/serializeRegExp.js +42 -0
  77. package/lib/cjs/types.js +77 -0
  78. package/lib/esm/cli.js +4 -0
  79. package/lib/esm/client/addon/Manager.js +252 -0
  80. package/lib/esm/client/addon/components/Addon.js +39 -0
  81. package/lib/esm/client/addon/components/Icons.js +31 -0
  82. package/lib/esm/client/addon/components/Panel.js +53 -0
  83. package/lib/esm/client/addon/components/TestSelect.js +51 -0
  84. package/lib/esm/client/addon/components/Tools.js +76 -0
  85. package/lib/esm/client/addon/decorator.js +2 -0
  86. package/lib/esm/client/addon/index.js +2 -0
  87. package/lib/esm/client/addon/preset.ie11.js +59 -0
  88. package/lib/esm/client/addon/preset.js +41 -0
  89. package/lib/esm/client/addon/readyForCapture.js +5 -0
  90. package/lib/esm/client/addon/register.js +53 -0
  91. package/lib/esm/client/addon/utils.js +32 -0
  92. package/lib/esm/client/addon/withCreevey.js +326 -0
  93. package/lib/esm/client/shared/components/ImagesView/BlendView.js +67 -0
  94. package/lib/esm/client/shared/components/ImagesView/ImagesView.js +69 -0
  95. package/lib/esm/client/shared/components/ImagesView/SideBySideView.js +131 -0
  96. package/lib/esm/client/shared/components/ImagesView/SlideView.js +143 -0
  97. package/lib/esm/client/shared/components/ImagesView/SwapView.js +71 -0
  98. package/lib/esm/client/shared/components/ImagesView/index.js +5 -0
  99. package/lib/esm/client/shared/components/PageFooter/PageFooter.js +36 -0
  100. package/lib/esm/client/shared/components/PageFooter/Paging.js +80 -0
  101. package/lib/esm/client/shared/components/PageHeader/ImagePreview.js +68 -0
  102. package/lib/esm/client/shared/components/PageHeader/PageHeader.js +97 -0
  103. package/lib/esm/client/shared/components/ResultsPage.js +115 -0
  104. package/lib/esm/client/shared/creeveyClientApi.js +67 -0
  105. package/lib/esm/client/shared/helpers.js +353 -0
  106. package/lib/esm/client/shared/viewMode.js +6 -0
  107. package/lib/esm/creevey.js +54 -0
  108. package/lib/esm/index.js +3 -0
  109. package/lib/esm/server/config.js +70 -0
  110. package/lib/esm/server/docker.js +123 -0
  111. package/lib/esm/server/extract.js +32 -0
  112. package/lib/esm/server/index.js +64 -0
  113. package/lib/esm/server/loaders/babel/creevey-plugin.js +72 -0
  114. package/lib/esm/server/loaders/babel/helpers.js +452 -0
  115. package/lib/esm/server/loaders/babel/register.js +103 -0
  116. package/lib/esm/server/loaders/hooks/mdx.js +15 -0
  117. package/lib/esm/server/loaders/hooks/svelte.js +49 -0
  118. package/lib/esm/server/loaders/webpack/compile.js +246 -0
  119. package/lib/esm/server/loaders/webpack/creevey-loader.js +152 -0
  120. package/lib/esm/server/loaders/webpack/dummy-hmr.js +32 -0
  121. package/lib/esm/server/loaders/webpack/mdx-loader.js +58 -0
  122. package/lib/esm/server/loaders/webpack/start.js +27 -0
  123. package/lib/esm/server/logger.js +20 -0
  124. package/lib/esm/server/master/api.js +60 -0
  125. package/lib/esm/server/master/index.js +131 -0
  126. package/lib/esm/server/master/master.js +38 -0
  127. package/lib/esm/server/master/pool.js +176 -0
  128. package/lib/esm/server/master/runner.js +259 -0
  129. package/lib/esm/server/master/server.js +107 -0
  130. package/lib/esm/server/messages.js +232 -0
  131. package/lib/esm/server/selenium/browser.js +634 -0
  132. package/lib/esm/server/selenium/index.js +2 -0
  133. package/lib/esm/server/selenium/selenoid.js +149 -0
  134. package/lib/esm/server/stories.js +137 -0
  135. package/lib/esm/server/storybook/entry.js +29 -0
  136. package/lib/esm/server/storybook/helpers.js +99 -0
  137. package/lib/esm/server/storybook/providers/browser.js +60 -0
  138. package/lib/esm/server/storybook/providers/nodejs.js +219 -0
  139. package/lib/esm/server/update.js +61 -0
  140. package/lib/esm/server/utils.js +128 -0
  141. package/lib/esm/server/worker/chai-image.js +130 -0
  142. package/lib/esm/server/worker/helpers.js +60 -0
  143. package/lib/esm/server/worker/index.js +1 -0
  144. package/lib/esm/server/worker/reporter.js +86 -0
  145. package/lib/esm/server/worker/worker.js +238 -0
  146. package/lib/esm/shared/index.js +80 -0
  147. package/lib/esm/shared/serializeRegExp.js +24 -0
  148. package/lib/esm/types.js +46 -0
  149. package/lib/types/cli.d.ts +1 -0
  150. package/lib/types/client/addon/Manager.d.ts +37 -0
  151. package/lib/types/client/addon/components/Addon.d.ts +9 -0
  152. package/lib/types/client/addon/components/Icons.d.ts +8 -0
  153. package/lib/types/client/addon/components/Panel.d.ts +10 -0
  154. package/lib/types/client/addon/components/TestSelect.d.ts +9 -0
  155. package/lib/types/client/addon/components/Tools.d.ts +7 -0
  156. package/lib/types/client/addon/decorator.d.ts +1 -0
  157. package/lib/types/client/addon/index.d.ts +2 -0
  158. package/lib/types/client/addon/preset.d.ts +23 -0
  159. package/lib/types/client/addon/preset.ie11.d.ts +10 -0
  160. package/lib/types/client/addon/readyForCapture.d.ts +6 -0
  161. package/lib/types/client/addon/register.d.ts +3 -0
  162. package/lib/types/client/addon/utils.d.ts +3 -0
  163. package/lib/types/client/addon/withCreevey.d.ts +24 -0
  164. package/lib/types/client/shared/components/ImagesView/BlendView.d.ts +5 -0
  165. package/lib/types/client/shared/components/ImagesView/ImagesView.d.ts +25 -0
  166. package/lib/types/client/shared/components/ImagesView/SideBySideView.d.ts +5 -0
  167. package/lib/types/client/shared/components/ImagesView/SlideView.d.ts +5 -0
  168. package/lib/types/client/shared/components/ImagesView/SwapView.d.ts +5 -0
  169. package/lib/types/client/shared/components/ImagesView/index.d.ts +5 -0
  170. package/lib/types/client/shared/components/PageFooter/PageFooter.d.ts +9 -0
  171. package/lib/types/client/shared/components/PageFooter/Paging.d.ts +8 -0
  172. package/lib/types/client/shared/components/PageHeader/ImagePreview.d.ts +14 -0
  173. package/lib/types/client/shared/components/PageHeader/PageHeader.d.ts +17 -0
  174. package/lib/types/client/shared/components/ResultsPage.d.ts +20 -0
  175. package/lib/types/client/shared/creeveyClientApi.d.ts +9 -0
  176. package/lib/types/client/shared/helpers.d.ts +46 -0
  177. package/lib/types/client/shared/viewMode.d.ts +4 -0
  178. package/lib/types/client/web/CreeveyApp.d.ts +12 -0
  179. package/lib/types/client/web/CreeveyContext.d.ts +11 -0
  180. package/lib/types/client/web/CreeveyLoader.d.ts +3 -0
  181. package/lib/types/client/web/CreeveyView/SideBar/Checkbox.d.ts +22 -0
  182. package/lib/types/client/web/CreeveyView/SideBar/Search.d.ts +7 -0
  183. package/lib/types/client/web/CreeveyView/SideBar/SideBar.d.ts +14 -0
  184. package/lib/types/client/web/CreeveyView/SideBar/SideBarHeader.d.ts +13 -0
  185. package/lib/types/client/web/CreeveyView/SideBar/SuiteLink.d.ts +38 -0
  186. package/lib/types/client/web/CreeveyView/SideBar/TestLink.d.ts +8 -0
  187. package/lib/types/client/web/CreeveyView/SideBar/TestStatusIcon.d.ts +12 -0
  188. package/lib/types/client/web/CreeveyView/SideBar/TestsStatus.d.ts +11 -0
  189. package/lib/types/client/web/CreeveyView/SideBar/Toggle.d.ts +7 -0
  190. package/lib/types/client/web/CreeveyView/SideBar/index.d.ts +1 -0
  191. package/lib/types/client/web/KeyboardEventsContext.d.ts +13 -0
  192. package/lib/types/client/web/index.d.ts +4 -0
  193. package/lib/types/creevey.d.ts +1 -0
  194. package/lib/types/index.d.ts +2 -0
  195. package/lib/types/server/config.d.ts +4 -0
  196. package/lib/types/server/docker.d.ts +7 -0
  197. package/lib/types/server/extract.d.ts +2 -0
  198. package/lib/types/server/index.d.ts +2 -0
  199. package/lib/types/server/loaders/babel/creevey-plugin.d.ts +1 -0
  200. package/lib/types/server/loaders/babel/helpers.d.ts +19 -0
  201. package/lib/types/server/loaders/babel/register.d.ts +5 -0
  202. package/lib/types/server/loaders/hooks/mdx.d.ts +1 -0
  203. package/lib/types/server/loaders/hooks/svelte.d.ts +1 -0
  204. package/lib/types/server/loaders/webpack/compile.d.ts +2 -0
  205. package/lib/types/server/loaders/webpack/creevey-loader.d.ts +4 -0
  206. package/lib/types/server/loaders/webpack/dummy-hmr.d.ts +10 -0
  207. package/lib/types/server/loaders/webpack/mdx-loader.d.ts +6 -0
  208. package/lib/types/server/loaders/webpack/start.d.ts +1 -0
  209. package/lib/types/server/logger.d.ts +10 -0
  210. package/lib/types/server/master/api.d.ts +7 -0
  211. package/lib/types/server/master/index.d.ts +3 -0
  212. package/lib/types/server/master/master.d.ts +7 -0
  213. package/lib/types/server/master/pool.d.ts +31 -0
  214. package/lib/types/server/master/runner.d.ts +26 -0
  215. package/lib/types/server/master/server.d.ts +2 -0
  216. package/lib/types/server/messages.d.ts +29 -0
  217. package/lib/types/server/selenium/browser.d.ts +19 -0
  218. package/lib/types/server/selenium/index.d.ts +2 -0
  219. package/lib/types/server/selenium/selenoid.d.ts +3 -0
  220. package/lib/types/server/stories.d.ts +8 -0
  221. package/lib/types/server/storybook/entry.d.ts +16 -0
  222. package/lib/types/server/storybook/helpers.d.ts +24 -0
  223. package/lib/types/server/storybook/providers/browser.d.ts +2 -0
  224. package/lib/types/server/storybook/providers/nodejs.d.ts +6 -0
  225. package/lib/types/server/update.d.ts +2 -0
  226. package/lib/types/server/utils.d.ts +23 -0
  227. package/lib/types/server/worker/chai-image.d.ts +6 -0
  228. package/lib/types/server/worker/helpers.d.ts +8 -0
  229. package/lib/types/server/worker/index.d.ts +1 -0
  230. package/lib/types/server/worker/reporter.d.ts +8 -0
  231. package/lib/types/server/worker/worker.d.ts +4 -0
  232. package/lib/types/shared/index.d.ts +7 -0
  233. package/lib/types/shared/serializeRegExp.d.ts +9 -0
  234. package/lib/types/types.d.ts +486 -0
  235. package/package.json +1 -1
@@ -0,0 +1,238 @@
1
+ import { promisify } from 'util';
2
+ import fs from 'fs';
3
+ import path from 'path';
4
+ import chai from 'chai';
5
+ import chalk from 'chalk';
6
+ import Mocha from 'mocha';
7
+ import { Key, until } from 'selenium-webdriver';
8
+ import { isImageError } from '../../types';
9
+ import { subscribeOn, emitTestMessage, emitWorkerMessage } from '../messages';
10
+ import chaiImage from './chai-image';
11
+ import { closeBrowser, getBrowser, switchStory } from '../selenium';
12
+ import { CreeveyReporter, TeamcityReporter } from './reporter';
13
+ import { addTestsFromStories } from './helpers';
14
+ import { logger } from '../logger';
15
+ const statAsync = promisify(fs.stat);
16
+ const readdirAsync = promisify(fs.readdir);
17
+ const readFileAsync = promisify(fs.readFile);
18
+ const writeFileAsync = promisify(fs.writeFile);
19
+ const mkdirAsync = promisify(fs.mkdir);
20
+
21
+ async function getStat(filePath) {
22
+ try {
23
+ return await statAsync(filePath);
24
+ } catch (error) {
25
+ if (typeof error == 'object' && error && error.code === 'ENOENT') {
26
+ return null;
27
+ }
28
+
29
+ throw error;
30
+ }
31
+ }
32
+
33
+ async function getLastImageNumber(imageDir, imageName) {
34
+ const actualImagesRegexp = new RegExp(`${imageName}-actual-(\\d+)\\.png`);
35
+
36
+ try {
37
+ return (await readdirAsync(imageDir)).map(filename => filename.replace(actualImagesRegexp, '$1')).map(Number).filter(x => !isNaN(x)).sort((a, b) => b - a)[0] ?? 0;
38
+ } catch (_error) {
39
+ return 0;
40
+ }
41
+ } // FIXME browser options hotfix
42
+
43
+
44
+ export default async function worker(config, options) {
45
+ var _await$browser$getSes;
46
+
47
+ let retries = 0;
48
+ let images = {};
49
+ let error = undefined;
50
+ const screenshots = [];
51
+ const testScope = [];
52
+
53
+ function runHandler(failures) {
54
+ if (failures > 0 && (error || Object.values(images).some(image => (image === null || image === void 0 ? void 0 : image.error) != null))) {
55
+ const isTimeout = hasTimeout(error) || Object.values(images).some(image => hasTimeout(image === null || image === void 0 ? void 0 : image.error));
56
+ const payload = {
57
+ status: 'failed',
58
+ images,
59
+ error
60
+ };
61
+ isTimeout ? emitWorkerMessage({
62
+ type: 'error',
63
+ payload: {
64
+ error: error ?? 'Unknown error'
65
+ }
66
+ }) : emitTestMessage({
67
+ type: 'end',
68
+ payload
69
+ });
70
+ } else {
71
+ emitTestMessage({
72
+ type: 'end',
73
+ payload: {
74
+ status: 'success',
75
+ images
76
+ }
77
+ });
78
+ }
79
+ }
80
+
81
+ async function saveImages(imageDir, images) {
82
+ await mkdirAsync(imageDir, {
83
+ recursive: true
84
+ });
85
+
86
+ for (const {
87
+ name,
88
+ data
89
+ } of images) {
90
+ await writeFileAsync(path.join(imageDir, name), data);
91
+ }
92
+ }
93
+
94
+ async function getExpected(assertImageName) {
95
+ // context => [kind, story, test, browser]
96
+ // rootSuite -> kindSuite -> storyTest -> [browsers.png]
97
+ // rootSuite -> kindSuite -> storySuite -> test -> [browsers.png]
98
+ const testPath = [...testScope];
99
+ const imageName = assertImageName ?? testPath.pop();
100
+ const imagesMeta = [];
101
+ const reportImageDir = path.join(config.reportDir, ...testPath);
102
+ const imageNumber = (await getLastImageNumber(reportImageDir, imageName)) + 1;
103
+ const actualImageName = `${imageName}-actual-${imageNumber}.png`;
104
+ const image = images[imageName] = images[imageName] ?? {
105
+ actual: actualImageName
106
+ };
107
+
108
+ const onCompare = async (actual, expect, diff) => {
109
+ imagesMeta.push({
110
+ name: image.actual,
111
+ data: actual
112
+ });
113
+
114
+ if (diff && expect) {
115
+ image.expect = `${imageName}-expect-${imageNumber}.png`;
116
+ image.diff = `${imageName}-diff-${imageNumber}.png`;
117
+ imagesMeta.push({
118
+ name: image.expect,
119
+ data: expect
120
+ });
121
+ imagesMeta.push({
122
+ name: image.diff,
123
+ data: diff
124
+ });
125
+ }
126
+
127
+ if (options.saveReport) {
128
+ await saveImages(reportImageDir, imagesMeta);
129
+ }
130
+ };
131
+
132
+ const expectImageDir = path.join(config.screenDir, ...testPath);
133
+ const expectImageStat = await getStat(path.join(expectImageDir, `${imageName}.png`));
134
+ if (!expectImageStat) return {
135
+ expected: null,
136
+ onCompare
137
+ };
138
+ const expected = await readFileAsync(path.join(expectImageDir, `${imageName}.png`));
139
+ return {
140
+ expected,
141
+ onCompare
142
+ };
143
+ }
144
+
145
+ const mochaOptions = {
146
+ timeout: 30000,
147
+ reporter: process.env.TEAMCITY_VERSION ? TeamcityReporter : options.reporter || CreeveyReporter,
148
+ reporterOptions: {
149
+ reportDir: config.reportDir,
150
+ topLevelSuite: options.browser,
151
+
152
+ get willRetry() {
153
+ return retries < config.maxRetries;
154
+ },
155
+
156
+ get images() {
157
+ return images;
158
+ },
159
+
160
+ get sessionId() {
161
+ return sessionId;
162
+ }
163
+
164
+ }
165
+ };
166
+ const mocha = new Mocha(mochaOptions);
167
+ mocha.cleanReferencesAfterRun(false);
168
+ chai.use(chaiImage(getExpected, config.diffOptions));
169
+ if ((await getBrowser(config, options)) == null) return;
170
+ await addTestsFromStories(mocha.suite, config, {
171
+ browser: options.browser,
172
+ watch: options.ui,
173
+ debug: options.debug,
174
+ port: options.port
175
+ });
176
+
177
+ try {
178
+ var _await$getBrowser;
179
+
180
+ await ((_await$getBrowser = await getBrowser(config, options)) === null || _await$getBrowser === void 0 ? void 0 : _await$getBrowser.getCurrentUrl());
181
+ } catch (_) {
182
+ await closeBrowser();
183
+ }
184
+
185
+ const browser = await getBrowser(config, options);
186
+ const sessionId = (_await$browser$getSes = await (browser === null || browser === void 0 ? void 0 : browser.getSession())) === null || _await$browser$getSes === void 0 ? void 0 : _await$browser$getSes.getId();
187
+ if (browser == null) return;
188
+ const interval = setInterval(() => void browser.getCurrentUrl().then(url => {
189
+ if (options.debug) logger.debug(`${options.browser}:${chalk.gray(sessionId)}`, 'current url', chalk.magenta(url));
190
+ }), 10 * 1000);
191
+ subscribeOn('shutdown', () => clearInterval(interval));
192
+ mocha.suite.beforeAll(function () {
193
+ this.config = config;
194
+ this.browser = browser;
195
+ this.until = until;
196
+ this.keys = Key;
197
+ this.expect = chai.expect;
198
+ this.browserName = options.browser;
199
+ this.testScope = testScope;
200
+ this.screenshots = screenshots;
201
+ });
202
+ mocha.suite.beforeEach(switchStory);
203
+ subscribeOn('test', message => {
204
+ if (message.type != 'start') return;
205
+ const test = message.payload;
206
+ const testPath = test.path.join(' ').replace(/[|\\{}()[\]^$+*?.-]/g, '\\$&');
207
+ images = {};
208
+ error = undefined;
209
+ retries = test.retries;
210
+ mocha.grep(new RegExp(`^${testPath}$`));
211
+ const runner = mocha.run(runHandler); // TODO How handle browser corruption?
212
+
213
+ runner.on('fail', (_test, reason) => {
214
+ if (!(reason instanceof Error)) {
215
+ error = reason;
216
+ } else if (!isImageError(reason)) {
217
+ error = reason.stack ?? reason.message;
218
+ } else if (typeof reason.images == 'string') {
219
+ const image = images[testScope.slice(-1)[0]];
220
+ if (image) image.error = reason.images;
221
+ } else {
222
+ const imageErrors = reason.images;
223
+ Object.keys(imageErrors).forEach(imageName => {
224
+ const image = images[imageName];
225
+ if (image) image.error = imageErrors[imageName];
226
+ });
227
+ }
228
+ });
229
+ });
230
+ logger.info(`${options.browser}:${chalk.gray(sessionId)} is ready`);
231
+ emitWorkerMessage({
232
+ type: 'ready'
233
+ });
234
+ }
235
+
236
+ function hasTimeout(str) {
237
+ return str != null && str.toLowerCase().includes('timeout');
238
+ }
@@ -0,0 +1,80 @@
1
+ /* eslint-disable */
2
+ //@ts-nocheck
3
+ import { mapValues, mergeWith, cloneDeepWith } from 'lodash';
4
+ import { deserializeRegExp, isSerializedRegExp, isRegExp, serializeRegExp } from './serializeRegExp'; // NOTE: Copy-paste from storybook/api
5
+
6
+ export const combineParameters = function () {
7
+ for (var _len = arguments.length, parameterSets = new Array(_len), _key = 0; _key < _len; _key++) {
8
+ parameterSets[_key] = arguments[_key];
9
+ }
10
+
11
+ return (// eslint-disable-next-line @typescript-eslint/no-unsafe-return
12
+ mergeWith({}, ...parameterSets, (_, srcValue) => {
13
+ // Treat arrays as scalars:
14
+ if (Array.isArray(srcValue)) return srcValue;
15
+ return undefined;
16
+ })
17
+ );
18
+ }; // NOTE: Copy-paste from storybook/api
19
+
20
+ export const denormalizeStoryParameters = _ref => {
21
+ let {
22
+ globalParameters,
23
+ kindParameters,
24
+ stories
25
+ } = _ref;
26
+ return mapValues(stories, storyData => {
27
+ var _kindParameters$story;
28
+
29
+ return { ...storyData,
30
+ parameters: combineParameters(globalParameters, (_kindParameters$story = kindParameters[storyData.kind]) !== null && _kindParameters$story !== void 0 ? _kindParameters$story : {}, storyData.parameters)
31
+ };
32
+ });
33
+ };
34
+ export const serializeRawStories = stories => {
35
+ return mapValues(stories, storyData => {
36
+ const creevey = storyData.parameters.creevey;
37
+
38
+ if (creevey !== null && creevey !== void 0 && creevey.skip) {
39
+ return { ...storyData,
40
+ parameters: { ...storyData.parameters,
41
+ creevey: { ...creevey,
42
+ skip: cloneDeepWith(creevey.skip, value => {
43
+ if (isRegExp(value)) {
44
+ return serializeRegExp(value);
45
+ }
46
+
47
+ return undefined;
48
+ })
49
+ }
50
+ }
51
+ };
52
+ }
53
+
54
+ return storyData;
55
+ });
56
+ };
57
+ export const deserializeRawStories = stories => {
58
+ return mapValues(stories, deserializeStory);
59
+ };
60
+ export const deserializeStory = story => {
61
+ const creevey = story.parameters.creevey;
62
+
63
+ if (creevey !== null && creevey !== void 0 && creevey.skip) {
64
+ return { ...story,
65
+ parameters: { ...story.parameters,
66
+ creevey: { ...creevey,
67
+ skip: cloneDeepWith(creevey.skip, value => {
68
+ if (isSerializedRegExp(value)) {
69
+ return deserializeRegExp(value);
70
+ }
71
+
72
+ return undefined;
73
+ })
74
+ }
75
+ }
76
+ };
77
+ }
78
+
79
+ return story;
80
+ };
@@ -0,0 +1,24 @@
1
+ export const isRegExp = exp => {
2
+ return exp instanceof RegExp;
3
+ };
4
+ export const isSerializedRegExp = exp => {
5
+ return typeof exp === 'object' && exp !== null && Reflect.get(exp, '__regexp') === true;
6
+ };
7
+ export const serializeRegExp = exp => {
8
+ const {
9
+ source,
10
+ flags
11
+ } = exp;
12
+ return {
13
+ __regexp: true,
14
+ source,
15
+ flags
16
+ };
17
+ };
18
+ export const deserializeRegExp = _ref => {
19
+ let {
20
+ source,
21
+ flags
22
+ } = _ref;
23
+ return new RegExp(source, flags);
24
+ };
@@ -0,0 +1,46 @@
1
+ // eslint-disable-next-line @typescript-eslint/ban-ts-comment
2
+ //@ts-nocheck
3
+
4
+ /* eslint-disable @typescript-eslint/no-explicit-any */
5
+
6
+ /* eslint-enable @typescript-eslint/no-explicit-any */
7
+ export function noop() {
8
+ /* noop */
9
+ }
10
+ export function isDefined(value) {
11
+ return value !== null && value !== undefined;
12
+ }
13
+ export function isTest(x) {
14
+ return isDefined(x) && 'id' in x && 'storyId' in x && typeof x.id == 'string' && typeof x.storyId == 'string';
15
+ }
16
+ export function isObject(x) {
17
+ return typeof x == 'object' && x != null;
18
+ }
19
+ export function isString(x) {
20
+ return typeof x == 'string';
21
+ } // eslint-disable-next-line @typescript-eslint/no-explicit-any
22
+
23
+ export function isFunction(x) {
24
+ return typeof x == 'function';
25
+ }
26
+ export function isImageError(error) {
27
+ return error instanceof Error && 'images' in error;
28
+ }
29
+ export function isProcessMessage(message) {
30
+ return isObject(message) && 'scope' in message;
31
+ }
32
+ export function isWorkerMessage(message) {
33
+ return isProcessMessage(message) && message.scope == 'worker';
34
+ }
35
+ export function isStoriesMessage(message) {
36
+ return isProcessMessage(message) && message.scope == 'stories';
37
+ }
38
+ export function isTestMessage(message) {
39
+ return isProcessMessage(message) && message.scope == 'test';
40
+ }
41
+ export function isWebpackMessage(message) {
42
+ return isProcessMessage(message) && message.scope == 'webpack';
43
+ }
44
+ export function isDockerMessage(message) {
45
+ return isProcessMessage(message) && message.scope == 'docker';
46
+ }
@@ -0,0 +1 @@
1
+ #!/usr/bin/env node
@@ -0,0 +1,37 @@
1
+ import { API } from '@storybook/api';
2
+ import { denormalizeStoryParameters } from '../../shared';
3
+ import { CreeveyStatus, CreeveyUpdate, TestData, TestStatus, StoriesRaw } from '../../types';
4
+ import { CreeveyClientApi } from '../shared/creeveyClientApi';
5
+ export declare class CreeveyManager {
6
+ storybookApi: API;
7
+ storyId: string;
8
+ activeBrowser: string;
9
+ selectedTestId: string;
10
+ status: CreeveyStatus;
11
+ creeveyApi: CreeveyClientApi | null;
12
+ stories: StoriesRaw;
13
+ updateStatusListeners: Array<(update: CreeveyUpdate) => void>;
14
+ changeTestListeners: Array<(testId: string) => void>;
15
+ constructor(storybookApi: API);
16
+ initAll: () => Promise<void>;
17
+ onUpdateStatus(listener: (update: CreeveyUpdate) => void): () => void;
18
+ onChangeTest(listener: (testId: string) => void): () => void;
19
+ handleCreeveyUpdate: (update: CreeveyUpdate) => void;
20
+ getCurrentTest: () => TestData | undefined;
21
+ onStoryRendered: (storyId: string) => void;
22
+ onStart: () => void;
23
+ onStop: () => void;
24
+ onImageApprove: (id: string, retry: number, image: string) => void;
25
+ onStartAllStoryTests: () => void;
26
+ onStartAllTests: () => void;
27
+ onSetStories: (data: Parameters<typeof denormalizeStoryParameters>['0']) => void;
28
+ setActiveBrowser: (browser: string) => void;
29
+ setSelectedTestId: (testId: string) => void;
30
+ getStoryTests: (storyId: string) => TestData[];
31
+ getBrowsers: () => string[];
32
+ getTestsByStoryIdAndBrowser: (browser: string) => TestData[];
33
+ getTabTitle: (browser: string) => string;
34
+ setPanelsTitle: () => void;
35
+ addStatusesToSideBar(): Promise<void>;
36
+ addStatusToStoryName(name: string, status: TestStatus | undefined, skip: string | boolean): string;
37
+ }
@@ -0,0 +1,9 @@
1
+ /// <reference types="react" />
2
+ import { CreeveyManager } from '../Manager';
3
+ interface AddonProps {
4
+ active?: boolean;
5
+ browser: string;
6
+ manager: CreeveyManager;
7
+ }
8
+ export declare const Addon: ({ active, browser, manager }: AddonProps) => JSX.Element | null;
9
+ export {};
@@ -0,0 +1,8 @@
1
+ /// <reference types="react" />
2
+ interface IconProps {
3
+ width?: number;
4
+ height?: number;
5
+ }
6
+ export declare const NextIcon: ({ width, height }: IconProps) => JSX.Element;
7
+ export declare const ForwardIcon: ({ width, height }: IconProps) => JSX.Element;
8
+ export {};
@@ -0,0 +1,10 @@
1
+ /// <reference types="react" />
2
+ import { TestData } from '../../../types';
3
+ interface PanelProps {
4
+ tests: TestData[];
5
+ selectedTestId: string;
6
+ onChangeTest: (testId: string) => void;
7
+ onImageApprove: (id: string, retry: number, image: string) => void;
8
+ }
9
+ export declare const Panel: ({ tests, selectedTestId, onChangeTest, onImageApprove }: PanelProps) => JSX.Element;
10
+ export {};
@@ -0,0 +1,9 @@
1
+ /// <reference types="react" />
2
+ import { TestData } from '../../../types';
3
+ interface TestSelectProps {
4
+ tests: TestData[];
5
+ selectedTestId: string;
6
+ onChangeTest: (testId: string) => void;
7
+ }
8
+ export default function TestSelect(props: TestSelectProps): JSX.Element;
9
+ export {};
@@ -0,0 +1,7 @@
1
+ /// <reference types="react" />
2
+ import { CreeveyManager } from '../Manager';
3
+ interface ToolsProps {
4
+ manager: CreeveyManager;
5
+ }
6
+ export declare const Tools: ({ manager }: ToolsProps) => JSX.Element | null;
7
+ export {};
@@ -0,0 +1 @@
1
+ export declare const decorators: import("@storybook/preview-api/dist/addons").MakeDecoratorResult[];
@@ -0,0 +1,2 @@
1
+ export * from './withCreevey';
2
+ export * from './readyForCapture';
@@ -0,0 +1,23 @@
1
+ import { Configuration } from 'webpack';
2
+ export declare function config(entry?: string[]): string[];
3
+ export declare function managerEntries(entry?: string[]): string[];
4
+ declare global {
5
+ const __CREEVEY_SERVER_HOST__: string;
6
+ const __CREEVEY_SERVER_PORT__: number;
7
+ const __CREEVEY_CLIENT_PORT__: number | null;
8
+ }
9
+ export interface CreeveyAddonOptions {
10
+ creeveyConfigPath?: string;
11
+ creeveyPreExtract?: string;
12
+ creeveyHost?: string;
13
+ creeveyPort?: number;
14
+ clientPort?: number;
15
+ configType: string;
16
+ configDir: string;
17
+ outputDir: string;
18
+ skipExtract?: boolean;
19
+ presets?: {
20
+ apply: <T>(preset: string) => Promise<T | undefined>;
21
+ };
22
+ }
23
+ export declare function managerWebpack(config: Configuration, options: CreeveyAddonOptions): Promise<Configuration>;
@@ -0,0 +1,10 @@
1
+ import type { Configuration } from 'webpack';
2
+ import { PluginItem } from '@babel/core';
3
+ interface BabelOptions {
4
+ extends: string | null;
5
+ presets: PluginItem[] | null;
6
+ }
7
+ export declare const babel: (config: BabelOptions) => BabelOptions;
8
+ export declare const managerWebpack: (webpackConfig?: Configuration) => Configuration;
9
+ export declare const webpack: (webpackConfig?: Configuration) => Configuration;
10
+ export {};
@@ -0,0 +1,6 @@
1
+ declare global {
2
+ interface Window {
3
+ __CREEVEY_SET_READY_FOR_CAPTURE__?: () => void;
4
+ }
5
+ }
6
+ export declare function readyForCapture(): void;
@@ -0,0 +1,3 @@
1
+ import { API } from '@storybook/api';
2
+ export declare const ADDON_ID = "creevey";
3
+ export declare function registerCreeveyPanels(storybookApi: API): Promise<void>;
@@ -0,0 +1,3 @@
1
+ import { TestStatus } from '../../types';
2
+ export declare function getEmojiByTestStatus(status: TestStatus | undefined, skip?: string | boolean): string;
3
+ export declare const isInternetExplorer: boolean;
@@ -0,0 +1,24 @@
1
+ import type { PreviewWeb } from '@storybook/preview-web';
2
+ import type { AnyFramework } from '@storybook/csf';
3
+ import type { StoryStore } from '@storybook/client-api';
4
+ import { MakeDecoratorResult, Channel } from '@storybook/addons';
5
+ import { CaptureOptions, StoriesRaw, StorybookGlobals } from '../../types';
6
+ declare global {
7
+ interface Window {
8
+ __CREEVEY_SERVER_HOST__: string;
9
+ __CREEVEY_SERVER_PORT__: number;
10
+ __CREEVEY_WORKER_ID__: number;
11
+ __CREEVEY_GET_STORIES__: () => Promise<StoriesRaw | void>;
12
+ __CREEVEY_SELECT_STORY__: (storyId: string, kind: string, name: string, shouldWaitForReady: boolean, callback: (response: [error?: string | null, isCaptureCalled?: boolean]) => void) => Promise<void>;
13
+ __CREEVEY_UPDATE_GLOBALS__: (globals: StorybookGlobals) => void;
14
+ __CREEVEY_INSERT_IGNORE_STYLES__: (ignoreElements: string[]) => HTMLStyleElement;
15
+ __CREEVEY_REMOVE_IGNORE_STYLES__: (ignoreStyles: HTMLStyleElement) => void;
16
+ __CREEVEY_HAS_PLAY_COMPLETED_YET__: (callback: (isPlayCompleted: boolean) => void) => void;
17
+ __CREEVEY_SET_READY_FOR_CAPTURE__?: () => void;
18
+ __STORYBOOK_ADDONS_CHANNEL__: Channel;
19
+ __STORYBOOK_STORY_STORE__: StoryStore<AnyFramework>;
20
+ __STORYBOOK_PREVIEW__: PreviewWeb<AnyFramework>;
21
+ }
22
+ }
23
+ export declare function withCreevey(): MakeDecoratorResult;
24
+ export declare function capture(options?: CaptureOptions): Promise<void>;
@@ -0,0 +1,5 @@
1
+ import React from 'react';
2
+ import { ViewPropsWithTheme } from './ImagesView';
3
+ export declare const BlendView: React.FC<Pick<ViewPropsWithTheme, "diff" | "actual" | "expect"> & {
4
+ theme?: import("@storybook/theming").Theme | undefined;
5
+ }>;
@@ -0,0 +1,25 @@
1
+ /// <reference types="react" />
2
+ import { Images, ImagesViewMode } from '../../../../types';
3
+ import { Theme } from '@storybook/theming';
4
+ export declare const themeBorderColors: {
5
+ actual: string;
6
+ expect: string;
7
+ diff: string;
8
+ };
9
+ export declare function getBorderColor(theme: Theme, color: string): string;
10
+ interface ViewProps {
11
+ actual: string;
12
+ diff: string;
13
+ expect: string;
14
+ }
15
+ export interface ViewPropsWithTheme extends ViewProps {
16
+ theme: Theme;
17
+ }
18
+ interface ImagesViewProps {
19
+ url: string;
20
+ image: Images;
21
+ canApprove: boolean;
22
+ mode: ImagesViewMode;
23
+ }
24
+ export declare function ImagesView({ url, image, canApprove, mode }: ImagesViewProps): JSX.Element;
25
+ export {};
@@ -0,0 +1,5 @@
1
+ import React from 'react';
2
+ import { ViewPropsWithTheme } from './ImagesView';
3
+ export declare const SideBySideView: React.FC<Pick<ViewPropsWithTheme, "diff" | "actual" | "expect"> & {
4
+ theme?: import("@storybook/theming").Theme | undefined;
5
+ }>;
@@ -0,0 +1,5 @@
1
+ import React from 'react';
2
+ import { ViewPropsWithTheme } from './ImagesView';
3
+ export declare const SlideView: React.FC<Pick<ViewPropsWithTheme, "diff" | "actual" | "expect"> & {
4
+ theme?: import("@storybook/theming").Theme | undefined;
5
+ }>;
@@ -0,0 +1,5 @@
1
+ import React from 'react';
2
+ import { ViewPropsWithTheme } from './ImagesView';
3
+ export declare const SwapView: React.FC<Pick<ViewPropsWithTheme, "diff" | "actual" | "expect"> & {
4
+ theme?: import("@storybook/theming").Theme | undefined;
5
+ }>;
@@ -0,0 +1,5 @@
1
+ export { ImagesView } from './ImagesView';
2
+ export { BlendView } from './BlendView';
3
+ export { SideBySideView } from './SideBySideView';
4
+ export { SlideView } from './SlideView';
5
+ export { SwapView } from './SwapView';
@@ -0,0 +1,9 @@
1
+ /// <reference types="react" />
2
+ export interface PageFooterProps {
3
+ canApprove: boolean;
4
+ retriesCount: number;
5
+ retry: number;
6
+ onRetryChange: (retry: number) => void;
7
+ onApprove: () => void;
8
+ }
9
+ export declare function PageFooter({ canApprove, retriesCount, retry, onRetryChange, onApprove, }: PageFooterProps): JSX.Element;
@@ -0,0 +1,8 @@
1
+ /// <reference types="react" />
2
+ export interface PagingProps {
3
+ activePage: number;
4
+ onPageChange: (pageNumber: number) => void;
5
+ pagesCount: number;
6
+ }
7
+ export declare type ItemType = number | '.' | 'forward';
8
+ export declare function Paging(props: PagingProps): JSX.Element;
@@ -0,0 +1,14 @@
1
+ import React from 'react';
2
+ import { Theme } from '@storybook/theming';
3
+ interface ImageSwapProps {
4
+ url: string;
5
+ isActive: boolean;
6
+ onClick: (imageName: string) => void;
7
+ imageName: string;
8
+ theme: Theme;
9
+ error?: boolean;
10
+ }
11
+ export declare const ImagePreview: React.FC<Pick<ImageSwapProps, "error" | "url" | "imageName" | "onClick" | "isActive"> & {
12
+ theme?: Theme | undefined;
13
+ }>;
14
+ export {};