How to create a new resource that can be listed in exporter's yaml?

[cruise-bryan-murdock]

If I want to create a new resource that an exporter can export, that I put in the exporter.yaml, does it have to go in https://github.com/labgrid-project/labgrid/blob/master/labgrid/remote/exporter.py ? If so, does that mean I have to fork labgrid to add my own resource?

[Emantor]

This depends on your resource. For simple resources where i.e. no external program needs to be started, they can simply be added and the exporter will export them as is, the NetworkService is such an example. The problem you'll run into is that both client and exporter will require the resource class, where you won't get around shipping your own internal labgrid version.

Which resource are you missing? We are more than happy to extend labgrid with features that are currently missing.

[cruise-bryan-murdock]

I do see the NetworkService in exporter.py, but are you saying it doesn't have to be there?

There are 2 resources we are thinking of right now:

1. We have dev boards connected to ports on an Ixia network tester. This is a case where no external program needs to be started.
   The exporter yaml that I'm thinking would be useful is this:

  IxiaPorts:
    api_server: 10.136.15.25
    ports: [10, 11, 12, 13]

2. We have Lauterbach debuggers connected to dev boards (kind of like Olimex debuggers). The lauterbach hardware is controlled via the python interface of the Trace32 software (which listens on a UDP port). The exporter could start Trace32 in the background, or maybe Trace32 (t32) could always be running on the exporter as a daemon. I think the exporter yaml would look something like this:

  Lauterbach:
    t32_udp_port: 2000

[cruise-bryan-murdock]

I added IxiaPorts to my exporter.yaml but when I try to run my test I see this:

[bryan.murdock@NJ9LCFYDQ3] $ pytest -vvv --lg-log=log2 --lg-env=remote.yaml --pdb
====================================== test session starts ======================================
platform darwin -- Python 3.9.6, pytest-7.2.2, pluggy-1.0.0 -- /Library/Developer/CommandLineTools/usr/bin/python3
cachedir: .pytest_cache
rootdir: /Users/bryan.murdock/work/soc-dune-val/val/epp/tests
plugins: labgrid-23.0.1
collected 1 item

test_hif_tx.py::test_hif_tx
ERROR                                                                                     [100%]
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> traceback >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>

request = <SubRequest 'env' for <Function test_hif_tx>>
record_testsuite_property = <function record_testsuite_property.<locals>.record_func at 0x101ec78b0>

    @pytest.fixture(scope="session")
    def env(request, record_testsuite_property):
        """Return the environment configured in the supplied configuration file.
        It contains the targets contained in the configuration file.
        """
        env = request.config._labgrid_env

        if not env:
            pytest.skip("missing environment config (use --lg-env)")

        record_testsuite_property('ENV_CONFIG', env.config_file)
        targets = list(env.config.get_targets().keys())
        record_testsuite_property('TARGETS', targets)

        for target_name in targets:
            try:
>               target = env.get_target(target_name)

../../../../../Library/Python/3.9/lib/python/site-packages/labgrid/pytestplugin/fixtures.py:68:
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
../../../../../Library/Python/3.9/lib/python/site-packages/labgrid/environment.py:49: in get_target
    target = target_factory.make_target(role, config, env=self)
../../../../../Library/Python/3.9/lib/python/site-packages/labgrid/factory.py:152: in make_target
    self.make_resource(target, resource, name, args)
../../../../../Library/Python/3.9/lib/python/site-packages/labgrid/factory.py:124: in make_resource
    r = cls(target, name, **args)
../../../../../Library/Python/3.9/lib/python/site-packages/labgrid/resource/remote.py:100: in __attrs_post_init__
    super().__attrs_post_init__()
../../../../../Library/Python/3.9/lib/python/site-packages/labgrid/resource/common.py:142: in __attrs_post_init__
    self.manager._add_resource(self)
../../../../../Library/Python/3.9/lib/python/site-packages/labgrid/resource/common.py:118: in _add_resource
    self.on_resource_added(resource)
../../../../../Library/Python/3.9/lib/python/site-packages/labgrid/resource/remote.py:54: in on_resource_added
    new = target_factory.make_resource(
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

self = <labgrid.factory.TargetFactory object at 0x1015034c0>
target = Target(name='main', env=Environment(config_file='remote.yaml')), resource = 'IxiaPorts'
name = 'IxiaPorts'
args = {'api_server': '10.136.15.25', 'card': 2, 'password': '@Keysightdemo1', 'ports': [10, 11, 12, 13], ...}

    def make_resource(self, target, resource, name, args):
        assert isinstance(args, dict)
        if not resource in self.resources:
>           raise InvalidConfigError(f"unknown resource class {resource}")
E           labgrid.exceptions.InvalidConfigError: unknown resource class IxiaPorts

So, do I need to create a resource class for IxiaPorts?

[Bastian-Krause]

Yes, you need to create a Resource class, see NetworkService. If you want to export it, you also need a ResourceExport class, see NetworkServiceExport.

[cruise-bryan-murdock]

Thank you, I was able to make an IxiaPorts class that inherits from NetworkResource and import it into my test. On the exporter machine all I had to do was add IxiaPorts to the exporter.yaml. Same for Lauterbach.