ossimBatchTest Class Reference

#include <ossimBatchTest.h>

Inheritance diagram for ossimBatchTest:

Public Types
enum	TEST_STATUS {   TEST_TBD = 0x00, TEST_PASSED = 0x01, TEST_FAILED = 0x02, TEST_ERROR = 0x04,   TEST_DISABLED = 0x08 }

Public Member Functions
	ossimBatchTest ()
	This constructor only initializes data members to null/defaults. More...
bool	initialize (ossimArgumentParser &ap)
	Initializes the test session given the command line. More...
ossim_uint8	execute ()
	Performs the actual test with the config filename previously set in initialize() or processConfigList() when config is a list of subordinate test config files. More...
Public Member Functions inherited from ossimReferenced
	ossimReferenced ()
	ossimReferenced (const ossimReferenced &)
ossimReferenced &	operator= (const ossimReferenced &)
void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
int	referenceCount () const

Private Member Functions
void	writeTemplate (const ossimFilename &templateFile, bool long_form)
	Writes template test config file, either exhaustive long form for flexibility, or simple short-form for easier test creation. More...
void	getDateString (ossimString &date)
	Fetches string from OS for naming and tagging the log file. More...
void	getLogFilename (ossimFilename &logFile)
	Establishes name of output log file. More...
ossim_uint8	processConfigList (const ossimKeywordlist &kwl)
	When the config file consists of a list of subordinate test config files, this method manages processing multiple configs. More...
ossim_uint8	processTest (const ossimString &prefix, const ossimKeywordlist &kwl)
	Within a single config file can be multiple tests, distinguished by the "test*." prefix. More...
ossim_uint8	processCommands (const ossimString &prefix, const ossimKeywordlist &kwl, const ossimString &testName, bool logTime, const ossimFilename &tempFile=ossimFilename(""))
	Runs a single command within a test. More...
void	preprocessKwl (const std::vector< std::string > &testList, const std::string &testCommand, ossimKeywordlist &kwl)
	Modifies the config's KWL to explicitly declare implied keywords. More...
bool	makeDefaultResultsDir ()
	Default preprocessing step makes expected and output results directories. More...
bool	doDefaultClean ()
	Default clean step deletes all files in out and exp dirs. More...
bool	getTempFileName (const ossimString &prefix, const ossimKeywordlist &kwl, ossimFilename &tempFile) const
	Gets the temp file name. More...
bool	getDefaultTempFileDir (ossimFilename &tempDir) const
	Gets the default temp directory /data1/test/results/linux/tmp. More...
void	usage (ossimArgumentParser &ap)
	Initializes arg parser and outputs usage. More...
std::string	convertToNative (const char *lookup) const
	Converts string slashes to either forward or backward taking into account that windows commands with forward slashes in them. More...

Private Attributes
std::vector< std::string >	m_acceptTestList
std::vector< std::string >	m_cleanTestList
std::vector< std::string >	m_preprocessTestList
std::vector< std::string >	m_runTestList
std::map< ossim_uint32, std::string >	m_statusLabels
bool	m_templateModeActive
ossimFilename	m_configFileName
ossimFilename	m_outDir
ossimFilename	m_expDir
std::ofstream	m_logStr

Additional Inherited Members
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Detailed Description

Definition at line 34 of file ossimBatchTest.h.

Member Enumeration Documentation

TEST_STATUS

enum ossimBatchTest::TEST_STATUS

Enumerator
TEST_TBD
TEST_PASSED
TEST_FAILED
TEST_ERROR
TEST_DISABLED

Definition at line 37 of file ossimBatchTest.h.

   {
      TEST_TBD      = 0x00, // initial state: no test yet attempted
      TEST_PASSED   = 0x01,
      TEST_FAILED   = 0x02,
      TEST_ERROR    = 0x04,
      TEST_DISABLED = 0x08
   };

Constructor & Destructor Documentation

ossimBatchTest()

ossimBatchTest::ossimBatchTest

(

)

This constructor only initializes data members to null/defaults.

Definition at line 37 of file ossimBatchTest.cpp.

References m_statusLabels, TEST_DISABLED, TEST_ERROR, TEST_FAILED, TEST_PASSED, and TEST_TBD.

   :
   m_acceptTestList(),
   m_cleanTestList(),
   m_preprocessTestList(),
   m_runTestList(),
   m_templateModeActive(false),
   m_configFileName(),
   m_outDir(),
   m_expDir(),
   m_logStr()
{
   typedef std::map<ossim_uint32, std::string>::value_type map_item;
   m_statusLabels.insert(map_item(TEST_TBD,      "UNKNOWN"));
   m_statusLabels.insert(map_item(TEST_PASSED,   "PASSED"));
   m_statusLabels.insert(map_item(TEST_FAILED,   "FAILED"));
   m_statusLabels.insert(map_item(TEST_ERROR,    "ERROR"));
   m_statusLabels.insert(map_item(TEST_DISABLED, "DISABLED"));
   m_statusLabels.insert(map_item(TEST_PASSED|TEST_FAILED,   "FAILURE ENCOUNTERED"));
   m_statusLabels.insert(map_item(TEST_PASSED|TEST_ERROR,   "ERROR ENCOUNTERED"));
   m_statusLabels.insert(map_item(TEST_FAILED|TEST_ERROR,   "FAILURE AND ERROR ENCOUNTERED"));
   m_statusLabels.insert(map_item(TEST_PASSED|TEST_FAILED|TEST_ERROR,   "FAILURE AND ERROR ENCOUNTERED"));
}

Member Function Documentation

convertToNative()

std::string ossimBatchTest::convertToNative ( const char *  lookup ) const

private

Converts string slashes to either forward or backward taking into account that windows commands with forward slashes in them.

Parameters

s	String to convert.

Definition at line 1209 of file ossimBatchTest.cpp.

Referenced by execute(), and processCommands().

{
   std::string s;
   
   if ( lookup )
   {
      s = lookup;
      const std::string::size_type SIZE = s.size();
      std::string::size_type i = 0;
      
#if defined(_WIN32)
      //---
      // Must not convert slashes for: "del /Q", "fc /W", and "copy /Y"
      //---
      while( i < SIZE )
      {
         if( s[i] == '/' )
         {
            bool replace = true;
            if ( (i+2) < SIZE ) // Could fit a window command and space like: "/Y "
            {
               if ( (s[i+1] == 'Q') || (s[i+1] == 'W') || (s[i+1] == 'Y') )
               {
                  if ( s[i+2] == ' ' ) // Check for space after "/Q".
                  {
                     replace = false;
                  }
               }
            }
            if ( replace )
            {
               s[i] = '\\';
            }
         }
         ++i;
      }
#else
      while( i < SIZE )
      {
         if( s[i] == '\\' )
         {
            s[i] = '/';
         }
         ++i;
      }
#endif
      
   } // Matches: if ( lookup )
   
   return s;
}

doDefaultClean()

bool ossimBatchTest::doDefaultClean ( )

private

Default clean step deletes all files in out and exp dirs.

