src/transport/raw/tests/NetworkTestHelpers.h

   1 /*
   2  *
   3  *    Copyright (c) 2020 Project CHIP Authors
   4  *
   5  *    Licensed under the Apache License, Version 2.0 (the "License");
   6  *    you may not use this file except in compliance with the License.
   7  *    You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  *    Unless required by applicable law or agreed to in writing, software
  12  *    distributed under the License is distributed on an "AS IS" BASIS,
  13  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *    See the License for the specific language governing permissions and
  15  *    limitations under the License.
  16  */
  17 #pragma once
  18
  19 #include <functional>
  20
  21 #include <core/CHIPError.h>
  22 #include <inet/InetLayer.h>
  23 #include <system/SystemLayer.h>
  24
  25 #include <nlbyteorder.h>
  26 #include <nlunit-test.h>
  27
  28 namespace chip {
  29 namespace Test {
  30
  31 class IOContext
  32 {
  33 public:
  34     IOContext() {}
  35
  36     /// Initialize the underlying layers and test suite pointer
  37     CHIP_ERROR Init(nlTestSuite * suite);
  38
  39     // Shutdown all layers, finalize operations
  40     CHIP_ERROR Shutdown();
  41
  42     /// Perform a single short IO Loop
  43     void DriveIO();
  44
  45     /// DriveIO until the specified number of milliseconds has passed or until
  46     /// completionFunction returns true
  47     void DriveIOUntil(unsigned maxWaitMs, std::function<bool(void)> completionFunction);
  48
  49     nlTestSuite * GetTestSuite() { return mSuite; }
  50     System::Layer & GetSystemLayer() { return *mSystemLayer; }
  51     Inet::InetLayer & GetInetLayer() { return *mInetLayer; }
  52
  53 private:
  54     nlTestSuite * mSuite         = nullptr;
  55     System::Layer * mSystemLayer = nullptr;
  56     Inet::InetLayer * mInetLayer = nullptr;
  57 };
  58
  59 } // namespace Test
  60 } // namespace chip