run Namespace Reference

Data Structures
class	Options
class	TestCase
class	TestSuite

Functions
bool	exclude_dir (str dirname)
bool	exclude_file (str filename)
bytes	read_file (str filename)
str	diff (bytes a, bytes b)
typing.Tuple[typing.Optional[bytes], bytes]	pop_line (bytes data)
bool	glob_line_matches (bytes actual, bytes expect)
bytes	glob_diff (bytes actual, bytes expect)
TestSuites	get_all_tests (Options options)
TestSuites	resolve_listed_tests (typing.List[str] tests, Options options)
bool	run_tests (TestSuites test_suites, Options options)
None	setup_zstd_symlink_dir (str zstd_symlink_dir, str zstd)

Variables
list	ZSTD_SYMLINKS
dict	EXCLUDED_DIRS
dict	EXCLUDED_BASENAMES
list	EXCLUDED_SUFFIXES
	TestSuites = typing.Dict[str, typing.List[str]]
	CLI_TEST_DIR = os.path.dirname(sys.argv[0])
	REPO_DIR = os.path.join(CLI_TEST_DIR, "..", "..")
	PROGRAMS_DIR = os.path.join(REPO_DIR, "programs")
	TESTS_DIR = os.path.join(REPO_DIR, "tests")
	ZSTD_PATH = os.path.join(PROGRAMS_DIR, "zstd")
	ZSTDGREP_PATH = os.path.join(PROGRAMS_DIR, "zstdgrep")
	ZSTDLESS_PATH = os.path.join(PROGRAMS_DIR, "zstdless")
	DATAGEN_PATH = os.path.join(TESTS_DIR, "datagen")
	parser
	action
	help
	default
	type
	int
	nargs
	args = parser.parse_args()
	timeout
	test_dir
	bin_dir = os.path.abspath(os.path.join(args.test_dir, "bin"))
	zstd_symlink_dir = os.path.join(bin_dir, "symlinks")
	scratch_dir = os.path.join(args.test_dir, "scratch")
dict	env = {}
	opts
TestSuites	tests = get_all_tests(opts)
bool	success = run_tests(tests, opts)

Function Documentation

diff()

str diff	(	bytes	a,
		bytes	b )

Returns a diff between two different byte-strings :a: and :b:.

exclude_dir()

bool exclude_dir

(

str

dirname

)

Should files under the directory :dirname: be excluded from the test runner?

exclude_file()

bool exclude_file

(

str

filename

)

Should the file :filename: be excluded from the test runner?

get_all_tests()

TestSuites get_all_tests

(

Options

options

)

Find all the test in the test directory and return the test suites.

glob_diff()

bytes glob_diff	(	bytes	actual,
		bytes	expect )

Returns None if the :actual: content matches the expected glob :expect:,
otherwise returns the diff bytes.

glob_line_matches()

bool glob_line_matches	(	bytes	actual,
		bytes	expect )

Does the `actual` line match the expected glob line `expect`?

pop_line()

typing.Tuple[typing.Optional[bytes], bytes] pop_line

(

bytes

data

)

Pop the first line from :data: and returns the first line and the remainder
of the data as a tuple. If :data: is empty, returns :(None, data):. Otherwise
the first line always ends in a :\n:, even if it is the last line and :data:
doesn't end in :\n:.

read_file()

bytes read_file

(

str

filename

)

Reads the file :filename: and returns the contents as bytes.

resolve_listed_tests()

TestSuites resolve_listed_tests	(	typing.List[str]	tests,
		Options	options )

Resolve the list of tests passed on the command line into their
respective test suites. Tests can either be paths, or test names
relative to the test directory.

run_tests()

bool run_tests	(	TestSuites	test_suites,
		Options	options )

Runs all the test in the :test_suites: with the given :options:.
Prints the results to stdout.

setup_zstd_symlink_dir()

None setup_zstd_symlink_dir	(	str	zstd_symlink_dir,
		str	zstd )

Variable Documentation

action

action

args

args = parser.parse_args()

bin_dir

bin_dir = os.path.abspath(os.path.join(args.test_dir, "bin"))

CLI_TEST_DIR

CLI_TEST_DIR = os.path.dirname(sys.argv[0])

DATAGEN_PATH

DATAGEN_PATH = os.path.join(TESTS_DIR, "datagen")

default

default

env

dict env = {}

EXCLUDED_BASENAMES

dict EXCLUDED_BASENAMES

Initial value:

=  {
    "setup",
    "setup_once",
    "teardown",
    "teardown_once",
    "README.md",
    "run.py",
    ".gitignore",
}

EXCLUDED_DIRS

dict EXCLUDED_DIRS

Initial value:

=  {
    "bin",
    "common",
    "scratch",
}

EXCLUDED_SUFFIXES

list EXCLUDED_SUFFIXES

Initial value:

=  [
    ".exact",
    ".glob",
    ".ignore",
    ".exit",
]

help

help

(

void

)

int

int

nargs

nargs

opts

opts

Initial value:

=  Options(
        env=env,
        timeout=args.timeout,
        verbose=args.verbose,
        preserve=args.preserve,
        test_dir=args.test_dir,
        scratch_dir=scratch_dir,
        set_exact_output=args.set_exact_output,
    )

parser

parser

Initial value:

=  argparse.ArgumentParser(
        (
            "Runs the zstd CLI tests. Exits nonzero on failure. Default arguments are\n"
            "generally correct. Pass --preserve to preserve test output for debugging,\n"
            "and --verbose to get verbose test output.\n"
        )
    )

PROGRAMS_DIR

PROGRAMS_DIR = os.path.join(REPO_DIR, "programs")

REPO_DIR

REPO_DIR = os.path.join(CLI_TEST_DIR, "..", "..")

scratch_dir

scratch_dir = os.path.join(args.test_dir, "scratch")

success

bool success = run_tests(tests, opts)

test_dir

test_dir

tests

TestSuites tests = get_all_tests(opts)

TESTS_DIR

TESTS_DIR = os.path.join(REPO_DIR, "tests")

TestSuites

TestSuites = typing.Dict[str, typing.List[str]]

timeout

timeout

type

type

ZSTD_PATH

ZSTD_PATH = os.path.join(PROGRAMS_DIR, "zstd")

zstd_symlink_dir

zstd_symlink_dir = os.path.join(bin_dir, "symlinks")

ZSTD_SYMLINKS

list ZSTD_SYMLINKS

Initial value:

=  [
    "zstd",
    "zstdmt",
    "unzstd",
    "zstdcat",
    "zcat",
    "gzip",
    "gunzip",
    "gzcat",
    "lzma",
    "unlzma",
    "xz",
    "unxz",
    "lz4",
    "unlz4",
]

ZSTDGREP_PATH

ZSTDGREP_PATH = os.path.join(PROGRAMS_DIR, "zstdgrep")

ZSTDLESS_PATH

ZSTDLESS_PATH = os.path.join(PROGRAMS_DIR, "zstdless")