tuxrun


Nametuxrun JSON
Version 0.66.2 PyPI version JSON
download
home_pagehttps://tuxsuite.com/
SummaryCommand line tool for testing Linux under QEMU
upload_time2024-04-10 10:28:55
maintainerNone
docs_urlNone
authorAntonio Terceiro
requires_python>=3.6
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <div align="center">
  <img src="docs/tuxrun_full.svg" alt="TuxRun Logo" width="40%" />
</div>

[![Pipeline Status](https://gitlab.com/Linaro/tuxrun/badges/master/pipeline.svg)](https://gitlab.com/Linaro/tuxrun/pipelines)
[![coverage report](https://gitlab.com/Linaro/tuxrun/badges/master/coverage.svg)](https://gitlab.com/Linaro/tuxrun/commits/master)
[![PyPI version](https://badge.fury.io/py/tuxrun.svg)](https://pypi.org/project/tuxrun/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![PyPI - License](https://img.shields.io/pypi/l/tuxrun)](https://gitlab.com/Linaro/tuxrun/blob/master/LICENSE)

[Documentation](https://tuxrun.org/) - [Repository](https://gitlab.com/Linaro/tuxrun) - [Issues](https://gitlab.com/Linaro/tuxrun/-/issues)

TuxRun, by [Linaro](https://www.linaro.org/), is a command line tool for
testing Linux on the following virtual devices, using curated test suites.

* AVH
* FVP
* QEMU

TuxRun is a part of [TuxSuite](https://tuxsuite.com), a suite of tools and
services to help with Linux kernel development.

[[_TOC_]]

# About TuxRun

Testing the Linux kernel is as simple as using QEMU but it gets complicated
when you want to support the following combinations:

- Architectures (arm64, armv5, armv7, i386, mips32, mips32el, mips64, mips64el,
  ppc32, ppc64, ppc64le, riscv64, s390, sh4, sparc64, x86_64)

- Emulation systems (QEMU or FVP or AVH)
- Tests (every test suite has dependencies on the rootfs)

Each of those items requires specific configuration and root file systems. In
order to allow for reproducible tests, TuxRun uses containers runtimes (Docker
or Podman).

# Installing TuxRun

There are several options for installing TuxRun:

- [From PyPI](docs/install-pypi.md)
- [Run uninstalled](docs/run-uninstalled.md)

# Using TuxRun

To use TuxRun, compile your own linux kernel for arm64, for example using
[TuxMake](https://tuxmake.org).

Then call tuxrun:

```shell
tuxrun --device qemu-arm64 --kernel /path/to/Image
```

TuxRun will automatically start qemu-system with the right arguments and the
right root filesystem.

# Known issues

Known issues when booting on different virtual platforms.

- [From issues](docs/issues.md)

# Examples

Boot test a mipsel kernel at https://mykernel.org/vmlinux:

```shell
tuxrun --device qemu-mips32el \
       --kernel https://mykernel.org/vmlinux
```

Running *ltp-smoke*:

```shell
tuxrun --device qemu-mips32el \
       --kernel https://mykernel.org/vmlinux \
       --test ltp-smoke
```

Using a custom root file system

```shell
tuxrun --device qemu-mips32el \
       --kernel https://mykernel.org/vmlinux \
       --rootfs https://mykernel.org/rootfs.tar.xz
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://tuxsuite.com/",
    "name": "tuxrun",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": null,
    "author": "Antonio Terceiro",
    "author_email": "antonio.terceiro@linaro.org",
    "download_url": "https://files.pythonhosted.org/packages/12/5c/fe14a340fa7e0a86b84df6e449a890a1ea7f8958a7740d18e6b6745b65a0/tuxrun-0.66.2.tar.gz",
    "platform": null,
    "description": "<div align=\"center\">\n  <img src=\"docs/tuxrun_full.svg\" alt=\"TuxRun Logo\" width=\"40%\" />\n</div>\n\n[![Pipeline Status](https://gitlab.com/Linaro/tuxrun/badges/master/pipeline.svg)](https://gitlab.com/Linaro/tuxrun/pipelines)\n[![coverage report](https://gitlab.com/Linaro/tuxrun/badges/master/coverage.svg)](https://gitlab.com/Linaro/tuxrun/commits/master)\n[![PyPI version](https://badge.fury.io/py/tuxrun.svg)](https://pypi.org/project/tuxrun/)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![PyPI - License](https://img.shields.io/pypi/l/tuxrun)](https://gitlab.com/Linaro/tuxrun/blob/master/LICENSE)\n\n[Documentation](https://tuxrun.org/) - [Repository](https://gitlab.com/Linaro/tuxrun) - [Issues](https://gitlab.com/Linaro/tuxrun/-/issues)\n\nTuxRun, by [Linaro](https://www.linaro.org/), is a command line tool for\ntesting Linux on the following virtual devices, using curated test suites.\n\n* AVH\n* FVP\n* QEMU\n\nTuxRun is a part of [TuxSuite](https://tuxsuite.com), a suite of tools and\nservices to help with Linux kernel development.\n\n[[_TOC_]]\n\n# About TuxRun\n\nTesting the Linux kernel is as simple as using QEMU but it gets complicated\nwhen you want to support the following combinations:\n\n- Architectures (arm64, armv5, armv7, i386, mips32, mips32el, mips64, mips64el,\n  ppc32, ppc64, ppc64le, riscv64, s390, sh4, sparc64, x86_64)\n\n- Emulation systems (QEMU or FVP or AVH)\n- Tests (every test suite has dependencies on the rootfs)\n\nEach of those items requires specific configuration and root file systems. In\norder to allow for reproducible tests, TuxRun uses containers runtimes (Docker\nor Podman).\n\n# Installing TuxRun\n\nThere are several options for installing TuxRun:\n\n- [From PyPI](docs/install-pypi.md)\n- [Run uninstalled](docs/run-uninstalled.md)\n\n# Using TuxRun\n\nTo use TuxRun, compile your own linux kernel for arm64, for example using\n[TuxMake](https://tuxmake.org).\n\nThen call tuxrun:\n\n```shell\ntuxrun --device qemu-arm64 --kernel /path/to/Image\n```\n\nTuxRun will automatically start qemu-system with the right arguments and the\nright root filesystem.\n\n# Known issues\n\nKnown issues when booting on different virtual platforms.\n\n- [From issues](docs/issues.md)\n\n# Examples\n\nBoot test a mipsel kernel at https://mykernel.org/vmlinux:\n\n```shell\ntuxrun --device qemu-mips32el \\\n       --kernel https://mykernel.org/vmlinux\n```\n\nRunning *ltp-smoke*:\n\n```shell\ntuxrun --device qemu-mips32el \\\n       --kernel https://mykernel.org/vmlinux \\\n       --test ltp-smoke\n```\n\nUsing a custom root file system\n\n```shell\ntuxrun --device qemu-mips32el \\\n       --kernel https://mykernel.org/vmlinux \\\n       --rootfs https://mykernel.org/rootfs.tar.xz\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Command line tool for testing Linux under QEMU",
    "version": "0.66.2",
    "project_urls": {
        "Homepage": "https://tuxsuite.com/"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "9dfe42532f0cbae4dcd50bcc842984bd42b2739a9917f1c2aa7145558e05047a",
                "md5": "9d9257215e2d01b3965cbf313dd12ee9",
                "sha256": "832cb6b92baab515d347f0b2856c85b7b206de798338b3d93e3a115041917051"
            },
            "downloads": -1,
            "filename": "tuxrun-0.66.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9d9257215e2d01b3965cbf313dd12ee9",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 71229,
            "upload_time": "2024-04-10T10:28:53",
            "upload_time_iso_8601": "2024-04-10T10:28:53.273148Z",
            "url": "https://files.pythonhosted.org/packages/9d/fe/42532f0cbae4dcd50bcc842984bd42b2739a9917f1c2aa7145558e05047a/tuxrun-0.66.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "125cfe14a340fa7e0a86b84df6e449a890a1ea7f8958a7740d18e6b6745b65a0",
                "md5": "38e9d8cb4f72e6dcfad039c36983834d",
                "sha256": "84cac32b89b3b0203b44b87b96748fc4af87a27d5f96233d862e376ffb665fd2"
            },
            "downloads": -1,
            "filename": "tuxrun-0.66.2.tar.gz",
            "has_sig": false,
            "md5_digest": "38e9d8cb4f72e6dcfad039c36983834d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 355703,
            "upload_time": "2024-04-10T10:28:55",
            "upload_time_iso_8601": "2024-04-10T10:28:55.896056Z",
            "url": "https://files.pythonhosted.org/packages/12/5c/fe14a340fa7e0a86b84df6e449a890a1ea7f8958a7740d18e6b6745b65a0/tuxrun-0.66.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-10 10:28:55",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "tuxrun"
}
        
Elapsed time: 0.23072s