Default clean step deletes all files in out and exp dirs. Returns TRUE if successful.

Returns

TRUE if successful.

Definition at line 1091 of file ossimBatchTest.cpp.

References ossimFilename::exists(), getDefaultTempFileDir(), ossimEnvironmentUtility::getEnvironmentVariable(), ossimEnvironmentUtility::instance(), m_logStr, and m_outDir.

Referenced by processCommands().

{
   bool result = true;

   ossimString del_cmd = ossimEnvironmentUtility::instance()->getEnvironmentVariable(
      ossimString("RMDIR_CMD") );
   ossimString command_line;
   
   if ( m_outDir.exists() )
   {
      command_line = del_cmd + " " + m_outDir;
      m_logStr << "executing command: " << command_line << "\n";
      if (system(command_line) != 0)
      {
         m_logStr << "ERROR: execution failed!\n";
         cerr << "ERROR: Could not delete <"<<m_outDir<<">. Clean operation failed."<< endl;
         result = false;
      }
   }
   
   ossimFilename tmpDir;
   if ( getDefaultTempFileDir( tmpDir ) )
   {
      if ( tmpDir.exists() )
      {
         command_line = del_cmd + " " + tmpDir;
         m_logStr << "executing command: " << command_line << "\n";
         if (system(command_line) != 0)
         {
            m_logStr << "ERROR: execution failed!\n";
            cerr << "ERROR: Could not delete <"<<m_outDir<<">. Clean operation failed."<< endl;
            result = false;
         }
      }
   }
   
   return result;
}

execute()

ossim_uint8 ossimBatchTest::execute

(

)

Performs the actual test with the config filename previously set in initialize() or processConfigList() when config is a list of subordinate test config files.

Returns

The overall bit-wise status of all tests (see TEST_STATUS enum for bit definitions).

Definition at line 418 of file ossimBatchTest.cpp.

References ossimKeywordlist::addFile(), ossimString::c_str(), ossimString::chars(), convertToNative(), ossimFilename::createDirectory(), ossimFilename::dirCat(), ossimString::empty(), ossimFilename::exists(), ossimFilename::fileNoExtension(), ossimKeywordlist::find(), ossimEnvironmentUtility::getCurrentWorkingDir(), getDateString(), ossimEnvironmentUtility::getEnvironmentVariable(), getLogFilename(), ossimKeywordlist::getSubstringKeyList(), ossimEnvironmentUtility::instance(), ossimTimer::instance(), m_acceptTestList, m_cleanTestList, m_configFileName, m_expDir, m_logStr, m_outDir, m_preprocessTestList, m_runTestList, m_statusLabels, m_templateModeActive, ossimSetLogFilename(), preprocessKwl(), processConfigList(), processTest(), ossimEnvironmentUtility::setEnvironmentVariable(), ossimKeywordlist::setExpandEnvVarsFlag(), ossimTimer::setStartTick(), status, TEST_ERROR, TEST_PASSED, TEST_TBD, ossimTimer::time_s(), and ossimException::what().

Referenced by processConfigList().

{
   if (m_templateModeActive)
   {
      return TEST_PASSED;
   }

   ossim_uint8 status = TEST_TBD;

   ossimString configName (m_configFileName.fileNoExtension());
   cout << "\nExecuting batch test for config: <" << configName << ">" << endl;

   try
   {
      ossimEnvironmentUtility* ossimEnv = ossimEnvironmentUtility::instance();

      // Fetch possible existing env vars for the expected and output directories:
      ossimFilename base_output_dir =
            ossimEnv->getEnvironmentVariable(ossimString("OSSIM_BATCH_TEST_RESULTS"));
      if (base_output_dir.empty())
      {
         // Need to establish the top-level test directory that will contain log and out subdirs:
         cout<<"\nossimBatchTest WARNING: The environment variable OSSIM_BATCH_TEST_RESULTS is not "
               "defined. Results will be written relative to the current working directory."<<endl;
         base_output_dir = ossimEnv->getCurrentWorkingDir();
      }

      // The base output directory is appended with the name of the test config file. Need to export
      // the corresponding env var so that the KeywordList class can expand the same env var used
      // in the config file:
      base_output_dir = base_output_dir.dirCat(configName);
      m_outDir = base_output_dir.dirCat("out");
      ossimEnv->setEnvironmentVariable("OBT_OUT_DIR", m_outDir.chars());

      m_expDir = ossimEnv->getEnvironmentVariable(ossimString("OSSIM_BATCH_TEST_EXPECTED"));
      if (m_expDir.empty())
      {
         // Need to establish the top-level test directory that will contain expected results:
         m_expDir = base_output_dir.dirCat("exp");
      }
      else
      {
         m_expDir = m_expDir.dirCat(configName);
      }
      ossimEnv->setEnvironmentVariable("OBT_EXP_DIR", m_expDir.chars());

      // Turn expansion of for like: $(OBT_TEST_RESULTS)
      ossimKeywordlist kwl;
      kwl.setExpandEnvVarsFlag(true);
      if (!kwl.addFile(m_configFileName))
      {
         ostringstream errmsg;
         errmsg << "Error encountered reading test config at <"<<m_configFileName<<">."<<endl;
         throw ossimException(errmsg.str());
      }

      // The KWL may contain names of other test config files. Is this a list of config files? If the
      // status returns anything other than TBD, then a list was present and processed:
      status = processConfigList(kwl);
      if (status != TEST_TBD)
      {
         cout<<"\nossimBatchTest: Exiting <"<<configName<<"> with overall status = "
               <<m_statusLabels[status]<<"\n"<<endl;
         return status;
      }

      // Pick up individual test options passed in by user.  These will adjust the keyword list
      // flags loaded in memory.
      if ( m_cleanTestList.size() ) // Do this first always...
      {
         std::string testCommand = "run_clean_commands";
         preprocessKwl(m_cleanTestList, testCommand, kwl);
      }

      if ( m_preprocessTestList.size() )
      {
         std::string testCommand = "run_preprocessing_commands";
         preprocessKwl(m_preprocessTestList, testCommand, kwl);
      }

      if ( m_acceptTestList.size() )
      {
         std::string testCommand = "run_expected_results_commands";
         preprocessKwl(m_acceptTestList, testCommand, kwl);
      }
      
      if ( m_runTestList.size() ) // Do this last always...
      {
         std::string testCommand = "run_test_commands";
         preprocessKwl(m_runTestList, testCommand, kwl);
      }

      ossimFilename logDir = base_output_dir.dirCat("log");
      const char* lookup = kwl.find("log_directory");
      if ( lookup )
      {
         logDir = convertToNative( lookup ).c_str();
      }

      if (( logDir.exists() == false ) && ( logDir.createDirectory() == false ))
      {
         status = TEST_ERROR;
         ostringstream errmsg;
         errmsg << "Could not create: <" << logDir << ">."<< endl;
         throw ossimException(errmsg.str());
      }

      // Establish path to and active stream for the log file:
      ossimFilename logFile;
      getLogFilename(logFile);
      logFile = logDir.dirCat(logFile);
      ossimSetLogFilename(logFile);
      m_logStr.open(logFile.c_str());
      if ( m_logStr.fail() )
      {
         status = TEST_ERROR;
         ostringstream errmsg;
         errmsg << "Could not open: <" << logFile  << ">."<< endl;
         throw ossimException(errmsg.str());
      }

      cout << "Logging to file: " << logFile << "\n";

      ossimString date;
      getDateString(date);
      m_logStr << "// ---\n"
               << "// ossim-batch-test log:\n"
               << "// date format = yyyymmddhhmmss\n"
               << "//---\n"
               << "start_time: " << date << "\n"
               << "config_file: " << m_configFileName<< "\n";
      // Start the timer.
      ossimTimer::instance()->setStartTick();
      
      double startTime = ossimTimer::instance()->time_s();
      
   
      ossimString regExpStr = "test[0-9]+\\.";
      std::vector<ossimString> prefixes;
      kwl.getSubstringKeyList(prefixes, regExpStr);
      
      // If no test prefix is used, this implies a single test:
      if (prefixes.empty())
         prefixes.push_back("");
      
      status = TEST_TBD;
      for(ossim_uint32 idx = 0; idx < prefixes.size(); ++idx)
      {
         ossim_uint8 individual_test_status = processTest( prefixes[idx], kwl);
         status |= individual_test_status;
      }
      
      getDateString(date);
      m_logStr << "\nstop_time: " << date << "\n";
      double stopTime = ossimTimer::instance()->time_s();
      m_logStr << "total elapsed time in seconds: "
               << std::setiosflags(ios::fixed) << std::setprecision(4)
               << (stopTime-startTime)
               << endl; // flush
      m_logStr.close();

      cout << "\ntotal elapsed time in seconds: "
           << std::setiosflags(ios::fixed) << std::setprecision(4)
           << (stopTime-startTime)
           << "\nWrote log: " << logFile << "\n" << endl;
   }
   catch (ossimException& e)
   {
      status = TEST_ERROR;
      cerr << "\nossimBatchTest::execute() caught exception: " << e.what() << endl;
   }
   catch ( ... )
   {
      cerr << "\nossimBatchTest::execute() caught unhandled exception: " << endl;
   }

   cout<<"ossimBatchTest: Exiting <"<<configName<<"> with status = "
         <<m_statusLabels[status]<<endl;

   return status;
}

