DistributorTestCase Class Reference

Inheritance diagram for DistributorTestCase:

Public Member Functions
	setUp (self)
	testConnectAndDisconnect (self)
	testEvents (self)
	testEndRun (self)
	tearDown (self)
	assertIsDown (self, name, timeout=5, minimum_delay=0.1)
	assertIsRunning (self, name)
	assertMonitoring (self, socket, search_key, search_value, timeout=10)
	assertIsAndGet (self, socket, message_type, final=True, router=False)
	assertIsMsgType (self, socket, message_type, final=True, router=False)
	assertNothingMore (self, socket)
	assertHasOutputFile (self, output_file, unlink=True, timeout=0.5, minimum_delay=0.1)
	assertNotHasOutputFile (self, output_file, timeout=0.5)

Static Public Member Functions
	get_free_port ()
	create_socket (port, socket_type=zmq.DEALER, identity="socket", bind=False)
	create_router_socket (port)
	send (socket, message_type, first_data=b"", second_data=b"", identity="")
	recv (socket)

Public Attributes
	input_port = HLTZMQTestCase.get_free_port()
	input_port
	output_port = HLTZMQTestCase.get_free_port()
	output_port
	monitoring_port = HLTZMQTestCase.get_free_port()
	monitoring_port
	test_dir = tempfile.mkdtemp()
	use a temporary folder for testing
	previous_dir = os.getcwd()
	remember current working directory
	started_programs = dict()
	dict for all started programs
	tearDown = subprocess.Popen(command, start_new_session=True)

Static Public Attributes
	event_data = open(basf2.find_file("daq/hbasf2/tests/out.raw"), "br").read()
	event_data
	ctx = zmq.Context()
	The ZMQ context.
	needed_programs = dict()
	The dict name -> cmd args of the programs to start, needs to be set in each test.

Protected Member Functions
	_is_running (self, name)

Detailed Description

Test case

Definition at line 17 of file test_distributor.py.

Member Function Documentation

_is_running()

_is_running ( self, name )

protectedinherited

Check if a given program is still running.

Definition at line 84 of file test_support.py.

    def _is_running(self, name):
        """
        Check if a given program is still running.
        """
        process = self.started_programs[name]
        pid, sts = process._try_wait(os.WNOHANG)
        assert pid == process.pid or pid == 0
        return pid == 0
 

assertHasOutputFile()

assertHasOutputFile ( self, output_file, unlink = True, timeout = 0.5, minimum_delay = 0.1 )

inherited

Assert that - at least after the given timeout - the output file
is present. If unlink is set to True, remove the file after checking.

Definition at line 227 of file test_support.py.

    def assertHasOutputFile(self, output_file, unlink=True, timeout=0.5, minimum_delay=0.1):
        """
        Assert that - at least after the given timeout - the output file
        is present. If unlink is set to True, remove the file after checking.
        """
        endtime = time() + timeout
 
        while True:
            if os.path.exists(output_file):
                if unlink:
                    os.unlink(output_file)
                return
 
            remaining = endtime - time()
            self.assertFalse(remaining <= 0)
 
            sleep(minimum_delay)
 

assertIsAndGet()

assertIsAndGet ( self, socket, message_type, final = True, router = False )

inherited

Assert that the next message received on the socket has the given message type.
If final is set to True, also assert that there is no additional message on the socket.
Use router only for router sockets.

Definition at line 200 of file test_support.py.

    def assertIsAndGet(self, socket, message_type, final=True, router=False):
        """
        Assert that the next message received on the socket has the given message type.
        If final is set to True, also assert that there is no additional message on the socket.
        Use router only for router sockets.
        """
        answer = HLTZMQTestCase.recv(socket)
        type_index = 0
        if router:
            type_index = 1
        self.assertEqual(answer[type_index], message_type.encode())
        if final:
            self.assertNothingMore(socket)
        return answer
 

assertIsDown()

assertIsDown ( self, name, timeout = 5, minimum_delay = 0.1 )

inherited

Test helper to assert the given program has terminated - at least after timeout in seconds has passed.
Checks every "minimal_delay seconds.

Definition at line 93 of file test_support.py.

    def assertIsDown(self, name, timeout=5, minimum_delay=0.1):
        """
        Test helper to assert the given program has terminated - at least after timeout in seconds has passed.
        Checks every "minimal_delay seconds.
        """
        endtime = time() + timeout
        while True:
            if not self._is_running(name):
                return
 
            remaining = endtime - time()
            self.assertFalse(remaining <= 0)
 
            sleep(minimum_delay)
 

