source: project/wiki/eggref/5/test-new-egg @ 39156

== test-new-egg

[[toc:]]

=== Description

{{test-new-egg}} is a simple commmand line tool to test new CHICKEN
eggs before they are added to the official repository of eggs.

The inputs for {{test-new-egg}} are the egg name the URI for the new
egg's .release-info file.  It then uses
[[/egg/henrietta-cache|henrietta-cache]] to download the egg's source
code and uses [[/egg/salmonella|salmonella]] to test it.

Since version 1.0.2, the following environment variables are respected:

* {{TEST_NEW_EGG_HENRIETTA_CACHE}}: if set, {{test-new-egg}} will assume
  it points to the {{henrietta-cache}} executable.

* {{TEST_NEW_EGG_SALMONELLA}}: if set, {{test-new-egg}} will assume it
  points to the {{salmonella}} executable.


=== Author

[[/users/mario-domenech-goulart|Mario Domenech Goulart]]


=== Requirements

* [[/egg/henrietta-cache|henrietta-cache]]
* [[/egg/salmonella|salmonella]]


=== Repository

[[https://github.com/mario-goulart/test-new-egg|https://github.com/mario-goulart/test-new-egg]]


=== Usage

  Usage: test-new-egg <egg name> <.release-info URI>


=== License

 Copyright (c) 2017-2019, 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:
 
 Redistributions of source code must retain the above copyright
 notice, this list of conditions and the following disclaimer.
 
 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.
 
 Neither the name of the author nor the names of its contributors may
 be used to endorse or promote products derived from this software
 without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 "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
 COPYRIGHT HOLDERS OR CONTRIBUTORS 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 1.0.2 (2020-11-07)

The following environment variables are now respected:

* {{TEST_NEW_EGG_HENRIETTA_CACHE}}: if set, {{test-new-egg}} will assume
  it points to the {{henrietta-cache}} executable.

* {{TEST_NEW_EGG_SALMONELLA}}: if set, {{test-new-egg}} will assume it
  points to the {{salmonella}} executable.

Thanks to Sergey Geldgaber for coming up with a use-case for this feature.


===== version 1.0.1
* Pass CHICKEN major version to henrietta-cache, so that URLs for pseudo-meta-egg-info work properly.


===== version 1.0.0
* CHICKEN 5 support

* Require egg name as first argument for {{test-new-egg}}, as egg names cannot be reliably infered from {{.release-info}} files

* Use tools ({{salmonella}} and {{henrietta-cache}}) from the same prefix as {{test-new-egg}}


===== version 0.0.1
* Initial release