getDateString()

void ossimBatchTest::getDateString ( ossimString &  date )

private

Fetches string from OS for naming and tagging the log file.

Definition at line 641 of file ossimBatchTest.cpp.

References ossimString::clear().

Referenced by execute(), getLogFilename(), and processCommands().

{
   time_t t;
   time(&t);
   tm* lt;
   lt = localtime(&t);
   std::string frmt = "%Y%m%d%H%M%S";
   // yyyymmddhhmmss
   char s[15];
   size_t count = strftime(s, 15, frmt.c_str(), lt);
   if ( count && (count < 15) )
      date = s;
   else
      date.clear();

}

getDefaultTempFileDir()

bool ossimBatchTest::getDefaultTempFileDir ( ossimFilename &  tempDir ) const

private

Gets the default temp directory /data1/test/results/linux/tmp.

Parameters

tempDir

Initialized by this.

Returns

true on success, false on error.

Definition at line 1159 of file ossimBatchTest.cpp.

References ossimFilename::dirCat(), ossimString::empty(), ossimEnvironmentUtility::getEnvironmentVariable(), ossimEnvironmentUtility::instance(), and ossimString::size().

Referenced by doDefaultClean(), and getTempFileName().

{
   // Create a default tmp directory under OSSIM_BATCH_TEST_RESULTS.
   tempFile = ossimEnvironmentUtility::instance()->getEnvironmentVariable(
      ossimString("OSSIM_BATCH_TEST_RESULTS") );
   if (!tempFile.empty())
      tempFile = tempFile.dirCat("tmp");
   else
      tempFile = ossimEnvironmentUtility::instance()->getEnvironmentVariable(ossimString("TEMP"));
   return ( tempFile.size() > 0 );
}

getLogFilename()

void ossimBatchTest::getLogFilename ( ossimFilename &  logFile )

private

Establishes name of output log file.

Definition at line 661 of file ossimBatchTest.cpp.

References getDateString().

Referenced by execute().

{
   logFile = "obt-log-";
   ossimString date;
   getDateString(date);
   logFile += date;
   logFile += ".txt";
}

getTempFileName()

bool ossimBatchTest::getTempFileName ( const ossimString &  prefix, const ossimKeywordlist &  kwl, ossimFilename &  tempFile  ) const

private

Gets the temp file name.

This will either be from the config file lookup of "temp_file" or derived under /data1/test/results/linux/tmp if the lookup fails. Note that this will create the /data1/test/results/linux/tmp directory if needed.

Parameters

prefix	Like "test1."
kwl	Keyword list to look for temp_file in.
tempFile	Initialized by this.

Returns

true on success. False if derived temp file directory could not be created.

Definition at line 1130 of file ossimBatchTest.cpp.

References ossimString::c_str(), ossimString::clear(), ossimString::contains(), ossimFilename::createDirectory(), ossimFilename::dirCat(), ossimFilename::expand(), ossimKeywordlist::find(), getDefaultTempFileDir(), and ossimString::size().

Referenced by processTest().

{
   const char* lookup = kwl.find(prefix.c_str(), "temp_file");
   if ( lookup )
   {
      tempFile = ossimFilename(lookup);
      if (tempFile.contains("$("))
         tempFile = tempFile.expand();
   }
   else
   {
      if ( getDefaultTempFileDir( tempFile ) )
      {
         if ( tempFile.createDirectory( true, 0775 ) )
         {
            // Tack on the file name.
            tempFile = tempFile.dirCat("tmp.txt");
         }
         else
         {
            tempFile.clear();
         }
      }
   }
   return ( tempFile.size() > 0 );
}

initialize()

bool ossimBatchTest::initialize

(

ossimArgumentParser &

ap

)

Initializes the test session given the command line.

Definition at line 64 of file ossimBatchTest.cpp.

References ossimArgumentParser::argc(), ossimArgumentParser::argv(), ossimArgumentParser::errors(), m_acceptTestList, m_cleanTestList, m_configFileName, m_preprocessTestList, m_runTestList, m_templateModeActive, ossimNotify(), ossimNotifyLevel_NOTICE, ossimArgumentParser::read(), ossimArgumentParser::reportRemainingOptionsAsUnrecognized(), ossimString::size(), ossimString::split(), usage(), ossimArgumentParser::writeErrorMessages(), and writeTemplate().

