messages.py 75.2 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.70'
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 255 256
        else:   # note this doesnt generate amqp properties
            import logging
            logging.warning('(!) messages library | generating reply message without corr_id')
            super(MsgReply, self).__init__(**kwargs)
257 258 259 260


class MsgErrorReply(MsgReply):
    """
261
    see section "F-Interop conventions" on top
262
    """
263

264 265
    def __init__(self, request_message, **kwargs):
        assert request_message
266
        # msg_data_template doesnt include _type cause this class is generic, we can only get this at init from request
267
        # so, let's copy the _type from request and let the MsgReply handle the rest of the fields
268
        self._msg_data_template["_type"] = request_message._type
269
        super(MsgErrorReply, self).__init__(request_message, **kwargs)
270 271

    _msg_data_template = {
272
        "ok": False,
273
        "error_message": "Some error message TBD",
274
        "error_code": "Some error code TBD"
275 276
    }

Federico Sismondi's avatar
Federico Sismondi committed
277

278
# # # # # # CORE API messages # # # # #
279 280

class MsgOrchestratorVersionReq(Message):
281 282 283 284 285 286 287 288 289
    """
    Requirements: ...

    Type: Event

    Pub/Sub: UI -> SO

    Description: Message for returning current version of SO
    """
290
    routing_key = "control.orchestrator.version.request"
291 292

    _msg_data_template = {
Federico Sismondi's avatar
Federico Sismondi committed
293
        "_type": "orchestrator.version.request"
294
    }
295

Federico Sismondi's avatar
Federico Sismondi committed
296

297 298 299 300 301 302 303 304 305 306
class MsgOrchestratorUsersList(Message):
    """
    Requirements: ...

    Type: Event

    Pub/Sub: UI -> SO

    Description: Message for returning user list of SO
    """
307
    routing_key = "control.orchestrator.users.list.request"
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323

    _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
    """
324

325
    routing_key = "control.orchestrator.users.add.request"
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341

    _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
    """
342

343
    routing_key = "control.orchestrator.users.delete.request"
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359

    _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
    """
360

361
    routing_key = "control.orchestrator.users.get.request"
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377

    _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
    """
378
    routing_key = "control.orchestrator.sessions.list.request"
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394

    _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
    """
395
    routing_key = "control.orchestrator.sessions.get.request"
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411

    _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
    """
412
    routing_key = "control.orchestrator.sessions.add.request"
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428

    _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
    """
429

430
    routing_key = "control.orchestrator.sessions.delete.request"
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447

    _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
    """

448
    routing_key = "control.orchestrator.sessions.update.request"
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463
    _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
    """
464
    routing_key = "control.orchestrator.tests.get.request"
465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480

    _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
    """
481
    routing_key = "control.orchestrator.tests.get_contributor_name.request"
482 483 484 485 486 487

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


488 489 490 491 492 493 494 495 496 497 498 499
# # # # # # UI API messages # # # # # # # #

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

    Type: Event

    Pub/Sub: TT -> UI

    Description: Message for requesting action or information to user
    """
500
    routing_key = "ui.user.all.request"
501 502

    _msg_data_template = {
503
        "_type": "ui.user.all.request.text.input",
504
        "fields": [
505 506 507 508 509 510 511 512 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
            {
                "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!"
            },
581 582 583
        ]
    }

584

585
# # # # # # AGENT MESSAGES # # # # # #
Federico Sismondi's avatar
Federico Sismondi committed
586

587

Federico Sismondi's avatar
Federico Sismondi committed
588 589
class MsgAgentTunStart(Message):
    """
590
    Requirements: Testing Tool MAY implement (if IP tun needed)
Federico Sismondi's avatar
Federico Sismondi committed
591

592
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
593

594
    Pub/Sub: Testing Tool -> Agent
Federico Sismondi's avatar
Federico Sismondi committed
595

596
    Description: Message for triggering start IP tun interface in OS where the agent is running