assertIsMsgType()

assertIsMsgType ( self, socket, message_type, final = True, router = False )

inherited

Deprecated copy of "assertIsAndGet".

Definition at line 215 of file test_support.py.

    def assertIsMsgType(self, socket, message_type, final=True, router=False):
        """
        Deprecated copy of "assertIsAndGet".
        """
        return self.assertIsAndGet(socket, message_type, final=final, router=router)
 

assertIsRunning()

assertIsRunning ( self, name )

inherited

Assert that a given program is still running.

Definition at line 108 of file test_support.py.

    def assertIsRunning(self, name):
        """
        Assert that a given program is still running.
        """
        self.assertTrue(self._is_running(name))
 

assertMonitoring()

assertMonitoring ( self, socket, search_key, search_value, timeout = 10 )

inherited

Ask the given socket for a monitoring JSON and make sure, the value related to "search_key"
is set to "search_value" - at least after the given timeout.
The search key can should be in the form "<category>.<key>".

Definition at line 169 of file test_support.py.

    def assertMonitoring(self, socket, search_key, search_value, timeout=10):
        """
        Ask the given socket for a monitoring JSON and make sure, the value related to "search_key"
        is set to "search_value" - at least after the given timeout.
        The search key can should be in the form "<category>.<key>".
        """
        end_time = time() + timeout
        monitoring = dict()
        while time() < end_time:
            HLTZMQTestCase.send(socket, "m")
            answer = self.assertIsAndGet(socket, "c")
 
            dict_monitoring = json.loads(answer[1])
            for parent_key, parent_dict in dict_monitoring.items():
                for key, value in parent_dict.items():
                    monitoring[parent_key + "." + key] = value
 
            if search_key in monitoring and monitoring[search_key] == search_value:
                break
        else:
            if monitoring:
                if search_key not in monitoring:
                    raise AssertionError(f"Monitoring did not have a result with key {search_key}")
                else:
                    raise AssertionError(
                        f"Monitoring did not show the result {search_value} for {search_key}, instead {monitoring[search_key]}")
            else:
                raise AssertionError("Monitoring did not answer in time.")
 
        self.assertNothingMore(socket)
 

assertNotHasOutputFile()

assertNotHasOutputFile ( self, output_file, timeout = 0.5 )

inherited

Assert that after the timeout the given file is not present
(a.k.a. no process has created it)

Definition at line 245 of file test_support.py.

    def assertNotHasOutputFile(self, output_file, timeout=0.5):
        """
        Assert that after the timeout the given file is not present
        (a.k.a. no process has created it)
        """
        sleep(timeout)
        self.assertFalse(os.path.exists(output_file))
 
 

assertNothingMore()

assertNothingMore ( self, socket )

inherited

Assert that there is no pending message to be received on the socket.

Definition at line 221 of file test_support.py.

    def assertNothingMore(self, socket):
        """
        Assert that there is no pending message to be received on the socket.
        """
        self.assertFalse(socket.poll(0))
 

create_router_socket()

create_router_socket ( port )

staticinherited

Shortcut to create a ROUTER type socket with the typical parameters
binding to the given port.

Definition at line 140 of file test_support.py.

    def create_router_socket(port):
        """
        Shortcut to create a ROUTER type socket with the typical parameters
        binding to the given port.
        """
        return HLTZMQTestCase.create_socket(port, socket_type=zmq.ROUTER, identity="", bind=True)
 

create_socket()

create_socket ( port, socket_type = zmq.DEALER, identity = "socket", bind = False )

staticinherited

Create and return a ZMQ socket with the given type and identity and
bind or connect it to localhost and the given port.

Definition at line 115 of file test_support.py.

    def create_socket(port, socket_type=zmq.DEALER, identity="socket", bind=False):
        """
        Create and return a ZMQ socket with the given type and identity and
        bind or connect it to localhost and the given port.
        """
        socket = HLTZMQTestCase.ctx.socket(socket_type)
        socket.rcvtimeo = 10000
        socket.linger = 0
        if identity:
            socket.setsockopt_string(zmq.IDENTITY, identity)
        if bind:
            if port is None:
                port = socket.bind_to_random_port("tcp://*")
                return socket, port
            else:
                socket.bind(f"tcp://*:{port}")
        else:
            if port is None:
                raise RuntimeError("Cannot connect to unknown port")
 
            socket.connect(f"tcp://localhost:{port}")
 
        return socket
 

get_free_port()

get_free_port ( )

staticinherited

