Proposal to remove --app-pid and --app-pipe-prefix for out of band commands. (project-chip#38778)

* Updated linux apps to read the FIFO without using the app_pid. Now uses a value from a env variable or static value. This will be usefull on tests to use only -app_pipe <app_prefix>+ instead of two paramters.

* Update write_to_app_pipe to only use app_pipe argument which is the full path to pipe file <prefix>_<id>, raises FileNotFound error if the pipe file is not found from start. Removed arguments app_pid and app_pipe_prefix as they are not needed anymore.

* Removed arguments --app-pid and --app-pipe-prefix

* Updated app-pipe_prefix to app-pipe with APP_ID in test cases

* Updated OPSTATE testcases and OVENOPSTATE test cases to use --app-pippe with id instead of PID of the app.

* Fix not found when the parameter is not available

* Removed unused ci actions

* Added APP_IDs for workflows. Currently those are static values for CI.

* Remove automatically appended --app-pid on execution. Now it dependes on the CI parameters provided by the user.

* Fix typo and restyle

* Restyled by whitespace

* Restyled by clang-format

* fix: Solved typo for TC_RVCRUM_2_1. Added quotes for APP_ID.

* fix: Fixed id for bridge app. Added --app-pipe for BRBINFO. Added missing app-pipe for TC_SWITCH

* Typo in variable name

* Typo RCV_CHIP

* Missing file exists check  when the app_pipe is send from the test case.

* fix: code review fix, optimize for string.

* Removed vars from yaml file

* Removed APP_ID from Test case CI arguments from --app-pipe

* Removed env variable for custom app-id. Replaced for app argument --app-id

* Restyled by whitespace

* Restore change.

* fix: Fixed from comments, app_id set to empty string instead of nullptr, this will avoid uneeded check on each of the apps.

* fix: removed comma

* Added app-pipe from scripts args to app-args if present. This is to avoid having the fifo path in scripts args and app-args and avoid posible run errors.

* Added custom fifo path for each one of the test cases.

* Removed prefix. Updated app-id to app-pipe. Now app pipe gets the full path of the fifo path. If not defined avoid sChipNamedPipeCommands.Start()

* Restyled by clang-format

* Updated empty string compare

* Added --app-pipe into app-args. Removed auto append --app-pipe this will need repeated value but will not force same fifo and allow more scenarios.

* Updated tc_soil_2_2 with new fifo format.

---------

Co-authored-by: Restyled.io <[email protected]>

Author: jtrejoespinoza-grid

examples/air-quality-sensor-app/linux/main.cpp

@@ -36,7 +36,6 @@ using namespace chip::app;
 using namespace chip::app::Clusters;
 
 namespace {
-constexpr char kChipEventFifoPathPrefix[] = "/tmp/chip_air_quality_fifo_";
 NamedPipeCommands sChipNamedPipeCommands;
 AirQualitySensorAppAttrUpdateDelegate sAirQualitySensorAppCommandDelegate;
 } // namespace
@@ -52,9 +51,9 @@ int main(int argc, char * argv[])
 {
     VerifyOrDie(ChipLinuxAppInit(argc, argv) == 0);
 
-    std::string path = kChipEventFifoPathPrefix + std::to_string(getpid());
+    std::string path = std::string(LinuxDeviceOptions::GetInstance().app_pipe);
 
-    if (sChipNamedPipeCommands.Start(path, &sAirQualitySensorAppCommandDelegate) != CHIP_NO_ERROR)
+    if ((!path.empty()) and (sChipNamedPipeCommands.Start(path, &sAirQualitySensorAppCommandDelegate) != CHIP_NO_ERROR))
     {
         ChipLogError(NotSpecified, "Failed to start CHIP NamedPipeCommands");
         sChipNamedPipeCommands.Stop();

examples/all-clusters-app/linux/main-common.cpp

@@ -78,7 +78,6 @@ using chip::Protocols::InteractionModel::Status;
 
 namespace {
 
-constexpr char kChipEventFifoPathPrefix[] = "/tmp/chip_all_clusters_fifo_";
 LowPowerManager sLowPowerManager;
 NamedPipeCommands sChipNamedPipeCommands;
 AllClustersCommandDelegate sAllClustersCommandDelegate;
@@ -176,9 +175,8 @@ static Identify gIdentify1 = {
 
 void ApplicationInit()
 {
-    std::string path = kChipEventFifoPathPrefix + std::to_string(getpid());
-
-    if (sChipNamedPipeCommands.Start(path, &sAllClustersCommandDelegate) != CHIP_NO_ERROR)
+    std::string path = std::string(LinuxDeviceOptions::GetInstance().app_pipe);
+    if ((!path.empty()) and (sChipNamedPipeCommands.Start(path, &sAllClustersCommandDelegate) != CHIP_NO_ERROR))
     {
         ChipLogError(NotSpecified, "Failed to start CHIP NamedPipeCommands");
         sChipNamedPipeCommands.Stop();

examples/bridge-app/linux/main.cpp

@@ -68,7 +68,6 @@ std::vector<Action *> gActions;
 
 namespace {
 
-constexpr char kChipEventFifoPathPrefix[] = "/tmp/chip_bridge_fifo_";
 NamedPipeCommands sChipNamedPipeCommands;
 BridgeCommandDelegate sBridgeCommandDelegate;
 
@@ -1052,9 +1051,9 @@ void ApplicationInit()
         }
     }
 
-    std::string path = kChipEventFifoPathPrefix + std::to_string(getpid());
+    std::string path = std::string(LinuxDeviceOptions::GetInstance().app_pipe);
 
-    if (sChipNamedPipeCommands.Start(path, &sBridgeCommandDelegate) != CHIP_NO_ERROR)
+    if ((!path.empty()) and (sChipNamedPipeCommands.Start(path, &sBridgeCommandDelegate) != CHIP_NO_ERROR))
     {
         ChipLogError(NotSpecified, "Failed to start CHIP NamedPipeCommands");
         sChipNamedPipeCommands.Stop();

examples/lighting-app-data-mode-no-unique-id/linux/main.cpp

@@ -42,7 +42,6 @@ using namespace chip::app::Clusters;
 
 namespace {
 
-constexpr char kChipEventFifoPathPrefix[] = "/tmp/chip_lighting_fifo_";
 NamedPipeCommands sChipNamedPipeCommands;
 LightingAppCommandDelegate sLightingAppCommandDelegate;
 } // namespace
@@ -78,9 +77,9 @@ void emberAfOnOffClusterInitCallback(EndpointId endpoint)
 
 void ApplicationInit()
 {
-    std::string path = kChipEventFifoPathPrefix + std::to_string(getpid());
+    std::string path = std::string(LinuxDeviceOptions::GetInstance().app_pipe);
 
-    if (sChipNamedPipeCommands.Start(path, &sLightingAppCommandDelegate) != CHIP_NO_ERROR)
+    if ((!path.empty()) and (sChipNamedPipeCommands.Start(path, &sLightingAppCommandDelegate) != CHIP_NO_ERROR))
     {
         ChipLogError(NotSpecified, "Failed to start CHIP NamedPipeCommands");
         sChipNamedPipeCommands.Stop();

examples/lighting-app/linux/main.cpp

@@ -42,7 +42,6 @@ using namespace chip::app::Clusters;
 
 namespace {
 
-constexpr char kChipEventFifoPathPrefix[] = "/tmp/chip_lighting_fifo_";
 NamedPipeCommands sChipNamedPipeCommands;
 LightingAppCommandDelegate sLightingAppCommandDelegate;
 } // namespace
@@ -78,9 +77,9 @@ void emberAfOnOffClusterInitCallback(EndpointId endpoint)
 
 void ApplicationInit()
 {
-    std::string path = kChipEventFifoPathPrefix + std::to_string(getpid());
+    std::string path = std::string(LinuxDeviceOptions::GetInstance().app_pipe);
 
-    if (sChipNamedPipeCommands.Start(path, &sLightingAppCommandDelegate) != CHIP_NO_ERROR)
+    if ((!path.empty()) and (sChipNamedPipeCommands.Start(path, &sLightingAppCommandDelegate) != CHIP_NO_ERROR))
     {
         ChipLogError(NotSpecified, "Failed to start CHIP NamedPipeCommands");
         sChipNamedPipeCommands.Stop();

examples/lock-app/linux/main.cpp

@@ -27,16 +27,16 @@ using namespace chip::app;
 
 namespace {
 // Variables for handling named pipe commands
-constexpr char kChipEventFifoPathPrefix[] = "/tmp/chip_lock_app_fifo-";
 NamedPipeCommands sChipNamedPipeCommands;
 LockAppCommandDelegate sLockAppCommandDelegate;
 
 } // anonymous namespace
 
 void ApplicationInit()
 {
-    auto path = kChipEventFifoPathPrefix + std::to_string(getpid());
-    if (sChipNamedPipeCommands.Start(path, &sLockAppCommandDelegate) != CHIP_NO_ERROR)
+    std::string path = std::string(LinuxDeviceOptions::GetInstance().app_pipe);
+
+    if ((!path.empty()) and (sChipNamedPipeCommands.Start(path, &sLockAppCommandDelegate) != CHIP_NO_ERROR))
     {
         ChipLogError(NotSpecified, "Failed to start CHIP NamedPipeCommands");
         sChipNamedPipeCommands.Stop();

examples/platform/linux/Options.cpp

@@ -88,6 +88,7 @@ enum
     kDeviceOption_PICS,
     kDeviceOption_KVS,
     kDeviceOption_InterfaceId,
+    kDeviceOption_AppPipe,
     kDeviceOption_Spake2pVerifierBase64,
     kDeviceOption_Spake2pSaltBase64,
     kDeviceOption_Spake2pIterations,
@@ -190,6 +191,7 @@ OptionDef sDeviceOptionDefs[] = {
     { "PICS", kArgumentRequired, kDeviceOption_PICS },
     { "KVS", kArgumentRequired, kDeviceOption_KVS },
     { "interface-id", kArgumentRequired, kDeviceOption_InterfaceId },
+    { "app-pipe", kArgumentRequired, kDeviceOption_AppPipe },
 #if CHIP_CONFIG_TRANSPORT_TRACE_ENABLED
     { "trace_file", kArgumentRequired, kDeviceOption_TraceFile },
     { "trace_log", kArgumentRequired, kDeviceOption_TraceLog },
@@ -346,6 +348,9 @@ const char * sDeviceOptionHelp =
     "\n"
     "  --interface-id <interface>\n"
     "       A interface id to advertise on.\n"
+    "\n"
+    "  --app-pipe <filepath>\n"
+    "       Custom path for the current application to send out of band commands.\n"
 #if CHIP_CONFIG_TRANSPORT_TRACE_ENABLED
     "\n"
     "  --trace_file <file>\n"
@@ -680,6 +685,10 @@ bool HandleOption(const char * aProgram, OptionSet * aOptions, int aIdentifier,
         LinuxDeviceOptions::GetInstance().KVS = aValue;
         break;
 
+    case kDeviceOption_AppPipe:
+        LinuxDeviceOptions::GetInstance().app_pipe = aValue;
+        break;
+
     case kDeviceOption_InterfaceId:
         LinuxDeviceOptions::GetInstance().interfaceId =
             Inet::InterfaceId(static_cast<chip::Inet::InterfaceId::PlatformType>(atoi(aValue)));

examples/platform/linux/Options.h

@@ -74,6 +74,7 @@ struct LinuxDeviceOptions
     const char * command                = nullptr;
     const char * PICS                   = nullptr;
     const char * KVS                    = nullptr;
+    const char * app_pipe               = "";
     chip::Inet::InterfaceId interfaceId = chip::Inet::InterfaceId::Null();
 #if CHIP_CONFIG_TRANSPORT_TRACE_ENABLED
     bool traceStreamDecodeEnabled = false;

examples/rvc-app/linux/main.cpp

@@ -28,7 +28,6 @@ using namespace chip::app;
 using namespace chip::app::Clusters;
 
 namespace {
-constexpr char kChipEventFifoPathPrefix[] = "/tmp/chip_rvc_fifo_";
 NamedPipeCommands sChipNamedPipeCommands;
 RvcAppCommandDelegate sRvcAppCommandDelegate;
 } // namespace
@@ -37,9 +36,9 @@ RvcDevice * gRvcDevice = nullptr;
 
 void ApplicationInit()
 {
-    std::string path = kChipEventFifoPathPrefix + std::to_string(getpid());
+    std::string path = std::string(LinuxDeviceOptions::GetInstance().app_pipe);
 
-    if (sChipNamedPipeCommands.Start(path, &sRvcAppCommandDelegate) != CHIP_NO_ERROR)
+    if ((!path.empty()) and (sChipNamedPipeCommands.Start(path, &sRvcAppCommandDelegate) != CHIP_NO_ERROR))
     {
         ChipLogError(NotSpecified, "Failed to start CHIP NamedPipeCommands");
         sChipNamedPipeCommands.Stop();

examples/water-leak-detector-app/linux/main.cpp

@@ -36,7 +36,6 @@ using namespace chip::app;
 using namespace chip::app::Clusters;
 
 namespace {
-constexpr char kChipEventFifoPathPrefix[] = "/tmp/chip_water_leak_detector_fifo_";
 NamedPipeCommands sChipNamedPipeCommands;
 WaterLeakDetectorAppAttrUpdateDelegate sWaterLeakDetectorAppAttrUpdateDelegate;
 } // namespace
@@ -51,10 +50,9 @@ void ApplicationShutdown() {}
 int main(int argc, char * argv[])
 {
     VerifyOrDie(ChipLinuxAppInit(argc, argv) == 0);
+    std::string path = std::string(LinuxDeviceOptions::GetInstance().app_pipe);
 
-    std::string path = kChipEventFifoPathPrefix + std::to_string(getpid());
-
-    if (sChipNamedPipeCommands.Start(path, &sWaterLeakDetectorAppAttrUpdateDelegate) != CHIP_NO_ERROR)
+    if ((!path.empty()) and (sChipNamedPipeCommands.Start(path, &sWaterLeakDetectorAppAttrUpdateDelegate) != CHIP_NO_ERROR))
     {
         ChipLogError(NotSpecified, "Failed to start CHIP NamedPipeCommands");
         sChipNamedPipeCommands.Stop();