Docs: Update testing YAML per review comments (#31628)

* address review comments

* regenerate tables

* Docs: Exclude YAML tables from restyler

The restyler removes all the newlines that cause the table to
render correctly.

.restyled.yaml

@@ -86,6 +86,8 @@ exclude:
     - "scripts/setup/pigweed.json" # TODO(#29547). This file is temporary copy from pigweed repo that has minor edits. No restyle help in diff.
     - "docs/ERROR_CODES.md" # generated by scripts, not easy to align tables
     - "docs/clusters.md" # generated by scripts, not easy to align tables
+    - "docs/testing/yaml_pseudocluster.md" # generated by scripts, restyler makes the tables render improperly
+    - "docs/testing/yaml_schema.md" # generated by scripts, restyler makes the tables render improperly
 
 changed_paths:
     maximum: 100000

docs/testing/yaml_pseudocluster.md

@@ -6,45 +6,69 @@ Script: generate_pseudo_cluster_doc_tables.py
 
 # YAML Pseudo-clusters
 
-CommissionerCommands |command|args|arg type| arg optional| |:---|:---|:---|:---|
+
+
+CommissionerCommands
+|command|args|arg type| arg optional|
+|:---|:---|:---|:---|
 |PairWithCode|nodeId<br />payload<br />discoverOnce|node_id<br />char_string<br />boolean|false<br />false<br />true|
-|Unpair|nodeId|node_id|false| |GetCommissionerNodeId||||
+|Unpair|nodeId|node_id|false|
+|GetCommissionerNodeId||||
 |GetCommissionerNodeIdResponse|nodeId|node_id|false|
 |GetCommissionerRootCertificate||||
 |GetCommissionerRootCertificateResponse|RCAC|OCTET_STRING|false|
 |IssueNocChain|Elements<br />nodeId|octet_string<br />node_id|false<br />false|
 |IssueNocChainResponse|NOC<br />ICAC<br />RCAC<br />IPK|octet_string<br />octet_string<br />octet_string<br />octet_string|false<br />false<br />false<br />false|
 
-DelayCommands |command|args|arg type| arg optional| |:---|:---|:---|:---|
+
+DelayCommands
+|command|args|arg type| arg optional|
+|:---|:---|:---|:---|
 |WaitForCommissioning||||
 |WaitForCommissionee|nodeId<br />expireExistingSession|node_id<br />bool|false<br />true|
 |WaitForMs|ms|int16u|false|
 |WaitForMessage|registerKey<br />message|char_string<br />char_string|false<br />false|
 
-DiscoveryCommands |command|args|arg type| arg optional| |:---|:---|:---|:---|
+
+DiscoveryCommands
+|command|args|arg type| arg optional|
+|:---|:---|:---|:---|
 |FindCommissionable||||
 |FindCommissionableByShortDiscriminator|value|int16u|false|
 |FindCommissionableByLongDiscriminator|value|int16u|false|
 |FindCommissionableByCommissioningMode||||
 |FindCommissionableByVendorId|value|vendor_id|false|
-|FindCommissionableByDeviceType|value|devtype_id|false| |FindCommissioner||||
+|FindCommissionableByDeviceType|value|devtype_id|false|
+|FindCommissioner||||
 |FindCommissionerByVendorId|value|vendor_id|false|
 |FindCommissionerByDeviceType|value|devtype_id|false|
 |FindResponse|hostName<br />instanceName<br />longDiscriminator<br />shortDiscriminator<br />vendorId<br />productId<br />commissioningMode<br />deviceType<br />deviceName<br />rotatingId<br />rotatingIdLen<br />pairingHint<br />pairingInstruction<br />supportsTcp<br />numIPs<br />port<br />mrpRetryIntervalIdle<br />mrpRetryIntervalActive<br />mrpRetryActiveThreshold<br />isICDOperatingAsLIT|char_string<br />char_string<br />int16u<br />int16u<br />vendor_id<br />int16u<br />int8u<br />devtype_id<br />char_string<br />octet_string<br />int64u<br />int16u<br />char_string<br />boolean<br />int8u<br />int16u<br />int32u<br />int32u<br />int16u<br />boolean|false<br />false<br />false<br />false<br />false<br />false<br />false<br />false<br />false<br />false<br />false<br />false<br />false<br />false<br />false<br />false<br />true<br />true<br />true<br />true|
 
-EqualityCommands |command|args|arg type| arg optional| |:---|:---|:---|:---|
+
+EqualityCommands
+|command|args|arg type| arg optional|
+|:---|:---|:---|:---|
 |BooleanEquals|Value1<br />Value2|boolean<br />boolean|false<br />false|
 |SignedNumberEquals|Value1<br />Value2|int64s<br />int64s|false<br />false|
 |UnsignedNumberEquals|Value1<br />Value2|int64u<br />int64u|false<br />false|
 |EqualityResponse|Equals|bool|false|
 
-LogCommands |command|args|arg type| arg optional| |:---|:---|:---|:---|
+
+LogCommands
+|command|args|arg type| arg optional|
+|:---|:---|:---|:---|
 |Log|message|char_string|false|
 |UserPrompt|message<br />expectedValue|char_string<br />char_string|false<br />true|
 
-SystemCommands |command|args|arg type| arg optional| |:---|:---|:---|:---|
-|Start|registerKey<br />discriminator<br />port<br />minCommissioningTimeout<br />kvs<br />filepath<br />otaDownloadPath|char_string<br />int16u<br />int16u<br />int16u<br />char_string<br />char_string<br />char_string|true<br />true<br />true<br />true<br />true<br />true<br />true|
-|Stop|registerKey|char_string|true| |Reboot|registerKey|char_string|true|
+
+SystemCommands
+|command|args|arg type| arg optional|
+|:---|:---|:---|:---|
+|Start|registerKey<br />discriminator<br />port<br />minCommissioningTimeout<br />kvs<br />filepath<br />otaDownloadPath<br />endUserSupportLogPath<br />networkDiagnosticsLogPath<br />crashLogPath|char_string<br />int16u<br />int16u<br />int16u<br />char_string<br />char_string<br />char_string<br />char_string<br />char_string<br />char_string|true<br />true<br />true<br />true<br />true<br />true<br />true<br />true<br />true<br />true|
+|Stop|registerKey|char_string|true|
+|Reboot|registerKey|char_string|true|
 |FactoryReset|registerKey|char_string|true|
 |CreateOtaImage|otaImageFilePath<br />rawImageFilePath<br />rawImageContent|char_string<br />char_string<br />char_string|false<br />false<br />false|
 |CompareFiles|file1<br />file2|char_string<br />char_string|false<br />false|
+|CreateFile|filePath<br />fileContent|char_string<br />char_string|false<br />false|
+|DeleteFile|filePath|char_string|false|

docs/testing/yaml_schema.md

@@ -6,30 +6,70 @@ Script: generate_yaml_doc_tables.py
 
 # YAML Schema
 
-YAML schema |key | type| supports variables |:---|:---|:---| |name |str|| |PICS
-|str,list|| |config | | | |  nodeId |int|| |  cluster |str|| | 
-endpoint |int|| |  _variableName_ | | | |    type |type|| | 
-  defaultValue |Any|| |tests | | | |  label |str|| |  identity
-|str|| |  nodeId |int|Y| |  runIf |str|| |  groupId |int|Y|
-|  endpoint |int|Y| |  cluster |str|| |  attribute |str|| | 
-command |str|| |  event |str|| |  eventNumber |int|Y| |  disabled
-|bool|| |  fabricFiltered |bool|| |  verification |str|| |  PICS
-|str|| |  arguments | | | |    values | | | |     
-value |NoneType,bool,int,float,dict,list|Y| |      name |str||
-|    value |NoneType,bool,int,float,dict,list|Y| |  response | |Y
-| |    value |NoneType,bool,int,float,dict,list|Y| |    name
-|str|| |    error |str|| |    clusterError |int|| | 
-  constraints | | | |      hasValue |bool|| |   
-  type |str|| |      minLength |int|| |     
-maxLength |int|| |      isHexString |bool|| |     
-startsWith |str|| |      endsWith |str|| |     
-isUpperCase |bool|| |      isLowerCase |bool|| |   
-  minValue |int,float|Y| |      maxValue |int,float|Y|
-|      contains |list|| |      excludes |list||
-|      hasMasksSet |list|| |      hasMasksClear
-|list|| |      notValue |NoneType,bool,int,float,list,dict|Y|
-|      anyOf |list|| |    saveAs |str|| |   
-saveDataVersschemaionAs |str|| |  saveResponseAs |str|| |  minInterval
-|int|| |  maxInterval |int|| |  keepSubscriptions |bool|| | 
-timeout |int|| |  timedInteractionTimeoutMs |int|| |  dataVersion
-|list,int|Y| |  busyWaitMs |int|| |  wait |str||
+YAML schema
+|key | type| supports variables
+|:---|:---|:---|
+|name |str||
+|PICS |str,list||
+|config | | |
+|  nodeId |int||
+|  cluster |str||
+|  endpoint |int||
+|  _variableName_ | | |
+|    type |type||
+|    defaultValue |Any||
+|tests | | |
+|  label |str||
+|  identity |str||
+|  nodeId |int|Y|
+|  runIf |str||
+|  groupId |int|Y|
+|  endpoint |int|Y|
+|  cluster |str||
+|  attribute |str||
+|  command |str||
+|  event |str||
+|  eventNumber |int|Y|
+|  disabled |bool||
+|  fabricFiltered |bool||
+|  verification |str||
+|  PICS |str||
+|  arguments | | |
+|    values | | |
+|      value |NoneType,bool,int,float,dict,list|Y|
+|      name |str||
+|    value |NoneType,bool,int,float,dict,list|Y|
+|  response | |Y |
+|    value |NoneType,bool,int,float,dict,list|Y|
+|    name |str||
+|    error |str||
+|    clusterError |int||
+|    constraints | | |
+|      hasValue |bool||
+|      type |str||
+|      minLength |int||
+|      maxLength |int||
+|      isHexString |bool||
+|      startsWith |str||
+|      endsWith |str||
+|      isUpperCase |bool||
+|      isLowerCase |bool||
+|      minValue |int,float|Y|
+|      maxValue |int,float|Y|
+|      contains |list||
+|      excludes |list||
+|      hasMasksSet |list||
+|      hasMasksClear |list||
+|      notValue |NoneType,bool,int,float,list,dict|Y|
+|      anyOf |list||
+|    saveAs |str||
+|    saveDataVersschemaionAs |str||
+|  saveResponseAs |str||
+|  minInterval |int||
+|  maxInterval |int||
+|  keepSubscriptions |bool||
+|  timeout |int||
+|  timedInteractionTimeoutMs |int||
+|  dataVersion |list,int|Y|
+|  busyWaitMs |int||
+|  wait |str||

scripts/py_matter_yamltests/generate_yaml_doc_tables.py

@@ -26,12 +26,16 @@
 
 
 def get_type_list_and_vars(typetuple) -> (list[type], bool):
+    "Returns a list of supported types for this type tuple and a bool indicating if variables are supported."
     # If str is one of the supported types, and other base types are supported,
     # this means it supports variables.
     # This is a heuristic, but it's true for now.
     try:
         typelist = list(typetuple)
         if str in typelist:
+            # The tuple passed from the yaml parser is a tuple of type classes
+            # Here, we directly compare to the base type because that's what
+            # we get from the parser (ex. (bool, int, str))
             reduced = [t for t in typelist if t != str]
             if reduced != [list]:
                 return (reduced, True)