From 5f220682cda8570939d4b3538ca257ee97861992 Mon Sep 17 00:00:00 2001
From: Yakun Xu <xyk@google.com>
Date: Fri, 22 Mar 2019 23:11:39 +0800
Subject: [PATCH] [tests] add an inspector for travis certification tests
 (#3700)

This commit adds a debugger to inspect nodes status.
---
 tests/scripts/thread-cert/README.md | 50 +++++++++++++++
 tests/scripts/thread-cert/debug.py  | 97 +++++++++++++++++++++++++++++
 2 files changed, 147 insertions(+)
 create mode 100644 tests/scripts/thread-cert/README.md
 create mode 100644 tests/scripts/thread-cert/debug.py

diff --git a/tests/scripts/thread-cert/README.md b/tests/scripts/thread-cert/README.md
new file mode 100644
index 000000000..2abb66f3d
--- /dev/null
+++ b/tests/scripts/thread-cert/README.md
@@ -0,0 +1,50 @@
+OpenThread Certification Tests
+==============================
+
+Inspector
+--------
+
+Inspect nodes status by the following modification:
+
+1. Insert the inspector to where you want to inspect.
+
+```python
+import debug
+debug.Inspector(self).inspect()
+```
+
+2. Run the test and it will stop at the line above and prompt `#`.
+
+```sh
+./script/test clean build cert tests/scripts/thread-cert/Cert_5_1_01_RouterAttach.py
+```
+
+3. Inspect
+
+```sh
+#
+# 1
+> state
+leader
+> exit
+# 2
+> panid
+face
+> exit
+# exit
+```
+
+### CLI reference
+
+#### `#` mode
+This is selection mode. You may select the node to inspect here.
+
+- `list`      - list available nodes.
+- `exit`      - end inspecting, continue running test case.
+- \<number\>   - select the node with id \<number\>. This will result in entering `>`  mode.
+
+#### `>` mode
+This is node mode. You may run OpenThread CLI here.
+
+* `exit`      - go back to `#` mode.
+
diff --git a/tests/scripts/thread-cert/debug.py b/tests/scripts/thread-cert/debug.py
new file mode 100644
index 000000000..0d70593a4
--- /dev/null
+++ b/tests/scripts/thread-cert/debug.py
@@ -0,0 +1,97 @@
+#!/usr/bin/env python
+#
+#  Copyright (c) 2019, 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.
+#
+
+class Inspector:
+    """This class provides a way to inspect node status of a test case.
+
+    USAGE:
+        `#` mode
+            This is selection mode. You may select the node to inspect here.
+
+            `list`      - list available nodes.
+            `exit`      - end inspecting, continue running test case.
+            <numbers>   - select the node with id <number>. This will result in enter `>  mode.
+
+        `>` mode
+            This is node mode. You may run OpenThread CLI here.
+            `exit`      - go back to `#` mode.
+
+    EXAMPLE:
+        #
+        # 1
+        > state
+        leader
+        > exit
+        # 2
+        > panid
+        face
+        > exit
+        # exit
+    """
+
+    def __init__(self, test_case):
+        """ Initialize a inspector.
+
+        Args:
+            test_case: The test case to inspect
+        """
+        self.test_case = test_case
+
+    def inspect_node(self, nodeid):
+        """ Inspect the node with the given nodeid.
+
+        Args:
+            nodeid: key in self.test_case.nodes.
+        """
+        node = self.test_case.nodes[nodeid]
+        while True:
+            line = raw_input('> ')
+            if not line:
+                continue
+
+            if line == 'exit':
+                break
+            else:
+                node.interface.send_command(line)
+                node.interface._expect('Done')
+
+    def inspect(self):
+        """ Start inspecting.
+        """
+        while True:
+            line = raw_input('# ')
+            if not line:
+                continue
+
+            if line.isdigit():
+                self.inspect_node(int(line))
+            elif line == 'list':
+                print(self.test_case.nodes.keys())
+            elif line == 'exit':
+                break