Skip to content

Commit

Permalink
[Fabric-Sync] Implement the test plan for TC_CCTRL_2_3 (#35202)
Browse files Browse the repository at this point in the history
* [Fabric-Sync] Implement the test plan for TC_CCTRL_2_3

* Remove unused import

* Add TC_CCTRL_2_3.py to exclude

* Address review comments

* Remove the CI skip condition
  • Loading branch information
yufengwangca authored and pull[bot] committed Sep 10, 2024
1 parent d027753 commit fed7366
Show file tree
Hide file tree
Showing 2 changed files with 177 additions and 0 deletions.
176 changes: 176 additions & 0 deletions src/python_testing/TC_CCTRL_2_3.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
#
# 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.
#

# See https://github.com/project-chip/connectedhomeip/blob/master/docs/testing/python.md#defining-the-ci-test-arguments
# for details about the block below.
#
# TODO: Skip CI for now, we don't have any way to run this. Needs setup. See test_TC_CCTRL.py

# This test requires a TH_SERVER application. Please specify with --string-arg th_server_app_path:<path_to_app>

import logging
import os
import random
import signal
import subprocess
import time
import uuid

import chip.clusters as Clusters
from chip import ChipDeviceCtrl
from chip.interaction_model import InteractionModelError, Status
from matter_testing_support import (MatterBaseTest, TestStep, async_test_body, default_matter_test_main, has_cluster,
per_endpoint_test)
from mobly import asserts


class TC_CCTRL_2_3(MatterBaseTest):

@async_test_body
async def setup_class(self):
super().setup_class()
self.app_process = None
app = self.user_params.get("th_server_app_path", None)
if not app:
asserts.fail('This test requires a TH_SERVER app. Specify app path with --string-arg th_server_app_path:<path_to_app>')

self.kvs = f'kvs_{str(uuid.uuid4())}'
self.port = 5543
discriminator = random.randint(0, 4095)
passcode = 20202021
app_args = f'--secured-device-port {self.port} --discriminator {discriminator} --passcode {passcode} --KVS {self.kvs}'
cmd = f'{app} {app_args}'
# TODO: Determine if we want these logs cooked or pushed to somewhere else
logging.info("Starting TH_SERVER")
self.app_process = subprocess.Popen(cmd, bufsize=0, shell=True)
logging.info("TH_SERVER started")
time.sleep(3)

logging.info("Commissioning from separate fabric")

# Create a second controller on a new fabric to communicate to the server
new_certificate_authority = self.certificate_authority_manager.NewCertificateAuthority()
new_fabric_admin = new_certificate_authority.NewFabricAdmin(vendorId=0xFFF1, fabricId=2)
paa_path = str(self.matter_test_config.paa_trust_store_path)
self.TH_server_controller = new_fabric_admin.NewController(nodeId=112233, paaTrustStorePath=paa_path)
self.server_nodeid = 1111
await self.TH_server_controller.CommissionOnNetwork(nodeId=self.server_nodeid, setupPinCode=passcode, filterType=ChipDeviceCtrl.DiscoveryFilterType.LONG_DISCRIMINATOR, filter=discriminator)
logging.info("Commissioning TH_SERVER complete")

def teardown_class(self):
# In case the th_server_app_path does not exist, then we failed the test
# and there is nothing to remove
if self.app_process is not None:
logging.warning("Stopping app with SIGTERM")
self.app_process.send_signal(signal.SIGTERM.value)
self.app_process.wait()

if os.path.exists(self.kvs):
os.remove(self.kvs)

super().teardown_class()

def steps_TC_CCTRL_2_3(self) -> list[TestStep]:
steps = [TestStep(1, "Get number of fabrics from TH_SERVER", is_commissioning=True),
TestStep(2, "Reading Attribute VendorId from TH_SERVER"),
TestStep(3, "Reading Attribute ProductId from TH_SERVER"),
TestStep(4, "Send RequestCommissioningApproval command to DUT with CASE session with correct VendorId and ProductId"),
TestStep(5, "(Manual Step) Approve Commissioning Approval Request on DUT using method indicated by the manufacturer"),
TestStep(6, "Reading Event CommissioningRequestResult from DUT, confirm one new event"),
TestStep(7, "Send another RequestCommissioningApproval command to DUT with CASE session with same RequestId as the previous one"),
TestStep(8, "Send CommissionNode command to DUT with CASE session, with valid parameters"),
TestStep(9, "Send another CommissionNode command to DUT with CASE session, with with same RequestId as the previous one"),
TestStep(10, "Send OpenCommissioningWindow command on Administrator Commissioning Cluster sent to TH_SERVER"),
TestStep(11, "Wait for DUT to successfully commission TH_SERVER, 30 seconds"),
TestStep(12, "Get number of fabrics from TH_SERVER, verify DUT successfully commissioned TH_SERVER")]

return steps

@per_endpoint_test(has_cluster(Clusters.CommissionerControl))
async def test_TC_CCTRL_2_3(self):
self.is_ci = self.check_pics('PICS_SDK_CI_ONLY')

self.step(1)
th_server_fabrics = await self.read_single_attribute_check_success(cluster=Clusters.OperationalCredentials, attribute=Clusters.OperationalCredentials.Attributes.Fabrics, dev_ctrl=self.TH_server_controller, node_id=self.server_nodeid, endpoint=0, fabric_filtered=False)

self.step(2)
th_server_vid = await self.read_single_attribute_check_success(cluster=Clusters.BasicInformation, attribute=Clusters.BasicInformation.Attributes.VendorID, dev_ctrl=self.TH_server_controller, node_id=self.server_nodeid, endpoint=0)

self.step(3)
th_server_pid = await self.read_single_attribute_check_success(cluster=Clusters.BasicInformation, attribute=Clusters.BasicInformation.Attributes.ProductID, dev_ctrl=self.TH_server_controller, node_id=self.server_nodeid, endpoint=0)

self.step(4)
good_request_id = 0x1234567812345678
cmd = Clusters.CommissionerControl.Commands.RequestCommissioningApproval(
requestId=good_request_id, vendorId=th_server_vid, productId=th_server_pid, label="Test Ecosystem")
await self.send_single_cmd(cmd=cmd)

self.step(5)
if not self.is_ci:
self.wait_for_user_input("Approve Commissioning approval request using manufacturer specified mechanism")

self.step(6)
event_path = [(self.matter_test_config.endpoint, Clusters.CommissionerControl.Events.CommissioningRequestResult, 1)]
events = await self.default_controller.ReadEvent(nodeid=self.dut_node_id, events=event_path)
asserts.assert_equal(len(events), 1, "Unexpected event list len")
asserts.assert_equal(events[0].Data.statusCode, 0, "Unexpected status code")
asserts.assert_equal(events[0].Data.clientNodeId,
self.matter_test_config.controller_node_id, "Unexpected client node id")
asserts.assert_equal(events[0].Data.requestId, good_request_id, "Unexpected request ID")

self.step(7)
cmd = Clusters.CommissionerControl.Commands.RequestCommissioningApproval(
requestId=good_request_id, vendorId=th_server_vid, productId=th_server_pid)
try:
await self.send_single_cmd(cmd=cmd)
asserts.fail("Unexpected success on CommissionNode")
except InteractionModelError as e:
asserts.assert_equal(e.status, Status.Failure, "Incorrect error returned")

self.step(8)
cmd = Clusters.CommissionerControl.Commands.CommissionNode(requestId=good_request_id, responseTimeoutSeconds=30)
resp = await self.send_single_cmd(cmd)
asserts.assert_equal(type(resp), Clusters.CommissionerControl.Commands.ReverseOpenCommissioningWindow,
"Incorrect response type")

self.step(9)
cmd = Clusters.CommissionerControl.Commands.CommissionNode(requestId=good_request_id, responseTimeoutSeconds=30)
try:
await self.send_single_cmd(cmd=cmd)
asserts.fail("Unexpected success on CommissionNode")
except InteractionModelError as e:
asserts.assert_equal(e.status, Status.Failure, "Incorrect error returned")

self.step(10)
# min commissioning timeout is 3*60 seconds, so use that even though the command said 30.
cmd = Clusters.AdministratorCommissioning.Commands.OpenCommissioningWindow(commissioningTimeout=3*60,
PAKEPasscodeVerifier=resp.PAKEPasscodeVerifier,
discriminator=resp.discriminator,
iterations=resp.iterations, salt=resp.salt)
await self.send_single_cmd(cmd, dev_ctrl=self.TH_server_controller, node_id=self.server_nodeid, endpoint=0, timedRequestTimeoutMs=5000)

self.step(11)
time.sleep(30)

self.step(12)
th_server_fabrics_new = await self.read_single_attribute_check_success(cluster=Clusters.OperationalCredentials, attribute=Clusters.OperationalCredentials.Attributes.Fabrics, dev_ctrl=self.TH_server_controller, node_id=self.server_nodeid, endpoint=0, fabric_filtered=False)
asserts.assert_equal(len(th_server_fabrics) + 1, len(th_server_fabrics_new),
"Unexpected number of fabrics on TH_SERVER")


if __name__ == "__main__":
default_matter_test_main()
1 change: 1 addition & 0 deletions src/python_testing/execute_python_tests.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ def main(search_directory, env_file):
"TC_CNET_4_4.py",
"TC_CCTRL_2_1.py",
"TC_CCTRL_2_2.py",
"TC_CCTRL_2_3.py",
"TC_DGGEN_3_2.py",
"TC_EEVSE_Utils.py",
"TC_ECOINFO_2_1.py",
Expand Down

0 comments on commit fed7366

Please sign in to comment.