{
   if ( (ap.argc() == 1) || ap.read("-h") || ap.read("--help") )
   {
      usage(ap);

      // continue_after_init to false
      return false;
   }

   // Initialize environment:
#if defined(_WIN32) || defined(_MSC_VER) && !defined(__CYGWIN__) && !defined(__MWERKS__)
   _putenv("DEL_CMD=del /Q"); // For backwards compatiblity.
   _putenv("DIFF_CMD=fc /W");
   _putenv("COPY_CMD=copy /Y");
   _putenv("MKDIR_CMD=mkdir");
   _putenv("RM_CMD=del /Q");
   _putenv("RMDIR_CMD=rmdir /S /Q");
   
#else
   setenv("DEL_CMD",  "rm -rf",    1); // For backwards compatiblity.
   setenv("DIFF_CMD",  "diff -w",  1);
   setenv("COPY_CMD",  "cp",       1);
   setenv("MKDIR_CMD", "mkdir -p", 1);
   setenv("RM_CMD",    "rm -f",    1);
   setenv("RMDIR_CMD", "rm -rf",   1);
   
#endif
   
   std::string tempString;
   ossimArgumentParser::ossimParameter stringParam(tempString);
   
   if (ap.read("-W", stringParam) || ap.read("-W"))
   {
      ossimFilename templateFile (tempString.c_str());
      if (templateFile.empty())
         templateFile = "obt_config_long_template.kwl";
      m_templateModeActive = true;
      writeTemplate(templateFile, true);
      return true;
   }
   if (ap.read("-w", stringParam) || ap.read("-w"))
   {
      ossimFilename templateFile(tempString.c_str());
      if (templateFile.empty())
         templateFile = "obt_config_short_template.kwl";
      m_templateModeActive = true;
      writeTemplate(templateFile, false);
      return true;
   }
   
   while ( ap.read("-a", stringParam) || ap.read("--accept-test", stringParam) )
   {
      if ( tempString.size() )
      {
         ossimString os = tempString;
         ossimString separatorList = " ";
         std::vector<ossimString> result;
         os.split(result, separatorList);
         std::vector<ossimString>::const_iterator i = result.begin();
         while ( i != result.end() )
         {
            m_acceptTestList.push_back((*i));
            ++i;
         }
      }
   }

   while ( ap.read("-c", stringParam) || ap.read("--clean-test", stringParam) )
   {
      if ( tempString.size() )
      {
         ossimString os = tempString;
         ossimString separatorList = " ";
         std::vector<ossimString> result;
         os.split(result, separatorList);
         std::vector<ossimString>::const_iterator i = result.begin();
         while ( i != result.end() )
         {
            m_cleanTestList.push_back((*i));
            ++i;
         }
      }
   }

   while ( ap.read("-p", stringParam) || ap.read("--preprocess-test", stringParam) )
   {
      if ( tempString.size() )
      {
         ossimString os = tempString;
         ossimString separatorList = " ";
         std::vector<ossimString> result;
         os.split(result, separatorList);
         std::vector<ossimString>::const_iterator i = result.begin();
         while ( i != result.end() )
         {
            m_preprocessTestList.push_back((*i));
            ++i;
         }
      }
   }

   while ( ap.read("-r", stringParam) || ap.read("--run-test", stringParam) )
   {
      if ( tempString.size() )
      {
         ossimString os = tempString;
         ossimString separatorList = " ";
         std::vector<ossimString> result;
         os.split(result, separatorList);
         std::vector<ossimString>::const_iterator i = result.begin();
         while ( i != result.end() )
         {
            m_runTestList.push_back((*i));
            ++i;
         }
      }
   }

   // End of arg parsing.
   ap.reportRemainingOptionsAsUnrecognized();
   if ( ap.errors() )
   {
      ap.writeErrorMessages(ossimNotify(ossimNotifyLevel_NOTICE));
      return false;
   }

   if (ap.argc() > 1 )
   {
      m_configFileName = ap.argv()[1];
   }
   else
   {
      usage(ap);

      // continue_after_init to false
      return false;
   }

   // Special command line case: When only a config filename is provided, this implies "run all 
   // tests".
   if (m_cleanTestList.empty()  && m_preprocessTestList.empty() &&
       m_acceptTestList.empty() && m_runTestList.empty() && m_configFileName.size())
   {
      m_runTestList.push_back("all");
   }

   return true;
}

makeDefaultResultsDir()

bool ossimBatchTest::makeDefaultResultsDir ( )

private

Default preprocessing step makes expected and output results directories.

Returns

Returns

TRUE if successful.

Returns TRUE if successful.

Definition at line 1073 of file ossimBatchTest.cpp.

References ossimFilename::createDirectory(), ossimFilename::exists(), m_expDir, and m_outDir.

Referenced by processCommands().

{
   if ( !m_outDir.exists() && !m_outDir.createDirectory() )
   {
      cerr << "Could not create: " << m_outDir << endl;
      return false;
   }
   if ( !m_expDir.exists() &&  !m_expDir.createDirectory() )
   {
      cerr << "Could not create: " << m_expDir << endl;
      return false;
   }
   return true;
}

preprocessKwl()

void ossimBatchTest::preprocessKwl ( const std::vector< std::string > &  testList, const std::string &  testCommand, ossimKeywordlist &  kwl  )

private

Modifies the config's KWL to explicitly declare implied keywords.

Definition at line 974 of file ossimBatchTest.cpp.

References ossimKeywordlist::add(), ossimString::c_str(), ossimString::downcase(), ossimKeywordlist::getNumberOfSubstringKeys(), ossimKeywordlist::getSize(), and ossimString::toString().

Referenced by execute().

{
   if ( testList.empty() || testCommand.empty() || (kwl.getSize()==0) )
      return;

   // Check for user passed in "all" to option.
   std::vector<std::string>::const_iterator testIter = testList.begin();
   bool enableAllTestFlag = false;
   ossimString firstTest(*testIter);
   firstTest.downcase();
   if ( firstTest == "all" )
   {
      enableAllTestFlag = true;
   }

   while ( testIter != testList.end() )
   {
      // Get the number of test:
      ossimString regExpStr = "test[0-9]+\\.";
      ossim_uint32 num_tests = kwl.getNumberOfSubstringKeys(regExpStr);
      const ossim_uint32 MAX_INDEX = num_tests + 1000;
      ossimString prefixBase = "test";
      ossim_uint32 index = 0;
      ossim_uint32 processedIndexes = 0;

      // A count of 0 may indicate that the config file consists of a single, unprefixed test spec:
      bool is_single_test = false;
      if (num_tests == 0)
      {
         regExpStr = "test_command[0-9]+";
         const ossim_uint32 cmd_count = kwl.getNumberOfSubstringKeys(regExpStr);
         if (cmd_count != 0)
         {
            ++num_tests;
            is_single_test = true;
         }
         else
            break; // Nothing to do here:
      }

      while ( processedIndexes < num_tests )
      {
         ossimString prefix ("");
         bool test_name_matches = true;
         bool test_exists = true;
         
         if (!is_single_test)
         {
            // The tests are prefixed with "test*". Assign the prefix for this test set:
            prefix = prefixBase + ossimString::toString(index);
            test_name_matches = (prefix == (*testIter).c_str());
            prefix += ".";
            
            // With a valid prefix, check if this test even exists before doing any more 
            // preprocessing:
            regExpStr = prefix + "test_command[0-9]+";
            const ossim_uint32 cmd_count = kwl.getNumberOfSubstringKeys(regExpStr);
            test_exists = cmd_count > 0;
         }

         if ( test_exists )
         {
            if ( test_name_matches || enableAllTestFlag )
            {
               //---
               // Removed adjustment of "enable" flag. Let the config file "enable" key
               // control this.  drb - 20151202
               // kwl.add(prefix.c_str(), "enabled", "1", true);
               //---
               kwl.add(prefix.c_str(), testCommand.c_str(), "1", true);
               if ( testCommand == "run_expected_results_commands" )
               {
                  // Need pre-processing if clean performed.
                  kwl.add(prefix.c_str(), "run_preprocessing_commands", "1", true);
               }
               if ( testCommand == "run_test_commands" )
               {
                  // Need pre/post-processing:
                  kwl.add(prefix.c_str(), "run_preprocessing_commands", "1", true);
                  kwl.add(prefix.c_str(), "run_postprocessing_commands", "1", true);
               }
            }
            ++processedIndexes;
         }
         ++index;
         if ( index >= MAX_INDEX ) break; 
      }
      ++testIter;

   } // End: while ( testIter != testList.end() )
   
} // End: preprocessKwl method

