messages.py 64.8 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
Federico Sismondi's avatar
Federico Sismondi committed
30
MsgTestCaseSkip(_api_version = 0.1.47, _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
Federico Sismondi's avatar
Federico Sismondi committed
41
MsgTestCaseSkip(_api_version = 0.1.47, _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()
Federico Sismondi's avatar
Federico Sismondi committed
47
'{"_api_version": "0.1.47", "_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()
Federico Sismondi's avatar
Federico Sismondi committed
52
'{"_api_version": "0.1.47", "_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
Federico Sismondi's avatar
Federico Sismondi committed
65
MsgErrorReply(_api_version = 0.1.47, _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

Federico Sismondi's avatar
Federico Sismondi committed
83
API_VERSION = '0.1.47'
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)


95 96
class Message:
    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 111 112
            if self.routing_key.endswith(".service"):
                self._properties["reply_to"] = "%s.%s" % (self.routing_key, "reply")
                self._properties["correlation_id"] = self._properties["message_id"]
113
        except AttributeError:
114
            pass
115

116
        # rewrite default data fields with the passed args
117 118 119
        self._msg_data.update(kwargs)

        # add API's version
120
        self._msg_data["_api_version"] = API_VERSION
121 122 123 124 125

        # add values as objects attributes
        for key in self._msg_data:
            setattr(self, key, self._msg_data[key])

126 127 128 129
        # add props as objects attributes
        for key in self._properties:
            setattr(self, key, self._properties[key])

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

136
        return OrderedDict(sorted(resp.items(), key=lambda t: t[0]))  # sorted by key
137 138 139 140

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

141
    def get_properties(self):
142 143 144 145
        resp = OrderedDict()
        for field in self._properties:
            resp[field] = getattr(self, field)
        return resp
146

147
    def __str__(self):
148 149 150 151 152 153 154
        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
155
        return s
156

157 158 159 160 161
    def update_properties(self, **kwargs):
        for key, value in kwargs.items():
            if key in self._properties:
                setattr(self, key, value)

162 163
    @classmethod
    def from_json(cls, body):
164 165 166 167 168 169 170 171 172 173
        """
        :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:
174
            message_dict = json.loads(body.decode("utf-8"))
175
        else:
176
            raise NonCompliantMessageFormatError("Not a Json")
177

178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
        # check fist if it's a response
        if "ok" in message_dict:
            # cannot build a complete reply message just from the json representation
            return

        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

194
        # check fist if it's a response
195
        if "ok" in message_dict:
196
            # cannot build a complete reply message just from the json representation
197
            return
198

199
        message_type = message_dict["_type"]
200

201 202 203
        if message_type in message_types_dict:
            return message_types_dict[message_type](**message_dict)
        else:
204 205
            raise NonCompliantMessageFormatError("Cannot load json message: %s" % str(message_dict))

206
    def __repr__(self):
207
        ret = "%s(" % self.__class__.__name__
208
        for key, value in self.to_dict().items():
209 210
            ret += "%s = %s, " % (key, value)
        ret += ")"
211 212
        return ret

213

214 215 216 217 218
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
    """
219

220 221 222 223 224 225 226
    def __init__(self, request_message, **kwargs):
        assert request_message

        self.routing_key = request_message.routing_key + ".reply"

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

233
        super(MsgReply, self).__init__(**kwargs)
234

235
        # overwrite correlation id template and attribute
236
        self._properties["correlation_id"] = request_message.correlation_id
237 238 239 240 241
        self.correlation_id = request_message.correlation_id


class MsgErrorReply(MsgReply):
    """
242
    see section "F-Interop conventions" on top
243
    """
244

245 246
    def __init__(self, request_message, **kwargs):
        assert request_message
247
        # msg_data_template doesnt include _type cause this class is generic, we can only get this at init from request
248
        # so, let's copy the _type from request and let the MsgReply handle the rest of the fields
249
        self._msg_data_template["_type"] = request_message._type
250
        super(MsgErrorReply, self).__init__(request_message, **kwargs)
251 252

    _msg_data_template = {
253
        "ok": False,
254
        "error_message": "Some error message TBD",
255
        "error_code": "Some error code TBD"
256 257
    }

258 259

# # # # # # AGENT MESSAGES # # # # # #
Federico Sismondi's avatar
Federico Sismondi committed
260 261 262

class MsgAgentTunStart(Message):
    """
263
    Requirements: Testing Tool MAY implement (if IP tun needed)
Federico Sismondi's avatar
Federico Sismondi committed
264

265
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
266

267
    Pub/Sub: Testing Tool -> Agent
Federico Sismondi's avatar
Federico Sismondi committed
268

269
    Description: Message for triggering start IP tun interface in OS where the agent is running
Federico Sismondi's avatar
Federico Sismondi committed
270
    """
271
    routing_key = "control.tun.toAgent.agent_TT"
Federico Sismondi's avatar
Federico Sismondi committed
272 273

    _msg_data_template = {
274 275 276 277
        "_type": "tun.start",
        "name": "agent_TT",
        "ipv6_prefix": "bbbb",
        "ipv6_host": ":3",
278
        "ipv6_no_forwarding": False,
279 280 281
        "ipv4_host": None,
        "ipv4_network": None,
        "ipv4_netmask": None,
Federico Sismondi's avatar
Federico Sismondi committed
282 283 284
    }


285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
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
305 306
class MsgAgentTunStarted(Message):
    """
307
    Description: Message for indicating that agent tun has been started
Federico Sismondi's avatar
Federico Sismondi committed
308

309
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
310

311
    Pub/Sub: Agent -> Testing Tool
Federico Sismondi's avatar
Federico Sismondi committed
312

313
    Description: TBD
Federico Sismondi's avatar
Federico Sismondi committed
314
    """
315
    routing_key = "control.tun.from.tbd"
Federico Sismondi's avatar
Federico Sismondi committed
316 317

    _msg_data_template = {
318 319 320 321 322 323 324
        "_type": "tun.started",
        "name": "agent_TT",
        "ipv6_prefix": "bbbb",
        "ipv6_host": ":3",
        "ipv4_host": None,
        "ipv4_network": None,
        "ipv4_netmask": None,
325
        "ipv6_no_forwarding": False,
Federico Sismondi's avatar
Federico Sismondi committed
326 327
    }

328

329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
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]}


