BaseCscTestCase#

class lsst.ts.salobj.BaseCscTestCase#

Bases: object

Base class for CSC tests.

Subclasses must:

Also we suggest:

Methods Summary

assert_next_sample(topic[, flush, timeout])

Wait for the next data sample for the specified topic, check specified fields for equality, and return the data.

assert_next_summary_state(state[, flush, ...])

Wait for and check the next summaryState event.

asyncTearDown()

Runs after each test is completed.

basic_make_csc(initial_state, config_dir, ...)

Make and return a CSC.

check_bad_commands([bad_commands, good_commands])

Check that bad commands fail.

check_bin_script(name, index, exe_name[, ...])

Test running the CSC command line script.

check_standard_state_transitions(...[, ...])

Test standard CSC state transitions.

make_csc([initial_state, config_dir, ...])

Create a CSC and remote and wait for them to start.

next_index()

Get the next SAL index.

run([result])

Set a random LSST_TOPIC_SUBNAME and set LSST_SITE=test for every test.

Methods Documentation

async assert_next_sample(topic, flush=False, timeout=30, **kwargs)#

Wait for the next data sample for the specified topic, check specified fields for equality, and return the data.

Parameters:

  • topic (topics.ReadTopic) – Topic to read, e.g. remote.evt_logMessage.

  • flush (bool, optional) – Flush the read queue before waiting?

  • timeout (double, optional) – Time limit for getting the data sample (sec).

  • kwargs (dict) – Dict of field_name: expected_value The specified fields will be checked for equality.

Returns:

data – The data read.

Return type:

topic data type

Raises:

asyncio.TimeoutError – If no message is available within the specified time limit.

async assert_next_summary_state(state, flush=False, timeout=30, remote=None)#

Wait for and check the next summaryState event.

Parameters:

  • state (lsst.ts.salobj.State or int) – Desired summary state.

  • flush (bool, optional) – Flush the read queue before waiting?

  • timeout (float, optional) – Time limit for getting the data sample (sec).

  • remote (Remote, optional) – Remote to use; self.remote if None.

Raises:

asyncio.TimeoutError – If summary state is not seen within the specified time limit.

Return type:

None

async asyncTearDown()#

Runs after each test is completed.

Return type:

None

abstract basic_make_csc(initial_state, config_dir, simulation_mode, **kwargs)#

Make and return a CSC.

Parameters:

  • initial_state (lsst.ts.salobj.State or int) – The initial state of the CSC.

  • config_dir (str or pathlib.Path or None) – Directory of configuration files, or None for the standard configuration directory (obtained from ConfigureCsc._get_default_config_dir).

  • simulation_mode (int) – Simulation mode.

  • kwargs (dict) – Extra keyword arguments, if needed.

Return type:

BaseCsc

async check_bad_commands(bad_commands=None, good_commands=None)#

Check that bad commands fail.

Parameters:

  • bad_commands (List`[`str] or None, optional) – Names of bad commands to try, or None for all commands.

  • good_commands (List`[`str] or None, optional) – Names of good commands to skip, or None to skip none.

Return type:

None

Notes

If a command appears in both lists, it is considered a good command, so it is skipped.

async check_bin_script(name, index, exe_name, default_initial_state=State.STANDBY, initial_state=None, override=None, cmdline_args=(), timeout=40)#

Test running the CSC command line script.

Parameters:

  • name (str) – Name of SAL component, e.g. “Rotator”

  • index (int or None) – SAL index of component.

  • exe_name (str) – Name of executable, e.g. “run_rotator.py”

  • default_initial_state (lsst.ts.salobj.State, optional) – The default initial state of the CSC. Ignored unless initial_state is None.

  • initial_state (lsst.ts.salobj.State or int or None, optional) – The desired initial state of the CSC; used to specify the --state command-argument.

  • override (str or None, optional) – Value for the --override command-line argument, which is omitted if override is None.

  • cmdline_args (List [str]) – Additional command-line arguments, such as “–simulate”.

  • timeout (float, optional) – Time limit for the CSC to start and output the summaryState event.

Raises:

asyncio.TimeoutError – If the CSC cannot be started within the specified time limit.

Return type:

None

async check_standard_state_transitions(enabled_commands, skip_commands=None, override='', timeout=30)#

Test standard CSC state transitions.

Parameters:

  • enabled_commands (List [str]) – List of CSC-specific commands that are valid in the enabled state. Need not include the standard commands, which are “disable” and “setLogLevel” (which is valid in any state).

  • skip_commands (List [str] or None, optional) – List of commands to skip.

  • override (str, optional) – Configuration override file to apply when the CSC is taken from state State.STANDBY to State.DISABLED.

  • timeout (float, optional) – Time limit for state transition commands (seconds).

Raises:

asyncio.TimeoutError – If any state transition takes longer than the specified time limit.

Return type:

None

Notes

timeout is only used for state transition commands that are expected to succceed. STD_TIMEOUT is used for things that should happen quickly:

  • Commands that should fail, due to the CSC being in the wrong state.

  • The summaryState event after each state transition:

make_csc(initial_state=None, config_dir=None, simulation_mode=0, log_level=None, timeout=30, **kwargs)#

Create a CSC and remote and wait for them to start.

The csc is accessed as self.csc and the remote as self.remote.

The topics in self.remote will queue all telemetry and events from when the CSC is constructed, with one exception: self.remote.evt_summaryState will only have the final summary state, because earlier values are read and checked against the expected startup states. (The final summary state is left queued for backwards compatibility.)

Parameters:

  • name (str) – Name of SAL component.

  • initial_state (lsst.ts.salobj.State or int, optional) – The initial state of the CSC. If None use the CSC’s default initial state.

  • config_dir (str, optional) – Directory of configuration files, or None (the default) for the standard configuration directory (obtained from ConfigureCsc._get_default_config_dir).

  • simulation_mode (int, optional) – Simulation mode. Defaults to 0 because not all CSCs support simulation. However, tests of CSCs that support simulation will almost certainly want to set this nonzero.

  • log_level (int or None, optional) – Logging level, such as logging.INFO. If None then do not set the log level, leaving the default behavior of SalInfo: increase the log level to INFO.

  • timeout (float, optional) – Time limit for the CSC to start (seconds).

  • **kwargs (dict, optional) – Extra keyword arguments for basic_make_csc. For a configurable CSC this may include override, especially if initial_state is DISABLED or ENABLED.

Raises:

asyncio.TimeoutError – If the CSC cannot be constructed within the specified time limit.

Return type:

AsyncGenerator[None, None]

next_index()#

Get the next SAL index.

Return type:

int

run(result=None)#

Set a random LSST_TOPIC_SUBNAME and set LSST_SITE=test for every test.

Unlike setUp, a user cannot forget to override this. (This is also a good place for context managers).

Parameters:

result (Any, default: None)

Return type:

None