test_descriptor 1.2.0

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 79

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.

1.2.0 #

  • Add an ArchiveDescriptor class and a corresponding archive() function that can create and validate Zip and TAR archives.

1.1.1 #

  • Update to lowercase Dart core library constants.

1.1.0 #

  • Add a path() function that returns the a path within the sandbox directory.

  • Add io getters to FileDescriptor and DirectoryDescriptor that returns dart:io File and Directory objects, respectively, within the sandbox directory.

1.0.4 #

  • Support test `1.x.x'.

1.0.3 #

  • Stop using comment-based generics.

1.0.2 #

  • Declare support for async 2.0.0.

1.0.1 #

  • FileDescriptor.validate() now allows invalid UTF-8 files.

  • Fix a bug where DirectoryDescriptor.load() would incorrectly report that multiple versions of a file or directory existed.

1.0.0 #

  • Initial version.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  test_descriptor: ^1.2.0

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:test_descriptor/test_descriptor.dart';
  
Version Uploaded Documentation Archive
1.2.0 Jun 12, 2019 Go to the documentation of test_descriptor 1.2.0 Download test_descriptor 1.2.0 archive
1.1.1 Jul 13, 2018 Go to the documentation of test_descriptor 1.1.1 Download test_descriptor 1.1.1 archive
1.1.0 Jun 19, 2018 Go to the documentation of test_descriptor 1.1.0 Download test_descriptor 1.1.0 archive
1.0.4 Jun 15, 2018 Go to the documentation of test_descriptor 1.0.4 Download test_descriptor 1.0.4 archive
1.0.3 Oct 17, 2017 Go to the documentation of test_descriptor 1.0.3 Download test_descriptor 1.0.3 archive
1.0.2 Sep 22, 2017 Go to the documentation of test_descriptor 1.0.2 Download test_descriptor 1.0.2 archive
1.0.1 Jun 1, 2017 Go to the documentation of test_descriptor 1.0.1 Download test_descriptor 1.0.1 archive
1.0.0 Mar 11, 2017 Go to the documentation of test_descriptor 1.0.0 Download test_descriptor 1.0.0 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
65
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
85
Overall:
Weighted score of the above. [more]
79
Learn more about scoring.

We analyzed this package on Jun 17, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.3.2
  • pana: 0.12.18

Platforms

Detected platforms: Flutter, other

Primary library: package:test_descriptor/test_descriptor.dart with components: io.

Maintenance suggestions

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and test_descriptor.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

The package description is too short. (-5 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0 <3.0.0
archive ^2.0.0 2.0.10
async >=1.13.0 <3.0.0 2.2.0
collection ^1.5.0 1.14.11
matcher ^0.12.0 0.12.5
meta ^1.1.7 1.1.7
path ^1.0.0 1.6.2
stack_trace ^1.0.0 1.9.3
term_glyph ^1.0.0 1.1.0
test ^1.6.0 1.6.4
Transitive dependencies
analyzer 0.36.3
args 1.5.2
boolean_selector 1.0.4
charcode 1.1.2
convert 2.1.1
crypto 2.0.6
csslib 0.16.0
front_end 0.1.18
glob 1.1.7
html 0.14.0+2
http 0.12.0+2
http_multi_server 2.1.0
http_parser 3.1.3
io 0.3.3
js 0.6.1+1
json_rpc_2 2.1.0
kernel 0.3.18
mime 0.9.6+3
multi_server_socket 1.0.2
node_preamble 1.4.4
package_config 1.0.5
package_resolver 1.0.10
pool 1.4.0
pub_semver 1.4.2
shelf 0.7.5
shelf_packages_handler 1.0.4
shelf_static 0.2.8
shelf_web_socket 0.2.3
source_map_stack_trace 1.1.5
source_maps 0.10.8
source_span 1.5.5
stream_channel 2.0.0
string_scanner 1.0.4
test_api 0.2.6
test_core 0.2.6
typed_data 1.1.6
vm_service_client 0.2.6+2
watcher 0.9.7+10
web_socket_channel 1.0.13
yaml 2.1.16
Dev dependencies
pedantic ^1.0.0 1.7.0