messages.py 75.6 KB
Newer Older
1 2 3
# -*- coding: utf-8 -*-

"""
4 5 6 7

About the library:
-----------------

8 9 10 11 12 13 14 15 16
This module provides the API message formats used in F-Interop.

The idea is to be able to have an
- organized and centralized way of dealing with the big amount of messages formats used in the platform;
- to be able to import (or just copy/paste) these messages formats from any component in the F-Interop platform,
- re-use this also for the integration testing;
- to have version control the messages e.g. messages_testcase_start API v1 and API v2;
- to have a direct way of exporting this as doc.

17 18 19 20 21 22 23 24

F-Interop conventions:
---------------------
- if event is a service request then the routing key (r_key) is control.someFunctionality.service
- a reply to a service will be on topic/r_key : control.someFunctionality.service.reply
- reply.correlation_id = request.correlation_id


25 26
Usage:
------
27
>>> from messages import * # doctest: +SKIP
Federico Sismondi's avatar
Federico Sismondi committed
28
>>> m = MsgTestCaseSkip(testcase_id = 'some_testcase_id')
29
>>> m
30
MsgTestCaseSkip(_api_version = 1.0.1, _type = testcoordination.testcase.skip, description = Skip testcase, node = someNode, testcase_id = some_testcase_id, )
31 32
>>> m.routing_key
'control.testcoordination'
33 34
>>> m.message_id # doctest: +SKIP
'802012eb-24e3-45c4-9dcc-dc293c584f63'
35
>>> m.testcase_id
Federico Sismondi's avatar
Federico Sismondi committed
36
'some_testcase_id'
37

38
# also we can modify some of the fields (rewrite the default ones)
Federico Sismondi's avatar
Federico Sismondi committed
39
>>> m = MsgTestCaseSkip(testcase_id = 'TD_COAP_CORE_03')
40
>>> m
41
MsgTestCaseSkip(_api_version = 1.0.1, _type = testcoordination.testcase.skip, description = Skip testcase, node = someNode, testcase_id = TD_COAP_CORE_03, )
42
>>> m.testcase_id
Federico Sismondi's avatar
Federico Sismondi committed
43
'TD_COAP_CORE_03'
44

45 46
# and even export the message in json format (for example for sending the message though the amqp event bus)
>>> m.to_json()
47
'{"_api_version": "1.0.1", "_type": "testcoordination.testcase.skip", "description": "Skip testcase", "node": "someNode", "testcase_id": "TD_COAP_CORE_03"}'
Federico Sismondi's avatar
Federico Sismondi committed
48

49
# We can use the Message class to import json into Message objects:
Federico Sismondi's avatar
Federico Sismondi committed
50 51
>>> m=MsgTestSuiteStart()
>>> m.to_json()
52
'{"_api_version": "1.0.1", "_type": "testcoordination.testsuite.start", "description": "Event test suite START"}'
Federico Sismondi's avatar
Federico Sismondi committed
53 54 55
>>> json_message = m.to_json()
>>> obj=Message.from_json(json_message)
>>> type(obj)
56
<class 'messages.MsgTestSuiteStart'>
57

58
# We can use the library for generating error responses:
59 60 61 62 63 64
# the request:
>>> m = MsgSniffingStart()
>>>
# the error reply (note that we pass the message of the request to build the reply):
>>> err = MsgErrorReply(m)
>>> err
65
MsgErrorReply(_api_version = 1.0.1, _type = sniffing.start, error_code = Some error code TBD, error_message = Some error message TBD, ok = False, )
66 67 68 69 70 71 72 73 74
>>> m.reply_to
'control.sniffing.service.reply'
>>> err.routing_key
'control.sniffing.service.reply'

>>> m.correlation_id # doctest: +SKIP
'360b0f67-4455-43e3-a00f-eca91f2e84da'
>>> err.correlation_id # doctest: +SKIP
'360b0f67-4455-43e3-a00f-eca91f2e84da'
Federico Sismondi's avatar
Federico Sismondi committed
75

76 77 78
"""

from collections import OrderedDict
79
import time
80 81 82
import json
import uuid

83
API_VERSION = '0.1.71'
84

85 86 87 88 89 90 91 92 93 94

# TODO use metaclasses instead?
class NonCompliantMessageFormatError(Exception):
    def __init__(self, value):
        self.value = value

    def __str__(self):
        return repr(self.value)


Federico Sismondi's avatar
Federico Sismondi committed
95
class Message(object):
96
    def __init__(self, **kwargs):
97 98 99
        global API_VERSION

        # hard copy the message template
100
        self._msg_data = {k: v for k, v in self._msg_data_template.items()}
101

102 103
        # init properties
        self._properties = dict(
104 105 106
            content_type="application/json",
            message_id=str(uuid.uuid4()),
            timestamp=int(time.time())
107 108
        )

109
        try:
110
            # TODO deprecate .service in favour of .request
111
            if self.routing_key.endswith(".service"):
112 113
                import logging
                logging.warning('(!) deprecate .service in favour of .request')
114 115
                self._properties["reply_to"] = "%s.%s" % (self.routing_key, "reply")
                self._properties["correlation_id"] = self._properties["message_id"]
