Linux Integration Services Automation (LISA)
============================================

|CI Workflow| |GitHub license| |Docs|

**Linux Integration Services Automation (LISA)** is a Linux quality
validation system, which consists of two parts：

-  A test framework to drive test execution.
-  A set of test suites to verify Linux kernel/distribution quality.

``LISA`` was originally designed and implemented for Microsoft Azure and
Windows HyperV platforms; now it can be used to validate Linux quality
on any platforms if the proper orchestrator module is implemented.

Why LISA
--------

-  **Scalable**: Benefit from the appropriate abstractions, ``LISA``
   can be used to test the quality of numerous Linux distributions
   without duplication of code implementation.

-  **Customizable**: The test suites created on top of ``LISA`` can be
   customized to support different quality validation needs.

-  **Support multiple platforms**: ``LISA`` is created with modular
   design, to support various of Linux platforms including Microsoft
   Azure, Windows HyperV, Linux bare metal, and other cloud based
   platforms.

-  **End-to-end**: ``LISA`` supports platform specific orchestrators to
   create and delete test environment automatically; it also provides
   flexibility to preserve environments for troubleshooting if test(s)
   fails.

Documents
---------

-  `Quick start <https://mslisa.rtfd.io/en/main/quick_start.html>`__
-  `Run tests <https://mslisa.rtfd.io/en/main/run_test/run.html>`__
-  `Development Setup <https://mslisa.readthedocs.io/en/main/write_test/dev_setup.html>`__
-  `Microsoft tests <https://mslisa.rtfd.io/en/main/run_test/microsoft_tests.html>`__
-  `Write test cases in LISA <https://mslisa.rtfd.io/en/main/write_test/write_case.html>`__
-  `Command line reference <https://mslisa.rtfd.io/en/main/run_test/command_line.html>`__
-  `Runbook reference <https://mslisa.rtfd.io/en/main/run_test/runbook.html>`__
-  `Extend and customize LISA <https://mslisa.rtfd.io/en/main/write_test/extension.html>`__
-  `Run the previous version of LISA (aka
   LISAv2) <https://mslisa.rtfd.io/en/main/run_test/run_legacy.html>`__

Contribute
----------

You are very welcome to contribute to this repository. Please follow `the contribution
document <https://mslisa.rtfd.io/en/main/contributing.html>`__ for details.

History and road map
--------------------

The previous LISA called LISAv2, which is in `the master
branch <https://github.com/microsoft/lisa/tree/master>`__. The previous
LISA can be used standalone or called from the current LISA. Learn more
from `how to run LISAv2 test cases <https://mslisa.rtfd.io/en/main/run_test/run_legacy.html>`__.

LISA is in active developing, and a lot of exciting features are being
implemented. We’re listening to your
`feedback <https://github.com/microsoft/lisa/issues/new>`__.

License
-------

The entire codebase is under `MIT license <LICENSE>`__.

.. |CI Workflow| image:: https://github.com/microsoft/lisa/workflows/CI%20Workflow/badge.svg?branch=main
   :target: https://github.com/microsoft/lisa/actions?query=workflow%3A%22CI+Workflow+for+LISAv3%22+event%3Apush+branch%3Amain
.. |GitHub license| image:: https://img.shields.io/github/license/microsoft/lisa
   :target: https://github.com/microsoft/lisa/blob/main/LICENSE
.. |Docs| image:: https://readthedocs.org/projects/mslisa/badge/?version=main
   :target: https://mslisa.readthedocs.io/en/main/?badge=main
   :alt: Documentation Status