350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
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]}
369

370 371

# # # # # # SESSION MESSAGES # # # # # #
372

373
class MsgTestingToolTerminate(Message):
374
    """
375
    Requirements: Testing Tool MUST listen to event
Federico Sismondi's avatar
Federico Sismondi committed
376

377
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
378

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

381
    Description: Testing tool should stop all it's processes gracefully.
382
    """
383
    routing_key = "control.session"
384 385

    _msg_data_template = {
386
        "_type": "testingtool.terminate",
387
        "description": "Event TERMINATE testing tool execution"
388 389 390 391 392
    }


class MsgTestingToolReady(Message):
    """
393
    Requirements: Testing Tool MUST publish event
Federico Sismondi's avatar
Federico Sismondi committed
394

395
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
396

397
    Typcal_use: Testing Tool -> GUI
Federico Sismondi's avatar
Federico Sismondi committed
398

399
    Description: Used to indicate to the GUI that testing is ready to start the test suite
400
    """
401
    routing_key = "control.session"
402 403

    _msg_data_template = {
404 405
        "_type": "testingtool.ready",
        "description": "Event Testing tool READY to start test suite."
406 407 408 409 410
    }


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

413
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
414

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

417
    Description: Once a testing tool's component is ready, it should publish a compoennt ready message
418
    """
419
    routing_key = "control.session"
420 421

    _msg_data_template = {
422
        "_type": "testingtool.component.ready",
423
        "component": "SomeComponent",
424
        "description": "Component READY to start test suite."
425 426 427
    }


428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
class MsgSessionChat(Message):
    """
    Requirements: GUI should implement

    Type: Event

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

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

    _msg_data_template = {
        "_type": "chat",
        "user_name": "Ringo",
        "iut_node": "tbd",
        "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
462
        "component": "misc",
463
        "message": "I've got blisters on my fingers!"
464 465 466 467 468
    }


