From 9942b98a4aa2d50f052c95ae09676a18b6b1d773 Mon Sep 17 00:00:00 2001
From: Jakub Uliarczyk <117639042+jaul-nsc@users.noreply.github.com>
Date: Wed, 8 Jan 2025 19:49:32 +0100
Subject: [PATCH] [tcat] add tlv command tree (#11077)

This commit adds 'tlv' command tree to the BBTC CLI.
The 'tlv' command has two subcommands: 'list' and 'send'.
The 'tlv list' prints available TLVs types that can be used in the 'send' subcommand.
The 'tlv send <TLV_TYPE> <TLV_PAYLOAD>' allows sending specific TLV with arbitrary payloads.

Example:
`tlv send a 1234`
Send ping TLV(0x0a) with payload '1234'

The 'tlv' command tree is to gain the ability to send the TLV with any payload at any time.
This feature allows to check the behavior of TCAT device against:
- receiving of unexpected TLV
- receiving of TLV with corrupted payload
- receiving of TLVs sent in custom order
---
 tools/tcat_ble_client/cli/__init__.py     |  0
 tools/tcat_ble_client/cli/cli.py          |  2 +
 tools/tcat_ble_client/cli/tlv_commands.py | 74 +++++++++++++++++++++++
 3 files changed, 76 insertions(+)
 create mode 100644 tools/tcat_ble_client/cli/__init__.py
 create mode 100644 tools/tcat_ble_client/cli/tlv_commands.py

diff --git a/tools/tcat_ble_client/cli/__init__.py b/tools/tcat_ble_client/cli/__init__.py
new file mode 100644
index 00000000000..e69de29bb2d
diff --git a/tools/tcat_ble_client/cli/cli.py b/tools/tcat_ble_client/cli/cli.py
index 34ff977a7c2..6f397f6a28c 100644
--- a/tools/tcat_ble_client/cli/cli.py
+++ b/tools/tcat_ble_client/cli/cli.py
@@ -33,6 +33,7 @@
                                GetDeviceIdCommand, GetPskdHash, GetExtPanIDCommand, GetNetworkNameCommand,
                                GetProvisioningUrlCommand, PingCommand, GetRandomNumberChallenge, ThreadStateCommand,
                                ScanCommand, PresentHash)
+from .tlv_commands import TlvCommand
 from cli.dataset_commands import (DatasetCommand)
 from dataset.dataset import ThreadDataset
 from typing import Optional
@@ -61,6 +62,7 @@ def __init__(self,
             'random_challenge': GetRandomNumberChallenge(),
             'present_hash': PresentHash(),
             'peer_pskd_hash': GetPskdHash(),
+            'tlv': TlvCommand()
         }
         self._context = {
             'ble_sstream': ble_sstream,
diff --git a/tools/tcat_ble_client/cli/tlv_commands.py b/tools/tcat_ble_client/cli/tlv_commands.py
new file mode 100644
index 00000000000..3beb985e0c5
--- /dev/null
+++ b/tools/tcat_ble_client/cli/tlv_commands.py
@@ -0,0 +1,74 @@
+"""
+  Copyright (c) 2024, The OpenThread Authors.
+  All rights reserved.
+
+  Redistribution and use in source and binary forms, with or without
+  modification, are permitted provided that the following conditions are met:
+  1. Redistributions of source code must retain the above copyright
+     notice, this list of conditions and the following disclaimer.
+  2. Redistributions in binary form must reproduce the above copyright
+     notice, this list of conditions and the following disclaimer in the
+     documentation and/or other materials provided with the distribution.
+  3. Neither the name of the copyright holder nor the
+     names of its contributors may be used to endorse or promote products
+     derived from this software without specific prior written permission.
+
+  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+  POSSIBILITY OF SUCH DAMAGE.
+"""
+
+from .base_commands import BleCommand, CommandResultNone, Command
+from tlv.tlv import TLV
+from tlv.tcat_tlv import TcatTLVType
+
+
+class TlvCommandList(Command):
+
+    def get_help_string(self) -> str:
+        return 'List available TLV types to use in \'tlv send\'.'
+
+    async def execute_default(self, args, context):
+        list_tlv = "\n".join([f"{tlv.value:#x}\t{tlv.name}" for tlv in TcatTLVType])
+        print(f"\n{list_tlv}")
+        return CommandResultNone()
+
+
+class TlvCommandSend(BleCommand):
+
+    def get_log_string(self) -> str:
+        pass
+
+    def get_help_string(self) -> str:
+        return 'Send TLV with arbitrary payload: \'tlv send <TLV_TYPE> <TLV_PAYLOAD>\'.'
+
+    def prepare_data(self, args, context):
+        tlv_type = TcatTLVType(int(args[0], 16))
+        tlv_value = bytes()
+        try:
+            tlv_value = bytes.fromhex(args[1])
+        except IndexError:
+            pass
+        data = TLV(tlv_type.value, tlv_value).to_bytes()
+        return data
+
+
+class TlvCommand(Command):
+
+    def __init__(self):
+        self._subcommands = {'list': TlvCommandList(), 'send': TlvCommandSend()}
+
+    def get_help_string(self) -> str:
+        return 'Send TLV with arbitrary payload.'
+
+    async def execute_default(self, args, context):
+        self.print_help()
+        return CommandResultNone()