Skip to content

Commit

Permalink
Fix DGGEN and TC-DGGEN-2.4 to latest spec (#31526)
Browse files Browse the repository at this point in the history 
* Fix DGGEN and TC-DGGEN-2.4 to latest spec

- https://github.com/CHIP-Specifications/connectedhomeip-spec/pull/8737 introduced simplifications
  to the TimeSnapshot command. The test plans were also updated.
- This PR updates the test case to follow, by removing granularity check,
  and reordering some sub-steps of step3.

Fixes: #31475

Testing done:

- Tested with all-clusters-app with both `--simulate-no-internal-time` and without
  (this app has TimeSync, so tests step 3, not 4).
- Tested with lighting-app (this app doesn't have TimeSync, so tests step 4, not 3)

* Restyled by autopep8

---------

Co-authored-by: tennessee.carmelveilleux@gmail.com <tennessee@google.com>
Co-authored-by: Restyled.io <commits@restyled.io>
  • Loading branch information
@tcarmelveilleux @tennessee-google
@restyled-commits @pull
3 people authored and pull[bot] committed Jan 27, 2024
1 parent 90c24c4 commit aaf419d
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 53 deletions.
39 changes: 6 additions & 33 deletions src/app/clusters/general-diagnostics-server/general-diagnostics-server.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,6 @@

#include <app/util/config.h>

#ifdef ZCL_USING_TIME_SYNCHRONIZATION_CLUSTER_SERVER
// Need the `nogncheck` because it's inter-cluster dependency and this
// breaks GN deps checks since that doesn't know how to deal with #ifdef'd includes :(.
#include "app/clusters/time-synchronization-server/time-synchronization-server.h" // nogncheck
#endif // ZCL_USING_TIME_SYNCHRONIZATION_CLUSTER_SERVER

#include "app/server/Server.h"
#include <app-common/zap-generated/attributes/Accessors.h>
#include <app-common/zap-generated/cluster-objects.h>
Expand Down Expand Up @@ -402,35 +396,14 @@ bool emberAfGeneralDiagnosticsClusterTimeSnapshotCallback(CommandHandler * comma

System::Clock::Microseconds64 posix_time_us{ 0 };

// Only consider real time if time sync cluster is actually enabled. Avoids
// likelihood of frequently reporting unsynced time.
#ifdef ZCL_USING_TIME_SYNCHRONIZATION_CLUSTER_SERVER
bool time_is_synced = false;
using Clusters::TimeSynchronization::GranularityEnum;
GranularityEnum granularity = Clusters::TimeSynchronization::TimeSynchronizationServer::Instance().GetGranularity();
switch (granularity)
{
case GranularityEnum::kUnknownEnumValue:
case GranularityEnum::kNoTimeGranularity:
time_is_synced = false;
break;
case GranularityEnum::kMinutesGranularity:
// Minute granularity is not deemed good enough for TimeSnapshot to report PosixTimeMs, by spec.
time_is_synced = false;
break;
case GranularityEnum::kSecondsGranularity:
case GranularityEnum::kMillisecondsGranularity:
case GranularityEnum::kMicrosecondsGranularity:
time_is_synced = true;
break;
}

if (time_is_synced)
CHIP_ERROR posix_time_err = System::SystemClock().GetClock_RealTime(posix_time_us);
if (posix_time_err != CHIP_NO_ERROR)
{
CHIP_ERROR posix_time_err = System::SystemClock().GetClock_RealTime(posix_time_us);
if (posix_time_err != CHIP_NO_ERROR)
{
ChipLogError(Zcl, "Failed to get POSIX real time: %" CHIP_ERROR_FORMAT, posix_time_err.Format());
posix_time_us = System::Clock::Microseconds64{ 0 };
}
ChipLogError(Zcl, "Failed to get POSIX real time: %" CHIP_ERROR_FORMAT, posix_time_err.Format());
posix_time_us = System::Clock::Microseconds64{ 0 };
}
#endif // ZCL_USING_TIME_SYNCHRONIZATION_CLUSTER_SERVER

Expand Down
46 changes: 26 additions & 20 deletions src/python_testing/TC_DGGEN_2_4.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ async def set_time_in_timesync(self, current_time: int):
code = 0

try:
await self.send_single_cmd(cmd=time_cluster.Commands.SetUTCTime(UTCTime=current_time, granularity=time_cluster.Enums.GranularityEnum.kSecondsGranularity), endpoint=endpoint)
await self.send_single_cmd(cmd=time_cluster.Commands.SetUTCTime(UTCTime=current_time, granularity=time_cluster.Enums.GranularityEnum.kMillisecondsGranularity), endpoint=endpoint)
except InteractionModelError as e:
# The python layer discards the cluster specific portion of the status IB, so for now we just expect a generic FAILURE error
# see #26521
Expand All @@ -66,8 +66,7 @@ async def send_time_snapshot_expect_success(self):

@async_test_body
async def test_TC_GEN_2_4(self):
self.print_step(1, "Detect Time Synchronization UTCTime attribute presence")

self.print_step("1a", "Detect Time Synchronization UTCTime attribute presence")
root_descriptor = await self.default_controller.ReadAttribute(self.dut_node_id, [(0, Clusters.Descriptor)])
root_server_list = root_descriptor[0][Clusters.Descriptor][Clusters.Descriptor.Attributes.ServerList]
has_timesync = (Clusters.TimeSynchronization.id in root_server_list)
Expand All @@ -80,6 +79,21 @@ async def test_TC_GEN_2_4(self):

if has_utc_time:
testvar_TimeSyncSupported = True
else:
asserts.fail("Time Synchronization cluster present but UTCTime missing. This should not happen!")

self.print_step("1b", "Write current time to DUT")
# Get current time in the correct format to set via command.
th_utc = matter_epoch_us_from_utc_datetime(desired_datetime=None)

await self.set_time_in_timesync(th_utc)

self.print_step("1c", "Read current time from DUT")
testvar_UTCTime1 = await self.read_timesync_attribute_expect_success(Clusters.TimeSynchronization.Attributes.UTCTime)
asserts.assert_true(testvar_UTCTime1 != NullValue,
"UTCTime1 readback must not be null after SetUTCTime (per Time Synchronization cluster spec)")

testvar_TimeSyncSupported = True

self.print_step(2, "Read UpTime attribute, save as UpTime1")
testvar_UpTime1 = await self.read_diags_attribute_expect_success(Clusters.GeneralDiagnostics.Attributes.UpTime)
Expand All @@ -89,22 +103,14 @@ async def test_TC_GEN_2_4(self):
if testvar_TimeSyncSupported:
self.print_step(3, "Functional verifications when Time Synchronization is supported")

self.print_step("3a", "Write current time to DUT")
# Get current time in the correct format to set via command.
th_utc = matter_epoch_us_from_utc_datetime(desired_datetime=None)

await self.set_time_in_timesync(th_utc)

self.print_step("3b", "Read current time from DUT")
testvar_UTCTime1 = await self.read_timesync_attribute_expect_success(Clusters.TimeSynchronization.Attributes.UTCTime)
asserts.assert_true(testvar_UTCTime1 != NullValue, "UTCTime1 readback must not be null")
self.print_step("3a", "Read UTCTime if TimeSyncSupported is true (already done as part of 1c, not redoing)")

self.print_step("3c", "Wait for 1 second")
self.print_step("3b", "Wait for 1 second")
await asyncio.sleep(1)

self.print_step("3d", "Send a first TimeSnapshot command and verify")
self.print_step("3c", "Send a first TimeSnapshot command and verify")
response = await self.send_time_snapshot_expect_success()
logging.info(f"Step 3d: {response}")
logging.info(f"Step 3c: {response}")

# Verify that the DUT sends a TimeSnapshotResponse with the following conditions met:
# - Value of PosixTimeMs field is not null.
Expand All @@ -127,13 +133,13 @@ async def test_TC_GEN_2_4(self):
testvar_SystemTimeMs1 = response.systemTimeMs
testvar_PosixTimeMs1 = response.posixTimeMs

self.print_step("3e", "Wait for 1 second")
self.print_step("3d", "Wait for 1 second")
await asyncio.sleep(1)

self.print_step("3f", "Send a second TimeSnapshot command and verify")
self.print_step("3e", "Send a second TimeSnapshot command and verify")

response = await self.send_time_snapshot_expect_success()
logging.info(f"Step 3f: {response}")
logging.info(f"Step 3e: {response}")

# Verify that the DUT sends a TimeSnapshotResponse with the following fields:
# - Value of PosixTimeMs field is not null and greater than PosixTimeMs1.
Expand All @@ -145,11 +151,11 @@ async def test_TC_GEN_2_4(self):
asserts.assert_greater(response.systemTimeMs, testvar_SystemTimeMs1,
"System time in milliseconds must be > SystemTimeMs1")

self.print_step(4, "Skipped: Functional verifications when Time Synchronization is NOT supported")
self.print_step(4, "Skipped: Functional verifications for case when Time Synchronization is NOT supported")

# Step 4 (Time Sync not supported)
else: # if not testvar_TimeSyncSupported:
self.print_step(3, "Skipped: Functional verifications when Time Synchronization is supported")
self.print_step(3, "Skipped: Functional verifications for case when Time Synchronization is supported")

self.print_step(4, "Functional verifications when Time Synchronization is NOT supported")

Expand Down

0 comments on commit aaf419d

Please sign in to comment.