tests/src/Mod/Material/App/TestMaterialProperties.cpp

// SPDX-License-Identifier: LGPL-2.1-or-later
/***************************************************************************
 *   Copyright (c) 2023 David Carter <dcarter@david.carter.ca>             *
 *                                                                         *
 *   This file is part of FreeCAD.                                         *
 *                                                                         *
 *   FreeCAD is free software: you can redistribute it and/or modify it    *
 *   under the terms of the GNU Lesser General Public License as           *
 *   published by the Free Software Foundation, either version 2.1 of the  *
 *   License, or (at your option) any later version.                       *
 *                                                                         *
 *   FreeCAD is distributed in the hope that it will be useful, but        *
 *   WITHOUT ANY WARRANTY; without even the implied warranty of            *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU      *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with FreeCAD. If not, see                               *
 *   <https://www.gnu.org/licenses/>.                                      *
 *                                                                         *
 **************************************************************************/

#include <gtest/gtest.h>

#include <memory>

#include <QMetaType>
#include <QString>

#include <App/Application.h>
#include <Gui/MetaTypes.h>

#include <Mod/Material/App/MaterialManager.h>
#include <Mod/Material/App/Model.h>
#include <Mod/Material/App/ModelManager.h>
#include <Mod/Material/App/ModelUuids.h>

class TestMaterialProperties: public ::testing::Test
{
protected:
    static void SetUpTestSuite()
    {}

    void SetUp() override
    {
        // 2D Properties
        modelProp = Materials::ModelProperty(
            QStringLiteral("Density"),  // Name
            QStringLiteral("D"),        // Header
            QStringLiteral("2DArray"),  // Type
            QStringLiteral(""),         // Units
            QStringLiteral(""),         // URL
            QStringLiteral("desc")
        );  // Description
        modelProp1 = Materials::ModelProperty(
            QStringLiteral("Temperature"),
            QStringLiteral("T"),
            QStringLiteral("Quantity"),
            QStringLiteral("C"),
            QStringLiteral(""),
            QStringLiteral("desc1")
        );
        modelProp2 = Materials::ModelProperty(
            QStringLiteral("Density"),
            QStringLiteral("D"),
            QStringLiteral("Quantity"),
            QStringLiteral("kg/m^3"),
            QStringLiteral("https://en.wikipedia.org/wiki/Density"),
            QStringLiteral("desc2")
        );

        modelProp.addColumn(modelProp1);
        modelProp.addColumn(modelProp2);

        // 3D properties
        model3DProp = Materials::ModelProperty(
            QStringLiteral("StressStrain"),     // Name
            QStringLiteral("Stress / Strain"),  // Header
            QStringLiteral("3DArray"),          // Type
            QStringLiteral(""),                 // Units
            QStringLiteral(""),                 // URL
            QStringLiteral(
                "3 Dimensional array showing stress and strain as a function of "
                "temperature"
            )
        );  // Description
        model3DProp1 = Materials::ModelProperty(
            QStringLiteral("Temperature"),
            QStringLiteral("T"),
            QStringLiteral("Quantity"),
            QStringLiteral("C"),
            QStringLiteral(""),
            QStringLiteral("desc1")
        );
        model3DProp2 = Materials::ModelProperty(
            QStringLiteral("Stress"),
            QStringLiteral("Stress"),
            QStringLiteral("Quantity"),
            QStringLiteral("MPa"),
            QStringLiteral(""),
            QStringLiteral("desc2")
        );
        model3DProp3 = Materials::ModelProperty(
            QStringLiteral("Strain"),
            QStringLiteral("Strain"),
            QStringLiteral("Quantity"),
            QStringLiteral("MPa"),
            QStringLiteral(""),
            QStringLiteral("desc3")
        );

        model3DProp.addColumn(model3DProp1);
        model3DProp.addColumn(model3DProp2);
        model3DProp.addColumn(model3DProp3);
    }

    // void TearDown() override {}

    Materials::ModelProperty modelProp;
    Materials::ModelProperty modelProp1;
    Materials::ModelProperty modelProp2;
    Materials::ModelProperty model3DProp;
    Materials::ModelProperty model3DProp1;
    Materials::ModelProperty model3DProp2;
    Materials::ModelProperty model3DProp3;
};

