Compare commits

...

32 Commits

Author SHA1 Message Date
phanes 879f07ec4b interpolate issue resolved 2024-02-10 16:44:21 -05:00
phanes 54d95aa582 fixing interpolation/environment var lifecycle issue 2024-02-10 08:43:37 -05:00
phanes 698ba9373c cleaning up interpolation 2024-02-09 01:20:17 -05:00
phanes d13793954d possible fix for buffering issue 2024-02-08 15:12:59 -05:00
phanes e9fd8c80bc possible fix for buffering issue 2024-02-08 15:04:52 -05:00
phanes d15847dbfe working on issue with pty redirection, not easily reproducible 2024-02-08 07:23:01 -05:00
phanes 60a9f2bad2 working on issue with pty redirection, not easily reproducible 2024-02-08 07:04:28 -05:00
phanes e03a7e67b8 ack 2024-02-08 06:56:35 -05:00
phanes 0561460b54 fixed nonsense with truncation 2024-02-08 06:15:06 -05:00
phanes 344cbfc56e fixed nonsense with truncation 2024-02-08 05:57:09 -05:00
Christopher M. Punches bb324087a8 Update src/lcpex/helpers.h 2024-02-08 10:45:26 +00:00
Christopher M. Punches 0f35e752d3 Update src/lcpex/helpers.h 2024-02-08 10:44:33 +00:00
Christopher M. Punches cddc271ac7 Update src/lcpex/liblcpex.cpp 2024-02-08 10:43:46 +00:00
Christopher M. Punches 2904e9dcd8 Update src/misc/helpers.h 2024-02-08 10:43:19 +00:00
Christopher M. Punches 7a816d5920 Update src/misc/helpers.cpp 2024-02-08 10:43:01 +00:00
Christopher M. Punches f510f2b8cc Update src/lcpex/vpty/libclpex_tty.cpp 2024-02-08 10:41:58 +00:00
Christopher M. Punches 67ab74a8c8 Update src/lcpex/vpty/libclpex_tty.cpp 2024-02-08 10:40:57 +00:00
Christopher M. Punches d4d5a2b30d Update src/lcpex/vpty/libclpex_tty.cpp 2024-02-08 10:34:17 +00:00
Christopher M. Punches bb466185d0 Update src/lcpex/liblcpex.cpp 2024-02-08 10:24:51 +00:00
Christopher M. Punches e16c663b5f Update src/lcpex/liblcpex.cpp 2024-02-08 10:15:38 +00:00
Christopher M. Punches 96e7cae5df Update src/lcpex/liblcpex.cpp 2024-02-08 10:10:28 +00:00
Christopher M. Punches 74bce85f1e Update src/lcpex/liblcpex.cpp 2024-02-08 10:02:53 +00:00
Christopher M. Punches e9556c6075 Update src/lcpex/liblcpex.cpp 2024-02-08 09:53:32 +00:00
phanes 130d539f81 more interpolation 2024-02-07 01:42:30 -05:00
phanes 35248176cb interpolation for task values 2024-02-07 00:55:41 -05:00
Christopher M. Punches 5f8ec22166 Update src/config/Config.h 2024-02-07 05:25:59 +00:00
Christopher M. Punches 9a33086cdd Update src/config/Config.h 2024-02-07 05:25:10 +00:00
Christopher M. Punches b439959413 Update 'src/config/Config.cpp' 2023-02-19 01:05:55 +00:00
phanes d0fbd30f31 prep for point release 2023-02-17 03:21:24 -05:00
phanes 004addd2b4 error handling for log file handle 2023-02-16 03:49:56 -05:00
phanes 79bc82e365 shell attribute fix 2023-02-16 03:27:16 -05:00
phanes c129f72b91 log path fix 2023-02-16 03:06:32 -05:00
31 changed files with 284 additions and 137 deletions

3
.gitignore vendored
View File

