Add support for tests to provide description and metadata when running tests e.g. for easier test tool log correlation.

[apratimmukherjee]

Feature Overview

• Issue TBD
• The aim is to provide a way for test logs in test components e.g the controller to associate a test or sub-test name with logs generated , especially for debugging issues found in test runs with 100s of cases being executed where being able to map an error log to specific test or sub-test can add significant value for quicker debugging and analysis.
• In future , it could also be used to generate some sort of test reports in terms of tests/sub-tests executed , time taken and apis executed for each test etc. if needed since controller / test tool will now have this information.

---

Feature Details

• Redocly docs for this feature/branch

• Look for the newly added optional metadata field in set_config proposed in this PR.

• Dev-Snappi branch reference

• Example command to fetch the dev-snappi branch:

  go get github.com/open-traffic-generator/snappi/gosnappi@set_config_metadata
  

---

Code snippets

  config.Metadata.SetDescription("FP1.5 - xyz test")
  /* TBD : Add pertinent example for tag-value pair */

---

Test Specification (Optional)

This is more of a test harness feature where test harness should ideally set the description before sending each set_config to controller and for now , the verification will be that the test tool logs will dump the test name alongwith test tool specific execution logs.