Federico Sismondi's avatar
Federico Sismondi committed
597
    """
598
    routing_key = "control.tun.toAgent.agent_TT"
Federico Sismondi's avatar
Federico Sismondi committed
599 600

    _msg_data_template = {
601 602 603 604
        "_type": "tun.start",
        "name": "agent_TT",
        "ipv6_prefix": "bbbb",
        "ipv6_host": ":3",
605
        "ipv6_no_forwarding": False,
606 607 608
        "ipv4_host": None,
        "ipv4_network": None,
        "ipv4_netmask": None,
Federico Sismondi's avatar
Federico Sismondi committed
609 610 611
    }


612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631
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
632 633
class MsgAgentTunStarted(Message):
    """
634
    Description: Message for indicating that agent tun has been started
Federico Sismondi's avatar
Federico Sismondi committed
635

636
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
637

638
    Pub/Sub: Agent -> Testing Tool
Federico Sismondi's avatar
Federico Sismondi committed
639

640
    Description: TBD
Federico Sismondi's avatar
Federico Sismondi committed
641
    """
642
    routing_key = "control.tun.from.tbd"
Federico Sismondi's avatar
Federico Sismondi committed
643 644

    _msg_data_template = {
645 646 647 648 649 650 651
        "_type": "tun.started",
        "name": "agent_TT",
        "ipv6_prefix": "bbbb",
        "ipv6_host": ":3",
        "ipv4_host": None,
        "ipv4_network": None,
        "ipv4_netmask": None,
652
        "ipv6_no_forwarding": False,
Federico Sismondi's avatar
Federico Sismondi committed
653 654
    }

655

656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676
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]}


677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695
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]}
696

697 698

# # # # # # SESSION MESSAGES # # # # # #
699

700
class MsgTestingToolTerminate(Message):
701
    """
702
    Requirements: TT MUST listen to event, and handle a gracefully termination of all it's processes
Federico Sismondi's avatar
Federico Sismondi committed
703

704
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
705

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

708
    Description: Testing tool should stop all it's processes gracefully.
709
    """
710
    routing_key = "control.session"
711 712

    _msg_data_template = {
713
        "_type": "testingtool.terminate",
714
        "description": "Event TERMINATE testing tool execution"
715 716 717 718 719
    }


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

722
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
723

724
    Pub/Sub: Testing Tool -> GUI
Federico Sismondi's avatar
Federico Sismondi committed
725

726
    Description: Used to indicate to the GUI that testing is ready to start the test suite
727
    """
728
    routing_key = "control.session"
729 730

    _msg_data_template = {
731 732
        "_type": "testingtool.ready",
        "description": "Event Testing tool READY to start test suite."
733 734 735 736 737
    }


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

740
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
741

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

744
    Description: Once a testing tool's component is ready, it should publish a compoennt ready message
745
    """
746
    routing_key = "control.session"
747 748

    _msg_data_template = {
749
        "_type": "testingtool.component.ready",
750
        "component": "SomeComponent",
751
        "description": "Component READY to start test suite."
752 753 754
    }


755 756 757 758 759 760 761 762 763 764
class MsgSessionChat(Message):
    """
    Requirements: GUI should implement

    Type: Event

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

    Description: Generic descriptor of chat messages
    """
765
    routing_key = "control.session"
766 767 768 769

    _msg_data_template = {
        "_type": "chat",
        "user_name": "Ringo",
770
        "node": "tbd",
771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788
        "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
789
        "component": "misc",
790
        "message": "I've got blisters on my fingers!"
791 792 793
    }


794 795
class MsgSessionConfiguration(Message):
    """
796
    Requirements: TT MUST listen to event, and configure accordingly
797 798 799 800 801

    Type: Event

    Pub/Sub: Orchestrator -> Testing Tool

802
    Description: TT MUST listen to this message and configure the testsuite correspondingly
803 804
    """
    routing_key = "control.session"
805

806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823
    _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
824
class MsgInteropSessionConfiguration(Message):
825
    """
826
    Requirements: TT MUST listen to event
Federico Sismondi's avatar
Federico Sismondi committed
827

828
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
829

830
    Pub/Sub: Orchestrator -> Testing Tool
Federico Sismondi's avatar
Federico Sismondi committed
831

832
    Description: TT MUST listen to this message and configure the testsuite correspondingly
