Actions cluster test support (#19487)

* Added support for action clusters tests to the Linux bridge-app example. Commands were added to support the actions cluster test plan for renaming rooms, adding and removing rooms, and changing rooms so that they are not visible in the endpoint lists. * Whitespace updates. * Restyled by clang-format * Build fixes and removed unused capture. Co-authored-by: Restyled.io <[email protected]>
project-chip · Jun 16, 2022 · 1e3f120 · 1e3f120
1 parent 75d0257
commit 1e3f120
Show file tree

Hide file tree

Showing 6 changed files with 252 additions and 21 deletions.
diff --git a/examples/bridge-app/linux/BUILD.gn b/examples/bridge-app/linux/BUILD.gn
@@ -24,6 +24,7 @@ executable("chip-bridge-app") {
     "${chip_root}/examples/tv-app/tv-common/include/CHIPProjectAppConfig.h",
     "Device.cpp",
     "include/Device.h",
+    "include/main.h",
     "main.cpp",
   ]
 

diff --git a/examples/bridge-app/linux/Device.cpp b/examples/bridge-app/linux/Device.cpp
@@ -22,12 +22,14 @@
 #include <cstdio>
 #include <platform/CHIPDeviceLayer.h>
 
+using namespace chip::app::Clusters::BridgedActions;
+
 // LightingManager LightingManager::sLight;
 
-Device::Device(const char * szDeviceName, const char * szLocation)
+Device::Device(const char * szDeviceName, std::string szLocation)
 {
     strncpy(mName, szDeviceName, sizeof(mName));
-    strncpy(mLocation, szLocation, sizeof(mLocation));
+    mLocation   = szLocation;
     mReachable  = false;
     mEndpointId = 0;
 }
@@ -72,21 +74,21 @@ void Device::SetName(const char * szName)
     }
 }
 
-void Device::SetLocation(const char * szLocation)
+void Device::SetLocation(std::string szLocation)
 {
-    bool changed = (strncmp(mLocation, szLocation, sizeof(mLocation)) != 0);
+    bool changed = (mLocation.compare(szLocation) != 0);
 
-    strncpy(mLocation, szLocation, sizeof(mLocation));
+    mLocation = szLocation;
 
-    ChipLogProgress(DeviceLayer, "Device[%s]: Location=\"%s\"", mName, mLocation);
+    ChipLogProgress(DeviceLayer, "Device[%s]: Location=\"%s\"", mName, mLocation.c_str());
 
     if (changed)
     {
         HandleDeviceChange(this, kChanged_Location);
     }
 }
 
-DeviceOnOff::DeviceOnOff(const char * szDeviceName, const char * szLocation) : Device(szDeviceName, szLocation)
+DeviceOnOff::DeviceOnOff(const char * szDeviceName, std::string szLocation) : Device(szDeviceName, szLocation)
 {
     mOn = false;
 }
@@ -129,7 +131,7 @@ void DeviceOnOff::HandleDeviceChange(Device * device, Device::Changed_t changeMa
     }
 }
 
-DeviceSwitch::DeviceSwitch(const char * szDeviceName, const char * szLocation, uint32_t aFeatureMap) :
+DeviceSwitch::DeviceSwitch(const char * szDeviceName, std::string szLocation, uint32_t aFeatureMap) :
     Device(szDeviceName, szLocation)
 {
     mNumberOfPositions = 2;
@@ -231,3 +233,32 @@ void DevicePowerSource::SetDescription(std::string aDescription)
         mChanged_CB(this, kChanged_Description);
     }
 }
+
+EndpointListInfo::EndpointListInfo(uint16_t endpointListId, std::string name, EndpointListTypeEnum type)
+{
+    mEndpointListId = endpointListId;
+    mName           = name;
+    mType           = type;
+}
+
+EndpointListInfo::EndpointListInfo(uint16_t endpointListId, std::string name, EndpointListTypeEnum type,
+                                   chip::EndpointId endpointId)
+{
+    mEndpointListId = endpointListId;
+    mName           = name;
+    mType           = type;
+    mEndpoints.push_back(endpointId);
+}
+
+void EndpointListInfo::AddEndpointId(chip::EndpointId endpointId)
+{
+    mEndpoints.push_back(endpointId);
+}
+
+Room::Room(std::string name, uint16_t endpointListId, EndpointListTypeEnum type, bool isVisible)
+{
+    mName           = name;
+    mEndpointListId = endpointListId;
+    mType           = type;
+    mIsVisible      = isVisible;
+}
diff --git a/examples/bridge-app/linux/bridged-actions-stub.cpp b/examples/bridge-app/linux/bridged-actions-stub.cpp
@@ -24,6 +24,11 @@
 #include <lib/support/CodeUtils.h>
 #include <lib/support/logging/CHIPLogging.h>
 
