#!/usr/bin/python3
"""Regression tests for Pacemaker's pacemaker-execd."""

# pylint doesn't like the module name "cts-execd" which is an invalid complaint for this file
# but probably something we want to continue warning about elsewhere
# pylint: disable=invalid-name
# pacemaker imports need to come after we modify sys.path, which pylint will complain about.
# pylint: disable=wrong-import-position

__copyright__ = "Copyright 2012-2024 the Pacemaker project contributors"
__license__ = "GNU General Public License version 2 or later (GPLv2+) WITHOUT ANY WARRANTY"

import argparse
import os
import stat
import sys
import subprocess
import shutil
import tempfile

# Where to find test binaries
# Prefer the source tree if available
TEST_DIR = sys.path[0]

from pacemaker.buildoptions import BuildOptions
from pacemaker.exitstatus import ExitStatus
from pacemaker._cts.corosync import Corosync
from pacemaker._cts.process import killall, exit_if_proc_running, stdout_from_command
from pacemaker._cts.test import Test, Tests

# File permissions for executable scripts we create
EXECMODE = stat.S_IRUSR | stat.S_IXUSR | stat.S_IRGRP | stat.S_IXGRP | stat.S_IROTH | stat.S_IXOTH


def update_path():
    # pylint: disable=protected-access
    """Set the PATH environment variable appropriately for the tests."""
    new_path = os.environ['PATH']

    if os.path.exists("%s/cts-exec.in" % TEST_DIR):
        print("Running tests from the source tree: %s (%s)" % (BuildOptions._BUILD_DIR, TEST_DIR))
        # For pacemaker-execd, cts-exec-helper, and pacemaker-remoted
        new_path = "%s/daemons/execd:%s" % (BuildOptions._BUILD_DIR, new_path)
        new_path = "%s/tools:%s" % (BuildOptions._BUILD_DIR, new_path)   # For crm_resource
        # For pacemaker-fenced
        new_path = "%s/daemons/fenced:%s" % (BuildOptions._BUILD_DIR, new_path)
        # For cts-support
        new_path = "%s/cts/support:%s" % (BuildOptions._BUILD_DIR, new_path)

    else:
        print("Running tests from the install tree: %s (not %s)" % (BuildOptions.DAEMON_DIR, TEST_DIR))
        # For cts-exec-helper, cts-support, pacemaker-execd, pacemaker-fenced,
        # and pacemaker-remoted
        new_path = "%s:%s" % (BuildOptions.DAEMON_DIR, new_path)

    print('Using PATH="%s"' % new_path)
    os.environ['PATH'] = new_path


class ExecTest(Test):
    """Executor for a single pacemaker-execd regression test."""

    def __init__(self, name, description, **kwargs):
        """Create a new ExecTest instance.

        Arguments:
        name        -- A unique name for this test.  This can be used on the
                       command line to specify that only a specific test should
                       be executed.
        description -- A meaningful description for the test.

        Keyword arguments:
        tls         -- Enable pacemaker-remoted.
        """
        Test.__init__(self, name, description, **kwargs)

        self.tls = kwargs.get("tls", False)

        # If we are going to run the stonith resource tests, we will need to
        # launch and track Corosync and pacemaker-fenced.
        self._corosync = None
        self._fencer = None
        self._is_stonith_test = "stonith" in self.name

        if self.tls:
            self._daemon_location = "pacemaker-remoted"
        else:
            self._daemon_location = "pacemaker-execd"
            if self._is_stonith_test:
                self._corosync = Corosync(self.verbose, self.logdir, "cts-exec")

        self._test_tool_location = "cts-exec-helper"

    def _kill_daemons(self):
        killall([
            "corosync",
            "pacemaker-fenced",
            "lt-pacemaker-fenced",
            "pacemaker-execd",
            "lt-pacemaker-execd",
            "cts-exec-helper",
            "lt-cts-exec-helper",
            "pacemaker-remoted",
        ])

    def _start_daemons(self):
        if self._corosync:
            self._corosync.start(kill_first=True)
            # pylint: disable=consider-using-with
            self._fencer = subprocess.Popen(["pacemaker-fenced", "-s"])

        cmd = [self._daemon_location, "-l", self.logpath]
        if self.verbose:
            cmd += ["-V"]

        # pylint: disable=consider-using-with
        self._daemon_process = subprocess.Popen(cmd)

    def clean_environment(self):
        """Clean up the host after running a test."""
        if self._daemon_process:
            self._daemon_process.terminate()
            self._daemon_process.wait()

            if self.verbose:
                print("Daemon Output Start")
                with open(self.logpath, "rt", errors="replace", encoding="utf-8") as logfile:
                    for line in logfile:
                        print(line.strip())
                print("Daemon Output End")

        if self._corosync:
            self._fencer.terminate()
            self._fencer.wait()
            self._corosync.stop()

        self._daemon_process = None
        self._fencer = None
        self._corosync = None

    def add_cmd(self, cmd=None, **kwargs):
        """Add a cts-exec-helper command to be executed as part of this test."""
        if cmd is None:
            cmd = self._test_tool_location

        if cmd == self._test_tool_location:
            if self.verbose:
                kwargs["args"] += " -V "

            if self.tls:
                kwargs["args"] += " -S "

        kwargs["validate"] = False
        kwargs["check_rng"] = False
        kwargs["check_stderr"] = False

        Test.add_cmd(self, cmd, **kwargs)

    def run(self):
        """Execute this test."""
        if self.tls and self._is_stonith_test:
            self._result_txt = "SKIPPED - '%s' - disabled when testing pacemaker_remote" % (self.name)
            print(self._result_txt)
            return

        Test.run(self)


