1161e1098c
With this commit the generation of built in keywords is completely
changed. The most important changes include:
1) We have autogenerated a class for each keyword in the new
ParserKeywords { ... } namespace.
2) The autogenerated classes derive from ParserKeyword, and the
default constructor will build of a fully initialized
ParserKeyword instance, i.e. the keyword used to parse the EQUIL
keyword can be instantiated as simple as:
ParserKeywords::EQUIL kw;
3) The generated keywords have built in static constants for keyword
and item names, and item default values. That way it should be
possible for the compiler to catch trivial errors like trying to
access the keyword "PoRO"; also the the access to default values
means that properties can be initialized without actually
insantiating a DeckKeyword.
4) Two new classes Generator/KeywordLoader and
Generator/KeywordGenerator have been created, with the help of
these classes the keyword generation code is significantly
simplified.
323 lines
12 KiB
C++
323 lines
12 KiB
C++
/*
|
|
Copyright 2013 Statoil ASA.
|
|
|
|
This file is part of the Open Porous Media project (OPM).
|
|
|
|
OPM 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.
|
|
|
|
OPM 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 for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with OPM. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#include <stdexcept>
|
|
#include <iostream>
|
|
#include <boost/filesystem.hpp>
|
|
#define BOOST_TEST_MODULE ParserTests
|
|
#include <boost/test/unit_test.hpp>
|
|
|
|
#include <opm/json/JsonObject.hpp>
|
|
|
|
#include <opm/parser/eclipse/Parser/Parser.hpp>
|
|
#include <opm/parser/eclipse/Parser/ParserKeyword.hpp>
|
|
|
|
#include <opm/parser/eclipse/Parser/ParserIntItem.hpp>
|
|
#include <opm/parser/eclipse/Parser/ParserStringItem.hpp>
|
|
|
|
|
|
using namespace Opm;
|
|
|
|
std::shared_ptr<ParserKeyword> createDynamicSized(const std::string& kw) {
|
|
std::shared_ptr<ParserKeyword> pkw = std::make_shared<ParserKeyword>(kw);
|
|
pkw->setSizeType(SLASH_TERMINATED);
|
|
return pkw;
|
|
}
|
|
|
|
|
|
/************************Basic structural tests**********************'*/
|
|
|
|
BOOST_AUTO_TEST_CASE(Initializing) {
|
|
BOOST_CHECK_NO_THROW(Parser parser);
|
|
BOOST_CHECK_NO_THROW(Parser parser);
|
|
BOOST_CHECK_NO_THROW(ParserPtr parserPtr(new Parser()));
|
|
BOOST_CHECK_NO_THROW(ParserConstPtr parserConstPtr(new Parser()));
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(addKeyword_keyword_doesntfail) {
|
|
Parser parser;
|
|
{
|
|
ParserKeywordPtr equilKeyword = createDynamicSized("EQUIL");
|
|
parser.addParserKeyword(equilKeyword);
|
|
}
|
|
}
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(canParseDeckKeyword_returnstrue) {
|
|
ParserPtr parser(new Parser());
|
|
parser->addParserKeyword(createDynamicSized("FJAS"));
|
|
BOOST_CHECK(parser->isRecognizedKeyword("FJAS"));
|
|
}
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(getKeyword_haskeyword_returnskeyword) {
|
|
ParserPtr parser(new Parser());
|
|
ParserKeywordConstPtr parserKeyword = createDynamicSized("FJAS");
|
|
parser->addParserKeyword(parserKeyword);
|
|
BOOST_CHECK_EQUAL(parserKeyword, parser->getParserKeywordFromDeckName("FJAS"));
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(getKeyword_hasnotkeyword_getKeywordThrowsException) {
|
|
ParserPtr parser(new Parser());
|
|
ParserKeywordConstPtr parserKeyword = createDynamicSized("FJAS");
|
|
parser->addParserKeyword(parserKeyword);
|
|
BOOST_CHECK_THROW(parser->getParserKeywordFromDeckName("FJASS"), std::invalid_argument);
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(getAllDeckNames_hasTwoKeywords_returnsCompleteList) {
|
|
ParserPtr parser(new Parser(false));
|
|
std::cout << parser->getAllDeckNames().size() << std::endl;
|
|
ParserKeywordConstPtr firstParserKeyword = createDynamicSized("FJAS");
|
|
parser->addParserKeyword(firstParserKeyword);
|
|
ParserKeywordConstPtr secondParserKeyword = createDynamicSized("SAJF");
|
|
parser->addParserKeyword(secondParserKeyword);
|
|
BOOST_CHECK_EQUAL(2U, parser->getAllDeckNames().size());
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(getAllDeckNames_hasNoKeywords_returnsEmptyList) {
|
|
ParserPtr parser(new Parser(false));
|
|
BOOST_CHECK_EQUAL(0U, parser->getAllDeckNames().size());
|
|
}
|
|
|
|
|
|
|
|
/************************ JSON config related tests **********************'*/
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(addParserKeywordJSON_isRecognizedKeyword_returnstrue) {
|
|
ParserPtr parser(new Parser());
|
|
Json::JsonObject jsonConfig("{\"name\": \"BPR\", \"sections\":[\"SUMMARY\"], \"size\" : 100 , \"items\" :[{\"name\":\"ItemX\" , \"size_type\":\"SINGLE\" , \"value_type\" : \"DOUBLE\"}]}");
|
|
parser->addParserKeyword(std::make_shared<const ParserKeyword>( jsonConfig ));
|
|
BOOST_CHECK(parser->isRecognizedKeyword("BPR"));
|
|
}
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(addParserKeywordJSON_size_isObject_allGood) {
|
|
ParserPtr parser(new Parser());
|
|
Json::JsonObject jsonConfig("{\"name\": \"EQUIXL\", \"sections\":[], \"size\" : {\"keyword\":\"EQLDIMS\" , \"item\" : \"NTEQUL\"}, \"items\" :[{\"name\":\"ItemX\" , \"size_type\":\"SINGLE\" , \"value_type\" : \"DOUBLE\"}]}");
|
|
parser->addParserKeyword(std::make_shared<const ParserKeyword>( jsonConfig ));
|
|
BOOST_CHECK(parser->isRecognizedKeyword("EQUIXL"));
|
|
}
|
|
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(loadKeywordsJSON_notArray_throw) {
|
|
ParserPtr parser(new Parser());
|
|
Json::JsonObject jsonConfig( "{\"name\" : \"BPR\" , \"size\" : 100, \"sections\":[\"SUMMARY\"]}");
|
|
|
|
BOOST_CHECK_THROW(parser->loadKeywords( jsonConfig ) , std::invalid_argument);
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(loadKeywordsJSON_noSectionsItem_throw) {
|
|
ParserPtr parser(new Parser());
|
|
Json::JsonObject jsonConfig( "[{\"name\" : \"BPR\" , \"size\" : 100, \"items\" :[{\"name\":\"ItemX\" , \"size_type\":\"SINGLE\" , \"value_type\" : \"DOUBLE\"}]}]");
|
|
|
|
BOOST_CHECK_THROW(parser->loadKeywords( jsonConfig ) , std::invalid_argument);
|
|
}
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(loadKeywordsJSON_isRecognizedKeyword_returnstrue) {
|
|
ParserPtr parser(new Parser());
|
|
Json::JsonObject jsonConfig( "[{\"name\" : \"BPR\" , \"size\" : 100, \"sections\":[\"SUMMARY\"], \"items\" :[{\"name\":\"ItemX\" , \"size_type\":\"SINGLE\" , \"value_type\" : \"DOUBLE\"}]}]");
|
|
|
|
parser->loadKeywords( jsonConfig );
|
|
BOOST_CHECK(parser->isRecognizedKeyword("BPR"));
|
|
}
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(empty_sizeReturns0) {
|
|
ParserPtr parser(new Parser( false ));
|
|
BOOST_CHECK_EQUAL( 0U , parser->size());
|
|
}
|
|
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(loadKeywordsJSON_manyKeywords_returnstrue) {
|
|
ParserPtr parser(new Parser( false ));
|
|
Json::JsonObject jsonConfig( "[{\"name\" : \"BPR\" , \"size\" : 100, \"sections\":[\"SUMMARY\"] , \"items\" :[{\"name\":\"ItemX\" , \"size_type\":\"SINGLE\" , \"value_type\" : \"DOUBLE\"}]}, {\"name\" : \"WWCT\", \"sections\":[\"SUMMARY\"], \"size\" : 0} , {\"name\" : \"EQUIL\", \"sections\":[\"PROPS\"], \"size\" : 0}]");
|
|
|
|
parser->loadKeywords( jsonConfig );
|
|
BOOST_CHECK(parser->isRecognizedKeyword("BPR"));
|
|
BOOST_CHECK(parser->isRecognizedKeyword("WWCT"));
|
|
BOOST_CHECK(parser->isRecognizedKeyword("EQUIL"));
|
|
BOOST_CHECK_EQUAL( 3U , parser->size() );
|
|
}
|
|
|
|
|
|
|
|
|
|
/*****************************************************************/
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(loadKeywordFromFile_fileDoesNotExist_returnsFalse) {
|
|
ParserPtr parser(new Parser());
|
|
boost::filesystem::path configFile("File/does/not/exist");
|
|
BOOST_CHECK_EQUAL( false , parser->loadKeywordFromFile( configFile ));
|
|
}
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(loadKeywordFromFile_invalidJson_returnsFalse) {
|
|
ParserPtr parser(new Parser());
|
|
boost::filesystem::path configFile("testdata/json/example_invalid_json");
|
|
BOOST_CHECK_EQUAL( false , parser->loadKeywordFromFile( configFile ));
|
|
}
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(loadKeywordFromFile_invalidConfig_returnsFalse) {
|
|
ParserPtr parser(new Parser());
|
|
boost::filesystem::path configFile("testdata/json/example_missing_name.json");
|
|
BOOST_CHECK_EQUAL( false , parser->loadKeywordFromFile( configFile ));
|
|
}
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(loadKeywordFromFile_validKeyword_returnsTrueHasKeyword) {
|
|
ParserPtr parser(new Parser( false ));
|
|
boost::filesystem::path configFile("testdata/json/BPR");
|
|
BOOST_CHECK_EQUAL( true , parser->loadKeywordFromFile( configFile ));
|
|
BOOST_CHECK_EQUAL( 1U , parser->size() );
|
|
BOOST_CHECK_EQUAL( true , parser->isRecognizedKeyword("BPR") );
|
|
}
|
|
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(loadConfigFromDirectory_directoryDoesNotexist_throws) {
|
|
ParserPtr parser(new Parser(false));
|
|
boost::filesystem::path configPath("path/does/not/exist");
|
|
BOOST_CHECK_THROW(parser->loadKeywordsFromDirectory( configPath), std::invalid_argument);
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(loadConfigFromDirectory_notRecursive_allNames) {
|
|
ParserPtr parser(new Parser(false));
|
|
BOOST_CHECK_EQUAL(false , parser->isRecognizedKeyword("BPR"));
|
|
boost::filesystem::path configPath("testdata/config/directory1");
|
|
BOOST_CHECK_NO_THROW(parser->loadKeywordsFromDirectory( configPath, false));
|
|
BOOST_CHECK(parser->isRecognizedKeyword("WWCT"));
|
|
BOOST_CHECK_EQUAL(true , parser->isRecognizedKeyword("BPR"));
|
|
BOOST_CHECK_EQUAL(false , parser->isRecognizedKeyword("DIMENS"));
|
|
}
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(loadConfigFromDirectory_notRecursive_strictNames) {
|
|
ParserPtr parser(new Parser(false));
|
|
boost::filesystem::path configPath("testdata/config/directory1");
|
|
BOOST_CHECK_NO_THROW(parser->loadKeywordsFromDirectory( configPath, false));
|
|
BOOST_CHECK(parser->isRecognizedKeyword("WWCT"));
|
|
// the file name for the following keyword is "Bpr", but that
|
|
// does not matter
|
|
BOOST_CHECK_EQUAL(true , parser->isRecognizedKeyword("BPR"));
|
|
BOOST_CHECK_EQUAL(false , parser->isRecognizedKeyword("DIMENS"));
|
|
}
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(loadConfigFromDirectory_Recursive_allNames) {
|
|
ParserPtr parser(new Parser(false));
|
|
BOOST_CHECK_EQUAL(false , parser->isRecognizedKeyword("BPR"));
|
|
boost::filesystem::path configPath("testdata/config/directory1");
|
|
BOOST_CHECK_NO_THROW(parser->loadKeywordsFromDirectory( configPath, true));
|
|
BOOST_CHECK(parser->isRecognizedKeyword("WWCT"));
|
|
BOOST_CHECK_EQUAL(true , parser->isRecognizedKeyword("BPR"));
|
|
BOOST_CHECK_EQUAL(true , parser->isRecognizedKeyword("DIMENS"));
|
|
}
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(loadConfigFromDirectory_default) {
|
|
ParserPtr parser(new Parser(false));
|
|
BOOST_CHECK_EQUAL(false , parser->isRecognizedKeyword("BPR"));
|
|
boost::filesystem::path configPath("testdata/config/directory1");
|
|
BOOST_CHECK_NO_THROW(parser->loadKeywordsFromDirectory( configPath ));
|
|
BOOST_CHECK(parser->isRecognizedKeyword("WWCT"));
|
|
// the file name for the following keyword is "Bpr", but that
|
|
// does not matter
|
|
BOOST_CHECK_EQUAL(true , parser->isRecognizedKeyword("BPR"));
|
|
BOOST_CHECK_EQUAL(true , parser->isRecognizedKeyword("DIMENS"));
|
|
}
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(DropKeyword) {
|
|
ParserPtr parser(new Parser());
|
|
BOOST_CHECK_EQUAL(false , parser->dropParserKeyword("DoesNotHaveThis"));
|
|
BOOST_CHECK_EQUAL(true , parser->isRecognizedKeyword("BPR"));
|
|
BOOST_CHECK_EQUAL(true , parser->dropParserKeyword("BLOCK_PROBE"));
|
|
BOOST_CHECK_EQUAL(false , parser->dropParserKeyword("BLOCK_PROBE"));
|
|
BOOST_CHECK_EQUAL(false , parser->isRecognizedKeyword("BPR"));
|
|
|
|
BOOST_CHECK_EQUAL(true , parser->isRecognizedKeyword("TVDPX"));
|
|
BOOST_CHECK_EQUAL(true , parser->dropParserKeyword("TVDP"));
|
|
BOOST_CHECK_EQUAL(false , parser->isRecognizedKeyword("TVDPX"));
|
|
}
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(ReplaceKeyword) {
|
|
ParserPtr parser(new Parser());
|
|
ParserKeywordConstPtr eqldims = parser->getParserKeywordFromDeckName("EQLDIMS");
|
|
|
|
BOOST_CHECK_EQUAL( 5U , eqldims->numItems());
|
|
BOOST_CHECK( parser->loadKeywordFromFile( "testdata/parser/EQLDIMS2" ) );
|
|
|
|
|
|
eqldims = parser->getParserKeywordFromDeckName("EQLDIMS");
|
|
BOOST_CHECK_EQUAL( 1U , eqldims->numItems());
|
|
}
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(WildCardTest) {
|
|
ParserPtr parser(new Parser());
|
|
BOOST_CHECK(!parser->isRecognizedKeyword("TVDP*"));
|
|
BOOST_CHECK(!parser->isRecognizedKeyword("TVDP"));
|
|
BOOST_CHECK(parser->isRecognizedKeyword("TVDPXXX"));
|
|
BOOST_CHECK(!parser->isRecognizedKeyword("TVDPIAMTOOLONG"));
|
|
BOOST_CHECK(!parser->isRecognizedKeyword("TVD"));
|
|
|
|
BOOST_CHECK(!parser->isRecognizedKeyword("TVDP"));
|
|
|
|
ParserKeywordConstPtr keyword1 = parser->getParserKeywordFromDeckName("TVDPA");
|
|
ParserKeywordConstPtr keyword2 = parser->getParserKeywordFromDeckName("TVDPBC");
|
|
ParserKeywordConstPtr keyword3 = parser->getParserKeywordFromDeckName("TVDPXXX");
|
|
|
|
BOOST_CHECK_EQUAL( keyword1 , keyword2 );
|
|
BOOST_CHECK_EQUAL( keyword1 , keyword3 );
|
|
}
|
|
|
|
|
|
|
|
/***************** Simple Int parsing ********************************/
|
|
|
|
static ParserKeywordPtr __attribute__((unused)) setupParserKeywordInt(std::string name, int numberOfItems) {
|
|
ParserKeywordPtr parserKeyword = createDynamicSized(name);
|
|
ParserRecordPtr parserRecord = parserKeyword->getRecord(0);
|
|
|
|
for (int i = 0; i < numberOfItems; i++) {
|
|
std::string another_name = "ITEM_" + boost::lexical_cast<std::string>(i);
|
|
ParserItemPtr intItem(new ParserIntItem(another_name, SINGLE));
|
|
parserRecord->addItem(intItem);
|
|
}
|
|
|
|
return parserKeyword;
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|