Diff for /wikisrc/kyua.mdwn between versions 1.1 and 1.4

version 1.1, 2012/07/13 01:35:00 version 1.4, 2012/09/01 19:17:30
Line 1 Line 1
 [[!meta title="Kyua: An introduction for NetBSD users"]]  [[!meta title="Kyua: An introduction for NetBSD users"]]
 [[!toc ]]  [[!toc levels=2]]
   
 The [Automated Testing Framework](ATF), or ATF for short, is a software  The [Automated Testing Framework](ATF), or ATF for short, is a software
 package composed of two parts: the *ATF libraries* and the *ATF tools*.  package composed of two parts: the *ATF libraries* and the *ATF tools*.
Line 32  This page provides instructions on how t Line 32  This page provides instructions on how t
 test suite so that you can experiment with the tool, familiarize yourself  test suite so that you can experiment with the tool, familiarize yourself
 with it and provide feedback early on.  with it and provide feedback early on.
   
   # What's in the name?
   
   You should really think of Kyua as ATF 2.x.  Then, why isn't it just ATF
   2.x?
   
   To be honest, I never liked the ATF name: it was picked for me as part of
   the Google Summer of Code 2007 program and I did not think about changing
   it at that time.  A year later, I learned that the ATF acronym is severely
   overloaded, which makes it hard to find the project on popular search
   engines, and has unpopular connotations in specific countries.
   
   So, as part of the rewrite, I decided to choose a new name: a name that is
   not an acronym and thus can be easily pronounced, and a name that is quite
   unique in search results.  The name is Kyua, which is just a play on the
   pronounciation of the Q.A. acronym.  Originally, my intention was to
   pronounce Kyua as Q.A., but in reality this never happened.  Today, just
   read the name as your instinct would: "Kyu-ah".
   
   # Why is Kyua a third-party project?
   
   Kyua's main consumer is NetBSD.  One could argue that Kyua should be
   developed within NetBSD and maintained in the NetBSD source tree.  However,
   there is nothing in the Kyua project that inherently depends on NetBSD, and
   maintaining it as a third-party package is a way to keep the developers
   honest regarding portability.
   
   Ideally, other projects (such as FreeBSD) would make use of Kyua too for
   their testing needs, and if that happened we would be able to share tests
   with them pretty easily.  Forcing a portable codebase in the upstream
   repository helps in this.  (Be aware that different individuals from
   FreeBSD and Minix have shown interest in adopting Kyua for their respective
   systems!)
   
 # Main differences (aka "what to expect")  # Main differences (aka "what to expect")
   
 As of version 0.5, Kyua has (or is supposed to have) feature parity with  As of version 0.5, Kyua has (or is supposed to have) feature parity with
Line 89  that the parser for these files is well- Line 122  that the parser for these files is well-
 Lua will allow the implementation of more-intelligent test (and maybe even  Lua will allow the implementation of more-intelligent test (and maybe even
 build) scripts.  build) scripts.
   
   ## Direct HTML output
   
   All of the NetBSD continous build and testing systems provide status
   reports through the releng web interface.  In the case of ATF, this has
   traditionally been tricky because ATF cannot generate HTML contents
   directly; instead, `atf-report` generates XML output which later must be
   postprocessed with `xsltproc` to create the HTML pages.
   
   Kyua has the ability to generate HTML reports straight from the tool,
   without having to go through any XML toolchain.  This means that NetBSD,
   out of the box, can generate such reports and publish them with the builtin
   httpd(8) server.
   
 ## Heavier code base  ## Heavier code base
   
 If you take a look at the Kyua distribution file, you may notice that it is  If you take a look at the Kyua distribution file, you may notice that it is
Line 189  Once this is done, configure Kyua in the Line 235  Once this is done, configure Kyua in the
 the box" in NetBSD.  Create the /usr/pkg/etc/kyua/kyua.conf file with these  the box" in NetBSD.  Create the /usr/pkg/etc/kyua/kyua.conf file with these
 contents:  contents:
   
     syntax('kyuafile', 1)      syntax('config', 1)
     unprivileged_user = '_tests'      unprivileged_user = '_tests'
   
 The next step is to populate /usr/tests with Kyuafiles, as Kyua is unable  The next step is to populate /usr/tests with Kyuafiles, as Kyua is unable

Removed from v.1.1  
changed lines
  Added in v.1.4


CVSweb for NetBSD wikisrc <wikimaster@NetBSD.org> software: FreeBSD-CVSweb