Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): Adding Playwright docs #3516

Merged
merged 3 commits into from Jan 11, 2024
Merged

Conversation

xoscar
Copy link
Collaborator

@xoscar xoscar commented Jan 10, 2024

This PR adds the playwright docs

Changes

  • Adds playwright integration docs

Checklist

  • tested locally
  • added new dependencies
  • updated the docs
  • added a test

Screenshots

localhost_3000_tools-and-integrations_playwright

@xoscar xoscar self-assigned this Jan 10, 2024
@xoscar xoscar marked this pull request as ready for review January 10, 2024 19:45

The `home.spec.ts` test script contains three different tests based on the Pokeshop Demo UI fetures, which are:

1. Creates a Pokemon
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. Creates a Pokemon
1. Create a Pokemon

The `home.spec.ts` test script contains three different tests based on the Pokeshop Demo UI fetures, which are:

1. Creates a Pokemon
2. Imports a Pokemon (using an async process)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. Imports a Pokemon (using an async process)
2. Import a Pokemon (using an async process)


1. Creates a Pokemon
2. Imports a Pokemon (using an async process)
3. Deletes a Pokemon
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
3. Deletes a Pokemon
3. Delete a Pokemon

Copy link
Member

@jfermi jfermi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few editing suggestions.

[Tracetest](https://tracetest.io/) is a testing tool based on [OpenTelemetry](https://opentelemetry.io/) that permits you to test your distributed application. It allows you to use the trace data generated by your OpenTelemetry tools to check and assert if your application has the desired behavior defined by your test definitions.

[Playwright](https://playwright.dev/) is an open-source automation framework developed by Microsoft that enables cross-browser automation for web applications. It provides a set of APIs and libraries for automating interactions with web browsers such as Chrome, Firefox, and Microsoft Edge.

Copy link
Collaborator

@kdhamric kdhamric Jan 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We say what Tracetest and Playwright are, and then we say 'Why is this important?', but we have not spelled out what 'this' is yet. Should we add a paragraph that says:

The Tracetest integration for Playwright enables your current Playwright tests to easily capture a full distributed trace from your OpenTelemetry instrumented frontend and backend system. You can embed a Tracetest in this Playwright test, and allow trace-based testing assertions to be applied across this entire flow, enabling true end-to-end tests across your entire system.


## The `@tracetest/playwright` npm Package

The [`@tracetest/playwright`](https://www.npmjs.com/package/@tracetest/playwright) npm package is a Playwright plugin that allows you to run Trace-based testing using Tracetest and Playwright. It is a wrapper around the Tracetest API that allows you to configure, orchestrate and run tests from Playwright.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not think 'Trace-based testing' should be capitalized

Copy link
Collaborator

@kdhamric kdhamric left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a couple comments - looks good

@xoscar xoscar merged commit bd6d3a1 into main Jan 11, 2024
37 checks passed
@xoscar xoscar deleted the docs-playwright-integration branch January 11, 2024 14:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants