Back to Repositories

Validating Package.json Cleaning Operations in Google ZX

This test suite validates the package.json artifact cleaning functionality in the Google ZX repository. It ensures proper handling of package.json properties during the publishing process by verifying the removal of development-specific fields while maintaining essential publishing information.

Test Coverage Overview

The test suite provides comprehensive coverage of package.json cleaning operations, focusing on property management during the publishing process.

Verifies preservation of essential publishing fields (name, description)
Tests removal of development-specific properties (prettier, scripts, volta)
Ensures proper file copying and cleanup operations

Implementation Analysis

The testing approach utilizes Node’s native test framework with temporary directory management for isolation.

Implements before/after hooks for test environment setup and cleanup
Uses file system operations for package.json manipulation
Employs assertion-based verification of JSON properties

Technical Details

Testing Framework: Node.js native test module
File System Operations: fs module for copy/remove operations
Temporary Directory Management: Custom tempdir utility
Assertion Library: Node.js assert module
Test Environment: Isolated temporary directory structure

Best Practices Demonstrated

The test suite exemplifies several testing best practices for configuration file management.

Isolated test environment using temporary directories
Proper cleanup of test artifacts
Clear separation of setup, execution, and verification phases
Specific assertions for each property verification
Structured test organization using describe/it blocks

google/zx

test/it/clean-package-json.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 { tempdir, $, path, fs } from '../../build/index.js'
import { describe, before, after, it } from 'node:test'

const __dirname = path.dirname(new URL(import.meta.url).pathname)
const root = path.resolve(__dirname, '../../')

describe('package.json artifact', () => {
  let tmp
  let t$

  before(async () => {
    tmp = tempdir()
    t$ = $({ cwd: tmp, quiet: true })

    await fs.copy(
      path.resolve(root, 'package.json'),
      path.resolve(tmp, 'package.json')
    )
    await fs.copy(
      path.resolve(root, 'scripts/clean-package-json.mjs'),
      path.resolve(tmp, 'scripts/clean-package-json.mjs')
    )
  })

  after(() => fs.remove(tmp))

  it('handle exist properties required for publishing', async () => {
    await t$`node scripts/clean-package-json.mjs`
    // to throw if manifest is not correct
    const pkgJson = JSON.parse(
      fs.readFileSync(path.resolve(tmp, 'package.json'))
    )

    assert.equal(pkgJson.name, 'zx')
    assert.equal(pkgJson.description, 'A tool for writing better scripts')
    assert.equal(pkgJson.prettier, undefined)
    assert.equal(pkgJson.scripts, undefined)
    assert.equal(pkgJson.volta, undefined)
  })
})