class ExecTests(Tests):
    """Collection of all pacemaker-execd regression tests."""

    def __init__(self, **kwargs):
        """
        Create a new ExecTests instance.

        Keyword arguments:
        tls         -- Enable pacemaker-remoted.
        """
        Tests.__init__(self, **kwargs)

        self.tls = kwargs.get("tls", False)

        self._action_timeout = " -t 9000 "
        self._installed_files = []
        self._rsc_classes = self._setup_rsc_classes()

        print("Testing resource classes %r" % self._rsc_classes)

        if "lsb" in self._rsc_classes:
            service_agent = "LSBDummy"
        elif "systemd" in self._rsc_classes:
            service_agent = "pacemaker-cts-dummyd@3"
        else:
            service_agent = "unsupported"

        self._common_cmds = {
            "ocf_reg_line": '-c register_rsc -r ocf_test_rsc ' + self._action_timeout + ' -C ocf -P pacemaker -T Dummy',
            "ocf_reg_event": '-l "NEW_EVENT event_type:register rsc_id:ocf_test_rsc action:none rc:ok op_status:Done"',
            "ocf_unreg_line": '-c unregister_rsc -r ocf_test_rsc ' + self._action_timeout,
            "ocf_unreg_event": '-l "NEW_EVENT event_type:unregister rsc_id:ocf_test_rsc action:none rc:ok op_status:Done"',
            "ocf_start_line": '-c exec -r ocf_test_rsc -a start ' + self._action_timeout,
            "ocf_start_event": '-l "NEW_EVENT event_type:exec_complete rsc_id:ocf_test_rsc action:start rc:ok op_status:Done" ',
            "ocf_stop_line": '-c exec -r ocf_test_rsc -a stop ' + self._action_timeout,
            "ocf_stop_event": '-l "NEW_EVENT event_type:exec_complete rsc_id:ocf_test_rsc action:stop rc:ok op_status:Done" ',
            "ocf_monitor_line": '-c exec -r ocf_test_rsc -a monitor -i 2s ' + self._action_timeout,
            "ocf_monitor_event": '-l "NEW_EVENT event_type:exec_complete rsc_id:ocf_test_rsc action:monitor rc:ok op_status:Done" ' + self._action_timeout,
            "ocf_cancel_line": '-c cancel -r ocf_test_rsc -a monitor -i 2s ' + self._action_timeout,
            "ocf_cancel_event": '-l "NEW_EVENT event_type:exec_complete rsc_id:ocf_test_rsc action:monitor rc:ok op_status:Cancelled" ',

            "systemd_reg_line": '-c register_rsc -r systemd_test_rsc ' + self._action_timeout + ' -C systemd -T pacemaker-cts-dummyd@3',
            "systemd_reg_event": '-l "NEW_EVENT event_type:register rsc_id:systemd_test_rsc action:none rc:ok op_status:Done"',
            "systemd_unreg_line": '-c unregister_rsc -r systemd_test_rsc ' + self._action_timeout,
            "systemd_unreg_event": '-l "NEW_EVENT event_type:unregister rsc_id:systemd_test_rsc action:none rc:ok op_status:Done"',
            "systemd_start_line": '-c exec -r systemd_test_rsc -a start ' + self._action_timeout,
            "systemd_start_event": '-l "NEW_EVENT event_type:exec_complete rsc_id:systemd_test_rsc action:start rc:ok op_status:Done" ',
            "systemd_stop_line": '-c exec -r systemd_test_rsc -a stop ' + self._action_timeout,
            "systemd_stop_event": '-l "NEW_EVENT event_type:exec_complete rsc_id:systemd_test_rsc action:stop rc:ok op_status:Done" ',
            "systemd_monitor_line": '-c exec -r systemd_test_rsc -a monitor -i 2s ' + self._action_timeout,
            "systemd_monitor_event": '-l "NEW_EVENT event_type:exec_complete rsc_id:systemd_test_rsc action:monitor rc:ok op_status:Done" -t 15000 ',
            "systemd_cancel_line": '-c cancel -r systemd_test_rsc -a monitor -i 2s ' + self._action_timeout,
            "systemd_cancel_event": '-l "NEW_EVENT event_type:exec_complete rsc_id:systemd_test_rsc action:monitor rc:ok op_status:Cancelled" ',

            "service_reg_line": '-c register_rsc -r service_test_rsc ' + self._action_timeout
                                + ' -C service -T %s' % service_agent,
            "service_reg_event": '-l "NEW_EVENT event_type:register rsc_id:service_test_rsc action:none rc:ok op_status:Done"',
            "service_unreg_line": '-c unregister_rsc -r service_test_rsc ' + self._action_timeout,
            "service_unreg_event": '-l "NEW_EVENT event_type:unregister rsc_id:service_test_rsc action:none rc:ok op_status:Done"',
            "service_start_line": '-c exec -r service_test_rsc -a start ' + self._action_timeout,
            "service_start_event": '-l "NEW_EVENT event_type:exec_complete rsc_id:service_test_rsc action:start rc:ok op_status:Done" ',
            "service_stop_line": '-c exec -r service_test_rsc -a stop ' + self._action_timeout,
            "service_stop_event": '-l "NEW_EVENT event_type:exec_complete rsc_id:service_test_rsc action:stop rc:ok op_status:Done" ',
            "service_monitor_line": '-c exec -r service_test_rsc -a monitor -i 2s ' + self._action_timeout,
            "service_monitor_event": '-l "NEW_EVENT event_type:exec_complete rsc_id:service_test_rsc action:monitor rc:ok op_status:Done" ' + self._action_timeout,
            "service_cancel_line": '-c cancel -r service_test_rsc -a monitor -i 2s ' + self._action_timeout,
            "service_cancel_event": '-l "NEW_EVENT event_type:exec_complete rsc_id:service_test_rsc action:monitor rc:ok op_status:Cancelled" ',

            "lsb_reg_line": '-c register_rsc -r lsb_test_rsc ' + self._action_timeout + ' -C lsb -T LSBDummy',
            "lsb_reg_event": '-l "NEW_EVENT event_type:register rsc_id:lsb_test_rsc action:none rc:ok op_status:Done" ',
            "lsb_unreg_line": '-c unregister_rsc -r lsb_test_rsc ' + self._action_timeout,
            "lsb_unreg_event": '-l "NEW_EVENT event_type:unregister rsc_id:lsb_test_rsc action:none rc:ok op_status:Done"',
            "lsb_start_line": '-c exec -r lsb_test_rsc -a start ' + self._action_timeout,
            "lsb_start_event": '-l "NEW_EVENT event_type:exec_complete rsc_id:lsb_test_rsc action:start rc:ok op_status:Done" ',
            "lsb_stop_line": '-c exec -r lsb_test_rsc -a stop ' + self._action_timeout,
            "lsb_stop_event": '-l "NEW_EVENT event_type:exec_complete rsc_id:lsb_test_rsc action:stop rc:ok op_status:Done" ',
            "lsb_monitor_line": '-c exec -r lsb_test_rsc -a status -i 2s ' + self._action_timeout,
            "lsb_monitor_event": '-l "NEW_EVENT event_type:exec_complete rsc_id:lsb_test_rsc action:status rc:ok op_status:Done" ' + self._action_timeout,
            "lsb_cancel_line": '-c cancel -r lsb_test_rsc -a status -i 2s ' + self._action_timeout,
            "lsb_cancel_event": '-l "NEW_EVENT event_type:exec_complete rsc_id:lsb_test_rsc action:status rc:ok op_status:Cancelled" ',

            "stonith_reg_line": '-c register_rsc -r stonith_test_rsc ' + self._action_timeout + ' -C stonith -P pacemaker -T fence_dummy',
            "stonith_reg_event": '-l "NEW_EVENT event_type:register rsc_id:stonith_test_rsc action:none rc:ok op_status:Done" ',
            "stonith_unreg_line": '-c unregister_rsc -r stonith_test_rsc ' + self._action_timeout,
            "stonith_unreg_event": '-l "NEW_EVENT event_type:unregister rsc_id:stonith_test_rsc action:none rc:ok op_status:Done"',
            "stonith_start_line": '-c exec -r stonith_test_rsc -a start ' + self._action_timeout,
            "stonith_start_event": '-l "NEW_EVENT event_type:exec_complete rsc_id:stonith_test_rsc action:start rc:ok op_status:Done" ',
            "stonith_stop_line": '-c exec -r stonith_test_rsc -a stop ' + self._action_timeout,
            "stonith_stop_event": '-l "NEW_EVENT event_type:exec_complete rsc_id:stonith_test_rsc action:stop rc:ok op_status:Done" ',
            "stonith_monitor_line": '-c exec -r stonith_test_rsc -a monitor -i 2s ' + self._action_timeout,
            "stonith_monitor_event": '-l "NEW_EVENT event_type:exec_complete rsc_id:stonith_test_rsc action:monitor rc:ok op_status:Done" ' + self._action_timeout,
            "stonith_cancel_line": '-c cancel -r stonith_test_rsc -a monitor -i 2s ' + self._action_timeout,
            "stonith_cancel_event": '-l "NEW_EVENT event_type:exec_complete rsc_id:stonith_test_rsc action:monitor rc:ok op_status:Cancelled" ',
        }

    def _setup_rsc_classes(self):
        """Determine which resource classes are supported."""
        classes = stdout_from_command(["crm_resource", "--list-standards"])
        # Strip trailing empty line
        classes = classes[:-1]

        if self.tls:
            classes.remove("stonith")

        if "systemd" in classes:
            try:
                # This code doesn't need this import, but pacemaker-cts-dummyd
                # does, so ensure the dependency is available rather than cause
                # all systemd tests to fail.
                # pylint: disable=import-outside-toplevel,unused-import
                import systemd.daemon
            except ImportError:
                print("Python systemd bindings not found.")
                print("The tests for systemd class are not going to be run.")
                classes.remove("systemd")

        return classes

    def new_test(self, name, description):
        """Create a named test."""
        test = ExecTest(name, description, verbose=self.verbose, tls=self.tls,
                        timeout=self.timeout, force_wait=self.force_wait,
                        logdir=self.logdir)
        self._tests.append(test)
        return test

    def setup_environment(self):
        """Prepare the host before executing any tests."""
        if BuildOptions.REMOTE_ENABLED:
            os.system("service pacemaker_remote stop")
        self.cleanup_environment()

        # @TODO Support the option of using specified existing certificates
        authkey = "%s/authkey" % BuildOptions.PACEMAKER_CONFIG_DIR
        if self.tls and not os.path.isfile(authkey):
            print("Installing %s ..." % authkey)
            os.system("mkdir -p %s" % BuildOptions.PACEMAKER_CONFIG_DIR)
            os.system("dd if=/dev/urandom of=%s bs=4096 count=1" % authkey)
            self._installed_files.append(authkey)

        # If we're in build directory, install agents if not already installed
        # pylint: disable=protected-access
        if getattr(BuildOptions, "_BUILD_DIR", None):
          if os.path.exists("%s/cts/cts-exec.in" % BuildOptions._BUILD_DIR):

              if not os.path.exists("%s/pacemaker" % BuildOptions.OCF_RA_INSTALL_DIR):
                  # @TODO remember which components were created and remove them
                  os.makedirs("%s/pacemaker" % BuildOptions.OCF_RA_INSTALL_DIR, 0o755)

              for agent in ["Dummy", "Stateful", "ping"]:
                  agent_source = "%s/extra/resources/%s" % (BuildOptions._BUILD_DIR, agent)
                  agent_dest = "%s/pacemaker/%s" % (BuildOptions.OCF_RA_INSTALL_DIR, agent)
                  if not os.path.exists(agent_dest):
                      print("Installing %s ..." % agent_dest)
                      shutil.copyfile(agent_source, agent_dest)
                      os.chmod(agent_dest, EXECMODE)
                      self._installed_files.append(agent_dest)

        subprocess.call(["cts-support", "install"])

    def cleanup_environment(self):
        """Clean up the host after executing desired tests."""
        for installed_file in self._installed_files:
            print("Removing %s ..." % installed_file)
            os.remove(installed_file)

        subprocess.call(["cts-support", "uninstall"])

    def _build_cmd_str(self, rsc, ty):
        """Construct a command string for the given resource and type."""
        return "%s %s" % (self._common_cmds["%s_%s_line" % (rsc, ty)], self._common_cmds["%s_%s_event" % (rsc, ty)])

    def build_generic_tests(self):
        """Register tests that apply to all resource classes."""
        common_cmds = self._common_cmds

        # register/unregister tests
        for rsc in self._rsc_classes:
            test = self.new_test("generic_registration_%s" % rsc,
                                 "Simple resource registration test for %s standard" % rsc)
            test.add_cmd(args=self._build_cmd_str(rsc, "reg"))
            test.add_cmd(args=self._build_cmd_str(rsc, "unreg"))

        # start/stop tests
        for rsc in self._rsc_classes:
            test = self.new_test("generic_start_stop_%s" % rsc, "Simple start and stop test for %s standard" % rsc)
            test.add_cmd(args=self._build_cmd_str(rsc, "reg"))
            test.add_cmd(args=self._build_cmd_str(rsc, "start"))
            test.add_cmd(args=self._build_cmd_str(rsc, "stop"))
            test.add_cmd(args=self._build_cmd_str(rsc, "unreg"))

        # monitor cancel test
        for rsc in self._rsc_classes:
            test = self.new_test("generic_monitor_cancel_%s" % rsc,
                                 "Simple monitor cancel test for %s standard" % rsc)
            test.add_cmd(args=self._build_cmd_str(rsc, "reg"))
            test.add_cmd(args=self._build_cmd_str(rsc, "start"))
            test.add_cmd(args=self._build_cmd_str(rsc, "monitor"))
            # If this fails, that means the monitor may not be getting rescheduled
            test.add_cmd(args=common_cmds["%s_monitor_event" % rsc])
            # If this fails, that means the monitor may not be getting rescheduled
            test.add_cmd(args=common_cmds["%s_monitor_event" % rsc])
            test.add_cmd(args=self._build_cmd_str(rsc, "cancel"))
            # If this happens the monitor did not actually cancel correctly
            test.add_cmd(args=common_cmds["%s_monitor_event" % rsc],
                         expected_exitcode=ExitStatus.TIMEOUT)
            # If this happens the monitor did not actually cancel correctly
            test.add_cmd(args=common_cmds["%s_monitor_event" % rsc],
                         expected_exitcode=ExitStatus.TIMEOUT)
            test.add_cmd(args=self._build_cmd_str(rsc, "stop"))
            test.add_cmd(args=self._build_cmd_str(rsc, "unreg"))

        # monitor duplicate test
        for rsc in self._rsc_classes:
            test = self.new_test("generic_monitor_duplicate_%s" % rsc,
                                 "Test creation and canceling of duplicate monitors for %s standard" % rsc)
            test.add_cmd(args=self._build_cmd_str(rsc, "reg"))
            test.add_cmd(args=self._build_cmd_str(rsc, "start"))
            test.add_cmd(args=self._build_cmd_str(rsc, "monitor"))
            # If this fails, that means the monitor may not be getting rescheduled
            test.add_cmd(args=common_cmds["%s_monitor_event" % rsc])
            # If this fails, that means the monitor may not be getting rescheduled
            test.add_cmd(args=common_cmds["%s_monitor_event" % rsc])

            # Add the duplicate monitors
            test.add_cmd(args=self._build_cmd_str(rsc, "monitor"))
            test.add_cmd(args=self._build_cmd_str(rsc, "monitor"))
            test.add_cmd(args=self._build_cmd_str(rsc, "monitor"))
            test.add_cmd(args=self._build_cmd_str(rsc, "monitor"))
            # verify we still get update events
            # If this fails, that means the monitor may not be getting rescheduled
            test.add_cmd(args=common_cmds["%s_monitor_event" % rsc])

            # cancel the monitor, if the duplicate merged with the original, we should no longer see monitor updates
            test.add_cmd(args=self._build_cmd_str(rsc, "cancel"))
            # If this happens the monitor did not actually cancel correctly
            test.add_cmd(args=common_cmds["%s_monitor_event" % rsc],
                         expected_exitcode=ExitStatus.TIMEOUT)
            # If this happens the monitor did not actually cancel correctly
            test.add_cmd(args=common_cmds["%s_monitor_event" % rsc],
                         expected_exitcode=ExitStatus.TIMEOUT)
            test.add_cmd(args=self._build_cmd_str(rsc, "stop"))
            test.add_cmd(args=self._build_cmd_str(rsc, "unreg"))

        # stop implies cancel test
        for rsc in self._rsc_classes:
            test = self.new_test("generic_stop_implies_cancel_%s" % rsc,
                                 "Verify stopping a resource implies cancel of recurring ops for %s standard" % rsc)
            test.add_cmd(args=self._build_cmd_str(rsc, "reg"))
            test.add_cmd(args=self._build_cmd_str(rsc, "start"))
            test.add_cmd(args=self._build_cmd_str(rsc, "monitor"))
            # If this fails, that means the monitor may not be getting rescheduled
            test.add_cmd(args=common_cmds["%s_monitor_event" % rsc])
            # If this fails, that means the monitor may not be getting rescheduled
            test.add_cmd(args=common_cmds["%s_monitor_event" % rsc])
            test.add_cmd(args=self._build_cmd_str(rsc, "stop"))
            # If this happens the monitor did not actually cancel correctly
            test.add_cmd(args=common_cmds["%s_monitor_event" % rsc],
                         expected_exitcode=ExitStatus.TIMEOUT)
            # If this happens the monitor did not actually cancel correctly
            test.add_cmd(args=common_cmds["%s_monitor_event" % rsc],
                         expected_exitcode=ExitStatus.TIMEOUT)
            test.add_cmd(args=self._build_cmd_str(rsc, "unreg"))

    def build_multi_rsc_tests(self):
        """Register complex tests that involve managing multiple resources of different types."""
        common_cmds = self._common_cmds
        # do not use service and systemd at the same time, it is the same resource.

        # register start monitor stop unregister resources of each type at the same time
        test = self.new_test("multi_rsc_start_stop_all_including_stonith",
                             "Start, monitor, and stop resources of multiple types and classes")
        for rsc in self._rsc_classes:
            test.add_cmd(args=self._build_cmd_str(rsc, "reg"))
        for rsc in self._rsc_classes:
            test.add_cmd(args=self._build_cmd_str(rsc, "start"))
        for rsc in self._rsc_classes:
            test.add_cmd(args=self._build_cmd_str(rsc, "monitor"))
        for rsc in self._rsc_classes:
            # If this fails, that means the monitor is not being rescheduled
            test.add_cmd(args=common_cmds["%s_monitor_event" % rsc])
        for rsc in self._rsc_classes:
            test.add_cmd(args=self._build_cmd_str(rsc, "cancel"))
        for rsc in self._rsc_classes:
            test.add_cmd(args=self._build_cmd_str(rsc, "stop"))
        for rsc in self._rsc_classes:
            test.add_cmd(args=self._build_cmd_str(rsc, "unreg"))

    def build_negative_tests(self):
        """Register tests related to how pacemaker-execd handles failures."""
        # ocf start timeout test
        test = self.new_test("ocf_start_timeout", "Force start timeout to occur, verify start failure.")
        test.add_cmd(args='-c register_rsc -r test_rsc -C ocf -P pacemaker -T Dummy ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:register rsc_id:test_rsc action:none rc:ok op_status:Done" ')
        # -t must be less than self._action_timeout
        test.add_cmd(args='-c exec -r test_rsc -a start -k op_sleep -v 5 -t 1000 -w')
        test.add_cmd(args='-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:start rc:Error occurred op_status:Timed out" '
                     + self._action_timeout)
        test.add_cmd(args='-c exec -r test_rsc -a stop ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:stop rc:ok op_status:Done" ')
        test.add_cmd(args='-c unregister_rsc -r test_rsc ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:unregister rsc_id:test_rsc action:none rc:ok op_status:Done" ')

        # stonith start timeout test
        test = self.new_test("stonith_start_timeout", "Force start timeout to occur, verify start failure.")
        test.add_cmd(args='-c register_rsc -r test_rsc -C stonith -P pacemaker -T fence_dummy ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:register rsc_id:test_rsc action:none rc:ok op_status:Done"')
        # -t must be less than self._action_timeout
        test.add_cmd(args='-c exec -r test_rsc -a start -k monitor_delay -v 30 -t 1000 -w')
        test.add_cmd(args='-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:start rc:Error occurred op_status:Timed out" '
                     + self._action_timeout)
        test.add_cmd(args='-c exec -r test_rsc -a stop ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:stop rc:ok op_status:Done" ')
        test.add_cmd(args='-c unregister_rsc -r test_rsc ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:unregister rsc_id:test_rsc action:none rc:ok op_status:Done" ')

        # stonith component fail
        test = self.new_test("stonith_component_fail", "Kill stonith component after pacemaker-execd connects")
        test.add_cmd(args=self._build_cmd_str("stonith", "reg"))
        test.add_cmd(args=self._build_cmd_str("stonith", "start"))

        test.add_cmd(args='-c exec -r stonith_test_rsc -a monitor -i 600s '
                     '-l "NEW_EVENT event_type:exec_complete rsc_id:stonith_test_rsc action:monitor rc:ok op_status:Done" '
                     + self._action_timeout)

        test.add_cmd(args='-l "NEW_EVENT event_type:exec_complete rsc_id:stonith_test_rsc action:monitor rc:Error occurred op_status:error" -t 15000',
                     kill="killall -9 -q pacemaker-fenced lt-pacemaker-fenced")
        test.add_cmd(args=self._build_cmd_str("stonith", "unreg"))

        # monitor fail for ocf resources
        test = self.new_test("monitor_fail_ocf", "Force ocf monitor to fail, verify failure is reported.")
        test.add_cmd(args='-c register_rsc -r test_rsc -C ocf -P pacemaker -T Dummy ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:register rsc_id:test_rsc action:none rc:ok op_status:Done" ')
        test.add_cmd(args='-c exec -r test_rsc -a start ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:start rc:ok op_status:Done" ')
        test.add_cmd(args='-c exec -r test_rsc -a start ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:start rc:ok op_status:Done" ')
        test.add_cmd(args='-c exec -r test_rsc -a monitor -i 1s ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:monitor rc:ok op_status:Done"')
        test.add_cmd(args='-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:monitor rc:ok op_status:Done"'
                     + self._action_timeout)
        test.add_cmd(args='-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:monitor rc:ok op_status:Done"'
                     + self._action_timeout)
        test.add_cmd(args='-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:monitor rc:not running op_status:Done" ' + self._action_timeout,
                     kill="rm -f %s/run/Dummy-test_rsc.state" % BuildOptions.LOCAL_STATE_DIR)
        test.add_cmd(args='-c cancel -r test_rsc -a monitor -i 1s ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:monitor rc:not running op_status:Cancelled" ')
        test.add_cmd(args='-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:monitor rc:not running op_status:Done" '
                     + self._action_timeout, expected_exitcode=ExitStatus.TIMEOUT)
        test.add_cmd(args='-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:monitor rc:ok op_status:Done" '
                     + self._action_timeout, expected_exitcode=ExitStatus.TIMEOUT)
        test.add_cmd(args='-c unregister_rsc -r test_rsc ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:unregister rsc_id:test_rsc action:none rc:ok op_status:Done" ')

        # verify notify changes only for monitor operation
        test = self.new_test("monitor_changes_only", "Verify when flag is set, only monitor changes are notified.")
        test.add_cmd(args='-c register_rsc -r test_rsc -C ocf -P pacemaker -T Dummy ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:register rsc_id:test_rsc action:none rc:ok op_status:Done" ')
        test.add_cmd(args='-c exec -r test_rsc -a start ' + self._action_timeout + ' -o '
                     '-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:start rc:ok op_status:Done" ')
        test.add_cmd(args='-c exec -r test_rsc -a monitor -i 1s ' + self._action_timeout
                     + ' -o -l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:monitor rc:ok op_status:Done" ')
        test.add_cmd(args='-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:monitor rc:ok op_status:Done" ' + self._action_timeout,
                     expected_exitcode=ExitStatus.TIMEOUT)
        test.add_cmd(args='-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:monitor rc:not running op_status:Done"' + self._action_timeout,
                     kill='rm -f %s/run/Dummy-test_rsc.state' % BuildOptions.LOCAL_STATE_DIR)
        test.add_cmd(args='-c cancel -r test_rsc -a monitor -i 1s' + self._action_timeout
                     + '-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:monitor rc:not running op_status:Cancelled" ')
        test.add_cmd(args='-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:monitor rc:not running op_status:Done" ' + self._action_timeout,
                     expected_exitcode=ExitStatus.TIMEOUT)
        test.add_cmd(args='-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:monitor rc:ok op_status:Done" ' + self._action_timeout,
                     expected_exitcode=ExitStatus.TIMEOUT)
        test.add_cmd(args='-c unregister_rsc -r test_rsc ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:unregister rsc_id:test_rsc action:none rc:ok op_status:Done"')

        # monitor fail for systemd resource
        if "systemd" in self._rsc_classes:
            test = self.new_test("monitor_fail_systemd", "Force systemd monitor to fail, verify failure is reported..")
            test.add_cmd(args='-c register_rsc -r test_rsc -C systemd -T pacemaker-cts-dummyd@3 ' + self._action_timeout
                         + '-l "NEW_EVENT event_type:register rsc_id:test_rsc action:none rc:ok op_status:Done" ')
            test.add_cmd(args='-c exec -r test_rsc -a start ' + self._action_timeout
                         + '-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:start rc:ok op_status:Done" ')
            test.add_cmd(args='-c exec -r test_rsc -a start ' + self._action_timeout
                         + '-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:start rc:ok op_status:Done" ')
            test.add_cmd(args='-c exec -r test_rsc -a monitor -i 1s ' + self._action_timeout
                         + '-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:monitor rc:ok op_status:Done" ')
            test.add_cmd(args='-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:monitor rc:ok op_status:Done" ' + self._action_timeout)
            test.add_cmd(args='-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:monitor rc:ok op_status:Done" ' + self._action_timeout)
            test.add_cmd(args='-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:monitor rc:not running op_status:Done"' + self._action_timeout,
                         kill="pkill -9 -f pacemaker-cts-dummyd")
            test.add_cmd(args='-c cancel -r test_rsc -a monitor -i 1s' + self._action_timeout
                         + '-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:monitor rc:not running op_status:Cancelled" ')
            test.add_cmd(args='-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:monitor rc:not running op_status:Done" ' + self._action_timeout,
                         expected_exitcode=ExitStatus.TIMEOUT)
            test.add_cmd(args='-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:monitor rc:ok op_status:Done" ' + self._action_timeout,
                         expected_exitcode=ExitStatus.TIMEOUT)
            test.add_cmd(args='-c unregister_rsc -r test_rsc ' + self._action_timeout
                         + '-l "NEW_EVENT event_type:unregister rsc_id:test_rsc action:none rc:ok op_status:Done" ')

        # Cancel non-existent operation on a resource
        test = self.new_test("cancel_non_existent_op", "Attempt to cancel the wrong monitor operation, verify expected failure")
        test.add_cmd(args='-c register_rsc -r test_rsc -C ocf -P pacemaker -T Dummy ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:register rsc_id:test_rsc action:none rc:ok op_status:Done" ')
        test.add_cmd(args='-c exec -r test_rsc -a start ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:start rc:ok op_status:Done" ')
        test.add_cmd(args='-c exec -r test_rsc -a start ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:start rc:ok op_status:Done" ')
        test.add_cmd(args='-c exec -r test_rsc -a monitor -i 1s ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:monitor rc:ok op_status:Done" ')
        test.add_cmd(args='-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:monitor rc:ok op_status:Done" ' + self._action_timeout)
        # interval is wrong, should fail
        test.add_cmd(args='-c cancel -r test_rsc -a monitor -i 2s' + self._action_timeout
                     + ' -l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:monitor rc:not running op_status:Cancelled" ',
                     expected_exitcode=ExitStatus.ERROR)
        # action name is wrong, should fail
        test.add_cmd(args='-c cancel -r test_rsc -a stop -i 1s' + self._action_timeout
                     + '-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:monitor rc:not running op_status:Cancelled" ',
                     expected_exitcode=ExitStatus.ERROR)
        test.add_cmd(args='-c unregister_rsc -r test_rsc ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:unregister rsc_id:test_rsc action:none rc:ok op_status:Done" ')

        # Attempt to invoke non-existent rsc id
        test = self.new_test("invoke_non_existent_rsc", "Attempt to perform operations on a non-existent rsc id.")
        test.add_cmd(args='-c exec -r test_rsc -a start ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:start rc:error op_status:Done" ',
                     expected_exitcode=ExitStatus.ERROR)
        test.add_cmd(args='-c exec -r test_rsc -a stop ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:stop rc:ok op_status:Done" ',
                     expected_exitcode=ExitStatus.ERROR)
        test.add_cmd(args='-c exec -r test_rsc -a monitor -i 6s ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:monitor rc:ok op_status:Done" ',
                     expected_exitcode=ExitStatus.ERROR)
        test.add_cmd(args='-c cancel -r test_rsc -a start ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:start rc:ok op_status:Cancelled" ',
                     expected_exitcode=ExitStatus.ERROR)
        test.add_cmd(args='-c unregister_rsc -r test_rsc ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:unregister rsc_id:test_rsc action:none rc:ok op_status:Done" ')

        # Register and start a resource that doesn't exist, systemd
        if "systemd" in self._rsc_classes:
            test = self.new_test("start_uninstalled_systemd", "Register uninstalled systemd agent, try to start, verify expected failure")
            test.add_cmd(args='-c register_rsc -r test_rsc -C systemd -T this_is_fake1234 ' + self._action_timeout
                         + '-l "NEW_EVENT event_type:register rsc_id:test_rsc action:none rc:ok op_status:Done" ')
            test.add_cmd(args='-c exec -r test_rsc -a start ' + self._action_timeout
                         + '-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:start rc:not installed op_status:Not installed" ')
            test.add_cmd(args='-c unregister_rsc -r test_rsc ' + self._action_timeout
                         + '-l "NEW_EVENT event_type:unregister rsc_id:test_rsc action:none rc:ok op_status:Done" ')

        # Register and start a resource that doesn't exist, ocf
        test = self.new_test("start_uninstalled_ocf", "Register uninstalled ocf agent, try to start, verify expected failure.")
        test.add_cmd(args='-c register_rsc -r test_rsc -C ocf -P pacemaker -T this_is_fake1234 ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:register rsc_id:test_rsc action:none rc:ok op_status:Done" ')
        test.add_cmd(args='-c exec -r test_rsc -a start ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:start rc:not installed op_status:Not installed" ')
        test.add_cmd(args='-c unregister_rsc -r test_rsc ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:unregister rsc_id:test_rsc action:none rc:ok op_status:Done" ')

        # Register ocf with non-existent provider
        test = self.new_test("start_ocf_bad_provider", "Register ocf agent with a non-existent provider, verify expected failure.")
        test.add_cmd(args='-c register_rsc -r test_rsc -C ocf -P pancakes -T Dummy ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:register rsc_id:test_rsc action:none rc:ok op_status:Done" ')
        test.add_cmd(args='-c exec -r test_rsc -a start ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:start rc:not installed op_status:Not installed" ')
        test.add_cmd(args='-c unregister_rsc -r test_rsc ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:unregister rsc_id:test_rsc action:none rc:ok op_status:Done" ')

        # Register ocf with empty provider field
        test = self.new_test("start_ocf_no_provider", "Register ocf agent with a no provider, verify expected failure.")
        test.add_cmd(args='-c register_rsc -r test_rsc -C ocf -T Dummy ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:register rsc_id:test_rsc action:none rc:ok op_status:Done" ',
                     expected_exitcode=ExitStatus.ERROR)
        test.add_cmd(args='-c exec -r test_rsc -a start ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:start rc:ok op_status:Error" ',
                     expected_exitcode=ExitStatus.ERROR)
        test.add_cmd(args='-c unregister_rsc -r test_rsc ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:unregister rsc_id:test_rsc action:none rc:ok op_status:Done" ')

    def build_stress_tests(self):
        """Register stress tests."""
        timeout = "-t 20000"

        iterations = 25
        test = self.new_test("ocf_stress", "Verify OCF agent handling works under load")
        for i in range(iterations):
            test.add_cmd(args='-c register_rsc -r rsc_%s %s -C ocf -P heartbeat -T Dummy -l "NEW_EVENT event_type:register rsc_id:rsc_%s action:none rc:ok op_status:Done"' % (i, timeout, i))
            test.add_cmd(args='-c exec -r rsc_%s -a start %s -l "NEW_EVENT event_type:exec_complete rsc_id:rsc_%s action:start rc:ok op_status:Done"' % (i, timeout, i))
            test.add_cmd(args='-c exec -r rsc_%s -a monitor %s -i 1s '
                         '-l "NEW_EVENT event_type:exec_complete rsc_id:rsc_%s action:monitor rc:ok op_status:Done"' % (i, timeout, i))
        for i in range(iterations):
            test.add_cmd(args='-c exec -r rsc_%s -a stop %s  -l "NEW_EVENT event_type:exec_complete rsc_id:rsc_%s action:stop rc:ok op_status:Done"' % (i, timeout, i))
            test.add_cmd(args='-c unregister_rsc -r rsc_%s %s -l "NEW_EVENT event_type:unregister rsc_id:rsc_%s action:none rc:ok op_status:Done"' % (i, timeout, i))

        if "systemd" in self._rsc_classes:
            test = self.new_test("systemd_stress", "Verify systemd dbus connection works under load")
            for i in range(iterations):
                test.add_cmd(args='-c register_rsc -r rsc_%s %s -C systemd -T pacemaker-cts-dummyd@3 -l "NEW_EVENT event_type:register rsc_id:rsc_%s action:none rc:ok op_status:Done"' % (i, timeout, i))
                test.add_cmd(args='-c exec -r rsc_%s -a start %s -l "NEW_EVENT event_type:exec_complete rsc_id:rsc_%s action:start rc:ok op_status:Done"' % (i, timeout, i))
                test.add_cmd(args='-c exec -r rsc_%s -a monitor %s -i 1s '
                             '-l "NEW_EVENT event_type:exec_complete rsc_id:rsc_%s action:monitor rc:ok op_status:Done"' % (i, timeout, i))

            for i in range(iterations):
                test.add_cmd(args='-c exec -r rsc_%s -a stop %s -l "NEW_EVENT event_type:exec_complete rsc_id:rsc_%s action:stop rc:ok op_status:Done"' % (i, timeout, i))
                test.add_cmd(args='-c unregister_rsc -r rsc_%s %s -l "NEW_EVENT event_type:unregister rsc_id:rsc_%s action:none rc:ok op_status:Done"' % (i, timeout, i))

        iterations = 9
        timeout = "-t 30000"
        # Verify recurring op in-flight collision is handled in series properly
        test = self.new_test("rsc_inflight_collision", "Verify recurring ops do not collide with other operations for the same rsc.")
        test.add_cmd(args='-c register_rsc -r test_rsc -P pacemaker -C ocf -T Dummy '
                     '-l "NEW_EVENT event_type:register rsc_id:test_rsc action:none rc:ok op_status:Done" ' + self._action_timeout)
        test.add_cmd(args='-c exec -r test_rsc -a start %s -k op_sleep -v 1 -l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:start rc:ok op_status:Done"' % timeout)
        for i in range(iterations):
            test.add_cmd(args='-c exec -r test_rsc -a monitor %s -i 100%dms -k op_sleep -v 2 '
                         '-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:monitor rc:ok op_status:Done"' % (timeout, i))

        test.add_cmd(args='-c exec -r test_rsc -a stop %s -l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:stop rc:ok op_status:Done"' % timeout)
        test.add_cmd(args='-c unregister_rsc -r test_rsc %s -l "NEW_EVENT event_type:unregister rsc_id:test_rsc action:none rc:ok op_status:Done"' % timeout)

    def build_custom_tests(self):
        """Register tests that target specific cases."""
        # verify resource temporary folder is created and used by OCF agents
        test = self.new_test("rsc_tmp_dir", "Verify creation and use of rsc temporary state directory")
        test.add_cmd("ls", args="-al %s" % BuildOptions.RSC_TMP_DIR)
        test.add_cmd(args='-c register_rsc -r test_rsc -P heartbeat -C ocf -T Dummy '
                     '-l "NEW_EVENT event_type:register rsc_id:test_rsc action:none rc:ok op_status:Done" ' + self._action_timeout)
        test.add_cmd(args='-c exec -r test_rsc -a start -t 4000')
        test.add_cmd("ls", args="-al %s" % BuildOptions.RSC_TMP_DIR)
        test.add_cmd("ls", args="%s/Dummy-test_rsc.state" % BuildOptions.RSC_TMP_DIR)
        test.add_cmd(args='-c exec -r test_rsc -a stop -t 4000')
        test.add_cmd(args='-c unregister_rsc -r test_rsc ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:unregister rsc_id:test_rsc action:none rc:ok op_status:Done" ')

        # start delay then stop test
        test = self.new_test("start_delay", "Verify start delay works as expected.")
        test.add_cmd(args='-c register_rsc -r test_rsc -P pacemaker -C ocf -T Dummy '
                     '-l "NEW_EVENT event_type:register rsc_id:test_rsc action:none rc:ok op_status:Done" ' + self._action_timeout)
        test.add_cmd(args='-c exec -r test_rsc -s 6000 -a start -w -t 6000')
        test.add_cmd(args='-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:start rc:ok op_status:Done" -t 2000',
                     expected_exitcode=ExitStatus.TIMEOUT)
        test.add_cmd(args='-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:start rc:ok op_status:Done" -t 6000')
        test.add_cmd(args='-c exec -r test_rsc -a stop ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:stop rc:ok op_status:Done" ')
        test.add_cmd(args='-c unregister_rsc -r test_rsc ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:unregister rsc_id:test_rsc action:none rc:ok op_status:Done" ')

        # start delay, but cancel before it gets a chance to start
        test = self.new_test("start_delay_cancel", "Using start_delay, start a rsc, but cancel the start op before execution.")
        test.add_cmd(args='-c register_rsc -r test_rsc -P pacemaker -C ocf -T Dummy '
                     '-l "NEW_EVENT event_type:register rsc_id:test_rsc action:none rc:ok op_status:Done" ' + self._action_timeout)
        test.add_cmd(args='-c exec -r test_rsc -s 5000 -a start -w -t 4000')
        test.add_cmd(args='-c cancel -r test_rsc -a start ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:start rc:ok op_status:Cancelled" ')
        test.add_cmd(args='-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:start rc:ok op_status:Done" -t 5000',
                     expected_exitcode=ExitStatus.TIMEOUT)
        test.add_cmd(args='-c unregister_rsc -r test_rsc ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:unregister rsc_id:test_rsc action:none rc:ok op_status:Done" ')

        # Register a bunch of resources, verify we can get info on them
        test = self.new_test("verify_get_rsc_info", "Register multiple resources, verify retrieval of rsc info.")
        if "systemd" in self._rsc_classes:
            test.add_cmd(args='-c register_rsc -r rsc1 -C systemd -T pacemaker-cts-dummyd@3 ' + self._action_timeout)
            test.add_cmd(args='-c get_rsc_info -r rsc1 ')
            test.add_cmd(args='-c unregister_rsc -r rsc1 ' + self._action_timeout)
            test.add_cmd(args='-c get_rsc_info -r rsc1 ', expected_exitcode=ExitStatus.ERROR)

        test.add_cmd(args='-c register_rsc -r rsc2 -C ocf -T Dummy -P pacemaker ' + self._action_timeout)
        test.add_cmd(args='-c get_rsc_info -r rsc2 ')
        test.add_cmd(args='-c unregister_rsc -r rsc2 ' + self._action_timeout)
        test.add_cmd(args='-c get_rsc_info -r rsc2 ', expected_exitcode=ExitStatus.ERROR)

        # Register duplicate, verify only one entry exists and can still be removed
        test = self.new_test("duplicate_registration", "Register resource multiple times, verify only one entry exists and can be removed.")
        test.add_cmd(args='-c register_rsc -r rsc2 -C ocf -T Dummy -P pacemaker ' + self._action_timeout)
        test.add_cmd(args="-c get_rsc_info -r rsc2 ",
                     stdout_match="id:rsc2 class:ocf provider:pacemaker type:Dummy")
        test.add_cmd(args='-c register_rsc -r rsc2 -C ocf -T Dummy -P pacemaker ' + self._action_timeout)
        test.add_cmd(args="-c get_rsc_info -r rsc2 ",
                     stdout_match="id:rsc2 class:ocf provider:pacemaker type:Dummy")
        test.add_cmd(args='-c register_rsc -r rsc2 -C ocf -T Stateful -P pacemaker ' + self._action_timeout)
        test.add_cmd(args="-c get_rsc_info -r rsc2 ",
                     stdout_match="id:rsc2 class:ocf provider:pacemaker type:Stateful")
        test.add_cmd(args='-c unregister_rsc -r rsc2 ' + self._action_timeout)
        test.add_cmd(args='-c get_rsc_info -r rsc2 ', expected_exitcode=ExitStatus.ERROR)

        # verify the option to only send notification to the original client
        test = self.new_test("notify_orig_client_only", "Verify option to only send notifications to the client originating the action.")
        test.add_cmd(args='-c register_rsc -r test_rsc -C ocf -P pacemaker -T Dummy ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:register rsc_id:test_rsc action:none rc:ok op_status:Done" ')
        test.add_cmd(args='-c exec -r test_rsc -a start ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:start rc:ok op_status:Done" ')
        test.add_cmd(args='-c exec -r test_rsc -a monitor -i 1s ' + self._action_timeout + ' -n '
                     '-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:monitor rc:ok op_status:Done"')
        # this will fail because the monitor notifications should only go to the original caller, which no longer exists.
        test.add_cmd(args='-l "NEW_EVENT event_type:exec_complete rsc_id:test_rsc action:monitor rc:ok op_status:Done" ' + self._action_timeout,
                     expected_exitcode=ExitStatus.TIMEOUT)
        test.add_cmd(args='-c cancel -r test_rsc -a monitor -i 1s -t 6000 ')
        test.add_cmd(args='-c unregister_rsc -r test_rsc ' + self._action_timeout
                     + '-l "NEW_EVENT event_type:unregister rsc_id:test_rsc action:none rc:ok op_status:Done" ')

        # get metadata
        test = self.new_test("get_ocf_metadata", "Retrieve metadata for a resource")
        test.add_cmd(args="-c metadata -C ocf -P pacemaker -T Dummy",
                     stdout_match="resource-agent name=\"Dummy\"")
        test.add_cmd(args="-c metadata -C ocf -P pacemaker -T Stateful")
        test.add_cmd(args="-c metadata -P pacemaker -T Stateful", expected_exitcode=ExitStatus.ERROR)
        test.add_cmd(args="-c metadata -C ocf -P pacemaker -T fake_agent", expected_exitcode=ExitStatus.ERROR)

        # get stonith metadata
        test = self.new_test("get_stonith_metadata", "Retrieve stonith metadata for a resource")
        test.add_cmd(args="-c metadata -C stonith -P pacemaker -T fence_dummy",
                     stdout_match="resource-agent name=\"fence_dummy\"")

        # get lsb metadata
        if "lsb" in self._rsc_classes:
            test = self.new_test("get_lsb_metadata",
                                 "Retrieve metadata for an LSB resource")
            test.add_cmd(args="-c metadata -C lsb -T LSBDummy",
                         stdout_match="resource-agent name='LSBDummy'")

        # get metadata
        if "systemd" in self._rsc_classes:
            test = self.new_test("get_systemd_metadata", "Retrieve metadata for a resource")
            test.add_cmd(args="-c metadata -C systemd -T pacemaker-cts-dummyd@",
                         stdout_match="resource-agent name=\"pacemaker-cts-dummyd@\"")

        # get ocf providers
        test = self.new_test("list_ocf_providers",
                             "Retrieve list of available resource providers, verifies pacemaker is a provider.")
        test.add_cmd(args="-c list_ocf_providers ", stdout_match="pacemaker")
        test.add_cmd(args="-c list_ocf_providers -T ping", stdout_match="pacemaker")

        # Verify agents only exist in their lists
        test = self.new_test("verify_agent_lists", "Verify the agent lists contain the right data.")

        if "ocf" in self._rsc_classes:
            test.add_cmd(args="-c list_agents ", stdout_match="Stateful")
            test.add_cmd(args="-c list_agents -C ocf", stdout_match="Stateful",
                         stdout_no_match="pacemaker-cts-dummyd@|fence_dummy")

        if "service" in self._rsc_classes:
            test.add_cmd(args="-c list_agents -C service", stdout_match="",
                         stdout_no_match="Stateful|fence_dummy")

        if "lsb" in self._rsc_classes:
            test.add_cmd(args="-c list_agents", stdout_match="LSBDummy")
            test.add_cmd(args="-c list_agents -C lsb", stdout_match="LSBDummy",
                         stdout_no_match="pacemaker-cts-dummyd@|Stateful|fence_dummy")
            test.add_cmd(args="-c list_agents -C service", stdout_match="LSBDummy")

        if "systemd" in self._rsc_classes:
            test.add_cmd(args="-c list_agents ", stdout_match="pacemaker-cts-dummyd@")                         # systemd
            test.add_cmd(args="-c list_agents -C systemd", stdout_match="", stdout_no_match="Stateful")        # should not exist
            test.add_cmd(args="-c list_agents -C systemd", stdout_match="pacemaker-cts-dummyd@")
            test.add_cmd(args="-c list_agents -C systemd", stdout_match="", stdout_no_match="fence_dummy")     # should not exist

        if "stonith" in self._rsc_classes:
            test.add_cmd(args="-c list_agents -C stonith", stdout_match="fence_dummy")                         # stonith
            test.add_cmd(args="-c list_agents -C stonith", stdout_match="",                                    # should not exist
                         stdout_no_match="pacemaker-cts-dummyd@")
            test.add_cmd(args="-c list_agents -C stonith", stdout_match="", stdout_no_match="Stateful")        # should not exist
            test.add_cmd(args="-c list_agents ", stdout_match="fence_dummy")


