[test optimization] Update automatic log submission tests to include playwright (#5783)

Author: juan-fernandez

integration-tests/automatic-log-submission.spec.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const { exec } = require('child_process')
+const { exec, execSync } = require('child_process')
 
 const { assert } = require('chai')
 const getPort = require('get-port')
@@ -23,9 +23,14 @@ describe('test visibility automatic log submission', () => {
       '@cucumber/cucumber',
       'jest',
       'winston',
-      'chai@4'
+      'chai@4',
+      '@playwright/test'
     ], true)
     cwd = sandbox.folder
+    const { NODE_OPTIONS, ...restOfEnv } = process.env
+    // Install chromium (configured in integration-tests/playwright.config.js)
+    // *Be advised*: this means that we'll only be using chromium for this test suite
+    execSync('npx playwright install chromium', { cwd, env: restOfEnv, stdio: 'inherit' })
     webAppPort = await getPort()
     webAppServer.listen(webAppPort)
   })
@@ -58,10 +63,18 @@ describe('test visibility automatic log submission', () => {
     {
       name: 'cucumber',
       command: './node_modules/.bin/cucumber-js ci-visibility/automatic-log-submission-cucumber/*.feature'
+    },
+    {
+      name: 'playwright',
+      command: './node_modules/.bin/playwright test -c playwright.config.js',
+      getExtraEnvVars: () => ({
+        PW_BASE_URL: `http://localhost:${webAppPort}`,
+        TEST_DIR: 'ci-visibility/automatic-log-submission-playwright'
+      })
     }
   ]
 
-  testFrameworks.forEach(({ name, command }) => {
+  testFrameworks.forEach(({ name, command, getExtraEnvVars = () => ({}) }) => {
     context(`with ${name}`, () => {
       it('can automatically submit logs', (done) => {
         let logIds, testIds
@@ -113,11 +126,13 @@ describe('test visibility automatic log submission', () => {
               DD_AGENTLESS_LOG_SUBMISSION_ENABLED: '1',
               DD_AGENTLESS_LOG_SUBMISSION_URL: `http://localhost:${receiver.port}`,
               DD_API_KEY: '1',
-              DD_SERVICE: 'my-service'
+              DD_SERVICE: 'my-service',
+              ...getExtraEnvVars()
             },
             stdio: 'pipe'
           }
         )
+
         childProcess.on('exit', () => {
           Promise.all([logsPromise, eventsPromise]).then(() => {
             const { logSpanId, logTraceId } = logIds
@@ -151,7 +166,8 @@ describe('test visibility automatic log submission', () => {
             env: {
               ...getCiVisAgentlessConfig(receiver.port),
               DD_AGENTLESS_LOG_SUBMISSION_URL: `http://localhost:${receiver.port}`,
-              DD_SERVICE: 'my-service'
+              DD_SERVICE: 'my-service',
+              ...getExtraEnvVars()
             },
             stdio: 'pipe'
           }
@@ -181,7 +197,8 @@ describe('test visibility automatic log submission', () => {
               DD_SERVICE: 'my-service',
               DD_TRACE_DEBUG: '1',
               DD_TRACE_LOG_LEVEL: 'warn',
-              DD_API_KEY: ''
+              DD_API_KEY: '',
+              ...getExtraEnvVars()
             },
             stdio: 'pipe'
           }

integration-tests/ci-visibility/automatic-log-submission-playwright/automatic-log-submission-test.js

@@ -0,0 +1,21 @@
+const { test, expect } = require('@playwright/test')
+const logger = require('./logger')
+const sum = require('./sum')
+
+test.beforeEach(async ({ page }) => {
+  await page.goto(process.env.PW_BASE_URL)
+})
+
+test.describe('playwright', () => {
+  test('should be able to log to the console', async ({ page }) => {
+    test.step('log to the console', async () => {
+      logger.log('info', 'Hello simple log!')
+    })
+
+    expect(sum(1, 2)).toEqual(3)
+
+    await expect(page.locator('.hello-world')).toHaveText([
+      'Hello World'
+    ])
+  })
+})

integration-tests/ci-visibility/automatic-log-submission-playwright/logger.js

@@ -0,0 +1,10 @@
+const { createLogger, format, transports } = require('winston')
+
+module.exports = createLogger({
+  level: 'info',
+  exitOnError: false,
+  format: format.json(),
+  transports: [
+    new transports.Console()
+  ]
+})

integration-tests/ci-visibility/automatic-log-submission-playwright/sum.js

@@ -0,0 +1,6 @@
+const logger = require('./logger')
+
+module.exports = function (a, b) {
+  logger.log('info', 'sum function being called')
+  return a + b
+}