116 117 118 119 120

            elif self.routing_key.endswith(".request"):
                self._properties["reply_to"] = self.routing_key.replace(".request", ".reply")
                self._properties["correlation_id"] = self._properties["message_id"]

121
        except AttributeError:
122
            pass
123

124
        # rewrite default data fields with the passed args
125 126 127
        self._msg_data.update(kwargs)

        # add API's version
128
        if "_api_version" not in self._msg_data:
129
            self._msg_data["_api_version"] = API_VERSION
130

Federico Sismondi's avatar
Federico Sismondi committed
131
        # add values as object's attributes
132 133 134
        for key in self._msg_data:
            setattr(self, key, self._msg_data[key])

135 136 137 138
        # add props as objects attributes
        for key in self._properties:
            setattr(self, key, self._properties[key])

139 140
    def to_dict(self):
        resp = {}
141 142
        # let's use sorted so API returns items inside always in the same order
        for field in sorted(self._msg_data.keys()):
143
            resp[field] = getattr(self, field)
144

145 146 147 148 149 150 151 152
        return resp

    def to_odict(self):
        resp = {}
        # let's use sorted so API returns items inside always in the same order
        for field in sorted(self._msg_data.keys()):
            resp[field] = getattr(self, field)

153
        return OrderedDict(sorted(resp.items(), key=lambda t: t[0]))  # sorted by key
154 155 156 157

    def to_json(self):
        return json.dumps(self.to_dict())

158
    def get_properties(self):
159 160 161 162
        resp = OrderedDict()
        for field in self._properties:
            resp[field] = getattr(self, field)
        return resp
163

164
    def __str__(self):
165 166 167 168 169 170 171
        s = " - " * 20 + "\n"
        s += "Message routing key: %s" % self.routing_key
        s += "\n -  -  - \n"
        s += "Message properties: %s" % json.dumps(self.get_properties(), indent=4, )
        s += "\n -  -  - \n"
        s += "Message body: %s" % json.dumps(self.to_dict(), indent=4, )
        s += "\n" + " - " * 20
172
        return s
173

174 175 176 177 178
    def update_properties(self, **kwargs):
        for key, value in kwargs.items():
            if key in self._properties:
                setattr(self, key, value)

179 180
    @classmethod
    def from_json(cls, body):
181 182 183 184 185 186 187 188 189 190
        """
        :param body: json string or string encoded as utf-8
        :return:  Message object generated from the body
        :raises NonCompliantMessageFormatError: If the message cannot be build from the provided json
        """

        if type(body) is str:
            message_dict = json.loads(body)
        # Note: pika re-encodes json.dumps strings as utf-8 for some reason, the following line undoes this
        elif type(body) is bytes:
191
            message_dict = json.loads(body.decode("utf-8"))
192
        else:
193
            raise NonCompliantMessageFormatError("Not a Json")
194

195 196 197 198 199 200 201 202 203 204 205
        return cls.from_dict(message_dict)

    @classmethod
    def from_dict(cls, message_dict):
        """
        :param body: dict
        :return:  Message object generated from the body
        :raises NonCompliantMessageFormatError: If the message cannot be build from the provided json
        """
        assert type(message_dict) is dict

206
        message_type = message_dict["_type"]
207

208 209 210
        if message_type in message_types_dict:
            return message_types_dict[message_type](**message_dict)
        else:
211 212
            raise NonCompliantMessageFormatError("Cannot load json message: %s" % str(message_dict))

213
    def __repr__(self):
214
        ret = "%s(" % self.__class__.__name__
215
        for key, value in self.to_dict().items():
216 217
            ret += "%s = %s, " % (key, value)
        ret += ")"
218 219
        return ret

220

221 222 223 224 225
class MsgReply(Message):
    """
    Auxiliary class which creates replies messages with fields based on the request.
    Routing key, corr_id and _type are generated based on the request message
    """
226

227
    def __init__(self, request_message=None, **kwargs):
228

229 230 231 232 233 234
        if request_message and hasattr(request_message, "routing_key"):
            # TODO (!) deprecate .service in favour of .request
            if request_message.routing_key.endswith(".service"):
                import logging
                logging.warning('(!) messages library | deprecate .service in favour of .request')
                self.routing_key = request_message.routing_key + ".reply"
235

236 237 238 239 240 241 242 243 244 245
            elif self.routing_key.endswith(".request"):
                self.routing_key = self.routing_key.replace(".request", ".reply")

            # if not data template, then let's build one for a reply
            # (possible when creating a MsgReply directly and not by using subclass)
            if not hasattr(self, "_msg_data_template"):
                self._msg_data_template = {
                    "_type": request_message._type,
                    "ok": True,
                }
246

247
            super(MsgReply, self).__init__(**kwargs)
248

249 250 251
            # overwrite correlation id template and attribute
            self._properties["correlation_id"] = request_message.correlation_id
            self.correlation_id = request_message.correlation_id
252

253 254
        else:   # note this doesnt generate amqp properties
            import logging
255
            logging.warning('(!) messages library | lazy response built, generating reply message without corr_id')
