temp-context
Test Context To Initialise Temporary Directory For Each Test, And Remove It At The End. It Contains Methods To Read, Write, Clone, Assert Existence And Remove Files Inside And Outside Of Temp Dir.
Last updated 7 months ago by zvr .
AGPL-3.0 · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install temp-context 
SYNC missed versions from official npm registry.

temp-context

npm version Pipeline Badge

temp-context is a Zoroaster test context to initialise a temporary directory for each test, and remove it at the end. It also contains methods to read, write, clone, assert existence and remove files inside and outside of the temp dir.

yarn add -E temp-context

Table Of Contents

API

The package is available by importing its default function:

import TempContext from 'temp-context'

class TempContext

Instances of this test context class will create a temp directory in the test folder on initialisation, and remove it at the end of each test. To change the location of the test directory, extend the class.

The test context is used with the Zoroaster testing framework, which will initialise and destroy it for every test. Check the example section to see how tests are implemented.

TempContext: A test context that creates and destroys a temp directory. By default, the temp directory will be test/temp relative to the current working directory, but it can be changed by extending the class and setting its TEMP property in the constructor.

Name Type & Description
constructor new () => TempContext
The constructor method will be called by a context-testing framework automatically.
TEMP string
The path to the temp directory.
_useOSTemp (name: string) => void
This method should be called in the constructor by classes that extend the TempContext to use the temp directory of the os system.
<kbd>name*</kbd> string: The name of the directory inside of the temp dir.
readGlobal (path: string) => !Promise<string>
Read a file from the filesystem.
<kbd>path*</kbd> string: Path of the file to read.
existsGlobal (path: string) => !Promise<boolean>
Check if the path exists on the filesystem.
<kbd>path*</kbd> string: The path to check.
exists (path: string) => !Promise<boolean>
Check if the path exists in the temp directory.
<kbd>path*</kbd> string: The relative path inside of the temp dir to check.
read (path: string) => !Promise<string>
Read a file inside of the temp directory.
<kbd>path*</kbd> string: The path to the file in the temp directory.
write (path: string, data: (string | !Buffer)) => !Promise<string>
Write a file in the temp directory.
<kbd>path*</kbd> string: The path to the file within the temp directory.
<kbd>data*</kbd> (string \| !Buffer): The data to write.
resolve (path: string) => string
Get a path to a file inside of the temp directory.
<kbd>path*</kbd> string: The relative path to the file inside of the temp dir.
rm (path: string) => !Promise<void>
Remove a file or folder inside of the temp directory.
<kbd>path*</kbd> string: The path of the file or folder to remove.
clone (path: string, to: string) => !Promise<void>
Clone a file or directory. This works like cloneGlobal, such that the path won't be resolved automatically.
<kbd>path*</kbd> string: The path to the file or directory to clone.
<kbd>to*</kbd> string: The path to the directory to contain the file or directory being cloned (not the path to the cloned entity).
add (target: string) => !Promise<string>
Adds a file or directory to the temp directory and returns its new path.
<kbd>target*</kbd> string: The path to the file or directory to add to the temp directory.
snapshot (options?: (string | !SnapshotOptions)) => !Promise<string>
Capture the contents of the temp directory as a string (or partial contents if the inner path is given).
<kbd>options</kbd> (string \| !SnapshotOptions) (optional): When a string is passed, indicates the inner path (left for compatibility with previous API). Otherwise, these are additional options for the snapshot, where inner path can also be specified.
_destroy () => !Promise<void>
Called automatically by a context-testing framework to remove the temp path.
_init () => !Promise<void>
Called automatically by a context-testing framework to create an empty temp dir.

For snapshots, the following options can be specified:

SnapshotOptions

Name Type & Description Default
posix boolean false
Standardise the path into POSIX (dir/file.txt) — this is useful when tests are run on Windows too.
innerPath string .
The path inside of the temp dir to snapshot.

Example

Zoroaster tests can be written either as masks, or more traditionally as specs. For example, a program might want to write given data to a file in a specified directory, as so:

import { join } from 'path'
import { createWriteStream } from 'fs'

/**
 * Writes given data to a hidden file.
 * @param {string} path Path to the directory where to create a file.
 * @param {string} data Data to write.
 */
const program = async (path, data) => {
  const j = join(path, '.test')
  const rs = createWriteStream(j)
  await new Promise((r) => {
    rs.end(`hello world: ${data}`)
    rs.on('close', r)
  })
}

export default program

