Merge lp:~cjwatson/lazr.authentication/tox into lp:lazr.authentication

[Colin Watson]

Add tox testing support and drop buildout.

I was very fed up of having to deal with buildout and remember the various arcane invocations required to actually run the doctests properly.

[lp:~cjwatson/lazr.authentication/tox]

55. By Colin Watson on 2018-05-08

Fix documentation version handling.

[Matias Bordese (matiasb)]

LGTM

review: Approve

=== modified file '.bzrignore'
--- .bzrignore	2009-03-17 14:52:16 +0000
+++ .bzrignore	2018-05-08 08:04:58 +0000
@@ -1,11 +1,11 @@
+*.egg-info
+*.pyc
+__pycache__
+.tox
 bin
-develop-eggs
-.installed.cfg
-develop-eggs
-parts
-*.egg-info
+build
+dist
+MANIFEST
 tags
 TAGS
-build
-*.egg
-dist
+src/lazr/authentication/docs/_build

=== renamed file 'HACKING.txt' => 'HACKING.rst'
--- HACKING.txt	2009-10-06 18:04:43 +0000
+++ HACKING.rst	2018-05-08 08:04:58 +0000
@@ -13,16 +13,11 @@
     You should have received a copy of the GNU Lesser General Public License
     along with lazr.authentication.  If not, see <http://www.gnu.org/licenses/>.
 
-This project uses zc.buildout for development.
-
 ============
 Introduction
 ============
 
-These are guidelines for hacking on the lazr.authentication project.  But first,
-please see the common hacking guidelines at:
-
-    http://dev.launchpad.net/Hacking
+To run this project's tests, use `tox <https://tox.readthedocs.io/en/latest/>`.
 
 
 Getting help

=== modified file 'MANIFEST.in'
--- MANIFEST.in	2009-06-26 18:09:58 +0000
+++ MANIFEST.in	2018-05-08 08:04:58 +0000
@@ -1,4 +1,5 @@
-include *.py *.rc
-global-include *.txt *.zcml
-exclude MANIFEST.in buildout.cfg bootstrap.py .bzrignore
-prune _bootstrap
+include COPYING.txt HACKING.rst *.rc
+recursive-include src *.txt *.rst
+include src/lazr/authentication/docs/Makefile
+prune src/lazr/authentication/docs/_build
+exclude MANIFEST.in .bzrignore

=== renamed file 'README.txt' => 'README.rst'
=== removed directory '_bootstrap'
=== removed file '_bootstrap/COPYRIGHT.txt'
--- _bootstrap/COPYRIGHT.txt	2009-03-23 19:12:50 +0000
+++ _bootstrap/COPYRIGHT.txt	1970-01-01 00:00:00 +0000
@@ -1,9 +0,0 @@
-Copyright (c) 2004-2009 Zope Corporation and Contributors.
-All Rights Reserved.
-
-This software is subject to the provisions of the Zope Public License,
-Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
-THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
-WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
-FOR A PARTICULAR PURPOSE.

=== removed file '_bootstrap/LICENSE.txt'
--- _bootstrap/LICENSE.txt	2009-03-23 19:12:50 +0000
+++ _bootstrap/LICENSE.txt	1970-01-01 00:00:00 +0000
@@ -1,54 +0,0 @@
-Zope Public License (ZPL) Version 2.1
--------------------------------------
-
-A copyright notice accompanies this license document that
-identifies the copyright holders.
-
-This license has been certified as open source. It has also
-been designated as GPL compatible by the Free Software
-Foundation (FSF).
-
-Redistribution and use in source and binary forms, with or
-without modification, are permitted provided that the
-following conditions are met:
-
-1. Redistributions in source code must retain the
-   accompanying copyright notice, this list of conditions,
-   and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the accompanying
-   copyright notice, this list of conditions, and the
-   following disclaimer in the documentation and/or other
-   materials provided with the distribution.
-
-3. Names of the copyright holders must not be used to
-   endorse or promote products derived from this software
-   without prior written permission from the copyright
-   holders.
-
-4. The right to distribute this software or to use it for
-   any purpose does not give you the right to use
-   Servicemarks (sm) or Trademarks (tm) of the copyright
-   holders. Use of them is covered by separate agreement
-   with the copyright holders.
-
-5. If any files are modified, you must cause the modified
-   files to carry prominent notices stating that you changed
-   the files and the date of any change.
-
-Disclaimer
-
-  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS''
-  AND ANY EXPRESSED 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 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.
\ No newline at end of file

