Back to Repositories

Testing Windows Shell Integration and PowerShell Compatibility in google/zx

This test suite validates Windows-specific functionality in the google/zx project, focusing on PowerShell integration and command execution compatibility. The tests ensure proper shell switching and command quoting behavior in Windows environments.

Test Coverage Overview

The test suite provides comprehensive coverage of Windows-specific command execution scenarios.

Windows command execution validation
PowerShell shell switching mechanics
Command quoting behavior verification
Pwsh availability and functionality testing

Implementation Analysis

The testing approach utilizes Node’s native test framework with conditional test execution based on platform detection. The implementation employs the ‘within’ pattern for shell context management and leverages Jest-style assertion patterns for verification.

Conditional test execution using platform checks
Shell context isolation with ‘within’ blocks
Dynamic shell switching with usePowerShell/usePwsh

Technical Details

Node.js native test framework
Platform-specific test skipping
Shell detection and switching utilities
PowerShell command quoting mechanisms
Assertion patterns for command output validation

Best Practices Demonstrated

The test suite exemplifies robust cross-platform testing practices with careful consideration for Windows-specific behaviors. It demonstrates effective use of test isolation, conditional execution, and platform-specific command validation.

Platform-aware test configuration
Isolated shell context management
Comprehensive command output validation
Graceful handling of optional dependencies

google/zx

test/smoke/win32.test.js

            
// Copyright 2021 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 'node:test'
import '../../build/globals.js'

const _describe = process.platform === 'win32' ? describe : describe.skip

const _testPwsh = which.sync('pwsh', { nothrow: true }) ? test : test.skip

_describe('win32', () => {
  test('should work with windows-specific commands', async () => {
    const p = await $`echo $0` // Bash is first by default.
    assert.match(p.stdout, /bash/)

    await within(async () => {
      usePowerShell()
      assert.match($.shell, /powershell/i)
      const p = await $`get-host`
      assert.match(p.stdout, /PowerShell/)
    })
  })

  test('quotePowerShell works', async () => {
    await within(async () => {
      usePowerShell()
      const p = await $`echo ${`Windows 'rulez!'`}`
      assert.match(p.stdout, /Windows 'rulez!'/)
    })
  })

  _testPwsh('should work with pwsh when it is available', async () => {
    await within(async () => {
      usePwsh()
      assert.match($.shell, /pwsh/i)
      const p = await $`echo 'Hello,' && echo ${`new 'PowerShell'!`}`
      assert.match(p.stdout, /Hello,\s+new 'PowerShell'!/)
    })
  })
})