From 85c97967d51623358d33d6f59bc561734cb45025 Mon Sep 17 00:00:00 2001
From: Ivan Grokhotkov <ivan@espressif.com>
Date: Tue, 19 Nov 2019 15:37:38 +0100
Subject: [PATCH] tiny-test-fw: add QEMU DUT

---
 examples/get-started/blink/example_test.py   | 17 ++++-
 tools/ci/python_packages/tiny_test_fw/DUT.py |  2 +-
 tools/ci/python_packages/ttfw_idf/IDFDUT.py  | 78 ++++++++++++++++++++
 3 files changed, 92 insertions(+), 5 deletions(-)

diff --git a/examples/get-started/blink/example_test.py b/examples/get-started/blink/example_test.py
index 10815cf081..b00b033fc4 100644
--- a/examples/get-started/blink/example_test.py
+++ b/examples/get-started/blink/example_test.py
@@ -7,8 +7,17 @@ import re
 import os
 import hashlib
 
-from tiny_test_fw import Utility
-import ttfw_idf
+try:
+    import IDF
+except ImportError:
+    # This environment variable is expected on the host machine
+    test_fw_path = os.getenv("TEST_FW_PATH")
+    if test_fw_path and test_fw_path not in sys.path:
+        sys.path.insert(0, test_fw_path)
+
+    import IDF
+from IDF.IDFDUT import ESP32DUT, ESP32QEMUDUT
+import Utility
 
 
 def verify_elf_sha256_embedding(dut):
@@ -28,9 +37,9 @@ def verify_elf_sha256_embedding(dut):
         raise ValueError('ELF file SHA256 mismatch')
 
 
-@ttfw_idf.idf_example_test(env_tag="Example_WIFI")
+@IDF.idf_example_test(env_tag="Example_QEMU")
 def test_examples_blink(env, extra_data):
-    dut = env.get_dut("blink", "examples/get-started/blink", dut_class=ttfw_idf.ESP32DUT)
+    dut = env.get_dut("blink", "examples/get-started/blink", dut_class=ESP32QEMUDUT)
     binary_file = os.path.join(dut.app.binary_path, "blink.bin")
     bin_size = os.path.getsize(binary_file)
     ttfw_idf.log_performance("blink_bin_size", "{}KB".format(bin_size // 1024))
diff --git a/tools/ci/python_packages/tiny_test_fw/DUT.py b/tools/ci/python_packages/tiny_test_fw/DUT.py
index 71007d85b0..c5139c628d 100644
--- a/tools/ci/python_packages/tiny_test_fw/DUT.py
+++ b/tools/ci/python_packages/tiny_test_fw/DUT.py
@@ -766,7 +766,7 @@ class SerialDUT(BaseDUT):
         return formatted_data
 
     def _port_open(self):
-        self.port_inst = serial.Serial(self.port, **self.serial_configs)
+        self.port_inst = serial.serial_for_url(self.port, **self.serial_configs)
 
     def _port_close(self):
         self.port_inst.close()
diff --git a/tools/ci/python_packages/ttfw_idf/IDFDUT.py b/tools/ci/python_packages/ttfw_idf/IDFDUT.py
index c5e0608d5b..2665d1c36d 100644
--- a/tools/ci/python_packages/ttfw_idf/IDFDUT.py
+++ b/tools/ci/python_packages/ttfw_idf/IDFDUT.py
@@ -20,6 +20,7 @@ import re
 import functools
 import tempfile
 import subprocess
+import time
 
 # python2 and python3 queue package name is different
 try:
@@ -444,3 +445,80 @@ def get_target_by_rom_class(cls):
         if c._get_rom() == cls:
             return c.TARGET
     return None
+
+
+class IDFQEMUDUT(IDFDUT):
+    ERASE_NVS = True
+    DEFAULT_EXPECT_TIMEOUT = 30  # longer timeout, since app startup takes more time in QEMU (due to slow SHA emulation)
+    QEMU_SERIAL_PORT = 3334
+
+    def __init__(self, name, port, log_file, app, allow_dut_exception=False, **kwargs):
+        self.flash_image = tempfile.NamedTemporaryFile('rb+', suffix=".bin", prefix="qemu_flash_img")
+        self.app = app
+        self.flash_size = 4 * 1024 * 1024
+        self._write_flash_img()
+
+        args = [
+            "qemu-system-xtensa",
+            "-nographic",
+            "-machine", self.TARGET,
+            "-drive", "file={},if=mtd,format=raw".format(self.flash_image.name),
+            "-nic", "user,model=open_eth",
+            "-serial", "tcp::{},server,nowait".format(self.QEMU_SERIAL_PORT),
+            # FIXME: generate a temporary efuse binary, pass it to QEMU
+        ]
+
+        if "QEMU_BIOS_PATH" in os.environ:
+            args += [ "-L", os.environ["QEMU_BIOS_PATH"] ]
+
+        self.qemu = subprocess.Popen(args, stdin=subprocess.PIPE, stdout=sys.stdout, stderr=subprocess.STDOUT)
+
+        # FIXME: wait for QEMU to start up by interacting with its monitor
+        time.sleep(1)
+
+        super(IDFQEMUDUT, self).__init__(name, port, log_file, app, allow_dut_exception=allow_dut_exception, **kwargs)
+
+    def _write_flash_img(self):
+        self.flash_image.seek(0)
+        self.flash_image.write(b'\x00' * self.flash_size)
+        for offs, path in self.app.flash_files:
+            with open(path, "rb") as flash_file:
+                contents = flash_file.read()
+                self.flash_image.seek(offs)
+                self.flash_image.write(contents)
+        self.flash_image.flush()
+
+    @classmethod
+    def get_mac(cls, app, port):
+        # FIXME: get this from QEMU somehow(?)
+        return "11:22:33:44:55:66"
+
+    @classmethod
+    def confirm_dut(cls, port, app, **kwargs):
+        return True, cls.TARGET
+
+    def start_app(self, erase_nvs=ERASE_NVS):
+        # TODO: implement erase_nvs
+        # since the flash image is generated every time in the constructor, maybe this isn't needed...
+        self.reset()
+
+    def reset(self):
+        self.qemu.stdin.write("system_reset\n")
+        time.sleep(1)
+
+    def erase_partition(self, partition):
+        pass
+
+    def dump_flush(self, output_file, **kwargs):
+        pass
+
+    @classmethod
+    def list_available_ports(cls):
+        return ["socket://localhost:{}".format(cls.QEMU_SERIAL_PORT)]
+
+    def close(self):
+        super(IDFQEMUDUT, self).close()
+        self.qemu.kill()
+
+class ESP32QEMUDUT(IDFQEMUDUT):
+    TARGET = "esp32"