messages.py 49.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
# -*- coding: utf-8 -*-

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

Usage:
------
15
>>> from messages import * # doctest: +SKIP
16
>>> m = MsgTestCaseSkip()
17
>>> m
18
MsgTestCaseSkip(_api_version = 0.1.29, _type = testcoordination.testcase.skip, testcase_id = TD_COAP_CORE_02_v01, )
19 20
>>> m.routing_key
'control.testcoordination'
21 22
>>> m.message_id # doctest: +SKIP
'802012eb-24e3-45c4-9dcc-dc293c584f63'
23 24
>>> m.testcase_id
'TD_COAP_CORE_02_v01'
25

26 27 28
# also we can modify some of the fields (rewrite the default ones)
>>> m = MsgTestCaseSkip(testcase_id = 'TD_COAP_CORE_03_v01')
>>> m
29
MsgTestCaseSkip(_api_version = 0.1.29, _type = testcoordination.testcase.skip, testcase_id = TD_COAP_CORE_03_v01, )
30 31
>>> m.testcase_id
'TD_COAP_CORE_03_v01'
32

33 34
# and even export the message in json format (for example for sending the message though the amqp event bus)
>>> m.to_json()
35
'{"_api_version": "0.1.29", "_type": "testcoordination.testcase.skip", "testcase_id": "TD_COAP_CORE_03_v01"}'
Federico Sismondi's avatar
Federico Sismondi committed
36

37
# We can use the Message class to import json into Message objects:
Federico Sismondi's avatar
Federico Sismondi committed
38 39
>>> m=MsgTestSuiteStart()
>>> m.to_json()
40
'{"_api_version": "0.1.29", "_type": "testcoordination.testsuite.start"}'
Federico Sismondi's avatar
Federico Sismondi committed
41 42 43
>>> json_message = m.to_json()
>>> obj=Message.from_json(json_message)
>>> type(obj)
44
<class 'messages.MsgTestSuiteStart'>
45

46
# We can use the library for generating error responses:
47 48 49 50 51 52
# the request:
>>> m = MsgSniffingStart()
>>>
# the error reply (note that we pass the message of the request to build the reply):
>>> err = MsgErrorReply(m)
>>> err
53
MsgErrorReply(_api_version = 0.1.29, _type = sniffing.start, error_code = Some error code TBD, error_message = Some error message TBD, ok = False, )
54 55 56 57 58 59 60 61 62
>>> 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
63

64 65 66
"""

from collections import OrderedDict
67
import time
68 69 70
import json
import uuid

71
API_VERSION = '0.1.29'
72

73 74 75 76 77 78 79 80 81 82 83

# TODO use metaclasses instead?

class NonCompliantMessageFormatError(Exception):
    def __init__(self, value):
        self.value = value

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


84 85
class Message:
    def __init__(self, **kwargs):
86 87 88
        global API_VERSION

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

91 92
        # init properties
        self._properties = dict(
93
                content_type="application/json",
94
                message_id=str(uuid.uuid4()),
95
                timestamp=int(time.time())
96 97
        )

98
        try:
99 100 101
            if self.routing_key.endswith(".service"):
                self._properties["reply_to"] = "%s.%s" % (self.routing_key, "reply")
                self._properties["correlation_id"] = self._properties["message_id"]
102
        except AttributeError:
103
            pass
104

105
        # rewrite default data fields with the passed args
106 107 108
        self._msg_data.update(kwargs)

        # add API's version
109
        self._msg_data["_api_version"] = API_VERSION
110 111 112 113 114

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

115 116 117 118
        # add props as objects attributes
        for key in self._properties:
            setattr(self, key, self._properties[key])

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

125
        return OrderedDict(sorted(resp.items(), key=lambda t: t[0]))  # sorted by key
126 127 128 129

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

130
    def get_properties(self):
131 132 133 134
        resp = OrderedDict()
        for field in self._properties:
            resp[field] = getattr(self, field)
        return resp
135

136
    def __str__(self):
137 138 139 140 141 142 143
        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
144
        return s
145

146 147 148 149 150
    def update_properties(self, **kwargs):
        for key, value in kwargs.items():
            if key in self._properties:
                setattr(self, key, value)

151 152
    @classmethod
    def from_json(cls, body):
153 154 155 156 157 158 159 160 161 162
        """
        :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:
163
            message_dict = json.loads(body.decode("utf-8"))
164
        else:
165
            raise NonCompliantMessageFormatError("Not a Json")
166

167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
        # 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

183
        # check fist if it's a response
184
        if "ok" in message_dict:
185
            # cannot build a complete reply message just from the json representation
186
            return
187

188
        message_type = message_dict["_type"]
189

190 191 192
        if message_type in message_types_dict:
            return message_types_dict[message_type](**message_dict)
        else:
193 194
            raise NonCompliantMessageFormatError("Cannot load json message: %s" % str(message_dict))

195

196
    def __repr__(self):
197
        ret = "%s(" % self.__class__.__name__
198
        for key, value in self.to_dict().items():
199 200
            ret += "%s = %s, " % (key, value)
        ret += ")"
201 202
        return ret

203

