skip to navigation
skip to content

exactly 0.8.6.1

Tests a command line program by executing it in a temporary sandbox directory and inspecting its result.

Package Documentation

Tests a command line program by executing it in a temporary sandbox directory and inspecting its result.

Or tests properties of existing files, directories etc.

Supports individual test cases and test suites.

Exactly has a Wiki, and an introduction by examples.

It also has a built in help system, which can, among other things, generate this Reference manual.

TEST CASES

A test case is written as a plain text file.

Testing stdin, stdout, stderr, exit code

The following checks that your new my-contacts-program reads a contact list from stdin, and is able to find the email of a person:

[setup]

stdin --file some-test-contacts.txt

[act]

my-contacts-program get-email-of --name 'Pablo Gauss'

[assert]

exitcode = 0

stdout equals <<EOF
pablo@gauss.org
EOF

stderr empty

If the file ‘contacts.case’ contains this test case, then Exactly can execute it:

> exactly contacts.case
PASS

“PASS” means that all assertions were satisfied.

This test assumes that

  • the system under test - my-contacts-program - is is found in the same directory as the test case file
  • the file “some-test-contacts.txt” (that is referenced from the test case) is found in the same directory as the test case file

The home and act-home instructions can be used to change the directories where Exactly looks for files referenced from the test case.

Testing side effects on files and directories

A test case is executed in a temporary sandbox directory, so files and directories can be created and deleted without modifying a source code repo.

The following tests a program that classifies files as either good or bad, by moving them to the appropriate output directory:

[setup]

dir input-files
dir output-files/good
dir output-files/bad

file input-files/a.txt <<EOF
GOOD contents
EOF

file input-files/b.txt <<EOF
bad contents
EOF

[act]

classify-files-by-moving-to-appropriate-dir GOOD .

[assert]

dir-contents input-files empty

exists --file output-files/good/a.txt
dir-contents  output-files/good num-files = 1

exists --file output-files/bad/b.txt
dir-contents  output-files/bad num-files = 1

Testing and transforming the contents of files

The contents instruction tests the contents of a file. It can also test a transformed version of a file, by applying a “file transformer”.

Such a “file transformer” may be given a name using the def instruction to make the test easier to read.

The following test case tests that “timing lines” are output as part of a log file “log.txt”.

The challenge is that the (fictive) log file contains non-timing lines that we are not interested in, and that timing lines contains a time stamp of the form “NN:NN”, whos exact value we are also not interested in.

A “file transformer” is used to extract all timing lines and to replace “NN:NN” time stamps with the constant string TIMESTAMP:

[act]

my-system-under-test-that-writes-log-file

[assert]

contents log.txt --transformed GET_TIMING_LINES equals <<EOF
timing TIMESTAMP begin
timing TIMESTAMP preprocessing
timing TIMESTAMP validation
timing TIMESTAMP execution
timing TIMESTAMP end
EOF

[setup]

def line-matcher     IS_TIMING_LINE     = regex ^timing

def file-transformer REPLACE_TIMESTAMPS = replace [0-9]{2}:[0-9]{2} TIMESTAMP

def file-transformer GET_TIMING_LINES   = select IS_TIMING_LINE | REPLACE_TIMESTAMPS

The --transformed option does not modify the tested file, it just applies the assertion to a transformed version of it.

Using shell commands

Shell commands can be used both in the “act” phase (the system under test), and in other phases, using “$”.

[setup]

$ touch file

[act]

$ echo ${PATH}

[assert]

$ tr ':' '\n' < ../result/stdout | grep '^/usr/local/bin$'

A shell command in the “assert” phase becomes an assertion that depends on the exit code of the command.

Testing source code files

The actor instruction can specify an interpreter to test a source code file:

[conf]

actor = --file python

[act]

my-python-program.py 'an argument'

[assert]

stdout equals <<EOF
Arguments: an argument
EOF

Experimenting with source code

The “source interpreter” actor treats the contents of the “act” phase as source code. It’s probably most useful as a tool for experimenting:

[conf]

actor = --source bash

[act]

var='hello world'
echo ${var:5}

[assert]

stdout equals <<EOF
world
EOF

or for running a source file in a sandbox:

> exactly --actor bash my-script.sh
PASS

This is more useful combined with --act (see below).

[act] is the default phase

[act] is not needed to indicate what is being checked, since the “act” phase is the default phase.

The following is a valid test case, and if run by Exactly, it won’t remove anything, since it is executed inside a temporary sandbox directory:

$ rm -rf *

Keeping the sandbox directory for later inspection

If --keep is used, the sandbox directory will not be deleted, and its name will be printed.

This can be used to inspect the outcome of the “setup” phase, e.g:

[setup]

dir  my-dir
file my-file.txt

[act]

my-prog my-file.txt

[assert]

