[Pancutan-commits] r74 - in pancutan: . debian lib/Pancutan tests tests/lib/Pancutan/Test

tincho-guest at alioth.debian.org tincho-guest at alioth.debian.org
Mon Aug 20 18:15:57 UTC 2007


Author: tincho-guest
Date: 2007-08-20 18:15:56 +0000 (Mon, 20 Aug 2007)
New Revision: 74

Added:
   pancutan/COPYING
Modified:
   pancutan/MANIFEST
   pancutan/README
   pancutan/debian/changelog
   pancutan/debian/control
   pancutan/debian/docs
   pancutan/lib/Pancutan/Config.pm
   pancutan/lib/Pancutan/Tests.pm
   pancutan/lib/Pancutan/Util.pm
   pancutan/pancutan
   pancutan/tests/Makefile.PL
   pancutan/tests/lib/Pancutan/Test/Booting.pm
   pancutan/tests/lib/Pancutan/Test/Files.pm
   pancutan/tests/lib/Pancutan/Test/Meta.pm
   pancutan/tests/lib/Pancutan/Test/Repositories.pm
   pancutan/tests/lib/Pancutan/Test/Sizes.pm
   pancutan/tests/lib/Pancutan/Test/Structural.pm
Log:
* Release for the end of GSoC. Lots of stuff still in the TODO.
* More documentation added.
* Properly added copyright notices to source.

Added: pancutan/COPYING
===================================================================
--- pancutan/COPYING	                        (rev 0)
+++ pancutan/COPYING	2007-08-20 18:15:56 UTC (rev 74)
@@ -0,0 +1,339 @@
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+
+	    How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

Modified: pancutan/MANIFEST
===================================================================
--- pancutan/MANIFEST	2007-08-20 17:17:54 UTC (rev 73)
+++ pancutan/MANIFEST	2007-08-20 18:15:56 UTC (rev 74)
@@ -20,3 +20,4 @@
 tests/lib/Pancutan/Test/Structural.pm
 tests/Makefile.PL
 README
+COPYING

Modified: pancutan/README
===================================================================
--- pancutan/README	2007-08-20 17:17:54 UTC (rev 73)
+++ pancutan/README	2007-08-20 18:15:56 UTC (rev 74)
@@ -1,3 +1,121 @@
-You need to have enough loop devices if you're using mount to access the images.
+Pancután - A lintian-like tool to test ISO files created with debian-cd.
 
- # modprobe loop max_loop=30
+The invocation parameters and configuration file are documented in the
+pancutan(1) man page, copied below. Documentation for writing plugins can be
+found in the Pancutan::Tests(3pm) man page.
+
+Note that for running this tool, you need a way to mount the images: either
+root permission via sudo, fuseiso9660 plus fuse permissions or user-mode-linux
+for running without any privileges. The faster alternative is sudo, but it is
+not suitable for everyone.
+
+
+NAME
+    pancutan - Automated testing of Debian installation CDs
+
+SYNOPSIS
+    pancutan [options] *ISO_FILE* [*ISO_FILE* ...]
+
+DESCRIPTION
+    pancutan runs automated tests on sets of CD images and reports errors in
+    standard output. It expects debian-cd generated images, but it can
+    operate on any ISO-9660 image, and even display some useful information.
+    All the images provided should belong to the same set of installation
+    media, for testing independent images, run a different instance on each
+    of them.
+
+    To this end, each image is mounted with one of three different methods,
+    which are described under OPTIONS, and then different tests are run on
+    them. A fully modular architecture has been built to allow for easy
+    development of new tests. The documentation that specifies the calling
+    convention and result passing can be found in the Pancutan::Tests man
+    page.
+
+DIAGNOSTICS
+    When finished, pancutan returns an exit code describing the result. It
+    is a sum of the following conditions, or zero if everything was OK:
+
+     1  - A warning has been triggered
+     2  - An non-fatal error encountered
+     4  - Fatal error in the image
+     16 - Fatal internal error
+     32 - Signal caught
+
+OPTIONS
+    Each file specified in the command line should be an ISO-9660 filesystem
+    image or a block device where an ISO-9660 filesystem resides, pancutan
+    will handle them automatically.
+
+    --help  Print a brief help message and exits.
+
+    --version
+            Show program's version and exit
+
+    --config *FILE*
+            Specifies configuration file location (/etc/pancutan.conf)
+
+    --concurrency, -j *int*
+            Maximum number of parallel tests to run (2, use 0 for never
+            forking)
+
+    --verbose, -v [*n*]
+            Increase or set verbosity level
+
+    --continue-on-fatal
+            Continue testing after a fatal error
+
+    --testdef-dir *DIR*
+            Directory containing test definitions (default:
+            "/usr/share/pancutan/tests/")
+
+    --temp-dir *DIR*
+            Temporary directory (default: ".pancutan.$$")
+
+    --mount-method sudomount | fuseiso9660 | uml
+            Specifies which method to use for mounting the images, defaults
+            to sudomount.
+
+            sudomount uses the standard mount, calling sudo to gain root. It
+            uses loopback devices when needed. It should be noted that for
+            this to work correctly, you need the loop module installed with
+            enough loop devices configured. As a rule of thumb, the double
+            of the number of images that you're testing in one run, e.g.:
+
+             # modprobe loop max_loop=20
+
+            fuseiso9660 uses the FUSE module to mount filesystems without
+            root privileges. Requires FUSE, fuseiso9660 and permissions to
+            run it.
+
+            uml runs the whole process inside an instance of
+            user-mode-linux, and inside the virtual machine uses root
+            privileges to execute mount as with sudomount. There is a
+            problem when unmounting, as it should guess which loop device is
+            being used, if it fails to correctly free it, the virtual
+            machine can run out of free loop devices. Please report a bug if
+            you find that the detection is not working correctly.
+
+CONFIGURATION
+    The behaviour of pancutan can be controlled by the command line or with
+    a configuration file, located by default in */etc/pancutan.conf*. This
+    file follows YAML format, and allows the following parameters:
+
+    concurrency
+    verbose
+    continue_on_fatal
+    testdef_dir
+    temp_dir
+    mount_method
+            These parameters are the same as in the command line.
+
+    uml_args
+            Allows to pass extra parameters to user-mode-linux. It should be
+            an array ref of strings to be passed to exec(), or a string if
+            it's onle one parameter. Defaults to mem=64M.
+
+SEE ALSO
+    Pancutan::Tests
+
+AUTHOR
+    Martin Ferrari "<martin.ferrari at gmail.com>"
+