processCommands()

ossim_uint8 ossimBatchTest::processCommands ( const ossimString &  prefix, const ossimKeywordlist &  kwl, const ossimString &  testName, bool  logTime, const ossimFilename &  tempFile = ossimFilename("")  )

private

Runs a single command within a test.

Returns

The bit-wise status of command (see TEST_STATUS enum for bit definitions).

Definition at line 820 of file ossimBatchTest.cpp.

References ossimString::c_str(), ossimString::contains(), convertToNative(), doDefaultClean(), ossimString::empty(), ossimKeywordlist::find(), getDateString(), ossimKeywordlist::getNumberOfSubstringKeys(), ossimTimer::instance(), m_logStr, makeDefaultResultsDir(), ossimString::size(), status, TEST_ERROR, TEST_FAILED, TEST_PASSED, TEST_TBD, ossimTimer::time_s(), and ossimString::toString().

Referenced by processTest().

{
   ossim_uint8 result = TEST_TBD;

   //---
   // We must do these in order so we will use the
   // ossimKeywordlist::getNumberOfSubstringKeys
   // instead of: ossimKeywordlist::getSubstringKeyList
   //
   // MAX_INDEX is just so people can skip numbers in their config file like:
   // test1.command
   // test3.command oops...
   //---
   ossimString regExpStr = prefixBase + "[0-9]+";
   const ossim_uint32 num_commands = kwl.getNumberOfSubstringKeys(regExpStr);
   const ossim_uint32 MAX_INDEX = num_commands + 1000;

   // Hack to permit defaulted results paths and default clean operation:
   if (num_commands == 0)
   {
      bool rtn_ok = true;
      if (prefixBase.contains("preprocess"))
         rtn_ok = makeDefaultResultsDir();
      if (prefixBase.contains("clean"))
         rtn_ok = doDefaultClean();
      if (rtn_ok)
         result = TEST_PASSED;
      else
         result = TEST_ERROR;
      return result;
   }

   ossimString date;
   double startTime;
   double stopTime;
   
   ossimString command;
   ossim_uint32 index = 0;
   ossim_uint32 processedIndexes = 0;
   const char* lookup = 0;
   
   bool postprocessing = false;
   if (prefixBase.contains("postprocess"))
      postprocessing = true;

   while (  processedIndexes < num_commands )
   {
      ossimString cmd_kw =  prefixBase + ossimString::toString(index);
      lookup = kwl.find( cmd_kw );
      if ( lookup )
      {
         ossimString command_line = convertToNative( lookup ).c_str();
         if ( tempFileName.size() )
         {
            command_line += " > " + tempFileName;
         }

         m_logStr << "executing command: " << command_line << "\n";

         if ( logTime )
         {
            getDateString(date);
            m_logStr << "begin: " << date << "\n";

            // Start the clock:
            startTime = ossimTimer::instance()->time_s();
         }
            
         // Launch the command:
         int status = system(command_line.chars());
         if (status == 0)
            result |= TEST_PASSED;
         else if (postprocessing)
            result |= TEST_FAILED;
         else
            result |= TEST_ERROR;

         if ( logTime )
         {
            // Log the time and status:
            stopTime = ossimTimer::instance()->time_s();
            getDateString(date);
            m_logStr << "end: " << date << "\n"
                   << testName << "[" << index << "]: elapsed time in seconds: "
                   << std::setiosflags(ios::fixed)
                   << std::setprecision(4)
                   << (stopTime-startTime) << "\n";
         }
         
         m_logStr << "return status: " << status << "\n";
         
         // Output the status.
         // If failed write the temp file to the log.  This should have the diffs in it.
         ostringstream statusString;
         if ( prefixBase.size() )
         {
            statusString << prefixBase;
         }
         else
         {
            statusString << "test";
         }
         statusString << "[" << index << "]: ";

         if ( status != 0 )
         {
            // A bad return status can be a test fail if the command was a postprocess:
            if ( postprocessing )
            {
               statusString << "FAILED";
            }
            else
            {
               statusString << "ERROR";
            }

            cout << statusString.str() << endl;
            m_logStr << statusString.str() << endl;
            m_logStr << command << "\noutput follows:\n";
            std::ifstream in;
            if (!tempFileName.empty())
            {
               in.open(tempFileName.c_str(), ios::in | ios::binary);
               if ( in.is_open() )
               {
                  char ch;
                  while ( in.get(ch) ) m_logStr.put(ch);
                  m_logStr << "\n";
                  in.close();
               }
            }
         }
         else
         {
            statusString << "PASSED";
            cout << statusString.str() << endl;
            m_logStr << statusString.str() << endl;
         }

         ++processedIndexes;
      }
      ++index;
      
      if ( index >= MAX_INDEX ) 
         break; // Config file has bad numbering...
   }
   return result;
}

processConfigList()

ossim_uint8 ossimBatchTest::processConfigList ( const ossimKeywordlist &  kwl )

private

When the config file consists of a list of subordinate test config files, this method manages processing multiple configs.

Returns

The overall bit-wise status of all configs (see TEST_STATUS enum for bit definitions).

Definition at line 603 of file ossimBatchTest.cpp.

References ossimString::contains(), ossimString::empty(), execute(), ossimFilename::expand(), ossimKeywordlist::findKey(), ossimKeywordlist::getSubstringKeyList(), ossimFilename::isReadable(), m_configFileName, ossimFilename::path(), ossimFilename::setPath(), and TEST_TBD.

Referenced by execute().

