electrobun 0.0.1 → 0.0.2

package/src/bsdiff/zstd/tests/cli-tests/README.md

@@ -1,258 +0,0 @@
-# CLI tests
-
-The CLI tests are focused on testing the zstd CLI.
-They are intended to be simple tests that the CLI and arguments work as advertised.
-They are not intended to test the library, only the code in `programs/`.
-The library will get incidental coverage, but if you find yourself trying to trigger a specific condition in the library, this is the wrong tool.
-
-## Test runner usage
-
-The test runner `run.py` will run tests against the in-tree build of `zstd` and `datagen` by default. Which means that `zstd` and `datagen` must be built.
-
-The `zstd` binary used can be passed with `--zstd /path/to/zstd`.
-Additionally, to run `zstd` through a tool like `valgrind` or `qemu`, set the `--exec-prefix 'valgrind -q'` flag.
-
-Similarly, the `--datagen`, and `--zstdgrep` flags can be set to specify
-the paths to their respective binaries. However, these tools do not use
-the `EXEC_PREFIX`.
-
-Each test executes in its own scratch directory under `scratch/test/name`. E.g. `scratch/basic/help.sh/`. Normally these directories are removed after the test executes. However, the `--preserve` flag will preserve these directories after execution, and save the tests exit code, stdout, and stderr in the scratch directory to `exit`, `stderr`, and `stdout` respectively. This can be useful for debugging/editing a test and updating the expected output.
-
-### Running all the tests
-
-By default the test runner `run.py` will run all the tests, and report the results.
-
-Examples:
-
-```
-./run.py
-./run.py --preserve
-./run.py --zstd ../../build/programs/zstd --datagen ../../build/tests/datagen
-```
-
-### Running specific tests
-
-A set of test names can be passed to the test runner `run.py` to only execute those tests.
-This can be useful for writing or debugging a test, especially with `--preserve`.
-
-The test name can either be the path to the test file, or the test name, which is the path relative to the test directory.
-
-Examples:
-
-```
-./run.py basic/help.sh
-./run.py --preserve basic/help.sh basic/version.sh
-./run.py --preserve --verbose basic/help.sh
-```
-
-### Updating exact output
-
-If a test is failing because a `.stderr.exact` or `.stdout.exact` no longer matches, you can re-run the tests with `--set-exact-output` and the correct output will be written.
-
-Example:
-```
-./run.py --set-exact-output
-./run.py basic/help.sh --set-exact-output
-```
-
-## Writing a test
-
-Test cases are arbitrary executables, and can be written in any language, but are generally shell scripts.
-After the script executes, the exit code, stderr, and stdout are compared against the expectations.
-
-Each test is run in a clean directory that the test can use for intermediate files. This directory will be cleaned up at the end of the test, unless `--preserve` is passed to the test runner. Additionally, the `setup` script can prepare the directory before the test runs.
-
-### Calling zstd, utilities, and environment variables
-
-The `$PATH` for tests is prepended with the `bin/` sub-directory, which contains helper scripts for ease of testing.
-The `zstd` binary will call the zstd binary specified by `run.py` with the correct `$EXEC_PREFIX`.
-Similarly, `datagen`, `unzstd`, `zstdgrep`, `zstdcat`, etc, are provided.
-
-Helper utilities like `cmp_size`, `println`, and `die` are provided here too. See their scripts for details.
-
-Common shell script libraries are provided under `common/`, with helper variables and functions. They can be sourced with `source "$COMMON/library.sh`.
-
-Lastly, environment variables are provided for testing, which can be listed when calling `run.py` with `--verbose`.
-They are generally used by the helper scripts in `bin/` to coordinate everything.
-
-### Basic test case
-
-When executing your `$TEST` executable, by default the exit code is expected to be `0`. However, you can provide an alternate expected exit code in a `$TEST.exit` file.
-
-When executing your `$TEST` executable, by default the expected stderr and stdout are empty. However, you can override the default by providing one of three files:
-
-* `$TEST.{stdout,stderr}.exact`
-* `$TEST.{stdout,stderr}.glob`
-* `$TEST.{stdout,stderr}.ignore`
-
-If you provide a `.exact` file, the output is expected to exactly match, byte-for-byte.
-
-If you provide a `.glob` file, the output is expected to match the expected file, where each line is interpreted as a glob syntax. Additionally, a line containing only `...` matches all lines until the next expected line matches.
-
-If you provide a `.ignore` file, the output is ignored.
-
-#### Passing examples
-
-All these examples pass.
-
-Exit 1, and change the expectation to be 1.
-
-```
-exit-1.sh
----
-#!/bin/sh
-exit 1
----
-
-exit-1.sh.exit
----
-1
----
-```
-
-Check the stdout output exactly matches.
-
-```
-echo.sh
----
-#!/bin/sh
-echo "hello world"
----
-
-echo.sh.stdout.exact
----
-hello world
----
-```
-
-Check the stderr output using a glob.
-
-```
-random.sh
----
-#!/bin/sh
-head -c 10 < /dev/urandom | xxd >&2
----
-
-random.sh.stderr.glob
----
-00000000: * * * * *                 *
-```
-
-Multiple lines can be matched with ...
-
-```
-random-num-lines.sh
----
-#!/bin/sh
-echo hello
-seq 0 $RANDOM
-echo world
----
-
-random-num-lines.sh.stdout.glob
----
-hello
-0
-...
-world
----
-```
-
-#### Failing examples
-
-Exit code is expected to be 0, but is 1.
-
-```
-exit-1.sh
----
-#!/bin/sh
-exit 1
----
-```
-
-Stdout is expected to be empty, but isn't.
-
-```
-echo.sh
----
-#!/bin/sh
-echo hello world
-```
-
-Stderr is expected to be hello but is world.
-
-```
-hello.sh
----
-#!/bin/sh
-echo world >&2
----
-
-hello.sh.stderr.exact
----
-hello
----
-```
-
-### Setup & teardown scripts
-
-Finally, test writing can be eased with setup and teardown scripts.
-Each directory in the test directory is a test-suite consisting of all tests within that directory (but not sub-directories).
-This test suite can come with 4 scripts to help test writing:
-
-* `setup_once`
-* `teardown_once`
-* `setup`
-* `teardown`
-
-The `setup_once` and `teardown_once` are run once before and after all the tests in the suite respectively.
-They operate in the scratch directory for the test suite, which is the parent directory of each scratch directory for each test case.
-They can do work that is shared between tests to improve test efficiency.
-For example, the `dictionaries/setup_once` script builds several dictionaries, for use in the `dictionaries` tests.
-
-The `setup` and `teardown` scripts run before and after each test case respectively, in the test case's scratch directory.
-These scripts can do work that is shared between test cases to make tests more succinct.
-For example, the `dictionaries/setup` script copies the dictionaries built by the `dictionaries/setup_once` script into the test's scratch directory, to make them easier to use, and make sure they aren't accidentally modified.
-
-#### Examples
-
-```
-basic/setup
----
-#!/bin/sh
-# Create some files for testing with
-datagen > file
-datagen > file0
-datagen > file1
----
-
-basic/test.sh
----
-#!/bin/sh
-zstd file file0 file1
----
-
-dictionaries/setup_once
----
-#!/bin/sh
-set -e
-
-mkdir files/ dicts/
-for i in $(seq 10); do
-	datagen -g1000 > files/$i
-done
-
-zstd --train -r files/ -o dicts/0
----
-
-dictionaries/setup
----
-#!/bin/sh
-
-# Runs in the test case's scratch directory.
-# The test suite's scratch directory that
-# `setup_once` operates in is the parent directory.
-cp -r ../files ../dicts .
----
-```

