ResInsight/ApplicationCode/UnitTests/RifFaciesPropertiesReader-Test.cpp

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2019-  Equinor ASA
//
//  ResInsight is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
//
//  ResInsight 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 General Public License at <http://www.gnu.org/licenses/gpl.html>
//  for more details.
//
/////////////////////////////////////////////////////////////////////////////////

#include "gtest/gtest.h"

#include "RifFaciesPropertiesReader.h"
#include "RifFileParseTools.h"

#include <QStringList>
#include <QTemporaryFile>
#include <QTextStream>

#include <vector>

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
TEST( RifFaciesPropertiesReaderTest, ReadCorrectInputFile )
{
    QTemporaryFile file;
    EXPECT_TRUE( file.open() );

    {
        QTextStream out( &file );
        out << "Norne,Not,Sand,0.00,25,0.25,2000,0.2\n"
            << "Norne,Not,Sand,0.10,19,0.27,2099,0.3\n";
    }

    QStringList filePaths;
    filePaths.append( file.fileName() );

    std::vector<RifFaciesProperties> faciesProperties;
    RifFaciesPropertiesReader::readFaciesProperties( faciesProperties, filePaths );

    ASSERT_EQ( 2u, faciesProperties.size() );

    ASSERT_EQ( "Norne", faciesProperties[0].fieldName.toStdString() );
    ASSERT_EQ( "Norne", faciesProperties[1].fieldName.toStdString() );

    ASSERT_EQ( "Not", faciesProperties[0].formationName.toStdString() );
    ASSERT_EQ( "Not", faciesProperties[1].formationName.toStdString() );

    ASSERT_EQ( "Sand", faciesProperties[0].faciesName.toStdString() );
    ASSERT_EQ( "Sand", faciesProperties[1].faciesName.toStdString() );

    ASSERT_DOUBLE_EQ( 0.0, faciesProperties[0].porosity );
    ASSERT_DOUBLE_EQ( 0.1, faciesProperties[1].porosity );

    ASSERT_DOUBLE_EQ( 25.0, faciesProperties[0].youngsModulus );
    ASSERT_DOUBLE_EQ( 19.0, faciesProperties[1].youngsModulus );

    ASSERT_DOUBLE_EQ( 0.25, faciesProperties[0].poissonsRatio );
    ASSERT_DOUBLE_EQ( 0.27, faciesProperties[1].poissonsRatio );

    ASSERT_DOUBLE_EQ( 2000.0, faciesProperties[0].K_Ic );
    ASSERT_DOUBLE_EQ( 2099.0, faciesProperties[1].K_Ic );

    ASSERT_DOUBLE_EQ( 0.2, faciesProperties[0].proppantEmbedment );
    ASSERT_DOUBLE_EQ( 0.3, faciesProperties[1].proppantEmbedment );
}

//--------------------------------------------------------------------------------------------------
/// Helper to check exception messages when reading invalid files
//--------------------------------------------------------------------------------------------------
::testing::AssertionResult readingFaciesPropertiesThrowsException( const QStringList& filePaths,
                                                                   const QString&     expectedMessage )
{
    std::vector<RifFaciesProperties> faciesProperties;
    try
    {
        RifFaciesPropertiesReader::readFaciesProperties( faciesProperties, filePaths );
        // No exception thrown: fail!
        return ::testing::AssertionFailure() << "readFaciesProperties did not throw exception";
    }
    catch ( FileParseException& error )
    {
        // Should always have cleaned up on failure
        EXPECT_EQ( 0u, faciesProperties.size() );
        // Check that we get the expected message
        EXPECT_EQ( expectedMessage.toStdString(), error.message.toStdString() );
        return ::testing::AssertionSuccess();
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
TEST( RifFaciesPropertiesReaderTest, ReadMissingFileThrows )
{
    QStringList filePaths;
    QString     nonExistingFile( "this/is/a/file/which/does/not/exist.csv" );
    filePaths.append( nonExistingFile );
    ASSERT_TRUE( readingFaciesPropertiesThrowsException( filePaths,
                                                         QString( "Unable to open file: %1" ).arg( nonExistingFile ) ) );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
TEST( RifFaciesPropertiesReaderTest, ReadShortLinesFileThrows )
{
    QTemporaryFile file;
    EXPECT_TRUE( file.open() );

    {
        QTextStream out( &file );
        out << "Norne,Not,Sand,0.00,25,0.25,2000,0.2\n"
            << "Norne,Not,Sand,0.10,19,0.27\n";
    }

    QStringList filePaths;
    filePaths.append( file.fileName() );
    ASSERT_TRUE(
        readingFaciesPropertiesThrowsException( filePaths,
                                                QString( "Incomplete data on line 2: %1" ).arg( file.fileName() ) ) );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
TEST( RifFaciesPropertiesReaderTest, ReadEmptyFieldNameThrows )
{
    QTemporaryFile file;
    EXPECT_TRUE( file.open() );

    {
        QTextStream out( &file );
        out << "Norne,Not,Sand,0.00,25,0.25,2000,0.2\n"
            << ",Not,Sand,0.10,19,0.27,2099,0.3\n";
    }

    QStringList filePaths;
    filePaths.append( file.fileName() );
    ASSERT_TRUE( readingFaciesPropertiesThrowsException( filePaths,
                                                         QString( "Unexpected empty 'Field Name' on line 2: %1" )
                                                             .arg( file.fileName() ) ) );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
TEST( RifFaciesPropertiesReaderTest, ReadInvalidMeasureDepthThrows )
{
    QTemporaryFile file;
    EXPECT_TRUE( file.open() );

    {
        QTextStream out( &file );
        out << "Norne,Not,Sand,0.00,25,0.25,2000,0.2\n"
            << "Norne,Not,Sand, not a number,23.4,0.27,2099,0.3\n";
    }

    QStringList filePaths;
    filePaths.append( file.fileName() );
    ASSERT_TRUE( readingFaciesPropertiesThrowsException( filePaths,
                                                         QString( "Invalid number for 'Porosity' on line 2: %1" )
                                                             .arg( file.fileName() ) ) );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
TEST( RifFaciesPropertiesReaderTest, CommentsAndEmptyLinesAreIgnored )
{
    QTemporaryFile file;
    EXPECT_TRUE( file.open() );

    {
        QTextStream out( &file );
        // Comment should be ignored
        out << "# This is a comment.\n";
        out << "#This is also a comment.\n";
        out << " # This is also a comment which does not start on first character.\n";
        // Should skip empty lines
        out << "\n";
        out << "\t\n";
        out << "        \n";
        // Then some data
        out << "Norne,Not,Sand,0.00,25,0.25,2000,0.2\n";
        // Comment in-between data should be ignored
        out << "# One more comment in-between the data\n";
        out << "Norne,Not,Silt,0.00,25,0.25,2000,0.2\n";
        // Empty line in-between data should be ignored
        out << "\n";
        // Data with comment sign inside it is not ignored
        out << "Norne,Not,Shale,0.00,25,0.25,2000,0.2\n";
        // Trailing empty lines should be ignored
        out << "\n\n\n";
    }

    QStringList filePaths;
    filePaths.append( file.fileName() );
    std::vector<RifFaciesProperties> faciesProperties;
    RifFaciesPropertiesReader::readFaciesProperties( faciesProperties, filePaths );

    ASSERT_EQ( 3u, faciesProperties.size() );

    ASSERT_EQ( "Sand", faciesProperties[0].faciesName.toStdString() );
    ASSERT_EQ( "Silt", faciesProperties[1].faciesName.toStdString() );
    ASSERT_EQ( "Shale", faciesProperties[2].faciesName.toStdString() );
}