+#include <vector>
+
+#include "Device.h"
+#include "main.h"
+
 using namespace chip;
 using namespace chip::app;
 using namespace chip::app::Clusters;
@@ -58,8 +63,20 @@ CHIP_ERROR BridgedActionsAttrAccess::ReadActionListAttribute(EndpointId endpoint
 
 CHIP_ERROR BridgedActionsAttrAccess::ReadEndpointListAttribute(EndpointId endpoint, AttributeValueEncoder & aEncoder)
 {
-    // Just return an empty list
-    return aEncoder.EncodeEmptyList();
+    std::vector<EndpointListInfo> infoList = GetEndpointListInfo(endpoint);
+
+    CHIP_ERROR err = aEncoder.EncodeList([&infoList](const auto & encoder) -> CHIP_ERROR {
+        for (auto info : infoList)
+        {
+            BridgedActions::Structs::EndpointListStruct::Type endpointListStruct = {
+                info.GetEndpointListId(), CharSpan::fromCharString(info.GetName().c_str()), info.GetType(),
+                DataModel::List<chip::EndpointId>(info.GetEndpointListData(), info.GetEndpointListSize())
+            };
+            ReturnErrorOnFailure(encoder.Encode(endpointListStruct));
+        }
+        return CHIP_NO_ERROR;
+    });
+    return err;
 }
 
 CHIP_ERROR BridgedActionsAttrAccess::ReadSetupUrlAttribute(EndpointId endpoint, AttributeValueEncoder & aEncoder)

diff --git a/examples/bridge-app/linux/include/Device.h b/examples/bridge-app/linux/include/Device.h
@@ -24,12 +24,15 @@
 #include <stdint.h>
 
 #include <functional>
+#include <vector>
+
+using namespace chip::app::Clusters;
+using namespace chip::app::Clusters::BridgedActions;
 
 class Device
 {
 public:
-    static const int kDeviceNameSize     = 32;
-    static const int kDeviceLocationSize = 32;
+    static const int kDeviceNameSize = 32;
 
     enum Changed_t
     {
@@ -39,26 +42,32 @@ class Device
         kChanged_Last      = kChanged_Name,
     } Changed;
 
-    Device(const char * szDeviceName, const char * szLocation);
+    Device(const char * szDeviceName, std::string szLocation);
     virtual ~Device() {}
 
     bool IsReachable();
     void SetReachable(bool aReachable);
     void SetName(const char * szDeviceName);
-    void SetLocation(const char * szLocation);
+    void SetLocation(std::string szLocation);
     inline void SetEndpointId(chip::EndpointId id) { mEndpointId = id; };
     inline chip::EndpointId GetEndpointId() { return mEndpointId; };
+    inline void SetParentEndpointId(chip::EndpointId id) { mParentEndpointId = id; };
+    inline chip::EndpointId GetParentEndpointId() { return mParentEndpointId; };
     inline char * GetName() { return mName; };
-    inline char * GetLocation() { return mLocation; };
+    inline std::string GetLocation() { return mLocation; };
+    inline std::string GetZone() { return mZone; };
+    inline void SetZone(std::string zone) { mZone = zone; };
 
 private:
     virtual void HandleDeviceChange(Device * device, Device::Changed_t changeMask) = 0;
 
 protected:
     bool mReachable;
     char mName[kDeviceNameSize];
-    char mLocation[kDeviceLocationSize];
+    std::string mLocation;
     chip::EndpointId mEndpointId;
+    chip::EndpointId mParentEndpointId;
+    std::string mZone;
 };
 
 class DeviceOnOff : public Device
@@ -69,7 +78,7 @@ class DeviceOnOff : public Device
         kChanged_OnOff = kChanged_Last << 1,
     } Changed;
 
