Add a provisioning comment field

[fginther]

This request is to add a comment or similar field to the provisioning section of a job request. The purpose of this field is to allow passing a message about the job which would then be visible from the WebUI. The primary use case is to provide a way to track jobs created by automation back to the automation which created it. for example:

job_queue: my-favorite-queue
provision_data:
  distro: focal
  comment: "Provisioned by primus team. url: https://automation.url/test-runner"

test_data:
  test_cmds: |
    echo "run a test"

This would then show up under the Provision Data for the job url https://testflinger.canonical.com/jobs/job_id:

{'distro': 'focal', 'comment': 'Provisioned by primus team. url: https://automation.url/test-runner'}

Currently, we do this by adding content to the test_cmds to echo out the same kind of information to a provisioned_by file. But with recent UI changes, having an explicit field for this would be helpful.

[syncronize-issues-to-jira]

Thank you for reporting your feedback to us!

The internal ticket has been created: https://warthogs.atlassian.net/browse/CERTTF-860.

This message was autogenerated

[rene-oromtz]

Hi @fginther!
Help me to understand a bit more the use case, you mentioned for having it in the WebUI but also for your automation to track back those jobs?

Would using "job tags" suit this purpose? Right now you can add any tag(s) to your job definition e.g.:

{
    "provision_data": {
        "distro": "noble"
    },
    "reserve_data": {},
    "tags": [
        "primus_team",
    ]
}

And then use the API to get only jobs that matches your tag:
curl https://testflinger.canonical.com/v1/job/search?tags=primus_team

Please let me know if this is enough or if there is something else we would need to work on (not sure if you explicitly or preferably want this in the UI.

Ref:
Test Job Schema: https://canonical-testflinger.readthedocs-hosted.com/latest/reference/job-schema/
OpenAPI docs: https://canonical-testflinger.readthedocs-hosted.com/latest/reference/openapi/#/V1/get_v1_job_search