# TODO delete "Interop" to generalize

469
class MsgInteropSessionConfiguration(Message):
470
    """
471
    Requirements: Testing Tool MUST listen to event
Federico Sismondi's avatar
Federico Sismondi committed
472

473
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
474

475
    Pub/Sub: Orchestrator -> Testing Tool
Federico Sismondi's avatar
Federico Sismondi committed
476

477
    Description: Testing tool MUST listen to this message and configure the testsuite correspondingly
478
    """
479
    routing_key = "control.session"
480 481

    _msg_data_template = {
482 483
        "_type": "session.interop.configuration",
        "session_id": "TBD",
484
        "testing_tools": "f-interop/interoperability-coap",
485
        "users": [
486 487 488
            "u1",
            "f-interop"
        ],
489
        "iuts": [
490
            {
491 492
                "id": "someImplementationFromAUser",
                "role": "coap_server",
493
                "execution_mode": "user-assisted",
494 495 496
                "location": "user-facilities",
                "owner": "someUserName",
                "version": "0.1"
497 498
            },
            {
499 500
                "id": "automated_iut-coap_client-coapthon-v0.1",
                "role": "coap_client",
501
                "execution_mode": "automated-iut",
502 503 504
                "location": "central-server-docker",
                "owner": "f-interop",
                "version": "0.1"
505 506
            }
        ],
507
        "tests": [
508
            {
Federico Sismondi's avatar
Federico Sismondi committed
509
                "testcase_ref": "http://doc.f-interop.eu/tests/TD_COAP_CORE_01",
510
                "settings": {}
511 512
            },
            {
Federico Sismondi's avatar
Federico Sismondi committed
513
                "testcase_ref": "http://doc.f-interop.eu/tests/TD_COAP_CORE_02",
514 515 516
                "settings": {}
            },
            {
Federico Sismondi's avatar
Federico Sismondi committed
517
                "testcase_ref": "http://doc.f-interop.eu/tests/TD_COAP_CORE_03",
518
                "settings": {}
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
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'
    }


544 545
class MsgTestingToolConfigured(Message):
    """
546
    Requirements: Testing Tool MUST publish event
Federico Sismondi's avatar
Federico Sismondi committed
547

548
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
549

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

552
    Description: The goal is to notify orchestrator and other components that the testing tool has been configured
553 554 555 556 557
    """

    routing_key = "control.session"

    _msg_data_template = {
558 559 560
        "_type": "testingtool.configured",
        "description": "Event Testing tool CONFIGURED",
        "session_id": "TBD",
561 562 563
        "testing_tools": "f-interop/interoperability-coap",
    }

564

565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585
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",
    }


586 587
class MsgTestingToolComponentShutdown(Message):
    """
588
    Requirements: Testing Tool SHOULD implement (other components should not subscribe to event)
Federico Sismondi's avatar
Federico Sismondi committed
589

590
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
591

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

594 595
    Description: tbd
    """
596 597 598
    routing_key = "control.session"

    _msg_data_template = {
599
        "_type": "testingtool.component.shutdown",
600
        "component": "SomeComponent",
601
        "description": "Event Component SHUTDOWN. Bye!"
602 603
    }

604
    # # # # # # TEST COORDINATION MESSAGES # # # # # #
605

606 607 608

class MsgTestSuiteStart(Message):
    """
609
    Requirements: Testing Tool MUST listen to event
Federico Sismondi's avatar
Federico Sismondi committed
610

611
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
612

613
    Pub/Sub: GUI -> Testing Tool
Federico Sismondi's avatar
Federico Sismondi committed
614

615
    Description: tbd
616 617
    """

618
    routing_key = "control.testcoordination"
619 620

    _msg_data_template = {
621
        "_type": "testcoordination.testsuite.start",
622
        "description": "Event test suite START"
623 624
    }

Federico Sismondi's avatar
Federico Sismondi committed
625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641
class MsgTestSuiteStarted(Message):
    """
    Requirements: Testing Tool SHOULD publish to event

    Type: Event

    Pub/Sub: Testing Tool -> GUI

    Description: tbd
    """

    routing_key = "control.testcoordination"

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

643 644
class MsgTestSuiteFinish(Message):
    """
645
    Requirements: Testing Tool MUST listen to event
Federico Sismondi's avatar
Federico Sismondi committed
646

647
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
648

649
    Pub/Sub: GUI -> Testing Tool
Federico Sismondi's avatar
Federico Sismondi committed
650

651
    Description: tbd
652 653 654 655 656
    """

    routing_key = "control.testcoordination"

    _msg_data_template = {
657
        "_type": "testcoordination.testsuite.finish",
658
        "description": "Event test suite FINISH"
659 660
    }

661

662 663
class MsgTestCaseReady(Message):
    """
664
    Requirements: Testing Tool MUST publish event
Federico Sismondi's avatar
Federico Sismondi committed
665

666
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
667

Federico Sismondi's avatar
Federico Sismondi committed
668
    Pub/Sub: Testing Tool -> GUI
Federico Sismondi's avatar
Federico Sismondi committed
669

670 671 672
    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)
673 674
    """

675
    routing_key = "control.testcoordination"
676 677

    _msg_data_template = {
678
        "_type": "testcoordination.testcase.ready",
Federico Sismondi's avatar
Federico Sismondi committed
679 680 681
        "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",
682 683
        "objective": "Perform GET transaction(CON mode)",
        "state": None
684 685 686
    }


687 688
class MsgTestCaseStart(Message):
    """
689
    Requirements: Testing Tool MUST listen to event
Federico Sismondi's avatar
Federico Sismondi committed
690

691
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
692

693
    Pub/Sub: GUI -> Testing Tool
Federico Sismondi's avatar
Federico Sismondi committed
694

695 696
    Description:
        - Message used for indicating the testing tool to start the test case (the one previously selected)
697 698
        - if testcase_id is Null then testing tool starts previously announced testcase in message
        "testcoordination.testcase.ready",
699
    """
700
    routing_key = "control.testcoordination"
701 702

    _msg_data_template = {
703
        "_type": "testcoordination.testcase.start",
704 705
        "description": "Event test case START",
        "testcase_id": "TBD",
706 707
    }

Federico Sismondi's avatar
Federico Sismondi committed
708

709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726
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
    """
    routing_key = "control.testcoordination"

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

Federico Sismondi's avatar
Federico Sismondi committed
728

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

731

732 733
class MsgTestCaseConfiguration(Message):
    """
734
    Requirements: Testing Tool MAY publish event (if needed for executing the test case)
735 736 737 738 739 740 741 742 743
    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
    """
    routing_key = "control.testcoordination"
    _msg_data_template = {
        "_type": "testcoordination.testcase.configuration",
Federico Sismondi's avatar
Federico Sismondi committed
744
        "configuration_id": "COAP_CFG_01",
745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774
        "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
775

776
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
777

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

780 781
    Description:
        - Message used to indicate GUI and/or automated-iut which configuration to use.
782 783 784 785
    """
    routing_key = "control.testcoordination"

    _msg_data_template = {
786
        "_type": "testcoordination.configuration.execute",
Federico Sismondi's avatar
Federico Sismondi committed
787
        "configuration_id": "COAP_CFG_01",
788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811
        "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"]
             ]
