Package openmdao.test

This package contains classes and modules that are used to test openmdao.

cluster.py

Routines to support testing with cluster allocation.

openmdao.test.cluster.init_cluster(encrypted=True, clean_dir=True, allow_shell=False)

If not already done, initializes the ResourceAllocationManager and adds a cluster using encrypted or unencrypted communication. Returns the name of the configured cluster.

openmdao.test.cluster.local_ssh_available()

Return True if this user has an authorized key for this machine.

early_report.py

class openmdao.test.early_report.BroadcastStream(*streams)

Bases: object

Sends stream output to multiple streams.

close()

flush()

write(*arg)

writeln(*arg)

class openmdao.test.early_report.EarlyTestInfo

Bases: nose.plugins.base.Plugin

This plugin writes test info (failures, run time) to a file as the tests are running instead of waiting until the end to report anything. Run nose with the option --with-early to activate it.

addError(test, err, capt=None)

addFailure(test, err, capt=None, tb_info=None)

addSkip(test, *args, **kwargs)

addSuccess(test, capt=None)

configure(options, config)

Configures the plugin.

finalize(result)

formatErr(err)

options(parser, env)

Sets additional command line options.

report(stream)

Report the test failures.

setOutputStream(stream)

startContext(ctx)

startTest(test)

stopContext(ctx)

stopTest(test)

name = 'early'

score = 1001

class openmdao.test.early_report.TestInfo(test)

Bases: object

end()

execcomp.py

ExecComp is a simple component that lets you easily define mathematical expressions.

class openmdao.test.execcomp.ExecComp(exprs=(), sleep=0)

Bases: openmdao.main.component.Component

Given a list of assignment statements, this component creates input and output I/O traits at construction time. All variables appearing on the left-hand side of the assignments are outputs, and the rest are inputs. All variables are assumed to be of type Float.

exprs: list of strings

sleep: float

Time (in seconds) to sleep during execute.

execute()

ExecComp execute function

class openmdao.test.execcomp.ExecCompWithDerivatives(exprs=(), derivatives=(), sleep=0, dsleep=0)

Bases: openmdao.main.component.Component

Works as ExecComp, except derivatives can also be defined.

Given a list of assignment statements, this component creates input and output I/O traits at construction time. All variables appearing on the left-hand side of the assignments are outputs, and the rest are inputs. All variables are assumed to be of type Float.

execute()

ExecCompWithDerivatives execute function

list_deriv_vars()

Return the full Jacobian

provideJ()

Calculate the Jacobian using our derivative expressions.

nosetimer.py

This plugin provides test timings to identify which tests might be
taking the most time. From this information, it might be useful to couple
individual tests' nose's `--with-profile` option to profile problematic
tests.

This plugin is heavily influenced by nose's `xunit` plugin.

Add this command to the way you execute nose::

    --with-test-timer

After all tests are executed, they will be sorted in ascending order.

