feat: make DuT DT-aux capable (#77)

feat: add FlasherExample connector (only for testing purpose) refactor : DUT auxiliary robot version is fully using pykiso interface (TestEntity class usage remove) refactor : refactor DUT auxiliary implementation refactor : remove unnecessary example_test_auxiliary (duplicate code) refactor : remove unnecessary code from test_message_handler module test: adapt DUT auxiliary pytest (Robot version too) refactor: remove the usage of the none existing example_test_auxiliary in virtual example refactor: add deprecated warning message refactor: remove AuxiliaryInterface class from coverage
eclipse · Jul 4, 2022 · 3d7b683 · 3d7b683
1 parent f5cd266
commit 3d7b683
Show file tree

Hide file tree

Showing 32 changed files with 1,058 additions and 1,211 deletions.
diff --git a/NOTICE.md b/NOTICE.md
@@ -81,6 +81,10 @@ PyVISA-py 0.5.2
 
  * License: MIT
 
+tabulate 0.8.10
+
+ * License: MIT
+
 ## Cryptography
 
 Content may contain encryption software. The country in which you are currently

diff --git a/docs/auxiliaries.rst b/docs/auxiliaries.rst
@@ -12,9 +12,6 @@ Included Auxiliaries
 .. automodule:: pykiso.lib.auxiliaries.communication_auxiliary
     :members:
 
-.. automodule:: pykiso.lib.auxiliaries.example_test_auxiliary
-    :members:
-
 .. automodule:: pykiso.lib.auxiliaries.simulated_auxiliary
     :members:
 

diff --git a/docs/auxiliaries/example_test_auxiliary.rst b/docs/auxiliaries/example_test_auxiliary.rst
diff --git a/docs/auxiliaries/index.rst b/docs/auxiliaries/index.rst
@@ -11,7 +11,6 @@ Included Auxiliaries
     acroname_auxiliary
     communication_auxiliary
     dut_auxiliary
-    example_test_auxiliary
     instrument_control_auxiliary
     mp_proxy_auxiliary
     proxy_auxiliary

diff --git a/docs/connectors/Flashers/flash_example.rst b/docs/connectors/Flashers/flash_example.rst
@@ -0,0 +1,5 @@
+cc_flasher_example
+==================
+
+.. automodule:: pykiso.lib.connectors.cc_flasher_example
+    :members:
diff --git a/docs/connectors/Flashers/index.rst b/docs/connectors/Flashers/index.rst
@@ -9,3 +9,4 @@ Flashers
 
     flash_jlink
     flash_lauterbach
+    flash_example
diff --git a/docs/whats_new/version_ongoing.rst b/docs/whats_new/version_ongoing.rst
@@ -18,7 +18,8 @@ and one for the reception.
 Proxy Auxiliary adaption
 ^^^^^^^^^^^^^^^^^^^^^^^^
 refactor code of the proxy auxiliary to fit with the brand new double threaded
-auxiliary interface
+auxiliary interface.
+Add useful decorators for common behaviors open_connector, close_connector, flash_target.
 
 CCProxy channel adaption
 ^^^^^^^^^^^^^^^^^^^^^^^^
@@ -29,3 +30,8 @@ Communication Auxiliary adaption
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 refactor code of the communication auxiliary to fit with the brand new double
 threaded auxiliary interface
+
+DUT Auxiliary adaption
+^^^^^^^^^^^^^^^^^^^^^^
+refactor/redesign of the device under test auxiliary to fit with the brand new double
+threaded auxiliary interface
diff --git a/examples/conf_access.yaml b/examples/conf_access.yaml
@@ -3,29 +3,29 @@ auxiliaries:
     connectors:
         com: chan1
     config: null
-    type: ext_lib/example_test_auxiliary.py:ExampleAuxiliary
+    type: pykiso.lib.auxiliaries.dut_auxiliary:DUTAuxiliary
   aux2:
     connectors:
         com:   chan2
         flash: chan3
-    type: pykiso.lib.auxiliaries.example_test_auxiliary:ExampleAuxiliary
+    type: pykiso.lib.auxiliaries.dut_auxiliary:DUTAuxiliary
   aux3:
     connectors:
         com:   chan4
     type: pykiso.lib.auxiliaries.dut_auxiliary:DUTAuxiliary
 connectors:
   chan1:
-    config: null
+    config:
+      param_1: "value 1"
+      param_2: 2000
     type: ext_lib/cc_example.py:CCExample
   chan2:
     type: ext_lib/cc_example.py:CCExample
   chan4:
     type: ext_lib/cc_example.py:CCExample
   chan3:
-    config:
-        param_1: "value 1"
-        param_2: 2000
-    type: ext_lib/cc_example.py:CCExample
+    config: ~
+    type: pykiso.lib.connectors.cc_flasher_example:FlasherExample
 test_suite_list:
 - suite_dir: conf_access
   test_filter_pattern: '*.py'

diff --git a/examples/conf_access/test_access.py b/examples/conf_access/test_access.py
@@ -67,9 +67,9 @@ def test_run(self):
             logging.info("Auxiliary aux2 has a flasher")
 
         # just make a simple assertion in order to raise an error and
-        # stop test execution if a  specific value is not given to chan3
+        # stop test execution if a specific value is not given to chan1
         # connector
-        self.assertEqual(yaml_config.connectors.chan3.config.param_1, "value 1")
+        self.assertEqual(yaml_config.connectors.chan1.config.param_1, "value 1")
 
     def tearDown(self):
         """Just print aux2 configuration and it related connector too."""
@@ -82,10 +82,10 @@ def tearDown(self):
 
         logging.info("*** print associated connector configuration ***")
         logging.info(
-            f"flasher chan3 param 1: {yaml_config.connectors.chan3.config.param_1}"
+            f"channel chan1 param 1: {yaml_config.connectors.chan1.config.param_1}"
         )
         logging.info(
-            f"flasher chan3 param 2: {yaml_config.connectors.chan3.config.param_2}"
+            f"channel chan1 param 2: {yaml_config.connectors.chan1.config.param_2}"
         )
-        logging.info(f"flasher chan3 type: {yaml_config.connectors.chan3.type}")
+        logging.info(f"channel chan1 type: {yaml_config.connectors.chan1.type}")
         logging.info(f"connector chan2 type: {yaml_config.connectors.chan2.type}")
diff --git a/examples/dummy.yaml b/examples/dummy.yaml
@@ -3,15 +3,15 @@ auxiliaries:
     connectors:
         com: chan1
     config: null
-    type: ext_lib/example_test_auxiliary.py:ExampleAuxiliary
+    type: pykiso.lib.auxiliaries.dut_auxiliary:DUTAuxiliary
   aux2:
     connectors:
         com:   chan2
-        flash: chan3
-    type: pykiso.lib.auxiliaries.example_test_auxiliary:ExampleAuxiliary
+    type: pykiso.lib.auxiliaries.dut_auxiliary:DUTAuxiliary
   aux3:
     connectors:
         com:   chan4
+        flash: chan3
     type: pykiso.lib.auxiliaries.dut_auxiliary:DUTAuxiliary
 connectors:
   chan1:
@@ -22,9 +22,8 @@ connectors:
   chan4:
     type: ext_lib/cc_example.py:CCExample
   chan3:
-    config:
-        configKey: "config value"
-    type: ext_lib/cc_example.py:CCExample
+    config: null
+    type: pykiso.lib.connectors.cc_flasher_example:FlasherExample
 test_suite_list:
 - suite_dir: test_suite_1
   test_filter_pattern: '*.py'

diff --git a/examples/dummy_env_var.yaml b/examples/dummy_env_var.yaml
@@ -3,22 +3,21 @@ auxiliaries:
     connectors:
         com: chan1
     config: null
-    type: ext_lib/example_test_auxiliary.py:ExampleAuxiliary
+    type: pykiso.lib.auxiliaries.dut_auxiliary:DUTAuxiliary
   aux2:
     connectors:
-        com:   chan2
-        flash: chan3
-    type: pykiso.lib.auxiliaries.example_test_auxiliary:ExampleAuxiliary
+      com:   chan2
+      flash: chan3
+    type: pykiso.lib.auxiliaries.dut_auxiliary:DUTAuxiliary
 connectors:
   chan1:
     config: null
     type: ext_lib/cc_example.py:CCExample
   chan2:
     type: ext_lib/cc_example.py:CCExample
   chan3:
-    config:
-        configKey: "config value"
-    type: ext_lib/cc_example.py:CCExample
+    config: null
+    type: pykiso.lib.connectors.cc_flasher_example:FlasherExample
 test_suite_list:
 - suite_dir: ENV{TEST_SUITE_1}
   test_filter_pattern: '*.py'

diff --git a/examples/templates/suite_dut/test_override.py b/examples/templates/suite_dut/test_override.py
@@ -66,7 +66,7 @@ def test_run(self):
             test_case=self.test_case_id,
         )
 
