From f030fb8d7cd2e6b31cdff5c691659303114674a6 Mon Sep 17 00:00:00 2001
From: Stefano Avallone <stavallo@unina.it>
Date: Mon, 12 Jun 2023 13:08:37 +0200
Subject: [PATCH] wifi: Define struct for parameters of test cases in EMLSR
 unit test

---
 src/wifi/test/wifi-emlsr-test.cc | 82 ++++++++++++++------------------
 src/wifi/test/wifi-emlsr-test.h  | 54 +++++++++++++--------
 2 files changed, 70 insertions(+), 66 deletions(-)

diff --git a/src/wifi/test/wifi-emlsr-test.cc b/src/wifi/test/wifi-emlsr-test.cc
index ecd9418b1..a30ef1e36 100644
--- a/src/wifi/test/wifi-emlsr-test.cc
+++ b/src/wifi/test/wifi-emlsr-test.cc
@@ -699,31 +699,27 @@ EmlOmnExchangeTest::DoRun()
     Simulator::Destroy();
 }
 
-EmlsrDlTxopTest::EmlsrDlTxopTest(std::size_t nEmlsrStations,
-                                 std::size_t nNonEmlsrStations,
-                                 const std::set<uint8_t>& linksToEnableEmlsrOn,
-                                 const std::vector<Time>& paddingDelay,
-                                 const std::vector<Time>& transitionDelay,
-                                 Time transitionTimeout)
-    : EmlsrOperationsTestBase("Check EML DL TXOP transmissions (" + std::to_string(nEmlsrStations) +
-                              "," + std::to_string(nNonEmlsrStations) + ")"),
-      m_emlsrLinks(linksToEnableEmlsrOn),
+EmlsrDlTxopTest::EmlsrDlTxopTest(const Params& params)
+    : EmlsrOperationsTestBase("Check EML DL TXOP transmissions (" +
+                              std::to_string(params.nEmlsrStations) + "," +
+                              std::to_string(params.nNonEmlsrStations) + ")"),
+      m_emlsrLinks(params.linksToEnableEmlsrOn),
       m_emlsrEnabledTime(0),
       m_fe2to3delay(MilliSeconds(20)),
       m_countQoSframes(0),
       m_countBlockAck(0)
 {
-    m_nEmlsrStations = nEmlsrStations;
-    m_nNonEmlsrStations = nNonEmlsrStations;
+    m_nEmlsrStations = params.nEmlsrStations;
+    m_nNonEmlsrStations = params.nNonEmlsrStations;
     m_linksToEnableEmlsrOn = {}; // do not enable EMLSR right after association
     m_mainPhyId = 1;
-    m_paddingDelay = paddingDelay;
-    m_transitionDelay = transitionDelay;
-    m_transitionTimeout = transitionTimeout;
+    m_paddingDelay = params.paddingDelay;
+    m_transitionDelay = params.transitionDelay;
+    m_transitionTimeout = params.transitionTimeout;
     m_establishBaDl = true;
     m_duration = Seconds(1.5);
 
-    NS_ABORT_MSG_IF(linksToEnableEmlsrOn.size() < 2,
+    NS_ABORT_MSG_IF(params.linksToEnableEmlsrOn.size() < 2,
                     "This test requires at least two links to be configured as EMLSR links");
 }
 
@@ -2203,16 +2199,15 @@ EmlsrDlTxopTest::DoRun()
     Simulator::Destroy();
 }
 
