yubowenok / testgen

Test generator for algorithm problems

Test generator for algorithm problems

Getting Started

Download (clone) the testgen package. Make sure it is in sys.path. The create_problem.sh script inside testgen may help you get started quickly. Use

./create_problem.sh {problem_id}

to initialize a problem with given id using the default template. The script will initialize the files mentioned in the tutorial below, and you can just fill in their content.

Test Generator Tutorial

Here we show how to create test cases for a simple problem "A + B" that asks for the sum of two integers.

./create_problem.sh aplusb

This creates a directory for the problem, i.e. aplusb. We will be under aplusb/ in all the following steps.

Inside the folder input_manual, we can place all the manually created test cases. Each file inside this folder may contain an arbitrary number of test cases, separated by a line with 20 equal signs, e.g.:

3 5
==================== case 3+5 (you can put any comments here)
4 7
==================== name:Sample-2 (you may specifically name the test file)
1 -1

The test generator python script gen.py create create a Problem instance prob, and call prob.manualCases('input_manual') to create one case for each test case you specify in the input_manual folder.

Here is a snippet of what happens in gen.py.

import sys

# add testgen to system path, or include the path here
sys.path.append('../..')

from testgen import Problem
import funcs

# create a new problem instance with given id
prob = Problem('aplusb')

# copy from the manual cases in input_manual
prob.manualCases('input_manual')

# parse the test generator rules defined in the file "aplusb.rules",
# and generate tests via program using the rules
prob.programCases('aplusb.rules', funcs)

To create programmatic cases, you need to write some functions in funcs.py. Each function in funcs.py defines one way to generate a group of tests, like:

import random

random.seed('aplusb')

def xMinusOne(args):
  x = args['x']
  return str(x) + " -1\n"
  
def twoRandomIntegers(args):
  l, r = int(args['l']), int(args['r'])
  a, b = random.randint(l,r), random.randint(l,r)
  return str(a) + " " + str(b) + "\n"

We write a generator rule file to tell testgen how to call those functions. Fill in the generator rule file aplusb.rules. Rules file has a simple syntax as follows:

group = MinusOne
  func = xMinusOne
  num = 2
  param
    x = 3
    x = 5
end

group = TwoRandom
  func = twoRandomIntegers
  num = 5
  param
    l = 1, r = 5
    l = 10, r = 20
    ...
end

Each group has a group name ("MinusOne" and "TwoRandom"). It tells the generator to call the method func for this group of cases. func shall be called num times, with the parameters specified by param. Each param line defines one set of parameter assignments separated by commas. Three dots "..." may be used to repeat the last set of parameter assignments for the remaining test cases in this group. In the above example, the last 4 cases for group "TwoRandom" all use parameters "l = 10, r = 20".

Note that rule files are space insensitive. All spaces are ignored when a rule file gets parsed.

Lastly, we need to create a solution. Let's write a solver for the problem, say sol.cpp. Source code will be compiled based on suffix file types. *.cpp, *.java and *.py files are supported. The solver will be used to generate the judge's output files.

Finally we can run the test generator:

python gen.py

This shall create a folder named input and put all cases there, one case per file. The files are named 000.in, 001.in, and so on. If there is a name set for a test case, it will be appended to the file name, e.g. 001-sample-1.in. Group names are automatically appended with its own counter, e.g. 008-MinusOne-1.in.

The corresponding answer files can be found in the output folder, such as 001-sample-1.ans, 008-MinusOne-1.ans, and so on.

Internally, the gen.py script calls the test_runner.sh script to generate those answer files, you can also manually invoke this shell script to generate outputs, or to test a solution:

./test_runner.sh {run|test} sol.cpp

If you are testing a solution, the solution's answers will be written to answer/*.

To generate cases in a specific order, possibly with alternating manual and program generated cases, can be achieved by modifying gen.py. This is particularly useful when the problem has multiple groups of inputs (subtasks), so that the tests need to be combined with specific ordering.

# small cases
prob.manualCases('input_manual_small')
prob.programCases('aplusb_small.rules', funcs)
# large cases
prob.manualCases('input_manual_large')
prob.programCases('aplusb_large.rules', funcs)

Test Packer (Optional)

Typically, each test file has exactly one test case, and you do not need to use the test packer. However for some judging environment you must have one test file containing multiple test cases. In this case, you can use the procedure described above to generate one-test-per-file test cases, and finally use the test packer to combine them into a smaller number of files.

Each new case file will include multiple cases, prepending the number of cases at its beginning. You need to write a group specification file (aplusb.groups) with the following format

n1 # number of cases in the 1st file
n2 # number of cases in the 2nd file
n3 # name:program number of cases in the 3rd file
...

Then in gen.py, add a call to test packer.

prob.packCases('aplusb.groups')

The first n1 cases (numbered by 001.in, 002.in ...) will be written to the 1st input file (001.in), the next n2 cases will be written to the 2nd input file (002.in), and so on. If you name group in the groups file, the group name will also be added to the file name (such as 003-program.in in the example groups file).

Please make sure that the input folder contains sufficient number of cases. If there are unused cases in the input folder, they will be deleted.

Test packer will give incorrect order if the number of cases exceed 999, as it sorts the input filenames lexicographically, e.g. 1000.in appears before 999.in. It is not recommended to create more than 1000 cases. If you have a problem that has a large number of cases, consider them to be multiple queries in one single case.