On 5 Jul., 17:23, Simon King <simon.k...@uni-jena.de> wrote:
> Dear sage devel,
>
> currently I am writing a test suite for my cohomology spkg. In the
> Developer's Guide, I read:
>
> spkg-check: this file runs the test suite. This is somewhat optional
> since not all spkgs have test suites. If possible do create such a
> script since it helps isolate bugs in upstream packages
>
> OK, I have spkg-check. But what exactly is it supposed to do? Is it
> fine to print on the screen whether all tests passed or not, and in
> the latter case to save the log in some file test.log in the current
> directory?
>
> And when will spkg-check be called? Is this something that the user
> has to do manually? Will there be tests on a regular basis?
>
> Perhaps these informations could go into the Developer's Guide as
> well.
>
> Best regards,
> Simon
Hi Simon,
first of all, "sage-check" is something specific to Sage. The Sage
project is expanding the number of platforms Sage runs on (think of
Solaris, and "native Windows"), new compiler versions (GCC 4.4),
eventually switching to new versions of NTL, GMP/MPIR, and so on.
This means that although the author of a certain spkg might not have
had a specific setting in mind, or the latter just wasn't exisiting at
creation time of the spkg, the Sage project might want to compile/use
this spkg in an environment it has never been tested/run in before.
Likely, there are problems (see other threads regarding Singular/GCC
4.4, or Solaris, or BSD, ...).
The "sage-check" script should be a device to determine quickly "YES,
sir, we do have some problem in this new setting!", and provide, if
possible, a starting point for debugging/solving this problem.
So if your spkg is, say, pure Python/Cython, probably all may be done
by doctests.
But if you have, say, a C or CPP library in your spkg, it is a must
that the spkg-check is executable without Sage/Python/Cython running
at all, to be able to detect linker problems, compiler issues,
platform dependencies, and the like.
So the spkg-check scripts in general are not at all called by the
users. But they are very helpful for integrators, should any problems
arise. So the output should be reproducible, and a kind of "test.log"
is always a good idea.
If this does answer your questions, please feel free to open a trac
ticket "Developers' Guide enhancement: About spkg-check". :-)
Cheers,
gsw
--~--~---------~--~----~------------~-------~--~----~
To post to this group, send email to sage-devel@googlegroups.com
To unsubscribe from this group, send email to
sage-devel-unsubscr...@googlegroups.com
For more options, visit this group at http://groups.google.com/group/sage-devel
URLs: http://www.sagemath.org
-~----------~----~----~----~------~----~------~--~---