204 205 206 207 208
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
    """
209

210 211 212 213 214 215 216
    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)
217
        if not hasattr(self, "_msg_data_template"):
218
            self._msg_data_template = {
219 220
                "_type": request_message._type,
                "ok":    True,
221 222
            }

223
        super(MsgReply, self).__init__(**kwargs)
224

225
        # overwrite correlation id template and attribute
226
        self._properties["correlation_id"] = request_message.correlation_id
227 228 229 230 231 232 233 234 235 236 237
        self.correlation_id = request_message.correlation_id


class MsgErrorReply(MsgReply):
    """
    F-Interop conventions:
        - if event is a service request then the routing keys is control.someFunctionality.service
        also, its reply will be control.someFunctionality.service.reply
        - reply.correlation_id = request.correlation_id

    """
238

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

    _msg_data_template = {
247 248 249
        "ok":            False,
        "error_message": "Some error message TBD",
        "error_code":    "Some error code TBD"
250 251
    }

252 253

# # # # # # AGENT MESSAGES # # # # # #
Federico Sismondi's avatar
Federico Sismondi committed
254 255 256 257 258

class MsgAgentTunStart(Message):
    """
    Message for triggering start IP tun interface in OS where the agent is running
    """
259
    routing_key = "control.tun.toAgent.agent_TT"
Federico Sismondi's avatar
Federico Sismondi committed
260 261

    _msg_data_template = {
262 263 264 265 266 267 268 269
        "_type":              "tun.start",
        "name":               "agent_TT",
        "ipv6_prefix":        "bbbb",
        "ipv6_host":          ":3",
        "ipv6_no_forwarding": False,
        "ipv4_host":          None,
        "ipv4_network":       None,
        "ipv4_netmask":       None,
Federico Sismondi's avatar
Federico Sismondi committed
270 271 272 273 274 275 276
    }


class MsgAgentTunStarted(Message):
    """
    Message for indicating that agent tun has been started
    """
277
    routing_key = "control.tun.from.agent_TT"
Federico Sismondi's avatar
Federico Sismondi committed
278 279

    _msg_data_template = {
280 281 282 283 284 285 286 287
        "_type":              "tun.started",
        "name":               "agent_TT",
        "ipv6_prefix":        "bbbb",
        "ipv6_host":          ":3",
        "ipv4_host":          None,
        "ipv4_network":       None,
        "ipv4_netmask":       None,
        "ipv6_no_forwarding": False,
Federico Sismondi's avatar
Federico Sismondi committed
288 289
    }

290

Federico Sismondi's avatar
Federico Sismondi committed
291 292 293 294 295 296 297 298
'''
TODO add packet.sniffed.raw
ROUTING_KEY: data.tun.fromAgent.coap_server_agent
 - - -
PROPS: {"delivery_mode": 2, "content_type": "application/json", "headers": {}, "priority": 0, "content_encoding": "utf-8"}
 - - -
BODY {"timestamp": "1488586183.45", "_type": "packet.sniffed.raw", "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]}
'''
299

300 301

# # # # # # SESSION MESSAGES # # # # # #
302

303
class MsgTestingToolTerminate(Message):
304 305 306 307 308
    """
    Testing Tool MUST-implement API endpoint
    GUI, (or Orchestrator?) -> Testing Tool
    Testing tool should stop all it's processes gracefully.
    """
309
    routing_key = "control.session"
310 311

    _msg_data_template = {
312
        "_type": "testingtool.terminate",
313 314 315 316 317 318 319 320 321 322
    }


class MsgTestingToolReady(Message):
    """
    Testing Tool MUST-implement notification.
    Testing Tool -> GUI

    Used to indicate to the GUI that testing is ready to start the test suite
    """
323
    routing_key = "control.session"
324 325

    _msg_data_template = {
326
        "_type":   "testingtool.ready",
327 328 329 330 331 332 333 334 335 336
        "message": "Testing tool ready to start test suite."
    }


class MsgTestingToolComponentReady(Message):
    """
    Testing Tools'internal call.
    Component x -> Test Coordinator
    Testing Tool SHOULD implement (design recommendation)
    """
337
    routing_key = "control.session"
338 339

    _msg_data_template = {
340 341
        "_type":     "testingtool.component.ready",
        "component": "SomeComponent",
342
        "message":   "Component ready to start test suite."
343 344 345
    }


346
class MsgInteropSessionConfiguration(Message):
347
    """
348 349 350
    Testing Tool MUST-implement API endpoint
    Orchestrator -> Testing Tool
    Testing tool should listen to this message and configure the testsuite correspondingly