833
    """
834
    routing_key = "control.session"
835 836

    _msg_data_template = {
837 838
        "_type": "session.interop.configuration",
        "session_id": "TBD",
839 840 841 842 843 844 845 846
        "configuration":
            {
                'testsuite.testcases': [
                    'http://doc.f-interop.eu/tests/TD_COAP_CORE_01',
                    'http://doc.f-interop.eu/tests/TD_COAP'
                ]
            },

847
        "testing_tools": "f-interop/interoperability-coap",
848
        "users": [
849 850 851
            "u1",
            "f-interop"
        ],
852
        "tests": [
853
            {
Federico Sismondi's avatar
Federico Sismondi committed
854
                "testcase_ref": "http://doc.f-interop.eu/tests/TD_COAP_CORE_01",
855
                "settings": {}
856 857
            },
            {
Federico Sismondi's avatar
Federico Sismondi committed
858
                "testcase_ref": "http://doc.f-interop.eu/tests/TD_COAP_CORE_02",
859 860 861
                "settings": {}
            },
            {
Federico Sismondi's avatar
Federico Sismondi committed
862
                "testcase_ref": "http://doc.f-interop.eu/tests/TD_COAP_CORE_03",
863
                "settings": {}
864 865 866 867 868
            }
        ]
    }


869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888
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'
    }


889 890
class MsgTestingToolConfigured(Message):
    """
891
    Requirements: TT MUST publish event once session.configuration message has been processed.
Federico Sismondi's avatar
Federico Sismondi committed
892

893
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
894

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

897
    Description: The goal is to notify orchestrator and other components that the testing tool has been configured
898 899 900 901 902
    """

    routing_key = "control.session"

    _msg_data_template = {
903 904 905
        "_type": "testingtool.configured",
        "description": "Event Testing tool CONFIGURED",
        "session_id": "TBD",
906 907 908
        "testing_tools": "f-interop/interoperability-coap",
    }

909

910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
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",
    }


931 932
class MsgTestingToolComponentShutdown(Message):
    """
933
    Requirements: Testing Tool SHOULD implement (other components should not subscribe to event)
Federico Sismondi's avatar
Federico Sismondi committed
934

935
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
936

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

939 940
    Description: tbd
    """
941 942 943
    routing_key = "control.session"

    _msg_data_template = {
944
        "_type": "testingtool.component.shutdown",
945
        "component": "SomeComponent",
946
        "description": "Event Component SHUTDOWN. Bye!"
947 948
    }

949
    # # # # # # TEST COORDINATION MESSAGES # # # # # #
950

951 952 953

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

956
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
957

958
    Pub/Sub: GUI -> Testing Tool
Federico Sismondi's avatar
Federico Sismondi committed
959

960
    Description: tbd
961 962
    """

963
    # TODO change to control.testsuite
964
    routing_key = "control.testcoordination"
965 966

    _msg_data_template = {
967
        "_type": "testcoordination.testsuite.start",
968
        "description": "Event test suite START"
969 970
    }

971

Federico Sismondi's avatar
Federico Sismondi committed
972 973 974 975 976 977 978 979 980 981 982
class MsgTestSuiteStarted(Message):
    """
    Requirements: Testing Tool SHOULD publish to event

    Type: Event

    Pub/Sub: Testing Tool -> GUI

    Description: tbd
    """

983
    # TODO change to control.testsuite
Federico Sismondi's avatar
Federico Sismondi committed
984 985 986 987 988 989
    routing_key = "control.testcoordination"

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

991

992 993
class MsgTestSuiteFinish(Message):
    """
994
    Requirements: TT MUST listen to event
Federico Sismondi's avatar
Federico Sismondi committed
995

996
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
997

998
    Pub/Sub: GUI -> Testing Tool
Federico Sismondi's avatar
Federico Sismondi committed
999

1000
    Description: tbd
1001 1002
    """

1003
    # TODO change to control.testsuite
1004 1005 1006
    routing_key = "control.testcoordination"

    _msg_data_template = {
1007
        "_type": "testcoordination.testsuite.finish",
1008
        "description": "Event test suite FINISH"
1009 1010
    }

1011

1012 1013
class MsgTestCaseReady(Message):
    """
1014
    Requirements: TT MUST publish event
Federico Sismondi's avatar
Federico Sismondi committed
1015

1016
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
1017

Federico Sismondi's avatar
Federico Sismondi committed
1018
    Pub/Sub: Testing Tool -> GUI
Federico Sismondi's avatar
Federico Sismondi committed
1019

1020 1021 1022
    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)
1023 1024
    """

