[nexus] migrate srp server reboot port test to nexus (#12952)

This commit migrates the SRP server reboot port test from the
thread-cert functional tests to the Nexus simulation framework.

The new Nexus test 'test_srp_server_reboot_port.cpp' covers:
- SRP server address mode configuration (Unicast).
- SRP client auto-start discovery of the server.
- SRP server reboot (disable/enable) without node reboot.
- Verification that the server selects a new port after each reboot.
- Robustness of service re-registration over 25 reboot iterations.

The original Python test 'test_srp_server_reboot_port.py' is removed
as its functionality is now fully covered by the Nexus test.
This commit is contained in:
Jonathan Hui
2026-04-22 00:27:17 -07:00
committed by GitHub
parent 0cf450af44
commit 0a97d566de
3 changed files with 189 additions and 189 deletions
+1
View File
@@ -413,6 +413,7 @@ ot_nexus_test(srp_lease "core;nexus")
ot_nexus_test(srp_many_services_mtu_check "core;nexus")
ot_nexus_test(srp_register_services_diff_lease "core;nexus")
ot_nexus_test(srp_scale "core;nexus")
ot_nexus_test(srp_server_reboot_port "core;nexus")
ot_nexus_test(zero_len_external_route "core;nexus")
# Trel
+188
View File
@@ -0,0 +1,188 @@
/*
* 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 "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.
*/
static constexpr uint32_t kAttachToRouterTime = 200 * 1000;
/**
* Time to advance for SRP server information to be updated in Network Data.
*/
static constexpr uint32_t kSrpServerInfoUpdateTime = 60 * 1000;
/**
* Time to advance for SRP registration, in milliseconds.
*/
static constexpr uint32_t kSrpRegistrationTime = 60 * 1000;
/**
* Number of reboot times.
*/
static constexpr uint16_t kRebootTimes = 25;
void TestSrpServerRebootPort(void)
{
Core nexus;
Node &client = nexus.CreateNode();
Node &server = nexus.CreateNode();
client.SetName("CLIENT");
server.SetName("SERVER");
nexus.AdvanceTime(0);
SuccessOrQuit(Instance::SetGlobalLogLevel(kLogLevelNote));
//
// 0. Start the server & client devices.
//
Log("0. Start the server & client devices.");
client.Get<Mle::Mle>().SetRouterUpgradeThreshold(2);
server.Get<Mle::Mle>().SetRouterUpgradeThreshold(2);
client.Form();
nexus.AdvanceTime(kFormNetworkTime);
server.Join(client);
nexus.AdvanceTime(kAttachToRouterTime);
VerifyOrQuit(server.Get<Mle::Mle>().IsRouter());
SuccessOrQuit(server.Get<Srp::Server>().SetAddressMode(Srp::Server::kAddressModeUnicast));
server.Get<Srp::Server>().SetEnabled(true);
// Wait for SRP server to be running (published in network data)
for (int i = 0; i < 10; i++)
{
nexus.AdvanceTime(10000);
if (server.Get<Srp::Server>().GetState() == Srp::Server::kStateRunning)
{
break;
}
}
VerifyOrQuit(server.Get<Srp::Server>().GetState() == Srp::Server::kStateRunning);
//
// 1. Check auto start mode on client and check that server is used.
//
Log("1. Check auto start mode on client and check that server is used.");
// We set a host name so the client has something to register and thus "runs".
SuccessOrQuit(client.Get<Srp::Client>().SetHostName("my-host"));
client.Get<Srp::Client>().EnableAutoStartMode(nullptr, nullptr);
nexus.AdvanceTime(kSrpRegistrationTime);
VerifyOrQuit(client.Get<Srp::Client>().GetServerAddress().GetAddress() == server.Get<Mle::Mle>().GetMeshLocalEid());
//
// 2. Reboot the server without any service registered. The server should
// switch to a new port after re-enabling.
//
Log("2. Reboot the server without any service registered.");
{
uint16_t oldPort = server.Get<Srp::Server>().GetPort();
server.Get<Srp::Server>().SetEnabled(false);
nexus.AdvanceTime(5000);
server.Get<Srp::Server>().SetEnabled(true);
nexus.AdvanceTime(kSrpServerInfoUpdateTime);
VerifyOrQuit(server.Get<Srp::Server>().GetState() == Srp::Server::kStateRunning);
VerifyOrQuit(server.Get<Srp::Server>().GetPort() != oldPort);
}
//
// 3. Register a service
//
Log("3. Register a service");
static Srp::Client::Service service;
SuccessOrQuit(client.Get<Srp::Client>().EnableAutoHostAddress());
memset(&service, 0, sizeof(service));
service.mName = "_ipps._tcp";
service.mInstanceName = "my-service";
service.mPort = 12345;
SuccessOrQuit(client.Get<Srp::Client>().AddService(service));
nexus.AdvanceTime(kSrpRegistrationTime);
// Reboot the SRP server several times
for (uint16_t i = 0; i < kRebootTimes; i++)
{
Log("Reboot iteration %u", i);
//
// 4. Disable server and check client is stopped/disabled.
//
uint16_t oldPort = server.Get<Srp::Server>().GetPort();
server.Get<Srp::Server>().SetEnabled(false);
nexus.AdvanceTime(5000);
//
// 5. Enable server and check client starts again. Verify that the
// server is using a different port, and the service have been
// re-registered.
//
server.Get<Srp::Server>().SetEnabled(true);
nexus.AdvanceTime(kSrpServerInfoUpdateTime);
nexus.AdvanceTime(kSrpRegistrationTime);
VerifyOrQuit(client.Get<Srp::Client>().GetHostInfo().GetState() == Srp::Client::kRegistered);
VerifyOrQuit(server.Get<Srp::Server>().GetNextHost(nullptr)->GetServices().GetHead()->GetPort() == 12345);
VerifyOrQuit(server.Get<Srp::Server>().GetPort() != oldPort);
}
Log("All steps completed.");
}
} // namespace Nexus
} // namespace ot
int main(void)
{
ot::Nexus::TestSrpServerRebootPort();
printf("All tests passed\n");
return 0;
}
@@ -1,189 +0,0 @@
#!/usr/bin/env python3
#
# Copyright (c) 2021, 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 ipaddress
import logging
import unittest
import command
import config
import thread_cert
# Test description:
# This test verifies when an SRP server restarts, it will listen to a UDP port
# that wasn't used in the last time.
#
# Topology:
#
# LEADER (SRP client) -- ROUTER (SRP server)
#
CLIENT = 1
SERVER = 2
REBOOT_TIMES = 25
class SrpServerRebootPort(thread_cert.TestCase):
USE_MESSAGE_FACTORY = False
SUPPORT_NCP = False
TOPOLOGY = {
CLIENT: {
'name': 'SRP_CLIENT',
'mode': 'rdn',
},
SERVER: {
'name': 'SRP_SERVER',
'mode': 'rdn',
},
}
def test(self):
client = self.nodes[CLIENT]
server = self.nodes[SERVER]
#
# 0. Start the server & client devices.
#
client.srp_server_set_enabled(False)
client.start()
self.simulator.go(config.LEADER_STARTUP_DELAY)
self.assertEqual(client.get_state(), 'leader')
server.srp_server_set_enabled(True)
server.start()
self.simulator.go(config.ROUTER_STARTUP_DELAY)
self.assertEqual(server.get_state(), 'router')
#
# 1. Check auto start mode on client and check that server is used.
#
self.assertEqual(client.srp_client_get_auto_start_mode(), 'Enabled')
self.simulator.go(2)
self.assertEqual(client.srp_client_get_state(), 'Enabled')
self.assertTrue(server.has_ipaddr(client.srp_client_get_server_address()))
#
# 2. Reboot the server without any service registered. The server should
# switch to a new port after re-enabling.
#
old_port = server.get_srp_server_port()
server.srp_server_set_enabled(False)
self.simulator.go(5)
server.srp_server_set_enabled(True)
self.simulator.go(5)
self.assertNotEqual(old_port, server.get_srp_server_port())
#
# 3. Register a service
#
client.srp_client_set_host_name('my-host')
client.srp_client_set_host_address('2001::1')
client.srp_client_add_service('my-service', '_ipps._tcp', 12345, 0, 0, ['abc', 'def=', 'xyz=XYZ'])
self.simulator.go(16)
self.check_host_and_service(server, client, '2001::1')
ports = [server.get_srp_server_port()]
# Reboot the SRP server several times
for i in range(REBOOT_TIMES):
#
# 4. Disable server and check client is stopped/disabled.
#
old_port = server.get_srp_server_port()
server.srp_server_set_enabled(False)
self.simulator.go(5)
#
# 5. Enable server and check client starts again. Verify that the
# server is using a different port, and the service have been
# re-registered.
#
server.srp_server_set_enabled(True)
self.simulator.go(16)
self.assertEqual(client.srp_client_get_state(), 'Enabled')
self.assertEqual(client.srp_client_get_server_address(), server.get_mleid())
self.assertNotEqual(old_port, server.get_srp_server_port())
self.check_host_and_service(server, client, '2001::1')
ports.append(server.get_srp_server_port())
logging.info(f'ports = {ports}')
def check_host_and_service(self, server, client, host_addr):
# Check that we have properly registered host and service instance.
# Originally used in test_srp_register_single_service.py.
client_services = client.srp_client_get_services()
print(client_services)
self.assertEqual(len(client_services), 1)
client_service = client_services[0]
# Verify that the client possesses correct service resources.
self.assertEqual(client_service['instance'], 'my-service')
self.assertEqual(client_service['name'], '_ipps._tcp')
self.assertEqual(int(client_service['port']), 12345)
self.assertEqual(int(client_service['priority']), 0)
self.assertEqual(int(client_service['weight']), 0)
# Verify that the client received a SUCCESS response for the server.
self.assertEqual(client_service['state'], 'Registered')
server_services = server.srp_server_get_services()
self.assertEqual(len(server_services), 1)
server_service = server_services[0]
# Verify that the server accepted the SRP registration and stores
# the same service resources.
self.assertEqual(server_service['deleted'], 'false')
self.assertEqual(server_service['instance'], client_service['instance'])
self.assertEqual(server_service['name'], client_service['name'])
self.assertEqual(server_service['subtypes'], '(null)')
self.assertEqual(int(server_service['port']), int(client_service['port']))
self.assertEqual(int(server_service['priority']), int(client_service['priority']))
self.assertEqual(int(server_service['weight']), int(client_service['weight']))
# We output value of TXT entry as HEX string.
print(server_service['TXT'])
self.assertEqual(server_service['TXT'], ['abc', 'def=', 'xyz=58595a'])
self.assertEqual(server_service['host'], 'my-host')
server_hosts = server.srp_server_get_hosts()
print(server_hosts)
self.assertEqual(len(server_hosts), 1)
server_host = server_hosts[0]
self.assertEqual(server_host['deleted'], 'false')
self.assertEqual(server_host['fullname'], server_service['host_fullname'])
self.assertEqual(len(server_host['addresses']), 1)
self.assertEqual(ipaddress.ip_address(server_host['addresses'][0]), ipaddress.ip_address(host_addr))
if __name__ == '__main__':
unittest.main()