-        state = aux1.run_command(awesome_message, blocking=True, timeout_in_s=10)
+        state = aux1.send_fixture_command(awesome_message, timeout=10)
 
         self.assertEqual(state, True)
 

diff --git a/examples/test_suite_1/test_suite_1.py b/examples/test_suite_1/test_suite_1.py
@@ -30,9 +30,9 @@
 
 
 @pykiso.define_test_parameters(suite_id=1, aux_list=[aux1, aux2])
-class SuiteSetup(pykiso.BasicTestSuiteSetup):
+class SuiteSetup(pykiso.RemoteTestSuiteSetup):
     """This test suite setup will be executed using base behavior
-    given by BasicTestSuiteSetup.
+    given by RemoteTestSuiteSetup.
 
 
     Using decorator define_test_parameters the following parameters will
@@ -41,24 +41,13 @@ class SuiteSetup(pykiso.BasicTestSuiteSetup):
     -> suite_id : set to 1
     -> aux_list : test suite setup executed using aux1 and aux2 (see
     yaml configuration file)
-    -> setup_timeout : ITF will wait 2 seconds (maximum) to receive a
-    report from device under test otherwise an abort command is sent.
-
-    If setup_timeout is not given the default timeout value is 10
-    seconds.
     """
 
-    module = importlib.import_module("pykiso.auxiliaries")
-    attribute = dir(module)
-    logging.error(f"this is the attribute of pykiso.auxiliaries: {attribute}")
-
-    pass
-
 
 @pykiso.define_test_parameters(suite_id=1, aux_list=[aux1, aux2])