@ -6,4 +6,5 @@ cmake-build-debug
cmake-build-release
CMakeFiles
CMakeLists.txt
Makefile
Makefile
sample/logs/*

View File

@ -3,4 +3,4 @@ project(rex)
set(CMAKE_CXX_STANDARD 14)
add_executable(rex Rex.cpp src/json_support/jsoncpp/json.h src/json_support/jsoncpp/json-forwards.h src/json_support/jsoncpp/jsoncpp.cpp src/logger/Logger.cpp src/logger/Logger.h src/json_support/JSON.cpp src/json_support/JSON.h src/misc/helpers.cpp src/misc/helpers.h src/config/Config.cpp src/config/Config.h src/suite/Suite.cpp src/suite/Suite.h src/suite/Unit.cpp src/suite/Unit.h src/shells/shells.cpp src/shells/shells.h src/plan/Plan.cpp src/plan/Plan.h src/plan/Task.cpp src/plan/Task.h src/lcpex/liblcpex.h src/lcpex/liblcpex.cpp src/lcpex/vpty/libclpex_tty.h src/lcpex/vpty/libclpex_tty.cpp src/lcpex/Contexts.h src/lcpex/Contexts.cpp src/lcpex/helpers.h src/lcpex/string_expansion/string_expansion.h src/lcpex/string_expansion/string_expansion.cpp src/lcpex/vpty/pty_fork_mod/pty_fork.h src/lcpex/vpty/pty_fork_mod/pty_fork.cpp src/lcpex/vpty/pty_fork_mod/pty_master_open.h src/lcpex/vpty/pty_fork_mod/pty_master_open.cpp src/lcpex/vpty/pty_fork_mod/tty_functions.h src/lcpex/vpty/pty_fork_mod/tty_functions.cpp )
add_executable(rex Rex.cpp src/json_support/jsoncpp/json.h src/json_support/jsoncpp/json-forwards.h src/json_support/jsoncpp/jsoncpp.cpp src/logger/Logger.cpp src/logger/Logger.h src/json_support/JSON.cpp src/json_support/JSON.h src/misc/helpers.cpp src/misc/helpers.h src/config/Config.cpp src/config/Config.h src/suite/Suite.cpp src/suite/Suite.h src/suite/Unit.cpp src/suite/Unit.h src/shells/shells.cpp src/shells/shells.h src/plan/Plan.cpp src/plan/Plan.h src/plan/Task.cpp src/plan/Task.h src/lcpex/helpers.h src/lcpex/helpers.cpp src/lcpex/liblcpex.h src/lcpex/liblcpex.cpp src/lcpex/vpty/libclpex_tty.h src/lcpex/vpty/libclpex_tty.cpp src/lcpex/Contexts.h src/lcpex/Contexts.cpp src/lcpex/helpers.h src/lcpex/string_expansion/string_expansion.h src/lcpex/string_expansion/string_expansion.cpp src/lcpex/vpty/pty_fork_mod/pty_fork.h src/lcpex/vpty/pty_fork_mod/pty_fork.cpp src/lcpex/vpty/pty_fork_mod/pty_master_open.h src/lcpex/vpty/pty_fork_mod/pty_master_open.cpp src/lcpex/vpty/pty_fork_mod/tty_functions.h src/lcpex/vpty/pty_fork_mod/tty_functions.cpp )

View File

@ -15,12 +15,15 @@
*/
#include <iostream>
#include <string>
#include <cstring>
#include <unistd.h>
#include <getopt.h>
#include "src/logger/Logger.h"
#include "src/config/Config.h"
#include "src/suite/Suite.h"
#include "src/plan/Plan.h"
#include "src/misc/helpers.h"
void version_info()
{
@ -162,6 +165,8 @@ int main( int argc, char * argv[] )
interpolate( config_path );
interpolate( plan_path );
plan_path = get_absolute_path( plan_path );
// default logging level
int L_LEVEL = E_INFO;

View File

@ -1,5 +1,8 @@
#!/bin/bash
echo "This is an independent test. It does not depend on other tests."
echo "Environment file check: TEST_VAR from environment file is set to: $TEST_VAR"
#!/usr/bin/bash
#
echo test from script
#/usr/bin/dialog --title "This should be one argument" --inputbox "Enter your name:" 0 0
exit $?
env

View File

@ -1,11 +1,8 @@
#!/usr/bin/bash
set -a
echo "variables file says hello and set a variable named TEST_VAR"
TEST_VAR="999"
TERM=xterm

View File

@ -1,2 +0,0 @@
lcpex: setgid failed: Operation not permitted
lcpex: Aborting: Setting GID failed: bagira/bagira

View File

@ -1 +0,0 @@
/usr/bin/bash: line 1: /home/phanes/development/internal/rex-rewrite/sample/environments/rex.variables: Permission denied

View File

@ -1 +0,0 @@
/usr/bin/bash: line 1: /home/phanes/development/internal/rex-rewrite/sample/environments/rex.variables: Permission denied

0
sample/plans/atomic.plan Normal file → Executable file
View File

3
sample/plans/test.plan Normal file → Executable file
View File

@ -1,5 +1,6 @@
{
"plan": [
{ "name": "independent test 1", "dependencies": [ null ] }
{ "name": "independent test 1", "dependencies": [ null ] },
{ "name": "independent test 2", "dependencies": [ null ] }
]
}

2
sample/rex.config Normal file → Executable file
View File

@ -1,6 +1,6 @@
{
"config": {
"project_root": "/home/phanes/development/internal/rex-rewrite/sample",
"project_root": "$HOME/development/internal/rex/sample",
"units_path": "units/",
"logs_path": "logs/",
"shells_path": "shells/shells.definitions",

0
sample/shells/shells.definitions Normal file → Executable file
View File

Binary file not shown.

22
sample/units/new.units Normal file → Executable file
View File

@ -13,8 +13,26 @@
"active": true,
"required": true,
"set_user_context": true,
"user": "bagira",
"group": "bagira",
"user": "$USER",
"group": "$USER",
"supply_environment": true,
"environment": "environments/rex.variables"
},
{
"name": "independent test 2",
"target": "components/independent_test_1.bash --ls -s --arg",
"is_shell_command": true,
"shell_definition": "bash",
"force_pty": true,
"set_working_directory": false,
"working_directory": "",
"rectify": false,
"rectifier": "echo rectifier executed",
"active": true,
"required": true,
"set_user_context": true,
"user": "$USER",
"group": "$USER",
"supply_environment": true,
"environment": "environments/rex.variables"
}

View File

@ -72,7 +72,7 @@ void Conf::set_object_s(std::string keyname, std::string & object_member, std::s
if ( this->get_string(jval_s, keyname) != 0) {
throw ConfigLoadException( "'" + keyname + "' string is not set in the config file supplied: " + filename );
} else {
interpolate(jval_s);
//interpolate(jval_s);
object_member = jval_s;
}
this->slog.log_task( E_DEBUG, "SET_PROPERTY", "'" + keyname + "': " + object_member );
@ -101,7 +101,7 @@ void Conf::set_object_s_derivedpath(std::string keyname, std::string & object_me
if ( this->get_string(jval_s, keyname) != 0) {
throw ConfigLoadException( "'" + keyname + "' string is not set in the config file supplied: " + filename );
} else {
interpolate(jval_s);
//interpolate(jval_s);
object_member = prepend_project_root( jval_s );
}
this->slog.log_task( E_DEBUG, "SET_PROPERTY", "'" + keyname + "': " + object_member );
@ -134,6 +134,12 @@ void Conf::set_object_b(std::string keyname, bool & object_member, std::string f
this->slog.log_task( E_DEBUG, "SET_PROPERTY", "'" + keyname + "' " + std::to_string(object_member));
}
void removeTrailingSlash(std::string &str) {
if (!str.empty() && str.back() == '/') {
str.pop_back();
}
}
/**
* @brief Prepend the project root to a relative path
*
@ -147,32 +153,11 @@ void Conf::set_object_b(std::string keyname, bool & object_member, std::string f
*/
std::string Conf::prepend_project_root( std::string relative_path)
{
removeTrailingSlash(relative_path);
return this->project_root + "/" + relative_path;
}
/**
* @brief Get the absolute path from a relative path
*
* This function takes a relative path and returns the corresponding absolute path.
* The absolute path is obtained by calling the `realpath` function.
* If the `realpath` function returns a null pointer, an error message is printed to the standard error stream and an empty string is returned.
*
* @param relative_path The relative path to be converted to an absolute path
*
* @return The absolute path corresponding to the relative path
*/
std::string get_absolute_path(const std::string &relative_path)
{
char resolved_path[1024];
memset(resolved_path, 0, sizeof(resolved_path));
if( realpath( relative_path.c_str(), resolved_path) == nullptr ) {
std::cerr << "Error resolving path: " << relative_path << std::endl;
return "";
}
return std::string(resolved_path);
}
/**
* @brief Check if a path exists
@ -231,7 +216,7 @@ void Conf::load_shells() {
{
tmp_S.load_root( jbuff[index] );
this->shells.push_back( tmp_S );
this->slog.log_task( E_DEBUG, "SHELLS", "Loaded shell: '" + tmp_S.name + "'" );
this->slog.log_task( E_DEBUG, "SHELLS", "Loaded shell: '" + tmp_S.name + "' (" + tmp_S.path + ")" );
}
}
@ -258,7 +243,6 @@ Shell Conf::get_shell_by_name( std::string name ) {
throw ConfigLoadException("The shell specified ('" + name + "') is not defined in the shell definitions file.");
}
/**
* @class Conf
* @brief Loads the configuration for the application
@ -276,9 +260,9 @@ Shell Conf::get_shell_by_name( std::string name ) {
Conf::Conf(std::string filename, int LOG_LEVEL ): JSON_Loader(LOG_LEVEL ), slog(LOG_LEVEL, "_conf_" )
{
this->LOG_LEVEL = LOG_LEVEL;
this->slog.log_task( E_DEBUG, "LOAD", "Loading configuration file: " + filename );
interpolate( filename );
this->slog.log_task( E_DEBUG, "LOAD", "Loading configuration file: " + filename );
try {
// load the test file.
@ -287,6 +271,7 @@ Conf::Conf(std::string filename, int LOG_LEVEL ): JSON_Loader(LOG_LEVEL ), slog(
this->slog.log( E_FATAL, "Unable to load configuration file: '" + filename + "'. Error: " + e.what());
throw ConfigLoadException("Parsing error in configuration file.");
}
Json::Value jbuff;
if ( this->get_serialized( jbuff, "config" ) != 0) {
@ -297,20 +282,27 @@ Conf::Conf(std::string filename, int LOG_LEVEL ): JSON_Loader(LOG_LEVEL ), slog(
this->json_root = jbuff;
}
set_object_s( "project_root", this->project_root, filename );
set_object_s( "project_root", this->project_root, filename );
interpolate( this->project_root );
// convert to an absolute path after all the interpolation is done.
this->project_root = get_absolute_path( this->project_root );
set_object_s( "logs_path", this->logs_path, filename );
interpolate( this->logs_path );
// all other paths are relative to project_root
set_object_s_derivedpath( "units_path", this->units_path, filename );
set_object_s_derivedpath( "logs_path", this->logs_path, filename );
set_object_s_derivedpath( "shells_path", this->shell_definitions_path, filename );
set_object_s_derivedpath( "units_path", this->units_path, filename );
interpolate( this->units_path );
set_object_s_derivedpath( "shells_path", this->shell_definitions_path, filename );
interpolate( this->shell_definitions_path );
// ensure these paths exists, with exception to the logs_path, which will be created at runtime
this->slog.log_task( E_DEBUG, "SANITY_CHECKS", "Checking for sanity..." );
checkPathExists( "project_root", this->project_root );
checkPathExists( "units_path", this->units_path );
checkPathExists( "shells_path", this->shell_definitions_path );
checkPathExists( "project_root", this->project_root );
checkPathExists( "units_path", this->units_path );
checkPathExists( "shells_path", this->shell_definitions_path );
// shells are scoped beyond plan so they need to be considered part of config
load_shells();

15
src/lcpex/helpers.cpp Normal file
View File

@ -0,0 +1,15 @@
#include "helpers.h"
ssize_t write_all(int fd, const void *buf, size_t count) {
const char *p = (const char *)buf;
while (count > 0) {
ssize_t written = write(fd, p, count);
if (written == -1) {
if (errno == EINTR || errno == EAGAIN) continue; // Retry
return -1; // Other errors
}
count -= written;
p += written;
}
return 0;
}

View File

@ -1,6 +1,9 @@
#ifndef LCPEX_HELPERS_H
#define LCPEX_HELPERS_H
#include <unistd.h>
#include "errno.h"
// helper for sanity
enum PIPE_ENDS {
READ_END = 0,
@ -16,6 +19,6 @@ enum CHILD_PIPE_NAMES {
#define BUFFER_SIZE 1024
ssize_t write_all(int fd, const void *buf, size_t count);
#endif //LCPEX_HELPERS_H

View File

@ -1,5 +1,6 @@
#include "liblcpex.h"
std::string prefix_generator(
std::string command,
bool is_shell_command,
@ -16,7 +17,8 @@ std::string prefix_generator(
prefix = shell_path;
// if the shell takes an argument to execute a command, add it enclosed in quotes
if (shell_execution_arg != "") {
if ( shell_execution_arg != "" )
{
// add the execution arg
prefix += " " + shell_execution_arg + " ";
} else {
@ -35,15 +37,15 @@ std::string prefix_generator(
// it's not a shell command, so we can just execute it directly
prefix = command;
}
std::cout << "prefix: " << prefix << std::endl;
std::cout << "LAUNCHER: " << prefix << std::endl;
return prefix;
}
int lcpex(
std::string command,
std::string stdout_log_file,
std::string stderr_log_file,
FILE * stdout_log_fh,
FILE * stderr_log_fh,
bool context_override,
std::string context_user,
std::string context_group,
@ -71,11 +73,11 @@ int lcpex(
// if we are forcing a pty, then we will use the vpty library
if( force_pty )
{
return exec_pty( command, stdout_log_file, stderr_log_file, context_override, context_user, context_group, supply_environment );
return exec_pty( command, stdout_log_fh, stderr_log_fh, context_override, context_user, context_group, supply_environment );
}
// otherwise, we will use the execute function
return execute( command, stdout_log_file, stderr_log_file, context_override, context_user, context_group, supply_environment );
return execute( command, stdout_log_fh, stderr_log_fh, context_override, context_user, context_group, supply_environment );
}
/**
@ -130,23 +132,23 @@ void run_child_process(bool context_override, const char* context_user, const ch
case IDENTITY_CONTEXT_ERRORS::ERROR_NONE:
break;
case IDENTITY_CONTEXT_ERRORS::ERROR_NO_SUCH_USER:
std::cerr << "lcpex: Aborting: context user not found: " << context_user << std::endl;
std::cerr << "REX: Aborting: context user not found: " << context_user << std::endl;
exit(1);
break;
case IDENTITY_CONTEXT_ERRORS::ERROR_NO_SUCH_GROUP:
std::cerr << "lcpex: Aborting: context group not found: " << context_group << std::endl;
std::cerr << "REX: Aborting: context group not found: " << context_group << std::endl;
exit(1);
break;
case IDENTITY_CONTEXT_ERRORS::ERROR_SETGID_FAILED:
std::cerr << "lcpex: Aborting: Setting GID failed: " << context_user << "/" << context_group << std::endl;
std::cerr << "REX: Aborting: Setting GID failed: " << context_user << "/" << context_group << std::endl;
exit(1);
break;
case IDENTITY_CONTEXT_ERRORS::ERROR_SETUID_FAILED:
std::cerr << "lcpex: Aborting: Setting UID failed: " << context_user << "/" << context_group << std::endl;
std::cerr << "REX: Aborting: Setting UID failed: " << context_user << "/" << context_group << std::endl;
exit(1);
break;
default:
std::cerr << "lcpex: Aborting: Unknown error while setting identity context." << std::endl;
std::cerr << "REX: Aborting: Unknown error while setting identity context." << std::endl;
exit(1);
break;
}
@ -160,8 +162,8 @@ void run_child_process(bool context_override, const char* context_user, const ch
int execute(
std::string command,
std::string stdout_log_file,
std::string stderr_log_file,
FILE * stdout_log_fh,
FILE * stderr_log_fh,
bool context_override,
std::string context_user,
std::string context_group,
@ -179,13 +181,10 @@ int execute(
// before we fork the process, so that the child process will inherit the environment
// from the parent process
if ( environment_supplied ) {
clearenv();
// this breaks reuse of env variables in between executions
//clearenv();
}
// open file handles to the two log files we need to create for each execution
FILE * stdout_log_fh = fopen( stdout_log_file.c_str(), "a+" );
FILE * stderr_log_fh = fopen( stderr_log_file.c_str(), "a+" );
// create the pipes for the child process to write and read from using its stdin/stdout/stderr
int fd_child_stdout_pipe[2];
int fd_child_stderr_pipe[2];
@ -268,6 +267,12 @@ int execute(
// loop until we've read all the data from the child process
while ( ! break_out ) {
num_files_readable = poll(watched_fds, sizeof(watched_fds) / sizeof(watched_fds[0]), -1);
// after the poll() call, add a check to see if both pipes are closed
if (!(watched_fds[CHILD_PIPE_NAMES::STDOUT_READ].events & POLLIN) &&
!(watched_fds[CHILD_PIPE_NAMES::STDERR_READ].events & POLLIN)) {
break_out = true;
}
if (num_files_readable == -1) {
// error occurred in poll()
perror("poll");
@ -284,9 +289,12 @@ int execute(
byte_count = read(watched_fds[this_fd].fd, buf, BUFFER_SIZE);
if (byte_count == -1) {
// error reading from pipe
perror("read");
exit(EXIT_FAILURE);
if (errno == EAGAIN) { continue; } else {
// error reading from pipe
perror("read");
exit(EXIT_FAILURE);
}
} else if (byte_count == 0) {
// reached EOF on one of the streams but not a HUP
// we've read all we can this cycle, so go to the next fd in the for loop
@ -296,12 +304,12 @@ int execute(
// write to stdout,stderr
if (this_fd == CHILD_PIPE_NAMES::STDOUT_READ) {
// the child's stdout pipe is readable
write(stdout_log_fh->_fileno, buf, byte_count);
write(STDOUT_FILENO, buf, byte_count);
write_all(stdout_log_fh->_fileno, buf, byte_count);
write_all(STDOUT_FILENO, buf, byte_count);
} else if (this_fd == CHILD_PIPE_NAMES::STDERR_READ) {
// the child's stderr pipe is readable
write(stderr_log_fh->_fileno, buf, byte_count);
write(STDERR_FILENO, buf, byte_count);
write_all(stderr_log_fh->_fileno, buf, byte_count);
write_all(STDERR_FILENO, buf, byte_count);
} else {
// this should never happen
perror("Logic error!");
@ -315,18 +323,25 @@ int execute(
}
if (watched_fds[this_fd].revents & POLLHUP) {
// this pipe has hung up
close(watched_fds[this_fd].fd);
break_out = true;
// don't close the file descriptor yet, there might still be data to read
// instead, remove the POLLIN event to avoid getting a POLLHUP event in the next poll() call
watched_fds[this_fd].events &= ~POLLIN;
}
}
}
// wait for child to exit, capture status
waitpid(pid, &status, 0);
// close the log file handles
fclose(stdout_log_fh);
fclose(stderr_log_fh);
// Drain the pipes before exiting
while ((byte_count = read(fd_child_stdout_pipe[READ_END], buf, BUFFER_SIZE)) > 0) {
write_all(stdout_log_fh->_fileno, buf, byte_count);
write_all(STDOUT_FILENO, buf, byte_count);
}
while ((byte_count = read(fd_child_stderr_pipe[READ_END], buf, BUFFER_SIZE)) > 0) {
write_all(stderr_log_fh->_fileno, buf, byte_count);
write_all(STDERR_FILENO, buf, byte_count);
}
if WIFEXITED(status) {
return WEXITSTATUS(status);
} else {

View File

@ -39,8 +39,8 @@
*/
int execute(
std::string command,
std::string stdout_log_file,
std::string stderr_log_file,
FILE * stdout_log_fh,
FILE * stderr_log_fh,
bool context_override,
std::string context_user,
std::string context_group,
@ -76,8 +76,8 @@ int execute(
*/
int lcpex(
std::string command,
std::string stdout_log_file,
std::string stderr_log_file,
FILE * stdout_log_fh,
FILE * stderr_log_fh,
bool context_override,
std::string context_user,
std::string context_group,

View File

@ -1,5 +1,7 @@
#include "string_expansion.h"
// convert a string to a char** representing our artificial argv to be consumed by execvp
char ** expand_env(const std::string& var, int flags )
{

View File

@ -83,7 +83,7 @@ void run_child_process( int fd_child_stderr_pipe[2], char * processed_command[],
// execute the dang command, print to stdout, stderr (of parent), and dump to file for each!!!!
// (and capture exit code in parent)
int exit_code = execvp(processed_command[0], processed_command);
int exit_code = execvp( processed_command[0], processed_command );
safe_perror("failed on execvp in child", ttyOrig );
exit(exit_code);
}
@ -94,8 +94,8 @@ void run_child_process( int fd_child_stderr_pipe[2], char * processed_command[],
// - TEE child stdout/stderr to parent stdout/stderr
int exec_pty(
std::string command,
std::string stdout_log_file,
std::string stderr_log_file,
FILE * stdout_log_fh,
FILE * stderr_log_fh,
bool context_override,
std::string context_user,
std::string context_group,
@ -108,15 +108,22 @@ int exec_pty(
// before we fork the process, so that the child process will inherit the environment
// from the parent process
if ( environment_supplied ) {
clearenv();
//clearenv();
}
// turn our command string into something execvp can consume
char ** processed_command = expand_env(command );
char ** processed_command = expand_env( command );
if ( stdout_log_fh == NULL ) {
safe_perror( "Error opening STDOUT log file. Aborting.", &ttyOrig );
exit( 1 );
}
if ( stderr_log_fh == NULL ) {
safe_perror( "Error opening STDERR log file. Aborting.", &ttyOrig );
exit( 1 );
}
// open file handles to the two log files we need to create for each execution
FILE * stdout_log_fh = fopen( stdout_log_file.c_str(), "a+" );
FILE * stderr_log_fh = fopen( stderr_log_file.c_str(), "a+" );
// create the pipes for the child process to write and read from using its stderr
int fd_child_stderr_pipe[2];
@ -204,6 +211,11 @@ int exec_pty(
// loop until we've read all the data from the child process
while ( ! break_out ) {
num_files_readable = poll(watched_fds, sizeof(watched_fds) / sizeof(watched_fds[0]), -1);
// after the poll() call, add a check to see if both pipes are closed
if (!(watched_fds[1].events & POLLIN) &&
!(watched_fds[2].events & POLLIN)) {
break_out = true;
}
if (num_files_readable == -1) {
// error occurred in poll()
@ -223,9 +235,11 @@ int exec_pty(
byte_count = read(watched_fds[this_fd].fd, buf, BUFFER_SIZE);
if (byte_count == -1) {
// error reading from pipe
safe_perror("read", &ttyOrig );
exit(EXIT_FAILURE);
if (errno == EAGAIN) { continue; } else {
// error reading from pipe
safe_perror("read", &ttyOrig );
exit(EXIT_FAILURE);
}
} else if (byte_count == 0) {
// reached EOF on one of the streams but not a HUP
// we've read all we can this cycle, so go to the next fd in the for loop
@ -233,17 +247,18 @@ int exec_pty(
} else {
// byte count was sane
// write to stdout,stderr
if (this_fd == 0) {
// parent stdin received, write to child pty (stdin)
write(masterFd, buf, byte_count);
write_all(masterFd, buf, byte_count);
} else if (this_fd == 1 ) {
// child pty sent some stuff, write to parent stdout and log
write(stdout_log_fh->_fileno, buf, byte_count);
write(STDOUT_FILENO, buf, byte_count);
write_all(stdout_log_fh->_fileno, buf, byte_count);
write_all(STDOUT_FILENO, buf, byte_count);
} else if ( this_fd == 2 ){
//the child's stderr pipe sent some stuff, write to parent stderr and log
write(stderr_log_fh->_fileno, buf, byte_count);
write(STDERR_FILENO, buf, byte_count);
write_all(stderr_log_fh->_fileno, buf, byte_count);
write_all(STDERR_FILENO, buf, byte_count);
} else {
// this should never happen
perror("Logic error!");
@ -252,24 +267,37 @@ int exec_pty(
}
}
if (watched_fds[this_fd].revents & POLLERR) {
close(watched_fds[this_fd].fd);
//break_out = true;
continue;
//close(watched_fds[this_fd].fd);
break_out = true;
//continue;
}
// if (watched_fds[this_fd].revents & POLLHUP) {
// // this pipe has hung up
// close(watched_fds[this_fd].fd);
// break_out = true;
// break;
// }
if (watched_fds[this_fd].revents & POLLHUP) {
// this pipe has hung up
close(watched_fds[this_fd].fd);
break_out = true;
break;
// don't close the file descriptor yet, there might still be data to read
// instead, remove the POLLIN event to avoid getting a POLLHUP event in the next poll() call
watched_fds[this_fd].events &= ~POLLIN;
}
}
}
// wait for child to exit, capture status
waitpid(pid, &status, 0);
// close the log file handles
fclose(stdout_log_fh);
fclose(stderr_log_fh);
while ((byte_count = read(watched_fds[1].fd, buf, BUFFER_SIZE)) > 0) {
write_all(stdout_log_fh->_fileno, buf, byte_count);
write_all(STDOUT_FILENO, buf, byte_count);
}
while ((byte_count = read(fd_child_stderr_pipe[READ_END], buf, BUFFER_SIZE)) > 0) {
write_all(stderr_log_fh->_fileno, buf, byte_count);
write_all(STDERR_FILENO, buf, byte_count);
}
ttyResetExit( &ttyOrig);
if WIFEXITED(status) {
return WEXITSTATUS(status);
@ -278,5 +306,4 @@ int exec_pty(
}
}
}
}
}

View File

@ -38,8 +38,8 @@
*/
int exec_pty(
std::string command,
std::string stdout_log_file,
std::string stderr_log_file,
FILE * stdout_log_fh,
FILE * stderr_log_fh,
bool context_override,
std::string context_user,
std::string context_group,

View File

@ -96,19 +96,57 @@ std::string get_8601()
* @brief Interpolates the environment variables in the input text
*
* This function takes a string reference as input and replaces all occurrences of
* environment variables in the format `${VAR_NAME}` with their corresponding values.
* environment variables in the format `${VAR_NAME}` or `$VAR_NAME` with their corresponding values.
* If an environment variable is not set, it is replaced with an empty string.
*
* @param text The input text to be processed
*/
//void interpolate( std::string & text )
//{
// static std::regex env1( "\\$\\{([^}]+)\\}" );
// static std::regex env2( "\\$([^/]+)" ); // matches $VAR_NAME until a / is found
// std::smatch match;
// while ( std::regex_search( text, match, env1 ) || std::regex_search( text, match, env2 ) )
// {
// const char * s = getenv( match[1].str().c_str() );
// const std::string var( s == NULL ? "" : s );
// text.replace( match[0].first, match[0].second, var );
// }
//}
void interpolate( std::string & text )
{
static std::regex env( "\\$\\{([^}]+)\\}" );
std::regex env1( "\\$\\{([^}]+)\\}" );
std::regex env2( "\\$([^/]+)" ); // matches $VAR_NAME until a / is found
std::smatch match;
while ( std::regex_search( text, match, env ) )
while ( std::regex_search( text, match, env1 ) || std::regex_search( text, match, env2 ) )
{
const char * s = getenv( match[1].str().c_str() );
const std::string var( s == NULL ? "" : s );
text.replace( match[0].first, match[0].second, var );
}
}
/**
* @brief Get the absolute path from a relative path
*
* This function takes a relative path and returns the corresponding absolute path.
* The absolute path is obtained by calling the `realpath` function.
* If the `realpath` function returns a null pointer, an error message is printed to the standard error stream and an empty string is returned.
*
* @param relative_path The relative path to be converted to an absolute path
*
* @return The absolute path corresponding to the relative path
*/
std::string get_absolute_path(const std::string &relative_path)
{
char resolved_path[1024];
memset(resolved_path, 0, sizeof(resolved_path));
if( realpath( relative_path.c_str(), resolved_path) == nullptr ) {
std::cerr << "Error resolving path: " << relative_path << std::endl;
return "";
}
return std::string(resolved_path);
}

View File

@ -23,6 +23,9 @@
#define REX_HELPERS_H
#include <string>
#include <cstring>
#include <string.h>
#include <sys/stat.h>
#include <sys/param.h>
#include <unistd.h>
@ -51,4 +54,17 @@ std::string get_8601();
const char * command2args( std::string input_string );
/**
* @brief Get the absolute path from a relative path
*
* This function takes a relative path and returns the corresponding absolute path.
* The absolute path is obtained by calling the `realpath` function.
* If the `realpath` function returns a null pointer, an error message is printed to the standard error stream and an empty string is returned.
*
* @param relative_path The relative path to be converted to an absolute path
*
* @return The absolute path corresponding to the relative path
*/
std::string get_absolute_path(const std::string &relative_path);
#endif //REX_HELPERS_H

View File

@ -307,7 +307,7 @@ bool createDirectory(const std::string& path) {
return true;
}
bool Task::prepare_logs( std::string task_name, std::string logs_root, std::string timestamp )
bool Task::prepare_logs( std::string task_name, std::string logs_root )
{
std::string full_path = logs_root + "/" + task_name;
bool ret = false;
@ -354,8 +354,19 @@ void Task::execute( Conf * configuration )
std::string environment_file = this->definition.get_environment_file();
std::string logs_root = configuration->get_logs_path();
interpolate(task_name);
this->slog.log_task( E_DEBUG, task_name, "Using unit definition: \"" + task_name + "\"." );
interpolate(command);
interpolate(shell_name);
interpolate(user);
interpolate(group);
interpolate(environment_file);
interpolate(new_working_dir);
interpolate(rectifier);
interpolate(logs_root);
// sanitize all path inputs from unit definition to be either absolute paths or relative to
// project_root
@ -407,19 +418,24 @@ void Task::execute( Conf * configuration )
logs_root = configuration->get_project_root() + "/" + logs_root;
}
std::string timestamp = get_8601();
// set these first so the pre-execution logs get there.
/*
* create the logs dir here
*/
if (! this->prepare_logs( task_name, logs_root, timestamp ) )
if (! this->prepare_logs( task_name, logs_root ) )
{
throw TaskException("Could not prepare logs for task execution at '" + logs_root + "'.");
}
std::string stdout_log_file = logs_root + "/" + timestamp + ".stdout.log";
std::string stderr_log_file = logs_root + "/" + timestamp + ".stderr.log";
std::string timestamp = get_8601();
std::string stdout_log_file = logs_root + "/" + task_name + "/" + timestamp + ".stdout.log";
std::string stderr_log_file = logs_root + "/" + task_name + "/" + timestamp + ".stderr.log";
// open file handles to the two log files we need to create for each execution
FILE * stdout_log_fh = fopen( stdout_log_file.c_str(), "a+" );
FILE * stderr_log_fh = fopen( stderr_log_file.c_str(), "a+" );
// check if working directory is to be set
if ( override_working_dir )
@ -443,8 +459,8 @@ void Task::execute( Conf * configuration )
int return_code = lcpex(
command,
stdout_log_file,
stderr_log_file,
stdout_log_fh,
stderr_log_fh,
set_user_context,
user,
group,
@ -457,7 +473,6 @@ void Task::execute( Conf * configuration )
environment_file
);
// **********************************************
// d[0] Error Code Check
// **********************************************
@ -513,8 +528,8 @@ void Task::execute( Conf * configuration )
this->slog.log_task( E_INFO, task_name, "Executing rectification: " + rectifier + "." );
int rectifier_error = lcpex(
rectifier,
stdout_log_file,
stderr_log_file,
stdout_log_fh,
stderr_log_fh,
set_user_context,
user,
group,
@ -565,8 +580,8 @@ void Task::execute( Conf * configuration )
int retry_code = lcpex(
command,
stdout_log_file,
stderr_log_file,
stdout_log_fh,
stderr_log_fh,
set_user_context,
user,
group,
@ -618,4 +633,7 @@ void Task::execute( Conf * configuration )
// end d[1] Rectify Check
// **********************************************
}
// close the log file handles
fclose(stdout_log_fh);
fclose(stderr_log_fh);
}

View File

@ -47,7 +47,7 @@ class Task
// the readiness of this task to execute
bool defined;
bool prepare_logs( std::string task_name, std::string logs_root, std::string timestamp );
bool prepare_logs( std::string task_name, std::string logs_root );
public:

View File

@ -54,11 +54,11 @@ int Shell::load_root( Json::Value loader_root )
throw ShellException("No execution_arg attribute specified when loading a shell definition.");
}
if ( loader_root.isMember("execution_arg") )
if ( loader_root.isMember("source_cmd") )
{
this->execution_arg = loader_root.get( "execution_arg", errmsg ).asString();
this->source_cmd = loader_root.get( "source_cmd", errmsg ).asString();
} else {
throw ShellException("No execution_arg attribute specified when loading a shell definition.");
throw ShellException("No source_cmd attribute specified when loading a shell definition.");
}
return 0;
}

View File

@ -129,7 +129,7 @@ void Suite::get_units_from_dir( std::vector<std::string> * files, std::string pa
// you want here. Something like:
if ( strstr( hFile->d_name, ".units" ))
{
std::string full_path = path + hFile->d_name;
std::string full_path = path + "/" + hFile->d_name;
files->push_back( full_path );
}
}