Get a free port number by reusing ZMQ's function for this.

Definition at line 41 of file test_support.py.

    def get_free_port():
        """
        Get a free port number by reusing ZMQ's function for this.
        """
        socket = HLTZMQTestCase.ctx.socket(zmq.ROUTER)
        port = socket.bind_to_random_port("tcp://*")
        socket.close()
        return port
 

recv()

recv ( socket )

staticinherited

Try to receive a message from the socket (or throw an assertion error if none comes after the set timeout
of the socket).

Definition at line 159 of file test_support.py.

    def recv(socket):
        """
        Try to receive a message from the socket (or throw an assertion error if none comes after the set timeout
        of the socket).
        """
        try:
            return socket.recv_multipart()
        except zmq.error.Again:
            raise AssertionError("No answer from socket")
 

send()

send ( socket, message_type, first_data = b"", second_data = b"", identity = "" )

staticinherited

Send a message consisting of the message type, the first and the second data
either to the identity if given or without identity if omitted.

Definition at line 148 of file test_support.py.

    def send(socket, message_type, first_data=b"", second_data=b"", identity=""):
        """
        Send a message consisting of the message type, the first and the second data
        either to the identity if given or without identity if omitted.
        """
        if identity:
            socket.send_multipart([identity.encode(), message_type.encode(), first_data, second_data])
        else:
            socket.send_multipart([message_type.encode(), first_data, second_data])
 

setUp()

setUp

(

self

)

Setup port numbers and necessary programs

Reimplemented from HLTZMQTestCase.

Definition at line 22 of file test_distributor.py.

    def setUp(self):
        """Setup port numbers and necessary programs"""
        
        self.input_port = HLTZMQTestCase.get_free_port()
        
        self.output_port = HLTZMQTestCase.get_free_port()
        
        self.monitoring_port = HLTZMQTestCase.get_free_port()
        
        self.needed_programs = {
            "distributor": [
                "b2hlt_distributor",
                "--input", f"tcp://localhost:{self.input_port}",
                "--output", f"tcp://*:{self.output_port}",
                "--monitor", f"tcp://*:{self.monitoring_port}",
                "--stopWaitingTime", "1"]}
        super().setUp()
 

tearDown()

tearDown ( self )

inherited

Custom tearDown function to kill the started programs if still present
and remove the temporary folder again.

Definition at line 70 of file test_support.py.

    def tearDown(self):
        """
        Custom tearDown function to kill the started programs if still present
        and remove the temporary folder again.
        """
        for name, process in self.started_programs.items():
            if self._is_running(name):
                os.killpg(process.pid, signal.SIGKILL)
            process.wait()
        os.chdir(self.previous_dir)
        shutil.rmtree(self.test_dir)
 
        atexit._clear()
 

testConnectAndDisconnect()

testConnectAndDisconnect

(

self

)

test function

Definition at line 40 of file test_distributor.py.

    def testConnectAndDisconnect(self):
        """test function"""
        monitoring_socket = self.create_socket(self.monitoring_port)
 
        self.assertMonitoring(monitoring_socket, "input.socket_state", "disconnected")
        self.assertMonitoring(monitoring_socket, "input.socket_connects", 0)
        self.assertMonitoring(monitoring_socket, "input.socket_disconnects", 0)
 
        # To make it actually look for input messages, it needs at least a single worker
        output_socket = self.create_socket(self.output_port)
        for _ in range(5):
            self.send(output_socket, "r")
 
        # Now we can go on
        input_socket = self.create_socket(self.input_port, socket_type=zmq.STREAM, bind=True)
 
        # Still no connection
        self.assertMonitoring(monitoring_socket, "input.socket_state", "disconnected")
        self.assertMonitoring(monitoring_socket, "input.socket_connects", 0)
        self.assertMonitoring(monitoring_socket, "input.socket_disconnects", 0)
 
        # This should initiate a connection
        identity, _ = self.recv(input_socket)
 
        self.assertMonitoring(monitoring_socket, "input.socket_state", "connected")
        self.assertMonitoring(monitoring_socket, "input.socket_connects", 1)
        self.assertMonitoring(monitoring_socket, "input.socket_disconnects", 0)
 
        # And we can also close it again
        input_socket.close()
 
        self.assertMonitoring(monitoring_socket, "input.socket_state", "disconnected")
        self.assertMonitoring(monitoring_socket, "input.socket_connects", 1)
        self.assertMonitoring(monitoring_socket, "input.socket_disconnects", 1)
 
        # or open
        input_socket = self.create_socket(self.input_port, socket_type=zmq.STREAM, bind=True)
        identity, _ = self.recv(input_socket)
 
        self.assertMonitoring(monitoring_socket, "input.socket_state", "connected")
        self.assertMonitoring(monitoring_socket, "input.socket_connects", 2)
        self.assertMonitoring(monitoring_socket, "input.socket_disconnects", 1)
 
        # sending an event should not change anything
        input_socket.send_multipart([identity, self.event_data])
        input_socket.send_multipart([identity, self.event_data])
        input_socket.send_multipart([identity, self.event_data])
        input_socket.send_multipart([identity, self.event_data])
 
        self.assertMonitoring(monitoring_socket, "input.received_events", 4)
 
        self.assertMonitoring(monitoring_socket, "input.socket_state", "connected")
        self.assertMonitoring(monitoring_socket, "input.socket_connects", 2)
        self.assertMonitoring(monitoring_socket, "input.socket_disconnects", 1)
 
        input_socket.close()
 
        self.assertMonitoring(monitoring_socket, "input.socket_state", "disconnected")
        self.assertMonitoring(monitoring_socket, "input.socket_connects", 2)
        self.assertMonitoring(monitoring_socket, "input.socket_disconnects", 2)
 