812 813 814
    }


815 816 817 818 819 820 821 822 823 824
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
825
        - pixit must be included in this message (pixit = Protocol Implementaiton eXtra Information for Testing)
826 827 828 829 830 831
    """
    routing_key = "control.testcoordination"

    _msg_data_template = {
        "_type": "testcoordination.configuration.executed",
        "description": "Event IUT has been configured",
832
        "node": "coap_server",
Federico Sismondi's avatar
Federico Sismondi committed
833
        "ipv6_address": "tbd"  # example of pixit
834 835 836
    }


837 838
class MsgTestCaseStop(Message):
    """
839
    Requirements: Testing Tool MUST listen to event
Federico Sismondi's avatar
Federico Sismondi committed
840

841
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
842

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

845 846
    Description:
        - Message used for indicating the testing tool to stop the test case (the one running).
847 848
    """

849
    routing_key = "control.testcoordination"
850 851

    _msg_data_template = {
852
        "_type": "testcoordination.testcase.stop",
853
        "description": "Event test case STOP"
854 855 856 857 858
    }


class MsgTestCaseRestart(Message):
    """
859
    Requirements: Testing Tool MUST listen to event
Federico Sismondi's avatar
Federico Sismondi committed
860

861
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
862

863
    Pub/Sub: GUI -> Testing Tool