package/src/bsdiff/zstd/tests/cli-tests/basic/args.sh

@@ -1,10 +0,0 @@
-#!/bin/sh
-
-println "+ zstd --blah" >&2
-zstd --blah
-println "+ zstd -xz" >&2
-zstd -xz
-println "+ zstd --adapt=min=1,maxx=2 file.txt" >&2
-zstd --adapt=min=1,maxx=2 file.txt
-println "+ zstd --train-cover=k=48,d=8,steps32 file.txt" >&2
-zstd --train-cover=k=48,d=8,steps32 file.txt

package/src/bsdiff/zstd/tests/cli-tests/basic/args.sh.exit

@@ -1 +0,0 @@
-1

package/src/bsdiff/zstd/tests/cli-tests/basic/args.sh.stderr.glob

@@ -1,28 +0,0 @@
-+ zstd --blah
-Incorrect parameter: --blah
-...
-Usage: zstd *
-
-Options:
-...
-+ zstd -xz
-Incorrect parameter: -x
-...
-Usage: zstd *
-
-Options:
-...
-+ zstd --adapt=min=1,maxx=2 file.txt
-Incorrect parameter: --adapt=min=1,maxx=2
-...
-Usage: zstd *
-
-Options:
-...
-+ zstd --train-cover=k=48,d=8,steps32 file.txt
-Incorrect parameter: --train-cover=k=48,d=8,steps32
-...
-Usage: zstd *
-
-Options:
-...