(c) 2011 - Mahmoud Abdelkader (http://github.com/mahmoudimus)

LICENSE:
            DO WHAT THE !#$% YOU WANT TO PUBLIC LICENSE
                    Version 2, December 2004

 Copyright (C) 2004 Sam Hocevar <sam@hocevar.net> (slightly modified)

 Everyone is permitted to copy and distribute verbatim or modified
 copies of this license document, and changing it is allowed as long
 as the name is changed.

            DO WHAT THE !#$% YOU WANT TO PUBLIC LICENSE
   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

  0. You just DO WHAT THE !#$% YOU WANT TO.

class openmdao.test.nosetimer.TestTimer

Bases: nose.plugins.base.Plugin

This plugin provides test timings.

addError(test, err, capt=None)

addFailure(test, err, capt=None, tb_info=None)

addSuccess(test, capt=None)

configure(options, config)

Configures the test timer plugin.

options(parser, env)

Sets additional command line options.

report(stream)

Report the test times.

startTest(test)

Initializes a timer before starting a test.

name = 'test-timer'

score = 1

rosen_suzuki.py

Model based on CONMIN test.

class openmdao.test.rosen_suzuki.NestedSimulation

Bases: openmdao.main.assembly.Assembly

configure()

class openmdao.test.rosen_suzuki.OptRosenSuzukiComponent

Bases: openmdao.main.component.Component

Array x

• default: ‘[]’
• iotype: ‘in’
• low: -10
• high: 99
• comparison_mode: 1
• vartypename: ‘Array’
• assumed_default: True

Float opt_objective

• default: ‘0.0’
• iotype: ‘out’
• vartypename: ‘Float’
• assumed_default: True

Float result

• default: ‘0.0’
• iotype: ‘out’
• vartypename: ‘Float’
• assumed_default: True

configure()

execute()

calculate the new objective value

class openmdao.test.rosen_suzuki.PostProc

Bases: openmdao.main.component.Component

Dummy post-processor.

Float result_in

• default: ‘0.0’
• iotype: ‘in’
• vartypename: ‘Float’
• assumed_default: True

Float result_out

• default: ‘0.0’
• iotype: ‘out’
• vartypename: ‘Float’
• assumed_default: True

execute()

class openmdao.test.rosen_suzuki.PreProc

Bases: openmdao.main.component.Component

Dummy pre-processor.

Array x_in

• default: ‘[ 1. 1. 1. 1.]’
• iotype: ‘in’
• low: -10
• high: 99
• comparison_mode: 1
• vartypename: ‘Array’
• assumed_default: False

Array x_out

• default: ‘[]’
• iotype: ‘out’
• comparison_mode: 1
• vartypename: ‘Array’
• assumed_default: True

execute()

class openmdao.test.rosen_suzuki.ScalingPostProc

Bases: openmdao.test.rosen_suzuki.PostProc

Scaling post-processor.

Float scaler

• default: ‘1.0’
• iotype: ‘in’
• vartypename: ‘Float’
• assumed_default: False

execute()

class openmdao.test.rosen_suzuki.ScalingPreProc

Bases: openmdao.test.rosen_suzuki.PreProc

Scaling pre-processor.

Float scaler

• default: ‘1.0’
• iotype: ‘in’
• vartypename: ‘Float’
• assumed_default: False

execute()

class openmdao.test.rosen_suzuki.Simulation

Bases: openmdao.main.assembly.Assembly

configure()

TEST

test_execcomp.py

Test of the ExecComp component.

class openmdao.test.test.test_execcomp.execCompTest(methodName='runTest')

Bases: unittest.case.TestCase

setUp()

test_execcomp()

test_execcomp_derivatives()

testing.py

class openmdao.test.testing.TestFailureSummary

Bases: nose.plugins.base.Plugin

This plugin lists the names of the failed tests. Run nose with the option --with-fail-summary to activate it.

addError(test, err, capt=None)

addFailure(test, err, capt=None, tb_info=None)

addSuccess(test, capt=None)

configure(options, config)

Configures the plugin.

options(parser, env)

Sets additional command line options.

report(stream)

Report the test failures.

startTest(test)

name = 'fail-summary'

score = 1

openmdao.test.testing.filter_config(hostlist, config, options)

Looks for sections in the config file that match the host names specified in options.hosts.

Returns a list of host names that match the given options.

openmdao.test.testing.is_dev_install()

openmdao.test.testing.loadTestsFromModule(self, module, path=None, discovered=False)

Load all tests from module and return a suite containing them. If the module has been discovered and is not test-like, the suite will be empty by default, though plugins may add their own tests.

openmdao.test.testing.read_config(options)

Reads the config file specified in options.cfg.

Returns a tuple of the form (hosts, config), where hosts is the list of host names and config is the ConfigParser object for the config file.

openmdao.test.testing.run_openmdao_suite(argv=None)

This function is exported as a script that is runnable as part of an OpenMDAO virtual environment as openmdao test.

This function wraps nosetests, so any valid nose args should also work here.