go2hx

manual

github

Module: stdgo.testing.fstest

(view library index)

Overview

Package fstest implements support for testing implementations and users of file systems.

Index

Variables

import stdgo.testing.fstest.Fstest
var __2:stdgo.io.fs.FS
var __3:stdgo.io.fs.File

Functions

import stdgo.testing.fstest.Fstest

function _formatEntry

function _formatEntry(_entry:stdgo.io.fs.DirEntry):stdgo.GoString

formatEntry formats an fs.DirEntry into a string for error messages and comparison.

(view code)

function _formatInfo

function _formatInfo(_info:stdgo.io.fs.FileInfo):stdgo.GoString

formatInfo formats an fs.FileInfo into a string for error messages and comparison.

(view code)

function _formatInfoEntry

function _formatInfoEntry(_info:stdgo.io.fs.FileInfo):stdgo.GoString

formatInfoEntry formats an fs.FileInfo into a string like the result of formatEntry, for error messages and comparison.

(view code)

function _testFS

function _testFS(_fsys:stdgo.io.fs.FS, _expected:haxe.Rest<stdgo.GoString>):stdgo.Error

(view code)

function testDash

function testDash(_t:stdgo.Ref<stdgo.testing.T_>):Void

(view code)

function testFS

function testFS(_fsys:stdgo.io.fs.FS, _expected:haxe.Rest<stdgo.GoString>):stdgo.Error

TestFS tests a file system implementation. It walks the entire tree of files in fsys, opening and checking that each file behaves correctly. It also checks that the file system contains at least the expected files. As a special case, if no expected files are listed, fsys must be empty. Otherwise, fsys must contain at least the listed files; it can also contain others. The contents of fsys must not change concurrently with TestFS.

If TestFS finds any misbehaviors, it returns an error reporting all of them. The error text spans multiple lines, one per detected misbehavior.

Typical usage inside a test is: 

	if err := fstest.TestFS(myFS, "file/that/should/be/present"); err != nil {
		t.Fatal(err)
	}

(view code)

function testMapFS

function testMapFS(_t:stdgo.Ref<stdgo.testing.T_>):Void

(view code)

function testMapFSChmodDot

function testMapFSChmodDot(_t:stdgo.Ref<stdgo.testing.T_>):Void

(view code)

function testShuffledFS

function testShuffledFS(_t:stdgo.Ref<stdgo.testing.T_>):Void

(view code)

function testSymlink

function testSymlink(_t:stdgo.Ref<stdgo.testing.T_>):Void

(view code)

Classes

import stdgo.testing.fstest.*

class MapFile

A MapFile describes a single file in a MapFS. 

var data:stdgo.Slice<stdgo.GoUInt8>
var modTime:stdgo.time.Time
var mode:stdgo.io.fs.FileMode
var sys:stdgo.AnyInterface

MapFile function new

function new(?data:stdgo.Slice<stdgo.GoUInt8>, ?mode:Null<stdgo.io.fs.FileMode>, ?modTime:stdgo.time.Time, ?sys:stdgo.AnyInterface):Void

(view code)

Typedefs

import stdgo.testing.fstest.*

typedef MapFS

typedef MapFS = stdgo.GoMap<stdgo.GoString, stdgo.Ref<stdgo.testing.fstest.MapFile>>;

A MapFS is a simple in-memory file system for use in tests, represented as a map from path names (arguments to Open) to information about the files or directories they represent.

The map need not include parent directories for files contained in the map; those will be synthesized if needed. But a directory can still be included by setting the MapFile.Mode's ModeDir bit; this may be necessary for detailed control over the directory's FileInfo or to create an empty directory.

File system operations read directly from the map, so that the file system can be changed by editing the map as needed. An implication is that file system operations must not run concurrently with changes to the map, which would be a race. Another implication is that opening or reading a directory requires iterating over the entire map, so a MapFS should typically be used with not more than a few hundred entries or directory reads.

typedef T_shuffledFS

typedef T_shuffledFS = stdgo.testing.fstest.MapFS;