Federico Sismondi's avatar
Federico Sismondi committed
864

865
    Description: Restart the running test cases.
866 867
    """

868
    routing_key = "control.testcoordination"
869 870

    _msg_data_template = {
871
        "_type": "testcoordination.testcase.restart",
872
        "description": "Event test case RESTART"
873 874
    }

875

876
class MsgStepStimuliExecute(Message):
877
    """
878
    Requirements: Testing Tool MUST publish event
879

880
    Type: Event
881

882
    Pub/Sub: Testing Tool -> GUI
883

884
    Description:
885 886
        - Used to indicate to the GUI (or automated-iut) which is the stimuli step to be executed by the user (or
        automated-IUT).
887 888
    """

889
    routing_key = "control.testcoordination"
890 891

    _msg_data_template = {
892
        "_type": "testcoordination.step.stimuli.execute",
Federico Sismondi's avatar
Federico Sismondi committed
893 894
        "description": "Please execute TD_COAP_CORE_01_step_01",
        "step_id": "TD_COAP_CORE_01_step_01",
895 896
        "step_type": "stimuli",
        "step_info": [
897 898 899 900
            "Client is requested to send a GET request with",
            "Type = 0(CON)",
            "Code = 1(GET)"
        ],
901 902
        "step_state": "executing",
        "node": "coap_client",
903
        "node_execution_mode": "user_assisted",
904
        "testcase_id": "TBD",
Federico Sismondi's avatar
Federico Sismondi committed
905 906
        "testcase_ref": "TBD",
        "target_address": "TBD"
907 908
    }

909

910
class MsgStepStimuliExecuted(Message):
911
    """
912
    Requirements: Testing Tool MUST listen to event
Federico Sismondi's avatar
Federico Sismondi committed
913

914
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
915

916
    Pub/Sub: GUI (or automated-IUT)-> Testing Tool
Federico Sismondi's avatar
Federico Sismondi committed
917

