tests/scripts/thread-cert/v1_2_test_csl_transmission.py

#!/usr/bin/env python3
#
#  Copyright (c) 2020, The OpenThread Authors.
#  All rights reserved.
#
#  Redistribution and use in source and binary forms, with or without
#  modification, are permitted provided that the following conditions are met:
#  1. Redistributions of source code must retain the above copyright
#     notice, this list of conditions and the following disclaimer.
#  2. Redistributions in binary form must reproduce the above copyright
#     notice, this list of conditions and the following disclaimer in the
#     documentation and/or other materials provided with the distribution.
#  3. Neither the name of the copyright holder nor the
#     names of its contributors may be used to endorse or promote products
#     derived from this software without specific prior written permission.
#
#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
#  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
#  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
#  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
#  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
#  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
#  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
#  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
#  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
#  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
#  POSSIBILITY OF SUCH DAMAGE.
#

import unittest

import mle
import thread_cert
from pktverify import consts

LEADER = 1
SSED_1 = 2


class SSED_CslTransmission(thread_cert.TestCase):
    TOPOLOGY = {
        LEADER: {
            'version': '1.2',
        },
        SSED_1: {
            'version': '1.2',
            'is_mtd': True,
            'mode': '-',
        },
    }
    """All nodes are created with default configurations"""

    def test(self):

        self.nodes[SSED_1].set_csl_period(consts.CSL_DEFAULT_PERIOD)
        self.nodes[SSED_1].set_csl_timeout(consts.CSL_DEFAULT_TIMEOUT)

        self.nodes[SSED_1].get_csl_info()

        self.nodes[LEADER].start()
        self.simulator.go(5)
        self.assertEqual(self.nodes[LEADER].get_state(), 'leader')

        self.nodes[SSED_1].start()
        self.simulator.go(7)
        self.assertEqual(self.nodes[SSED_1].get_state(), 'child')

        print('SSED rloc:%s' % self.nodes[SSED_1].get_rloc())
        self.assertTrue(self.nodes[LEADER].ping(self.nodes[SSED_1].get_rloc()))
        self.simulator.go(5)

        ssed_messages = self.simulator.get_messages_sent_by(SSED_1)
        msg = ssed_messages.next_mle_message(mle.CommandType.CHILD_UPDATE_REQUEST)
        msg.assertMleMessageDoesNotContainTlv(mle.CslChannel)

        self.nodes[SSED_1].set_csl_channel(consts.CSL_DEFAULT_CHANNEL)
        self.simulator.go(1)
        ssed_messages = self.simulator.get_messages_sent_by(SSED_1)
        msg = ssed_messages.next_mle_message(mle.CommandType.CHILD_UPDATE_REQUEST)
        msg.assertMleMessageContainsTlv(mle.CslChannel)
        self.assertTrue(self.nodes[LEADER].ping(self.nodes[SSED_1].get_rloc()))
        self.simulator.go(5)

        self.nodes[SSED_1].set_csl_channel(0)
        self.simulator.go(1)
        self.assertTrue(self.nodes[LEADER].ping(self.nodes[SSED_1].get_rloc()))
        self.simulator.go(5)

        ssed_messages = self.simulator.get_messages_sent_by(SSED_1)
        msg = ssed_messages.next_mle_message(mle.CommandType.CHILD_UPDATE_REQUEST)
        msg.assertMleMessageDoesNotContainTlv(mle.CslChannel)

        self.nodes[SSED_1].set_csl_period(0)
        self.assertFalse(self.nodes[LEADER].ping(self.nodes[SSED_1].get_rloc()))
        self.simulator.go(2)

        self.nodes[SSED_1].set_pollperiod(1000)
        self.simulator.go(2)
        self.nodes[SSED_1].set_pollperiod(0)
        self.simulator.go(5)

        # Check if data poll is not sent if data packet with CSL IE is sent to parent
        self.nodes[SSED_1].set_csl_period(consts.CSL_DEFAULT_PERIOD)
        self.simulator.go(consts.CSL_DEFAULT_TIMEOUT / 2)
        self.assertTrue(self.nodes[LEADER].ping(self.nodes[SSED_1].get_rloc()))
        self.flush_all()
        self.simulator.go(consts.CSL_DEFAULT_TIMEOUT / 2)
        ssed_messages = self.simulator.get_messages_sent_by(SSED_1)
        self.assertIsNone(ssed_messages.next_data_poll())

        # Check if data poll is used to sync SSED's parent before CSL timeout
        self.assertTrue(self.nodes[LEADER].ping(self.nodes[SSED_1].get_rloc()))
        self.flush_all()
        self.simulator.go(consts.CSL_DEFAULT_TIMEOUT)
        ssed_messages = self.simulator.get_messages_sent_by(SSED_1)
        self.assertIsNotNone(ssed_messages.next_data_poll())

        # Check if data poll is used to resync SSED's parent after retransmission
        leader_rloc = self.nodes[LEADER].get_rloc()
        self.nodes[LEADER].stop()
        self.flush_all()
        self.assertFalse(self.nodes[SSED_1].ping(leader_rloc))
        self.simulator.go(2)
        ssed_messages = self.simulator.get_messages_sent_by(SSED_1)
        self.assertIsNotNone(ssed_messages.next_data_poll())


if __name__ == '__main__':
    unittest.main()