1*b0d29bc4SBrooks DavisWelcome to the Kyua project! 2*b0d29bc4SBrooks Davis============================ 3*b0d29bc4SBrooks Davis 4*b0d29bc4SBrooks DavisKyua is a **testing framework** for infrastructure software, originally 5*b0d29bc4SBrooks Davisdesigned to equip BSD-based operating systems with a test suite. This 6*b0d29bc4SBrooks Davismeans that Kyua is lightweight and simple, and that Kyua integrates well 7*b0d29bc4SBrooks Daviswith various build systems and continuous integration frameworks. 8*b0d29bc4SBrooks Davis 9*b0d29bc4SBrooks DavisKyua features an **expressive test suite definition language**, a **safe 10*b0d29bc4SBrooks Davisruntime engine** for test suites and a **powerful report generation 11*b0d29bc4SBrooks Davisengine**. 12*b0d29bc4SBrooks Davis 13*b0d29bc4SBrooks DavisKyua is for **both developers *and* users**, from the developer applying a 14*b0d29bc4SBrooks Davissimple fix to a library to the system administrator deploying a new release 15*b0d29bc4SBrooks Davison a production machine. 16*b0d29bc4SBrooks Davis 17*b0d29bc4SBrooks DavisKyua is **able to execute test programs written with a plethora of testing 18*b0d29bc4SBrooks Davislibraries and languages**. The library of choice is 19*b0d29bc4SBrooks Davis[ATF](https://github.com/jmmv/atf/), for which Kyua was originally 20*b0d29bc4SBrooks Davisdesigned, but simple, framework-less test programs and TAP-compliant test 21*b0d29bc4SBrooks Davisprograms can also be executed through Kyua. 22*b0d29bc4SBrooks Davis 23*b0d29bc4SBrooks DavisKyua is licensed under a **[liberal BSD 3-clause license](LICENSE)**. 24*b0d29bc4SBrooks DavisThis is not an official Google product. 25*b0d29bc4SBrooks Davis 26*b0d29bc4SBrooks Davis[Read more about Kyua in the About wiki page.](../../wiki/About) 27*b0d29bc4SBrooks Davis 28*b0d29bc4SBrooks Davis 29*b0d29bc4SBrooks DavisDownload 30*b0d29bc4SBrooks Davis-------- 31*b0d29bc4SBrooks Davis 32*b0d29bc4SBrooks DavisThe latest version of Kyua is 0.13 and was released on August 26th, 2016. 33*b0d29bc4SBrooks Davis 34*b0d29bc4SBrooks DavisDownload: [kyua-0.13](../../releases/tag/kyua-0.13). 35*b0d29bc4SBrooks Davis 36*b0d29bc4SBrooks DavisSee the [release notes](NEWS.md) for information about the changes in this 37*b0d29bc4SBrooks Davisand all previous releases. 38*b0d29bc4SBrooks Davis 39*b0d29bc4SBrooks Davis 40*b0d29bc4SBrooks DavisInstallation 41*b0d29bc4SBrooks Davis------------ 42*b0d29bc4SBrooks Davis 43*b0d29bc4SBrooks DavisYou are encouraged to install binary packages for your operating system 44*b0d29bc4SBrooks Daviswherever available: 45*b0d29bc4SBrooks Davis 46*b0d29bc4SBrooks Davis* Fedora 20 and above: install the `kyua-cli` package with `yum install 47*b0d29bc4SBrooks Davis kyua-cli`. 48*b0d29bc4SBrooks Davis 49*b0d29bc4SBrooks Davis* FreeBSD 10.0 and above: install the `kyua` package with `pkg install kyua`. 50*b0d29bc4SBrooks Davis 51*b0d29bc4SBrooks Davis* NetBSD with pkgsrc: install the `pkgsrc/devel/kyua` package. 52*b0d29bc4SBrooks Davis 53*b0d29bc4SBrooks Davis* OpenBSD with packages: install the `kyua` package with `pkg_add kyua`. 54*b0d29bc4SBrooks Davis 55*b0d29bc4SBrooks Davis* OS X (with Homebrew): install the `kyua` package with `brew install kyua`. 56*b0d29bc4SBrooks Davis 57*b0d29bc4SBrooks DavisShould you want to build and install Kyua from the source tree provided 58*b0d29bc4SBrooks Davishere, follow the instructions in the 59*b0d29bc4SBrooks Davis[INSTALL.md file](INSTALL.md). 60*b0d29bc4SBrooks Davis 61*b0d29bc4SBrooks DavisYou should also install the ATF libraries to assist in the development of 62*b0d29bc4SBrooks Davistest programs. To that end, see the 63*b0d29bc4SBrooks Davis[ATF project page](https://github.com/jmmv/atf/). 64*b0d29bc4SBrooks Davis 65*b0d29bc4SBrooks Davis 66*b0d29bc4SBrooks DavisContributing 67*b0d29bc4SBrooks Davis------------ 68*b0d29bc4SBrooks Davis 69*b0d29bc4SBrooks DavisWant to contribute? Great! But please first read the guidelines provided 70*b0d29bc4SBrooks Davisin [CONTRIBUTING.md](CONTRIBUTING.md). 71*b0d29bc4SBrooks Davis 72*b0d29bc4SBrooks DavisIf you are curious about who made this project possible, you can check out 73*b0d29bc4SBrooks Davisthe [list of copyright holders](AUTHORS) and the [list of 74*b0d29bc4SBrooks Davisindividuals](CONTRIBUTORS). 75*b0d29bc4SBrooks Davis 76*b0d29bc4SBrooks Davis 77*b0d29bc4SBrooks DavisSupport 78*b0d29bc4SBrooks Davis------- 79*b0d29bc4SBrooks Davis 80*b0d29bc4SBrooks DavisPlease use the [kyua-discuss mailing 81*b0d29bc4SBrooks Davislist](https://groups.google.com/forum/#!forum/kyua-discuss) for any support 82*b0d29bc4SBrooks Davisinquiries. 83*b0d29bc4SBrooks Davis 84*b0d29bc4SBrooks Davis*Homepage:* https://github.com/jmmv/kyua/ 85