From 2728fb97fd33a7a67e89ab5363427701963ddf79 2017-12-18 15:23:18
From: Alexandre Leroux <aleroux@itlink.fr>
Date: 2017-12-18 15:23:18
Subject: [PATCH] Merge branch 'feature/FuzingTests' into develop

---

diff --git a/core/include/Data/SqpRange.h b/core/include/Data/SqpRange.h
index fd7b344..9fb5cc3 100644
--- a/core/include/Data/SqpRange.h
+++ b/core/include/Data/SqpRange.h
@@ -14,6 +14,14 @@
  * @brief The SqpRange struct holds the information of time parameters
  */
 struct SqpRange {
+    /// Creates SqpRange from dates and times
+    static SqpRange fromDateTime(const QDate &startDate, const QTime &startTime,
+                                 const QDate &endDate, const QTime &endTime)
+    {
+        return {DateUtils::secondsSinceEpoch(QDateTime{startDate, startTime}),
+                DateUtils::secondsSinceEpoch(QDateTime{endDate, endTime})};
+    }
+
     /// Start time (UTC)
     double m_TStart;
     /// End time (UTC)
diff --git a/plugins/amda/CMakeLists.txt b/plugins/amda/CMakeLists.txt
index dcce263..ebcaf32 100644
--- a/plugins/amda/CMakeLists.txt
+++ b/plugins/amda/CMakeLists.txt
@@ -115,6 +115,7 @@ IF(BUILD_TESTS)
                         ${testDirectory}/*.cpp
                         ${testDirectory}/*.h)
                 LIST (REMOVE_ITEM currentTestSources ${TESTS_SOURCES})
+                LIST(APPEND testFilesToFormat ${currentTestSources})
                 # LIST (REMOVE_ITEM currentTestSources ${TESTS_HEADERS})
 
                 ADD_EXECUTABLE(${testName} ${testFile} ${currentTestSources})
diff --git a/plugins/amda/meson.build b/plugins/amda/meson.build
index 7728623..52109e4 100644
--- a/plugins/amda/meson.build
+++ b/plugins/amda/meson.build
@@ -62,7 +62,17 @@ sciqlop_amdaplugin = library('amdaplugin',
 tests = [
   [['tests/TestAmdaParser.cpp'],'test_amda_parser','AMDA parser test'],
   [['tests/TestAmdaResultParser.cpp'],'test_amda_result_parser','AMDA result parser test'],
-  [['tests/TestAmdaAcquisition.cpp'],'test_amda_acquisition','AMDA Acquisition test']
+  [['tests/TestAmdaAcquisition.cpp'],'test_amda_acquisition','AMDA Acquisition test'],
+  [['tests/TestAmdaFuzzing.cpp'],'test_amda_fuzzing','AMDA fuzzing test']
+]
+
+tests_sources = [
+  'tests/FuzzingDefs.h',
+  'tests/FuzzingDefs.cpp',
+  'tests/FuzzingOperations.h',
+  'tests/FuzzingOperations.cpp',
+  'tests/FuzzingUtils.h',
+  'tests/FuzzingUtils.cpp'
 ]
 
 foreach unit_test : tests
@@ -71,6 +81,7 @@ foreach unit_test : tests
                           link_with : [sciqlop_amdaplugin],
                           include_directories : [amdaplugin_inc],
                           cpp_args : ['-DAMDA_TESTS_RESOURCES_DIR="'+meson.current_source_dir()+'/tests-resources"'],
+						  sources : [tests_sources],
                           dependencies : [sciqlop_core, sciqlop_gui, qt5test])
   test(unit_test[2], test_exe, args: ['-teamcity', '-o', '@0@.teamcity.txt'.format(unit_test[1])], timeout: 3 * 60)
 endforeach
diff --git a/plugins/amda/tests/FuzzingDefs.cpp b/plugins/amda/tests/FuzzingDefs.cpp
new file mode 100644
index 0000000..71e863f
--- /dev/null
+++ b/plugins/amda/tests/FuzzingDefs.cpp
@@ -0,0 +1,8 @@
+#include "FuzzingDefs.h"
+
+const QString NB_MAX_OPERATIONS_PROPERTY = QStringLiteral("component");
+const QString NB_MAX_VARIABLES_PROPERTY = QStringLiteral("nbMaxVariables");
+const QString AVAILABLE_OPERATIONS_PROPERTY = QStringLiteral("availableOperations");
+const QString MAX_RANGE_PROPERTY = QStringLiteral("maxRange");
+const QString METADATA_POOL_PROPERTY = QStringLiteral("metadataPool");
+const QString PROVIDER_PROPERTY = QStringLiteral("provider");
diff --git a/plugins/amda/tests/FuzzingDefs.h b/plugins/amda/tests/FuzzingDefs.h
new file mode 100644
index 0000000..8d6f092
--- /dev/null
+++ b/plugins/amda/tests/FuzzingDefs.h
@@ -0,0 +1,38 @@
+#ifndef SCIQLOP_FUZZINGDEFS_H
+#define SCIQLOP_FUZZINGDEFS_H
+
+#include <QString>
+#include <QVariantHash>
+
+// /////// //
+// Aliases //
+// /////// //
+
+using MetadataPool = std::vector<QVariantHash>;
+Q_DECLARE_METATYPE(MetadataPool)
+
+using Properties = QVariantHash;
+
+// ///////// //
+// Constants //
+// ///////// //
+
+/// Max number of operations to generate
+extern const QString NB_MAX_OPERATIONS_PROPERTY;
+
+/// Max number of variables to manipulate through operations
+extern const QString NB_MAX_VARIABLES_PROPERTY;
+
+/// Set of operations available for the test
+extern const QString AVAILABLE_OPERATIONS_PROPERTY;
+
+/// Max range that an operation can reach
+extern const QString MAX_RANGE_PROPERTY;
+
+/// Set of metadata that can be associated to a variable
+extern const QString METADATA_POOL_PROPERTY;
+
+/// Provider used to retrieve data
+extern const QString PROVIDER_PROPERTY;
+
+#endif // SCIQLOP_FUZZINGDEFS_H
diff --git a/plugins/amda/tests/FuzzingOperations.cpp b/plugins/amda/tests/FuzzingOperations.cpp
new file mode 100644
index 0000000..124ae35
--- /dev/null
+++ b/plugins/amda/tests/FuzzingOperations.cpp
@@ -0,0 +1,74 @@
+#include "FuzzingOperations.h"
+#include "FuzzingUtils.h"
+
+#include <Data/IDataProvider.h>
+
+#include <Variable/Variable.h>
+#include <Variable/VariableController.h>
+
+#include <QUuid>
+
+Q_LOGGING_CATEGORY(LOG_FuzzingOperations, "FuzzingOperations")
+
+namespace {
+
+struct CreateOperation : public IFuzzingOperation {
+    bool canExecute(std::shared_ptr<Variable> variable) const override
+    {
+        // A variable can be created only if it doesn't exist yet
+        return variable == nullptr;
+    }
+
+    void execute(std::shared_ptr<Variable> &variable, VariableController &variableController,
+                 const Properties &properties) const override
+    {
+        // Retrieves metadata pool from properties, and choose one of the metadata entries to
+        // associate it with the variable
+        auto metaDataPool = properties.value(METADATA_POOL_PROPERTY).value<MetadataPool>();
+        auto variableMetadata = RandomGenerator::instance().randomChoice(metaDataPool);
+
+        // Retrieves provider
+        auto variableProvider
+            = properties.value(PROVIDER_PROPERTY).value<std::shared_ptr<IDataProvider> >();
+
+        auto variableName = QString{"Var_%1"}.arg(QUuid::createUuid().toString());
+        qCInfo(LOG_FuzzingOperations())
+            << "Creating variable" << variableName << "(metadata:" << variableMetadata << ")";
+
+        auto newVariable
+            = variableController.createVariable(variableName, variableMetadata, variableProvider);
+        std::swap(variable, newVariable);
+    }
+};
+
+struct UnknownOperation : public IFuzzingOperation {
+    bool canExecute(std::shared_ptr<Variable> variable) const override
+    {
+        Q_UNUSED(variable);
+        return false;
+    }
+
+    void execute(std::shared_ptr<Variable> &variable, VariableController &variableController,
+                 const Properties &properties) const override
+    {
+        Q_UNUSED(variable);
+        Q_UNUSED(variableController);
+        Q_UNUSED(properties);
+        // Does nothing
+    }
+};
+
+} // namespace
+
+std::unique_ptr<IFuzzingOperation> FuzzingOperationFactory::create(FuzzingOperationType type)
+{
+    switch (type) {
+        case FuzzingOperationType::CREATE:
+            return std::make_unique<CreateOperation>();
+        default:
+            // Default case returns unknown operation
+            break;
+    }
+
+    return std::make_unique<UnknownOperation>();
+}
diff --git a/plugins/amda/tests/FuzzingOperations.h b/plugins/amda/tests/FuzzingOperations.h
new file mode 100644
index 0000000..cbc3dc0
--- /dev/null
+++ b/plugins/amda/tests/FuzzingOperations.h
@@ -0,0 +1,49 @@
+#ifndef SCIQLOP_FUZZINGOPERATIONS_H
+#define SCIQLOP_FUZZINGOPERATIONS_H
+
+#include "FuzzingDefs.h"
+
+#include <memory>
+#include <set>
+
+#include <QLoggingCategory>
+#include <QMetaType>
+
+Q_DECLARE_LOGGING_CATEGORY(LOG_FuzzingOperations)
+
+class Variable;
+class VariableController;
+
+/**
+ * Enumeration of types of existing fuzzing operations
+ */
+enum class FuzzingOperationType { CREATE };
+
+/// Interface that represents an operation that can be executed during a fuzzing test
+struct IFuzzingOperation {
+    virtual ~IFuzzingOperation() noexcept = default;
+
+    /// Checks if the operation can be executed according to the current state of the variable
+    /// passed in parameter
+    virtual bool canExecute(std::shared_ptr<Variable> variable) const = 0;
+    /// Executes the operation on the variable passed in parameter
+    /// @param variable the variable on which to execute the operation
+    /// @param variableController the controller associated to the operation
+    /// @param properties properties that can be used to configure the operation
+    /// @remarks variable is passed as a reference because, according to the operation, it can be
+    /// modified (in/out parameter)
+    virtual void execute(std::shared_ptr<Variable> &variable,
+                         VariableController &variableController,
+                         const Properties &properties = {}) const = 0;
+};
+
+/// Factory of @sa IFuzzingOperation
+struct FuzzingOperationFactory {
+    /// Creates a fuzzing operation from a type
+    static std::unique_ptr<IFuzzingOperation> create(FuzzingOperationType type);
+};
+
+using OperationsTypes = std::set<FuzzingOperationType>;
+Q_DECLARE_METATYPE(OperationsTypes)
+
+#endif // SCIQLOP_FUZZINGOPERATIONS_H
diff --git a/plugins/amda/tests/FuzzingUtils.cpp b/plugins/amda/tests/FuzzingUtils.cpp
new file mode 100644
index 0000000..6cf89af
--- /dev/null
+++ b/plugins/amda/tests/FuzzingUtils.cpp
@@ -0,0 +1,25 @@
+#include "FuzzingUtils.h"
+
+RandomGenerator &RandomGenerator::instance()
+{
+    static auto instance = RandomGenerator();
+    return instance;
+}
+
+double RandomGenerator::generateDouble(double min, double max)
+{
+    std::uniform_real_distribution<double> dist{min, max};
+    return dist(m_Mt);
+}
+
+int RandomGenerator::generateInt(int min, int max)
+{
+    std::uniform_int_distribution<int> dist{min, max};
+    return dist(m_Mt);
+}
+
+RandomGenerator::RandomGenerator()
+{
+    std::random_device rd{};
+    m_Mt = std::mt19937{rd()};
+}
diff --git a/plugins/amda/tests/FuzzingUtils.h b/plugins/amda/tests/FuzzingUtils.h
new file mode 100644
index 0000000..adfe293
--- /dev/null
+++ b/plugins/amda/tests/FuzzingUtils.h
@@ -0,0 +1,41 @@
+#ifndef SCIQLOP_FUZZINGUTILS_H
+#define SCIQLOP_FUZZINGUTILS_H
+
+#include <random>
+
+/**
+ * Class that proposes random utility methods
+ */
+class RandomGenerator {
+public:
+    /// @return the unique instance of the random generator
+    static RandomGenerator &instance();
+
+    /// Generates a random double between [min, max]
+    double generateDouble(double min, double max);
+    /// Generates a random int between [min, max]
+    int generateInt(int min, int max);
+
+    /// Returns a random element among the elements of a container. If the container is empty,
+    /// returns an element built by default
+    template <typename T, typename ValueType = typename T::value_type>
+    ValueType randomChoice(const T &container);
+
+private:
+    std::mt19937 m_Mt;
+
+    explicit RandomGenerator();
+};
+
+template <typename T, typename ValueType>
+ValueType RandomGenerator::randomChoice(const T &container)
+{
+    if (container.empty()) {
+        return ValueType{};
+    }
+
+    auto randomIndex = generateInt(0, container.size() - 1);
+    return container.at(randomIndex);
+}
+
+#endif // SCIQLOP_FUZZINGUTILS
diff --git a/plugins/amda/tests/TestAmdaFuzzing.cpp b/plugins/amda/tests/TestAmdaFuzzing.cpp
new file mode 100644
index 0000000..41ace89
--- /dev/null
+++ b/plugins/amda/tests/TestAmdaFuzzing.cpp
@@ -0,0 +1,241 @@
+#include "FuzzingDefs.h"
+#include "FuzzingOperations.h"
+#include "FuzzingUtils.h"
+
+#include "AmdaProvider.h"
+
+#include <Network/NetworkController.h>
+#include <SqpApplication.h>
+#include <Time/TimeController.h>
+#include <Variable/VariableController.h>
+
+#include <QLoggingCategory>
+#include <QObject>
+#include <QtTest>
+
+#include <memory>
+
+Q_LOGGING_CATEGORY(LOG_TestAmdaFuzzing, "TestAmdaFuzzing")
+
+namespace {
+
+// /////// //
+// Aliases //
+// /////// //
+
+using VariableId = int;
+
+using VariableOperation = std::pair<VariableId, std::shared_ptr<IFuzzingOperation> >;
+using VariablesOperations = std::vector<VariableOperation>;
+
+using OperationsPool = std::set<std::shared_ptr<IFuzzingOperation> >;
+using VariablesPool = std::map<VariableId, std::shared_ptr<Variable> >;
+
+// ///////// //
+// Constants //
+// ///////// //
+
+// Defaults values used when the associated properties have not been set for the test
+const auto NB_MAX_OPERATIONS_DEFAULT_VALUE = 100;
+const auto NB_MAX_VARIABLES_DEFAULT_VALUE = 1;
+const auto AVAILABLE_OPERATIONS_DEFAULT_VALUE
+    = QVariant::fromValue(OperationsTypes{FuzzingOperationType::CREATE});
+
+// /////// //
+// Methods //
+// /////// //
+
+/// Goes through the variables pool and operations pool to determine the set of {variable/operation}
+/// pairs that are valid (i.e. operation that can be executed on variable)
+VariablesOperations availableOperations(const VariablesPool &variablesPool,
+                                        const OperationsPool &operationsPool)
+{
+    VariablesOperations result{};
+
+    for (const auto &variablesPoolEntry : variablesPool) {
+        auto variableId = variablesPoolEntry.first;
+        auto variable = variablesPoolEntry.second;
+
+        for (const auto &operation : operationsPool) {
+            // A pair is valid if the current operation can be executed on the current variable
+            if (operation->canExecute(variable)) {
+                result.push_back({variableId, operation});
+            }
+        }
+    }
+
+    return result;
+}
+
+OperationsPool createOperationsPool(const OperationsTypes &types)
+{
+    OperationsPool result{};
+
+    std::transform(types.cbegin(), types.cend(), std::inserter(result, result.end()),
+                   [](const auto &type) { return FuzzingOperationFactory::create(type); });
+
+    return result;
+}
+
+/**
+ * Class to run random tests
+ */
+class FuzzingTest {
+public:
+    explicit FuzzingTest(VariableController &variableController, Properties properties)
+            : m_VariableController{variableController},
+              m_Properties{std::move(properties)},
+              m_VariablesPool{}
+    {
+        // Inits variables pool: at init, all variables are null
+        for (auto variableId = 0; variableId < nbMaxVariables(); ++variableId) {
+            m_VariablesPool[variableId] = nullptr;
+        }
+    }
+
+    void execute()
+    {
+        qCInfo(LOG_TestAmdaFuzzing()) << "Running" << nbMaxOperations() << "operations on"
+                                      << nbMaxVariables() << "variable(s)...";
+
+        auto canExecute = true;
+        for (auto i = 0; i < nbMaxOperations() && canExecute; ++i) {
+            // Retrieves all operations that can be executed in the current context
+            auto variableOperations = availableOperations(m_VariablesPool, operationsPool());
+
+            canExecute = !variableOperations.empty();
+            if (canExecute) {
+                // Of the operations available, chooses a random operation and executes it
+                auto variableOperation
+                    = RandomGenerator::instance().randomChoice(variableOperations);
+
+                auto variableId = variableOperation.first;
+                auto variable = m_VariablesPool.at(variableId);
+                auto fuzzingOperation = variableOperation.second;
+
+                fuzzingOperation->execute(variable, m_VariableController, m_Properties);
+
+                // Updates variable pool with the new state of the variable after operation
+                m_VariablesPool[variableId] = variable;
+            }
+            else {
+                qCInfo(LOG_TestAmdaFuzzing())
+                    << "No more operations are available, the execution of the test will stop...";
+            }
+        }
+
+        qCInfo(LOG_TestAmdaFuzzing()) << "Execution of the test completed.";
+    }
+
+private:
+    int nbMaxOperations() const
+    {
+        static auto result
+            = m_Properties.value(NB_MAX_OPERATIONS_PROPERTY, NB_MAX_OPERATIONS_DEFAULT_VALUE)
+                  .toInt();
+        return result;
+    }
+
+    int nbMaxVariables() const
+    {
+        static auto result
+            = m_Properties.value(NB_MAX_VARIABLES_PROPERTY, NB_MAX_VARIABLES_DEFAULT_VALUE).toInt();
+        return result;
+    }
+
+    OperationsPool operationsPool() const
+    {
+        static auto result = createOperationsPool(
+            m_Properties.value(AVAILABLE_OPERATIONS_PROPERTY, AVAILABLE_OPERATIONS_DEFAULT_VALUE)
+                .value<OperationsTypes>());
+        return result;
+    }
+
+    VariableController &m_VariableController;
+    Properties m_Properties;
+    VariablesPool m_VariablesPool;
+};
+
+} // namespace
+
+class TestAmdaFuzzing : public QObject {
+    Q_OBJECT
+
+private slots:
+    /// Input data for @sa testFuzzing()
+    void testFuzzing_data();
+    void testFuzzing();
+};
+
+void TestAmdaFuzzing::testFuzzing_data()
+{
+    // ////////////// //
+    // Test structure //
+    // ////////////// //
+
+    QTest::addColumn<Properties>("properties"); // Properties for random test
+
+    // ////////// //
+    // Test cases //
+    // ////////// //
+
+    auto maxRange = SqpRange::fromDateTime({2017, 1, 1}, {0, 0}, {2017, 1, 5}, {0, 0});
+    MetadataPool metadataPool{{{"dataType", "vector"}, {"xml:id", "imf"}}};
+
+    // Note: we don't use auto here as we want to pass std::shared_ptr<IDataProvider> as is in the
+    // QVariant
+    std::shared_ptr<IDataProvider> provider = std::make_shared<AmdaProvider>();
+
+    QTest::newRow("fuzzingTest") << Properties{
+        {MAX_RANGE_PROPERTY, QVariant::fromValue(maxRange)},
+        {METADATA_POOL_PROPERTY, QVariant::fromValue(metadataPool)},
+        {PROVIDER_PROPERTY, QVariant::fromValue(provider)}};
+}
+
+void TestAmdaFuzzing::testFuzzing()
+{
+    QFETCH(Properties, properties);
+
+    auto &variableController = sqpApp->variableController();
+    auto &timeController = sqpApp->timeController();
+
+    // Generates random initial range (bounded to max range)
+    auto maxRange = properties.value(MAX_RANGE_PROPERTY, QVariant::fromValue(INVALID_RANGE))
+                        .value<SqpRange>();
+
+    QVERIFY(maxRange != INVALID_RANGE);
+
+    auto initialRangeStart
+        = RandomGenerator::instance().generateDouble(maxRange.m_TStart, maxRange.m_TEnd);
+    auto initialRangeEnd
+        = RandomGenerator::instance().generateDouble(maxRange.m_TStart, maxRange.m_TEnd);
+    if (initialRangeStart > initialRangeEnd) {
+        std::swap(initialRangeStart, initialRangeEnd);
+    }
+
+    // Sets initial range on time controller
+    SqpRange initialRange{initialRangeStart, initialRangeEnd};
+    qCInfo(LOG_TestAmdaFuzzing()) << "Setting initial range to" << initialRange << "...";
+    timeController.onTimeToUpdate(initialRange);
+
+    FuzzingTest test{variableController, properties};
+    test.execute();
+}
+
+int main(int argc, char *argv[])
+{
+    QLoggingCategory::setFilterRules(
+        "*.warning=false\n"
+        "*.info=false\n"
+        "*.debug=false\n"
+        "FuzzingOperations.info=true\n"
+        "TestAmdaFuzzing.info=true\n");
+
+    SqpApplication app{argc, argv};
+    app.setAttribute(Qt::AA_Use96Dpi, true);
+    TestAmdaFuzzing testObject{};
+    QTEST_SET_MAIN_SOURCE_PATH
+    return QTest::qExec(&testObject, argc, argv);
+}
+
+#include "TestAmdaFuzzing.moc"