cis_interface.examples.tests package

Submodules

cis_interface.examples.tests.test_SaM module

class cis_interface.examples.tests.test_SaM.TestExampleSaM(*args, **kwargs)[source]

Bases: cis_interface.examples.tests.TestExample

Test the SaM example.

example_name = 'SaM'
output_files

Output files for the run.

Type:list
results

Results that should be found in the output files.

Type:list

cis_interface.examples.tests.test_ascii_io module

class cis_interface.examples.tests.test_ascii_io.TestExampleAsciiIO(*args, **kwargs)[source]

Bases: cis_interface.examples.tests.TestExample

Test the AsciiIO example.

check_table(fname, iAT)[source]

Assert that contents of input/output ascii tables are identical.

example_name = 'ascii_io'
input_array

Input array file.

Type:str
input_file

Input file.

Type:str
input_table

Input table file.

Type:str
output_array

Output array for the run.

Type:str
output_file

Output file for the run.

Type:str
output_files

Output files for the run.

Type:list
output_table

Output table for the run.

Type:str
results

Results that should be found in the output files.

Type:list

cis_interface.examples.tests.test_fakeplant module

class cis_interface.examples.tests.test_fakeplant.TestExampleFakeplant(*args, **kwargs)[source]

Bases: cis_interface.examples.tests.TestExample

Test the Fakeplant example.

check_results()[source]

This should be overridden with checks for the result.

example_name = 'fakeplant'
output_dir

Output directory.

Type:str
output_files

Output files for the run.

Type:list
run_example()[source]

This runs an example in the correct language.

cis_interface.examples.tests.test_formatted_io1 module

class cis_interface.examples.tests.test_formatted_io1.TestExampleFIO1(*args, **kwargs)[source]

Bases: cis_interface.examples.tests.TestExample

Test the Formatted I/O lesson 1 example.

example_name = 'formatted_io1'
input_files

Input file.

output_files

Output file.

cis_interface.examples.tests.test_formatted_io2 module

class cis_interface.examples.tests.test_formatted_io2.TestExampleFIO2(*args, **kwargs)[source]

Bases: cis_interface.examples.tests.TestExample

Test the Formatted I/O lesson 2 example.

example_name = 'formatted_io2'
input_files

Input file.

output_files

Output file.

cis_interface.examples.tests.test_formatted_io3 module

class cis_interface.examples.tests.test_formatted_io3.TestExampleFIO3(*args, **kwargs)[source]

Bases: cis_interface.examples.tests.TestExample

Test the Formatted I/O lesson 3 example.

example_name = 'formatted_io3'
input_files

Input file.

output_files

Output file.

cis_interface.examples.tests.test_formatted_io4 module

class cis_interface.examples.tests.test_formatted_io4.TestExampleFIO4(*args, **kwargs)[source]

Bases: cis_interface.examples.tests.TestExample

Test the Formatted I/O lesson 4 example.

example_name = 'formatted_io4'
input_files

Input file.

output_files

Output file.

cis_interface.examples.tests.test_formatted_io5 module

class cis_interface.examples.tests.test_formatted_io5.TestExampleFIO5(*args, **kwargs)[source]

Bases: cis_interface.examples.tests.TestExample

Test the Formatted I/O lesson 5 example.

example_name = 'formatted_io5'
input_files

Input file.

output_files

Output file.

cis_interface.examples.tests.test_formatted_io6 module

class cis_interface.examples.tests.test_formatted_io6.TestExampleFIO6(*args, **kwargs)[source]

Bases: cis_interface.examples.tests.TestExample

Test the Formatted I/O lesson 6 example.

example_name = 'formatted_io6'
input_files

Input file.

output_files

Output file.

cis_interface.examples.tests.test_formatted_io7 module

class cis_interface.examples.tests.test_formatted_io7.TestExampleFIO7(*args, **kwargs)[source]

Bases: cis_interface.examples.tests.TestExample

Test the Formatted I/O lesson 7 example.

example_name = 'formatted_io7'
input_files

Input file.

output_files

Output file.

cis_interface.examples.tests.test_formatted_io8 module

class cis_interface.examples.tests.test_formatted_io8.TestExampleFIO8(*args, **kwargs)[source]

Bases: cis_interface.examples.tests.TestExample

Test the Formatted I/O lesson 8 example.

example_name = 'formatted_io8'
input_files

Input file.

output_files

Output file.

cis_interface.examples.tests.test_formatted_io9 module

class cis_interface.examples.tests.test_formatted_io9.TestExampleFIO9(*args, **kwargs)[source]

Bases: cis_interface.examples.tests.TestExample

Test the Formatted I/O lesson 9 example.

example_name = 'formatted_io9'
input_files

Input file.

output_files

Output file.

cis_interface.examples.tests.test_gs_lesson1 module

class cis_interface.examples.tests.test_gs_lesson1.TestExampleGS1(*args, **kwargs)[source]

Bases: cis_interface.examples.tests.TestExample

Test the Getting Started Lesson 1 example.

example_name = 'gs_lesson1'

cis_interface.examples.tests.test_gs_lesson2 module

class cis_interface.examples.tests.test_gs_lesson2.TestExampleGS2(*args, **kwargs)[source]

Bases: cis_interface.examples.tests.TestExample

Test the Getting Started Lesson 2 example.

example_name = 'gs_lesson2'

cis_interface.examples.tests.test_gs_lesson3 module

class cis_interface.examples.tests.test_gs_lesson3.TestExampleGS3(*args, **kwargs)[source]

