Back to Repositories

Testing Bun Command Execution and Context Management in google/zx

This test suite validates Bun integration and command execution functionality in the google/zx project, focusing on process handling, error capturing, and context isolation. The tests ensure reliable shell command execution and proper environment management within the Bun runtime.

Test Coverage Overview

The test suite provides comprehensive coverage of core command execution features in Bun environment.

Key areas tested include:

Basic command execution and output capture
Error handling and exit code processing
stdio inheritance configuration
Context isolation and working directory management

Implementation Analysis

The testing approach utilizes Bun’s native test framework with async/await patterns for command execution testing. The implementation leverages Bun’s test and describe blocks for structured test organization, while employing assertion patterns to validate command outputs and environmental states.

Framework-specific features include:

Bun’s built-in test runner
Async function execution
Native assertion library integration

Technical Details

Testing tools and configuration:

Bun test runner (bun:test)
Node.js assert module
Custom $ command executor
within() context manager
tmpdir() utility for temporary directory handling

Best Practices Demonstrated

The test suite exemplifies high-quality testing practices through isolated test cases and comprehensive error handling verification. Notable practices include:

Proper test isolation using within()
Explicit error case handling
Environment state validation
Clean setup and teardown patterns

google/zx

test/smoke/bun.test.js

            
// Copyright 2024 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

import assert from 'node:assert'
import { test, describe } from 'bun:test'
import { $, within, tmpdir } from '../../build/index.js'
import '../../build/cli.js'

describe('bun', () => {
  test('smoke test', async () => {
    const p = await $`echo foo`
    assert.match(p.stdout, /foo/)
  })

  test('captures err stack', async () => {
    const p = await $({ nothrow: true })`echo foo; exit 3`
    assert.match(p.message, /exit code: 3/)
  })

  test('stdio: inherit', async () => {
    await $({ stdio: 'inherit' })`ls`
  })

  test('ctx isolation', async () => {
    await within(async () => {
      const t1 = tmpdir()
      const t3 = tmpdir()
      $.cwd = t1
      assert.equal($.cwd, t1)
      assert.equal($.cwd, t1)

      const w = within(async () => {
        const t3 = tmpdir()
        $.cwd = t3
        assert.equal($.cwd, t3)

        assert.ok((await $`pwd`).toString().trim().endsWith(t3))
        assert.equal($.cwd, t3)
      })

      await $`pwd`
      assert.ok((await $`pwd`).toString().trim().endsWith(t1))
      assert.equal($.cwd, t1)
      assert.ok((await $`pwd`).toString().trim().endsWith(t1))

      $.cwd = t3
      assert.ok((await $`pwd`).toString().trim().endsWith(t3))
      assert.equal($.cwd, t3)

      await w
    })
  })
})