test/test-util-data-file.cpp

#include <util/data_file.hpp>
#include <util/temporary_file.hpp>
#include <util/trace.hpp>

#include "gtest/gtest.h"

using namespace std;
using namespace util;

using json = nlohmann::json;

TEST(UtilDataFile, TestFindFiles)
{
    // The parent folder is determined by the file system.
    // On Linux it is /tmp.
    fs::path dataDir = fs::temp_directory_path();
    // Regex pattern of the temp files used by TemporaryFile class.
    auto regexPattern = R"(openpower\-hw\-diags\-.*)";
    // The vector to store temp files.
    vector<fs::path> dataPaths;

    // Create two new temp file objects.
    TemporaryFile tempFile1{};
    TemporaryFile tempFile2{};

    // Get the string of paths of temp files.
    string fullPathTempFile1 = tempFile1.getPath();
    string fullPathTempFile2 = tempFile2.getPath();
    EXPECT_NE(fullPathTempFile1, fullPathTempFile2);

    trace::inf("fullPathTempFile1: %s", fullPathTempFile1.c_str());
    trace::inf("fullPathTempFile2: %s", fullPathTempFile2.c_str());

    // Path objects of two temp files
    // path1 and path2 will be used to test later.
    fs::path path1 = fullPathTempFile1;
    fs::path path2 = fullPathTempFile2;

    // After creating new temp files, call the function under test.
    util::findFiles(dataDir, regexPattern, dataPaths);

    vector<fs::path>::iterator it;
    // Verify that the newly created temp files were in vector dataPaths
    it = find(dataPaths.begin(), dataPaths.end(), path1);
    EXPECT_TRUE(it != dataPaths.end());
    it = find(dataPaths.begin(), dataPaths.end(), path2);
    EXPECT_TRUE(it != dataPaths.end());

    // Remove the newly created temp files.
    tempFile1.remove();
    tempFile2.remove();
}

TEST(UtilDataFile, TestValidateJson)
{
    // The json object that is used as schema for other json objects.
    // Copied/modified from file:
    // ./analyzer/ras-data/schema/ras-data-schema-v01.json
    json schema_obj = R"({
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "title": "RAS Data schema for openpower-hw-diags",
    "version": 1,
    "type": "object",
    "additionalProperties": false,
    "required": [ "model_ec" ],
    "properties": {
        "model_ec": {
            "type": "string",
            "pattern": "^[0-9A-Fa-f]{8}$"
        },
        "version": {
            "type": "integer",
            "minimum": 1
        }
    }
})"_json;

    // The json objects
    // Copied/modified from file:
    // ./analyzer/ras-data/data/ras-data-p10-20.json
    json json_obj = R"({
    "model_ec" : "20da0020",
    "version" : 1
})"_json;

    EXPECT_TRUE(util::validateJson(schema_obj, json_obj));

    // Test negative scenario.
    // The key "version_1" does not exist in the schema.
    json json_obj1 = R"({
    "model_ec" : "20da0020",
    "version_1" : 1
})"_json;

    EXPECT_FALSE(util::validateJson(schema_obj, json_obj1));
}