Bases: cis_interface.examples.tests.TestExample

Test the Getting Started Lesson 3 example.

example_name = 'gs_lesson3'
input_files

Input file.

output_files

Output file.

cis_interface.examples.tests.test_gs_lesson4 module

class cis_interface.examples.tests.test_gs_lesson4.TestExampleGS4(*args, **kwargs)[source]

Bases: cis_interface.examples.tests.TestExample

Test the Getting Started Lesson 4 example.

example_name = 'gs_lesson4'
input_files

Input file.

output_files

Output file.

cis_interface.examples.tests.test_gs_lesson4b module

class cis_interface.examples.tests.test_gs_lesson4b.TestExampleGS4b(*args, **kwargs)[source]

Bases: cis_interface.examples.tests.TestExample

Test the Getting Started Lesson 4b example.

example_name = 'gs_lesson4b'
input_files

Input file.

output_files

Output file.

cis_interface.examples.tests.test_hello module

class cis_interface.examples.tests.test_hello.TestExampleHello(*args, **kwargs)[source]

Bases: cis_interface.examples.tests.TestExample

Test the Hello example.

example_name = 'hello'
input_files

Input file.

output_files

Output file.

cis_interface.examples.tests.test_maxMsg module

class cis_interface.examples.tests.test_maxMsg.TestExampleMaxMsg(*args, **kwargs)[source]

Bases: cis_interface.examples.tests.TestExample

Test the MaxMsg example.

example_name = 'maxMsg'

cis_interface.examples.tests.test_model_error module

class cis_interface.examples.tests.test_model_error.TestExampleModelError(*args, **kwargs)[source]

Bases: cis_interface.examples.tests.TestExample

Test the model_error example.

cleanup()[source]

Cleanup files created during the test.

core_dump

Pattern for core dump that may be produced.

Type:str
example_name = 'model_error'
expects_error = True

cis_interface.examples.tests.test_root_to_shoot module

class cis_interface.examples.tests.test_root_to_shoot.TestExampleRootToShoot(*args, **kwargs)[source]

Bases: cis_interface.examples.tests.TestExample

Test the Root to Shoot example.

check_results()[source]

This should be overridden with checks for the result.

example_name = 'root_to_shoot'
output_dir

Output directory.

Type:str
output_files

Output files for the run.

Type:list
run_example()[source]

This runs an example in the correct language.

cis_interface.examples.tests.test_rpcFib module

class cis_interface.examples.tests.test_rpcFib.TestExampleRpcFib(*args, **kwargs)[source]

Bases: cis_interface.examples.tests.TestExample

Test the rpcFib example.

env = {'FIB_ITERATIONS': '3', 'FIB_SERVER_SLEEP_SECONDS': '0.01'}
example_name = 'rpcFib'
output_files

Output file.

results

Result that should be found in output files.

cis_interface.examples.tests.test_rpc_lesson1 module

class cis_interface.examples.tests.test_rpc_lesson1.TestExampleRPC1(*args, **kwargs)[source]

Bases: cis_interface.examples.tests.TestExample

Test the rpc_lesson1 example.

example_name = 'rpc_lesson1'
niter = 3
output_files

Output file.

results

Result that should be found in output files.

cis_interface.examples.tests.test_rpc_lesson2 module

class cis_interface.examples.tests.test_rpc_lesson2.TestExampleRPC2(*args, **kwargs)[source]

Bases: cis_interface.examples.tests.TestExample

Test the rpc_lesson2 example.

example_name = 'rpc_lesson2'
niter1 = 3
niter2 = 5
output_files

Output file.

results

Result that should be found in output files.

cis_interface.examples.tests.test_timed_pipe module

class cis_interface.examples.tests.test_timed_pipe.ExampleTimedPipeTestBase(*args, **kwargs)[source]

Bases: cis_interface.examples.tests.TestExample

Base class for testing TimedPipe example with various comm types.

description_prefix

Prefix message with test name.

env = {'PIPE_MSG_COUNT': '10', 'PIPE_MSG_SIZE': '1024'}
example_name = 'timed_pipe'
output_files

Output file.

results

Result that should be found in output files.

run_example()[source]

This runs an example in the correct language.

class cis_interface.examples.tests.test_timed_pipe.TestExampleTimedPipeIPCComm(*args, **kwargs)

Bases: cis_interface.examples.tests.test_timed_pipe.ExampleTimedPipeTestBase

Module contents

class cis_interface.examples.tests.TestExample(*args, **kwargs)[source]

Bases: cis_interface.tests.CisTestBase, cis_interface.tools.CisClass

Base class for running examples.

check_results()[source]

This should be overridden with checks for the result.

cleanup()[source]

Cleanup files created during the test.

description_prefix

Prefix message with test name.

env = {}
example_name = None
expects_error = False
input_files

list Input files for the run.

namespace

Namespace for the example.

Type:str
output_files

Output files for the run.

Type:list
results

Results that should be found in the output files.

Type:list
run_example()[source]

This runs an example in the correct language.

tempdir

Temporary directory.

Type:str
test_all()[source]

Test the version of the example that uses all languages.

test_c()[source]

Test the C version of the example.

test_cpp()[source]

Test the C++ version of the example.

test_matlab()[source]

Test the Matlab version of the example.

test_python()[source]

Test the Python version of the example.

yaml

The full path to the yaml file for this example.

Type:str
yamldir

Full path to the directory containing the yaml file.

Type:str