-EmlsrLinkSwitchTest::EmlsrLinkSwitchTest(bool switchAuxPhy,
-                                         bool resetCamState,
-                                         uint16_t auxPhyMaxChWidth)
+EmlsrLinkSwitchTest::EmlsrLinkSwitchTest(const Params& params)
     : EmlsrOperationsTestBase(std::string("Check EMLSR link switching (switchAuxPhy=") +
-                              std::to_string(switchAuxPhy) +
-                              ", resetCamState=" + std::to_string(resetCamState) +
-                              ", auxPhyMaxChWidth=" + std::to_string(auxPhyMaxChWidth) + "MHz )"),
-      m_switchAuxPhy(switchAuxPhy),
-      m_resetCamState(resetCamState),
-      m_auxPhyMaxChWidth(auxPhyMaxChWidth),
+                              std::to_string(params.switchAuxPhy) +
+                              ", resetCamState=" + std::to_string(params.resetCamState) +
+                              ", auxPhyMaxChWidth=" + std::to_string(params.auxPhyMaxChWidth) +
+                              "MHz )"),
+      m_switchAuxPhy(params.switchAuxPhy),
+      m_resetCamState(params.resetCamState),
+      m_auxPhyMaxChWidth(params.auxPhyMaxChWidth),
       m_countQoSframes(0),
       m_txPsdusPos(0)
 {
@@ -2577,26 +2572,20 @@ WifiEmlsrTestSuite::WifiEmlsrTestSuite()
     for (const auto& emlsrLinks :
          {std::set<uint8_t>{0, 1, 2}, std::set<uint8_t>{1, 2}, std::set<uint8_t>{0, 1}})
     {
-        AddTestCase(new EmlsrDlTxopTest(1,
-                                        0,
-                                        emlsrLinks,
-                                        {MicroSeconds(32)},
-                                        {MicroSeconds(32)},
-                                        MicroSeconds(512)),
-                    TestCase::QUICK);
-        AddTestCase(new EmlsrDlTxopTest(1,
-                                        1,
-                                        emlsrLinks,
-                                        {MicroSeconds(64)},
-                                        {MicroSeconds(64)},
-                                        MicroSeconds(512)),
-                    TestCase::QUICK);
-        AddTestCase(new EmlsrDlTxopTest(2,
-                                        2,
-                                        emlsrLinks,
-                                        {MicroSeconds(128), MicroSeconds(256)},
-                                        {MicroSeconds(128), MicroSeconds(256)},
-                                        MicroSeconds(512)),
+        AddTestCase(
+            new EmlsrDlTxopTest(
+                {1, 0, emlsrLinks, {MicroSeconds(32)}, {MicroSeconds(32)}, MicroSeconds(512)}),
+            TestCase::QUICK);
+        AddTestCase(
+            new EmlsrDlTxopTest(
+                {1, 1, emlsrLinks, {MicroSeconds(64)}, {MicroSeconds(64)}, MicroSeconds(512)}),
+            TestCase::QUICK);
+        AddTestCase(new EmlsrDlTxopTest({2,
+                                         2,
+                                         emlsrLinks,
+                                         {MicroSeconds(128), MicroSeconds(256)},
+                                         {MicroSeconds(128), MicroSeconds(256)},
+                                         MicroSeconds(512)}),
                     TestCase::QUICK);
     }
 
@@ -2606,8 +2595,9 @@ WifiEmlsrTestSuite::WifiEmlsrTestSuite()
         {
             for (uint16_t auxPhyMaxChWidth : {20, 40, 80, 160})
             {
-                AddTestCase(new EmlsrLinkSwitchTest(switchAuxPhy, resetCamState, auxPhyMaxChWidth),
-                            TestCase::QUICK);
+                AddTestCase(
+                    new EmlsrLinkSwitchTest({switchAuxPhy, resetCamState, auxPhyMaxChWidth}),
+                    TestCase::QUICK);
             }
         }
     }
diff --git a/src/wifi/test/wifi-emlsr-test.h b/src/wifi/test/wifi-emlsr-test.h
index 28179208b..80077bca6 100644
--- a/src/wifi/test/wifi-emlsr-test.h
+++ b/src/wifi/test/wifi-emlsr-test.h
@@ -350,24 +350,29 @@ class EmlOmnExchangeTest : public EmlsrOperationsTestBase
 class EmlsrDlTxopTest : public EmlsrOperationsTestBase
 {
   public:
+    /**
+     * Parameters for the EMLSR DL TXOP test
+     */
+    struct Params
+    {
+        std::size_t nEmlsrStations;    //!< number of non-AP MLDs that support EMLSR
+        std::size_t nNonEmlsrStations; //!< number of non-AP MLDs that do not support EMLSR
+        std::set<uint8_t>
+            linksToEnableEmlsrOn;       //!< IDs of links on which EMLSR mode should be enabled
+        std::vector<Time> paddingDelay; //!< vector (whose size equals <i>nEmlsrStations</i>) of the
+                                        //!< padding delay values advertised by non-AP MLDs
+        std::vector<Time>
+            transitionDelay;    //!< vector (whose size equals <i>nEmlsrStations</i>) of
+                                //!< transition the delay values advertised by non-AP MLDs
+        Time transitionTimeout; //!< the Transition Timeout advertised by the AP MLD
+    };
+
     /**
      * Constructor
      *
-     * \param nEmlsrStations number of non-AP MLDs that support EMLSR
-     * \param nNonEmlsrStations number of non-AP MLDs that do not support EMLSR
-     * \param linksToEnableEmlsrOn IDs of links on which EMLSR mode should be enabled
-     * \param paddingDelay vector (whose size equals <i>nEmlsrStations</i>) of the padding
-     *                     delay values advertised by non-AP MLDs
-     * \param transitionDelay vector (whose size equals <i>nEmlsrStations</i>) of the transition
-     *                        delay values advertised by non-AP MLDs
-     * \param transitionTimeout the Transition Timeout advertised by the AP MLD
+     * \param params parameters for the EMLSR DL TXOP test
      */
-    EmlsrDlTxopTest(std::size_t nEmlsrStations,
-                    std::size_t nNonEmlsrStations,
-                    const std::set<uint8_t>& linksToEnableEmlsrOn,
-                    const std::vector<Time>& paddingDelay,
-                    const std::vector<Time>& transitionDelay,
-                    Time transitionTimeout);
+    EmlsrDlTxopTest(const Params& params);
     ~EmlsrDlTxopTest() override = default;
 
   protected:
@@ -476,16 +481,25 @@ class EmlsrDlTxopTest : public EmlsrOperationsTestBase
 class EmlsrLinkSwitchTest : public EmlsrOperationsTestBase
 {
   public:
+    /**
+     * Parameters for the EMLSR link switching test
+     */
+    struct Params
+    {
+        bool
+            switchAuxPhy; //!< whether AUX PHY should switch channel to operate on the link on which
+                          //!<  the Main PHY was operating before moving to the link of the Aux PHY
+        bool resetCamState; //!< whether to reset the state of the ChannelAccessManager associated
+                            //!< with the link on which the main PHY has just switched to
+        uint16_t auxPhyMaxChWidth; //!< max channel width (MHz) supported by aux PHYs
+    };
+
     /**
      * Constructor
      *
-     * \param switchAuxPhy whether AUX PHY should switch channel to operate on the link on which
-                          the Main PHY was operating before moving to the link of the Aux PHY
-     * \param resetCamState whether to reset the state of the ChannelAccessManager associated with
-                            the link on which the main PHY has just switched to
-        \param auxPhyMaxChWidth max channel width (MHz) supported by aux PHYs
+     * \param params parameters for the EMLSR link switching test
      */
-    EmlsrLinkSwitchTest(bool switchAuxPhy, bool resetCamState, uint16_t auxPhyMaxChWidth);
+    EmlsrLinkSwitchTest(const Params& params);
 
     ~EmlsrLinkSwitchTest() override = default;