256
            super(MsgReply, self).__init__(**kwargs)
257

258 259 260 261 262 263 264 265
    def correlate_to(self, request_message):
        """
        add to reply message the right correlation information to request
        """
        # overwrite correlation id template and attribute
        self._properties["correlation_id"] = request_message.correlation_id
        self.correlation_id = request_message.correlation_id

266 267 268

class MsgErrorReply(MsgReply):
    """
269
    see section "F-Interop conventions" on top
270
    """
271

272 273
    def __init__(self, request_message, **kwargs):
        assert request_message
274
        # msg_data_template doesnt include _type cause this class is generic, we can only get this at init from request
275
        # so, let's copy the _type from request and let the MsgReply handle the rest of the fields
276
        self._msg_data_template["_type"] = request_message._type
277
        super(MsgErrorReply, self).__init__(request_message, **kwargs)
278 279

    _msg_data_template = {
280
        "ok": False,
281
        "error_message": "Some error message TBD",
282
        "error_code": "Some error code TBD"
283 284
    }

Federico Sismondi's avatar
Federico Sismondi committed
285

286
# # # # # # CORE API messages # # # # #
287 288

class MsgOrchestratorVersionReq(Message):
289 290 291 292 293 294 295 296 297
    """
    Requirements: ...

    Type: Event

    Pub/Sub: UI -> SO

    Description: Message for returning current version of SO
    """
298
    routing_key = "control.orchestrator.version.request"
299 300

    _msg_data_template = {
Federico Sismondi's avatar
Federico Sismondi committed
301
        "_type": "orchestrator.version.request"
302
    }
303

Federico Sismondi's avatar
Federico Sismondi committed
304

305 306 307 308 309 310 311 312 313 314
class MsgOrchestratorUsersList(Message):
    """
    Requirements: ...

    Type: Event

    Pub/Sub: UI -> SO

    Description: Message for returning user list of SO
    """
315
    routing_key = "control.orchestrator.users.list.request"
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331

    _msg_data_template = {
        "_type": "orchestrator.users.list.request"
    }


class MsgOrchestratorUserAdd(Message):
    """
    Requirements: ...

    Type: Event

    Pub/Sub: UI -> SO

    Description: Message for adding a user to SO
    """
332

333
    routing_key = "control.orchestrator.users.add.request"
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349

    _msg_data_template = {
        "_type": "orchestrator.users.add.request"
    }


class MsgOrchestratorUserDelete(Message):
    """
    Requirements: ...

    Type: Event

    Pub/Sub: UI -> SO

    Description: Message for deleting a user from SO
    """
350

351
    routing_key = "control.orchestrator.users.delete.request"
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367

    _msg_data_template = {
        "_type": "orchestrator.users.delete.request"
    }


class MsgOrchestratorUserGet(Message):
    """
    Requirements: ...

    Type: Event

    Pub/Sub: UI -> SO

    Description: Message for getting a user from SO
    """
368

369
    routing_key = "control.orchestrator.users.get.request"
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385

    _msg_data_template = {
        "_type": "orchestrator.users.get.request"
    }


class MsgOrchestratorSessionsList(Message):
    """
    Requirements: ...

    Type: Event

    Pub/Sub: UI -> SO

    Description: Message for listing sessions from SO
    """
386
    routing_key = "control.orchestrator.sessions.list.request"
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402

    _msg_data_template = {
        "_type": "orchestrator.sessions.list.request"
    }


class MsgOrchestratorSessionsGet(Message):
    """
    Requirements: ...

    Type: Event

    Pub/Sub: UI -> SO

    Description: Message for getting a session from SO
    """
403
    routing_key = "control.orchestrator.sessions.get.request"
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419

    _msg_data_template = {
        "_type": "orchestrator.sessions.get.request"
    }


class MsgOrchestratorSessionsAdd(Message):
    """
    Requirements: ...

    Type: Event

    Pub/Sub: UI -> SO

    Description: Message for adding a session to SO
    """
420
    routing_key = "control.orchestrator.sessions.add.request"
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436

    _msg_data_template = {
        "_type": "orchestrator.sessions.add.request"
    }


class MsgOrchestratorSessionsDelete(Message):
    """
    Requirements: ...

    Type: Event

    Pub/Sub: UI -> SO

    Description: Message for deleting a session to SO
    """
437

438
    routing_key = "control.orchestrator.sessions.delete.request"
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455

    _msg_data_template = {
        "_type": "orchestrator.sessions.delete.request"
    }


class MsgOrchestratorSessionsUpdate(Message):
    """
    Requirements: ...

    Type: Event

    Pub/Sub: UI -> SO

    Description: Message for updating a session from SO
    """

456
    routing_key = "control.orchestrator.sessions.update.request"
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
    _msg_data_template = {
        "_type": "orchestrator.sessions.update.request"
    }


class MsgOrchestratorTestsGet(Message):
    """
    Requirements: ...

    Type: Event

    Pub/Sub: UI -> SO

    Description: Message for getting tests from SO
    """