{
   ossim_uint8 overall_test_status = TEST_TBD;
   ossimFilename config_list_path = m_configFileName.path();

   ossimString keywordRegEx = "test_config_file[0-9]+";
   std::vector<ossimString> keywords;
   kwl.getSubstringKeyList(keywords, keywordRegEx);

   for(ossim_uint32 idx=0;idx < (ossim_uint32)keywords.size(); ++idx)
   {
      // Looping over each config file listed, performing an execute() on each:
      m_configFileName = kwl.findKey(keywords[idx]);
      
      if (!m_configFileName.empty())
      {
         // Expand any environment variable:
         if (m_configFileName.contains("$("))
            m_configFileName = m_configFileName.expand();

         // Handle paths relative to the master config list file:
         if (m_configFileName.path().empty())
            m_configFileName = m_configFileName.setPath(config_list_path);
      }

      // Execute this config file:
      if (m_configFileName.isReadable())
      {
         overall_test_status |= execute();
      }
   }

   return overall_test_status;
}

processTest()

ossim_uint8 ossimBatchTest::processTest ( const ossimString &  prefix, const ossimKeywordlist &  kwl  )

private

Within a single config file can be multiple tests, distinguished by the "test*." prefix.

This method manages the execution of a single test.

Returns

The overall bit-wise status of test (see TEST_STATUS enum for bit definitions).

This method manages the execution of a single test.

Definition at line 674 of file ossimBatchTest.cpp.

References ossimString::c_str(), ossimString::empty(), ossimFilename::fileNoExtension(), ossimKeywordlist::find(), ossimKeywordlist::getNumberOfSubstringKeys(), getTempFileName(), m_configFileName, m_logStr, processCommands(), ossimString::size(), TEST_DISABLED, TEST_ERROR, TEST_TBD, ossimString::toBool(), and ossimString::trim().

Referenced by execute().

{
   ossim_uint8 testStatus = TEST_TBD;

   // Determine first if this test prefix is represented in the KWL:
   if (kwl.getNumberOfSubstringKeys(prefix) == 0)
      return testStatus;

   ossimString testName;
   const char* lookup = kwl.find( prefix, "name" );
   if ( lookup )
   {
      testName = lookup;
   }
   if (testName.empty())
   {
      if (prefix.empty())
         testName = m_configFileName.fileNoExtension();
      else
         testName = prefix.trim(".");
   }

   m_logStr << "\n----------------------------------------------------------------------\n";

   // See if test is disabled/enabled:
   
   bool enabled = true;
   lookup = kwl.find( prefix, "enabled" );
   if ( lookup )
   {
      enabled = ossimString(lookup).toBool();
   }

   if ( !enabled )
   {
      testStatus = TEST_DISABLED;
      ossimString statusString;
      if ( prefix.size() )
      {
         statusString = prefix.trim(ossimString(".")) + ossimString(": disabled");
      }
      else
      {
         statusString = "test: disabled";
      }
      cout << "test_name: " << testName << "\n" << statusString << endl;
      m_logStr << "test_name: " << testName << "\n" << statusString << endl;
      return testStatus;
   }

   cout     << "\n\nbegin_test:\n" << prefix << "name: " << testName << "\n";
   m_logStr << "\n\nbegin_test:\n" << prefix << "name: " << testName << "\n";   
   lookup = kwl.find( prefix, "description" );
   if ( lookup )
      m_logStr << "description: " << lookup << "\n";

   bool preProcessFlag  = false;
   bool expectedFlag    = false;
   bool testFlag        = false;
   bool postProcessFlag = false;
   bool cleanFlag       = false;
   std::string date; 

   lookup = kwl.find(prefix.c_str(), "run_clean_commands");
   if ( lookup )
   {
      cleanFlag = ossimString(lookup).toBool();
   }

   lookup = kwl.find(prefix.c_str(), "run_preprocessing_commands");
   if ( lookup )
   {  
      preProcessFlag = ossimString(lookup).toBool();
   }

   lookup = kwl.find(prefix.c_str(), "run_expected_results_commands");
   if ( lookup )
   {
      expectedFlag = ossimString(lookup).toBool();
   }

   lookup = kwl.find(prefix.c_str(), "run_test_commands");
   if ( lookup )
   {
      testFlag = ossimString(lookup).toBool();
   }

   lookup = kwl.find(prefix.c_str(), "run_postprocessing_commands");
   if ( lookup )
   {
      postProcessFlag = ossimString(lookup).toBool();
   }

   m_logStr << "preProcessFlag:  " << preProcessFlag
            << "\nexpectedFlag:    " <<expectedFlag
            << "\ntestFlag:        " <<testFlag
            << "\npostProcessFlag: " <<postProcessFlag
            << "\ncleanFlag:       " <<cleanFlag
            << "\n";

   // Run the clean first if set...
   if ( cleanFlag )
   {
      ossimString prefixBase = prefix + "clean_command";
      testStatus |= processCommands( prefixBase, kwl, testName, false );
   }

   if ( preProcessFlag && !(testStatus & TEST_ERROR))
   {
      ossimString prefixBase = prefix + "preprocess_command";
      testStatus |= processCommands( prefixBase, kwl, testName, false );
   }
   if ( expectedFlag  && !(testStatus & TEST_ERROR))
   {
      ossimString prefixBase = prefix + "expected_results_command";
      testStatus |= processCommands( prefixBase, kwl, testName, true );
   }
   if ( testFlag  && !(testStatus & TEST_ERROR))
   {
      ossimString prefixBase = prefix + "test_command";
      testStatus |= processCommands( prefixBase, kwl, testName, true );
   }
   if ( postProcessFlag  && !(testStatus & TEST_ERROR))
   {
      ossimFilename tempFile;

      if ( getTempFileName( prefix, kwl, tempFile ) )
      {
         ossimString prefixBase = prefix + "postprocess_command";
         testStatus |= processCommands( prefixBase, kwl, testName, false, tempFile );
      }
      else
      {
         m_logStr << testName << ": ERROR temp file could not be derived..." << endl;
         testStatus |= TEST_ERROR; // Set an error bit...
      }
   }

   cout     << "end_test:\n";
   m_logStr << "end_test:\n";

   m_logStr << "----------------------------------------------------------------------\n"; 
   return testStatus; 
}

usage()

void ossimBatchTest::usage ( ossimArgumentParser &  ap )

private

Initializes arg parser and outputs usage.

Definition at line 1171 of file ossimBatchTest.cpp.

References ossimApplicationUsage::addCommandLineOption(), ossimArgumentParser::getApplicationUsage(), ossimNotify(), ossimNotifyLevel_INFO, and ossimApplicationUsage::write().

Referenced by initialize().

