IMP.test.ApplicationTestCase Class Reference

Super class for simple IMP application test cases. More...

Inheritance diagram for IMP.test.ApplicationTestCase:

Detailed Description

Super class for simple IMP application test cases.

Note

This class is only available in Python.

Definition at line 987 of file test/__init__.py.

Public Member Functions
def	assertApplicationExitedCleanly
	Assert that the application exited cleanly (return value = 0). More...
def	import_python_application
	Import an installed Python application, rather than running it. More...
def	read_shell_commands
	Read and return a set of shell commands from a doxygen file. More...
def	run_application
	Run an application with the given list of arguments. More...
def	run_python_application
	Run a Python application with the given list of arguments. More...
def	run_script
	Run an application with the given list of arguments. More...
def	run_shell_command
	Print and run a shell command, as returned by read_shell_commands() More...
Public Member Functions inherited from IMP.test.TestCase
def	assertClassNames
	Check that all the classes in the module follow the imp naming conventions. More...
def	assertFunctionNames
	Check that all the functions in the module follow the IMP naming conventions. More...
def	assertShow
	Check that all the classes in modulename have a show method. More...
def	assertValueObjects
	Check that all the C++ classes in the module are values or objects. More...
def	assertXYZDerivativesInTolerance
	Assert that x,y,z analytical derivatives match numerical within a tolerance, or a percentage (of the analytical value), whichever is larger. More...
def	check_runnable_python_module
	Check a Python module designed to be runnable with 'python -m' to make sure it supports standard command line options. More...
def	check_unary_function_deriv
	Check the unary function func's derivatives against numerical approximations between lb and ub. More...
def	check_unary_function_min
	Make sure that the minimum of the unary function func over the range between lb and ub is at expected_fmin. More...
def	create_particles_in_box
	Create a bunch of particles in a box. More...
def	create_point_particle
	Make a particle with optimizable x, y and z attributes, and add it to the model. More...
def	failure_probability
	Estimate how likely a given block of code is to raise an AssertionError. More...
def	get_input_file_name
	Get the full name of an input file in the top-level test directory. More...
def	get_tmp_file_name
	Get the full name of an output file in the tmp directory. More...
def	open_input_file
	Open and return an input file in the top-level test directory. More...
def	particle_distance
	Return distance between two given particles. More...
def	probabilistic_test
	Help handle a test which is expected to fail some fraction of the time. More...
def	randomize_particles
	Randomize the xyz coordinates of a list of particles. More...
def	run_example
	Run the named example script. More...
def	run_python_module
	Run a Python module as if with "python -m <modname>", with the given list of arguments as sys.argv. More...

Member Function Documentation

def IMP.test.ApplicationTestCase.assertApplicationExitedCleanly	(		self,
			ret,
			error
	)

Assert that the application exited cleanly (return value = 0).

Definition at line 1041 of file test/__init__.py.

def IMP.test.ApplicationTestCase.import_python_application	(		self,
			app
	)

Import an installed Python application, rather than running it.

This is useful to directly test components of the application.

Returns

the Python module object.

Definition at line 1026 of file test/__init__.py.

def IMP.test.ApplicationTestCase.read_shell_commands	(		self,
			doxfile
	)

Read and return a set of shell commands from a doxygen file.

Each command is assumed to be in a

...

block. The doxygen file is specified relative to the test file itself. This is used to make sure the commands shown in an application example actually work (the testcase can also check the resulting files for correctness).

Definition at line 1051 of file test/__init__.py.

def IMP.test.ApplicationTestCase.run_application	(		self,
			app,
			args
	)

Run an application with the given list of arguments.

Returns

a subprocess.Popen-like object containing the child stdin, stdout and stderr.

Definition at line 999 of file test/__init__.py.

def IMP.test.ApplicationTestCase.run_python_application	(		self,
			app,
			args
	)

Run a Python application with the given list of arguments.

The Python application should be self-runnable (i.e. it should be executable and with a #! on the first line).

Returns

a subprocess.Popen-like object containing the child stdin, stdout and stderr.

Definition at line 1012 of file test/__init__.py.

def IMP.test.ApplicationTestCase.run_script	(		self,
			app,
			args
	)

Run an application with the given list of arguments.

Returns

a subprocess.Popen-like object containing the child stdin, stdout and stderr.

Definition at line 1034 of file test/__init__.py.

def IMP.test.ApplicationTestCase.run_shell_command	(		self,
			cmd
	)

Print and run a shell command, as returned by read_shell_commands()

Definition at line 1087 of file test/__init__.py.

---

The documentation for this class was generated from the following file:

• test/__init__.py