webship-js 2.0.1 → 2.0.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.
- package/AGENTS.md +109 -0
- package/CLAUDE.md +317 -0
- package/bin/generate-reports.js +363 -0
- package/bin/init-webship.js +343 -0
- package/bin/postinstall.js +8 -74
- package/cucumber.js +66 -2
- package/docs/00-quick-start.md +102 -0
- package/docs/01-getting-started.md +102 -0
- package/docs/02-bbr-smart-waits.md +77 -0
- package/docs/03-selector-registry.md +95 -0
- package/docs/04-step-reference.md +728 -0
- package/docs/05-web-first-assertions.md +91 -0
- package/docs/06-network-and-dialogs.md +83 -0
- package/docs/07-auth-state.md +75 -0
- package/docs/08-clock-mocking.md +59 -0
- package/docs/09-api-testing.md +114 -0
- package/docs/10-accessibility.md +167 -0
- package/docs/11-debugging.md +129 -0
- package/docs/12-ai-agent-guide.md +338 -0
- package/docs/13-faq.md +236 -0
- package/docs/14-recipes-cookbook.md +255 -0
- package/docs/15-tag-conventions.md +76 -0
- package/docs/advanced-screenshots/then-i-save-fullscreen-screenshot.md +36 -0
- package/docs/advanced-screenshots/then-i-save-width-x-height-screenshot.md +34 -0
- package/docs/advanced-screenshots/when-i-save-screenshot-name-filename.md +45 -0
- package/docs/advanced-screenshots.md +52 -0
- package/docs/advanced-selectors.md +18 -0
- package/docs/api-step-definitions.md +45 -0
- package/docs/diffy-step-definitions/then-compare-diffy-env1-env2.md +30 -0
- package/docs/diffy-step-definitions/then-create-diffy-comparison-name-value.md +21 -0
- package/docs/diffy-step-definitions/then-create-diffy-comparison.md +25 -0
- package/docs/diffy-step-definitions/then-create-diffy-screenshot-environment-name.md +35 -0
- package/docs/diffy-step-definitions/then-i-take-screenshot.md +21 -0
- package/docs/diffy-step-definitions/then-i-take-screenshots-all-breakpoints.md +27 -0
- package/docs/diffy-step-definitions/then-send-screenshots-diffy-name-value.md +27 -0
- package/docs/diffy-step-definitions/then-upload-folder-url-diffy-snapshotname.md +28 -0
- package/docs/diffy-step-definitions/then-wait-diffy-comparison-complete.md +21 -0
- package/docs/diffy-step-definitions/when-i-resize-window-number.md +29 -0
- package/docs/diffy-step-definitions.md +21 -0
- package/docs/global-settings.md +244 -0
- package/docs/index.md +104 -0
- package/docs/install-webship-js/ddev-webship-js.md +52 -0
- package/docs/install-webship-js.md +35 -0
- package/docs/overview.md +41 -0
- package/docs/step-definitions/given-i-am-anonymous-user.md +67 -0
- package/docs/step-definitions/given-i-am-homepage.md +68 -0
- package/docs/step-definitions/given-i-am-specific-page.md +72 -0
- package/docs/step-definitions/then-i-should-be.md +56 -0
- package/docs/step-definitions/then-i-should-see.md +62 -0
- package/docs/step-definitions/then-item-checkbox.md +54 -0
- package/docs/step-definitions/then-item-link-should-contain-url.md +84 -0
- package/docs/step-definitions/then-item-should-contain.md +67 -0
- package/docs/step-definitions/then-radio-button-value-should-be-selected.md +68 -0
- package/docs/step-definitions/then-response-status-code-should-be-number.md +69 -0
- package/docs/step-definitions/then-value-radio-button-selected.md +62 -0
- package/docs/step-definitions/when-i-attach-file-file-name-element.md +71 -0
- package/docs/step-definitions/when-i-check-checkbox.md +60 -0
- package/docs/step-definitions/when-i-click-link.md +51 -0
- package/docs/step-definitions/when-i-click-operation-text-row.md +71 -0
- package/docs/step-definitions/when-i-fill.md +59 -0
- package/docs/step-definitions/when-i-go-homepage.md +60 -0
- package/docs/step-definitions/when-i-go-specific-page.md +67 -0
- package/docs/step-definitions/when-i-move-backward-one-page.md +49 -0
- package/docs/step-definitions/when-i-move-forward-one-page.md +58 -0
- package/docs/step-definitions/when-i-press-button.md +58 -0
- package/docs/step-definitions/when-i-reload-page.md +51 -0
- package/docs/step-definitions/when-i-scroll.md +73 -0
- package/docs/step-definitions/when-i-select-option-select-list.md +53 -0
- package/docs/step-definitions/when-i-select-radio-button-value.md +62 -0
- package/docs/step-definitions/when-i-uncheck-checkbox.md +57 -0
- package/docs/step-definitions/when-i-wait-ajax-finish.md +64 -0
- package/docs/step-definitions/when-i-wait.md +62 -0
- package/docs/step-definitions.md +50 -0
- package/examples/a11y.html +31 -0
- package/examples/cookies.html +10 -0
- package/examples/date.html +12 -0
- package/examples/diffy/baseline.html +54 -0
- package/examples/diffy/changed.html +63 -0
- package/examples/diffy/index.html +52 -0
- package/examples/element.html +11 -0
- package/examples/field.html +24 -0
- package/examples/index.html +6 -0
- package/examples/keyboard.html +11 -0
- package/examples/links.html +9 -0
- package/examples/modal.html +14 -0
- package/examples/path.html +3 -0
- package/examples/table.html +13 -0
- package/examples/test--when--i-additionally-select.html +27 -0
- package/package.json +19 -6
- package/playwright.config.ts +3 -2
- package/tests/features/a11y.feature +39 -0
- package/tests/features/cookie.feature +13 -0
- package/tests/features/date.feature +11 -0
- package/tests/features/diffy/test--diffy-01-example-demo.feature +22 -0
- package/tests/features/diffy/test--diffy-02-all-steps.feature +52 -0
- package/tests/features/diffy/test--diffy-03-real-api.feature +21 -0
- package/tests/features/element.feature +16 -0
- package/tests/features/field.feature +25 -0
- package/tests/features/keyboard.feature +10 -0
- package/tests/features/link.feature +11 -0
- package/tests/features/modal-advanced-example.feature +1 -1
- package/tests/features/modal.feature +11 -0
- package/tests/features/path.feature +16 -0
- package/tests/features/response.feature +8 -0
- package/tests/features/responsive.feature +10 -0
- package/tests/features/table.feature +18 -0
- package/tests/features/test--then--i-save-screenshot.feature +33 -0
- package/tests/features/test--then--i-see-locator.feature +320 -0
- package/tests/features/test--then--i-should-see-n-elements.feature +24 -0
- package/tests/features/test--then--print-current-url-and-response.feature +21 -0
- package/tests/features/test--when--i-additionally-select.feature +30 -0
- package/tests/features/test--when--i-follow.feature +22 -0
- package/tests/features/wait.feature +7 -0
- package/tests/features/yaml.feature +102 -0
- package/tests/reports/README.md +55 -0
- package/tests/selectors/_canonical-keys.json +113 -0
- package/tests/selectors/back-end-selectors.json +19 -0
- package/tests/selectors/cms-contentful-admin.json +35 -0
- package/tests/selectors/cms-craft-admin.json +39 -0
- package/tests/selectors/cms-drupal-cms-gin.json +56 -0
- package/tests/selectors/cms-drupal-core-claro.json +50 -0
- package/tests/selectors/cms-generic-admin.json +34 -0
- package/tests/selectors/cms-ghost-admin.json +34 -0
- package/tests/selectors/cms-joomla-admin.json +41 -0
- package/tests/selectors/cms-magento2-admin.json +32 -0
- package/tests/selectors/cms-prestashop-admin.json +38 -0
- package/tests/selectors/cms-shopify-admin.json +25 -0
- package/tests/selectors/cms-strapi-admin.json +42 -0
- package/tests/selectors/cms-typo3-admin.json +41 -0
- package/tests/selectors/cms-woocommerce-front.json +50 -0
- package/tests/selectors/cms-wordpress-admin.json +31 -0
- package/tests/selectors/framework-ant-design.json +80 -0
- package/tests/selectors/framework-bootstrap.json +86 -0
- package/tests/selectors/framework-bulma.json +74 -0
- package/tests/selectors/framework-chakra.json +58 -0
- package/tests/selectors/framework-foundation.json +51 -0
- package/tests/selectors/framework-material-ui.json +72 -0
- package/tests/selectors/framework-shadcn.json +51 -0
- package/tests/selectors/framework-tailwind.json +40 -0
- package/tests/selectors/framework-vuetify.json +61 -0
- package/tests/selectors/front-end-selectors.json +16 -0
- package/tests/selectors/homepage-selectors.json +13 -0
- package/tests/step-definitions/a11y.steps.js +798 -0
- package/tests/step-definitions/action.steps.js +167 -0
- package/tests/step-definitions/{webship-api.js → api.steps.js} +254 -44
- package/tests/step-definitions/assertion.steps.js +352 -0
- package/tests/step-definitions/auth.steps.js +124 -0
- package/tests/step-definitions/clock.steps.js +128 -0
- package/tests/step-definitions/cookie.steps.js +216 -0
- package/tests/step-definitions/debug.steps.js +31 -0
- package/tests/step-definitions/dialog.steps.js +193 -0
- package/tests/step-definitions/element.steps.js +314 -0
- package/tests/step-definitions/field.steps.js +653 -0
- package/tests/step-definitions/file-download.steps.js +193 -0
- package/tests/step-definitions/form.steps.js +333 -0
- package/tests/step-definitions/iframe.steps.js +178 -0
- package/tests/step-definitions/input.steps.js +163 -0
- package/tests/step-definitions/javascript.steps.js +71 -0
- package/tests/step-definitions/keyboard.steps.js +78 -0
- package/tests/step-definitions/link.steps.js +142 -0
- package/tests/step-definitions/metatag.steps.js +91 -0
- package/tests/step-definitions/modal.steps.js +219 -0
- package/tests/step-definitions/navigation.steps.js +218 -0
- package/tests/step-definitions/network.steps.js +238 -0
- package/tests/step-definitions/path.steps.js +141 -0
- package/tests/step-definitions/response.steps.js +98 -0
- package/tests/step-definitions/responsive.steps.js +123 -0
- package/tests/step-definitions/rest.steps.js +111 -0
- package/tests/step-definitions/screenshot.steps.js +423 -0
- package/tests/step-definitions/scroll.steps.js +189 -0
- package/tests/step-definitions/selectors.steps.js +996 -0
- package/tests/step-definitions/storage.steps.js +194 -0
- package/tests/step-definitions/table.steps.js +181 -0
- package/tests/step-definitions/wait.steps.js +400 -0
- package/tests/step-definitions/web-first.steps.js +296 -0
- package/tests/step-definitions/webship.js +567 -923
- package/tests/step-definitions/xml.steps.js +409 -0
- package/tests/step-definitions/yaml.steps.js +911 -0
- package/tests/step-definitions-diffy/README.md +329 -0
- package/tests/step-definitions-diffy/mock-diffy-api/server.js +84 -0
- package/tests/step-definitions-diffy/webship-diffy-mock.js +31 -0
- package/tests/step-definitions-diffy/webship-diffy.js +459 -0
- package/tsconfig.json +19 -3
- package/generate-reports.js +0 -22
- package/required/cucumber.js +0 -37
- package/required/generate-reports.js +0 -22
- package/required/package.json +0 -18
- package/required/playwright.config.ts +0 -37
- package/required/tests/features/README.md +0 -1
- package/required/tests/features/check-homepage.feature +0 -8
- package/required/tests/reports/README.md +0 -1
- package/required/tests/step-definitions/README.md +0 -1
- package/required/tests/step-definitions/custom.js +0 -4
- package/required/tsconfig.json +0 -12
|
@@ -0,0 +1,363 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
'use strict';
|
|
4
|
+
|
|
5
|
+
const fs = require('fs');
|
|
6
|
+
const path = require('path');
|
|
7
|
+
const reporter = require('cucumber-html-reporter');
|
|
8
|
+
|
|
9
|
+
const THEMES = new Set(['bootstrap', 'hierarchy', 'foundation', 'simple']);
|
|
10
|
+
const FORMATS = new Set(['html', 'pdf', 'all']);
|
|
11
|
+
const PDF_FORMATS = new Set(['Letter', 'Legal', 'Tabloid', 'Ledger', 'A0', 'A1', 'A2', 'A3', 'A4', 'A5', 'A6']);
|
|
12
|
+
|
|
13
|
+
function capitalize(s) {
|
|
14
|
+
return s ? s.charAt(0).toUpperCase() + s.slice(1) : s;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
function parseArgs(argv) {
|
|
18
|
+
const opts = {
|
|
19
|
+
metadata: {},
|
|
20
|
+
scenarioTimestamp: true,
|
|
21
|
+
reportSuiteAsScenarios: true,
|
|
22
|
+
failedSummaryReport: true,
|
|
23
|
+
launchReport: false,
|
|
24
|
+
noInlineScreenshots: false,
|
|
25
|
+
storeScreenshots: false,
|
|
26
|
+
ignoreBadJsonFile: false,
|
|
27
|
+
formats: [],
|
|
28
|
+
pdfFormat: 'A4',
|
|
29
|
+
pdfLandscape: false,
|
|
30
|
+
pdfMargin: '20mm',
|
|
31
|
+
pdfPrintBackground: true,
|
|
32
|
+
};
|
|
33
|
+
for (let i = 0; i < argv.length; i++) {
|
|
34
|
+
const a = argv[i];
|
|
35
|
+
const next = () => argv[++i];
|
|
36
|
+
switch (a) {
|
|
37
|
+
case '-h':
|
|
38
|
+
case '--help': opts.help = true; break;
|
|
39
|
+
case '--json': opts.jsonFile = next(); break;
|
|
40
|
+
case '--out':
|
|
41
|
+
case '--output': opts.output = next(); break;
|
|
42
|
+
case '--theme': opts.theme = next(); break;
|
|
43
|
+
case '--title': opts.brandTitle = next(); break;
|
|
44
|
+
case '--name': opts.name = next(); break;
|
|
45
|
+
case '--launch': opts.launchReport = true; break;
|
|
46
|
+
case '--layout': opts.columnLayout = Number(next()); break;
|
|
47
|
+
case '--no-scenario-timestamp': opts.scenarioTimestamp = false; break;
|
|
48
|
+
case '--no-suite-as-scenarios': opts.reportSuiteAsScenarios = false; break;
|
|
49
|
+
case '--no-failed-summary': opts.failedSummaryReport = false; break;
|
|
50
|
+
case '--no-inline-screenshots': opts.noInlineScreenshots = true; break;
|
|
51
|
+
case '--store-screenshots': opts.storeScreenshots = true; break;
|
|
52
|
+
case '--screenshots-dir': opts.screenshotsDirectory = next(); break;
|
|
53
|
+
case '--ignore-bad-json': opts.ignoreBadJsonFile = true; break;
|
|
54
|
+
case '--app-version': opts.metadata['App Version'] = next(); break;
|
|
55
|
+
case '--env': opts.metadata['Test Environment'] = next(); break;
|
|
56
|
+
case '--browser': opts.metadata['Browser'] = next(); break;
|
|
57
|
+
case '--platform': opts.metadata['Platform'] = next(); break;
|
|
58
|
+
case '--parallel': opts.metadata['Parallel'] = next(); break;
|
|
59
|
+
case '--executed': opts.metadata['Executed'] = next(); break;
|
|
60
|
+
case '--format': {
|
|
61
|
+
const f = (next() || '').toLowerCase();
|
|
62
|
+
if (!FORMATS.has(f)) {
|
|
63
|
+
console.error(`[webship-js] Unknown format "${f}". Use: ${[...FORMATS].join(', ')}`);
|
|
64
|
+
process.exit(1);
|
|
65
|
+
}
|
|
66
|
+
if (f === 'all') opts.formats.push('html', 'pdf');
|
|
67
|
+
else opts.formats.push(f);
|
|
68
|
+
break;
|
|
69
|
+
}
|
|
70
|
+
case '--pdf-out': opts.pdfOut = next(); break;
|
|
71
|
+
case '--pdf-format': opts.pdfFormat = next(); break;
|
|
72
|
+
case '--pdf-landscape': opts.pdfLandscape = true; break;
|
|
73
|
+
case '--pdf-margin': opts.pdfMargin = next(); break;
|
|
74
|
+
case '--pdf-no-background': opts.pdfPrintBackground = false; break;
|
|
75
|
+
case '--pdf-header': opts.pdfHeaderTemplate = next(); break;
|
|
76
|
+
case '--pdf-footer': opts.pdfFooterTemplate = next(); break;
|
|
77
|
+
case '--pdf-scale': opts.pdfScale = Number(next()); break;
|
|
78
|
+
case '--metadata': {
|
|
79
|
+
const kv = next() || '';
|
|
80
|
+
const eq = kv.indexOf('=');
|
|
81
|
+
if (eq > 0) opts.metadata[kv.slice(0, eq)] = kv.slice(eq + 1);
|
|
82
|
+
break;
|
|
83
|
+
}
|
|
84
|
+
default:
|
|
85
|
+
if (a.startsWith('--')) {
|
|
86
|
+
console.error(`[webship-js] Unknown option: ${a}`);
|
|
87
|
+
opts.help = true;
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
if (opts.formats.length === 0) opts.formats = ['html'];
|
|
92
|
+
return opts;
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
function printHelp() {
|
|
96
|
+
process.stdout.write(
|
|
97
|
+
[
|
|
98
|
+
'Usage: generate-reports [options]',
|
|
99
|
+
'',
|
|
100
|
+
'Generate HTML / PDF report from cucumber JSON output.',
|
|
101
|
+
'',
|
|
102
|
+
'Input / Output:',
|
|
103
|
+
' --json <path> JSON input (env WEBSHIP_REPORT_JSON,',
|
|
104
|
+
' default: tests/reports/cucumber_report.json)',
|
|
105
|
+
' --out <path> HTML output (env WEBSHIP_REPORT_OUT,',
|
|
106
|
+
' default: tests/reports/cucumber_report.html)',
|
|
107
|
+
' --format <kind> html | pdf | all (repeatable)',
|
|
108
|
+
' default: html',
|
|
109
|
+
'',
|
|
110
|
+
'PDF options (require --format pdf or all):',
|
|
111
|
+
' --pdf-out <path> PDF output (default: <out>.pdf)',
|
|
112
|
+
' --pdf-format <name> Letter | Legal | A3 | A4 | A5 | … (default: A4)',
|
|
113
|
+
' --pdf-landscape Landscape orientation',
|
|
114
|
+
' --pdf-margin <css> Margin all sides (default: 20mm)',
|
|
115
|
+
' --pdf-no-background Disable print background colors / images',
|
|
116
|
+
' --pdf-header <html> Header template HTML',
|
|
117
|
+
' --pdf-footer <html> Footer template HTML',
|
|
118
|
+
' --pdf-scale <n> Scale factor 0.1-2.0',
|
|
119
|
+
'',
|
|
120
|
+
'Format:',
|
|
121
|
+
' --theme <name> bootstrap | hierarchy | foundation | simple',
|
|
122
|
+
' (env WEBSHIP_REPORT_THEME, default: bootstrap)',
|
|
123
|
+
' --title <s> Brand title (env WEBSHIP_REPORT_TITLE)',
|
|
124
|
+
' --name <s> Report name',
|
|
125
|
+
' --layout <1|2> Column layout (default: 1)',
|
|
126
|
+
' --launch Launch report in browser after generation',
|
|
127
|
+
' --no-scenario-timestamp Hide per-scenario timestamp',
|
|
128
|
+
' --no-suite-as-scenarios Report suites instead of scenarios',
|
|
129
|
+
' --no-failed-summary Hide failed-scenarios summary',
|
|
130
|
+
' --no-inline-screenshots Link screenshots instead of embedding',
|
|
131
|
+
' --store-screenshots Copy screenshots into report dir',
|
|
132
|
+
' --screenshots-dir <dir> Source screenshots directory',
|
|
133
|
+
' --ignore-bad-json Do not fail on malformed JSON entries',
|
|
134
|
+
'',
|
|
135
|
+
'Metadata:',
|
|
136
|
+
' --app-version <s> App Version (env WEBSHIP_REPORT_APP_VERSION)',
|
|
137
|
+
' --env <s> Test Environment (env WEBSHIP_REPORT_ENV)',
|
|
138
|
+
' --browser <s> Browser (env BROWSER)',
|
|
139
|
+
' --platform <s> Platform (default: process.platform)',
|
|
140
|
+
' --parallel <s> Parallel (default: Scenarios)',
|
|
141
|
+
' --executed <s> Executed (env WEBSHIP_REPORT_EXECUTED)',
|
|
142
|
+
' --metadata key=value Arbitrary key/value (repeatable)',
|
|
143
|
+
'',
|
|
144
|
+
' -h, --help Show this help',
|
|
145
|
+
'',
|
|
146
|
+
'Examples:',
|
|
147
|
+
' generate-reports',
|
|
148
|
+
' generate-reports --format pdf --pdf-format Letter --pdf-landscape',
|
|
149
|
+
' generate-reports --format all --launch',
|
|
150
|
+
'',
|
|
151
|
+
].join('\n')
|
|
152
|
+
);
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
async function generatePdf(htmlPath, pdfPath, args) {
|
|
156
|
+
let chromium;
|
|
157
|
+
try {
|
|
158
|
+
({ chromium } = require('playwright'));
|
|
159
|
+
} catch (err) {
|
|
160
|
+
throw new Error(
|
|
161
|
+
'PDF generation requires "playwright". Run `npm install playwright` and try again.\n' +
|
|
162
|
+
`Original error: ${err.message}`
|
|
163
|
+
);
|
|
164
|
+
}
|
|
165
|
+
if (!PDF_FORMATS.has(args.pdfFormat)) {
|
|
166
|
+
throw new Error(`Unknown --pdf-format "${args.pdfFormat}". Use: ${[...PDF_FORMATS].join(', ')}`);
|
|
167
|
+
}
|
|
168
|
+
const browser = await chromium.launch();
|
|
169
|
+
try {
|
|
170
|
+
const context = await browser.newContext();
|
|
171
|
+
const page = await context.newPage();
|
|
172
|
+
const fileUrl = 'file://' + path.resolve(htmlPath);
|
|
173
|
+
// The cucumber-html-reporter output references CDN scripts that may
|
|
174
|
+
// never settle; use `domcontentloaded` and add a short render delay.
|
|
175
|
+
// `commit` returns once navigation accepts; safer than domcontentloaded
|
|
176
|
+
// when the report references third-party CDN assets that may stall.
|
|
177
|
+
await page.goto(fileUrl, { waitUntil: 'commit', timeout: 60000 });
|
|
178
|
+
await page.waitForLoadState('domcontentloaded', { timeout: 30000 }).catch(() => {});
|
|
179
|
+
await page.waitForTimeout(2500);
|
|
180
|
+
|
|
181
|
+
// Render exactly what is shown on screen (preserves badges, panels,
|
|
182
|
+
// gradients). The `print` media flips to greyscale on many themes.
|
|
183
|
+
await page.emulateMedia({ media: 'screen' });
|
|
184
|
+
|
|
185
|
+
// Force-expand every collapsed feature/scenario block and apply
|
|
186
|
+
// print-friendly styles so the PDF shows ALL steps without clipping.
|
|
187
|
+
await page.addStyleTag({ content: `
|
|
188
|
+
/* Preserve every color (status badges, panels, charts) when printing. */
|
|
189
|
+
*, *::before, *::after {
|
|
190
|
+
-webkit-print-color-adjust: exact !important;
|
|
191
|
+
print-color-adjust: exact !important;
|
|
192
|
+
color-adjust: exact !important;
|
|
193
|
+
}
|
|
194
|
+
@media print {
|
|
195
|
+
.collapse, .panel-collapse, [aria-expanded="false"] + .collapse,
|
|
196
|
+
.collapse.in, .collapse.show, .collapsing {
|
|
197
|
+
display: block !important;
|
|
198
|
+
visibility: visible !important;
|
|
199
|
+
height: auto !important;
|
|
200
|
+
max-height: none !important;
|
|
201
|
+
overflow: visible !important;
|
|
202
|
+
opacity: 1 !important;
|
|
203
|
+
}
|
|
204
|
+
.feature, .feature-container, .scenario, .scenario-container,
|
|
205
|
+
.row.steps, .step, .features-summary { page-break-inside: avoid; }
|
|
206
|
+
.feature, .feature-container { page-break-before: auto; }
|
|
207
|
+
details { display: block !important; } details > * { display: block !important; }
|
|
208
|
+
a[href]:after { content: ""; }
|
|
209
|
+
.btn, button.collapse-toggle, .toggle-icon, .glyphicon-chevron-right,
|
|
210
|
+
.glyphicon-chevron-down { display: none !important; }
|
|
211
|
+
pre, code { white-space: pre-wrap !important; word-wrap: break-word !important; }
|
|
212
|
+
img { max-width: 100% !important; height: auto !important; }
|
|
213
|
+
}
|
|
214
|
+
.collapse { display: block !important; height: auto !important; }
|
|
215
|
+
.collapsing { transition: none !important; }
|
|
216
|
+
details:not([open]) { }
|
|
217
|
+
` });
|
|
218
|
+
|
|
219
|
+
// Flatten the report: kill every script, expand every panel, neutralise
|
|
220
|
+
// every collapse trigger so the resulting PDF is static. No JS runs at
|
|
221
|
+
// PDF time — what you see is exactly what gets rendered.
|
|
222
|
+
await page.evaluate(() => {
|
|
223
|
+
document.querySelectorAll('script').forEach(s => s.remove());
|
|
224
|
+
document.querySelectorAll('[data-toggle], [data-bs-toggle]').forEach(el => {
|
|
225
|
+
el.removeAttribute('data-toggle');
|
|
226
|
+
el.removeAttribute('data-bs-toggle');
|
|
227
|
+
el.removeAttribute('data-target');
|
|
228
|
+
el.removeAttribute('data-bs-target');
|
|
229
|
+
el.removeAttribute('href');
|
|
230
|
+
el.style.cursor = 'default';
|
|
231
|
+
});
|
|
232
|
+
document.querySelectorAll('.collapse, .panel-collapse, [class*="collapse"]').forEach(el => {
|
|
233
|
+
el.classList.add('in', 'show');
|
|
234
|
+
el.classList.remove('collapsing');
|
|
235
|
+
el.style.cssText += ';height:auto !important;display:block !important;visibility:visible !important;opacity:1 !important;';
|
|
236
|
+
el.setAttribute('aria-expanded', 'true');
|
|
237
|
+
});
|
|
238
|
+
document.querySelectorAll('[aria-expanded]').forEach(el => el.setAttribute('aria-expanded', 'true'));
|
|
239
|
+
document.querySelectorAll('details').forEach(el => el.setAttribute('open', ''));
|
|
240
|
+
document.querySelectorAll('.glyphicon-chevron-right').forEach(el => {
|
|
241
|
+
el.classList.remove('glyphicon-chevron-right');
|
|
242
|
+
el.classList.add('glyphicon-chevron-down');
|
|
243
|
+
});
|
|
244
|
+
});
|
|
245
|
+
await page.waitForTimeout(300);
|
|
246
|
+
const opts = {
|
|
247
|
+
path: pdfPath,
|
|
248
|
+
format: args.pdfFormat,
|
|
249
|
+
landscape: !!args.pdfLandscape,
|
|
250
|
+
printBackground: args.pdfPrintBackground,
|
|
251
|
+
margin: {
|
|
252
|
+
top: args.pdfMargin,
|
|
253
|
+
right: args.pdfMargin,
|
|
254
|
+
bottom: args.pdfMargin,
|
|
255
|
+
left: args.pdfMargin,
|
|
256
|
+
},
|
|
257
|
+
};
|
|
258
|
+
if (args.pdfHeaderTemplate || args.pdfFooterTemplate) {
|
|
259
|
+
opts.displayHeaderFooter = true;
|
|
260
|
+
if (args.pdfHeaderTemplate) opts.headerTemplate = args.pdfHeaderTemplate;
|
|
261
|
+
if (args.pdfFooterTemplate) opts.footerTemplate = args.pdfFooterTemplate;
|
|
262
|
+
}
|
|
263
|
+
if (Number.isFinite(args.pdfScale)) opts.scale = args.pdfScale;
|
|
264
|
+
await page.pdf(opts);
|
|
265
|
+
} finally {
|
|
266
|
+
await browser.close();
|
|
267
|
+
}
|
|
268
|
+
}
|
|
269
|
+
|
|
270
|
+
async function run(argv) {
|
|
271
|
+
const args = parseArgs(argv);
|
|
272
|
+
if (args.help) return printHelp();
|
|
273
|
+
|
|
274
|
+
const cwd = process.cwd();
|
|
275
|
+
const jsonFile = path.resolve(
|
|
276
|
+
cwd,
|
|
277
|
+
args.jsonFile ||
|
|
278
|
+
process.env.WEBSHIP_REPORT_JSON ||
|
|
279
|
+
'tests/reports/cucumber_report.json'
|
|
280
|
+
);
|
|
281
|
+
const output = path.resolve(
|
|
282
|
+
cwd,
|
|
283
|
+
args.output ||
|
|
284
|
+
process.env.WEBSHIP_REPORT_OUT ||
|
|
285
|
+
'tests/reports/cucumber_report.html'
|
|
286
|
+
);
|
|
287
|
+
|
|
288
|
+
const theme =
|
|
289
|
+
args.theme || process.env.WEBSHIP_REPORT_THEME || 'bootstrap';
|
|
290
|
+
if (!THEMES.has(theme)) {
|
|
291
|
+
console.error(
|
|
292
|
+
`[webship-js] Unknown theme "${theme}". Use one of: ${[...THEMES].join(', ')}`
|
|
293
|
+
);
|
|
294
|
+
process.exit(1);
|
|
295
|
+
}
|
|
296
|
+
|
|
297
|
+
const metadata = {
|
|
298
|
+
'App Version':
|
|
299
|
+
args.metadata['App Version'] ||
|
|
300
|
+
process.env.WEBSHIP_REPORT_APP_VERSION ||
|
|
301
|
+
'2.0.0',
|
|
302
|
+
'Test Environment':
|
|
303
|
+
args.metadata['Test Environment'] ||
|
|
304
|
+
process.env.WEBSHIP_REPORT_ENV ||
|
|
305
|
+
'development',
|
|
306
|
+
Browser:
|
|
307
|
+
args.metadata['Browser'] ||
|
|
308
|
+
(process.env.BROWSER ? capitalize(process.env.BROWSER) : 'Chromium'),
|
|
309
|
+
Platform: args.metadata['Platform'] || process.platform,
|
|
310
|
+
Parallel: args.metadata['Parallel'] || 'Scenarios',
|
|
311
|
+
Executed:
|
|
312
|
+
args.metadata['Executed'] ||
|
|
313
|
+
process.env.WEBSHIP_REPORT_EXECUTED ||
|
|
314
|
+
'Remote',
|
|
315
|
+
};
|
|
316
|
+
for (const [k, v] of Object.entries(args.metadata)) {
|
|
317
|
+
metadata[k] = v;
|
|
318
|
+
}
|
|
319
|
+
|
|
320
|
+
const wantHtml = args.formats.includes('html');
|
|
321
|
+
const wantPdf = args.formats.includes('pdf');
|
|
322
|
+
const needsHtmlForExport = wantPdf;
|
|
323
|
+
|
|
324
|
+
const options = {
|
|
325
|
+
theme,
|
|
326
|
+
jsonFile,
|
|
327
|
+
output,
|
|
328
|
+
reportSuiteAsScenarios: args.reportSuiteAsScenarios,
|
|
329
|
+
scenarioTimestamp: args.scenarioTimestamp,
|
|
330
|
+
launchReport: args.launchReport && wantHtml,
|
|
331
|
+
brandTitle:
|
|
332
|
+
args.brandTitle || process.env.WEBSHIP_REPORT_TITLE || 'Test Report',
|
|
333
|
+
name: args.name || process.env.WEBSHIP_REPORT_NAME,
|
|
334
|
+
columnLayout: args.columnLayout || 1,
|
|
335
|
+
noInlineScreenshots: args.noInlineScreenshots,
|
|
336
|
+
storeScreenshots: args.storeScreenshots,
|
|
337
|
+
screenshotsDirectory: args.screenshotsDirectory,
|
|
338
|
+
ignoreBadJsonFile: args.ignoreBadJsonFile,
|
|
339
|
+
failedSummaryReport: args.failedSummaryReport,
|
|
340
|
+
metadata,
|
|
341
|
+
};
|
|
342
|
+
|
|
343
|
+
if (wantHtml || needsHtmlForExport) {
|
|
344
|
+
reporter.generate(options);
|
|
345
|
+
console.log(`[webship-js] HTML report → ${output}`);
|
|
346
|
+
}
|
|
347
|
+
|
|
348
|
+
if (wantPdf) {
|
|
349
|
+
const pdfOut = path.resolve(cwd, args.pdfOut || output.replace(/\.html?$/i, '') + '.pdf');
|
|
350
|
+
await generatePdf(output, pdfOut, args);
|
|
351
|
+
console.log(`[webship-js] PDF report → ${pdfOut}`);
|
|
352
|
+
}
|
|
353
|
+
|
|
354
|
+
}
|
|
355
|
+
|
|
356
|
+
if (require.main === module) {
|
|
357
|
+
Promise.resolve(run(process.argv.slice(2))).catch(err => {
|
|
358
|
+
console.error(`[webship-js] ${err.message || err}`);
|
|
359
|
+
process.exit(1);
|
|
360
|
+
});
|
|
361
|
+
}
|
|
362
|
+
|
|
363
|
+
module.exports = { run };
|