472
    routing_key = "control.orchestrator.tests.get.request"
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488

    _msg_data_template = {
        "_type": "orchestrator.tests.get.request"
    }


class MsgOrchestratorTestsGetContributorName(Message):
    """
    Requirements: ...

    Type: Event

    Pub/Sub: UI -> SO

    Description: Message for getting tests from SO with contributor and name
    """
489
    routing_key = "control.orchestrator.tests.get_contributor_name.request"
490 491 492 493 494 495

    _msg_data_template = {
        "_type": "orchestrator.tests.get_contributor_name.request"
    }


496 497 498 499 500 501 502 503 504 505 506 507
# # # # # # UI API messages # # # # # # # #

class MsgUiRequestTextInput(Message):
    """
    Requirements: ...

    Type: Event

    Pub/Sub: TT -> UI

    Description: Message for requesting action or information to user
    """
508
    routing_key = "ui.user.all.request"
509 510

    _msg_data_template = {
511
        "_type": "ui.user.all.request.text.input",
512
        "fields": [
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
            {
                "name": "input_name",
                "type": "text"
            },
        ]
    }


class MsgUiRequestConfirmationButton(Message):
    """
    Requirements: ...

    Type: Event

    Pub/Sub: TT -> UI

    Description: Message for requesting confirmation button
    """
    routing_key = "ui.user.all.request"

    _msg_data_template = {
        "_type": "MsgUiRequestConfirmationButton",
        "fields": [
            {
                "name": "Please confirm that Uruguay is the best country in the world",
                "type": "button",
                "value": True
            },
        ]
    }


class MsgUiDisplay(Message):
    """
    Requirements: ...

    Type: Event

    Pub/Sub: TT -> UI

    Description: Message to display in user interface
    """
    routing_key = "ui.user.all.display"

    _msg_data_template = {
        "_type": "ui.user.all.display",
        "fields": [
            {
                "name": "display_markdown_text",
                "type": "p",
                "value": "Hello World!"
            },
        ]
    }


class MsgUiDisplayMarkdownText(Message):
    """
    Requirements: ...

    Type: Event

    Pub/Sub: TT -> UI

    Description: Message for displaying Mardown text to user interface
    """
    routing_key = "ui.user.all.display"

    _msg_data_template = {
        "_type": "ui.user.all.display",
        "fields": [
            {
                "name": "display_markdown_text",
                "type": "p",
                "value": "Hello World!"
            },
589 590 591
        ]
    }

592

593
# # # # # # AGENT MESSAGES # # # # # #
Federico Sismondi's avatar
Federico Sismondi committed
594

595

Federico Sismondi's avatar
Federico Sismondi committed
596 597
class MsgAgentTunStart(Message):
    """
598
    Requirements: Testing Tool MAY implement (if IP tun needed)
Federico Sismondi's avatar
Federico Sismondi committed
599

600
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
601

602
    Pub/Sub: Testing Tool -> Agent
Federico Sismondi's avatar
Federico Sismondi committed
603

604
    Description: Message for triggering start IP tun interface in OS where the agent is running
Federico Sismondi's avatar
Federico Sismondi committed
605
    """
606
    routing_key = "control.tun.toAgent.agent_TT"
Federico Sismondi's avatar
Federico Sismondi committed
607 608

    _msg_data_template = {
609 610 611 612
        "_type": "tun.start",
        "name": "agent_TT",
        "ipv6_prefix": "bbbb",
        "ipv6_host": ":3",
613
        "ipv6_no_forwarding": False,
614 615 616
        "ipv4_host": None,
        "ipv4_network": None,
        "ipv4_netmask": None,
Federico Sismondi's avatar
Federico Sismondi committed
617 618 619
    }


620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639
class MsgAgentSerialStarted(Message):
    """
    Description: Message for indicating that agent serial interface has been started

    Type: Event

    Pub/Sub: Testing Tool -> Agent

    Description: TBD
    """
    routing_key = "control.serial.from.tbd"

    _msg_data_template = {
        "_type": "serial.started",
        "name": "tbd",
        "port": "tbd",
        "boudrate": "tbd",
    }


Federico Sismondi's avatar
Federico Sismondi committed
640 641
class MsgAgentTunStarted(Message):
    """
642
    Description: Message for indicating that agent tun has been started
Federico Sismondi's avatar
Federico Sismondi committed
643

644
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
645

646
    Pub/Sub: Agent -> Testing Tool
Federico Sismondi's avatar
Federico Sismondi committed
647

648
    Description: TBD
Federico Sismondi's avatar
Federico Sismondi committed
649
    """
650
    routing_key = "control.tun.from.tbd"
Federico Sismondi's avatar
Federico Sismondi committed
651 652

    _msg_data_template = {
653 654 655 656 657 658 659
        "_type": "tun.started",
        "name": "agent_TT",
        "ipv6_prefix": "bbbb",
        "ipv6_host": ":3",
        "ipv4_host": None,
        "ipv4_network": None,
        "ipv4_netmask": None,
660
        "ipv6_no_forwarding": False,
Federico Sismondi's avatar
Federico Sismondi committed
661 662
    }

663