351
    """
352
    routing_key = "control.session"
353 354

    _msg_data_template = {
355
        "_type":         "session.interop.configuration",
Federico Sismondi's avatar
Federico Sismondi committed
356
        "session_id":    "TBD",
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
        "testing_tools": "f-interop/interoperability-coap",
        "users":         [
            "u1",
            "f-interop"
        ],
        "iuts":          [
            {
                "id":             "someImplementationFromAUser",
                "role":           "coap_server",
                "execution_mode": "user-assisted",
                "location":       "user-facilities",
                "owner":          "someUserName",
                "version":        "0.1"
            },
            {
                "id":             "automated_iut-coap_client-coapthon-v0.1",
                "role":           "coap_client",
                "execution_mode": "automated-iut",
                "location":       "central-server-docker",
                "owner":          "f-interop",
                "version":        "0.1"
            }
        ],
        "tests":         [
            {
                "testcase_ref": "http://doc.f-interop.eu/tests/TD_COAP_CORE_01_v01",
383
                "settings":     {}
384 385 386
            },
            {
                "testcase_ref": "http://doc.f-interop.eu/tests/TD_COAP_CORE_02_v01",
387
                "settings":     {}
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
            }
        ]
    }


class MsgTestingToolConfigured(Message):
    """
    Testing Tool MUST-implement notification.
    Testing Tool -> Orchestrator, GUI
    Notify orchestrator and other components that the testing tool has been configured
    """

    routing_key = "control.session"

    _msg_data_template = {
        "_type":         "testingtool.configured",
        "session_id":    "8ea6b6d5-ffcc-4a0e-ba93-92ee1befea23",
        "testing_tools": "f-interop/interoperability-coap",
    }

408

409 410 411 412 413 414 415 416 417 418 419
class MsgTestingToolComponentShutdown(Message):
    """
        Testing Tools'internal call.
        Component x -> Test Coordinator
        Testing Tool SHOULD implement (design recommendation)
        """
    routing_key = "control.session"

    _msg_data_template = {
        "_type":     "testingtool.component.shutdown",
        "component": "SomeComponent",
420
        "message":   "Component is shutting down. Bye!"
421 422
    }

423
    # # # # # # TEST COORDINATION MESSAGES # # # # # #
424

425 426 427 428 429 430 431

class MsgTestSuiteStart(Message):
    """
    Testing Tool MUST-implement API endpoint
    GUI -> Testing Tool
    """

432
    routing_key = "control.testcoordination"
433 434

    _msg_data_template = {
435
        "_type": "testcoordination.testsuite.start",
436 437 438
    }


439 440 441 442 443 444 445 446 447
class MsgTestSuiteFinish(Message):
    """
    Testing Tool MUST-implement API endpoint
    GUI -> Testing Tool
    """

    routing_key = "control.testcoordination"

    _msg_data_template = {
448
        "_type": "testcoordination.testsuite.finish",
449 450
    }

451

452 453 454 455 456 457 458 459 460
class MsgTestCaseReady(Message):
    """
    Testing Tool MUST-implement notification.
    Testing Tool -> GUI

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

461
    routing_key = "control.testcoordination"
462 463

    _msg_data_template = {
464 465 466
        "_type":        "testcoordination.testcase.ready",
        "message":      "Next test case to be executed is TD_COAP_CORE_01_v01",
        "testcase_id":  "TD_COAP_CORE_01_v01",
467
        "testcase_ref": "http://doc.f-interop.eu/tests/TD_COAP_CORE_01_v01",
468 469
        "objective":    "Perform GET transaction(CON mode)",
        "state":        None
470 471 472
    }


473 474 475 476 477 478
class MsgTestCaseStart(Message):
    """
    Testing Tool MUST-implement API endpoint
    GUI -> Testing Tool
    Message used for indicating the testing tool to start the test case (the one previously selected)
    """
479
    routing_key = "control.testcoordination"
480 481

    _msg_data_template = {
482
        "_type": "testcoordination.testcase.start",
483 484 485
    }


486 487 488 489 490 491 492 493 494
class MsgTestCaseConfiguration(Message):
    """
    Testing Tool MUST-implement notification
    Testing Tool -> GUI
    Messages used to indicate GUI which configuration to use.
    """
    routing_key = "control.testcoordination"

    _msg_data_template = {
495
        "_type":            "testcoordination.testcase.configuration",
496
        "configuration_id": "COAP_CFG_01_v01",
497 498 499
        "node":             "coap_server",
        "testcase_id":      "TBD",
        "testcase_ref":     "TBD",
500
        "message":
501 502 503 504 505 506 507 508 509 510 511
                            ["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"],
512 513
                             ["/large_create",
                              "Large resource that can be  created using POST method (>1024 bytes)",
514 515 516 517 518
                              "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"]
                             ]
519 520 521
    }


522 523 524 525 526 527 528
class MsgTestCaseStop(Message):
    """
    Testing Tool MUST-implement API endpoint
    GUI -> Testing Tool
    Message used for indicating the testing tool to stop the test case (the one running)
    """

529
    routing_key = "control.testcoordination"
530 531

    _msg_data_template = {
532
        "_type": "testcoordination.testcase.stop",
533 534 535 536 537 538 539 540 541
    }


class MsgTestCaseRestart(Message):
    """
    Testing Tool MUST-implement API endpoint
    GUI -> Testing Tool
    """

542
    routing_key = "control.testcoordination"
543 544

    _msg_data_template = {
545
        "_type": "testcoordination.testcase.restart",
546 547
    }

548 549 550 551 552 553 554 555 556

class MsgStepExecute(Message):
    """
    Testing Tool MUST-implement notification.
    Testing Tool -> GUI

    Used to indicate to the GUI (or automated-iut) which is the step to be executed by the user (or automated-IUT)
    """

557
    routing_key = "control.testcoordination"
558 559

    _msg_data_template = {
560 561 562 563 564
        "_type":               "testcoordination.step.execute",
        "message":             "Next test step to be executed is TD_COAP_CORE_01_v01_step_01",
        "step_id":             "TD_COAP_CORE_01_v01_step_01",
        "step_type":           "stimuli",
        "step_info":           [
565 566 567 568
            "Client is requested to send a GET request with",
            "Type = 0(CON)",
            "Code = 1(GET)"
        ],
569 570
        "step_state":          "executing",
        "node":                "coap_client",
571
        "node_execution_mode": "user_assisted",
572 573
        "testcase_id":         "TBD",
        "testcase_ref":        "TBD"
574 575
    }

576 577 578 579 580 581 582

class MsgStimuliExecuted(Message):
    """
    Testing Tool MUST-implement API endpoint
    GUI (or automated-IUT)-> Testing Tool
    """

583
    routing_key = "control.testcoordination"
584 585

    _msg_data_template = {
586
        "_type": "testcoordination.step.stimuli.executed",
587 588 589 590 591 592 593 594 595 596 597 598
    }


