butler_cmd_test.ButlerCmdTestBase Class Reference

Inheritance diagram for butler_cmd_test.ButlerCmdTestBase:

Public Member Functions
def	instrumentClassName (self)
def	secondInstrumentClassName (self)
def	instrument (self)
def	instrumentName (self)
def	test_cli (self)

Detailed Description

Base class for tests of butler command line interface subcommands.
Subclass from this, then `unittest.TestCase` to get a working test suite.

Definition at line 34 of file butler_cmd_test.py.

Member Function Documentation

instrument()

def butler_cmd_test.ButlerCmdTestBase.instrument

(

self

)

The instrument class.

Definition at line 63 of file butler_cmd_test.py.

    def instrument(self):
        """The instrument class."""
        return doImport(self.instrumentClassName)
 

instrumentClassName()

def butler_cmd_test.ButlerCmdTestBase.instrumentClassName

(

self

)

The fully qualified instrument class name.

Returns
-------
`str`
    The fully qualified instrument class name.

Definition at line 41 of file butler_cmd_test.py.

    def instrumentClassName(self):
        """The fully qualified instrument class name.
 
        Returns
        -------
        `str`
            The fully qualified instrument class name.
        """
        pass
 

instrumentName()

def butler_cmd_test.ButlerCmdTestBase.instrumentName

(

self

)

The name of the instrument.

Returns
-------
`str`
    The name of the instrument.

Definition at line 68 of file butler_cmd_test.py.

    def instrumentName(self):
        """The name of the instrument.
 
        Returns
        -------
        `str`
            The name of the instrument.
        """
        return self.instrument.getName()
 

secondInstrumentClassName()

def butler_cmd_test.ButlerCmdTestBase.secondInstrumentClassName

(

self

)

Optional; if provided the register-instrument test will try to
register two instruments.

Returns
-------
`str` or `None`
    The fully qualified instrument class name.

Definition at line 52 of file butler_cmd_test.py.

    def secondInstrumentClassName(self):
        """Optional; if provided the register-instrument test will try to
        register two instruments.
 
        Returns
        -------
        `str` or `None`
            The fully qualified instrument class name.
        """
 

test_cli()

def butler_cmd_test.ButlerCmdTestBase.test_cli

(

self

)

Definition at line 78 of file butler_cmd_test.py.

    def test_cli(self):
        runner = LogCliRunner()
        with runner.isolated_filesystem():
            result = runner.invoke(butler.cli, ["create", "here"])
            self.assertEqual(result.exit_code, 0, f"output: {result.output} exception: {result.exception}")
            registerInstrumentArgs = ["register-instrument", "here", self.instrumentClassName]
            if self.secondInstrumentClassName is not None:
                registerInstrumentArgs.append(self.secondInstrumentClassName)
            result = runner.invoke(butler.cli, registerInstrumentArgs)
            self.assertEqual(result.exit_code, 0, f"output: {result.output} exception: {result.exception}")
            result = runner.invoke(butler.cli, ["write-curated-calibrations",
                                                "here",
                                                self.instrumentName,
                                                "--collection", "collection"])
            self.assertEqual(result.exit_code, 0, f"output: {result.output} exception: {result.exception}")

---

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

• /j/snowflake/release/lsstsw/stack/0.2.1/Linux64/obs_base/21.0.0-27-gbbd0d29+ae871e0f33/python/lsst/obs/base/cli/butler_cmd_test.py