chore(examples): Adding Cypress and Playwright examples (#3618)

* chore(examples): Adding Cypress and Playwright examples

* chore(examples): removing jaeger instance

examples/tracetest-cypress/.env.template

@@ -0,0 +1,2 @@
+TRACETEST_API_TOKEN=
+TRACETEST_AGENT_API_KEY=

examples/tracetest-cypress/.gitignore

@@ -0,0 +1,11 @@
+node_modules
+.vscode
+
+node_modules
+api/.build/
+.idea/
+.DS_Store
+.env
+
+cypress/screenshots
+cypress/downloads

examples/tracetest-cypress/.prettierrc

@@ -0,0 +1,3 @@
+{
+  "singleQuote": true
+}

examples/tracetest-cypress/Dockerfile

@@ -0,0 +1,9 @@
+FROM cypress/base:20.10.0
+WORKDIR /app
+
+COPY package.json .
+COPY package-lock.json .
+
+ENV CI=1
+RUN npm ci
+RUN npx cypress verify

examples/tracetest-cypress/README.md

@@ -0,0 +1,13 @@
+# Tracetest + Cypress
+
+This repository's objective is to show how you can configure trace-based tests using Tracetest and Cypress.
+
+## Steps
+
+1. Copy the `.env.template` file to `.env`.
+2. Log into the [Tracetest app](https://app.tracetest.io/).
+3. This example is configured to use the OpenTelemetry Collector. Ensure the environment you will be utilizing to run this example is also configured to use the OpenTelemetry Tracing Backend by clicking on Settings, Tracing Backend, OpenTelemetry, and Save.
+4. Fill out the [token](https://docs.tracetest.io/concepts/environment-tokens) and [agent API key](https://docs.tracetest.io/concepts/agent) details by editing your .env file. You can find these values in the Settings area for your environment.
+5. Run `docker compose up -d`.
+6. Look for the `tracetest-e2e` service in Docker and click on it to view the logs. It will show the results from the trace-based tests that are triggered by the Cypress tests.
+7. Follow the links in the log to view the test runs programmatically created by your Cypress script.

examples/tracetest-cypress/collector.config.yaml

@@ -0,0 +1,27 @@
+receivers:
+  otlp:
+    protocols:
+      grpc:
+      http:
+        cors:
+          allowed_origins:
+            - "http://*"
+            - "https://*"
+
+processors:
+  batch:
+
+exporters:
+  logging:
+    loglevel: debug
+  otlp/trace:
+    endpoint: tracetest-agent:4317
+    tls:
+      insecure: true
+
+service:
+  pipelines:
+    traces:
+      receivers: [otlp]
+      processors: [batch]
+      exporters: [otlp/trace]

examples/tracetest-cypress/cypress.config.js

@@ -0,0 +1,17 @@
+const { defineConfig } = require('cypress');
+const { config } = require('dotenv');
+
+config();
+
+module.exports = defineConfig({
+  chromeWebSecurity: false,
+  e2e: {
+    baseUrl: process.env.POKESHOP_DEMO_URL || 'http://localhost:8081',
+    env: {
+      TRACETEST_API_TOKEN: process.env.TRACETEST_API_TOKEN,
+    },
+    setupNodeEvents() {
+      // implement node event listeners here
+    },
+  },
+});

examples/tracetest-cypress/cypress/e2e/pokeshop.cy.js

@@ -0,0 +1,80 @@
+const {default: Tracetest} = require('@tracetest/cypress');
+
+const TRACETEST_API_TOKEN = Cypress.env('TRACETEST_API_TOKEN') || '';
+
+let tracetest = undefined;
+
+const definition = `
+type: Test
+spec:
+  id: aW1wb3J0cyBhIHBva2Vtb24=
+  name: imports a pokemon
+  trigger:
+    type: cypress
+  specs:
+  - selector: span[tracetest.span.type="http"] span[tracetest.span.type="http"]
+    name: "All HTTP Spans: Status  code is 200"
+    assertions:
+    - attr:http.status_code   =   200
+  - selector: span[tracetest.span.type="database"]
+    name: "All Database Spans: Processing time is less than 100ms"
+    assertions:
+    - attr:tracetest.span.duration < 2s
+  outputs:
+  - name: MY_OUTPUT
+    selector: span[tracetest.span.type="general" name="Tracetest trigger"]
+    value: attr:name
+`;
+
+console.log('@@@Tracetest', Tracetest);
+
+describe('Home', { defaultCommandTimeout: 80000 }, () => {
+  before((done) => {
+    Tracetest({ apiToken: TRACETEST_API_TOKEN }).then((instance) => {
+      tracetest = instance;
+      tracetest
+        .setOptions({
+          'imports a pokemon': {
+            definition,
+          },
+        })
+        .then(() => done());
+    });
+  });
+
+  beforeEach(() => {
+    cy.visit('/', {
+      onBeforeLoad: (win) => tracetest.capture(win.document),
+    });
+  });
+
+  // uncomment to wait for trace tests to be done
+  after((done) => {
+    tracetest.summary().then(() => done());
+  });
+
+  it('create a pokemon', () => {
+    cy.get('[data-cy="create-pokemon-button"]').should('be.visible').click();
+    cy.get('[data-cy="create-pokemon-modal"]').should('be.visible');
+    cy.get('#name').type('Pikachu');
+    cy.get('#type').type('Electric');
+    cy.get('#imageUrl').type('https://oyster.ignimgs.com/mediawiki/apis.ign.com/pokemon-blue-version/8/89/Pikachu.jpg');
+
+    cy.get('button').contains('OK').click();
+  });
+
+  it('imports a pokemon', () => {
+    cy.get('[data-cy="import-pokemon-button"]').click();
+    cy.get('[data-cy="import-pokemon-form"]').should('be.visible');
+
+    cy.get('[id="id"]')
+      .last()
+      .type(Math.floor(Math.random() * 101).toString());
+    cy.get('button').contains('OK').click({ force: true });
+  });
+
+  it('deletes a pokemon', () => {
+    cy.get('[data-cy="pokemon-list"]').should('be.visible');
+    cy.get('[data-cy="pokemon-card"]').first().click().get('[data-cy="delete-pokemon-button"]').first().click();
+  });
+});

examples/tracetest-cypress/cypress/fixtures/example.json

@@ -0,0 +1,5 @@
+{
+  "name": "Using fixtures to represent data",
+  "email": "hello@cypress.io",
+  "body": "Fixtures are a great way to mock data for responses to routes"
+}

examples/tracetest-cypress/cypress/support/commands.js

@@ -0,0 +1,25 @@
+// ***********************************************
+// This example commands.js shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add('login', (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })

examples/tracetest-cypress/cypress/support/e2e.js

@@ -0,0 +1,20 @@
+// ***********************************************************
+// This example support/e2e.js is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands'
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')

examples/tracetest-cypress/docker-compose.yaml

@@ -0,0 +1,136 @@
+version: "3.5"
+name: pokeshop
+
+services:
+  tracetest-agent:
+    environment:
+      TRACETEST_DEV: ${TRACETEST_DEV}
+      TRACETEST_API_KEY: ${TRACETEST_AGENT_API_KEY}
+      TRACETEST_SERVER_URL: ${TRACETEST_SERVER_URL}
+    image: kubeshop/tracetest-agent:latest
+    networks:
+      default: null
+
+  tracetest-e2e:
+    build: .
+    depends_on:
+      - api
+      - worker
+    command: npx cypress run
+    environment:
+      - POKESHOP_DEMO_URL=http://api:8081
+      - TRACETEST_API_TOKEN=${TRACETEST_API_TOKEN}
+    volumes:
+      - ./cypress:/app/cypress
+      - ./cypress.config.js:/app/cypress.config.js
+
+  # pokeshop demo services
+  postgres:
+    image: postgres:14
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_DB: postgres
+    healthcheck:
+      test: ['CMD-SHELL', 'pg_isready -U $$POSTGRES_USER -d $$POSTGRES_DB']
+      interval: 1s
+      timeout: 5s
+      retries: 60
+
+  cache:
+    image: redis:6
+    healthcheck:
+      test: ['CMD', 'redis-cli', 'ping']
+      interval: 1s
+      timeout: 3s
+      retries: 60
+
+  queue:
+    image: rabbitmq:3.12
+    restart: unless-stopped
+    healthcheck:
+      test: rabbitmq-diagnostics -q check_running
+      interval: 1s
+      timeout: 5s
+      retries: 60
+
+  otel-collector:
+    image: otel/opentelemetry-collector-contrib:0.59.0
+    restart: unless-stopped
+    extra_hosts:
+      - 'host.docker.internal:host-gateway'
+    command:
+      - '--config'
+      - '/otel-local-config.yaml'
+    volumes:
+      - ./collector.config.yaml:/otel-local-config.yaml
+
+  api:
+    image: kubeshop/demo-pokemon-api:latest
+    restart: unless-stopped
+    pull_policy: always
+    environment:
+      REDIS_URL: cache
+      DATABASE_URL: postgresql://postgres:postgres@postgres:5432/postgres?schema=public
+      RABBITMQ_HOST: queue
+      POKE_API_BASE_URL: https://pokeapi.co/api/v2
+      COLLECTOR_ENDPOINT: http://otel-collector:4317
+      HTTP_COLLECTOR_ENDPOINT: http://otel-collector:4318/v1/traces
+      NPM_RUN_COMMAND: api
+    healthcheck:
+      test: ['CMD', 'wget', '--spider', 'localhost:8081']
+      interval: 1s
+      timeout: 3s
+      retries: 60
+    ports:
+      - 8081:8081
+    depends_on:
+      postgres:
+        condition: service_healthy
+      cache:
+        condition: service_healthy
+      queue:
+        condition: service_healthy
+
+  worker:
+    image: kubeshop/demo-pokemon-api:latest
+    restart: unless-stopped
+    pull_policy: always
+    environment:
+      REDIS_URL: cache
+      DATABASE_URL: postgresql://postgres:postgres@postgres:5432/postgres?schema=public
+      RABBITMQ_HOST: queue
+      POKE_API_BASE_URL: https://pokeapi.co/api/v2
+      COLLECTOR_ENDPOINT: http://otel-collector:4317
+      NPM_RUN_COMMAND: worker
+    depends_on:
+      postgres:
+        condition: service_healthy
+      cache:
+        condition: service_healthy
+      queue:
+        condition: service_healthy
+
+  rpc:
+    image: kubeshop/demo-pokemon-api:latest
+    restart: unless-stopped
+    pull_policy: always
+    environment:
+      REDIS_URL: cache
+      DATABASE_URL: postgresql://postgres:postgres@postgres:5432/postgres?schema=public
+      RABBITMQ_HOST: queue
+      POKE_API_BASE_URL: https://pokeapi.co/api/v2
+      COLLECTOR_ENDPOINT: http://otel-collector:4317
+      NPM_RUN_COMMAND: rpc
+    healthcheck:
+      test: ['CMD', 'lsof', '-i', '8082']
+      interval: 1s
+      timeout: 3s
+      retries: 60
+    depends_on:
+      postgres:
+        condition: service_healthy
+      cache:
+        condition: service_healthy
+      queue:
+        condition: service_healthy