feat: create dut-factory method (RDT-587)

[horw]

• created factory class for dut
  closes Make Create Dut Instance Easier (RDT-554) #231

[horw]

Hi @hfudev, this is a very initial draft commit for the implementation of the Fabrica class. I have a few questions. I have only created the base Dut class for now, but I don't think it's enough for the users. Should we implement other Duts in the same manner? (for example, IdfDut, SerialDut, etc.) It is possible, but it might result in a lot of duplicated code.

[horw]

As I see this task, I will split it into the following tasks:

• Move function logic under fixtures to dut_factory.
• Test the moved solution.
• Create a DutFactory class using these dut_factory functions.

[horw]

It still seems rough, but it's starting to work. @hfudev, what do you think about doing it this way? Also, I commented on some issues here.

[horw]

@hfudev, Hello, I have cleaned the history and it seems like the test was passed.

[hfudev]

# test_foo.py
from pytest_embedded.dut_factory import DutFactory


def test_foo():
    dut = DutFactory.create(app_path='components/console/test_apps/console', target='esp32c6')
    dut.run_all_single_board_cases()

unfortunately it's not working with error message

            _pexpect_logfile = os.path.join(
>               buff_parametrized_fixtures['_meta'].logdir, f'custom-dut-{dut_index_global}.txt'
            )
E           KeyError: '_meta'

Seems like the set_buff_parametrized_fixtures will be triggered in another fixture parametrize_fixtures. If I don't use any fixture, the set_buff_parametrized_fixtures will be skipped.

and the embedded_services should also be able to pass in the DutFactory

for example

idf_qemu_dut = DutFactory.create(app_path='foo', target='esp32', embedded_services='qemu,idf')
idf_esp32_dut = DutFactory.create(app_path='foo', target='esp32', embedded_services='esp,idf')

Besides, could you also add the DutFactory to pytest_embedded/__init__.py __all__?

[horw]

@hfudev
Thanks for your review! Your testcase was very useful!

This commit contains the following changes:

• parametrize_fixtures changed to be autouse, which helps initialize set_buff_parametrized_fixtures.
• Added unit_tester.
• Added a test for esp,idf.
• Call DutFactory.close() after every test, not the session.

Do you have any other testcase I can try to implement?

Further steps:

• Add the DutFactory to pytest_embedded/__init__.py __all__.
• Check dut_factory again, as there was some conflict related to the update in plugin.py when rebasing (I have just accepted my changes).
• Check for possible issues with dut-{number}.

[hfudev]

The code changes LGTM. Left some comments.

Besides of the "reverse dependency" issue, another question is that now we have to touch two places when we're introducing a new param right?

for example, if we support --esptool-version for `EspSerial, how many files shall we touch? (we won't support that, just an example) could you help document it somewhere in the comments as well?

[horw]

for example, if we support --esptool-version for `EspSerial, how many files shall we touch? (we won't support that, just an example) could you help document it somewhere in the comments as well?

Hello, let's take wokwi_timeout as an example. This is the output from git grep wokwi_timeout. As a result, you need to make changes in dut_factory and the plugin.

pytest-embedded-wokwi/pytest_embedded_wokwi/wokwi_cli.py:41:        wokwi_timeout: t.Optional[int] = None,
pytest-embedded-wokwi/pytest_embedded_wokwi/wokwi_cli.py:57:        if (wokwi_timeout is not None) and (wokwi_timeout > 0):
pytest-embedded-wokwi/pytest_embedded_wokwi/wokwi_cli.py:58:            cmd.extend(['--timeout', str(wokwi_timeout)])
pytest-embedded/pytest_embedded/dut_factory.py:140:    wokwi_timeout,
pytest-embedded/pytest_embedded/dut_factory.py:291:                    'wokwi_timeout': wokwi_timeout,
pytest-embedded/pytest_embedded/dut_factory.py:584:        wokwi_timeout=0,
pytest-embedded/pytest_embedded/dut_factory.py:638:                'wokwi_timeout': wokwi_timeout,
pytest-embedded/pytest_embedded/plugin.py:950:def wokwi_timeout(request: FixtureRequest) -> t.Optional[str]:
pytest-embedded/pytest_embedded/plugin.py:952:    return _request_param_or_config_option_or_default(request, 'wokwi_timeout', None)
pytest-embedded/pytest_embedded/plugin.py:1010:    wokwi_timeout,

[hfudev]

@horw Thanks for this great PR. Only some minor comments regarding to the code conventions. Let's merge it today!