https://github.com/dart-lang/test_descriptor

Provides a convenient, easy-to-read API for defining and verifying directory structures in tests
https://github.com/dart-lang/test_descriptor

Last synced: 6 months ago
JSON representation

Provides a convenient, easy-to-read API for defining and verifying directory structures in tests

• Host: GitHub
• URL: https://github.com/dart-lang/test_descriptor
• Owner: dart-lang
• License: bsd-3-clause
• Created: 2017-01-05T22:04:44.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-12-12T13:22:47.000Z (6 months ago)
• Last Synced: 2024-12-16T06:03:55.425Z (6 months ago)
• Language: Dart
• Homepage: https://pub.dev/packages/test_descriptor
• Size: 146 KB
• Stars: 9
• Watchers: 36
• Forks: 8
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Authors: AUTHORS

Awesome Lists containing this project

README

        
> [!IMPORTANT]  

> This repo has moved to https://github.com/dart-lang/test/tree/master/pkgs/test_descriptor

[![Dart CI](https://github.com/dart-lang/test_descriptor/actions/workflows/test-package.yml/badge.svg)](https://github.com/dart-lang/test_descriptor/actions/workflows/test-package.yml)

[![pub package](https://img.shields.io/pub/v/test_descriptor.svg)](https://pub.dev/packages/test_descriptor)

[![package publisher](https://img.shields.io/pub/publisher/test_descriptor.svg)](https://pub.dev/packages/test_descriptor/publisher)

The `test_descriptor` package provides a convenient, easy-to-read API for

defining and verifying directory structures in tests.

## Usage

We recommend that you import this library with the `d` prefix. The

[`d.dir()`][dir] and [`d.file()`][file] functions are the main entrypoints. They

define a filesystem structure that can be created using

[`Descriptor.create()`][create] and verified using

[`Descriptor.validate()`][validate]. For example:

[dir]: https://pub.dev/documentation/test_descriptor/latest/test_descriptor/dir.html

[file]: https://pub.dev/documentation/test_descriptor/latest/test_descriptor/file.html

[create]: https://pub.dev/documentation/test_descriptor/latest/test_descriptor/Descriptor/create.html

[validate]: https://pub.dev/documentation/test_descriptor/latest/test_descriptor/Descriptor/validate.html

```dart

import 'dart:io';

import 'package:test/test.dart';

import 'package:test_descriptor/test_descriptor.dart' as d;

void main() {

  test('Directory.rename', () async {

    await d.dir('parent', [

      d.file('sibling', 'sibling-contents'),

      d.dir('old-name', [d.file('child', 'child-contents')])

    ]).create();

    await Directory('${d.sandbox}/parent/old-name')

        .rename('${d.sandbox}/parent/new-name');

    await d.dir('parent', [

      d.file('sibling', 'sibling-contents'),

      d.dir('new-name', [d.file('child', 'child-contents')])

    ]).validate();

  });

}

```

By default, descriptors create entries in a temporary sandbox directory,

[`d.sandbox`][sandbox]. A new sandbox is automatically created the first time

you create a descriptor in a given test, and automatically deleted once the test

finishes running.

[sandbox]: https://pub.dev/documentation/test_descriptor/latest/test_descriptor/sandbox.html

This package is [`term_glyph`][term_glyph] aware. It will decide whether to use

ASCII or Unicode glyphs based on the [`glyph.ascii`][ascii] attribute.

[term_glyph]: https://pub.dev/packages/term_glyph

[ascii]: https://pub.dev/documentation/term_glyph/latest/term_glyph/ascii.html