Valve cluster: refactor to make unit-testable

examples/valve-app/linux/.gn

@@ -0,0 +1,25 @@
+# Copyright (c) 2020 Project CHIP Authors
+#
+# 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.
+
+import("//build_overrides/build.gni")
+
+# The location of the build configuration file.
+buildconfig = "${build_root}/config/BUILDCONFIG.gn"
+
+# CHIP uses angle bracket includes.
+check_system_includes = true
+
+default_args = {
+  import("//args.gni")
+}

examples/valve-app/linux/BUILD.gn

@@ -0,0 +1,55 @@
+# Copyright (c) 2023 Project CHIP Authors
+#
+# 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.
+
+import("//build_overrides/chip.gni")
+
+import("${chip_root}/build/chip/tools.gni")
+import("${chip_root}/src/app/common_flags.gni")
+
+assert(chip_build_tools)
+
+import("${chip_root}/examples/common/pigweed/pigweed_rpcs.gni")
+
+config("includes") {
+  include_dirs = [
+    ".",
+    "include",
+  ]
+}
+
+executable("valve-app") {
+  sources = [
+    "include/CHIPProjectAppConfig.h",
+    "main.cpp",
+  ]
+
+  deps = [
+    "${chip_root}/examples/platform/linux:app-main",
+    "${chip_root}/examples/valve-app/valve-common",
+    "${chip_root}/src/lib",
+  ]
+
+  cflags = [ "-Wconversion" ]
+
+  include_dirs = [ "include" ]
+  output_dir = root_out_dir
+}
+
+group("linux") {
+  deps = [ ":valve-app" ]
+}
+
+group("default") {
+  deps = [ ":linux" ]
+}

examples/valve-app/linux/args.gni

@@ -0,0 +1,25 @@
+# Copyright (c) 2023 Project CHIP Authors
+#
+# 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.
+
+import("//build_overrides/chip.gni")
+
+import("${chip_root}/config/standalone/args.gni")
+
+chip_device_project_config_include = "<CHIPProjectAppConfig.h>"
+chip_project_config_include = "<CHIPProjectAppConfig.h>"
+chip_system_project_config_include = "<SystemProjectConfig.h>"
+
+chip_project_config_include_dirs =
+    [ "${chip_root}/examples/air-purifier-app/linux/include" ]
+chip_project_config_include_dirs += [ "${chip_root}/config/standalone" ]

examples/valve-app/linux/build_overrides

@@ -0,0 +1 @@
+../../build_overrides

examples/valve-app/linux/include/CHIPProjectAppConfig.h