class MsgCheckResponse(Message):
    """
    Testing Tools'internal call.
    In the context of IUT to IUT test execution, this message is used for indicating that the previously executed
    messages (stimuli message and its reply) CHECK or comply to what is described in the Test Description.
    Testing tools' coordinator -> Testing Tool's analyzer (TAT)
    Not used in CoAP testing Tool (analysis of traces is done post mortem)
    """

599
    routing_key = "control.testcoordination"
600

601
    _msg_data_template = {
602 603 604
        "_type":           "testcoordination.step.check.response",
        "partial_verdict": "pass",
        "description":     "TAT says: step complies (checks) with specification"
605 606 607 608 609 610 611 612 613 614 615
    }


class MsgVerifyResponse(Message):
    """
    Testing Tool MUST-implement API endpoint
    Message provided by user declaring if the IUT VERIFY the step previously executed as described in the Test
    Description.
    GUI (or automated-IUT)-> Testing Tool
    """

616
    routing_key = "control.testcoordination"
617 618

    _msg_data_template = {
619 620 621
        "_type":           "testcoordination.step.verify.response",
        "verify_response": True,
        "response_type":   "bool"
622 623
    }

624

625 626 627 628 629 630 631
class MsgTestCaseFinish(Message):
    """
    Testing Tool MUST-implement API endpoint
    GUI (or automated-IUT)-> Testing Tool
    Not used in CoAP Testing Tool (test coordinator deduces it automatically by using the testcase's step sequence)
    """

632
    routing_key = "control.testcoordination"
633 634

    _msg_data_template = {
635
        "_type": "testcoordination.testcase.finish",
636 637
    }

638

639 640 641 642 643 644 645 646
class MsgTestCaseFinished(Message):
    """
    Testing Tool MUST-implement notification.
    Testing Tool -> GUI

    This message is followed by a verdict
    """

647
    routing_key = "control.testcoordination"
648 649

    _msg_data_template = {
650 651
        "_type":        "testcoordination.testcase.finished",
        "testcase_id":  "TD_COAP_CORE_01",
652
        "testcase_ref": "TBD",
653
        "message":      "Testcase finished"
654 655
    }

656

657 658 659 660
class MsgTestCaseSkip(Message):
    """
    Testing Tool MUST-implement API endpoint
    GUI (or automated-IUT)-> Testing Tool
661 662

    - testcase_id (optional) : if not provided then current tc is skipped
663 664
    """

665
    routing_key = "control.testcoordination"
666 667

    _msg_data_template = {
668 669
        "_type":       "testcoordination.testcase.skip",
        "testcase_id": "TD_COAP_CORE_02_v01",
670 671 672 673 674 675 676 677 678
    }


class MsgTestCaseSelect(Message):
    """
    Testing Tool MUST-implement API endpoint
    GUI (or automated-IUT)-> Testing Tool
    """

679
    routing_key = "control.testcoordination"
680 681

    _msg_data_template = {
682 683
        "_type":       "testcoordination.testcase.select",
        "testcase_id": "TD_COAP_CORE_03_v01",
684 685
    }

686

687 688 689 690 691 692
class MsgTestSuiteAbort(Message):
    """
    Testing Tool MUST-implement API endpoint
    GUI (or automated-IUT)-> Testing Tool
    """

693
    routing_key = "control.testcoordination"
694 695

    _msg_data_template = {
696
        "_type": "testcoordination.testsuite.abort",
697 698
    }

699

700 701
class MsgTestSuiteGetStatus(Message):
    """
702
    Testing Tool SHOULD-implement API endpoint
703 704 705 706 707 708
    Describes current state of the test suite.
    Format for the response not standardised.

    GUI -> Testing Tool
    """

709
    routing_key = "control.testcoordination.service"
710 711

    _msg_data_template = {
712
        "_type": "testcoordination.testsuite.getstatus",
713 714
    }

715

716
class MsgTestSuiteGetStatusReply(MsgReply):
717 718 719 720 721 722 723 724 725
    """
    Testing Tool SHOULD-implement API endpoint
    Describes current state of the test suite.
    Format for the response not standardised.

    Testing Tool -> GUI

    """

726
    routing_key = "control.testcoordination.service.reply"
727 728

    _msg_data_template = {
729 730
        "_type":          "testcoordination.testsuite.getstatus.reply",
        "ok":             True,
731 732
        "started":        True,
        "testcase_id":    "TD_COAP_CORE_01_v01",
733
        "testcase_state": "executing",
734
        "step_id":        "TD_COAP_CORE_01_v01_step_01"
735

736 737
    }

738

739 740
class MsgTestSuiteGetTestCases(Message):
    """
741
    Testing Tool's MUST-implement API endpoint
742 743 744 745
    GUI -> Testing Tool
    GUI MUST implement
    """

746
    routing_key = "control.testcoordination.service"
747 748

    _msg_data_template = {
749
        "_type": "testcoordination.testsuite.gettestcases",
750 751
    }

752 753 754 755 756 757 758

class MsgTestSuiteGetTestCasesReply(MsgReply):
    """
    Testing Tool's MUST-implement API endpoint
    Testing Tool -> GUI
    """

759
    routing_key = "control.testcoordination.service.reply"
