review feedback, minor refactoring, added a disabled test in simplectrl

base/include/AbsControlModule.h

@@ -32,11 +32,11 @@ class AbsControlModule : public Module {
 	virtual void handleHealthCallback(const APHealthObject& healthObj);
 	/**
 	 * @brief Register external function to be triggered on every health callBack that control modules recieves from the modules.
-	 * In SimpleControlModule, this extention is called at the end of handleHealthCallback function.
+	 * For eg. In SimpleControlModule, this extention is called at the end of handleHealthCallback function.
 	 * @param function with signature void f(const APHealthObject*, unsigned short)
 	 * @return nothing.
 	 */
-	void register_healthCallback_extention(
+	void registerHealthCallbackExtention(
 		boost::function<void(const APHealthObject*, unsigned short)> callbackFunction);
 protected:
 	bool process(frame_container& frames);

base/include/PipeLine.h

@@ -48,7 +48,7 @@ class PipeLine {
 	void stop();
 	void term();
 	void wait_for_all(bool ignoreStatus = false);
-	void interrup_wait_for_all();
+	void interrupt_wait_for_all();
 	void flushAllQueues(bool flushControlModuleQ=false);
 	const char* getStatus();
 };

base/include/SimpleControlModule.h

@@ -19,7 +19,6 @@ class SimpleControlModule : public AbsControlModule
 	std::string printStatus();
 	void handleError(const APErrorObject &error) override;
     void handleHealthCallback(const APHealthObject &healthObj) override;
-	// ErrorCallbacks
 protected:
 	void sendEOS();
 	void sendEOS(frame_sp& frame);

base/src/AbsControlModule.cpp

@@ -101,7 +101,7 @@ boost::shared_ptr<Module> AbsControlModule::getModuleofRole(std::string role)
 	return moduleWithRole;
 }
 
-void AbsControlModule::register_healthCallback_extention(
+void AbsControlModule::registerHealthCallbackExtention(
 	boost::function<void(const APHealthObject*, unsigned short)> callbackFunction)
 {
 	healthCallbackExtention = callbackFunction;
@@ -129,9 +129,9 @@ std::vector<std::string> AbsControlModule::serializeControlModule()
 		std::string cbStatus = "registered for...\n";
 		if (it.second.lock()->getProps().enableHealthCallBack)
 		{
-			cbStatus += spacedLineFmt + "<health callbacks> \n";
+			cbStatus += spacedLineFmt + "health callbacks \n";
 		}
-		cbStatus += spacedLineFmt + "<error callbacks>";
+		cbStatus += spacedLineFmt + "error callbacks \n";
 		status.push_back(spacedLineFmt + cbStatus);
 	}
 	return status;

base/src/PipeLine.cpp

@@ -106,7 +106,6 @@ bool PipeLine::init()
 	{
 		myStatus = PL_INITFAILED;
 		return false;
-		return false;
 	}
 
 	LOG_TRACE << " Initializing pipeline";
@@ -270,7 +269,7 @@ void PipeLine::wait_for_all(bool ignoreStatus)
 }
 
 
-void PipeLine::interrup_wait_for_all()
+void PipeLine::interrupt_wait_for_all()
 {
 	if (myStatus > PL_STOPPING)
 	{

base/test/simpleControlModuleTests.cpp

@@ -157,7 +157,6 @@ struct SimpleControlModuleTests
 
 		auto metadata = framemetadata_sp(new FrameMetadata(FrameMetadata::GENERAL));
 		sourceMod = boost::shared_ptr<TestModuleSrc>(new TestModuleSrc);
-		//auto source_pin_1 = sourceMod->addOutputPin(metadata);
 
 		/* set transform module health callbacks */
 		TestModuleTransformProps props;
@@ -168,6 +167,10 @@ struct SimpleControlModuleTests
 
 		sinkMod = boost::shared_ptr<TestSink>(new TestSink);
 
+		// pins connection
+		sourceMod->setNext(transformMod1);
+		transformMod1->setNext(sinkMod);
+
 		auto simpleCtrlProps = SimpleControlModuleProps();
 		simpleCtrl = boost::shared_ptr<SimpleControlModule>(new SimpleControlModule(simpleCtrlProps));
 
@@ -248,7 +251,7 @@ void TestCallackExtention(const APHealthObject* healthObj, unsigned int eventId)
 BOOST_AUTO_TEST_CASE(simpleControlModule_healthCallback)
 {
 	SimpleControlModuleTests t;
-	t.simpleCtrl->register_healthCallback_extention(TestCallackExtention);
+	t.simpleCtrl->registerHealthCallbackExtention(TestCallackExtention);
 
 	t.startPipeline();
 	t.addControlModule();
@@ -258,4 +261,60 @@ BOOST_AUTO_TEST_CASE(simpleControlModule_healthCallback)
 	boost::this_thread::sleep_for(boost::chrono::milliseconds(3000));
 }
 
+BOOST_AUTO_TEST_CASE(simpleControlModule_enroll_ctrlMod_step_test, *boost::unit_test::disabled())
+{
+	SimpleControlModuleTests t;
+
+	t.simpleCtrl->registerHealthCallbackExtention(TestCallackExtention);
+	t.addControlModule();
+
+	t.sourceMod->init();
+	t.transformMod1->init();
+	t.sinkMod->init();
+	t.simpleCtrl->init();
+
+	t.sourceMod->step();
+	t.transformMod1->step();
+	t.sinkMod->step();
+
+	t.simpleCtrl->enrollModule("transform_test_module", t.transformMod1);
+	t.simpleCtrl->enrollModule("source_test_module", t.sourceMod);
+
+	// BOOSTASSERT the printStatus for enrollment
+	auto status = t.simpleCtrl->printStatus();
+	BOOST_ASSERT(status.find("transform_test_module") != std::string::npos);
+	BOOST_ASSERT(status.find("source_test_module") != std::string::npos);
+
+	// since we are queueing any command in control module, the step should remain blocked at mQue->pop inside step()
+	// the following code tests exactly that.
+	auto future = std::async(std::launch::async, &SimpleControlModule::step, t.simpleCtrl.get());
+	if (future.wait_for(std::chrono::seconds(2)) == std::future_status::ready)
+	{
+		try
+		{
+			bool result = future.get();
+			LOG_ERROR << "Simple control module step() unexpectedly returned a value <" << result << ">";
+		}
+		catch (const std::exception& e) 
+		{
+			std::cout << "Task threw an exception: " << e.what() << std::endl;
+		}
+		BOOST_ASSERT(false);
+	}
+	BOOST_ASSERT(true);
+
+	t.sourceMod->stop();
+	t.transformMod1->stop();
+	t.sinkMod->stop();
+	t.simpleCtrl->stop();
+
+	t.sourceMod->term();
+	t.transformMod1->term();
+	t.sinkMod->term();
+	t.simpleCtrl->term();
+
+	LOG_INFO << "SUCCESS: do not wait for step() to finish..."; // future.get()
+	return;
+}
+
 BOOST_AUTO_TEST_SUITE_END()