Modified: pancutan/debian/changelog
===================================================================
--- pancutan/debian/changelog	2007-08-20 17:17:54 UTC (rev 73)
+++ pancutan/debian/changelog	2007-08-20 18:15:56 UTC (rev 74)
@@ -1,9 +1,12 @@
 pancutan (0.3) unstable; urgency=low
 
+  * Release for the end of GSoC. Lots of stuff still in the TODO.
   * A lot of work done, specially on the booting area.
   * Support for running without any privilege, inside user-mode-linux.
+  * More documentation added.
+  * Properly added copyright notices to source.
 
- -- Martín Ferrari <martin.ferrari at gmail.com>  Sun, 19 Aug 2007 05:35:18 +0100
+ -- Martín Ferrari <martin.ferrari at gmail.com>  Mon, 20 Aug 2007 18:08:32 +0100
 
 pancutan (0.2) unstable; urgency=low
 

Modified: pancutan/debian/control
===================================================================
--- pancutan/debian/control	2007-08-20 17:17:54 UTC (rev 73)
+++ pancutan/debian/control	2007-08-20 18:15:56 UTC (rev 74)
@@ -7,9 +7,13 @@
 
 Package: pancutan
 Architecture: any
-Depends: ${perl:Depends}, libyaml-syck-perl | libyaml-perl, libdigest-sha-perl, libcdio7, libdevice-cdio-perl (>= 0.2.4-2), libcompress-zlib-perl (>= 2.005-3), libcompress-bzip2-perl, libio-compress-zlib-perl, hfsbootfiles
-Description: A modular lintian-like tool to test ISO files created with debian-cd
+Depends: ${perl:Depends}, libyaml-syck-perl | libyaml-perl, libdigest-sha-perl,
+ libcdio7, libdevice-cdio-perl (>= 0.2.4-2),
+ libcompress-zlib-perl (>= 2.005-3), libcompress-bzip2-perl,
+ libio-compress-zlib-perl, hfsbootfiles
+Recommends: user-mode-linux | sudo | fuseiso9660
+Description: A modular lintian-like tool to test images created with debian-cd
  Pancután is a tool to test ISO files before they are distributed, in a way
  similar to lintian. It aims to support CDDs, and even Debian-Live CDs.
  .
- Homepage: http://pancutan.alioth.debian.org/
+  Homepage: http://pancutan.alioth.debian.org/