-class SuiteTearDown(pykiso.BasicTestSuiteTeardown):
+class SuiteTearDown(pykiso.RemoteTestSuiteTeardown):
     """This test suite teardown will be executed using base behavior
-    given by RemoteTestSuiteTeardown.
+    given by RemoteTestSuiteSetup.
 
     Using decorator define_test_parameters the following parameters will
     be applied on test suite teardown :
@@ -68,8 +57,6 @@ class SuiteTearDown(pykiso.BasicTestSuiteTeardown):
     yaml configuration file)
     """
 
-    pass
-
 
 @pykiso.define_test_parameters(
     suite_id=1,
@@ -172,10 +159,6 @@ def test_run(self):
         This test will be run 3 times in order to test stability (setUp
         and tearDown excluded as the flags are set to False).
         """
-        module = importlib.import_module("pykiso.auxiliaries")
-        attribute = dir(module)
-        logging.error(f"this is the attribute of pykiso.auxiliaries: {attribute}")
-
         logging.info(f"------------suspend auxiliaries run-------------")
         aux3.suspend()
         aux2.suspend()
@@ -218,5 +201,3 @@ class MyTest3(pykiso.RemoteTest):
     If setup_timeout, run_timeout and teardown_timeout are not given the
     default timeout value is 10 seconds for each.
     """
-
-    pass
diff --git a/examples/test_suite_2/test_suite_2.py b/examples/test_suite_2/test_suite_2.py
@@ -23,8 +23,8 @@
 from pykiso.auxiliaries import aux1, aux2
 
 
-@pykiso.define_test_parameters(suite_id=2, case_id=0, aux_list=[aux1, aux2])
-class SuiteSetup(pykiso.BasicTestSuiteSetup):
+@pykiso.define_test_parameters(suite_id=2, aux_list=[aux1, aux2])
+class SuiteSetup(pykiso.RemoteTestSuiteSetup):
     """This test suite setup will be executed using base behavior given
     by BasicTestSuiteTeardown.
 
@@ -39,11 +39,9 @@ class SuiteSetup(pykiso.BasicTestSuiteSetup):
     yaml configuration file)
     """
 
-    pass
 
-
-@pykiso.define_test_parameters(suite_id=2, case_id=0, aux_list=[aux1, aux2])
-class SuiteTearDown(pykiso.BasicTestSuiteTeardown):
+@pykiso.define_test_parameters(suite_id=2, aux_list=[aux1, aux2])
+class SuiteTearDown(pykiso.RemoteTestSuiteTeardown):
     """This test suite teardown will be executed using base behavior
     given by BasicTestSuiteTeardown.
 
@@ -58,16 +56,14 @@ class SuiteTearDown(pykiso.BasicTestSuiteTeardown):
     yaml configuration file)
     """
 
-    pass
-
 
 @pykiso.define_test_parameters(
     suite_id=2,
     case_id=1,
     aux_list=[aux1],
     tag={"variant": ["variant3", "variant2"], "branch_level": ["daily"]},
 )
-class MyTest4(pykiso.BasicTest):
+class MyTest4(pykiso.RemoteTest):
     """This test case definition will be executed using base behavior
     given by BasicTest.
 
@@ -82,11 +78,9 @@ class MyTest4(pykiso.BasicTest):
     -> tag: [optional] allows the run of subset of tests
     """
 
-    pass
-
 
 @pykiso.define_test_parameters(suite_id=2, case_id=2, aux_list=[aux2])
-class MyTest2(pykiso.BasicTest):
+class MyTest5(pykiso.RemoteTest):
     """This test case definition will be executed using base behavior
     given by BasicTest.
 
@@ -98,5 +92,3 @@ class MyTest2(pykiso.BasicTest):
     -> aux_list : test case executed using aux2(see yaml
     configuration file)
     """
-
-    pass
diff --git a/examples/virtual.yaml b/examples/virtual.yaml
@@ -8,7 +8,7 @@ auxiliaries:
     connectors:
         com: chan1
     config: null
-    type: pykiso.lib.auxiliaries.example_test_auxiliary:ExampleAuxiliary
+    type: pykiso.lib.auxiliaries.dut_auxiliary:DUTAuxiliary
 connectors:
   chan1:
     config: {dest_ip : '127.0.0.1', dest_port: 5005}

diff --git a/pyproject.toml b/pyproject.toml
@@ -93,6 +93,7 @@ omit = [
     "*/tasks.py",
     "*/src/pykiso/tool/*",
     "*/src/pykiso/__main__.py",
+    "*/src/pykiso/interfaces/thread_auxiliary.py",
     "*__init__.py",
 ]