tiny-test-fw: move to tools/esp_python_packages:

make `tiny_test_fw` as a package and move to root path of idf python
packages

tools/ci/python_packages/tiny_test_fw/docs/Makefile

@@ -0,0 +1,26 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXAPI     = sphinx-apidoc
+SPHINXAPISRC  = ..
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = TinyTestFW
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# define the files to be excluded here
+EXCLUEDLIST   = "$(SPHINXAPISRC)/example.py"
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXAPI) -o $(SOURCEDIR) $(SPHINXAPISRC) $(EXCLUEDLIST)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

tools/ci/python_packages/tiny_test_fw/docs/conf.py

@@ -0,0 +1,157 @@
+# -*- coding: utf-8 -*-
+#
+# TinyTestFW documentation build configuration file, created by
+# sphinx-quickstart on Thu Sep 21 20:19:12 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
+
+# import sphinx_rtd_theme
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.autodoc',
+              'sphinx.ext.viewcode',
+              'plantweb.directive']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'TinyTestFW'
+copyright = u'2017, Espressif'
+author = u'Espressif'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = u'0.1'
+# The full version, including alpha/beta/rc tags.
+release = u'0.1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'TinyTestFWdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'TinyTestFW.tex', u'TinyTestFW Documentation',
+     u'He Yinling', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'tinytestfw', u'TinyTestFW Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'TinyTestFW', u'TinyTestFW Documentation',
+     author, 'TinyTestFW', 'One line description of project.',
+     'Miscellaneous'),
+]

tools/ci/python_packages/tiny_test_fw/docs/index.rst