664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684
class MsgPacketInjectRaw(Message):
    """
    Description: Message to be captured by the agent an push into the correct embedded interface (e.g. tun, serial, etc..)

    Type: Event

    Pub/Sub: Testing Tool -> Agent

    Description: TBD
    """
    routing_key = None  # depends on the agent_id and the agent interface being used, re-write after creation

    _msg_data_template = {
        "_type": "packet.to_inject.raw",
        "timestamp": "1488586183.45",
        "interface_name": "tun0",
        "data": [96, 0, 0, 0, 0, 36, 0, 1, 254, 128, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, 255, 2, 0, 0, 0, 0, 0, 0,
                 0, 0, 0, 0, 0, 0, 0, 22, 58, 0, 5, 2, 0, 0, 1, 0, 143, 0, 112, 7, 0, 0, 0, 1, 4, 0, 0, 0, 255, 2, 0, 0,
                 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2]}


685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703
class MsgPacketSniffedRaw(Message):
    """
    Description: Message captured by the agent in one of its embedded interfaces (e.g. tun, serial, etc..)

    Type: Event

    Pub/Sub: Agent -> Testing Tool

    Description: TBD
    """
    routing_key = None  # depends on the agent_id and the agent interface being used, re-write after creation

    _msg_data_template = {
        "_type": "packet.sniffed.raw",
        "timestamp": "1488586183.45",
        "interface_name": "tun0",
        "data": [96, 0, 0, 0, 0, 36, 0, 1, 254, 128, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, 255, 2, 0, 0, 0, 0, 0, 0,
                 0, 0, 0, 0, 0, 0, 0, 22, 58, 0, 5, 2, 0, 0, 1, 0, 143, 0, 112, 7, 0, 0, 0, 1, 4, 0, 0, 0, 255, 2, 0, 0,
                 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2]}
704

705 706

# # # # # # SESSION MESSAGES # # # # # #
707

708
class MsgTestingToolTerminate(Message):
709
    """
710
    Requirements: TT MUST listen to event, and handle a gracefully termination of all it's processes
Federico Sismondi's avatar
Federico Sismondi committed
711

712
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
713

714
    Pub/Sub: GUI, (or Orchestrator) -> Testing Tool
Federico Sismondi's avatar
Federico Sismondi committed
715

716
    Description: Testing tool should stop all it's processes gracefully.
717
    """
718
    routing_key = "control.session"
719 720

    _msg_data_template = {
721
        "_type": "testingtool.terminate",
722
        "description": "Event TERMINATE testing tool execution"
723 724 725 726 727
    }


class MsgTestingToolReady(Message):
    """
728
    Requirements: TT MUST publish event as soon as TT is up and listening on the event bus
Federico Sismondi's avatar
Federico Sismondi committed
729

730
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
731

732
    Pub/Sub: Testing Tool -> GUI
Federico Sismondi's avatar
Federico Sismondi committed
733

734
    Description: Used to indicate to the GUI that testing is ready to start the test suite
735
    """
736
    routing_key = "control.session"
737 738

    _msg_data_template = {
739 740
        "_type": "testingtool.ready",
        "description": "Event Testing tool READY to start test suite."
741 742 743 744 745
    }


class MsgTestingToolComponentReady(Message):
    """
746
    Requirements: Testing Tool SHOULD implement (other components should not subscribe to event)
Federico Sismondi's avatar
Federico Sismondi committed
747

748
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
749

750
    Pub/Sub: Any Testing tool's component -> Test Coordinator
Federico Sismondi's avatar
Federico Sismondi committed
751

752
    Description: Once a testing tool's component is ready, it should publish a compoennt ready message
753
    """
754
    routing_key = "control.session"
755 756

    _msg_data_template = {
757
        "_type": "testingtool.component.ready",
758
        "component": "SomeComponent",
759
        "description": "Component READY to start test suite."
760 761 762
    }


763 764 765 766 767 768 769 770 771 772
class MsgSessionChat(Message):
    """
    Requirements: GUI should implement

    Type: Event

    Pub/Sub: UI 1 (2) -> UI 2 (1)

    Description: Generic descriptor of chat messages
    """
773
    routing_key = "control.session"
774 775 776 777

    _msg_data_template = {
        "_type": "chat",
        "user_name": "Ringo",
778
        "node": "tbd",
779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796
        "description": "I've got blisters on my fingers!"
    }


class MsgSessionLog(Message):
    """
    Requirements: Testing Tool SHOULD implement

    Type: Event

    Pub/Sub: Any Testing tool's component -> user/devs interfaces

    Description: Generic descriptor of log messages
    """
    routing_key = "log.warning.the_drummer"

    _msg_data_template = {
        "_type": "log",
Federico Sismondi's avatar
Federico Sismondi committed
797
        "component": "misc",
798
        "message": "I've got blisters on my fingers!"
799 800 801
    }


802 803
class MsgSessionConfiguration(Message):
    """
804
    Requirements: TT MUST listen to event, and configure accordingly
805 806 807 808 809

    Type: Event

    Pub/Sub: Orchestrator -> Testing Tool

810
    Description: TT MUST listen to this message and configure the testsuite correspondingly
811 812
    """
    routing_key = "control.session"