package/src/bsdiff/zstd/tests/cli-tests/basic/help.sh

@@ -1,10 +0,0 @@
-#!/bin/sh
-
-set -e
-
-println "+ zstd -h"
-zstd -h
-println "+ zstd -H"
-zstd -H
-println "+ zstd --help"
-zstd --help

package/src/bsdiff/zstd/tests/cli-tests/basic/help.sh.stdout.glob

@@ -1,34 +0,0 @@
-+ zstd -h
-Compress or decompress the INPUT file(s); reads from STDIN if INPUT is `-` or not provided.
-
-Usage: zstd *OPTIONS...* *INPUT... | -* *-o OUTPUT*
-
-Options:
-  -o OUTPUT                     Write output to a single file, OUTPUT.
-  -k, --keep                    Preserve INPUT file(s). *Default*
-  --rm                          Remove INPUT file(s) after successful (de)compression.
-
-  -#                            Desired compression level, where `#` is a number between 1 and 19;
-                                lower numbers provide faster compression, higher numbers yield
-                                better compression ratios. *Default: 3*
-
-  -d, --decompress              Perform decompression.
-  -D DICT                       Use DICT as the dictionary for compression or decompression.
-
-  -f, --force                   Disable input and output checks. Allows overwriting existing files,
-                                receiving input from the console, printing output to STDOUT, and
-                                operating on links, block devices, etc. Unrecognized formats will be
-                                passed-through through as-is.
-
-  -h                            Display short usage and exit.
-  -H, --help                    Display full help and exit.
-  -V, --version                 Display the program version and exit.
-
-+ zstd -H
-...
-Advanced options:
-...
-+ zstd --help
-...
-Advanced options:
-...

package/src/bsdiff/zstd/tests/cli-tests/basic/memlimit.sh

@@ -1,40 +0,0 @@
-#!/bin/sh
-
-echo "some data" > file
-
-println "+ zstd --memory=32LB file"
-zstd --memory=32LB file && die "Should not allow bogus suffix"
-println "+ zstd --memory=32LiB file"
-zstd --memory=32LiB file && die "Should not allow bogus suffix"
-println "+ zstd --memory=32A file"
-zstd --memory=32A file && die "Should not allow bogus suffix"
-println "+ zstd --memory=32r82347dn83 file"
-zstd --memory=32r82347dn83 file && die "Should not allow bogus suffix"
-println "+ zstd --memory=32asbdf file"
-zstd --memory=32asbdf file && die "Should not allow bogus suffix"
-println "+ zstd --memory=hello file"
-zstd --memory=hello file && die "Should not allow non-numeric parameter"
-println "+ zstd --memory=1 file"
-zstd -q --memory=1 file && die "Should allow numeric parameter without suffix"
-rm file.zst
-println "+ zstd --memory=1K file"
-zstd -q --memory=1K file && die "Should allow numeric parameter with expected suffix"
-rm file.zst
-println "+ zstd --memory=1KB file"
-zstd -q --memory=1KB file && die "Should allow numeric parameter with expected suffix"
-rm file.zst
-println "+ zstd --memory=1KiB file"
-zstd -q --memory=1KiB file && die "Should allow numeric parameter with expected suffix"
-rm file.zst
-println "+ zstd --memory=1M file"
-zstd -q --memory=1M file && die "Should allow numeric parameter with expected suffix"
-rm file.zst
-println "+ zstd --memory=1MB file"
-zstd -q --memory=1MB file && die "Should allow numeric parameter with expected suffix"
-rm file.zst
-println "+ zstd --memory=1MiB file"
-zstd -q --memory=1MiB file && die "Should allow numeric parameter with expected suffix"
-rm file.zst
-
-rm file
-exit 0