{
   ossimApplicationUsage* au = ap.getApplicationUsage();

   au->addCommandLineOption("-a or --accept-test", 
      "<testX> Runs \"run_expected_results_commands\" portion from test configuration file for "
      "testX where X is some test number, i.e. 1, 2, 3...  This will turn off all other test in "
      "the test config file. Notes: Multiple tests can be entered by quoting string of space "
      "separated test, e.g. \"test1 test2\". To accept all tests use \"all\" for test.");
   
   au->addCommandLineOption("-c or --clean-test", "<testX> Runs \"run_clean_commands\" portion "
      "from test configuration file for testX where X is some test number, i.e. 1, 2, 3...  This "
      "will turn off all other test in the test config file. Notes: Multiple tests can be entered "
      "by quoting string of space separated test, e.g. \"test1 test2\". To clean all tests use "
      "\"all\" for test.");

   au->addCommandLineOption("-p or --preprocess-test", 
      "<testX> Runs \"run_preprocessing_commands\" portion from test configuration file for testX "
      "where X is some test number, i.e. 1, 2, 3...  This will turn off all other test in the test "
      "config file. Notes: Multiple tests can be entered by quoting string of space separated "
      "test, e.g. \"test1 test2\". To preprocess all tests use \"all\" for test.");
   
   au->addCommandLineOption("-r or --run-test", 
      "<testX> Runs \"run_test_commands\" portion from test configuration file for testX where X "
      "is some test number, i.e. 1, 2, 3...  This will turn off all other test in the test config "
      "file. Notes: Multiple tests can be entered by quoting string of space separated test, e.g. "
      "\"test1 test2\". To run all tests use \"all\" for test.");
   
   au->addCommandLineOption("-h or --help", "Display usage.");
   
   au->addCommandLineOption("-W or -w", 
      "<template_name.kwl> Writes a long-form (-W) or a short-form (-w) template test "
      "configuration file.");

   // Write usage.
   au->write(ossimNotify(ossimNotifyLevel_INFO));
}

writeTemplate()

void ossimBatchTest::writeTemplate ( const ossimFilename &  templateFile, bool  long_form  )

private

Writes template test config file, either exhaustive long form for flexibility, or simple short-form for easier test creation.

Definition at line 217 of file ossimBatchTest.cpp.

References ossimString::c_str(), ossimString::chars(), ossimFilename::exists(), ossimString::expandEnvironmentVariable(), ossimNotify(), and ossimNotifyLevel_NOTICE.

Referenced by initialize().

{
   if (templateFile.exists())
   {
      ossimString del_cmd ("$(RM_CMD) ");
      del_cmd += templateFile;
      del_cmd = del_cmd.expandEnvironmentVariable();
      if (system(del_cmd.chars()) != 0)
      {
         cerr << "ERROR: Could not delete existing template file before writing new template."
            " Please delete the existing and rerun the command."<< endl;
         return;
      }
   }

   std::ofstream out(templateFile.c_str());
   if ( !out.good() )
   {
      ossimNotify(ossimNotifyLevel_NOTICE)
         << "Could not open: " << templateFile.c_str() << std::endl;
      return;
   }

   if (write_long_form)
   {
      out<< "//===================================================================================\n"
         << "// \n"
         << "// File: " << templateFile.c_str() << "\n"
         << "// Generated by command: ossim-batch-test -W " << templateFile.c_str() << "\n"
         << "// Description: ossim-batch-test template config file.\n"
         << "// \n"
         << "// Control flags:\n"
         << "// Use 1 or true, 0 or false to turn on and off sections.\n"
         << "// Typically preprocess and expected results only turned on for first run.\n"
         << "// Clean commands should erase anything created by this test.\n"
         << "// Command order if flag turned on:\n"
         << "// 1) clean, 2) pre-process, 3) expected, 4) test, 5) post-process\n"
         << "// \n"
         << "// NOTES:\n"
         << "// * The following environment variables must be set before running batch test:\n"
         << "//     OSSIM_BATCH_TEST_DATA     Top-level dir containing all test source data\n"
         << "//     OSSIM_BATCH_TEST_EXPECTED Top-level dir containing all test expected results \n"
         << "//     OSSIM_BATCH_TEST_RESULTS  Top-level dir containing all test results and logging output \n"
         << "// \n"
         << "// * The variables OBT_EXP_DIR and OBT_OUT_DIR are assigned during run-time to\n"
         << "//   the proper paths according to the config filename. It isn't required to replace\n"
         << "//   these nor predefine them in the environment. You can leave them as is or modify\n"
         << "//   the paths to your unconventional file paths.\n"
         << "// \n"
         << "// * In order to preserve platform independence, please utilize the following \n"
         << "//   variables for the common OS commands when adding new commands to the test\n"
         << "//   configuration KWL file. Examples are provided in this template\n"
         << "//       $(DIFF_CMD) Use this var for windows \"fc\" or linux \"diff\"\n"
         << "//       $(COPY_CMD) Use this var for windows \"copy\" or linux \"cp\"\n"
         << "//       $(MKDIR_CMD) Use this var for windows \"mkdir\" or linux \"mkdir\"\n"
         << "//       $(RM_CMD) Use this var for windows \"del /Q\" or linux \"rm -f\"\n"
         << "//       $(RMDIR_CMD) Use this var for windows \"rmdir /S /Q\" or linux \"rm -rf\"\n"
         << "//   This application will set the environment variables to the proper values at \n"
         << "//   runtime, so no need to worry about defining these.\n"
         << "// \n"
         << "// * Use forward slashes \"//\", at beginning of line for comments.\n"
         << "// \n"
         << "// * You can use existing environment variables as $(YOUR_VARIABLE). They will be \n"
         << "//   expanded at run time if valid.\n"
         << "// \n"
         << "// * Clean, preprocess, run, and accept test sections can be switched on or off\n"
         << "//   at run time.  These override config file flags.  Optional arguments are the \n"
         << "//   the following: \n"
         << "//      -c or --clean-test \n"
         << "//      -p or --preprocess-test\n"
         << "//      -r or --run-test \n"
         << "//      -a or --accept-test \n"
         << "//   Multiple tests can be entered by quoting string of space-separated\n"
         << "//   test names, e.g. \"test1 test2\". To do all tests use \"all\" or leave blank.\n"
         << "// \n"
         << "//===================================================================================\n"
         << "\n"
         << "// If the config file will contain only a list of subordinate config files to be\n"
         << "// run as one consolidated \"super-test\", then use only the following suffixed\n"
         << "// keywords. Otherwise, REMOVE THESE:\n"
         << "test_config_file1: <my_first_test_config.kwl>\n"
         << "test_config_file2: <my_second_test_config.kwl>\n"
         << "// ... etc.\n"
         << "\n"
         << "// The remaining keywords are used exclusive of \"test_config_fileX\" above. The\n"
         << "// config files must be either a list of subordinate configs, or a concrete, \n"
         << "// low-level config file.\n"
         << "\n"
         << "// Where you want the top-level (inter-test) log files to go:\n"
         << "log_directory: $(OBT_OUT_DIR)\\..\\log\n"
         << "\n"
         << "//===================================================================================\n"
         << "// Begin Test 1\n"
         << "// NOTE: If the config file contains just a single test, then the use of the \"test1\"\n"
         << "// prefix is optional. Make sure the results directory spec reflects the proper path.\n"
         << "\n"
         << "test1.name: <YOUR_TEST_NAME>\n"
         << "test1.description: Test height for the center of the image for test2 and test3.\n"
         << "\n"
         << "// Controls/turns on/off whole test (all sections):\n"
         << "test1.enabled: 1\n"
         << "\n"
         << "// Individual control flags:\n"
         << "test1.run_clean_commands: 0\n"
         << "test1.run_preprocessing_commands: 0\n"
         << "test1.run_expected_results_commands: 0\n"
         << "test1.run_test_commands: 1\n"
         << "test1.run_postprocessing_commands: 1\n"
         << "\n"
         << "// Temp file to catch diff output.\n"
         << "test1.temp_file: $(TEMP)\\tmp.txt\n"
         << "\n"
         << "// Clean up commands\n"
         << "test1.clean_command1: $(RMDIR_CMD) $(OBT_OUT_DIR)\n"
         << "\n"
         << "// Pre-process commands\n"
         << "test1.preprocess_command1: $(MKDIR_CMD) $(OBT_OUT_DIR)\n"
         << "test1.preprocess_command1: $(MKDIR_CMD) $(OBT_OUT_DIR)\\..\\log\n"
         << "\n"
         << "//---------------------------------------\n"
         << "// Commands to generate expected results\n"
         << "//---------------------------------------\n"
         << "// Since test2 and test3 are dependent on elevation test the center of the image.\n"
         << "test1.expected_results_command0: ossim-info --height -42.8508 147.2537 > $(OBT_EXP_DIR)\\height.txt\n"
         << "test1.expected_results_command1: $(COPY_CMD) $(OBT_OUT_DIR)\\height.txt $(OBT_EXP_DIR)\\height.txt\n"
         << "\n"
         << "//---------------------------------------\n"
         << "// The actual commands to test\n"
         << "//---------------------------------------\n"
         << "test1.test_command0: ossim-info --height -42.8508 147.2537 > $(OBT_OUT_DIR)\\height.txt\n"
         << "\n"
         << "//-------------------------------------------\n"
         << "// Post process commands for diffs, etc.\n"
         << "//-------------------------------------------\n"
         << "test1.postprocess_command0: $(DIFF_CMD) $(OBT_EXP_DIR)\\height.txt $(OBT_OUT_DIR)\\height.txt\n"
         << " \n"
         << "\n"
         << "// End <TEST_NAME>\n"
         << "//===================================================================================\n"
         << "// Begin <TEST2_NAME>...\n"
         << "\n"
         << "// You can specify additional tests by copying the test1 keywords and changing the\n"
         << "// prefix indices to be unique. It is not necessary to be consecutive.\n"
         << "\n"
         << std::endl;
   }
   else 
   {
      out<< "//===================================================================================\n"
         << "// \n"
         << "// File: " << templateFile.c_str() << "\n"
         << "// Generated by command: ossim-batch-test -w " << templateFile.c_str() << "\n"
         << "// Description: ossim-batch-test template config file.\n"
         << "// \n"
         << "// NOTES:\n"
         << "// * The following environment variables must be set before running batch test:\n"
         << "//     OSSIM_BATCH_TEST_DATA     Top-level dir containing all test source data\n"
         << "//     OSSIM_BATCH_TEST_EXPECTED Top-level dir containing all test expected results \n"
         << "//     OSSIM_BATCH_TEST_RESULTS  Top-level dir containing all test results and logging output \n"
         << "// \n"
         << "// * You can use existing environment variables as $(YOUR_VARIABLE). They will be \n"
         << "//   expanded at run time if valid.\n"
         << "// \n"
         << "// * If the config file contains more than a single test, then it will be necessary \n" 
         << "//   to prefix all test-specific keywords with \"testN.\"\n"
         << "// \n"
         << "// * The variables OBT_EXP_DIR and OBT_OUT_DIR are assigned during runtime to\n"
         << "//   the proper paths according to the config filename. It isn't required to replace\n"
         << "//   these nor predefine them in the environment. You can leave them as is or modify\n"
         << "//   the paths to your unconventional file paths.\n"
         << "// \n"
         << "//===================================================================================\n"
         << "\n"
         << "description: Test height for the center of the image for test2 and test3.\n"
         << "\n"
         << "//---------------------------------------\n"
         << "// Commands to generate expected results.\n"
         << "//---------------------------------------\n"
         << "expected_results_command0: ossim-info --height -42.8508 147.2537 > $(OBT_OUT_DIR)\\height.txt\n"
         << "expected_results_command1: $(COPY_CMD) $(OBT_OUT_DIR)\\height.txt $(OBT_EXP_DIR)\\height.txt\n"
         << "\n"
         << "//---------------------------------------\n"
         << "// The actual commands to test.\n"
         << "//---------------------------------------\n"
         << "test_command0: ossim-info --height -42.8508 147.2537 > $(OBT_OUT_DIR)\\height.txt\n"
         << "\n"
         << "//---------------------------------------\n"
         << "// The post-processing (comparison) commands. Typically these involve a file \n"
         << "// comparison of last run command against expected results.\n"
         << "//---------------------------------------\n"
         << "postprocess_command0: $(DIFF_CMD) $(OBT_EXP_DIR)\\height.txt $(OBT_OUT_DIR)\\height.txt\n"
         << std::endl;
   }

   out.close();
   ossimNotify(ossimNotifyLevel_NOTICE) << "Wrote file: " << templateFile.c_str() << std::endl;
}