813

814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831
    _msg_data_template = {
        "_type": "session.configuration",
        "session_id": "666",
        "configuration": {
            'testsuite.testcases': [
                'someTestCaseId1',
                'someTestCaseId2'
            ]
        },
        "testing_tools": "f-interop/someTestToolId",
        "users": [
            "u1",
            "f-interop"
        ],
    }


# TODO deprecate this in favor of the generic MsgSessionConfiguration
832
class MsgInteropSessionConfiguration(Message):
833
    """
834
    Requirements: TT MUST listen to event
Federico Sismondi's avatar
Federico Sismondi committed
835

836
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
837

838
    Pub/Sub: Orchestrator -> Testing Tool
Federico Sismondi's avatar
Federico Sismondi committed
839

840
    Description: TT MUST listen to this message and configure the testsuite correspondingly
841
    """
842
    routing_key = "control.session"
843 844

    _msg_data_template = {
845 846
        "_type": "session.interop.configuration",
        "session_id": "TBD",
847 848 849 850 851 852 853 854
        "configuration":
            {
                'testsuite.testcases': [
                    'http://doc.f-interop.eu/tests/TD_COAP_CORE_01',
                    'http://doc.f-interop.eu/tests/TD_COAP'
                ]
            },

855
        "testing_tools": "f-interop/interoperability-coap",
856
        "users": [
857 858 859
            "u1",
            "f-interop"
        ],
860
        "tests": [
861
            {
Federico Sismondi's avatar
Federico Sismondi committed
862
                "testcase_ref": "http://doc.f-interop.eu/tests/TD_COAP_CORE_01",
863
                "settings": {}
864 865
            },
            {
Federico Sismondi's avatar
Federico Sismondi committed
866
                "testcase_ref": "http://doc.f-interop.eu/tests/TD_COAP_CORE_02",
867 868 869
                "settings": {}
            },
            {
Federico Sismondi's avatar
Federico Sismondi committed
870
                "testcase_ref": "http://doc.f-interop.eu/tests/TD_COAP_CORE_03",
871
                "settings": {}
872 873 874 875 876
            }
        ]
    }


877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896
class MsgAgentConfigured(Message):
    """
    Requirements: Testing Tool SHOULD publish event

    Type: Event

    Pub/Sub: Testing Tool -> GUI

    Description: The goal is to notify GUI when agents are ready to start the session
    """

    routing_key = "control.session"

    _msg_data_template = {
        "_type": "agent.configured",
        "description": "Event agent successfully CONFIGURED",
        'name': 'agent_TT'
    }


897 898
class MsgTestingToolConfigured(Message):
    """
899
    Requirements: TT MUST publish event once session.configuration message has been processed.
Federico Sismondi's avatar
Federico Sismondi committed
900

901
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
902

903
    Pub/Sub: Testing Tool -> Orchestrator, GUI
Federico Sismondi's avatar
Federico Sismondi committed
904

905
    Description: The goal is to notify orchestrator and other components that the testing tool has been configured
906 907 908 909 910
    """

    routing_key = "control.session"

    _msg_data_template = {
911 912 913
        "_type": "testingtool.configured",
        "description": "Event Testing tool CONFIGURED",
        "session_id": "TBD",
914 915 916
        "testing_tools": "f-interop/interoperability-coap",
    }

917

918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938
class MsgSessionCreated(Message):
    """
    Requirements: Session Orchestrator MUST publish message on common-services channel (on every session creation)

    Type: Event

    Pub/Sub: SO -> viz tools

    Description: The goal is to notify viz tools about new sessions
    """

    routing_key = "control.session.created"

    _msg_data_template = {
        "_type": "session.created",
        "description": "A new session has been created",
        "session_id": "TBD",
        "testing_tools": "TBD",
    }


939 940
class MsgTestingToolComponentShutdown(Message):
    """
941
    Requirements: Testing Tool SHOULD implement (other components should not subscribe to event)
Federico Sismondi's avatar
Federico Sismondi committed
942

943
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
944

945
    Pub/Sub: Any Testing tool's component -> Test Coordinator
Federico Sismondi's avatar
Federico Sismondi committed
946

947 948
    Description: tbd
    """
949 950 951
    routing_key = "control.session"

    _msg_data_template = {
952
        "_type": "testingtool.component.shutdown",
953
        "component": "SomeComponent",
954
        "description": "Event Component SHUTDOWN. Bye!"
955 956
    }

957
    # # # # # # TEST COORDINATION MESSAGES # # # # # #
958

959 960 961

class MsgTestSuiteStart(Message):
    """
962
    Requirements: TT MUST listen to event and start the test suite right after reception. MsgTestSuiteStarted
Federico Sismondi's avatar
Federico Sismondi committed
963

964
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
965

966
    Pub/Sub: GUI -> Testing Tool
Federico Sismondi's avatar
Federico Sismondi committed
967

968
    Description: tbd
969 970
    """

971
    # TODO change to control.testsuite
972
    routing_key = "control.testcoordination"