1025
    # TODO change to control.testsuite
1026
    routing_key = "control.testcoordination"
1027 1028

    _msg_data_template = {
1029
        "_type": "testcoordination.testcase.ready",
Federico Sismondi's avatar
Federico Sismondi committed
1030 1031 1032
        "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",
1033 1034
        "objective": "Perform GET transaction(CON mode)",
        "state": None
1035 1036 1037
    }


1038 1039
class MsgTestCaseStart(Message):
    """
1040
    Requirements: TT MUST listen to event
Federico Sismondi's avatar
Federico Sismondi committed
1041

1042
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
1043

1044
    Pub/Sub: GUI -> Testing Tool
Federico Sismondi's avatar
Federico Sismondi committed
1045

1046 1047
    Description:
        - Message used for indicating the testing tool to start the test case (the one previously selected)
1048 1049
        - if testcase_id is Null then testing tool starts previously announced testcase in message
        "testcoordination.testcase.ready",
1050
    """
1051
    # TODO change to control.testsuite
1052
    routing_key = "control.testcoordination"
1053 1054

    _msg_data_template = {
1055
        "_type": "testcoordination.testcase.start",
1056 1057
        "description": "Event test case START",
        "testcase_id": "TBD",
1058 1059
    }

Federico Sismondi's avatar
Federico Sismondi committed
1060

1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071
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
    """
1072
    # TODO change to control.testsuite
1073 1074 1075 1076 1077 1078 1079
    routing_key = "control.testcoordination"

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

Federico Sismondi's avatar
Federico Sismondi committed
1081

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

1084

1085 1086
class MsgTestCaseConfiguration(Message):
    """
1087
    Requirements: Testing Tool MAY publish event (if needed for executing the test case)
1088 1089 1090 1091 1092 1093
    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
    """
1094 1095

    # TODO change to control.testsuite
1096 1097 1098
    routing_key = "control.testcoordination"
    _msg_data_template = {
        "_type": "testcoordination.testcase.configuration",
Federico Sismondi's avatar
Federico Sismondi committed
1099
        "configuration_id": "COAP_CFG_01",
1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129
        "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
1130

1131
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
1132

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

1135 1136
    Description:
        - Message used to indicate GUI and/or automated-iut which configuration to use.
1137
    """
1138 1139

    # TODO change to control.testsuite
1140 1141 1142
    routing_key = "control.testcoordination"

    _msg_data_template = {
1143
        "_type": "testcoordination.configuration.execute",
Federico Sismondi's avatar
Federico Sismondi committed
1144
        "configuration_id": "COAP_CFG_01",
1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168
        "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"]
             ]
1169 1170 1171
    }


1172 1173 1174 1175 1176 1177 1178 1179 1180 1181
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
1182
        - pixit must be included in this message (pixit = Protocol Implementaiton eXtra Information for Testing)
1183
    """
1184 1185

    # TODO change to control.testsuite
1186 1187 1188 1189 1190
    routing_key = "control.testcoordination"

    _msg_data_template = {
        "_type": "testcoordination.configuration.executed",
        "description": "Event IUT has been configured",
1191
        "node": "coap_server",
Federico Sismondi's avatar
Federico Sismondi committed
1192
        "ipv6_address": "tbd"  # example of pixit
1193 1194 1195
    }


1196 1197
class MsgTestCaseStop(Message):
    """
1198
    Requirements: TT MUST listen to event
Federico Sismondi's avatar
Federico Sismondi committed
1199

1200
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
1201

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

1204 1205
    Description:
        - Message used for indicating the testing tool to stop the test case (the one running).
1206 1207
    """

1208
    # TODO change to control.testsuite
1209
    routing_key = "control.testcoordination"
1210 1211

    _msg_data_template = {
1212
        "_type": "testcoordination.testcase.stop",
1213
        "description": "Event test case STOP"
1214 1215 1216 1217 1218
    }


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

1221
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
1222

1223
    Pub/Sub: GUI -> Testing Tool
Federico Sismondi's avatar
Federico Sismondi committed
1224

1225
    Description: Restart the running test cases.
1226 1227
    """

1228
    # TODO change to control.testsuite
1229
    routing_key = "control.testcoordination"