package/src/bsdiff/zstd/tests/cli-tests/basic/memlimit.sh.stderr.exact

@@ -1,13 +0,0 @@
-error: only numeric values with optional suffixes K, KB, KiB, M, MB, MiB are allowed 
-error: only numeric values with optional suffixes K, KB, KiB, M, MB, MiB are allowed 
-error: only numeric values with optional suffixes K, KB, KiB, M, MB, MiB are allowed 
-error: only numeric values with optional suffixes K, KB, KiB, M, MB, MiB are allowed 
-error: only numeric values with optional suffixes K, KB, KiB, M, MB, MiB are allowed 
-error: only numeric values with optional suffixes K, KB, KiB, M, MB, MiB are allowed 
-Should allow numeric parameter without suffix
-Should allow numeric parameter with expected suffix
-Should allow numeric parameter with expected suffix
-Should allow numeric parameter with expected suffix
-Should allow numeric parameter with expected suffix
-Should allow numeric parameter with expected suffix
-Should allow numeric parameter with expected suffix

package/src/bsdiff/zstd/tests/cli-tests/basic/memlimit.sh.stdout.exact

@@ -1,13 +0,0 @@
-+ zstd --memory=32LB file
-+ zstd --memory=32LiB file
-+ zstd --memory=32A file
-+ zstd --memory=32r82347dn83 file
-+ zstd --memory=32asbdf file
-+ zstd --memory=hello file
-+ zstd --memory=1 file
-+ zstd --memory=1K file
-+ zstd --memory=1KB file
-+ zstd --memory=1KiB file
-+ zstd --memory=1M file
-+ zstd --memory=1MB file
-+ zstd --memory=1MiB file

package/src/bsdiff/zstd/tests/cli-tests/basic/output_dir.sh

@@ -1,7 +0,0 @@
-#!/bin/sh
-
-println "+ zstd -r * --output-dir-mirror=\"\""
-zstd -r * --output-dir-mirror="" && die "Should not allow empty output dir!"
-println "+ zstd -r * --output-dir-flat=\"\""
-zstd -r * --output-dir-flat="" && die "Should not allow empty output dir!"
-exit 0

package/src/bsdiff/zstd/tests/cli-tests/basic/output_dir.sh.stderr.exact

@@ -1,2 +0,0 @@
-error: output dir cannot be empty string (did you mean to pass '.' instead?)
-error: output dir cannot be empty string (did you mean to pass '.' instead?)

package/src/bsdiff/zstd/tests/cli-tests/basic/output_dir.sh.stdout.exact

@@ -1,2 +0,0 @@
-+ zstd -r * --output-dir-mirror=""
-+ zstd -r * --output-dir-flat=""

package/src/bsdiff/zstd/tests/cli-tests/basic/version.sh

@@ -1,6 +0,0 @@
-#!/bin/sh
-
-set -e
-
-zstd -V
-zstd --version

package/src/bsdiff/zstd/tests/cli-tests/basic/version.sh.stdout.glob

@@ -1,2 +0,0 @@
-*** Zstandard CLI (*-bit) v1.*.*, by Yann Collet ***
-*** Zstandard CLI (*-bit) v1.*.*, by Yann Collet ***