@@ -0,0 +1,204 @@
+.. TinyTestFW documentation master file, created by
+   sphinx-quickstart on Thu Sep 21 20:19:12 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to TinyTestFW's documentation!
+======================================
+
+We have a lot of test which depends on interact with DUT via communication port.
+Usually we send command to the port and then check response to see if the test succeed.
+TinyTestFW is designed for such scenarios.
+It supports ESP-IDF applications and can be adapted to other applications by writing new bundles.
+
+Example
+-------
+
+Let's first check a simple example::
+
+    import re
+    import os
+    import sys
+    test_fw_path = os.getenv("TEST_FW_PATH")
+    if test_fw_path:
+        sys.path.insert(0, test_fw_path)
+
+    import TinyFW
+    from IDF import IDFApp, IDFDUT
+
+
+    @TinyFW.test_method(app=IDFApp.Example, dut=IDFDUT.IDFDUT, env_tag="Example_WIFI",
+                        chip="ESP32", module="examples", execution_time=1)
+    def test_examples_protocol_https_request(env, extra_data):
+        """
+        steps: |
+          1. join AP
+          2. connect to www.howsmyssl.com:443
+          3. send http request
+        """
+        dut1 = env.get_dut("https_request", "examples/protocols/https_request")
+        dut1.start_app()
+        dut1.expect("Connecting to www.howsmyssl.com:443", timeout=30)
+        dut1.expect("Performing the SSL/TLS handshake")
+        dut1.expect("Certificate verified.", timeout=15)
+        dut1.expect_all(re.compile(r"Cipher suite is TLS-ECDHE-RSA-WITH-AES-128-GCM-SHA256"),
+                        "Reading HTTP response",
+                        timeout=20)
+        dut1.expect(re.compile(r"Completed (\d) requests"))
+
+
+    if __name__ == '__main__':
+        TinyFW.set_default_config(env_config_file="EnvConfigTemplate.yml")
+        test_examples_protocol_https_request()
+
+
+SOP for adding test cases
+-------------------------
+
+1. Import test framework:
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+* We assume ``TEST_FW_PATH`` is pre-defined before running the tests
+* Then we can import python packages and files from ``TEST_FW_PATH``
+
+2. Define test case:
+^^^^^^^^^^^^^^^^^^^^
+
+1. Define test case ``test_xxx(env, extra_data)``
+    * env: instance of test env, see :doc:`Test Env <Env>` for details
+    * extra_data: extra data passed from test case caller
+2. Add decorator for test case
+    * add decorator ``TinyFW.test_method`` to test method
+    * define default case configs and filters in decorator, see :doc:`TinyFW.test_method <TinyFW>`
+
+3. Execute test cases:
+^^^^^^^^^^^^^^^^^^^^^^
+
+* define in ``main`` section and execute from this file
+    1. set preset configs(optional). If the config is not define in case decorator, it will use the preset configs.
+    2. call test case method:
+        * if you don't pass any arguments, it will use default values
+        * you can pass ``extra_data`` to test case by adding ``extra_data=some_data`` as kwarg of test case method.
+          default value for extra_data is None.
+        * you can overwrite test case config by adding them as kwarg of test case method.
+          It will overwrite preset configs and case default configs.
+
+    Examples::
+
+        test_examples_protocol_https_request(extra_data=["data1", "data2"], dut=SomeOtherDUT, env_tag="OtherEnv")
+
+* or, use ``runner`` to execute. see :doc:`runner <Runner>` for details
+
+Test FW features
+----------------
+
+1. Test Environment:
+    1. DUT: DUT class provides methods to interact with DUT
+        * read/write through port
+        * expect method which supports expect one or multiple string or RegEx
+        * tool methods provided by the tool bundle, like ``start_app``, ``reset``
+    2. App:
+        * provide some specific features to the test application of DUT, for example:
+            * SDK path
+            * SDK tools
+            * application information like partition table, download configs
+    3. Environment Configs:
+        * support get env configs from config file or auto-detect from current PC
+        * provide ``get_variable`` method to get variables
+2. Allow to customize components (DUT, App) to support different devices
+3. Integrate to CI:
+    * provide interfaces for Gitlab-CI
+    * provide ``search case`` and ``runner`` interfaces, able to integrate with other CI
+
+
+Class Diagram
+=============
+.. uml::
+
+   class BaseDUT {
+   {field} app
+   {method} expect
+   {method} expect_any
+   {method} expect_all
+   {method} read
+   {method} write
+   {method} start_receive
+   {method} stop_receive
+   {method} close
+   }
+   class SerialDUT {
+   {method} _port_read
+   {method} _port_write
+   {method} _port_open
+   {method} _port_close
+   }
+   class IDFDUT {
+   {method} reset
+   {method} start_app
+   }
+   class BaseApp {
+   {method} get_sdk_path
+   {method} get_log_folder
+   }
+   class IDFApp {
+   {field} flash_files
+   {field} flash_settings
+   {field} partition_table
+   }
+   class Example {
+   {method} get_binary_path
+   }
+   class EnvConfig {
+   {method} get_variable
+   }
+   class Env {
+   {field} config
+   {field} allocated_duts
+   {field} app_cls
+   {method} get_dut
+   {method} close_dut
+   {method} get_variable
+   {method} get_pc_nic_info
+   {method} close
+   }
+
+   SerialDUT --|> BaseDUT
+   IDFDUT --|> SerialDUT
+   IDFApp --|> BaseApp
+   Example --|> IDFApp
+   Env *-- EnvConfig
+   Env *-- BaseDUT
+   Env o-- BaseApp
+   BaseDUT o-- BaseApp
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   modules
+
+Dependencies
+============
+
+Support for both Python2 and Python3 (tested on python 2.7.13 and 3.6.2).
+
+The following 3rd party lib is required:
+
+    * pyserial
+    * pyyaml
+    * junit_xml
+    * netifaces
+    * matplotlib (if use Utility.LineChart)
+
+These libraries can be installed by running ``pip install --user -r requirements.txt`` in tiny-test-fw directory.
+
+To build document, we need to install ``Sphinx``, ``plantweb`` and ``sphinx-rtd-theme`` (you may replace this with your own theme). ``plantweb`` requires internet access during building document.
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`