TEST_F(TestMaterialProperties, TestEmpty)
{
    Materials::MaterialProperty prop;
    EXPECT_EQ(prop.getType(), Materials::MaterialValue::None);
    EXPECT_TRUE(prop.isNull());
    auto variant = prop.getValue();
    EXPECT_TRUE(variant.isNull());
    EXPECT_FALSE(variant.canConvert<QString>());
    EXPECT_TRUE(variant.toString().isNull());
    EXPECT_TRUE(variant.toString().isEmpty());
    EXPECT_EQ(variant.toString().size(), 0);
}

TEST_F(TestMaterialProperties, TestSingle)
{
    Materials::MaterialProperty prop(modelProp1, QStringLiteral("sampleUUID"));
    EXPECT_EQ(prop.getType(), Materials::MaterialValue::Quantity);
    EXPECT_EQ(prop.getModelUUID(), QStringLiteral("sampleUUID"));
    EXPECT_TRUE(prop.isNull());
    auto variant = prop.getValue();
    EXPECT_TRUE(variant.canConvert<Base::Quantity>());
    EXPECT_FALSE(variant.value<Base::Quantity>().isValid());
    EXPECT_FALSE(variant.canConvert<QString>());
    EXPECT_TRUE(variant.toString().isNull());
    EXPECT_TRUE(variant.toString().isEmpty());
    EXPECT_EQ(variant.toString().size(), 0);
}

void check2DArray(Materials::MaterialProperty& prop)
{
    EXPECT_EQ(prop.getType(), Materials::MaterialValue::Array2D);
    EXPECT_EQ(prop.getModelUUID(), QStringLiteral("sampleUUID"));
    EXPECT_TRUE(prop.isNull());
    auto array = std::static_pointer_cast<Materials::Array2D>(prop.getMaterialValue());
    EXPECT_EQ(array->rows(), 0);
    auto variant = prop.getValue();  // Throw an error?
    EXPECT_FALSE(variant.canConvert<QString>());
    EXPECT_TRUE(variant.toString().isNull());
    EXPECT_TRUE(variant.toString().isEmpty());
    EXPECT_EQ(variant.toString().size(), 0);

    // Check the columns
    EXPECT_EQ(prop.columns(), 2);
}

TEST_F(TestMaterialProperties, Test2DArray)
{
    Materials::MaterialProperty prop(modelProp, QStringLiteral("sampleUUID"));
    check2DArray(prop);
}

TEST_F(TestMaterialProperties, Test2DArrayCopy)
{
    Materials::MaterialProperty propBase(modelProp, QStringLiteral("sampleUUID"));
    Materials::MaterialProperty prop(propBase);
    check2DArray(prop);
}

TEST_F(TestMaterialProperties, Test2DArrayAssignment)
{
    Materials::MaterialProperty propBase(modelProp, QStringLiteral("sampleUUID"));
    Materials::MaterialProperty prop;

    prop = propBase;
    check2DArray(prop);
}

void check3DArray(Materials::MaterialProperty& prop)
{
    EXPECT_EQ(prop.getType(), Materials::MaterialValue::Array3D);
    EXPECT_EQ(prop.getModelUUID(), QStringLiteral("sampleUUID"));
    EXPECT_TRUE(prop.isNull());
    auto array = std::static_pointer_cast<Materials::Array3D>(prop.getMaterialValue());
    EXPECT_EQ(array->depth(), 0);
    auto variant = prop.getValue();  // Throw an error?
    EXPECT_FALSE(variant.canConvert<QString>());
    EXPECT_TRUE(variant.toString().isNull());
    EXPECT_TRUE(variant.toString().isEmpty());
    EXPECT_EQ(variant.toString().size(), 0);

    // Check the columns
    EXPECT_EQ(prop.columns(), 3);
}

TEST_F(TestMaterialProperties, Test3DArray)
{
    Materials::MaterialProperty prop(model3DProp, QStringLiteral("sampleUUID"));
    check3DArray(prop);
}

TEST_F(TestMaterialProperties, Test3DArrayCopy)
{
    Materials::MaterialProperty propBase(model3DProp, QStringLiteral("sampleUUID"));
    Materials::MaterialProperty prop(propBase);
    check3DArray(prop);
}

TEST_F(TestMaterialProperties, Test3DArrayAssignment)
{
    Materials::MaterialProperty propBase(model3DProp, QStringLiteral("sampleUUID"));
    Materials::MaterialProperty prop;

    prop = propBase;
    check3DArray(prop);
}

// clang-format off

// clang-format on