exitcode = 0
> exactly --keep my-test.case
/tmp/exactly-1strbro1

> find /tmp/exactly-1strbro1
/tmp/exactly-1strbro1
/tmp/exactly-1strbro1/tmp
/tmp/exactly-1strbro1/tmp/user
/tmp/exactly-1strbro1/tmp/internal
/tmp/exactly-1strbro1/testcase
/tmp/exactly-1strbro1/act
/tmp/exactly-1strbro1/act/my-dir
/tmp/exactly-1strbro1/act/my-file.txt
/tmp/exactly-1strbro1/result
/tmp/exactly-1strbro1/result/exitcode
/tmp/exactly-1strbro1/result/stderr
/tmp/exactly-1strbro1/result/stdout
/tmp/exactly-1strbro1/log

The act/ directory is the current directory when the test starts. The file instruction has put the file my-file.txt there.

The result of the “act” phase is saved in the result/ directory.

tmp/user/ is a directory where the test can put temporary files.

TEST SUITES

Tests can be grouped in suites:

first.case
second.case

or:

[cases]

helloworld.case
*.case
**/*.case


[suites]

subsuite.suite
*.suite
pkg/suite.suite
**/*.suite

If the file my-suite.suite contains this text, then Exactly can run it:

> exactly suite my-suite.suite
...
OK

The result of a suite can also be reported as JUnit XML, by using --reporter junit.

HELP

Exactly has a built in help system.

Use exactly --help or exactly help to get brief help.

exactly help help displays a summary of help options.

exactly help instructions lists the instructions that are available in each “phase”.

exactly help htmldoc outputs all built in help as html, which serves as Exactly’s reference manual.

EXAMPLES

The examples/ directory of the source distribution contains examples.

A complex example

The following test case displays a potpurri of features. (Beware that this test case does not make sense! - it just displays some of Exactly’s features.)

[conf]


status = SKIP
# This will cause the test case to not be executed.


[setup]


install this-is-an-existing-file-in-same-dir-as-test-case.txt

dir first/second/third

file in/a/dir/file-name.txt <<EOF
contents of the file
EOF

dir root-dir-for-act-phase

cd root-dir-for-act-phase
# This will be current directory for the "act" phase.

stdin <<EOF
this will be stdin for the program in the "act" phase
EOF
# (It is also possible to have stdin redirected to an existing file.)

env MY_VAR = 'value of my environment variable'

env PATH = '${PATH}:/my-dir'

env unset VARIABLE_THAT_SHOULD_NOT_BE_SET

run my-prog--located-in-same-dir-as-test-case--that-does-some-more-setup 'with an argument'

run --python --interpret custom-setup.py 'with an argument'

run ( --python -c ) --source print('Setting up things...')


[act]


the-system-under-test


[before-assert]


cd ..
# Moves back to the original current directory.

$ sort root-dir-for-act-phase/output-from-sut.txt > sorted.txt


[assert]


exitcode != 0

stdout equals <<EOF
This is the expected output from the-system-under-test
EOF

stdout --transformed REPLACE_TEST_CASE_DIRS any line matches regex 'EXACTLY_ACT:[0-9]+'

stderr empty

contents a-file.txt empty

contents a-second-file.txt ! empty

contents another-file.txt --transformed REPLACE_TEST_CASE_DIRS equals --file expected-content.txt

contents file.txt any line matches regex 'my .* reg ex'

exists actual-file

exists --dir actual-file

cd this-dir-is-where-we-should-be-for-the-following-assertions

run my-prog--located-in-same-dir-as-test-case--that-does-some-assertions

run --python --interpret custom-assertion.py


cd --rel-result
# Changes to the directory where the result of the act phase is stored (exitcode, stdout, stderr)

$ sed '1,10d' stdout > modified-stdout.txt
contents modified-stdout.txt equals <<EOF
this should be the single line of modified-stdout.txt
EOF


[cleanup]


$ umount my-test-mount-point

run my-prog-that-removes-database 'my test database'

INSTALLING

Exactly is written in Python and does not require any external libraries.

Exactly requires Python >= 3.5 (not tested on earlier version of Python 3).

Use pip or pip3 to install:

> pip install exactly

or:

> pip3 install exactly

The program can also be run from a source distribution:

> python3 src/default-main-program-runner.py

DEVELOPMENT STATUS

Current version is fully functional, but syntax and semantics are experimental.

Comments are welcome!

THANKS

The Python IDE PyCharm from JetBrains has greatly helped the development of this software.

DEDICATION

Aron Karlén

Tommy Karlsson

Götabergsgatan 10, lägenhet 4

 
File Type Py Version Uploaded on Size
exactly-0.8.6.1-py3-none-any.whl (md5) Python Wheel py3 2017-12-04 553KB
exactly-0.8.6.1.tar.gz (md5) Source 2017-12-04 336KB