chickadee » salmonella

Outdated egg!

This is an egg for CHICKEN 4, the unsupported old release. You're almost certainly looking for the CHICKEN 5 version of this egg, if it exists.

If it does not exist, there may be equivalent functionality provided by another egg; have a look at the egg index. Otherwise, please consider porting this egg to the current version of CHICKEN.

salmonella

TOC »

Introduction

Salmonella is a set of tools to test CHICKEN eggs. Here's a brief summary of features:

Note: starting on version 2.0, salmonella is a rewrite of the salmonella 1.x series, which was available since CHICKEN 2.x. The documentation for the 1.x series is still available at http://wiki.call-cc.org/egg/salmonella-1.x.

Author

Mario Domenech Goulart

Repository

salmonella is hosted on github: https://github.com/mario-goulart/salmonella

Tools

This egg provides some command line tools. The next sections describe each of them.

salmonella

This is the core tool for testing eggs. salmonella can perform the following tests:

salmonella generates a sexpr-based log file as output. That file can be used by tools like salmonella-html-report to generate a pretty output in HTML.

When executing, salmonella prints some basic information on the standard output. Detailed information can be viewed with the aforementioned salmonella-html-report or with salmonella-log-viewer, a tool which is provided by this egg. salmonella-log-viewer parses the log file generated by salmonella and formats the data on the standard output.

Command line options