Modified: pancutan/debian/docs
===================================================================
--- pancutan/debian/docs	2007-08-20 17:17:54 UTC (rev 73)
+++ pancutan/debian/docs	2007-08-20 18:15:56 UTC (rev 74)
@@ -0,0 +1 @@
+README

Modified: pancutan/lib/Pancutan/Config.pm
===================================================================
--- pancutan/lib/Pancutan/Config.pm	2007-08-20 17:17:54 UTC (rev 73)
+++ pancutan/lib/Pancutan/Config.pm	2007-08-20 18:15:56 UTC (rev 74)
@@ -1,5 +1,22 @@
 package Pancutan::Config;
 # vim: ts=4:sw=4:et:ai:sts=4
+#
+# Copyright 2007, Martín Ferrari <martin.ferrari at gmail.com>
+#
+#    This file is part of Pancutan.
+#
+#    Pancutan is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    Pancutan is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 use warnings;
 use strict;
@@ -7,18 +24,18 @@
 use Cwd;
 require Pancutan::Util; # Cyclic dependency
 
-use Exporter   ();
-our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
+BEGIN {
+    use Exporter   ();
+    our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
 
-# set the version for version checking
-$VERSION     = 0.02;
+    # set the version for version checking
+    $VERSION     = 0.02;
 
- at ISA         = qw(Exporter);
- at EXPORT      = qw(%CONFIG);
- at EXPORT_OK   = qw(get_default_config read_config);
-%EXPORT_TAGS = ( all => [ '%CONFIG', @EXPORT_OK ] );
+    @ISA         = qw(Exporter);
+    @EXPORT      = qw(%CONFIG);
+    @EXPORT_OK   = qw(get_default_config read_config);
+    %EXPORT_TAGS = ( all => [ '%CONFIG', @EXPORT_OK ] );
 
-BEGIN {
     eval { require YAML::Syck; import YAML::Syck; };
     if($@) {
         require YAML; import YAML;

Modified: pancutan/lib/Pancutan/Tests.pm
===================================================================
--- pancutan/lib/Pancutan/Tests.pm	2007-08-20 17:17:54 UTC (rev 73)
+++ pancutan/lib/Pancutan/Tests.pm	2007-08-20 18:15:56 UTC (rev 74)
@@ -1,5 +1,22 @@
 package Pancutan::Tests;
 # vim: ts=4:sw=4:et:ai:sts=4
+#
+# Copyright 2007, Martín Ferrari <martin.ferrari at gmail.com>
+#
+#    This file is part of Pancutan.
+#
+#    Pancutan is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    Pancutan is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 use strict;
 use warnings;

Modified: pancutan/lib/Pancutan/Util.pm
===================================================================
--- pancutan/lib/Pancutan/Util.pm	2007-08-20 17:17:54 UTC (rev 73)
+++ pancutan/lib/Pancutan/Util.pm	2007-08-20 18:15:56 UTC (rev 74)
@@ -1,6 +1,24 @@
 package Pancutan::Util;
 # vim: ts=4:sw=4:et:ai:sts=4
+#
+# Copyright 2007, Martín Ferrari <martin.ferrari at gmail.com>
+#
+#    This file is part of Pancutan.
+#
+#    Pancutan is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    Pancutan is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+
 use strict;
 use warnings;
 use Pancutan::Config;
@@ -10,15 +28,15 @@
 use POSIX ":sys_wait_h";
 use Cwd;
 
-use Exporter ();
-our @ISA = qw(Exporter);
-our @EXPORT = qw(execute debug info warnn mount umount_all mktmpfile
-rmtmpfiles mktmpdir rmtmpdirs);
-our @EXPORT_OK   = qw(running queue_init run_task collect_results can_run);
-our %EXPORT_TAGS = ( all => [ @EXPORT, @EXPORT_OK ],
-    queue => [ @EXPORT_OK ] );
+BEGIN {
+    use Exporter ();
+    our @ISA = qw(Exporter);
+    our @EXPORT = qw(execute debug info warnn mount umount_all mktmpfile
+    rmtmpfiles mktmpdir rmtmpdirs);
+    our @EXPORT_OK   = qw(running queue_init run_task collect_results can_run);
+    our %EXPORT_TAGS = ( all => [ @EXPORT, @EXPORT_OK ],
+        queue => [ @EXPORT_OK ] );
 
-BEGIN {
    	eval { require YAML::Syck; import YAML::Syck; };
 	if($@) {
 		require YAML; import YAML;
@@ -330,16 +348,31 @@
 
 =item B<umount_all>
 
-Unmounts all the files that were mounted by the current process
+Unmounts all the files that were mounted by the current process. It should not be called by modules, as it's automatically invoked during cleanup on exit.
 
-=item B<mktmpfile>
+=item B<mktmpfile> TEMPLATE SUFFIX
 
-=item B<mktmpdir>
+=item B<mktmpdir> TEMPLATE ERASE_CONTENTS
 
 =item B<rmtmpfiles>
 
 =item B<rmtmpdirs>
 
+These four routines handle the creation and destruction of temporary files and
+directories. The destruction routines should not be called by modules, as they
+are automatically invoked during cleanup on exit, and they only deal with files
+or directories created by the current process.
+
+The temporary files and directories will be created inside the global
+B<temp_dir>, using the I<File::Temp> functions. As such both routines take an
+optional I<TEMPLATE> argument, with the same semantics as in said module. The
+optional I<ERASE_CONTENTS> argument to B<mktmpdir> specifies if the contents of
+the directory should be wiped upon destruction, using the I<rmtree> routine
+from the I<File::Path> module.
+
+Like their I<File::Temp> counterparts, B<mktmpfile> returns a list of
+(I<filehandle>, I<filename>) and B<mktmpdir> returns the directory name.
+
 =item B<queue_init>
 
 Initialises the queue for parallel task management.

Modified: pancutan/pancutan
===================================================================
--- pancutan/pancutan	2007-08-20 17:17:54 UTC (rev 73)
+++ pancutan/pancutan	2007-08-20 18:15:56 UTC (rev 74)
@@ -1,5 +1,22 @@
 #!/usr/bin/perl
 # vim: ts=4:sw=4:et:ai:sts=4
+#
+# Copyright 2007, Martín Ferrari <martin.ferrari at gmail.com>
+#
+#    This file is part of Pancutan.
+#
+#    Pancutan is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    Pancutan is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 use warnings;
 use strict;
@@ -13,9 +30,9 @@
 
 # Error codes
 my %error_t = (
-    fatal  => [ "F", 8 ],
-    error  => [ "E", 4 ],
-    warn   => [ "W", 2 ]);
+    fatal  => [ "F", 4 ],
+    error  => [ "E", 2 ],
+    warn   => [ "W", 1 ]);
 
 # Global variables
 our $i_am_a_fork = 0;
@@ -53,7 +70,7 @@
 # The fun begins
 info("Starting checks");
 my @ready = grep {not %{$run->{$_}{depends}}} keys %$run;
-my $ecode = 0;
+our $ecode = 0;
 my $must_wait;
 queue_init();
 while(1) {
@@ -137,7 +154,8 @@
         kill INT => 0;
         while(wait() != -1) {}
     }
-    die @_;
+    warn @_;
+    exit($ecode | 16) if($ecode);
 }
 sub sighandler {
     my $sig = shift;
@@ -152,7 +170,8 @@
     #$SIG{$sig} = "DEFAULT";
     #kill $sig, $$;
     # Let it die(), so END{} is called
-    exit 16;
+    exit($ecode | 32) if($ecode);
+    exit 32;
 }
 sub cleanup {
     umount_all();
@@ -179,7 +198,7 @@
      --testdef-dir DIR      Directory for finding test defitions
                             (/usr/share/pancutan/tests/)
      --temp-dir DIR         Temporary directory (.pancutan.\$\$)
-     --mount_method METHOD  Specify which method to use to mount files:
+     --mount-method METHOD  Specify which method to use to mount files:
                             sudomount, fuseiso9660 or uml (sudomount)
 
 END
@@ -194,8 +213,38 @@
 
 pancutan [options] I<ISO_FILE> [I<ISO_FILE> ...]
 
+=head1 DESCRIPTION
+
+B<pancutan> runs automated tests on sets of CD images and reports errors in
+standard output. It expects debian-cd generated images, but it can operate on
+any ISO-9660 image, and even display some useful information. All the images
+provided should belong to the same set of installation media, for testing
+independent images, run a different instance on each of them.
+
+To this end, each image is mounted with one of three different methods, which
+are described under B<OPTIONS>, and then different tests are run on them. A
+fully modular architecture has been built to allow for easy development of new
+tests. The documentation that specifies the calling convention and result
+passing can be found in the L<Pancutan::Tests> man page.
+
+
+=head1 DIAGNOSTICS
+
+When finished, B<pancutan> returns an exit code describing the result. It is a
+sum of the following conditions, or zero if everything was OK:
+
+ 1  - A warning has been triggered
+ 2  - An non-fatal error encountered
+ 4  - Fatal error in the image
+ 16 - Fatal internal error
+ 32 - Signal caught
+
 =head1 OPTIONS
 
+Each file specified in the command line should be an ISO-9660 filesystem image
+or a block device where an ISO-9660 filesystem resides, B<pancutan> will handle
+them automatically.
+
 =over 8
 
 =item B<--help>
@@ -236,25 +285,31 @@
 B<sudomount>.
 
 B<sudomount> uses the standard mount, calling sudo to gain root. It uses
-loopback devices when needed.
+loopback devices when needed. It should be noted that for this to work
+correctly, you need the loop module installed with enough loop devices
+configured. As a rule of thumb, the double of the number of images that you're
+testing in one run, e.g.:
 
+ # modprobe loop max_loop=20
+
 B<fuseiso9660> uses the FUSE module to mount filesystems without root
-privileges. Requires FUSE and permission to run it.
+privileges. Requires FUSE, fuseiso9660 and permissions to run it.
 
 B<uml> runs the whole process inside an instance of user-mode-linux, and inside
 the virtual machine uses root privileges to execute mount as with B<sudomount>.
+There is a problem when unmounting, as it should guess which loop device is
+being used, if it fails to correctly free it, the virtual machine can run out
+of free loop devices. Please report a bug if you find that the detection is not
+working correctly.
 
 =back
 
-=head1 DESCRIPTION
+=head1 CONFIGURATION
 
-B<pancutan> runs automated tests on sets of CD images and reports errors in
-standard output.
+The behaviour of B<pancutan> can be controlled by the command line or with a
+configuration file, located by default in I</etc/pancutan.conf>. This file
+follows L<YAML> format, and allows the following parameters:
 
-It's behaviour can be controlled by the command line or with a configuration
-file, located by default in I</etc/pancutan.conf>. This file follows L<YAML>
-format, and allows the following parameters:
-
 =over 8
 
 =item B<concurrency>
@@ -275,8 +330,16 @@
 
 Allows to pass extra parameters to user-mode-linux. It should be an array ref
 of strings to be passed to exec(), or a string if it's onle one parameter.
-Defaults to "mem=64M".
+Defaults to B<mem=64M>.
 
 =back
 
+=head1 SEE ALSO
+
+L<Pancutan::Tests>
+
+=head1 AUTHOR
+
+Martin Ferrari C<< <martin.ferrari at gmail.com> >>
+
 =cut

Modified: pancutan/tests/Makefile.PL
===================================================================
--- pancutan/tests/Makefile.PL	2007-08-20 17:17:54 UTC (rev 73)
+++ pancutan/tests/Makefile.PL	2007-08-20 18:15:56 UTC (rev 74)
@@ -13,7 +13,7 @@
 		"Compress::Bzip2" => 0,
 		"IO::Uncompress::Gunzip" => 0,
 		"Math::BigInt" => 0,
-		"HTML::Entities" => 0,
-		"HTML::PullParser" => 0,
+#		"HTML::Entities" => 0,
+#		"HTML::PullParser" => 0,
 	}
 );

Modified: pancutan/tests/lib/Pancutan/Test/Booting.pm
===================================================================
--- pancutan/tests/lib/Pancutan/Test/Booting.pm	2007-08-20 17:17:54 UTC (rev 73)
+++ pancutan/tests/lib/Pancutan/Test/Booting.pm	2007-08-20 18:15:56 UTC (rev 74)
@@ -1,4 +1,22 @@
 # vim:ts=4:sw=4:et:ai:sts=4
+#
+# Copyright 2007, Martín Ferrari <martin.ferrari at gmail.com>
+#
+#    This file is part of Pancutan.
+#
+#    Pancutan is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    Pancutan is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 package Pancutan::Test::Booting;
 
 use strict;
@@ -926,8 +944,12 @@
             }
         }
     }