=== removed file '_bootstrap/bootstrap.py'
--- _bootstrap/bootstrap.py	2009-03-23 19:12:50 +0000
+++ _bootstrap/bootstrap.py	1970-01-01 00:00:00 +0000
@@ -1,77 +0,0 @@
-##############################################################################
-#
-# Copyright (c) 2006 Zope Corporation and Contributors.
-# All Rights Reserved.
-#
-# This software is subject to the provisions of the Zope Public License,
-# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
-# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
-# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
-# FOR A PARTICULAR PURPOSE.
-#
-##############################################################################
-"""Bootstrap a buildout-based project
-
-Simply run this script in a directory containing a buildout.cfg.
-The script accepts buildout command-line options, so you can
-use the -c option to specify an alternate configuration file.
-
-$Id$
-"""
-
-import os, shutil, sys, tempfile, urllib2
-
-tmpeggs = tempfile.mkdtemp()
-
-is_jython = sys.platform.startswith('java')
-
-try:
-    import pkg_resources
-except ImportError:
-    ez = {}
-    exec urllib2.urlopen('http://peak.telecommunity.com/dist/ez_setup.py'
-                         ).read() in ez
-    ez['use_setuptools'](to_dir=tmpeggs, download_delay=0)
-
-    import pkg_resources
-
-if sys.platform == 'win32':
-    def quote(c):
-        if ' ' in c:
-            return '"%s"' % c # work around spawn lamosity on windows
-        else:
-            return c
-else:
-    def quote (c):
-        return c
-
-cmd = 'from setuptools.command.easy_install import main; main()'
-ws  = pkg_resources.working_set
-
-if is_jython:
-    import subprocess
-    
-    assert subprocess.Popen([sys.executable] + ['-c', quote(cmd), '-mqNxd', 
-           quote(tmpeggs), 'zc.buildout'], 
-           env=dict(os.environ,
-               PYTHONPATH=
-               ws.find(pkg_resources.Requirement.parse('setuptools')).location
-               ),
-           ).wait() == 0
-
-else:
-    assert os.spawnle(
-        os.P_WAIT, sys.executable, quote (sys.executable),
-        '-c', quote (cmd), '-mqNxd', quote (tmpeggs), 'zc.buildout',
-        dict(os.environ,
-            PYTHONPATH=
-            ws.find(pkg_resources.Requirement.parse('setuptools')).location
-            ),
-        ) == 0
-
-ws.add_entry(tmpeggs)
-ws.require('zc.buildout')
-import zc.buildout.buildout
-zc.buildout.buildout.main(sys.argv[1:] + ['bootstrap'])
-shutil.rmtree(tmpeggs)

=== removed symlink 'bootstrap.py'
=== target was u'_bootstrap/bootstrap.py'
=== removed file 'buildout.cfg'
--- buildout.cfg	2009-10-06 18:04:43 +0000
+++ buildout.cfg	1970-01-01 00:00:00 +0000
@@ -1,47 +0,0 @@
-[buildout]
-parts =
-    interpreter
-    test
-    docs
-    tags
-    filetemplates
-    pylint
-unzip = true
-
-develop = .
-
-[test]
-recipe = zc.recipe.testrunner
-eggs = lazr.authentication
-defaults = '--tests-pattern ^tests --exit-with-status --suite-name additional_tests'.split()
-
-[docs]
-recipe = z3c.recipe.sphinxdoc
-eggs = lazr.authentication [docs]
-index-doc = README
-default.css =
-layout.html =
-
-[interpreter]
-recipe = zc.recipe.egg
-interpreter = py
-eggs = lazr.authentication
-       docutils
-
-[tags]
-recipe = z3c.recipe.tag:tags
-eggs = lazr.authentication
-
-[filetemplates]
-recipe = z3c.recipe.filetemplate
-source-directory = buildout-templates
-package = lazr.authentication
-eggs = lazr.authentication
-
-[pylint]
-recipe = zc.recipe.egg
-eggs =
-    logilab.pylintinstaller
-    pylint==0.15.2
-entry-points = pylint=pylint.lint:Run
-arguments = sys.argv[1:]

