Opened 9 years ago
Closed 9 years ago
#7993 closed defect (fixed)
whitespace error in doctest causes A Mysterious Error.
Reported by: | wjp | Owned by: | tbd |
---|---|---|---|
Priority: | major | Milestone: | sage-4.3.4 |
Component: | doctest coverage | Keywords: | |
Cc: | Merged in: | sage-4.3.4.alpha1 | |
Authors: | Willem Jan Palenstijn | Reviewers: | Paul Zimmermann |
Report Upstream: | N/A | Work issues: | |
Branch: | Commit: | ||
Dependencies: | Stopgaps: |
Description
When doctesting a file a.sage
containing
def foo(): """ sage: 1+1 2 """ pass
(note the missing space before the 2), you get:
[wjp@issa sage-4.3.1.rc0]$ ./sage -t a.sage sage -t "a.sage" A mysterious error (perhaps a memory error?) occurred, which may have crashed doctest. [2.4 s] exit code: 768 ---------------------------------------------------------------------- The following tests failed: sage -t "a.sage" Total time for all tests: 2.4 seconds
Attachments (1)
Change History (16)
comment:1 Changed 9 years ago by
- Status changed from new to needs_review
comment:2 Changed 9 years ago by
As for #7995: thanks much for handling this. I'd love to see this in Sage very shortly.
Please include the new output in the ticket description!
I can try to review this, but I'd rather have a testing framework expert to it.
Changed 9 years ago by
comment:3 Changed 9 years ago by
I noticed an existing, unrelated problem. Let foo.py
contain
def g(): """ sage: 1 + 1 11 """ return
Then sage -tp 1 foo.py
ends with
1 items had failures: 1 of 3 in __main__.example_0 ***Test Failed*** 1 failures. For whitespace errors, see the file /home/.sage//tmp/.doctest_foo.py [2.0 s] ---------------------------------------------------------------------- Traceback (most recent call last): File "/home/apps/sage/local/bin/sage-ptest", line 361, in <module> failed_files[F.split('#')[0].split()[2]] = None IndexError: list index out of range
comment:4 Changed 9 years ago by
Anyway, we can make a separate ticket to unify, simplify, and doctest the doctesting framework.
I'm not an expert, but the changes look OK. Can we report at least partial results for interrupted tests?
comment:5 Changed 9 years ago by
comment:6 Changed 9 years ago by
Minor update: The patch works for me in daily (i.e., not heavy) use. Any other experiences?
comment:7 Changed 9 years ago by
- Status changed from needs_review to needs_work
I wanted to try this patch to see if it would by chance solve #7773, but apparently it needs a rebase for 4.3.3:
---------------------------------------------------------------------- | Sage Version 4.3.3, Release Date: 2010-02-21 | | Type notebook() for the GUI, and license() for information. | ---------------------------------------------------------------------- Loading Sage library. Current Mercurial branch is: 7993 sage: hg_sage.import_patch("/tmp/scripts_7993_doctest_error_handling.patch") cd "/usr/local/sage-4.3.3/sage/devel/sage" && hg status cd "/usr/local/sage-4.3.3/sage/devel/sage" && hg status cd "/usr/local/sage-4.3.3/sage/devel/sage" && hg import "/tmp/scripts_7993_doctest_error_handling.patch" applying /tmp/scripts_7993_doctest_error_handling.patch unable to find 'sage-doctest' for patching 4 out of 4 hunks FAILED -- saving rejects to file sage-doctest.rej unable to find 'sage-ptest' for patching 1 out of 1 hunks FAILED -- saving rejects to file sage-ptest.rej unable to find 'sage-test' for patching 2 out of 2 hunks FAILED -- saving rejects to file sage-test.rej abort: patch failed to apply
Paul
comment:8 Changed 9 years ago by
The patch is for the scripts repository, whose root is SAGE_ROOT/local/bin
. Try using hg_scripts
, instead. I think the patch will still apply cleanly to 4.3.3.
comment:9 Changed 9 years ago by
- Status changed from needs_work to needs_info
sorry, I still cannot apply this patch on 4.3.3, even with hg_scripts
:
---------------------------------------------------------------------- | Sage Version 4.3.3, Release Date: 2010-02-21 | | Type notebook() for the GUI, and license() for information. | ---------------------------------------------------------------------- Loading Sage library. Current Mercurial branch is: 7993 sage: hg_scripts.import_patch("/tmp/scripts_7993_doctest_error_handling.patch") cd "/usr/local/sage-4.3.3/sage/local/bin" && hg status cd "/usr/local/sage-4.3.3/sage/local/bin" && hg status cd "/usr/local/sage-4.3.3/sage/local/bin" && hg import "/tmp/scripts_7993_doctest_error_handling.patch" applying /tmp/scripts_7993_doctest_error_handling.patch patching file sage-doctest Hunk #1 FAILED at 4 Hunk #2 FAILED at 151 Hunk #3 FAILED at 170 Hunk #4 FAILED at 655 4 out of 4 hunks FAILED -- saving rejects to file sage-doctest.rej patching file sage-ptest Hunk #1 FAILED at 163 1 out of 1 hunks FAILED -- saving rejects to file sage-ptest.rej patching file sage-test Hunk #1 FAILED at 84 Hunk #2 FAILED at 109 2 out of 2 hunks FAILED -- saving rejects to file sage-test.rej abort: patch failed to apply
Did I something wrong?
comment:10 Changed 9 years ago by
That's strange; the same command works for me in a clean 4.3.3. Do you have any other patches applied to the scripts repo? (I don't think branching will affect that repo.) You can check with hg_scripts.status() and hg_scripts.log().
Also, since all hunks are failing, could it be a line ending problem? (mac vs. unix vs. dos?)
comment:11 Changed 9 years ago by
I get:
sage: hg_scripts.status() Getting status of modified or unknown files: cd "/usr/local/sage-4.3.3/sage/local/bin" && hg status ? cbc ? clp ---
and:
sage: hg_scripts.log() cd "/usr/local/sage-4.3.3/sage/local/bin" && hg log | less changeset: 1449:0893591acc56 tag: tip user: Willem Jan Palenstijn <wjp@usecode.org> date: Wed Jan 20 10:52:15 2010 -0800 summary: #7993: clean up error handling in sage-doctest changeset: 1448:77ae8a697bba user: Minh Van Nguyen <nguyenminh2@gmail.com> date: Sun Feb 21 17:22:49 2010 -0800 summary: 4.3.3 ...
I thought that sage -clone 7993
would create a fresh clone of 4.3.3, where I could apply
and test your patch. Do you mean that I've already applied your patch?
comment:12 Changed 9 years ago by
Yes, it does look like it. I don't think sage -clone
touches the scripts repository, but only the main sage library.
comment:13 Changed 9 years ago by
- Reviewers set to Paul Zimmermann
- Status changed from needs_info to needs_review
with the patch, we now get with the initial example:
tarte% sage -t a.sage sage -t "a.sage" Exception raised by doctesting framework. Use -verbose for details. [1.4 s] ---------------------------------------------------------------------- The following tests failed: sage -t "a.sage" # Exception from doctest framework Total time for all tests: 1.4 seconds
and the whole doctest still produces 22 Segfaults (see #7773). However, instead of say:
sage -t tests/benchmark.py A mysterious error (perhaps a memory error?) occurred, which may have crashed d\ octest. [62.3 s]
we now get:
sage -t tests/benchmark.py The doctested process was killed by signal 14 [62.5 s]
which is more informative. I thus give a positive review.
comment:14 Changed 9 years ago by
- Status changed from needs_review to positive_review
comment:15 Changed 9 years ago by
- Merged in set to sage-4.3.4.alpha1
- Resolution set to fixed
- Status changed from positive_review to closed
I changed the
sage-doctest
script to make the actual doctesting process catch exceptions and communicate this tosage-doctest
via the process exit code.It now differentiates between a crash and an exception raised by the doctesting code.
This patch depends on the patch at #7995.