testEndRun()

testEndRun

(

self

)

test function

Definition at line 194 of file test_distributor.py.

    def testEndRun(self):
        """test function"""
        monitoring_socket = self.create_socket(self.monitoring_port)
 
        # Start two workers
        output_socket = self.create_socket(self.output_port)
        second_output_socket = self.create_socket(self.output_port, identity="other_socket")
 
        self.assertMonitoring(monitoring_socket, "output.ready_queue_size", 0)
        self.assertMonitoring(monitoring_socket, "output.registered_workers", 0)
 
        # and register them by sending a ready
        self.send(output_socket, "r")
        self.send(second_output_socket, "r")
 
        self.assertMonitoring(monitoring_socket, "output.ready_queue_size", 2)
        self.assertMonitoring(monitoring_socket, "output.registered_workers", 2)
 
        # a stop run should be sent to all workers
        self.send(monitoring_socket, "l")
 
        self.assertIsMsgType(output_socket, "l")
        self.assertIsMsgType(second_output_socket, "l")
 
        # also multiple times
        self.send(monitoring_socket, "l")
 
        self.assertIsMsgType(output_socket, "l")
        self.assertIsMsgType(second_output_socket, "l")
 
        # and if there are events in between they should not be transported
        input_socket = self.create_socket(self.input_port, socket_type=zmq.STREAM, bind=True)
        identity, _ = self.recv(input_socket)
        input_socket.send_multipart([identity, self.event_data])
        input_socket.send_multipart([identity, self.event_data])
 
        self.assertNothingMore(output_socket)
        self.assertNothingMore(second_output_socket)
 
        # it shouldn't matter
        self.send(monitoring_socket, "l")
 
        self.assertIsMsgType(output_socket, "l")
        self.assertIsMsgType(second_output_socket, "l")
 
        # A terminate message should also be sent
        self.send(monitoring_socket, "x")
 
        self.assertIsMsgType(output_socket, "x")
        self.assertIsMsgType(second_output_socket, "x")
 
        # and the distributor should go down
        self.assertIsDown("distributor")
 
 

testEvents()

testEvents

(

self

)

test function