973 974

    _msg_data_template = {
975
        "_type": "testcoordination.testsuite.start",
976
        "description": "Event test suite START"
977 978
    }

979

Federico Sismondi's avatar
Federico Sismondi committed
980 981 982 983 984 985 986 987 988 989 990
class MsgTestSuiteStarted(Message):
    """
    Requirements: Testing Tool SHOULD publish to event

    Type: Event

    Pub/Sub: Testing Tool -> GUI

    Description: tbd
    """

991
    # TODO change to control.testsuite
Federico Sismondi's avatar
Federico Sismondi committed
992 993 994 995 996 997
    routing_key = "control.testcoordination"

    _msg_data_template = {
        "_type": "testcoordination.testsuite.started",
        "description": "Event test suite STARTED"
    }
998

999

1000 1001
class MsgTestSuiteFinish(Message):
    """
1002
    Requirements: TT MUST listen to event
Federico Sismondi's avatar
Federico Sismondi committed
1003

1004
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
1005

1006
    Pub/Sub: GUI -> Testing Tool
Federico Sismondi's avatar
Federico Sismondi committed
1007

1008
    Description: tbd
1009 1010
    """

1011
    # TODO change to control.testsuite
1012 1013 1014
    routing_key = "control.testcoordination"

    _msg_data_template = {
1015
        "_type": "testcoordination.testsuite.finish",
1016
        "description": "Event test suite FINISH"
1017 1018
    }

1019

1020 1021
class MsgTestCaseReady(Message):
    """
1022
    Requirements: TT MUST publish event
Federico Sismondi's avatar
Federico Sismondi committed
1023

1024
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
1025

Federico Sismondi's avatar
Federico Sismondi committed
1026
    Pub/Sub: Testing Tool -> GUI
Federico Sismondi's avatar
Federico Sismondi committed
1027

1028 1029 1030
    Description:
        - Used to indicate to the GUI (or automated-iut) which is the next test case to be executed.
        - This message is normally followed by a MsgTestCaseStart (from GUI-> Testing Tool)
1031 1032
    """

1033
    # TODO change to control.testsuite
1034
    routing_key = "control.testcoordination"
1035 1036

    _msg_data_template = {
1037
        "_type": "testcoordination.testcase.ready",
Federico Sismondi's avatar
Federico Sismondi committed
1038 1039 1040
        "description": "Next test case to be executed is TD_COAP_CORE_01",
        "testcase_id": "TD_COAP_CORE_01",
        "testcase_ref": "http://doc.f-interop.eu/tests/TD_COAP_CORE_01",
1041 1042
        "objective": "Perform GET transaction(CON mode)",
        "state": None
1043 1044 1045
    }


1046 1047
class MsgTestCaseStart(Message):
    """
1048
    Requirements: TT MUST listen to event
Federico Sismondi's avatar
Federico Sismondi committed
1049

1050
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
1051

1052
    Pub/Sub: GUI -> Testing Tool
Federico Sismondi's avatar
Federico Sismondi committed
1053

1054 1055
    Description:
        - Message used for indicating the testing tool to start the test case (the one previously selected)
1056 1057
        - if testcase_id is Null then testing tool starts previously announced testcase in message
        "testcoordination.testcase.ready",
1058
    """
1059
    # TODO change to control.testsuite
1060
    routing_key = "control.testcoordination"
1061 1062

    _msg_data_template = {
1063
        "_type": "testcoordination.testcase.start",
1064 1065
        "description": "Event test case START",
        "testcase_id": "TBD",
1066 1067
    }

Federico Sismondi's avatar
Federico Sismondi committed
1068

1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079
class MsgTestCaseStarted(Message):
    """
    Requirements: Testing Tool SHOULD publish event

    Type: Event

    Pub/Sub: Testing Tool -> GUI

    Description:
        - Message used for indicating that testcase has started
    """
1080
    # TODO change to control.testsuite
1081 1082 1083 1084 1085 1086 1087
    routing_key = "control.testcoordination"

    _msg_data_template = {
        "_type": "testcoordination.testcase.started",
        "description": "Event test case STARTED",
        "testcase_id": "TBD",
    }
1088

Federico Sismondi's avatar
Federico Sismondi committed
1089

1090 1091
# TODO MsgTestCaseNotes, see https://portal.etsi.org/cti/downloads/TestSpecifications/6LoWPAN_Plugtests_TestDescriptions_1.0.pdf

1092

1093 1094
class MsgTestCaseConfiguration(Message):
    """
1095
    Requirements: Testing Tool MAY publish event (if needed for executing the test case)
1096 1097 1098 1099 1100 1101
    Type: Event
    Pub/Sub: Testing Tool -> GUI & automated-iut
    Description:
        - Message used to indicate GUI and/or automated-iut which configuration to use.
        - IMPORTANT: deprecate this message in favor of MsgConfigurationExecute and MsgConfigurationExecuted
    """
1102 1103

    # TODO change to control.testsuite
