openthread/tests/nexus/test_1_1_6_3_1.cpp

/*
 *  Copyright (c) 2026, 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.
 */

#include <stdio.h>
#include <string.h>

#include "mac/data_poll_sender.hpp"
#include "platform/nexus_core.hpp"
#include "platform/nexus_node.hpp"

namespace ot {
namespace Nexus {

/**
 * Time to advance for a node to form a network and become leader, in milliseconds.
 */
static constexpr uint32_t kFormNetworkTime = 13 * 1000;

/**
 * Time to advance for a node to join as a child and upgrade to a router, in milliseconds.
 */
static constexpr uint32_t kAttachToRouterTime = 200 * 1000;

/**
 * Time to advance for the DUT to attach to a parent, in milliseconds.
 */
static constexpr uint32_t kAttachTime = 20 * 1000;

/**
 * Time to wait for ICMPv6 Echo response, in milliseconds.
 */
static constexpr uint32_t kEchoTimeout = 5000;

/**
 * Data poll period for SED, in milliseconds.
 */
static constexpr uint32_t kPollPeriod = 1000;

/**
 * Child timeout for DUT, in milliseconds.
 */
static constexpr uint32_t kChildTimeout = 4000;

/**
 * Time to wait for the DUT to detect its parent is gone, in milliseconds.
 */
static constexpr uint32_t kDetectParentLossTime = 100 * 1000;

/**
 * ICMPv6 Echo hop limit.
 */
static constexpr uint8_t kEchoHopLimit = 64;

/**
 * ICMPv6 Echo identifier for the nudge ping.
 */
static constexpr uint16_t kNudgeEchoIdentifier = 0x1234;

enum Topology
{
    kTopologyA,
    kTopologyB,
};

void RunTest6_3_1(Topology aTopology, const char *aJsonFile)
{
    /**
     * 6.3.1 Orphan Reattach
     *
     * 6.3.1.1 Topology
     * - Topology A: DUT as End Device (ED_1)
     * - Topology B: DUT as Sleepy End Device (SED_1)
     * - Leader
     * - Router_1
     *
     * 6.3.1.2 Purpose & Description
     * The purpose of this test case is to show that the DUT will attach to the Leader once its parent is removed from
     *   the network.
     *
     * Spec Reference        | V1.1 Section | V1.3.0 Section
     * ----------------------|--------------|---------------
     * Child Update Messages | 4.7.3        | 4.6.1
     */

    Core nexus;

    Node &leader  = nexus.CreateNode();
    Node &router1 = nexus.CreateNode();
    Node &dut     = nexus.CreateNode();

    leader.SetName("LEADER");
    router1.SetName("ROUTER_1");

    if (aTopology == kTopologyA)
    {
        dut.SetName("ED_1");
    }
    else
    {
        dut.SetName("SED_1");
    }

    nexus.AdvanceTime(0);

    SuccessOrQuit(Instance::SetGlobalLogLevel(kLogLevelNote));

    Log("---------------------------------------------------------------------------------------");
    if (aTopology == kTopologyA)
    {
        Log("Topology A: ED_1 (DUT)");
    }
    else
    {
        Log("Topology B: SED_1 (DUT)");
    }

    Log("---------------------------------------------------------------------------------------");
    Log("Step 1: All");

    /**
     * Step 1: All
     * - Description: Setup the topology without the DUT. Ensure all routers and leader are sending MLE advertisements.
     * - Pass Criteria: N/A
     */

    AllowLinkBetween(leader, router1);
    AllowLinkBetween(router1, dut);

    leader.Form();
    nexus.AdvanceTime(kFormNetworkTime);
    VerifyOrQuit(leader.Get<Mle::Mle>().IsLeader());

    router1.Join(leader);
    nexus.AdvanceTime(kAttachToRouterTime);
    VerifyOrQuit(router1.Get<Mle::Mle>().IsRouter());

    if (aTopology == kTopologyA)
    {
        dut.Join(router1, Node::kAsMed);
    }
    else
    {
        dut.Join(router1, Node::kAsSed);
        SuccessOrQuit(dut.Get<DataPollSender>().SetExternalPollPeriod(kPollPeriod));
    }

    dut.Get<Mle::Mle>().SetTimeout(kChildTimeout);

    nexus.AdvanceTime(kAttachTime);
    VerifyOrQuit(dut.Get<Mle::Mle>().IsChild());
    VerifyOrQuit(dut.Get<Mle::Mle>().GetParent().GetExtAddress() == router1.Get<Mac::Mac>().GetExtAddress());

    Log("---------------------------------------------------------------------------------------");
    Log("Step 2: Router_1");

    /**
     * Step 2: Router_1
     * - Description: Harness silently removes Router_1 from the network.
     * - Pass Criteria: N/A
     */
    router1.Get<Mle::Mle>().Stop();
    router1.Get<ThreadNetif>().Down();

    if (aTopology == kTopologyA)
    {
        Log("---------------------------------------------------------------------------------------");
        Log("Step 3: ED_1 (DUT) [Topology A only]");

        /**
         * Step 3: ED_1 (DUT) [Topology A only]
         * - Description: Automatically sends MLE Child Update Request keep-alive message(s) to its parent. [Optional]
         *   The DUT SHOULD send MLE Child Update Requests [FAILED_CHILD_TRANSMISSIONS-1] to its parent (Router_1).
         * - Pass Criteria:
         *   - The following TLVs MUST be included in each MLE Child Update Request:
         *     - Source Address TLV
         *     - Leader Data TLV
         *     - Mode TLV
         *     - Address Registration TLVs (optional)
         */
        /** We advance time to let the periodic keep-alive happen. */
        nexus.AdvanceTime(kChildTimeout);

        /** Send multiple pings to parent to trigger parent loss detection. */
        for (int i = 0; i < 5; i++)
        {
            dut.SendEchoRequest(router1.Get<Mle::Mle>().GetLinkLocalAddress(), kNudgeEchoIdentifier);
            nexus.AdvanceTime(1000);
        }
    }
    else
    {
        Log("---------------------------------------------------------------------------------------");
        Log("Step 4: SED_1 (DUT) [Topology B only]");

        /**
         * Step 4: SED_1 (DUT) [Topology B only]
         * - Description: Automatically sends 802.15.4 Data Request keep-alive message(s) to its parent. [Optional] The
         *   DUT SHOULD send 802.15.4 Data Request commands [FAILED_CHILD_TRANSMISSIONS-1] to its parent (Router_1).
         * - Pass Criteria:
         *   - The DUT MUST NOT receive an ACK message in response.
         */
    }

    AllowLinkBetween(leader, dut);

    nexus.AdvanceTime(kDetectParentLossTime);

    Log("---------------------------------------------------------------------------------------");
    Log("Step 5: ED_1 / SED_1 (DUT)");

    /**
     * Step 5: ED_1 / SED_1 (DUT)
     * - Description: Automatically attaches to the Leader.
     * - Pass Criteria:
     *   - The DUT MUST perform the attach procedure with the Leader (see section 6.1.1 Attaching to a Router).
     */

    for (uint32_t i = 0; i < 60; i++)
    {
        nexus.AdvanceTime(1000);
        if (dut.Get<Mle::Mle>().IsAttached() &&
            dut.Get<Mle::Mle>().GetParent().GetExtAddress() == leader.Get<Mac::Mac>().GetExtAddress())
        {
            break;
        }
    }

    VerifyOrQuit(dut.Get<Mle::Mle>().IsAttached());
    VerifyOrQuit(dut.Get<Mle::Mle>().GetParent().GetExtAddress() == leader.Get<Mac::Mac>().GetExtAddress());

    Log("---------------------------------------------------------------------------------------");
    Log("Step 6: Leader");

    /**
     * Step 6: Leader
     * - Description: Harness verifies connectivity by instructing the device to send an ICMPv6 Echo Request to the DUT
     *   link local address.
     * - Pass Criteria:
     *   - The DUT MUST respond with ICMPv6 Echo Reply.
     */
    nexus.SendAndVerifyEchoRequest(leader, dut.Get<Mle::Mle>().GetLinkLocalAddress(), 0, kEchoHopLimit, kEchoTimeout);

    nexus.SaveTestInfo(aJsonFile);
}

} // namespace Nexus
} // namespace ot

int main(int argc, char *argv[])
{
    if (argc < 2)
    {
        ot::Nexus::RunTest6_3_1(ot::Nexus::kTopologyA, "test_1_1_6_3_1_A.json");
        ot::Nexus::RunTest6_3_1(ot::Nexus::kTopologyB, "test_1_1_6_3_1_B.json");
    }
    else if (strcmp(argv[1], "A") == 0)
    {
        ot::Nexus::RunTest6_3_1(ot::Nexus::kTopologyA, (argc > 2) ? argv[2] : "test_1_1_6_3_1_A.json");
    }
    else if (strcmp(argv[1], "B") == 0)
    {
        ot::Nexus::RunTest6_3_1(ot::Nexus::kTopologyB, (argc > 2) ? argv[2] : "test_1_1_6_3_1_B.json");
    }
    else
    {
        fprintf(stderr, "Error: Invalid topology '%s'. Must be 'A' or 'B'.\n", argv[1]);
        return 1;
    }

    printf("All tests passed\n");
    return 0;
}