=== modified file 'pylint.rc'
--- pylint.rc	2009-06-17 02:54:25 +0000
+++ pylint.rc	2018-05-08 08:04:58 +0000
@@ -20,7 +20,7 @@
 
 # Add <file or directory> to the black list. It should be a base name, not a
 # path. You may set this option multiple times.
-ignore=CVS
+ignore=CVS,conf.py
 
 # Pickle collected data for later comparisons.
 persistent=no

=== modified file 'setup.py'
--- setup.py	2014-08-01 11:38:52 +0000
+++ setup.py	2018-05-08 08:04:58 +0000
@@ -16,14 +16,13 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with lazr.authentication.  If not, see <http://www.gnu.org/licenses/>.
 
-import sys
 from setuptools import setup, find_packages
 
 # generic helpers primarily for the long_description
 def generate(*docname_or_string):
     res = []
     for value in docname_or_string:
-        if value.endswith('.txt'):
+        if value.endswith('.rst'):
             f = open(value)
             value = f.read()
             f.close()
@@ -36,6 +35,10 @@
 
 __version__ = open("src/lazr/authentication/version.txt").read().strip()
 
+tests_require = [
+    'zope.testrunner',
+    ]
+
 setup(
     name='lazr.authentication',
     version=__version__,
@@ -46,10 +49,10 @@
     zip_safe=False,
     maintainer='LAZR Developers',
     maintainer_email='[e-mail]',
-    description=open('README.txt').readline().strip(),
+    description=open('README.rst').readline().strip(),
     long_description=generate(
-        'src/lazr/authentication/README.txt',
-        'src/lazr/authentication/NEWS.txt'),
+        'src/lazr/authentication/docs/index.rst',
+        'src/lazr/authentication/docs/NEWS.rst'),
     license='LGPL v3',
     install_requires=[
         'httplib2',
@@ -66,9 +69,10 @@
         "License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)",
         "Operating System :: OS Independent",
         "Programming Language :: Python"],
+    tests_require=tests_require,
     extras_require=dict(
-        docs=['Sphinx',
-              'z3c.recipe.sphinxdoc']
+        docs=['Sphinx'],
+        test=tests_require,
     ),
     # This does not play nicely with buildout because it downloads but does
     # not cache the package.

=== added file 'src/lazr/authentication/docs/Makefile'
--- src/lazr/authentication/docs/Makefile	1970-01-01 00:00:00 +0000
+++ src/lazr/authentication/docs/Makefile	2018-05-08 08:04:58 +0000
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = lazrauthentication
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
\ No newline at end of file

=== renamed file 'src/lazr/authentication/NEWS.txt' => 'src/lazr/authentication/docs/NEWS.rst'
--- src/lazr/authentication/NEWS.txt	2014-11-08 12:52:40 +0000
+++ src/lazr/authentication/docs/NEWS.rst	2018-05-08 08:04:58 +0000
@@ -2,6 +2,11 @@
 NEWS for lazr.authentication
 ============================
 
+0.1.4
+=====
+
+- Switch from buildout to tox.
+
 0.1.3 (2014-11-08)
 ==================
 

=== added file 'src/lazr/authentication/docs/conf.py'
--- src/lazr/authentication/docs/conf.py	1970-01-01 00:00:00 +0000
+++ src/lazr/authentication/docs/conf.py	2018-05-08 08:04:58 +0000
@@ -0,0 +1,170 @@
+# -*- coding: utf-8 -*-
+#
+# lazr.authentication documentation build configuration file, created by
+# sphinx-quickstart on Sat Apr 28 19:41:59 2018.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+with open('../version.txt') as version_file:
+    _version = version_file.read().strip()
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'lazr.authentication'
+copyright = u'2009-2018, Canonical Ltd.'
+author = u'LAZR Developers <[e-mail]>'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = _version
+# The full version, including alpha/beta/rc tags.
+release = _version
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+#html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+    '**': [
+        'relations.html',  # needs 'show_related': True theme option to display
+        'searchbox.html',
+    ]
+}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'lazrauthenticationdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'lazrauthentication.tex', u'lazr.authentication Documentation',
+     u'LAZR Developers \\textless{}[e-mail]\\textgreater{}', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'lazrauthentication', u'lazr.authentication Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'lazrauthentication', u'lazr.authentication Documentation',
+     author, 'lazrauthentication', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