-    DeviceOnOff(const char * szDeviceName, const char * szLocation);
+    DeviceOnOff(const char * szDeviceName, std::string szLocation);
 
     bool IsOn();
     void SetOnOff(bool aOn);
@@ -96,7 +105,7 @@ class DeviceSwitch : public Device
         kChanged_MultiPressMax     = kChanged_Last << 3,
     } Changed;
 
-    DeviceSwitch(const char * szDeviceName, const char * szLocation, uint32_t aFeatureMap);
+    DeviceSwitch(const char * szDeviceName, std::string szLocation, uint32_t aFeatureMap);
 
     void SetNumberOfPositions(uint8_t aNumberOfPositions);
     void SetCurrentPosition(uint8_t aCurrentPosition);
@@ -124,7 +133,7 @@ class DeviceSwitch : public Device
 class ComposedDevice : public Device
 {
 public:
-    ComposedDevice(const char * szDeviceName, const char * szLocation) : Device(szDeviceName, szLocation){};
+    ComposedDevice(const char * szDeviceName, std::string szLocation) : Device(szDeviceName, szLocation){};
 
     using DeviceCallback_fn = std::function<void(ComposedDevice *, ComposedDevice::Changed_t)>;
 
@@ -146,7 +155,7 @@ class DevicePowerSource : public Device
         kChanged_Description = kChanged_Last << 2,
     } Changed;
 
-    DevicePowerSource(const char * szDeviceName, const char * szLocation, uint32_t aFeatureMap) :
+    DevicePowerSource(const char * szDeviceName, std::string szLocation, uint32_t aFeatureMap) :
         Device(szDeviceName, szLocation), mFeatureMap(aFeatureMap){};
 
     using DeviceCallback_fn = std::function<void(DevicePowerSource *, DevicePowerSource::Changed_t)>;
@@ -172,3 +181,40 @@ class DevicePowerSource : public Device
     uint32_t mFeatureMap;
     DeviceCallback_fn mChanged_CB;
 };
+
+class EndpointListInfo
+{
+public:
+    EndpointListInfo(uint16_t endpointListId, std::string name, EndpointListTypeEnum type);
+    EndpointListInfo(uint16_t endpointListId, std::string name, EndpointListTypeEnum type, chip::EndpointId endpointId);
+    void AddEndpointId(chip::EndpointId endpointId);
+    inline uint16_t GetEndpointListId() { return mEndpointListId; };
+    std::string GetName() { return mName; };
+    inline EndpointListTypeEnum GetType() { return mType; };
+    inline chip::EndpointId * GetEndpointListData() { return mEndpoints.data(); };
+    inline size_t GetEndpointListSize() { return mEndpoints.size(); };
+
+private:
+    uint16_t mEndpointListId = static_cast<uint16_t>(0);
+    std::string mName;
+    EndpointListTypeEnum mType = static_cast<EndpointListTypeEnum>(0);
+    std::vector<chip::EndpointId> mEndpoints;
+};
+
+class Room
+{
+public:
+    Room(std::string name, uint16_t endpointListId, EndpointListTypeEnum type, bool isVisible);
+    inline void setIsVisible(bool isVisible) { mIsVisible = isVisible; };
+    inline bool getIsVisible() { return mIsVisible; };
+    inline void setName(std::string name) { mName = name; };
+    inline std::string getName() { return mName; };
+    inline EndpointListTypeEnum getType() { return mType; };
+    inline uint16_t getEndpointListId() { return mEndpointListId; };
+
+private:
+    bool mIsVisible;
+    std::string mName;
+    uint16_t mEndpointListId;
+    EndpointListTypeEnum mType;
+};
diff --git a/examples/bridge-app/linux/include/main.h b/examples/bridge-app/linux/include/main.h
@@ -0,0 +1,21 @@
+/*
+ *
+ *    Copyright (c) 2022 Project CHIP Authors
+ *    All rights reserved.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+
+#pragma once
+
+std::vector<EndpointListInfo> GetEndpointListInfo(chip::EndpointId parentId);