When writing tests with Zoroaster, the project directory will have the src and test directories:

example
├── src
│   └── index.js
└── test
    ├── context
    │   ├── index.js
    │   └── temp.js
    ├── mask
    │   └── default.js
    ├── result
    │   └── default.md
    └── spec
        ├── default.js
        └── extended.js

Masks

To implement tests with masks, a mask implementation should be set up in the mask directory:

import makeTestSuite from '@zoroaster/mask'
import TempContext from 'temp-context'
import program from '../../src'

/**
 * This test suite will clone an input and take a snapshot of the temp directory.
 */
export default makeTestSuite('example/test/result', {
  /**
   * @param {TempContext} context
   */
  async getResults({ TEMP, snapshot }) {
    await program(TEMP, this.input)
    const s = await snapshot()
    return s
  },
  context: TempContext,
})

The results file which contains data about how input should be mapped to the output is saved in the results directory:

## creates a file in the temp directory
input data

/* expected */
# .test

hello world: input data
/**/

Now when run, zoroaster will use the mask test suite (generated with the makeTestSuite function) to check that inputs match expected outputs.

Specs

Occasionally, there are times when masks are not flexible enough to run tests. Specs are individual test cases, and can access test contexts assigned to the context property of a test suite.

import TempContext from 'temp-context'
import { ok, equal } from '@zoroaster/assert'
import Context from '../context'
import program from '../../src'

/** @type {Object.<string, (c:Context, tc: TempContext)>} */
const T = {
  context: [Context, TempContext],
  async 'writes data to a file'(
    { DATA }, { TEMP, resolve, exists, read },
  ) {
    await program(TEMP, DATA)
    const j = resolve('.test')
    console.log('Temp file location: %s', j)

    const e = await exists('.test')
    ok(e, 'File does not exist.')
    const res = await read('.test')
    equal(res, `hello world: ${DATA}`)
  },
}

export default T

Output

The outcome of all the above tests can be achieved with zoroaster -a example/test/spec example/test/mask command, where -a is used to require alamode -- a fast RegExp-based transpiler of import and export statements.

example/test/spec/default.js
Temp file location: test/temp/.test
  ✓  writes data to a file
 example/test/mask
  ✓  creates a file in the temp directory

????  Executed 2 tests.

Autocompletion

One of the advantages of using test context is that they are well documented and it's possible to get auto-completes for available methods when using destructuring on the context argument to a test case, both in masks as well as in specs.

Extending

Extending the TempContext allows to set the specific temp directory location, and/or add additional methods without having to have 2 contexts for testing.

import TempContext from 'temp-context'

export default class MyTempContext extends TempContext {
  constructor() {
    super()
    this._useOSTemp('package-test')
  }
  get DATA() {
    return 'test-data'
  }
}
import { ok, equal } from '@zoroaster/assert'
import MyTempContext from '../context/temp'
import program from '../../src'

/** @type {Object.<string, (tc: MyTempContext)>} */
const T = {
  context: MyTempContext,
  async 'writes data to a file'(
    { TEMP, resolve, exists, read, DATA },
  ) {
    await program(TEMP, DATA)
    const j = resolve('.test')
    console.log('Temp file location: %s', j)

    const e = await exists('.test')
    ok(e, 'File does not exist.')
    const res = await read('.test')
    equal(res, `hello world: ${DATA}`)
  },
}

export default T
example/test/spec/extended.js
Temp file location: /private/var/folders/wj/mc61bmvn3k5_n7q4pfh8rx3w0000gp/T/package-test/.test
  ✓  writes data to a file

????  Executed 1 test.

Copyright

Art Deco © Art Deco™ for Wrote 2020 Wrote AGPL-3.0

Current Tags

  • 2.2.0                                ...           latest (7 months ago)

10 Versions

  • 2.2.0                                ...           7 months ago
  • 2.1.3                                ...           2 years ago
  • 2.1.2                                ...           2 years ago
  • 2.1.1                                ...           2 years ago
  • 2.1.0                                ...           2 years ago
  • 2.0.0                                ...           2 years ago
  • 1.3.0                                ...           2 years ago
  • 1.2.0                                ...           2 years ago
  • 1.1.0                                ...           2 years ago
  • 1.0.0                                ...           2 years ago
Maintainers (1)
Downloads
Today 0
This Week 1
This Month 5
Last Day 0
Last Week 1
Last Month 13
Dependencies (0)
None
Dev Dependencies (16)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |