Made messaging vs non-messaging more flexible

Author: CodeByDrescher

IDAWin/SundialsSolverInterface.cpp

@@ -15,52 +15,6 @@
 #define IDA_SOLVER "IDA"
 
 void activateSolver(std::ifstream& inputFileStream, FILE* outputFile, int taskID) {
-	// std::string solver;
-	//
-	// while (!inputFileStream.eof()) { // Note break statement if "SOLVER" encountered
-	// 	std::string nextToken;
-	// 	inputFileStream >> nextToken;
-	// 	if (nextToken.empty()) continue;
-	// 	if (nextToken[0] == '#') getline(inputFileStream, nextToken);
-	// 	else if (nextToken == "JMS_PARAM_BEGIN") {
-	// 		loadJMSInfo(inputFileStream, taskID);
-	// 		#ifdef USE_MESSAGING
-	// 		SimulationMessaging::getInstVar()->start(); // start the thread
-	// 		#endif
-	// 	} else if (nextToken == "SOLVER") {
-	// 		inputFileStream >> solver;
-	// 		break;
-	// 	}
-	// }
-	// #ifdef USE_MESSAGING
-	// // should only happen during testing for solver compiled with messaging but run locally.
-	// if (SimulationMessaging::getInstVar() == nullptr) { SimulationMessaging::create(); }
-	// #endif
-	//
-	// if (solver.empty()) { throw "Solver not defined "; }
-	// VCellSundialsSolver *vss = nullptr;
-	//
-	// if (solver == IDA_SOLVER) {
-	// 	vss = new VCellIDASolver();
-	// } else if (solver == CVODE_SOLVER) {
-	// 	vss = new VCellCVodeSolver();
-	// } else {
-	// 	std::stringstream ss;
-	// 	ss << "Solver " << solver << " not defined!";
-	// 	throw ss.str();
-	// }
-	//
-	// vss->solve(nullptr, true, outputFile, VCellSundialsSolver::checkStopRequested);
-	// delete vss;
-
-	// Check if we have messaging and a taskID of -1; if so; fail now.
-
-	#ifdef USE_MESSAGING
-	if (taskID < 0) {
-		throw std::runtime_error("task id of value: " + std::to_string(taskID) + " not acceptable when this library is built with messaging");
-	}
-	#endif
-
 	VCellSolver* targetSolver = VCellSolverFactory::produceVCellSolver(inputFileStream, taskID);
 	targetSolver->solve(nullptr, true, outputFile, VCellSundialsSolver::checkStopRequested);
 }

IDAWin/SundialsSolverStandalone.cpp

@@ -36,7 +36,7 @@ int parseAndRunWithArgParse(int argc, char *argv[]) {
 	argumentParser.add_argument("input").help("path to directory with input files.").store_into(inputFilePath);
 	argumentParser.add_argument("output").help("path to directory for output files.").store_into(outputFilePath);
 	#ifdef USE_MESSAGING
-	argumentParser.add_argument("-tid").help("path to solver to run.").store_into(taskID);
+	argumentParser.add_argument("-tid").help("id of the job").store_into(taskID);
 	#endif
 
 	try {

IDAWin/VCellSolverFactory.cpp

@@ -103,6 +103,12 @@ VCellSolverInputBreakdown VCellSolverFactory::parseInputFile(std::ifstream& inpu
 		else throw VCell::Exception("Unexpected token \"" + nextToken + "\" in the input file!");
 
 	}
+
+
+	#ifdef USE_MESSAGING
+	// Since messaging assumes we have a job requiring messaging, we should initialize a "default" messaging handler
+	if (NULL == SimulationMessaging::getInstVar()) SimulationMessaging::create();
+	#endif
 	return inputBreakdown;
 }
 
@@ -191,7 +197,7 @@ static void readEvents(std::istream &inputStream, VCellSolverInputBreakdown& inp
 					//eventComponents.eventAssignments.emplace_back(varIndex, assignmentExpression); // should try this in the future, more descriptive
 				}
 				break;
-			} else { throw VCell::Exception("Unexpected token \"" + token + "\" in the input file!"); }
+			} else { throw VCell::Exception("Unexpected event token \"" + token + "\" in the input file!"); }
 		}
 		inputBreakdown.eventSettings.EVENTS.push_back(std::move(eventComponents));
 	}
@@ -421,13 +427,10 @@ static void collectSteadyStateTerms(std::ifstream& inputFileStream, VCellSolverI
 
 static void loadJMSInfo(std::istream &ifsInput, int taskID) {
 	#ifndef USE_MESSAGING
-	return; // Only useful for messaging; let's not waste time!
-	#else
-
-	if (taskID < 0) {
-		SimulationMessaging::create();
-		return; // No need to do any parsing
-	}
+	// We'll still parse the section, as we can still execute the simulation; we'll just toss the values!
+	std::cerr << "WARNING: Input file expects messaging capabilities; this build does not support JMS messaging!" << std::endl;
+	#endif
+	
 	std::string broker;
 	std::string smqUserName;
 	std::string password;
@@ -459,6 +462,7 @@ static void loadJMSInfo(std::istream &ifsInput, int taskID) {
 		else if (nextToken == "JOB_INDEX") ifsInput >> jobIndex;
 	}
 
+	#ifdef USE_MESSAGING
 	SimulationMessaging::create(broker.c_str(), smqUserName.c_str(),
 								password.c_str(), qName.c_str(), topicName.c_str(),
 								vCellUsername.c_str(), simKey, jobIndex, taskID);

conan-profiles/CI-CD/MacOS-AMD64_profile.txt

@@ -4,5 +4,5 @@ build_type=Release
 compiler=apple-clang
 compiler.cppstd=20
 compiler.libcxx=libc++
-compiler.version=17
+compiler.version=17cd
 os=Macos

tests/unit/smoke_test.cpp

@@ -16,16 +16,13 @@
 
 void compare(const std::filesystem::path& file1, const std::filesystem::path& file2, float tolerance);
 
-
-TEST(SmokeTest, MessagingRequiresJobID) {
-	#ifndef USE_MESSAGING
-	return; // no need to test this
-	#endif
+TEST(SmokeTest, UserProvidesFilesWithoutJMS) {
+	constexpr int taskID = -1, hashID = 1489333437;
 	const std::filesystem::path RESOURCE_DIRECTORY{RESOURCE_DIR};
-	const std::filesystem::path OUTPUT_TARGET{RESOURCE_DIRECTORY /"SimID_1489333437_0_.ida",};
+	const std::filesystem::path OUTPUT_TARGET{RESOURCE_DIRECTORY /std::format("SimID_{}_0_.ida", hashID)};
 	const std::array NECESSARY_FILES{
-		RESOURCE_DIRECTORY /"SimID_1489333437_0_.cvodeInput",
-		RESOURCE_DIRECTORY /"SimID_1489333437_0_.ida.expected"
+		RESOURCE_DIRECTORY /std::format("SimID_{}_0_.cvodeInput", hashID),
+		RESOURCE_DIRECTORY /std::format("SimID_{}_0_.ida.expected", hashID)
 	};
 	for (const auto& file : NECESSARY_FILES) {
 		assert(std::filesystem::exists(file));
@@ -39,16 +36,14 @@ TEST(SmokeTest, MessagingRequiresJobID) {
 		throw std::runtime_error("Could not open output file[" + OUTPUT_TARGET.string() + "] for writing.");
 	}
 
-	EXPECT_THROW(activateSolver(inputFileStream, outputFile, -1), std::runtime_error);
+	activateSolver(inputFileStream, outputFile, taskID);
 	fclose(outputFile);
+
+	compare(OUTPUT_TARGET, NECESSARY_FILES[1], 1e-7);
 }
 
-TEST(SmokeTest, ConfirmExecution) {
-	#ifdef USE_MESSAGING
-	const int taskID = 2025, hashID = 256118677;
-	#else
-	const int taskID = -1, hashID = 1489333437;
-	#endif
+TEST(SmokeTest, UserProvidesFilesWithJMS) {
+	constexpr int taskID = 2025, hashID = 256118677;
 	const std::filesystem::path RESOURCE_DIRECTORY{RESOURCE_DIR};
 	const std::filesystem::path OUTPUT_TARGET{RESOURCE_DIRECTORY /std::format("SimID_{}_0_.ida", hashID)};
 	const std::array NECESSARY_FILES{