1104 1105 1106
    routing_key = "control.testcoordination"
    _msg_data_template = {
        "_type": "testcoordination.testcase.configuration",
Federico Sismondi's avatar
Federico Sismondi committed
1107
        "configuration_id": "COAP_CFG_01",
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137
        "node": "coap_server",
        "testcase_id": "TBD",
        "testcase_ref": "TBD",
        "description":
            ["CoAP servers running service at [bbbb::2]:5683",
             "CoAP servers are requested to offer the following resources",
             ["/test", "Default test resource", "Should not exceed 64bytes"],
             ["/seg1/seg2/seg3", "Long path ressource", "Should not exceed 64bytes"],
             ["/query", "Ressource accepting query parameters", "Should not exceed 64bytes"],
             ["/separate",
              "Ressource which cannot be served immediately and which cannot be "
              "acknowledged in a piggy-backed way",
              "Should not exceed 64bytes"],
             ["/large", "Large resource (>1024 bytes)", "shall not exceed 2048bytes"],
             ["/large_update",
              "Large resource that can be updated using PUT method (>1024 bytes)",
              "shall not exceed 2048bytes"],
             ["/large_create",
              "Large resource that can be  created using POST method (>1024 bytes)",
              "shall not exceed 2048bytes"],
             ["/obs", "Observable resource which changes every 5 seconds",
              "shall not exceed 2048bytes"],
             ["/.well-known/core", "CoRE Link Format", "may require usage of Block options"]
             ]
    }


class MsgConfigurationExecute(Message):
    """
    Requirements: Testing Tool MAY publish event (if needed for executing the test case)
Federico Sismondi's avatar
Federico Sismondi committed
1138

1139
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
1140

1141
    Pub/Sub: Testing Tool -> GUI & automated-iut
Federico Sismondi's avatar
Federico Sismondi committed
1142

1143 1144
    Description:
        - Message used to indicate GUI and/or automated-iut which configuration to use.
1145
    """
1146 1147

    # TODO change to control.testsuite
1148 1149 1150
    routing_key = "control.testcoordination"

    _msg_data_template = {
1151
        "_type": "testcoordination.configuration.execute",
Federico Sismondi's avatar
Federico Sismondi committed
1152
        "configuration_id": "COAP_CFG_01",
1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176
        "node": "coap_server",
        "testcase_id": "TBD",
        "testcase_ref": "TBD",
        "description":
            ["CoAP servers running service at [bbbb::2]:5683",
             "CoAP servers are requested to offer the following resources",
             ["/test", "Default test resource", "Should not exceed 64bytes"],
             ["/seg1/seg2/seg3", "Long path ressource", "Should not exceed 64bytes"],
             ["/query", "Ressource accepting query parameters", "Should not exceed 64bytes"],
             ["/separate",
              "Ressource which cannot be served immediately and which cannot be "
              "acknowledged in a piggy-backed way",
              "Should not exceed 64bytes"],
             ["/large", "Large resource (>1024 bytes)", "shall not exceed 2048bytes"],
             ["/large_update",
              "Large resource that can be updated using PUT method (>1024 bytes)",
              "shall not exceed 2048bytes"],
             ["/large_create",
              "Large resource that can be  created using POST method (>1024 bytes)",
              "shall not exceed 2048bytes"],
             ["/obs", "Observable resource which changes every 5 seconds",
              "shall not exceed 2048bytes"],
             ["/.well-known/core", "CoRE Link Format", "may require usage of Block options"]
             ]
1177 1178 1179
    }


1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
class MsgConfigurationExecuted(Message):
    """
    Requirements: Testing Tool SHOULD listen to event

    Type: Event

    Pub/Sub: GUI (automated-IUT) -> Testing Tool

    Description:
        - Message used for indicating that the IUT has been configured as requested
1190
        - pixit must be included in this message (pixit = Protocol Implementaiton eXtra Information for Testing)
1191
    """
1192 1193

    # TODO change to control.testsuite
1194 1195 1196 1197 1198
    routing_key = "control.testcoordination"

    _msg_data_template = {
        "_type": "testcoordination.configuration.executed",
        "description": "Event IUT has been configured",
1199
        "node": "coap_server",
Federico Sismondi's avatar
Federico Sismondi committed
1200
        "ipv6_address": "tbd"  # example of pixit
1201 1202 1203
    }


1204 1205
class MsgTestCaseStop(Message):
    """
1206
    Requirements: TT MUST listen to event
Federico Sismondi's avatar
Federico Sismondi committed
1207

1208
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
1209

1210
    Pub/Sub: GUI & automated-iut -> Testing Tool
Federico Sismondi's avatar
Federico Sismondi committed
1211

1212 1213
    Description:
        - Message used for indicating the testing tool to stop the test case (the one running).
1214 1215
    """

1216
    # TODO change to control.testsuite
1217
    routing_key = "control.testcoordination"
1218 1219

    _msg_data_template = {
1220
        "_type": "testcoordination.testcase.stop",
1221
        "description": "Event test case STOP"
1222 1223 1224 1225 1226
    }


class MsgTestCaseRestart(Message):
    """
1227
    Requirements: TT MUST listen to event
Federico Sismondi's avatar
Federico Sismondi committed
1228

1229
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
1230

1231
    Pub/Sub: GUI -> Testing Tool
Federico Sismondi's avatar