ready to implement external execution aspect of task

master
Chris Punches 2017-06-26 22:27:24 -04:00
parent 0bd455dd97
commit c87a56eb37
8 changed files with 63 additions and 6 deletions

View File

@ -18,6 +18,15 @@
"required": true,
"rectify": true
},
{
"name": "A DEFINITION THAT IS NOT USED",
"target": "/bin/pwd",
"output": "pass",
"rectifier": "/bin/pwd",
"active": true,
"required": true,
"rectify": true
},
{
"name": "dependent test",
"target": "/home/phanes/tests/test-script-pass.sh",

View File

@ -7,7 +7,7 @@ int main( )
bool verbose = true;
// A Plan is made up of Tasks, and a Suite is made up of Units.
// A Plan declares what units are executed and a Suite declares the definitions of those units.
Conf configuration = Conf("/home/phanes/Development/internal/Examplar/conf/config.json");
Conf configuration = Conf("/home/phanes/Development/internal/Examplar/conf/config.json", verbose );
// load the configuration file which contains filepaths to definitions of a plan and definitions of units.
std::string definitions_file = configuration.get_units_path();
@ -21,5 +21,9 @@ int main( )
plan.load_definitions( available_definitions, verbose );
std::cout << "Ready to execute all tasks in Plan." << std::endl;
plan.execute( verbose );
return 0;
}

View File

@ -16,10 +16,10 @@ class CONF_UNITSPATH_INVALID: public std::runtime_error { public:
/// TODO Expand to detect when a directory path is supplied for units_path or plan_path and import all Tasks and Units.
///
/// \param filename - The filename to load the configuration from.
Conf::Conf( std::string filename ): JSON_Loader()
Conf::Conf( std::string filename, bool verbose ): JSON_Loader()
{
// load the conf file.
this->load_json_file( filename, true );
this->load_json_file( filename, verbose );
// find the path to the plan file
if (this->get_serialized(this->plan_path, "plan_path", true) != 0 ) { throw CONF_PLANPATH_INVALID(); }

View File

@ -13,7 +13,7 @@ private:
Json::Value units_path;
public:
Conf( std::string filename );
Conf( std::string filename, bool verbose );
std::string get_plan_path();
std::string get_units_path();
};

View File

@ -107,3 +107,19 @@ void Plan::load_definitions( Suite unit_definitions, bool verbose )
this->tasks[i].load_definition( tmp_U, verbose );
}
}
/// Plan::execute() - Iterates through all tasks in a plan and executes them.
///
/// \param verbose
void Plan::execute( bool verbose )
{
// for each task in this plan
for ( int i = 0; i < this->tasks.size(); i++ )
{
if ( verbose ) {
std::cout << "Executing task \"" << this->tasks[i].get_name() << "\"." << std::endl;
}
this->tasks[i].execute( verbose );
}
}

View File

@ -28,7 +28,10 @@ class Plan: public JSON_Loader
void load_definitions( Suite unit_definitions, bool verbose );
// fetch a corresponding Unit to a Task
void get_definition_from_task(Unit & result, Task input, bool verbose );
// void get_definition_from_task(Unit & result, Task input, bool verbose );
// execute all tasks in this plan
void execute( bool verbose );
};
#endif //FTESTS_PLAN_H

View File

@ -5,6 +5,12 @@ class Task_InvalidDataStructure: public std::runtime_error { public:
Task_InvalidDataStructure(): std::runtime_error("Task: Attempted to access a member of a Task that is not set.") {}
};
/// Task_InvalidDataStructure - Exception thrown when a Task is defined with invalid JSON.
class Task_NotReady: public std::runtime_error { public:
Task_NotReady(): std::runtime_error("Task: Attempted to access a unit of a Task that is not defined.") {}
};
/// Task::Task() - Constructor for the Task class. The Task is the building block of a Plan indicating of which Unit to
/// execute, and its dependencies on other units to have already been completed successfully.
Task::Task() {
@ -74,3 +80,19 @@ bool Task::is_complete() {
bool Task::has_definition() {
return this->defined;
}
/// Task::execute - execute a task's unit definition.
void Task::execute( bool verbose )
{
// throw if unit not coupled
if (! this->has_definition() ) { throw Task_NotReady(); }
if ( verbose )
{
std::cout << "\t Using unit \"" << this->definition.get_name() << "\"." << std::endl;
std::cout << "\t Executing target \"" << this->definition.get_target() << "\"." << std::endl;
}
}

View File

@ -39,6 +39,9 @@ class Task
// fetch the name of a task
std::string get_name();
// execute this task's definition
void execute( bool verbose );
};
#endif //FTESTS_TASK_H