760 761

    _msg_data_template = {
762 763
        "_type":   "testcoordination.testsuite.gettestcases.reply",
        "ok":      True,
764 765
        "tc_list": [
            {
766
                "testcase_id":  "TD_COAP_CORE_01_v01",
767
                "testcase_ref": "http://doc.f-interop.eu/tests/TD_COAP_CORE_01_v01",
768 769
                "objective":    "Perform GET transaction(CON mode)",
                "state":        None
770 771
            },
            {
772
                "testcase_id":  "TD_COAP_CORE_02_v01",
773
                "testcase_ref": "http://doc.f-interop.eu/tests/TD_COAP_CORE_02_v01",
774 775
                "objective":    "Perform DELETE transaction (CON mode)",
                "state":        None
776 777
            },
            {
778
                "testcase_id":  "TD_COAP_CORE_03_v01",
779
                "testcase_ref": "http://doc.f-interop.eu/tests/TD_COAP_CORE_03_v01",
780 781
                "objective":    "Perform PUT transaction (CON mode)",
                "state":        None
782 783 784 785 786 787 788 789 790 791 792 793 794
            }
        ]
    }


class MsgTestCaseVerdict(Message):
    """
    Testing Tool MUST-implement notification.
    Testing Tool -> GUI

    Used to indicate to the GUI (or automated-iut) which is the final verdict of the testcase.
    """

795
    routing_key = "control.testcoordination"
796 797

    _msg_data_template = {
798 799 800
        "_type":            "testcoordination.testcase.verdict",
        "verdict":          "pass",
        "description":      "No interoperability error was detected,",
801 802 803 804 805 806 807 808 809 810 811
        "partial_verdicts": [
            ["TD_COAP_CORE_01_v01_step_02", None, "CHECK postponed", ""],
            ["TD_COAP_CORE_01_v01_step_03", None, "CHECK postponed", ""],
            ["TD_COAP_CORE_01_v01_step_04", "pass",
             "VERIFY step: User informed that the information was displayed correclty on his/her IUT", ""],
            ["CHECK_1_post_mortem_analysis", "pass",
             "<Frame   3: [bbbb::1 -> bbbb::2] CoAP [CON 43211] GET /test> Match: CoAP(type=0, code=1)"],
            ["CHECK_2_post_mortem_analysis", "pass",
             "<Frame   4: [bbbb::2 -> bbbb::1] CoAP [ACK 43211] 2.05 Content > Match: CoAP(code=69, mid=0xa8cb, tok=b'', pl=Not(b''))"],
            ["CHECK_3_post_mortem_analysis", "pass",
             "<Frame   4: [bbbb::2 -> bbbb::1] CoAP [ACK 43211] 2.05 Content > Match: CoAP(opt=Opt(CoAPOptionContentFormat()))"]],
812 813 814
        "testcase_id":      "TD_COAP_CORE_01_v01",
        "testcase_ref":     "http://f-interop.paris.inria.fr/tests/TD_COAP_CORE_01_v01",
        "objective":        "Perform GET transaction(CON mode)", "state": "finished"
815 816 817 818 819 820 821 822 823 824 825
    }


class MsgTestSuiteReport(Message):
    """
    Testing Tool MUST-implement notification.
    Testing Tool -> GUI

    Used to indicate to the GUI (or automated-iut) the final results of the test session.
    """

826
    routing_key = "control.testcoordination"
827 828

    _msg_data_template = {
829
        "_type": "testcoordination.testsuite.report",
830
        "TD_COAP_CORE_01_v01":
831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850
                 {
                     "verdict":     "pass",
                     "description": "No interoperability error was detected,",
                     "partial_verdicts":
                                    [
                                        ["TD_COAP_CORE_01_v01_step_02", None, "CHECK postponed", ""],
                                        ["TD_COAP_CORE_01_v01_step_03", None, "CHECK postponed", ""],
                                        ["TD_COAP_CORE_01_v01_step_04", "pass",
                                         "VERIFY step: User informed that the information was displayed correclty on his/her IUT",
                                         ""],
                                        ["CHECK_1_post_mortem_analysis", "pass",
                                         "<Frame   3: [bbbb::1 -> bbbb::2] CoAP [CON 43211] GET /test> Match: CoAP(type=0, code=1)"],
                                        ["CHECK_2_post_mortem_analysis", "pass",
                                         "<Frame   4: [bbbb::2 -> bbbb::1] CoAP [ACK 43211] 2.05 Content > Match: CoAP(code=69, mid=0xa8cb, tok=b'', pl=Not(b''))"],
                                        [
                                            "CHECK_3_post_mortem_analysis",
                                            "pass",
                                            "<Frame   4: [bbbb::2 -> bbbb::1] CoAP [ACK 43211] 2.05 Content > Match: CoAP(opt=Opt(CoAPOptionContentFormat()))"]
                                    ]
                 },
851 852

        "TD_COAP_CORE_02_v01":
853 854 855 856 857 858 859 860 861 862 863 864 865
                 {
                     "verdict":          "pass",
                     "description":      "No interoperability error was detected,",
                     "partial_verdicts": [
                         ["TD_COAP_CORE_02_v01_step_02", None, "CHECK postponed", ""],
                         ["TD_COAP_CORE_02_v01_step_03", None, "CHECK postponed", ""],
                         ["TD_COAP_CORE_02_v01_step_04", "pass",
                          "VERIFY step: User informed that the information was displayed correclty on his/her IUT",
                          ""], ["CHECK_1_post_mortem_analysis", "pass",
                                "<Frame   3: [bbbb::1 -> bbbb::2] CoAP [CON 43213] DELETE /test> Match: CoAP(type=0, code=4)"],
                         ["CHECK_2_post_mortem_analysis", "pass",
                          "<Frame   4: [bbbb::2 -> bbbb::1] CoAP [ACK 43213] 2.02 Deleted > Match: CoAP(code=66, mid=0xa8cd, tok=b'')"]]
                 }
866 867
    }