918 919
    Description:
        - Used to indicate stimuli has been executed by user (and it's user-assisted iut) or by automated-iut
920 921
    """

922
    routing_key = "control.testcoordination"
923 924

    _msg_data_template = {
925
        "_type": "testcoordination.step.stimuli.executed",
926 927 928
        "description": "Event step (stimuli) EXECUTED",
        "node": "coap_client",
        "node_execution_mode": "user_assisted",
929 930 931
    }


932
class MsgStepCheckExecute(Message):
933
    """
934
    Requirements: Testing Tool SHOULD publish event
Federico Sismondi's avatar
Federico Sismondi committed
935

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

938
    Pub/Sub: Testing Tool -> Analysis
Federico Sismondi's avatar
Federico Sismondi committed
939

940 941 942 943 944 945 946 947 948
    Description:
        - Used to indicate to the GUI (or automated-iut) which is the stimuli step to be executed by the user (or
        automated-IUT).
    """

    routing_key = "control.testcoordination"

    _msg_data_template = {
        "_type": "testcoordination.step.check.execute",
Federico Sismondi's avatar
Federico Sismondi committed
949 950
        "description": "Please execute TD_COAP_CORE_01_step_02",
        "step_id": "TD_COAP_CORE_01_step_02",
951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967
        "step_type": "check",
        "step_info": [
            "The request sent by the client contains",
            "Type=0 and Code=1,"
            "Client-generated Message ID (➔ CMID)",
            "Client-generated Token (➔ CTOK)",
            "UTEST Uri-Path option test"
        ],
        "step_state": "executing",
        "testcase_id": "TBD",
        "testcase_ref": "TBD"
    }


class MsgStepCheckExecuted(Message):
    """
    Requirements: Testing Tool SHOULD implement
Federico Sismondi's avatar
Federico Sismondi committed
968

969
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
970

971
    Pub/Sub: test coordination -> test analysis
Federico Sismondi's avatar
Federico Sismondi committed
972

973
    Description:
974 975
        - In the context of IUT to IUT test execution, this message is used for indicating that the previously
        executed
976 977
        messages (stimuli message and its reply) CHECK or comply to what is described in the Test Description.
        - Not used in CoAP testing Tool (analysis of traces is done post mortem)
978 979
    """

980
    routing_key = "control.testcoordination"
981

982
    _msg_data_template = {
983
        "_type": "testcoordination.step.check.executed",
984
        "partial_verdict": "pass",
985
        "description": "TAT says: step complies (checks) with specification",
986 987 988
    }


989
class MsgStepVerifyExecute(Message):
990
    """
991
    Requirements: Testing Tool MUST publish event
Federico Sismondi's avatar
Federico Sismondi committed
992

993
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
994

995
    Pub/Sub: Testing Tool -> GUI (or automated-IUT)
Federico Sismondi's avatar
Federico Sismondi committed
996

997
    Description:
998 999
        - Used to indicate to the GUI (or automated-iut) which is the verify step to be executed by the user (or
        automated-IUT).
1000 1001
    """

1002
    routing_key = "control.testcoordination"
1003 1004

    _msg_data_template = {
1005 1006
        "_type": "testcoordination.step.verify.execute",
        "response_type": "bool",
Federico Sismondi's avatar
Federico Sismondi committed
1007 1008
        "description": "Please execute TD_COAP_CORE_01_step_04",
        "step_id": "TD_COAP_CORE_01_step_04",
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
        "step_type": "verify",
        "step_info": [
            "Client displays the received information"
        ],
        "node": "coap_client",
        "node_execution_mode": "user_assisted",
        "step_state": "executing",
        "testcase_id": "TBD",
        "testcase_ref": "TBD"

1019 1020
    }

1021

1022
class MsgStepVerifyExecuted(Message):
1023
    """
1024
    Requirements: Testing Tool MUST listen to event
Federico Sismondi's avatar
Federico Sismondi committed
1025

1026
    Type: Event
Federico Sismondi's avatar
Federico Sismondi committed
1027

1028
    Pub/Sub: GUI (or automated-IUT)-> Testing Tool
Federico Sismondi's avatar
Federico Sismondi committed
1029

1030
    Description:
1031
        - Message generated by user (GUI or automated-IUT) declaring if the IUT VERIFY verifies the expected behaviour.
1032 1033
    """

1034
    routing_key = "control.testcoordination"
1035 1036

    _msg_data_template = {
1037 1038 1039 1040 1041 1042
        "_type": "testcoordination.step.verify.executed",
        "description": "Event step (verify) EXECUTED",
        "response_type": "bool",
        "verify_response": True,
        "node": "coap_client",
        "node_execution_mode": "user_assisted",
1043 1044
    }

1045 1046 1047 1048 1049 1050
    # class MsgTestCaseFinish(Message):
    #     """
    #     TODO: TBD if needed or not
    #
    #     Requirements: Testing Tool MAY listen to event
    #     Type: Event
1051
    #     Pub/Sub: GUI (or automated-IUT)-> Testing Tool