package/src/bsdiff/zstd/tests/cli-tests/bin/cmp_size

@@ -1,44 +0,0 @@
-#!/bin/sh
-
-set -e
-
-usage()
-{
-	printf "USAGE:\n\t$0 [-eq|-ne|-lt|-le|-gt|-ge] FILE1 FILE2\n"
-}
-
-help()
-{
-	printf "Small utility to compare file sizes without printing them with set -x.\n\n"
-	usage
-}
-
-case "$1" in
-	-h) help; exit 0  ;;
-	--help) help; exit 0 ;;
-esac
-
-if ! test -f $2; then
-	printf "FILE1='%b' is not a file\n\n" "$2"
-	usage
-	exit 1
-fi
-
-if ! test -f $3; then
-	printf "FILE2='%b' is not a file\n\n" "$3"
-	usage
-	exit 1
-fi
-
-
-size1=$(wc -c < $2)
-size2=$(wc -c < $3)
-
-case "$1" in
-	-eq) [ "$size1" -eq "$size2" ] ;;
-	-ne) [ "$size1" -ne "$size2" ] ;;
-	-lt) [ "$size1" -lt "$size2" ] ;;
-	-le) [ "$size1" -le "$size2" ] ;;
-	-gt) [ "$size1" -gt "$size2" ] ;;
-	-ge) [ "$size1" -ge "$size2" ] ;;
-esac

package/src/bsdiff/zstd/tests/cli-tests/bin/datagen

@@ -1,3 +0,0 @@
-#!/bin/sh
-
-"$DATAGEN_BIN" $@

package/src/bsdiff/zstd/tests/cli-tests/bin/die

@@ -1,4 +0,0 @@
-#!/bin/sh
-
-println "${*}" 1>&2
-exit 1

package/src/bsdiff/zstd/tests/cli-tests/bin/println

@@ -1,2 +0,0 @@
-#!/bin/sh
-printf '%b\n' "${*}"

package/src/bsdiff/zstd/tests/cli-tests/bin/zstd

@@ -1,9 +0,0 @@
-#!/bin/sh
-
-zstdname=$(basename $0)
-
-if [ -z "$EXEC_PREFIX" ]; then
-    "$ZSTD_SYMLINK_DIR/$zstdname" $@
-else
-    $EXEC_PREFIX "$ZSTD_SYMLINK_DIR/$zstdname" $@
-fi

package/src/bsdiff/zstd/tests/cli-tests/bin/zstdgrep

@@ -1,2 +0,0 @@
-#!/bin/sh
-"$ZSTDGREP_BIN" $@

package/src/bsdiff/zstd/tests/cli-tests/bin/zstdless

@@ -1,2 +0,0 @@
-#!/bin/sh
-"$ZSTDLESS_BIN" $@

package/src/bsdiff/zstd/tests/cli-tests/cltools/setup

@@ -1,6 +0,0 @@
-#!/bin/sh
-
-set -e
-
-echo "1234" > file
-zstd file

package/src/bsdiff/zstd/tests/cli-tests/cltools/zstdgrep.sh

@@ -1,8 +0,0 @@
-#!/bin/sh
-
-set -e
-
-println "+ good path"
-zstdgrep "1234" file file.zst
-println "+ bad path"
-zstdgrep "1234" bad.zst

package/src/bsdiff/zstd/tests/cli-tests/cltools/zstdgrep.sh.exit

@@ -1 +0,0 @@
-1

package/src/bsdiff/zstd/tests/cli-tests/cltools/zstdgrep.sh.stderr.exact

@@ -1 +0,0 @@
-zstd: can't stat bad.zst : No such file or directory -- ignored 

package/src/bsdiff/zstd/tests/cli-tests/cltools/zstdgrep.sh.stdout.glob

@@ -1,4 +0,0 @@
-+ good path
-file:1234
-file.zst:1234
-+ bad path

package/src/bsdiff/zstd/tests/cli-tests/cltools/zstdless.sh

