TestWorker.h

Go to the documentation of this file.

/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */
 
#ifndef META_OCEAN_TEST_TESTBASE_WORKER_H
#define META_OCEAN_TEST_TESTBASE_WORKER_H
 
#include "ocean/test/testbase/TestBase.h"
#include "ocean/test/TestSelector.h"
 
#include "ocean/base/Worker.h"
 
namespace Ocean
{
 
namespace Test
{
 
namespace TestBase
{
 
/**
 * This class implements worker tests.
 * @ingroup testbase
 */
class OCEAN_TEST_BASE_EXPORT TestWorker : protected Worker
{
    public:
 
        /**
         * Tests the entire worker functionalities.
         * @param testDuration The number of seconds for each test, with range (0, infinity)
         * @param selector Optional test selector
         * @return True, if succeeded
         */
        static bool test(const double testDuration, const TestSelector& selector = TestSelector());
 
        /**
         * Tests the constructor.
         * @return True, if succeeded
         */
        static bool testConstructor();
 
        /**
         * Tests the worker delay.
         * @param testDuration The number of seconds for each test, with range (0, infinity)
         * @param worker The worker object to be used
         * @return True, if succeeded
         */
        static bool testDelay(const double testDuration, Worker& worker);
 
        /**
         * Tests the worker calling a static function.
         * @param worker The worker object to be used
         * @return True, if succeeded
         */
        static bool testStaticWorker(Worker& worker);
 
        /**
         * Tests the validation of the worker calling a static function.
         * @param testDuration The number of seconds for each test, with range (0, infinity)
         * @param worker The worker object to be used
         * @return True, if succeeded
         */
        static bool testStaticWorkerSumOfSquares(const double testDuration, Worker& worker);
 
        /**
         * Tests the validation of the worker calling a static function.
         * @param testDuration The number of seconds for each test, with range (0, infinity)
         * @param worker The worker object to be used
         * @return True, if succeeded
         */
        static bool testStaticWorkerSumOfSquareRoots(const double testDuration, Worker& worker);
 
        /**
         * Tests the validation of the worker calling a static abortable function.
         * @param worker The worker object to be used
         * @return True, if succeeded
         */
        static bool testAbortableFunction(Worker& worker);
 
        /**
         * Tests the validation of the worker calling a static separable and abortable function.
         * @param worker The worker object to be used
         * @return True, if succeeded
         */
        static bool testSeparableAndAbortableFunction(Worker& worker);
 
    private:
 
        /**
         * Static worker function.
         * @param time The time parameters, must be valid
         * @param first The first element
         * @param size The number of elements, with range [1, infinity)
         */
        static void staticWorkerFunctionDelay(uint64_t* time, const unsigned int first, const unsigned int size);
 
        /**
         * Static worker function.
         * @param first The first element
         * @param size The number of elements, with range [1, infinity)
         */
        static void staticWorkerFunction(const unsigned int first, const unsigned int size);
 
        /**
         * Static worker function to calculate the sum of square values.
         * @param values The values to be handled, must be valid
         * @param first The first element
         * @param size The number of elements, with range [1, infinity)
         */
        static void staticWorkerFunctionSumOfSquares(unsigned int* values, const unsigned int first, const unsigned int size);
 
        /**
         * Static worker function to calculate the sum of square root values.
         * @param values The values to be handled, must be valid
         * @param first The first element
         * @param size The number of elements, with range [1, infinity)
         */
        static void staticWorkerFunctionSumOfSquareRoots(double* values, const unsigned int first, const unsigned int size);
 
        /**
         * Static abortable worker function.
         * @param result Function result
         * @param abort The abort state
         * @return True, if succeeded and not aborted
         */
        static bool staticWorkerFunctionAbortable(double* result, bool* abort);
 
        /**
         * Static separable and abortable worker function.
         * @param result Function result
         * @param first The first object to be handled
         * @param size Number of objects to be handled
         * @param abort The abort state
         * @return True, if succeeded and not aborted
         */
        static bool staticWorkerFunctionSeparableAndAbortable(double* result, const unsigned int first, const unsigned int size, bool* abort);
};
 
}
 
}
 
}
 
#endif // META_OCEAN_TEST_TESTBASE_WORKER_H