{"id":20009027,"url":"https://github.com/linuxkit/rtf","last_synced_at":"2026-03-09T03:35:12.048Z","repository":{"id":53792657,"uuid":"89472225","full_name":"linuxkit/rtf","owner":"linuxkit","description":"Regression testing framework","archived":false,"fork":false,"pushed_at":"2025-04-09T12:48:41.000Z","size":1226,"stargazers_count":44,"open_issues_count":2,"forks_count":14,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-10-18T01:07:43.756Z","etag":null,"topics":["linuxkit","testing","testing-framework","testing-tools"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/linuxkit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-04-26T11:14:39.000Z","updated_at":"2025-09-29T04:39:36.000Z","dependencies_parsed_at":"2025-05-04T19:35:48.799Z","dependency_job_id":"edbb84c8-1a82-4718-a46c-ae83162daa27","html_url":"https://github.com/linuxkit/rtf","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/linuxkit/rtf","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linuxkit%2Frtf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linuxkit%2Frtf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linuxkit%2Frtf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linuxkit%2Frtf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/linuxkit","download_url":"https://codeload.github.com/linuxkit/rtf/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linuxkit%2Frtf/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30281574,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-09T02:57:19.223Z","status":"ssl_error","status_checked_at":"2026-03-09T02:56:26.373Z","response_time":61,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["linuxkit","testing","testing-framework","testing-tools"],"created_at":"2024-11-13T07:13:46.184Z","updated_at":"2026-03-09T03:35:07.036Z","avatar_url":"https://github.com/linuxkit.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"RT Framework\n============\n\n**A regression testing framework**\n\nThis project contains a generic, cross-platform regression test\nframework.\n\nThe generic regression test framework is implemented in Go whereas\nthe test are written as shell scripts. The library code is in the `rt`\ndirectory and some common utilities and helper programs are contained in\nthe `utils` directory.\n\n- `rtf` - a local test runner\n\nFor more details, see the documentation in `./docs/USER_GUIDE.md`.\n\n## Installation\n\n```\ngo get -u github.com/linuxkit/rtf\n```\n\n## Development\n\nTo run the test suite please use:\n```\nmake test\n```\n\n## Prerequisites\n\nOn a Mac and Linux, this should pretty much just work out of the\nbox. The tests are written in `sh` and expect it to be installed in\n`/bin/sh`. Some optional utilities (see [`./bin`](./bin)) are written\nin `python` and if your tests use them, you need to have python\ninstalled.\n\nOn Windows, it depends on how your tests are written. If they are\nwritten as `powershell` scripts, `rtf` should just work. If they are\nwritten as shell scripts, you need to have the MSYS2 variant of `bash`\ninstalled and `bash.exe` must be in your path. The simplest way to\ninstall it is to install `git` via\n[chocolatey](https://chocolatey.org/). Note, neither `bash` from WSL\nnor cygwin is currently supported.\n\n```\nchoco install git\n```\n\nIf your tests use the optional utilities in, you also need to install `python`:\n```\nchoco install python\n```\n\n## Quickstart\n\nThe regression test framework allows running tests on a local host (or\ninside a VM) as well as against a suitably configured remote host.\n\nIf you don't have the source code in your `GOPATH`, you may have to\nset the `RT_ROOT` environment variable to point to it.\n\nTo run tests locally, simply execute the `rtf run` command. It will\nexecuted all the test cases in the supplied cases directory. This\ndefaults to `./cases`\n\nTo list all current tests run `rtf list`, or to get a one line\nsummary for each test use `rtf info`.\n\nWhen running tests, by default a line per test is printed on the\nconsole with a pass/fail indication. Detailed logs, by default, are\nstored in `./_results/\u003cUUID\u003e/`. In that directory, `TESTS.log`\ncontains detailed logs of all tests, `TESTS.csv` contains a line per\ntest, `SUMMARY.csv` contains a one line summary of the all tests run,\nand `SUMMARY.json` contains both a test summary and the individual\ntest results. The directory also contains a log file for each tests,\nwith the same contents as `TESTS.log`.\n\nIf you prefer a bit more information in the log files use:\n```\nrtf -v run -x\n```\n\nThis executes the tests with `-x`, logging all commands executed to `stderr`;\nand with `-v`, causing `stderr` to be displayed to the console.\n\nFor a CI system, where the output is displayed on a web page use:\n```\nrtf -vvv run -x\n```\n\nThis prints the same information logged to the log file to the console.\n\nThere is initial support for comparing the result from two test runs:\n```\nrtf compare \u003cpath to SUMMARY.json\u003e \u003cpath to SUMMARY.json\u003e ...\n```\nwhich will display the results side by side.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinuxkit%2Frtf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flinuxkit%2Frtf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinuxkit%2Frtf/lists"}