def build_options():
    """Handle command line arguments."""
    parser = argparse.ArgumentParser(formatter_class=argparse.RawDescriptionHelpFormatter,
                                     description="Run pacemaker-execd regression tests",
                                     epilog="Example: Run only the test 'start_stop'\n"
                                            "\t " + sys.argv[0] + " --run-only start_stop\n\n"
                                            "Example: Run only the tests with the string 'systemd' present in them\n"
                                            "\t " + sys.argv[0] + " --run-only-pattern systemd")
    parser.add_argument("-l", "--list-tests", action="store_true",
                        help="Print out all registered tests")
    parser.add_argument("-p", "--run-only-pattern", metavar='PATTERN',
                        help="Run only tests matching the given pattern")
    parser.add_argument("-r", "--run-only", metavar='TEST',
                        help="Run a specific test")
    parser.add_argument("-t", "--timeout", type=float, default=2,
                        help="Up to how many seconds each test case waits for the daemon to "
                             "be initialized.  Defaults to 2.  The value 0 means no limit.")
    parser.add_argument("-w", "--force-wait", action="store_true",
                        help="Each test case waits the default/specified --timeout for the "
                             "daemon without tracking the log")
    if BuildOptions.REMOTE_ENABLED:
        parser.add_argument("-R", "--pacemaker-remote", action="store_true",
                            help="Test pacemaker-remoted binary instead of pacemaker-execd")
    parser.add_argument("-V", "--verbose", action="store_true",
                        help="Verbose output")

    args = parser.parse_args()
    return args


