salmonella-feeds

  1. salmonella-feeds
    1. Introduction
    2. Author
    3. Repository
    4. Usage
    5. Custom feeds
    6. License
    7. Version history
      1. Version 0.1.0 (2020-11-07)
      2. Version 0

Introduction

salmonella-feeds is a command line tool to generate atom feeds out of salmonella log files.

Author

Mario Domenech Goulart

Repository

The salmonella-feeds egg is maintained in a Github repository.

Usage

 salmonella-feeds [ -h | --help ]
 salmonella-feeds <options>
 
 <options>:
 
 --log-file=<file>
   The salmonella log file.
 
 --feeds-dir=<dir>
   Directory where to write feed files.
 
 --custom-feeds-dir=<dir>
   Directory where custom feeds can be read from (optional).
 
 --custom-feeds-out-dir=<dir>
   Directory where custom feeds will be written to.
 
 --feeds-web-dir=<dir>
   The web directory (i.e., the directory which HTTP clients request) where
   feeds are located.
 
 --custom-feeds-web-dir=<dir>
   The web directory (i.e., the directory which HTTP clients request) where
   custom feeds are located.
 
 --feeds-server=<server address>
   Feeds server address (e.g., "http://tests.call-cc.org")
 
 --salmonella-report-uri=<URI>
   The URI where salmonella reports can be located.

Custom feeds

Custom feeds are special feeds that can be customized by users.

The input file has a simple sexpr-based syntax. Here's an example that:

(title "Eggs that Mario is tracking")

(egg awful)
(egg salmonella)
(egg salmonella-feeds)

;; Ignore failures in tests (this example needs a server process
;; which is not installed on the Salmonella-server)
(egg postgresql ignore-tests)

;; ignore warnings
(egg salmonella-diff ignore-warnings)

License

 Copyright (c) 2011-2020, 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 0.1.0 (2020-11-07)

Version 0