Documentation for Installation of Echoed.
Echoed offers two installation methods, choose one that suits your needs:
- Initialize a new directory using our template:
mkdir my_test_directory && cd my_test_directory npm create echoed@latest
- Install dependencies:
npm install
- Start server in the
example
directory:cd example make start
- Run test from project root directory after compiling YAML tests:
cd ../ npm run compile && npm run test
- After test, you can view the HTML report in
report/result.html
(specified in.echoed.yml
):open report/result.html
- Stop server:
cd example make stop
- Once you're familiar, remove the
example
directory and begin crafting your own tests:rm -rf ./example
-
Install package:
npm install echoed
-
Update Jest configuration for Echoed
Modify yourjest.config.js
to include Echoed intestEnvironment
andreporters
:module.exports = { // ... other configurations testEnvironment: "echoed/jest/nodeEnvironment", reporters: [ "default", "echoed/jest/reporter" ], };
-
Create
.echoed.yml
.
To integrate Echoed, create a configuration file named.echoed.yml
.
The minimal required option isoutput
, specifying where to write the result. Refer to the Configuration for other options.For example:
output: "report/result.html"
-
Update your OpenTelemetry endpoint to send data to Echoed.
If you are using the OpenTelemetry Collector, modify its settings as shown below:exporters: otlphttp/local: endpoint: http://host.docker.internal:3000 # Default port of Echoed is 3000 service: pipelines: traces: exporters: [otlphttp/local] logs: exporters: [otlphttp/local]
Echoed offers two installation methods, choose one that suits your needs:
- Initialize a new directory using our Playwright template:
mkdir my_test_directory && cd my_test_directory npm create echoed@latest -- --template playwright
- Install dependencies:
npm install npx playwright install sudo npx playwright install-deps
- Start server in the
example
directory:cd example make start
- Run test from project root directory after compiling YAML tests:
cd ../ npm run compile && npm run test
- After test, you can view the HTML report in
report/result.html
(specified in.echoed.yml
):open report/result.html
- Stop server:
cd example make stop
- Once you're familiar, remove the
example
directory and begin crafting your own tests:rm -rf ./example
-
Install package:
npm install echoed
-
Update Playwright configuration for Echoed
Modify yourplaywright.config.ts
to include Echoed inreporter
andglobalSetup
:module.exports = { // ... other configurations reporter: [["html"], ["echoed/playwright/reporter"]], globalSetup: "echoed/playwright/globalSetup", };
-
Create
.echoed.yml
.
To integrate Echoed, create a configuration file named.echoed.yml
.
The minimal required option isoutput
, specifying where to write the result. Refer to the Configuration for other options.For example:
output: "report/result.html"
-
Update your OpenTelemetry endpoint to send data to Echoed.
If you are using the OpenTelemetry Collector, modify its settings as shown below:exporters: otlphttp/local: endpoint: http://host.docker.internal:3000 # Default port of Echoed is 3000 service: pipelines: traces: exporters: [otlphttp/local] logs: exporters: [otlphttp/local]
Echoed offers two installation methods, choose one that suits your needs:
- Initialize a new directory using our Playwright template:
mkdir my_test_directory && cd my_test_directory npm create echoed@latest -- --template cypress
- Install dependencies:
npm install
- Start server in the
example
directory:cd example make start
- Run test from project root directory:
cd ../ npm run test
- After test, you can view the HTML report in
report/result.html
(specified in.echoed.yml
):open report/result.html
- Stop server:
cd example make stop
- Once you're familiar, remove the
example
andcypress/e2e/example
directory and begin crafting your own tests:rm -rf ./example ./cypress/e2e/example
-
Install package:
npm install echoed
-
Update Cypress configuration for Echoed
Modify yourcypress.config.ts
to include Echoed inreporter
andsetupNodeEvents
:import { defineConfig } from "cypress"; import { install } from "echoed/cypress/nodeEvents"; module.exports = defineConfig({ reporter: "echoed/cypressReporter.js", // <- Add reporter e2e: { setupNodeEvents: async ( on: Cypress.PluginEvents, options: Cypress.PluginConfigOptions, ) => { return install(on, options); // <- Run `install` to collect data for reporter }, }, });
-
Update Support file
Modify your./cypress/support/e2e.js
to add commands by Echoed:import { install } from "echoed/cypress/support"; install();
-
Create
.echoed.yml
.
To integrate Echoed, create a configuration file named.echoed.yml
.
The minimal required option isoutput
, specifying where to write the result. Refer to the Configuration for other options.For example:
output: "report/result.html"
-
Update your OpenTelemetry endpoint to send data to Echoed.
If you are using the OpenTelemetry Collector, modify its settings as shown below:exporters: otlphttp/local: endpoint: http://host.docker.internal:3000 # Default port of Echoed is 3000 service: pipelines: traces: exporters: [otlphttp/local] logs: exporters: [otlphttp/local]