@@ -0,0 +1,38 @@
+/*
+ *
+ *    Copyright (c) 2023 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
+
+// include the CHIPProjectConfig from config/standalone
+#include <CHIPProjectConfig.h>
+
+#define CHIP_DEVICE_CONFIG_ENABLE_COMMISSIONER_DISCOVERY 0
+
+#define CHIP_DEVICE_CONFIG_ENABLE_COMMISSIONER_DISCOVERY_CLIENT 0
+
+#define CHIP_DEVICE_CONFIG_ENABLE_EXTENDED_DISCOVERY 1
+
+#define CHIP_DEVICE_CONFIG_ENABLE_COMMISSIONABLE_DEVICE_TYPE 1
+
+#define CHIP_DEVICE_CONFIG_DEVICE_TYPE 0x0042 // Water valve
+
+#define CHIP_DEVICE_CONFIG_ENABLE_COMMISSIONABLE_DEVICE_NAME 1
+
+#define CHIP_DEVICE_ENABLE_PORT_PARAMS 1
+
+#define CHIP_DEVICE_CONFIG_DEVICE_NAME "DISCO Drinks"

examples/valve-app/linux/main.cpp

@@ -0,0 +1,119 @@
+/*
+ *
+ *    Copyright (c) 2024 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.
+ */
+#include <AppMain.h>
+#include <app-common/zap-generated/ids/Clusters.h>
+#include <app/clusters/valve-configuration-and-control-server/valve-configuration-and-control-cluster-logic.h>
+#include <app/clusters/valve-configuration-and-control-server/valve-configuration-and-control-delegate.h>
+#include <app/clusters/valve-configuration-and-control-server/valve-configuration-and-control-server-disco.h>
+#include <lib/support/logging/CHIPLogging.h>
+#include <platform/KvsPersistentStorageDelegate.h>
+
+using namespace chip;
+using namespace chip::app;
+using namespace chip::app::Clusters;
+using namespace chip::app::Clusters::ValveConfigurationAndControl;
+namespace {
+class PrintOnlyDelegate : public NonLevelControlDelegate
+{
+public:
+    PrintOnlyDelegate(EndpointId endpoint) : mEndpoint(endpoint) {}
+    CHIP_ERROR HandleOpenValve(ValveStateEnum & currentState, BitMask<ValveFaultBitmap> & valveFault) override
+    {
+        ChipLogProgress(NotSpecified, "VALVE IS OPENING on endpoint %u!!!!!", mEndpoint);
+        state        = ValveStateEnum::kOpen;
+        currentState = state;
+        return CHIP_NO_ERROR;
+    }
+    ValveStateEnum GetCurrentValveState() override { return state; }
+    CHIP_ERROR HandleCloseValve(ValveStateEnum & currentState, BitMask<ValveFaultBitmap> & valveFault) override
+    {
+        ChipLogProgress(NotSpecified, "VALVE IS CLOSING on endpoint %u!!!!!", mEndpoint);
+        state        = ValveStateEnum::kClosed;
+        currentState = state;
+        return CHIP_NO_ERROR;
+    }
+
+private:
+    ValveStateEnum state = ValveStateEnum::kClosed;
+    EndpointId mEndpoint;
+};
+
+class NonLevelValveEndpoint
+{
+public:
+    NonLevelValveEndpoint(EndpointId endpoint) :
+        mEndpoint(endpoint), mContext(mEndpoint, storage), mDelegate(mEndpoint), mLogic(mDelegate, mContext),
+        mInterface(mEndpoint, mLogic)
+    {}
+    CHIP_ERROR Init()
+    {
+        ReturnErrorOnFailure(mLogic.Init(kConformance, kInitParams));
+        ReturnErrorOnFailure(mInterface.Init());
+        return CHIP_NO_ERROR;
+    }
+
+private:
+    const ClusterConformance kConformance = {
+        .featureMap = 0, .supportsDefaultOpenLevel = false, .supportsValveFault = false, .supportsLevelStep = false
+    };
+    const ClusterInitParameters kInitParams = { .currentState = DataModel::MakeNullable(ValveStateEnum::kClosed),
+                                                .currentLevel = DataModel::NullNullable,
+                                                .valveFault   = 0,
+                                                .levelStep    = 1 };
+    EndpointId mEndpoint;
+    KvsPersistentStorageDelegate storage;
+    MatterContext mContext;
+    PrintOnlyDelegate mDelegate;
+    ClusterLogic mLogic;
+    Interface mInterface;
+};
+
+NonLevelValveEndpoint ep1(1);
+NonLevelValveEndpoint ep2(2);
+NonLevelValveEndpoint ep3(3);
+NonLevelValveEndpoint ep4(4);
+NonLevelValveEndpoint ep5(5);
+NonLevelValveEndpoint ep6(6);
+} // namespace
+
+void ApplicationInit()
+{
+    ChipLogError(NotSpecified, "App init!!!");
+    ep1.Init();
+    ep2.Init();
+    ep3.Init();
+    ep4.Init();
+    ep5.Init();
+    ep6.Init();
+}
+
+void ApplicationShutdown()
+{
+    ChipLogDetail(NotSpecified, "ApplicationShutdown()");
+}
+
+int main(int argc, char * argv[])
+{
+    if (ChipLinuxAppInit(argc, argv) != 0)
+    {
+        return -1;
+    }
+
+    ChipLinuxAppMainLoop();
+    return 0;
+}

examples/valve-app/linux/third_party/connectedhomeip

@@ -0,0 +1 @@
+../../../../

examples/valve-app/valve-common/BUILD.gn

@@ -0,0 +1,21 @@
+# Copyright (c) 2020 Project CHIP Authors
+#
+# 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.
+
+import("//build_overrides/chip.gni")
+import("${chip_root}/src/app/chip_data_model.gni")
+
+chip_data_model("valve-common") {
+  zap_file = "valve-app.zap"
+  is_server = true
+}