Merge lp:~vila/bzr/688072-skip-sphinx-failures into lp:bzr

[Vincent Ladeuil]

Check sphinx version for tests that need it.

python-sphinx has reached 1.0 (and beyond) but we don't yet have
it widely available in most of our setups.

Lately, some tests have been failing on babune, in fact the last
failures to turn the OSX 10.6 slave blue are due to sphinx-1.0.4.

Since I won't investigate and fix the compatibility with the
various sphinx versions (maverick is at 0.6.6), I'd prefer to
just skip them in the mean time (2 tests only are failing out of 18).

[John A Meinel (jameinel)]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 12/9/2010 9:09 AM, Vincent Ladeuil wrote:
> Vincent Ladeuil has proposed merging lp:~vila/bzr/688072-skip-sphinx-failures into lp:bzr.
>
> Requested reviews:
> bzr-core (bzr-core)
> Related bugs:
> #688072 tests failures with sphinx >= 1.0
> https://bugs.launchpad.net/bugs/688072
>
>
> python-sphinx has reached 1.0 (and beyond) but we don't yet have
> it widely available in most of our setups.
>
> Lately, some tests have been failing on babune, in fact the last
> failures to turn the OSX 10.6 slave blue are due to sphinx-1.0.4.
>
> Since I won't investigate and fix the compatibility with the
> various sphinx versions (maverick is at 0.6.6), I'd prefer to
> just skip them in the mean time (2 tests only are failing out of 18).
>

+ def sphinx_version(self):
+ # Convert to a tuple to avoid traps in string comparison
+ # ( '1.12' < '1.6' but (1, 12) > (1, 6) )
+ return tuple(features.sphinx.module.__version__.split('.'))
+

^- I'm pretty sure that isn't enough, since '12' < '6'.

You need to map(int(features.sphinx.module.__version__.split('.'))

I'm fine with this, though not supporting maverick is a bit odd.
John
=:->

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (Cygwin)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAk0BMW4ACgkQJdeBCYSNAANP/QCdFomY6sDeVSLevxHMBbLtGf4d
8dQAoMyRoI9H3M5fHG/HIIldztsLpqbV
=Ro+8
-----END PGP SIGNATURE-----

[lp:~vila/bzr/688072-skip-sphinx-failures]

5565. By Vincent Ladeuil on 2010-12-09

Nice jma's catch, we need ints.

[Vincent Ladeuil (vila)]

> + return tuple(features.sphinx.module.__version__.split('.'))
> +
>
>
> ^- I'm pretty sure that isn't enough, since '12' < '6'.

Doh ! Thanks, fixed.

> I'm fine with this, though not supporting maverick is a bit odd.

(0, 6, 6) < (1,0) so we support maverick. Keep in mind though, that's the texinfo version needs work for all the intra and extra links anyway.

[Vincent Ladeuil (vila)]

sent to pqm by email

=== modified file 'bzrlib/tests/doc_generate/__init__.py'
--- bzrlib/tests/doc_generate/__init__.py	2010-07-21 08:07:14 +0000
+++ bzrlib/tests/doc_generate/__init__.py	2010-12-09 21:38:09 +0000
@@ -52,6 +52,11 @@
 
     _test_needs_features = [features.sphinx]
 
+    def sphinx_version(self):
+        # Convert to a tuple to avoid traps in string comparison
+        # ( '1.12' < '1.6' but (1, 12) > (1, 6) )
+        return tuple(map(int, features.sphinx.module.__version__.split('.')))
+
     def make_sphinx(self):
         out = tests.StringIOWrapper()
         err = tests.StringIOWrapper()

=== modified file 'bzrlib/tests/doc_generate/builders/test_texinfo.py'
--- bzrlib/tests/doc_generate/builders/test_texinfo.py	2010-07-06 13:22:32 +0000
+++ bzrlib/tests/doc_generate/builders/test_texinfo.py	2010-12-09 21:38:09 +0000
@@ -43,6 +43,8 @@
 class TestFileProduction(test_dg.TestSphinx):
 
     def test_files_generated(self):
+        if self.sphinx_version() >= (1, 0):
+            raise tests.TestSkipped('Not compatible with sphinx >= 1.0')
         self.build_tree_contents(
             [('index.txt', """
 Table of Contents

=== modified file 'bzrlib/tests/doc_generate/writers/test_texinfo.py'
--- bzrlib/tests/doc_generate/writers/test_texinfo.py	2010-07-21 08:07:14 +0000
+++ bzrlib/tests/doc_generate/writers/test_texinfo.py	2010-12-09 21:38:09 +0000
@@ -16,6 +16,7 @@
 
 """sphinx texinfo writer tests."""
 
+from bzrlib import tests
 from bzrlib.tests import (
     doc_generate as test_dg, # Avoid clash with from bzrlib import doc_generate
     )
@@ -176,6 +177,8 @@
 class TestTocTreeGeneration(test_dg.TestSphinx):
 
     def test_toctree(self):
+        if self.sphinx_version() >= (1, 0):
+            raise tests.TestSkipped('Not compatible with sphinx >= 1.0')
         self.build_tree_contents(
             [('index.txt', """
 Table of Contents

=== modified file 'doc/en/release-notes/bzr-2.3.txt'
--- doc/en/release-notes/bzr-2.3.txt	2010-12-07 16:27:49 +0000
+++ doc/en/release-notes/bzr-2.3.txt	2010-12-09 21:38:09 +0000
@@ -64,6 +64,9 @@
 * Catch exceptions related to bug #637821 during test cleanup to avoid
   spurious failures. (Vincent Ladeuil, #686008).
 
+* Check sphinx compatibility for tests requiring older sphinx versions.
+  (Vincent Ladeuil, #688072)
+
 * ``TestDebuntuExpansions`` was escaping the test isolation by calling the
   wrong base class ``setUp``. (Vincent Ladeuil, #684622)