-    use Data::Dumper;
-    print Dumper(\@bootconfig, \%bootpair);
+    foreach(keys %bootpair) {
+        push(@{$meta->{set}[$ncd]{boot}{path}},
+            { kernel => $bootpair{$_}[0], initrd => $bootpair{$_}[1] });
+        info("Detected booting path, kernel: $bootpair{$_}[0]" .
+            ($bootpair{$_}[1] ? ", initrd: " . $bootpair{$_}[1] : ""));
+    }
     return @res;
 }
 sub _myread {
@@ -1048,13 +1070,34 @@
 
 =over
 
-=item B<read_eltorito>
+=item B<detect_eltorito>
 
+=item B<detect_apm_partition>
+
+=item B<detect_mbr_partition>
+
+=item B<detect_bsd_partition>
+
+=item B<detect_sparc_partition>
+
+=item B<detect_sgi_partition>
+
+=item B<detect_pmax_boot>
+
+=item B<detect_alpha_boot>
+
 Type: first_cd
 
-Detects if an ISO image has an El Torito boot descriptor and verifies its
-validity.
+These routines scan the ISO image for the different boot methods of each
+architecture, perform sanity checks and detect the bootloaders and their
+configuration files, if any. That information is later parsed by
+I<detect_boot_sequence>.
 
+=item B<detect_boot_sequence>
+
+Once detected all the possible boot methods, parses configuration files and
+determines which kernels and initrds are being loaded.
+
 =back
 
 =head1 SEE ALSO

Modified: pancutan/tests/lib/Pancutan/Test/Files.pm
===================================================================
--- pancutan/tests/lib/Pancutan/Test/Files.pm	2007-08-20 17:17:54 UTC (rev 73)
+++ pancutan/tests/lib/Pancutan/Test/Files.pm	2007-08-20 18:15:56 UTC (rev 74)
@@ -1,4 +1,22 @@
 # vim:ts=4:sw=4:et:ai:sts=4
+#
+# Copyright 2007, Martín Ferrari <martin.ferrari at gmail.com>
+#
+#    This file is part of Pancutan.
+#
+#    Pancutan is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    Pancutan is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 package Pancutan::Test::Files;
 
 use strict;

Modified: pancutan/tests/lib/Pancutan/Test/Meta.pm
===================================================================
--- pancutan/tests/lib/Pancutan/Test/Meta.pm	2007-08-20 17:17:54 UTC (rev 73)
+++ pancutan/tests/lib/Pancutan/Test/Meta.pm	2007-08-20 18:15:56 UTC (rev 74)
@@ -1,4 +1,22 @@
 # vim:ts=4:sw=4:et:ai:sts=4
+#
+# Copyright 2007, Martín Ferrari <martin.ferrari at gmail.com>
+#
+#    This file is part of Pancutan.
+#
+#    Pancutan is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    Pancutan is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 package Pancutan::Test::Meta;
 
 use strict;

Modified: pancutan/tests/lib/Pancutan/Test/Repositories.pm
===================================================================
--- pancutan/tests/lib/Pancutan/Test/Repositories.pm	2007-08-20 17:17:54 UTC (rev 73)
+++ pancutan/tests/lib/Pancutan/Test/Repositories.pm	2007-08-20 18:15:56 UTC (rev 74)
@@ -1,4 +1,22 @@
 # vim:ts=4:sw=4:et:ai:sts=4
+#
+# Copyright 2007, Martín Ferrari <martin.ferrari at gmail.com>
+#
+#    This file is part of Pancutan.
+#
+#    Pancutan is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    Pancutan is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 package Pancutan::Test::Repositories;
 
 use strict;

Modified: pancutan/tests/lib/Pancutan/Test/Sizes.pm
===================================================================
--- pancutan/tests/lib/Pancutan/Test/Sizes.pm	2007-08-20 17:17:54 UTC (rev 73)
+++ pancutan/tests/lib/Pancutan/Test/Sizes.pm	2007-08-20 18:15:56 UTC (rev 74)
@@ -1,4 +1,22 @@
 # vim:ts=4:sw=4:et:ai:sts=4
+#
+# Copyright 2007, Martín Ferrari <martin.ferrari at gmail.com>
+#
+#    This file is part of Pancutan.
+#
+#    Pancutan is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    Pancutan is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 package Pancutan::Test::Sizes;
 
 use strict;

Modified: pancutan/tests/lib/Pancutan/Test/Structural.pm
===================================================================
--- pancutan/tests/lib/Pancutan/Test/Structural.pm	2007-08-20 17:17:54 UTC (rev 73)
+++ pancutan/tests/lib/Pancutan/Test/Structural.pm	2007-08-20 18:15:56 UTC (rev 74)
@@ -1,4 +1,22 @@
 # vim:ts=4:sw=4:et:ai:sts=4
+#
+# Copyright 2007, Martín Ferrari <martin.ferrari at gmail.com>
+#
+#    This file is part of Pancutan.
+#
+#    Pancutan is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    Pancutan is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 package Pancutan::Test::Structural;
 
 use strict;




More information about the Pancutan-commits mailing list