=== renamed file 'src/lazr/authentication/README.txt' => 'src/lazr/authentication/docs/index.rst'
--- src/lazr/authentication/README.txt	2018-04-28 19:08:51 +0000
+++ src/lazr/authentication/docs/index.rst	2018-05-08 08:04:58 +0000
@@ -303,3 +303,8 @@
 Teardown.
 
     >>> _ = wsgi_intercept.remove_wsgi_intercept('oauthtest', 80)
+
+.. toctree::
+   :glob:
+
+   NEWS

=== modified file 'src/lazr/authentication/tests/test_docs.py'
--- src/lazr/authentication/tests/test_docs.py	2018-04-28 19:10:38 +0000
+++ src/lazr/authentication/tests/test_docs.py	2018-05-08 08:04:58 +0000
@@ -15,20 +15,20 @@
 # along with lazr.authentication.  If not, see <http://www.gnu.org/licenses/>.
 "Test harness for doctests."
 
-# pylint: disable-msg=E0611,W0142
+# pylint: disable=E0611
 
 __metaclass__ = type
 __all__ = [
-    'additional_tests',
+    'load_tests',
     ]
 
 import atexit
 import doctest
 import os
-# pylint: disable-msg=F0401
+
+# pylint: disable=F0401
 from pkg_resources import (
     resource_filename, resource_exists, resource_listdir, cleanup_resources)
-import unittest
 
 DOCTEST_FLAGS = (
     doctest.ELLIPSIS |
@@ -36,17 +36,17 @@
     doctest.REPORT_NDIFF)
 
 
-def additional_tests():
-    "Run the doc tests (README.txt and docs/*, if any exist)"
-    doctest_files = [
-        os.path.abspath(resource_filename('lazr.authentication', 'README.txt'))]
+# pylint: disable=W0613
+def load_tests(loader, tests, pattern):
+    """Load all the doctests."""
+    doctest_files = []
     if resource_exists('lazr.authentication', 'docs'):
         for name in resource_listdir('lazr.authentication', 'docs'):
-            if name.endswith('.txt'):
+            if name.endswith('.rst'):
                 doctest_files.append(
-                    os.path.abspath(
-                        resource_filename('lazr.authentication', 'docs/%s' % name)))
-    kwargs = dict(module_relative=False, optionflags=DOCTEST_FLAGS)
+                    os.path.abspath(resource_filename(
+                        'lazr.authentication', 'docs/%s' % name)))
     atexit.register(cleanup_resources)
-    return unittest.TestSuite((
-        doctest.DocFileSuite(*doctest_files, **kwargs)))
+    tests.addTest(doctest.DocFileSuite(
+        *doctest_files, module_relative=False, optionflags=DOCTEST_FLAGS))
+    return tests

=== added file 'tox.ini'
--- tox.ini	1970-01-01 00:00:00 +0000
+++ tox.ini	2018-05-08 08:04:58 +0000
@@ -0,0 +1,35 @@
+[tox]
+envlist =
+    py27,docs
+
+[testenv]
+deps =
+    .[test]
+commands =
+    zope-testrunner --test-path src --tests-pattern ^tests {posargs}
+
+# This is needed until we port to oauthlib.  It means that this environment
+# will only work on Debian or derivatives with python3-oauth (which has had
+# 2to3 run over it) installed, so it isn't yet in envlist.
+[testenv:py36]
+sitepackages = True
+
+[lint]
+deps =
+    pylint
+commands =
+    pylint --rcfile=pylint.rc src/lazr/authentication/
+
+# This has too many failures to be enabled by default as yet.
+[testenv:lint-py27]
+basepython = python2.7
+skip_install = true
+deps = {[lint]deps}
+commands = {[lint]commands}
+
+[testenv:docs]
+basepython = python2.7
+deps =
+    .[docs]
+commands =
+    sphinx-build -b html -d src/lazr/authentication/docs/_build/doctrees src/lazr/authentication/docs src/lazr/authentication/docs/_build/html