@@ -1,10 +0,0 @@
-#!/bin/sh
-
-set -e
-
-println "+ good path"
-zstdless file.zst
-println "+ pass parameters"
-zstdless -N file.zst # This parameter does not produce line #s when piped, but still serves to test that the flag went to less and not zstd
-println "+ bad path"
-zstdless bad.zst >&2

package/src/bsdiff/zstd/tests/cli-tests/cltools/zstdless.sh.stderr.exact

@@ -1,2 +0,0 @@
-zstd: can't stat bad.zst : No such file or directory -- ignored 
-bad.zst: No such file or directory

package/src/bsdiff/zstd/tests/cli-tests/cltools/zstdless.sh.stdout.glob

@@ -1,5 +0,0 @@
-+ good path
-1234
-+ pass parameters
-1234
-+ bad path

package/src/bsdiff/zstd/tests/cli-tests/common/format.sh

@@ -1,19 +0,0 @@
-#!/bin/sh
-
-. "$COMMON/platform.sh"
-
-zstd_supports_format()
-{
-	zstd -h | grep > $INTOVOID -- "--format=$1"
-}
-
-format_extension()
-{
-	if [ "$1" = "zstd" ]; then
-		printf "zst"
-	elif [ "$1" = "gzip" ]; then
-		printf "gz"
-	else
-		printf "$1"
-	fi
-}

package/src/bsdiff/zstd/tests/cli-tests/common/mtime.sh

@@ -1,13 +0,0 @@
-. "$COMMON/platform.sh"
-
-MTIME="stat -c %Y"
-case "$UNAME" in
-    Darwin | FreeBSD | OpenBSD | NetBSD) MTIME="stat -f %m" ;;
-esac
-
-assertSameMTime() {
-    MT1=$($MTIME "$1")
-    MT2=$($MTIME "$2")
-    echo MTIME $MT1 $MT2
-    [ "$MT1" = "$MT2" ] || die "mtime on $1 doesn't match mtime on $2 ($MT1 != $MT2)"
-}

package/src/bsdiff/zstd/tests/cli-tests/common/permissions.sh

@@ -1,18 +0,0 @@
-. "$COMMON/platform.sh"
-
-GET_PERMS="stat -c %a"
-case "$UNAME" in
-    Darwin | FreeBSD | OpenBSD | NetBSD) GET_PERMS="stat -f %Lp" ;;
-esac
-
-assertFilePermissions() {
-    STAT1=$($GET_PERMS "$1")
-    STAT2=$2
-    [ "$STAT1" = "$STAT2" ] || die "permissions on $1 don't match expected ($STAT1 != $STAT2)"
-}
-
-assertSamePermissions() {
-    STAT1=$($GET_PERMS "$1")
-    STAT2=$($GET_PERMS "$2")
-    [ "$STAT1" = "$STAT2" ] || die "permissions on $1 don't match those on $2 ($STAT1 != $STAT2)"
-}

package/src/bsdiff/zstd/tests/cli-tests/common/platform.sh

@@ -1,37 +0,0 @@
-#!/bin/sh
-
-UNAME=$(uname)
-
-isWindows=false
-INTOVOID="/dev/null"
-case "$UNAME" in
-  GNU) DEVDEVICE="/dev/random" ;;
-  *) DEVDEVICE="/dev/zero" ;;
-esac
-case "$OS" in
-  Windows*)
-    isWindows=true
-    INTOVOID="NUL"
-    DEVDEVICE="NUL"
-    ;;
-esac
-
-case "$UNAME" in
-  Darwin) MD5SUM="md5 -r" ;;
-  FreeBSD) MD5SUM="gmd5sum" ;;
-  NetBSD) MD5SUM="md5 -n" ;;
-  OpenBSD) MD5SUM="md5" ;;
-  *) MD5SUM="md5sum" ;;
-esac
-
-DIFF="diff"
-case "$UNAME" in
-  SunOS) DIFF="gdiff" ;;
-esac
-
-if echo hello | zstd -v -T2 2>&1 > $INTOVOID | grep -q 'multi-threading is disabled'
-then
-    hasMT=""
-else
-    hasMT="true"
-fi