Here's the output of salmonella -h with an explanation for each command line option:

 salmonella [ -h | --help ]
 salmonella --version
 salmonella [ [ <options> ] eggs ]
 
 When called without eggs in the command line, salmonella will try to
 find a .egg file in the current directory and process it (just like
 chicken-install).
 
 <options>:
 --log-file=<logfile>
     The name for the log file to be generated by salmonella
     (default=salmonella.log).
 
 --chicken-installation-prefix=<prefix dir>
     If you want to test eggs using a chicken installed on a certain directory,
     you can use this option (it should point to the same directory as given to
     `PREFIX' when installing CHICKEN). If omitted, salmonella uses CHICKEN
     tools from the current runtime's installation prefix.  Note that when this
     option is used, salmonella will look for "csi", "csc" and "chicken-install"
     under <prefix dir>/bin.  If the CHICKEN installed under <prefix dir>
     has different names for the CHICKEN tools (i.e., they were tweaked via
     CSI_PROGRAM, CSC_PROGRAM, CHICKEN_INSTALL_PROGRAM, PROGRAM_PREFIX or
     PROGRAM_SUFFIX at build time), you will need to use the --csi, --csc
     and/or --chicken-install parameters for salmonella.
 
 --chicken-install-args=<install args>
     This option can be used customize chicken-install's arguments.  You can
     use <repo> to indicate where you want the actual repository directory
     to be replaced by salmonella.
 
 --csi=<path to csi>
    Path to csi.  If provided, salmonella will use the csi pointed by
    this parameter instead of the one from the current runtime's
    installation prefix (or the static "csi" from the prefix set by
    --chicken-installation-prefix).
 
 --csc=<path to csc>
    Path to csc.  If provided, salmonella will use the csc pointed by
    this parameter instead of the one from the current runtime's
    installation prefix (or the static "csc" from the prefix set by
    --chicken-installation-prefix).
 
 --chicken-install=<path to chicken-install>
    Path to chicken-install.  If provided, salmonella will use the csi
    pointed by this parameter instead of the one from the current runtime's
    installation prefix (or the static "chicken-install" from the prefix set
    by --chicken-installation-prefix).
 
 --eggs-doc-dir=<doc dir>
     By default, salmonella checks if documentation for eggs exist by accessing
     the CHICKEN wiki.  If you have a local copy of the wiki documentation for
     eggs, you can use this option to point to the directory where they can be
     found.
 
 --keep-repo
     For each egg that salmonella tests, it sets the egg installation repository
     empty and removes it at the end of its execution.  This option makes
     salmonella keep the egg installation repository after testing each egg and
     after finishing its execution.  This option can save a lot of time when
     testing several eggs, at the cost of potentially making salmonella unable
     to catch dependencies problems.
 
 --skip-eggs=<comma-separated list of eggs to skip>
     A comma-separated list of eggs to be skipped.
 
 --repo-dir=<path to repo dir to be used>
     Alternative location for the egg installation directory used by salmonella.
     By default, salmonella generates a `salmonella-tmp-xxxxx' directory in the
     current directory.  This option can be useful when used with `--keep-repo'
     to reuse egg installation repositories for several salmonella executions.
 
 --clear-chicken-home
     Remove Scheme files from <chicken-installation-prefix>/share/chicken.
     WARNING: use this option with care.  If you don't understand the
     consequences of this option, DON'T USE IT.  Extra care when you don't
     use --chicken-installation-prefix -- in this case --clear-chicken-home
     will remove Scheme files from your "host" CHICKEN installation.
     This option is only effective when --keep-repo is NOT used.
 
 --verbosity=<number>
     A number to indicate salmonella's verbosity level.  0 means practically
     silent. 1 is mostly silent and 2 (default) prints some useful information
     while salmonella is running.
Some quick tips by example

Simplest case: testing eggs using the remote egg server and the chicken tools (chicken-install and csi) in the system PATH

 $ salmonella big-chicken slice

You can test all the available eggs using one of the following approaches:

1. If you have CHICKEN >= 4.7.2:

 $ salmonella `chicken-install -list`

2. If you don't have CHICKEN >= 4.7.2:

 $ salmonella `wget http://code.call-cc.org/cgi-bin/henrietta.cgi?list=1 -q -O -`

If you don't want to test some specific eggs, you can skip them:

 $ salmonella --skip-eggs=macosx,hfs+ `chicken-install -list`

You can tell salmonella to use a specific CHICKEN version:

 $ salmonella --chicken-installation-prefix=/usr/local/chicken-4.7.3 big-chicken slice

Not cleaning the egg installation repository after installing each egg may significantly speed up the salmonella execution time (the default behavior is to set the egg installation repository empty after testing each egg):

 $ salmonella --keep-repo big-chicken slice

warning: if you use --keep-repo, salmonella will not be able to catch dependencies problems.

If you want to reuse the same egg installation repository for multiple salmonella runs, you can provide a specific directory:

 $ salmonella --repo-dir=my-repo --keep-repo big-chicken slice

By default, salmonella generates a log file named salmonella.log in the current directory. You can change that by using the --log-file command line option:

 $ salmonella --log-file=my-log-file.log big-chicken slice
Using salmonella as an egg lint tool

Suppose you are working on a new egg and you want to check if it is working ok before releasing it (or a new version). You can use salmonella to check it:

 $ cd my-egg    # where your egg code is stored
 $ salmonella

salmonella-log-viewer

This tool can be used to turn salmonella log files into something readable on the standard output.

Just provide a salmonella log file as argument to salmonella-log-viewer:

   $ salmonella-log-viewer salmonella.log

Alternatively, you can use salmonella-html-report for a prettier and more complete format.

salmonella-epidemy

Note: this tool is currently not supported on Windows systems.

salmonella-epidemy can be used to run multiple salmonella instances in parallel. It can be handy when you have a multi-core machine and you want to make use of all cores, for example. The command line options are basically the same as for salmonella, plus a --instances=<number> to indicate how many salmonella instances you want to run in parallel.

This tool can significantly speed up salmonella execution times on multi-core machines.

Usage example:

 $ salmonella-epidemy --instances=2 big-chicken slice spiffy amb

salmonella-log-merger

This tool simply puts more than one salmonella log into a single one, so it can be used by tools like salmonella-log-viewer and salmonella-html-report.

Usage example:

 $ salmonella-log-merger --log-file=full.log file1.log file2.log

salmonella-log-inquirer

salmonella-log-inquirer can be used to query salmonella log files. Below you can see its help message and a usage example.

 salmonella-log-inquirer [ -h | -help | --help ]
   Print this message.
 
 salmonella-log-inquirer --version
   Show version and exit.
 
 salmonella-log-inquirer --log-info <log file>
   Show information about the environment where salmonella was executed
   to generate the given <log-file> (e.g., environment variables, C
   compiler, CHICKEN version, salmonella command line etc.)
 
 salmonella-log-inquirer --statistics <log file>
   Show simple statistics on installation, tests and documentation from
   the log file .
 
 salmonella-log-inquirer --list-eggs <log file>
   List eggs covered in <log file>.
 
 salmonella-log-inquirer --action=<action> --egg=<egg> [ --part=<part> ] <log file>
   Query <action> and, optionally, <part> for <egg> in <log file>.
 
 <action>s:
 fetch
 install
 check-version
 test
 meta-data
 
 <part>s (the default part is "message"):
 message
 status
 duration

Usage example:

 $ salmonella-log-inquirer --action=fetch --egg=this salmonella.log
 '/home/chicken/salmonella/build/salmonella-run-publish/chicken/bin/chicken-install' -r -v -test this 2>&1
 this not cached
 resolving alias `kitten-technologies' to: http://chicken.kitten-technologies.co.uk/henrietta.cgi
 resolving alias `call-cc' to: http://code.call-cc.org/cgi-bin/henrietta.cgi
 trying server http://chicken.kitten-technologies.co.uk/henrietta.cgi ...
 downloading this: http://chicken.kitten-technologies.co.uk/henrietta.cgi
 connecting to host "chicken.kitten-technologies.co.uk", port 80 ...
 requesting "/henrietta.cgi?name=this&release=5&mode=default&tests=yes" ...
 reading response ...
 HTTP/1.1 200 OK
 Date: Thu, 25 Jul 2019 11:47:58 GMT
 Server: Apache/2.2.31 (Unix) DAV/2 PHP/5.5.36 mod_fastcgi/2.4.6
 Connection: close
 Transfer-Encoding: chunked
 Content-Type: text/plain
 reading chunks .
 reading files ...
   ./README.md
   ./this.egg
   ./this.release-info
   ./this.scm
 cp -r '/tmp/temp303b.18990'/* '/home/chicken/salmonella/build/salmonella-run-publish/salmonella-repo/repo/cache/this'
 this located at /home/chicken/salmonella/build/salmonella-run-publish/salmonella-repo/repo/cache/this

Log file format

The command line tool writes a log file which contains records in the following format:

(<egg> <action> <status> <message> <duration>)
<egg>

Can be either a symbol that indicates the egg-name or #f to indicate the start and end actions (logged when salmonella is started and when it finishes testing, respectively).

<action>

A symbol to indicate the action that was executed. Can be one of the following values:

<status>

A numeric value indicating the exit status of the executed action. When the action is test and status is -1, it means that the egg has no tests.

<message>

The output generated by the commands executed to perform <action>. A string.

<duration>

The time (in seconds) that was taken to execute <action>.

For the start and end actions, the value is the seconds since epoch, so the total salmonella execution time can be determined by subtracting the start time from the end time.

Modules

Salmonella provides two modules:

salmonella
the core salmonella functionality and basic data strucuture for logs (report records)
salmonella-log-parser
provides procedures to access log files and compute simple statistics regarding log file data.

salmonella

report
report egg action status message durationrecord
make-reportprocedure
report?procedure
report-eggprocedure
report-actionprocedure
report-statusprocedure
report-messageprocedure
report-durationprocedure
report-egg-set!procedure
report-action-set!procedure
report-status-set!procedure
report-message-set!procedure
report-duration-set!procedure

report objects. Each log file registry is represented by a report object (serialized as a list).

report->list
report->list reportprocedure

Convert a report object to a list.

log!
log! report log-fileprocedure

Print the report representation to log-file.

make-salmonella
make-salmonella tmp-dir #!key chicken-installation-prefix chicken-install-args eggs-source-dir eggs-doc-dir this-egg?procedure

The salmonella maker. Returns a procedure that receives symbols (methods) to indicate the actions to be performed. The available methods are (example considering a salmonella object returned by make-salmonella):

(salmonella 'init-repo!)
(salmonella 'clear-repo!)
(salmonella 'fetch <egg>)
(salmonella 'install <egg>)
(salmonella 'test <egg>)
(salmonella 'check-version <egg>)
(salmonella 'env-info)
(salmonella 'meta-data <egg>)
(salmonella 'check-dependencies <egg> <meta data>)
(salmonella 'check-category <egg> <meta data>)
(salmonella 'check-license <egg> <meta data>)
(salmonella 'check-author <egg> <meta data>)
(salmonella 'check-doc <egg>)

salmonella-log-parser

Reading
read-log-file filenameprocedure

Reads the log file filename and returns a list of report records.

fetch action
fetch-status
fetch-status egg logprocedure
fetch-message
fetch-message egg logprocedure
fetch-duration
fetch-duration egg logprocedure
install action
install-status
install-status egg logprocedure
install-message
install-message egg logprocedure
install-duration
install-duration egg logprocedure
check-version action
check-version-status
check-version-status egg logprocedure
check-version-message
check-version-message egg logprocedure
egg-version
egg-version egg logprocedure
check-version-ok?
check-version-ok? egg logprocedure
test action
test-status
test-status egg logprocedure
test-message
test-message egg logprocedure
test-duration
test-duration egg logprocedure
has-test?
has-test? egg logprocedure
meta-data action
meta-data
meta-data egg logprocedure
egg-dependencies
egg-dependencies egg logprocedure
egg-license
egg-license egg log #!key with-test-dependencies? with-versions?procedure
check-doc action
doc-exists?
doc-exists? egg logprocedure
start & end actions
start-time
start-time logprocedure
end-time
end-time logprocedure
total-time
total-time logprocedure
salmonella-info
salmonella-info logprocedure
Statistics
count-install-ok
count-install-ok logprocedure
count-install-fail
count-install-fail logprocedure
count-test-ok
count-test-ok logprocedure
count-test-fail
count-test-fail logprocedure
count-no-test
count-no-test logprocedure
count-total-eggs
count-total-eggs log #!key with-skipped?procedure
count-documented
count-documented logprocedure
count-undocumented
count-undocumented logprocedure
Miscelaneous
prettify-time
prettify-time timeprocedure
sort-eggs
sort-eggs eggsprocedure
log-eggs
log-eggs logprocedure
log-skipped-eggs
log-skipped-eggs logprocedure

Environment variables

When running, salmonella sets the SALMONELLA_RUNNING environment variable. If you need to check if your tests code is being run by salmonella, this variable can be used.

Caveats

Testing executable files installed by eggs

Salmonella sets a private repository to install and test eggs, so when extensions install programs, they get installed into <salmonella-repo-dir>/bin, not into $CHICKEN_PREFIX/bin.

So, how to invoke (from tests/run.scm, for example) a binary executable file your egg installs? You have the following options:

So far the only "portable" solution is a combination of both options, which happens to be a bit ugly. Salmonella sets the SALMONELLA_RUNNING environment variable when it runs, so your test script may check that variable and assume your test executable will be found in PATH if it is set. If SALMONELLA_RUNNING is not set, just build up the absolute path to your executable using (program-path). Here's an example:

(use setup-api)

(define executable
  (make-pathname
   (if (get-environment-variable "SALMONELLA_RUNNING")
       #f ;; salmonella adds its REPO_PREFIX/bin to PATH
       (program-path))
   "executable-filename"))

salmonella-epidemy on Windows

salmonella-epidemy is currently not supported on Windows systems.

License

 Copyright (c) 2010-2024, Mario Domenech Goulart
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.
 3. The name of the authors may not be used to endorse or promote products
    derived from this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
 OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
 IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Version history

Version 3.1.1 (2023-12-29)

Version 3.1.0 (2023-12-29)

Version 3.0.1 (2020-08-19)

Version 3.0.0

Version 2.7

Version 2.6

Version 2.5

Version 2.4

Version 2.3

Version 2.2

Version 2.1

Version 2.0

Contents »