.. _results-upload-plugin:
Results Upload Plugin
=====================
This optional plugin is intended to upload the Avocado Job results to
a dedicated sever.
To install the Result Upload plugin from pip, use::
pip install avocado-framework-plugin-result-upload
Usage::
$ avocado run avocado/examples/tests/passtest.py --result-upload-url www@avocadologs.example.com:/var/www/html
JOB ID : f40403c7409ef998f293a7c83ee456c32cb6547a
JOB LOG : $HOME/avocado/job-results/job-2021-09-30T22.16-f40403c/job.log
(1/1) avocado/examples/tests/passtest.py:PassTest.test: STARTED
(1/1) avocado/examples/tests/passtest.py:PassTest.test: PASS (0.01 s)
RESULTS : PASS 1 | ERROR 0 | FAIL 0 | SKIP 0 | WARN 0 | INTERRUPT 0 | CANCEL 0
JOB HTML : $HOME/avocado/job-results/job-2021-09-30T22.16-f40403c/results.html
Avocado logs will be available at following URL:
- ssh
www@avocadologs.example.com:/var/www/html/job-2021-09-30T22.16-f40403c
- html (If web server is enabled)
http://avocadologs.example.com/job-2021-09-30T22.16-f40403c/
Such links may be referred by other plugins, such as the ResultsDB plugin.
By default upload will be handled by following command ::
rsync -arz -e 'ssh -o LogLevel=error -o stricthostkeychecking=no -o userknownhostsfile=/dev/null -o batchmode=yes -o passwordauthentication=no'
Optionally, you can customize uploader command, for example following command upload logs to Google storage: ::
$ avocado run avocado/examples/tests/passtest.py --result-upload-url='gs://avocadolog' --result-upload-cmd='gsutil -m cp -r'
You can also set the ResultUpload URL and command using a config file::
[plugins.result_upload]
url = www@avocadologs.example.com:/var/www/htmlavocado/job-results
command='rsync -arzq'
And then run the Avocado command without the explicit command options. Notice
that the command line options will have precedence over the configuration file.
Raw data
{
"_id": null,
"home_page": "http://avocado-framework.github.io/",
"name": "avocado-framework-plugin-result-upload",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Avocado Developers",
"author_email": "avocado-devel@redhat.com",
"download_url": "https://files.pythonhosted.org/packages/51/0d/cd0de258f26ea16188bef1fbd41f7f3540131183463f66f4588c958984a9/avocado_framework_plugin_result_upload-109.0.tar.gz",
"platform": null,
"description": ".. _results-upload-plugin:\n\nResults Upload Plugin\n=====================\n\nThis optional plugin is intended to upload the Avocado Job results to\na dedicated sever.\n\nTo install the Result Upload plugin from pip, use::\n\n pip install avocado-framework-plugin-result-upload\n\nUsage::\n\n $ avocado run avocado/examples/tests/passtest.py --result-upload-url www@avocadologs.example.com:/var/www/html\n JOB ID : f40403c7409ef998f293a7c83ee456c32cb6547a\n JOB LOG : $HOME/avocado/job-results/job-2021-09-30T22.16-f40403c/job.log\n (1/1) avocado/examples/tests/passtest.py:PassTest.test: STARTED\n (1/1) avocado/examples/tests/passtest.py:PassTest.test: PASS (0.01 s)\n RESULTS : PASS 1 | ERROR 0 | FAIL 0 | SKIP 0 | WARN 0 | INTERRUPT 0 | CANCEL 0\n JOB HTML : $HOME/avocado/job-results/job-2021-09-30T22.16-f40403c/results.html\n\n\nAvocado logs will be available at following URL:\n\n- ssh\n\n www@avocadologs.example.com:/var/www/html/job-2021-09-30T22.16-f40403c\n\n- html (If web server is enabled)\n\n http://avocadologs.example.com/job-2021-09-30T22.16-f40403c/\n\nSuch links may be referred by other plugins, such as the ResultsDB plugin.\n\nBy default upload will be handled by following command ::\n\n rsync -arz -e 'ssh -o LogLevel=error -o stricthostkeychecking=no -o userknownhostsfile=/dev/null -o batchmode=yes -o passwordauthentication=no'\n\nOptionally, you can customize uploader command, for example following command upload logs to Google storage: ::\n\n $ avocado run avocado/examples/tests/passtest.py --result-upload-url='gs://avocadolog' --result-upload-cmd='gsutil -m cp -r'\n\nYou can also set the ResultUpload URL and command using a config file::\n\n [plugins.result_upload]\n url = www@avocadologs.example.com:/var/www/htmlavocado/job-results\n command='rsync -arzq'\n\nAnd then run the Avocado command without the explicit command options. Notice\nthat the command line options will have precedence over the configuration file.\n",
"bugtrack_url": null,
"license": null,
"summary": "Avocado Plugin to propagate Job results to remote host",
"version": "109.0",
"project_urls": {
"Homepage": "http://avocado-framework.github.io/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e991b31f90fe4a438b6791bd59461b3b43ae8c80a3748474075f8ba6ca5b2134",
"md5": "95c450ec1dce75c51fa3f405b378b164",
"sha256": "8699af5c4f59485ee843b6b4b037ad2aee94bf2819175e478c60a2e02679e39a"
},
"downloads": -1,
"filename": "avocado_framework_plugin_result_upload-109.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "95c450ec1dce75c51fa3f405b378b164",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4055,
"upload_time": "2025-01-14T13:27:29",
"upload_time_iso_8601": "2025-01-14T13:27:29.541621Z",
"url": "https://files.pythonhosted.org/packages/e9/91/b31f90fe4a438b6791bd59461b3b43ae8c80a3748474075f8ba6ca5b2134/avocado_framework_plugin_result_upload-109.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "510dcd0de258f26ea16188bef1fbd41f7f3540131183463f66f4588c958984a9",
"md5": "b897e0aca8ce5cd706e04f0fdbff8a27",
"sha256": "3947783d0077779efb5a5658c330c600b4f1ee85bcb05feb97186364ed2b8ab9"
},
"downloads": -1,
"filename": "avocado_framework_plugin_result_upload-109.0.tar.gz",
"has_sig": false,
"md5_digest": "b897e0aca8ce5cd706e04f0fdbff8a27",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3771,
"upload_time": "2025-01-14T13:27:47",
"upload_time_iso_8601": "2025-01-14T13:27:47.595966Z",
"url": "https://files.pythonhosted.org/packages/51/0d/cd0de258f26ea16188bef1fbd41f7f3540131183463f66f4588c958984a9/avocado_framework_plugin_result_upload-109.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-14 13:27:47",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "avocado-framework-plugin-result-upload"
}
JSON