868
    # # # # # # SNIFFING SERVICES REQUEST MESSAGES # # # # # #
869

870 871 872 873 874 875 876 877

class MsgSniffingStart(Message):
    """
    Testing Tools'internal call.
    Coordinator -> Sniffer
    Testing Tool SHOULD implement (design recommendation)
    """

878
    routing_key = "control.sniffing.service"
879 880

    _msg_data_template = {
881 882 883 884
        "_type":        "sniffing.start",
        "capture_id":   "TD_COAP_CORE_01",
        "filter_if":    "tun0",
        "filter_proto": "udp port 5683"
885 886
    }

887

888 889 890 891 892 893 894
class MsgSniffingStartReply(MsgReply):
    """
    Testing Tools'internal call.
    Sniffer -> Coordinator
    Testing Tool SHOULD implement (design recommendation)
    """

895
    routing_key = "control.sniffing.service.reply"
896 897

    _msg_data_template = {
898 899
        "_type": "sniffing.start.reply",
        "ok":    True
900 901
    }

902

903 904 905 906 907 908 909
class MsgSniffingStop(Message):
    """
    Testing Tools'internal call.
    Coordinator -> Sniffer
    Testing Tool SHOULD implement (design recommendation)
    """

910
    routing_key = "control.sniffing.service"
911 912

    _msg_data_template = {
913
        "_type": "sniffing.stop",
914 915
    }

916

917 918 919 920 921 922 923
class MsgSniffingStoptReply(MsgReply):
    """
    Testing Tools'internal call.
    Sniffer -> Coordinator
    Testing Tool SHOULD implement (design recommendation)
    """

924
    routing_key = "control.sniffing.service.reply"
925 926

    _msg_data_template = {
927 928
        "_type": "sniffing.stop.reply",
        "ok":    True
929 930
    }

931

932 933 934 935 936 937 938
class MsgSniffingGetCapture(Message):
    """
    Testing Tools'internal call.
    Coordinator -> Sniffer
    Testing Tool SHOULD implement (design recommendation)
    """

939
    routing_key = "control.sniffing.service"
940 941

    _msg_data_template = {
942
        "_type":      "sniffing.getcapture",
943 944 945 946
        "capture_id": "TD_COAP_CORE_01",

    }

947

948
class MsgSniffingGetCaptureReply(MsgReply):
949
    routing_key = "control.sniffing.service.reply"
950 951

    _msg_data_template = {
952 953 954 955 956
        "_type":    "sniffing.getcapture.reply",
        "ok":       True,
        "file_enc": "pcap_base64",
        "filename": "TD_COAP_CORE_01.pcap",
        "value":    "1MOyoQIABAAAAAAAAAAAAMgAAAAAAAAA",  # empty PCAP
957 958
    }

959

960 961 962 963 964 965 966
class MsgSniffingGetCaptureLast(Message):
    """
    Testing Tools'internal call.
    Coordinator -> Sniffer
    Testing Tool SHOULD implement (design recommendation)
    """

967
    routing_key = "control.sniffing.service"
968 969

    _msg_data_template = {
970
        "_type": "sniffing.getlastcapture",
971
    }
972

973

974
class MsgSniffingGetCaptureLastReply(MsgReply):
975
    routing_key = "control.sniffing.service.reply"
976 977

    _msg_data_template = {
978 979 980 981 982
        "_type":    "sniffing.getlastcapture.reply",
        "ok":       True,
        "file_enc": "pcap_base64",
        "filename": "TD_COAP_CORE_01.pcap",
        "value":    "1MOyoQIABAAAAAAAAAAAAMgAAAAAAAAA",  # empty PCAP
983 984
    }

985
    # # # # # # ANALYSIS MESSAGES # # # # # #
986

987

988
class MsgInteropTestCaseAnalyze(Message):
989 990
    """
    Testing Tools'internal call.
991 992 993 994 995 996

    Method to launch an analysis from a pcap file or a token if the pcap file has already been provided.
    # TODO token support

    The method need a token or a pcap_file but doesn't allow someone to provide both.

997
    Coordinator -> Analyzer
998

999 1000 1001
    Testing Tool SHOULD implement (design recommendation)
    """

1002
    PCAP_empty_base64 = "1MOyoQIABAAAAAAAAAAAAMgAAAAAAAAA"
1003

1004
    routing_key = "control.analysis.service"
1005 1006

    _msg_data_template = {
1007
        "_type":        "analysis.interop.testcase.analyze",
1008
        "testcase_id":  "TD_COAP_CORE_01",
1009
        "testcase_ref": "http://doc.f-interop.eu/tests/TD_COAP_CORE_01_v01",
1010 1011 1012
        "file_enc":     "pcap_base64",
        "filename":     "TD_COAP_CORE_01.pcap",
        "value":        PCAP_empty_base64,
1013 1014
    }

1015

