1#!/usr/bin/env python3
2#
3#  Copyright (c) 2019, The OpenThread Authors.
4#  All rights reserved.
5#
6#  Redistribution and use in source and binary forms, with or without
7#  modification, are permitted provided that the following conditions are met:
8#  1. Redistributions of source code must retain the above copyright
9#     notice, this list of conditions and the following disclaimer.
10#  2. Redistributions in binary form must reproduce the above copyright
11#     notice, this list of conditions and the following disclaimer in the
12#     documentation and/or other materials provided with the distribution.
13#  3. Neither the name of the copyright holder nor the
14#     names of its contributors may be used to endorse or promote products
15#     derived from this software without specific prior written permission.
16#
17#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18#  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19#  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20#  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
21#  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22#  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23#  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24#  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25#  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26#  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27#  POSSIBILITY OF SUCH DAMAGE.
28#
29
30from pktverify.packet import Packet
31from pktverify.packet_filter import PacketFilter
32
33
34class VerifyResult(object):
35    """
36    Represents a verification result of a packet.
37    """
38    __slots__ = ('_packet_found', '_packet_indexes', '_seek_indexes')
39
40    def __init__(self):
41        self._packet_found = {}
42        self._packet_indexes = {}
43        self._seek_indexes = {}
44
45    def record_last(self, name: str, pkts: PacketFilter) -> None:
46        """
47        Record the information of the last found packet.
48
49        :param name: The record name.
50        :param pkts: The packet filter.
51        """
52        assert name not in self._packet_found, f'duplicate name: {name}'
53        self._packet_found[name] = pkts.last()
54        self._packet_indexes[name] = pkts.last_index
55        self._seek_indexes[name] = pkts.index
56
57    def packet_index(self, name: str) -> int:
58        """
59        Returns a recorded packet index.
60
61        :param name: The record name.
62        :return: The packet index.
63        """
64        return self._packet_indexes[name]
65
66    def packet(self, name: str) -> Packet:
67        """
68        Returns the recorded packet.
69
70        :param name: The record name.
71        :return: The packet.
72        """
73        return self._packet_found[name]
74
75    def seek_index(self, name: str) -> tuple:
76        """
77        Returns the recorded seek index.
78
79        :param name: The record name.
80        :return: The seek index.
81        """
82        return self._seek_indexes[name]
83
84    def __str__(self):
85        return "VerifyResult%s" % self._packet_found
86