5c63476f9d63d320a4fd251f0dd51d699266caf7 - test_descriptor

commit	5c63476f9d63d320a4fd251f0dd51d699266caf7	[log] [tgz]
author	Franklin Yow <58489007+franklinyow@users.noreply.github.com>	Wed Mar 31 14:58:19 2021 -0700
committer	GitHub <noreply@github.com>	Wed Mar 31 14:58:19 2021 -0700
tree	3eb5611d1df65f4d1b8dde2434edf5a0b31d0f39
parent	768aaf79f7063e9f52f37225baeed0fd6e498bb1 [diff]

tree: 3eb5611d1df65f4d1b8dde2434edf5a0b31d0f39

README.md

The test_descriptor package provides a convenient, easy-to-read API for defining and verifying directory structures in tests.

We recommend that you import this library with the d prefix. The d.dir() and d.file() functions are the main entrypoints. They define a filesystem structure that can be created using Descriptor.create() and verified using Descriptor.validate(). For example:

import 'dart:io';

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 new 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. 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.

This package is term_glyph aware. It will decide whether to use ASCII or Unicode glyphs based on the glyph.ascii attribute.