1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
class MsgInteropTestCaseAnalyzeReply(MsgReply):
    """
    Testing Tools'internal call.
    Analyzer -> Coordinator
    Testing Tool SHOULD implement (design recommendation)

    The recommended structure for the partial_verdicts field is a list of partial verdicts with the following
    requirements:
     - each one of those elements of the list correspond to one CHECK or VERIFY steps of the test description
     - first value of the list MUST be a "pass", "fail", "inconclusive" or eventually "error" partial verdict (string)
     - the second value MUST be a string with a description of partial verdict (intended for the user)
     - more values elements MAY be added to the list

    """

    _msg_data_template = {
1032 1033 1034 1035 1036 1037 1038
        "_type":            "analysis.interop.testcase.analyze.reply",
        "ok":               True,
        "verdict":          "pass",
        "analysis_type":    "postmortem",
        "description":      "The test purpose has been verified without any fault detected",
        "review_frames":    [],
        "token":            "0lzzb_Bx30u8Gu-xkt1DFE1GmB4",
1039 1040
        "partial_verdicts": [
            [
1041 1042
                "pass",
                "<Frame   1: [127.0.0.1 -> 127.0.0.1] CoAP [CON 43521] GET /test> Match: CoAP(type=0, code=1)"
1043
            ],
1044 1045 1046 1047 1048

            [
                "pass",
                "<Frame   2: [127.0.0.1 -> 127.0.0.1] CoAP [ACK 43521] 2.05 Content > Match: CoAP(code=69, mid=0xaa01, \
                tok=b'b\\xda', pl=Not(b''))"
1049
            ],
1050 1051 1052 1053
            [
                "pass",
                "<Frame   2: [127.0.0.1 -> 127.0.0.1] CoAP [ACK 43521] 2.05 Content > \
                Match: CoAP(opt=Opt(CoAPOptionContentFormat()))"
1054
            ]
1055
        ],
1056 1057
        "testcase_id":      "TD_COAP_CORE_01",
        "testcase_ref":     "http://doc.f-interop.eu/tests/TD_COAP_CORE_01_v01",
1058 1059
    }

1060
    # # # # # # DISSECTION MESSAGES # # # # # #
1061

1062

1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079
class MsgDissectionDissectCapture(Message):
    """
    Testing Tools'internal call.
    Coordinator -> Dissector
    and
    Analyzer -> Dissector
    Testing Tool SHOULD implement (design recommendation)
    """

    PCAP_COAP_GET_OVER_TUN_INTERFACE_base64 = "1MOyoQIABAAAAAAAAAAAAMgAAABlAAAAqgl9WK8aBgA7AAAAOwAAAGADPxUAExFAu7s" \
                                              "AAAAAAAAAAAAAAAAAAbu7AAAAAAAAAAAAAAAAAALXvBYzABNZUEABcGO0dGVzdMECqg" \
                                              "l9WMcaBgCQAAAAkAAAAGAAAAAAaDr//oAAAAAAAAAAAAAAAAAAA7u7AAAAAAAAAAAAA" \
                                              "AAAAAGJAAcTAAAAALu7AAAAAAAAAAAAAAAAAAK7uwAAAAAAAAAAAAAAAAACBAgAAAAA" \
                                              "AABgAz8VABMRQLu7AAAAAAAAAAAAAAAAAAG7uwAAAAAAAAAAAAAAAAAC17wWMwATWVB" \
                                              "AAXBjtHRlc6oJfVjSGgYAOwAAADsAAABgAz8VABMRP7u7AAAAAAAAAAAAAAAAAAG7uw" \
                                              "AAAAAAAAAAAAAAAAAC17wWMwATWVBAAXBjtHRlc3TBAg=="

1080
    routing_key = "control.dissection.service"
1081 1082

    _msg_data_template = {
1083
        "_type":              "dissection.dissectcapture",
1084 1085 1086
        "file_enc":           "pcap_base64",
        "filename":           "TD_COAP_CORE_01.pcap",
        "value":              PCAP_COAP_GET_OVER_TUN_INTERFACE_base64,
1087
        "protocol_selection": "coap",
1088 1089 1090
    }


1091 1092 1093 1094 1095 1096 1097 1098 1099
class MsgDissectionDissectCaptureReply(MsgReply):
    """
    Testing Tools'internal call.
    Dissector -> Coordinator
    and
    Dissector -> Analyzer
    Testing Tool SHOULD implement (design recommendation)
    """

1100
    _frames_example = [
1101
        {
1102 1103 1104 1105
            "_type":          "frame",
            "id":             1,
            "timestamp":      1464858393.547275,
            "error":          None,
1106 1107
            "protocol_stack": [
                {
1108 1109 1110
                    "_type":          "protocol",
                    "_protocol":      "NullLoopback",
                    "AddressFamily":  "2",
1111 1112 1113
                    "ProtocolFamily": "0"
                },
                {
1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128
                    "_type":              "protocol",
                    "_protocol":          "IPv4",
                    "Version":            "4",
                    "HeaderLength":       "5",
                    "TypeOfService":      "0x00",
                    "TotalLength":        "41",
                    "Identification":     "0x71ac",
                    "Reserved":           "0",
                    "DontFragment":       "0",
                    "MoreFragments":      "0",
                    "FragmentOffset":     "0",
                    "TimeToLive":         "64",
                    "Protocol":           "17",
                    "HeaderChecksum":     "0x0000",
                    "SourceAddress":      "127.0.0.1",
1129
                    "DestinationAddress": "127.0.0.1",
1130
                    "Options":            "b''"
1131
                }
1132 1133 1134
            ]
        },
    ]
1135 1136

    _msg_data_template = {
1137 1138 1139 1140
        "_type":  "dissection.dissectcapture.reply",
        "ok":     True,
        "token":  "0lzzb_Bx30u8Gu-xkt1DFE1GmB4",
        "frames": _frames_example
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154
    }


class MsgDissectionAutoDissect(Message):
    """
    Testing Tool's MUST-implement.
    Testing Tool -> GUI
    GUI MUST display this info during execution:
     - interop session
     - conformance session
     - performance ?
     - privacy?

    """