def main():
    """Run pacemaker-execd regression tests as specified by arguments."""
    update_path()

    # Ensure all command output is in portable locale for comparison
    os.environ['LC_ALL'] = "C"

    opts = build_options()

    if opts.pacemaker_remote:
        exit_if_proc_running("pacemaker-remoted")
    else:
        exit_if_proc_running("corosync")
        exit_if_proc_running("pacemaker-execd")
        exit_if_proc_running("pacemaker-fenced")

    # Create a temporary directory for log files (the directory will
    # automatically be erased when done)
    with tempfile.TemporaryDirectory(prefix="cts-exec-") as logdir:
        tests = ExecTests(verbose=opts.verbose, tls=opts.pacemaker_remote,
                          timeout=opts.timeout, force_wait=opts.force_wait,
                          logdir=logdir)

        tests.build_generic_tests()
        tests.build_multi_rsc_tests()
        tests.build_negative_tests()
        tests.build_custom_tests()
        tests.build_stress_tests()

        if opts.list_tests:
            tests.print_list()
            sys.exit(ExitStatus.OK)

        print("Starting ...")

        tests.setup_environment()

        if opts.run_only_pattern:
            tests.run_tests_matching(opts.run_only_pattern)
            tests.print_results()
        elif opts.run_only:
            tests.run_single(opts.run_only)
            tests.print_results()
        else:
            tests.run_tests()
            tests.print_results()

        tests.cleanup_environment()

    tests.exit()


if __name__ == "__main__":
    main()
