Skip to content

Commit

Permalink
Replaced old unit test for RemoveLogs
Browse files Browse the repository at this point in the history 
Refs #8336
  • Loading branch information
@DanNixon
DanNixon committed Sep 5, 2014
1 parent 573b3f4 commit 6d3f330
Showing 1 changed file with 98 additions and 173 deletions.
271 changes: 98 additions & 173 deletions Code/Mantid/Framework/DataHandling/test/RemoveLogsTest.h
View file
Expand Up @@ -15,223 +15,148 @@
#include "MantidAPI/Algorithm.h"
#include "MantidGeometry/Instrument/Component.h"
#include "MantidKernel/TimeSeriesProperty.h"
#include <vector>
#include "MantidTestHelpers/WorkspaceCreationHelper.h"

#include <vector>

using namespace Mantid::API;
using namespace Mantid::Kernel;
using namespace Mantid::DataHandling;
using namespace Mantid::DataObjects;

class RemoveLogsTest : public CxxTest::TestSuite
{
public:

public:

static RemoveLogsTest *createSuite() { return new RemoveLogsTest(); }
static void destroySuite(RemoveLogsTest *suite) { delete suite; }

RemoveLogsTest()
{
//initialise framework manager to allow logging
//Mantid::API::FrameworkManager::Instance().initialize();
}
void testInit()
{
TS_ASSERT( !remover.isInitialized() );
TS_ASSERT_THROWS_NOTHING(remover.initialize());
TS_ASSERT( remover.isInitialized() );
}

void testExecWithSingleLogFile()
/**
* Creates a sample workspace in ADS.
*/
void setUp()
{
if ( !loader.isInitialized() ) loader.initialize();

// Path to test input file assumes Test directory checked out from SVN
TS_ASSERT_THROWS_NOTHING(loader.setPropertyValue("Filename", "HRP37129_ICPevent.txt") )
inputFile = loader.getPropertyValue("Filename");

outputSpace = "RemoveLogsTest-singleLogFile";
TS_ASSERT_THROWS(loader.setPropertyValue("Workspace", outputSpace), std::invalid_argument)
// Create an empty workspace and put it in the AnalysisDataService
Workspace_sptr ws = WorkspaceFactory::Instance().create("Workspace2D",1,1,1);

TS_ASSERT_THROWS_NOTHING(AnalysisDataService::Instance().add(outputSpace, ws));

std::string result;
TS_ASSERT_THROWS_NOTHING( result = loader.getPropertyValue("Filename") )
TS_ASSERT( ! result.compare(inputFile));

TS_ASSERT_THROWS_NOTHING( result = loader.getPropertyValue("Workspace") )
TS_ASSERT( ! result.compare(outputSpace));

TS_ASSERT_THROWS_NOTHING(loader.execute());
m_sampleWorkspace = "__remove_logs_test_ws";
createSampleWorkspace();
}

/**
* Removes the sample workspace from ADS.
*/
void tearDown()
{
AnalysisDataService::Instance().remove(m_sampleWorkspace);
}

TS_ASSERT( loader.isExecuted() );
/**
* Tests creation and initialisation of the algorithm.
*/
void test_init()
{
TS_ASSERT(!m_remover.isInitialized());
TS_ASSERT_THROWS_NOTHING(m_remover.initialize());
TS_ASSERT(m_remover.isInitialized());
}

// Get back the saved workspace
/**
* Tests removal of all logs from the workspace.
*/
void test_removeAllLogs()
{
// Get the sample workspace from ADS
MatrixWorkspace_sptr output;
TS_ASSERT_THROWS_NOTHING(output = AnalysisDataService::Instance().retrieveWS<MatrixWorkspace>(outputSpace));

if ( !remover.isInitialized() ) remover.initialize();
TS_ASSERT_THROWS_NOTHING(remover.setPropertyValue("Workspace", outputSpace))
TS_ASSERT_THROWS_NOTHING(remover.execute());

TS_ASSERT_THROWS_NOTHING(output = AnalysisDataService::Instance().retrieveWS<MatrixWorkspace>(m_sampleWorkspace));

TS_ASSERT( remover.isExecuted() );
// Make sure it has log data
TS_ASSERT_DIFFERS(output->run().getLogData().size(), 0);

// log should have been removed
TS_ASSERT_THROWS( output->run().getLogData("HRP37129_ICPevent"), std::runtime_error);
// Remove it's logs
TS_ASSERT_THROWS_NOTHING(m_remover.initialize());
TS_ASSERT_THROWS_NOTHING(m_remover.setPropertyValue("Workspace", m_sampleWorkspace));
TS_ASSERT_THROWS_NOTHING(m_remover.execute());
TS_ASSERT(m_remover.isExecuted());

AnalysisDataService::Instance().remove(outputSpace);
// Ensure it's no longer has any log data
TS_ASSERT_EQUALS(output->run().getLogData().size(), 0);
}


void do_test_SNSTextFile(std::string names, std::string units, bool willFail, bool createWorkspace = true)
/**
* Tests keeping certain logs in the workspace.
*/
void test_keepLogs()
{
// Create an empty workspace and put it in the AnalysisDataService

outputSpace = "test_SNSTextFile";
if (createWorkspace)
{
Workspace_sptr ws = WorkspaceFactory::Instance().create("Workspace2D",1,1,1);
TS_ASSERT_THROWS_NOTHING(AnalysisDataService::Instance().addOrReplace(outputSpace, ws));
}

// Set up the algo
LoadLog alg;
alg.initialize();
TS_ASSERT( alg.isInitialized() );
TS_ASSERT_THROWS_NOTHING( alg.setPropertyValue("Filename", "VULCAN_furnace4208.txt") );
TS_ASSERT_THROWS_NOTHING( alg.setPropertyValue("Workspace", outputSpace) );
TS_ASSERT_THROWS_NOTHING( alg.setPropertyValue("Names", names ) );
TS_ASSERT_THROWS_NOTHING( alg.setPropertyValue("Units", units ) );
TS_ASSERT_THROWS_NOTHING(alg.execute() );
if (willFail)
{ TS_ASSERT(!alg.isExecuted() );
return;
}
else
{TS_ASSERT(alg.isExecuted() );}

// Get back the saved workspace
// Get the sample workspace from ADS
MatrixWorkspace_sptr output;
TS_ASSERT_THROWS_NOTHING(output = AnalysisDataService::Instance().retrieveWS<MatrixWorkspace>(outputSpace));
TS_ASSERT_THROWS_NOTHING(output = AnalysisDataService::Instance().retrieveWS<MatrixWorkspace>(m_sampleWorkspace));

if ( !remover.isInitialized() ) remover.initialize();
TS_ASSERT_THROWS_NOTHING(remover.setPropertyValue("Workspace", outputSpace))
TS_ASSERT_THROWS_NOTHING(remover.execute());
// Make sure it has log data
TS_ASSERT_DIFFERS(output->run().getLogData().size(), 0);

// Remove it's logs
TS_ASSERT_THROWS_NOTHING(m_remover.initialize());
TS_ASSERT_THROWS_NOTHING(m_remover.setPropertyValue("Workspace", m_sampleWorkspace));
TS_ASSERT_THROWS_NOTHING(m_remover.setPropertyValue("KeepLogs", "Ei, scan_index"));
TS_ASSERT_THROWS_NOTHING(m_remover.execute());
TS_ASSERT(m_remover.isExecuted());

TS_ASSERT( remover.isExecuted() );
// Ensure it has the correct log data
TS_ASSERT_DIFFERS(output->run().getLogData().size(), 0);

// logs should have been removed
TS_ASSERT_THROWS( output->run().getLogData("Yadda"), std::runtime_error);
TS_ASSERT_THROWS( output->run().getLogData("Temp1"), std::runtime_error);
TS_ASSERT_THROWS( output->run().getLogData("Temp2"), std::runtime_error);
TS_ASSERT_THROWS( output->run().getLogData("Temp3"), std::runtime_error);
TS_ASSERT_THROWS( output->run().getLogData("Extra"), std::runtime_error);
TS_ASSERT_THROWS( output->run().getLogData("some_prop"), std::runtime_error);
TS_ASSERT_THROWS( output->run().getLogData("T0"), std::runtime_error);

TS_ASSERT_THROWS_NOTHING( output->run().getLogData("Ei"));
TS_ASSERT_THROWS_NOTHING( output->run().getLogData("scan_index"));
}

void test_SNSTextFile_noNames_fails()
{
do_test_SNSTextFile("", "", true);
}

void test_SNSTextFile_tooFewNames_fails()
{
do_test_SNSTextFile("Yadda,Yadda", "", true);
}
private:

void test_SNSTextFile_tooManyNames_fails()
/**
* Creates a sample workspace with various types of log entries
*/
void createSampleWorkspace()
{
do_test_SNSTextFile("Yadda,Yadda,Yadda,Yadda,Yadda,Yadda", "", true);
}
// Create the workspace
MatrixWorkspace_sptr ws = WorkspaceCreationHelper::Create2DWorkspace(10, 100);

// Add some log entries to it
std::vector<DateAndTime> times;
std::vector<int> index;
std::vector<double> dbl1, dbl2;
DateAndTime startTime("2010-01-01T00:00:00");
for (int i = 0; i < 100; ++i)
{
times.push_back(startTime + i * 10.0);
index.push_back(i);
dbl1.push_back(i * 0.1);
dbl2.push_back(6.0);
}

void test_SNSTextFile()
{
do_test_SNSTextFile("Temp1,Temp2,Temp3,Extra", "C,K,F,Furlongs", false);
}
auto scan_index = new TimeSeriesProperty<int>("scan_index");
scan_index->addValues(times,index);
ws->mutableRun().addProperty(scan_index);

void test_SNSTextFile_noUnits()
{
do_test_SNSTextFile("Temp1,Temp2,Temp3,Extra", "", false);
}
auto dbl_prop1 = new TimeSeriesProperty<double>("some_prop");
auto dbl_prop2 = new TimeSeriesProperty<double>("some_other_prop");
dbl_prop1->addValues(times,dbl1);
dbl_prop2->addValues(times,dbl2);

void test_SNSTextFile_wrongNumberOfUnits_fails()
{
do_test_SNSTextFile("Temp1,Temp2,Temp3,Extra", "Dynes,Ergs", true);
}
ws->mutableRun().addProperty(dbl_prop1);
ws->mutableRun().addProperty(dbl_prop2);

void test_SNSTextFile_twice_overwrites_logs()
{
do_test_SNSTextFile("Temp1,Temp2,Temp3,Extra", "C,K,F,Furlongs", false, true);
// Dont re-create the workspace the 2nd time around.
// Switch a unit around to make sure the new one got overwritten
do_test_SNSTextFile("Temp1,Temp2,Temp3,Yadda", "C,K,F,Fortnights", false, false);
}
ws->mutableRun().addProperty("Ei", 42.);
ws->mutableRun().addProperty("T0", 42.);

void test_KeepLogs()
{
// Create an empty workspace and put it in the AnalysisDataService
EventWorkspace_sptr ws = WorkspaceCreationHelper::CreateEventWorkspace(1000,1,10000);
outputSpace = "PartiallyRemoveLogs";

// Add a bunch of logs
std::vector<DateAndTime> times;
std::vector<int> index;
std::vector<double> dbl1, dbl2;
DateAndTime startTime("2010-01-01T00:00:00");
for (int i = 0; i < 100; ++i)
{
times.push_back(startTime + i*10.0);
index.push_back(i);
dbl1.push_back(i*0.1);
dbl2.push_back(6.0);
}

auto scan_index = new TimeSeriesProperty<int>("scan_index");
scan_index->addValues(times,index);
ws->mutableRun().addProperty(scan_index);
auto dbl_prop1 = new TimeSeriesProperty<double>("some_prop");
auto dbl_prop2 = new TimeSeriesProperty<double>("some_other_prop");
dbl_prop1->addValues(times,dbl1);
dbl_prop2->addValues(times,dbl2);
ws->mutableRun().addProperty(dbl_prop1);
ws->mutableRun().addProperty(dbl_prop2);
ws->mutableRun().addProperty("Ei", 42.);
ws->mutableRun().addProperty("T0", 42.);
TS_ASSERT_THROWS_NOTHING(AnalysisDataService::Instance().add(outputSpace, ws));


// Get back the saved workspace
MatrixWorkspace_sptr output;
TS_ASSERT_THROWS_NOTHING(output = AnalysisDataService::Instance().retrieveWS<MatrixWorkspace>(outputSpace));

if ( !remover.isInitialized() ) remover.initialize();
TS_ASSERT_THROWS_NOTHING(remover.setPropertyValue("Workspace", outputSpace));
TS_ASSERT_THROWS_NOTHING(remover.setPropertyValue("KeepLogs", "Ei, scan_index"));
TS_ASSERT_THROWS_NOTHING(remover.execute());


TS_ASSERT( remover.isExecuted() );

// log should have been removed
TS_ASSERT_THROWS( output->run().getLogData("some_other_prop"), std::runtime_error);
TS_ASSERT_THROWS( output->run().getLogData("some_prop"), std::runtime_error);
TS_ASSERT_THROWS( output->run().getLogData("T0"), std::runtime_error);
TS_ASSERT_THROWS_NOTHING( output->run().getLogData("Ei"));
TS_ASSERT_THROWS_NOTHING( output->run().getLogData("scan_index"));
AnalysisDataService::Instance().remove(outputSpace);
// Store it in ADS
TS_ASSERT_THROWS_NOTHING(AnalysisDataService::Instance().add(m_sampleWorkspace, ws));
}

private:
LoadLog loader;
RemoveLogs remover;
std::string inputFile;
std::string outputSpace;
std::string inputSpace;
RemoveLogs m_remover;
std::string m_sampleWorkspace;

};

Expand Down

0 comments on commit 6d3f330

Please sign in to comment.