1155
    routing_key = "control.dissection"
1156

1157
    _frames_example = MsgDissectionDissectCaptureReply._frames_example
1158 1159

    _msg_data_template = {
1160 1161 1162
        "_type":        "dissection.autotriggered",
        "token":        "0lzzb_Bx30u8Gu-xkt1DFE1GmB4",
        "frames":       _frames_example,
1163
        "testcase_id":  "TBD",
1164
        "testcase_ref": "TBD"
1165 1166
    }

1167
    # # # # # # PRIVACY TESTING TOOL MESSAGES # # # # # #
Luca Lamorte's avatar
Luca Lamorte committed
1168 1169 1170 1171 1172


class MsgPrivacyAnalyze(Message):
    """
        Testing Tool's MUST-implement.
1173
        Analyze PCAP File for Privacy checks.
Luca Lamorte's avatar
Luca Lamorte committed
1174
    """
1175
    routing_key = "control.privacy.service"
Luca Lamorte's avatar
Luca Lamorte committed
1176 1177

    # TODO: This message should be update with a valuable privacy example
1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192
    # PCAP_COAP_GET_OVER_TUN_INTERFACE_base64 = "1MOyoQIABAAAAAAAAAAAAMgAAABlAAAAqgl9WK8aBgA7AAAAOwAAAGADPxUAExFAu7s" \
    #                                           "AAAAAAAAAAAAAAAAAAbu7AAAAAAAAAAAAAAAAAALXvBYzABNZUEABcGO0dGVzdMECqg" \
    #                                           "l9WMcaBgCQAAAAkAAAAGAAAAAAaDr//oAAAAAAAAAAAAAAAAAAA7u7AAAAAAAAAAAAA" \
    #                                           "AAAAAGJAAcTAAAAALu7AAAAAAAAAAAAAAAAAAK7uwAAAAAAAAAAAAAAAAACBAgAAAAA" \
    #                                           "AABgAz8VABMRQLu7AAAAAAAAAAAAAAAAAAG7uwAAAAAAAAAAAAAAAAAC17wWMwATWVB" \
    #                                           "AAXBjtHRlc6oJfVjSGgYAOwAAADsAAABgAz8VABMRP7u7AAAAAAAAAAAAAAAAAAG7uw" \
    #                                           "AAAAAAAAAAAAAAAAAC17wWMwATWVBAAXBjtHRlc3TBAg=="

    PCAP_COAP_GET_OVER_TUN_INTERFACE_base64 = "Cg0NCpgAAABNPCsaAQAAAP//////////AwAuAE1hYyBPUyBYIDEwLjEyLjQsIGJ1aWxk" \
                                              "IDE2RTE5NSAoRGFyd2luIDE2LjUuMCkAAAQAPQBEdW1wY2FwIChXaXJlc2hhcmspIDIu" \
                                              "Mi4wICh2Mi4yLjAtMC1nNTM2OGM1MCBmcm9tIG1hc3Rlci0yLjIpAAAAAAAAAJgAAAAB" \
                                              "AAAAXAAAAAAAAAAAAAQAAgAEAHR1bjAJAAEABgAAAAwALgBNYWMgT1MgWCAxMC4xMi40" \
                                              "LCBidWlsZCAxNkUxOTUgKERhcndpbiAxNi41LjApAAAAAAAAXAAAAAUAAABsAAAAAAAA" \
                                              "AIdOBQCsif6eAQAcAENvdW50ZXJzIHByb3ZpZGVkIGJ5IGR1bXBjYXACAAgAh04FAN2Z" \
                                              "ip4DAAgAh04FAKGJ/p4EAAgAAAAAAAAAAAAFAAgAAAAAAAAAAAAAAAAAbAAAAA=="
Luca Lamorte's avatar
Luca Lamorte committed
1193 1194

    _msg_data_template = {
1195 1196
        "_type":    "privacy.analyze",
        "value":    PCAP_COAP_GET_OVER_TUN_INTERFACE_base64,
Luca Lamorte's avatar
Luca Lamorte committed
1197 1198 1199 1200 1201
        "file_enc": "pcap_base64",
        "filename": "TD_PRIVACY_DEMO_01.pcap",
    }


1202 1203 1204 1205 1206 1207
class MsgPrivacyAnalyzeReply(MsgReply):
    """
            Testing Tool's MUST-implement.
            Response of Analyze request from GUI
    """

1208 1209 1210 1211 1212 1213 1214 1215 1216 1217
    _privacy_empty_report = {"type":           "Anomalies Report",
                             "protocols":      ["coap"],
                             "conversation":   [],
                             "status":         "none",
                             "testing_tool":   "Privacy Testing Tool",
                             "byte_exchanged": 0,
                             "timestamp":      1493798811.53124,
                             "is_final":       True,
                             "packets":        {},
                             "version":        "0.0.1"}
1218 1219

    _msg_data_template = {
1220 1221 1222 1223
        "_type":       "privacy.analyze.reply",
        "ok":          True,
        "verdict":     _privacy_empty_report,
        "testcase_id": "TBD",
1224 1225
    }

1226

Luca Lamorte's avatar
Luca Lamorte committed
1227 1228 1229 1230 1231
class MsgPrivacyGetConfiguration(Message):
    """
           Read Privacy configuration.
           GUI MUST display this info during setup
    """
1232
    routing_key = "control.privacy.service"
Luca Lamorte's avatar
Luca Lamorte committed
1233 1234 1235