Member Data Documentation

m_acceptTestList

std::vector<std::string> ossimBatchTest::m_acceptTestList

private

Definition at line 135 of file ossimBatchTest.h.

Referenced by execute(), and initialize().

m_cleanTestList

std::vector<std::string> ossimBatchTest::m_cleanTestList

private

Definition at line 136 of file ossimBatchTest.h.

Referenced by execute(), and initialize().

m_configFileName

ossimFilename ossimBatchTest::m_configFileName

private

Definition at line 142 of file ossimBatchTest.h.

Referenced by execute(), initialize(), processConfigList(), and processTest().

m_expDir

ossimFilename ossimBatchTest::m_expDir

private

Definition at line 144 of file ossimBatchTest.h.

Referenced by execute(), and makeDefaultResultsDir().

m_logStr

std::ofstream ossimBatchTest::m_logStr

private

Definition at line 145 of file ossimBatchTest.h.

Referenced by doDefaultClean(), execute(), processCommands(), and processTest().

m_outDir

ossimFilename ossimBatchTest::m_outDir

private

Definition at line 143 of file ossimBatchTest.h.

Referenced by doDefaultClean(), execute(), and makeDefaultResultsDir().

m_preprocessTestList

std::vector<std::string> ossimBatchTest::m_preprocessTestList

private

Definition at line 137 of file ossimBatchTest.h.

Referenced by execute(), and initialize().

m_runTestList

std::vector<std::string> ossimBatchTest::m_runTestList

private

Definition at line 138 of file ossimBatchTest.h.

Referenced by execute(), and initialize().

m_statusLabels

std::map<ossim_uint32, std::string> ossimBatchTest::m_statusLabels

private

Definition at line 139 of file ossimBatchTest.h.

Referenced by execute(), and ossimBatchTest().

m_templateModeActive

bool ossimBatchTest::m_templateModeActive

private

Definition at line 141 of file ossimBatchTest.h.

Referenced by execute(), and initialize().

---

The documentation for this class was generated from the following files:

• ossimBatchTest.h
• ossimBatchTest.cpp