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.

Sign up for GitHub

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

Jump to bottom

(@wdio/utils): propagate driver logs to stdout #11175

Merged
merged 1 commit into from Sep 15, 2023
Merged

(@wdio/utils): propagate driver logs to stdout #11175

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 9 additions & 0 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions packages/wdio-utils/package.json
View file
Open in desktop
Expand Up @@ -42,6 +42,7 @@
"import-meta-resolve": "^3.0.0",
"locate-app": "^2.1.0",
"safaridriver": "^0.1.0",
"split2": "^4.2.0",
"wait-port": "^1.0.4"
},
"publishConfig": {
Expand Down
7 changes: 6 additions & 1 deletion packages/wdio-utils/src/driver/index.ts
View file
Open in desktop
Expand Up @@ -6,6 +6,7 @@ import cp, { type ChildProcess } from 'node:child_process'
import getPort from 'get-port'
import waitPort from 'wait-port'
import logger from '@wdio/logger'
import split2 from 'split2'
import { deepmerge } from 'deepmerge-ts'

import { start as startSafaridriver, type SafaridriverOptions as SafaridriverParameters } from 'safaridriver'
Expand Down Expand Up @@ -163,15 +164,19 @@ export async function startWebDriver (options: Options.WebDriver) {
)
}

const logIdentifier = driver.split(' ').shift()?.toLowerCase() || 'driver'
if (options.outputDir) {
const logIdentifier = driver.split(' ').shift()?.toLowerCase()
const logFileName = process.env.WDIO_WORKER_ID
? `wdio-${process.env.WDIO_WORKER_ID}-${logIdentifier}.log`
: `wdio-${logIdentifier}-${port}.log`
const logFile = path.resolve(options.outputDir, logFileName)
const logStream = fs.createWriteStream(logFile, { flags: 'w' })
driverProcess.stdout?.pipe(logStream)
driverProcess.stderr?.pipe(logStream)
} else {
const driverLog = logger(logIdentifier)
driverProcess.stdout?.pipe(split2()).on('data', driverLog.info.bind(driverLog))
driverProcess.stderr?.pipe(split2()).on('data', driverLog.warn.bind(driverLog))
}

await waitPort({ port, output: 'silent', timeout: DRIVER_WAIT_TIMEOUT })
Expand Down
20 changes: 16 additions & 4 deletions packages/wdio-utils/tests/driver/index.test.ts
View file
Open in desktop
Expand Up @@ -4,6 +4,7 @@ import fs from 'node:fs'
import path from 'node:path'
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'

import split2 from 'split2'
import waitPort from 'wait-port'
import { start as startSafaridriver } from 'safaridriver'
import { start as startGeckodriver } from 'geckodriver'
Expand All @@ -12,6 +13,8 @@ import { install } from '@puppeteer/browsers'

import { startWebDriver } from '../../src/driver/index.js'

vi.mock('split2', () => ({ default: vi.fn() }))

vi.mock('node:fs/promises', () => ({
default: {
access: vi.fn().mockRejectedValue(new Error('boom')),
Expand All @@ -35,8 +38,8 @@ vi.mock('node:os', async (origMod) => ({
vi.mock('node:child_process', () => ({
default: {
spawn: vi.fn().mockReturnValue({
stdout: { pipe: vi.fn() },
stderr: { pipe: vi.fn() }
stdout: { pipe: vi.fn().mockReturnValue({ on: vi.fn() }) },
stderr: { pipe: vi.fn().mockReturnValue({ on: vi.fn() }) }
}),
execSync: vi.fn().mockReturnValue(Buffer.from('115.0.5790.171'))
}
Expand All @@ -45,7 +48,12 @@ vi.mock('node:child_process', () => ({
vi.mock('@wdio/logger', () => import(path.join(process.cwd(), '__mocks__', '@wdio/logger')))
vi.mock('devtools', () => ({ default: 'devtools package' }))
vi.mock('webdriver', () => ({ default: 'webdriver package' }))
vi.mock('safaridriver', () => ({ start: vi.fn().mockReturnValue('safaridriver') }))
vi.mock('safaridriver', () => ({
start: vi.fn().mockReturnValue({
stdout: { pipe: vi.fn().mockReturnValue({ on: vi.fn() }) },
stderr: { pipe: vi.fn().mockReturnValue({ on: vi.fn() }) }
})
}))
vi.mock('edgedriver', () => ({
start: vi.fn().mockResolvedValue('edgedriver'),
findEdgePath: vi.fn().mockReturnValue('/foo/bar/executable')
Expand Down Expand Up @@ -101,7 +109,10 @@ describe('startWebDriver', () => {
'wdio:safaridriverOptions': { foo: 'bar' }
} as any
}
await expect(startWebDriver(params)).resolves.toBe('safaridriver')
await expect(startWebDriver(params)).resolves.toEqual(expect.objectContaining({
stdout: expect.any(Object),
stderr: expect.any(Object)
}))
await expect(params).toEqual({
hostname: '0.0.0.0',
port: 1234,
Expand All @@ -121,6 +132,7 @@ describe('startWebDriver', () => {
foo: 'bar',
useTechnologyPreview: false
})
expect(split2).toBeCalledTimes(2)
})

it('should start firefox driver', async () => {
Expand Down