Definition at line 101 of file test_distributor.py.

    def testEvents(self):
        """test function"""
        monitoring_socket = self.create_socket(self.monitoring_port)
 
        # connect the input
        input_socket = self.create_socket(self.input_port, socket_type=zmq.STREAM, bind=True)
        identity, _ = self.recv(input_socket)
 
        # Start two workers
        output_socket = self.create_socket(self.output_port)
        second_output_socket = self.create_socket(self.output_port, identity="other_socket")
 
        self.assertMonitoring(monitoring_socket, "output.ready_queue_size", 0)
        self.assertMonitoring(monitoring_socket, "output.registered_workers", 0)
 
        # Every ready should give us an event at exactly this worker, when there is an event
 
        # 1. only send ready message
        self.send(output_socket, "r")
 
        # No event
        self.assertNothingMore(output_socket)
        self.assertNothingMore(second_output_socket)
 
        # But ready worker
        self.assertMonitoring(monitoring_socket, "output.ready_queue_size", 1)
        self.assertMonitoring(monitoring_socket, "output.registered_workers", 1)
        self.assertMonitoring(monitoring_socket, "output.ready_messages[socket]", 1)
        self.assertMonitoring(monitoring_socket, "input.socket_state", "connected")
        self.assertMonitoring(monitoring_socket, "input.socket_connects", 1)
        self.assertMonitoring(monitoring_socket, "input.socket_disconnects", 0)
 
        # Now the event
        input_socket.send_multipart([identity, self.event_data])
 
        self.assertIsMsgType(output_socket, "u")
        self.assertNothingMore(second_output_socket)
 
        # And no ready worker
        self.assertMonitoring(monitoring_socket, "output.ready_queue_size", 0)
        self.assertMonitoring(monitoring_socket, "output.registered_workers", 1)
        self.assertMonitoring(monitoring_socket, "output.ready_messages[socket]", 0)
        self.assertMonitoring(monitoring_socket, "input.socket_state", "connected")
        self.assertMonitoring(monitoring_socket, "input.socket_connects", 1)
        self.assertMonitoring(monitoring_socket, "input.socket_disconnects", 0)
 
        # 2. Try out sending the event first
        input_socket.send_multipart([identity, self.event_data])
 
        # Still no event
        self.assertNothingMore(output_socket)
        self.assertNothingMore(second_output_socket)
 
        # And no updated monitoring
        self.assertMonitoring(monitoring_socket, "output.ready_queue_size", 0)
        self.assertMonitoring(monitoring_socket, "output.registered_workers", 1)
        self.assertMonitoring(monitoring_socket, "output.ready_messages[socket]", 0)
        self.assertMonitoring(monitoring_socket, "input.socket_state", "connected")
        self.assertMonitoring(monitoring_socket, "input.socket_connects", 1)
        self.assertMonitoring(monitoring_socket, "input.socket_disconnects", 0)
 
        # but with a ready message
        self.send(second_output_socket, "r")
 
        self.assertNothingMore(output_socket)
        self.assertIsMsgType(second_output_socket, "u")
 
        self.assertMonitoring(monitoring_socket, "output.ready_queue_size", 0)
        self.assertMonitoring(monitoring_socket, "output.registered_workers", 2)
        self.assertMonitoring(monitoring_socket, "input.socket_state", "connected")
        self.assertMonitoring(monitoring_socket, "input.socket_connects", 1)
        self.assertMonitoring(monitoring_socket, "input.socket_disconnects", 0)
 
        # and again
        input_socket.send_multipart([identity, self.event_data])
 
        self.send(second_output_socket, "r")
        self.assertNothingMore(output_socket)
        self.assertIsMsgType(second_output_socket, "u")
 
        # As we have answered all ready messages, nothing should be in the queue
        self.assertMonitoring(monitoring_socket, "output.ready_queue_size", 0)
        self.assertMonitoring(monitoring_socket, "output.registered_workers", 2)
 
        # until we start sending more ready messages
        self.send(output_socket, "r")
        self.send(output_socket, "r")
        self.send(second_output_socket, "r")
        self.send(second_output_socket, "r")
 
        self.assertMonitoring(monitoring_socket, "output.ready_queue_size", 4)
        self.assertMonitoring(monitoring_socket, "output.registered_workers", 2)
 

Member Data Documentation

ctx

ctx = zmq.Context()

staticinherited

The ZMQ context.

Definition at line 36 of file test_support.py.

event_data

event_data = open(basf2.find_file("daq/hbasf2/tests/out.raw"), "br").read()

static

event_data

Definition at line 20 of file test_distributor.py.

input_port

input_port = HLTZMQTestCase.get_free_port()

input_port

Definition at line 25 of file test_distributor.py.

monitoring_port

monitoring_port = HLTZMQTestCase.get_free_port()

monitoring_port

Definition at line 29 of file test_distributor.py.

needed_programs

needed_programs = dict()

staticinherited

The dict name -> cmd args of the programs to start, needs to be set in each test.

Definition at line 38 of file test_support.py.

output_port

output_port = HLTZMQTestCase.get_free_port()

output_port

Definition at line 27 of file test_distributor.py.

previous_dir

previous_dir = os.getcwd()

inherited

remember current working directory

Definition at line 58 of file test_support.py.

started_programs

started_programs = dict()

inherited

dict for all started programs

Definition at line 62 of file test_support.py.

tearDown

tearDown = subprocess.Popen(command, start_new_session=True)

inherited

Definition at line 68 of file test_support.py.

test_dir

test_dir = tempfile.mkdtemp()

inherited

use a temporary folder for testing

Definition at line 56 of file test_support.py.

---

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

• daq/hbasf2/tests/test_distributor.py