[Python-modules-commits] [txfixtures] 01/01: New upstream version 0.2.0
Free Ekanayaka
freee at moszumanska.debian.org
Tue Dec 20 14:16:56 UTC 2016
This is an automated email from the git hooks/post-receive script.
freee pushed a commit to annotated tag upstream/0.2.0
in repository txfixtures.
commit 3c7ffd74944ca9c3f5d482f570b29d261622141d
Author: Free Ekanayaka <freee at debian.org>
Date: Tue Dec 20 14:14:32 2016 +0000
New upstream version 0.2.0
---
.mailmap | 1 +
.travis.yml | 16 +
AUTHORS | 4 +
ChangeLog | 46 +++
Makefile | 18 +
PKG-INFO | 30 +-
README | 14 -
README.rst | 12 +
doc/Makefile | 216 +++++++++++
doc/api.rst | 26 ++
doc/conf.py | 302 +++++++++++++++
doc/index.rst | 35 ++
doc/phantomjs.rst | 40 ++
doc/reactor.rst | 48 +++
doc/service.rst | 96 +++++
requirements.txt | 5 +
setup.cfg | 38 ++
setup.py | 38 +-
tests/__init__.py | 0
tests/cannotlisten.tac | 27 ++
tests/okay.tac | 23 ++
tests/test_mongodb.py | 24 ++
tests/test_phantomjs.py | 29 ++
tests/test_reactor.py | 326 +++++++++++++++++
tests/test_service.py | 239 ++++++++++++
tests/test_tachandler.py | 159 ++++++++
tox.ini | 26 ++
txfixtures.egg-info/PKG-INFO | 30 ++
txfixtures.egg-info/SOURCES.txt | 49 +++
txfixtures.egg-info/dependency_links.txt | 1 +
txfixtures.egg-info/not-zip-safe | 1 +
txfixtures.egg-info/pbr.json | 1 +
txfixtures.egg-info/requires.txt | 19 +
txfixtures.egg-info/top_level.txt | 1 +
txfixtures/__init__.py | 23 +-
txfixtures/_twisted/__init__.py | 0
txfixtures/_twisted/testing.py | 90 +++++
txfixtures/_twisted/tests/__init__.py | 0
txfixtures/_twisted/tests/test_threading.py | 50 +++
txfixtures/_twisted/threading.py | 35 ++
txfixtures/mongodb.py | 47 +++
txfixtures/osutils.py | 17 +-
txfixtures/phantomjs.py | 43 +++
txfixtures/reactor.py | 205 +++++++++++
txfixtures/service.py | 549 ++++++++++++++++++++++++++++
txfixtures/tachandler.py | 46 +--
txfixtures/tests/__init__.py | 0
txfixtures/tests/test_mongodb.py | 61 ++++
txfixtures/tests/test_phantomjs.py | 53 +++
txfixtures/tests/test_reactor.py | 129 +++++++
txfixtures/tests/test_service.py | 435 ++++++++++++++++++++++
51 files changed, 3622 insertions(+), 101 deletions(-)
diff --git a/.mailmap b/.mailmap
new file mode 100644
index 0000000..cd68523
--- /dev/null
+++ b/.mailmap
@@ -0,0 +1 @@
+Gavin Panella <gavin at gromper.net> Gavin Panella <gavin.panella at canonical.com>
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..c009465
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,16 @@
+sudo: false
+language: python
+
+python:
+ - "2.7"
+ - "3.5"
+
+install:
+ - pip install tox-travis
+ - pip install python-coveralls
+
+script:
+ - tox
+
+after_success:
+ - coveralls
diff --git a/AUTHORS b/AUTHORS
new file mode 100644
index 0000000..15278fd
--- /dev/null
+++ b/AUTHORS
@@ -0,0 +1,4 @@
+Free Ekanayaka <free.ekanayaka at gmail.com>
+Free Ekanayaka <free at ekanayaka.io>
+Gavin Panella <gavin at gromper.net>
+Martin Pool <mbp at canonical.com>
diff --git a/ChangeLog b/ChangeLog
new file mode 100644
index 0000000..9e5d1ed
--- /dev/null
+++ b/ChangeLog
@@ -0,0 +1,46 @@
+CHANGES
+=======
+
+0.2.0
+-----
+
+* Add MongoDB fixture
+* Add Phantomjs fixture
+* Add Service fixture (#3)
+
+0.1.5
+-----
+
+* Add travis and tox configuration
+* Switch to PBR
+* [r=cjwatson] Add basic sphinx documentation
+* [r=allenap] Attach the log using addDetail() instead of as an exception message
+* [r=bigjools] Remove spurious copy of get_pid_from_file() from txfixtures.tachandler
+* Use super() to call up
+* Attach the log using addDetail() instead of as an exception message
+* Update ignores
+* Fix lint
+* Remove get_pid_from_file() from tachandler.py
+
+0.1.4
+-----
+
+* Release 0.1.4
+* twistd can't be invoked as a module; explain some more failure cases
+
+0.1.3
+-----
+
+* Add more pypi metadata
+* Don't use PYTHONWARNINGS which only exists in python>=2.7
+* rm dead code
+* Don't use relative imports, so we can cope with Python2.4
+* Rename TacTestSetup to TacTestFixture
+
+0.1.1
+-----
+
+* Declare Python dependencies
+* Fix Trove licence classification
+* Add distutils setup.py
+* txfixtures split out from lp and all tests are passing
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..95f965c
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,18 @@
+PYTHON ?= python
+COVERAGE ?= $(PYTHON)-coverage
+
+SOURCE = txfixtures
+OMIT = $(SOURCE)/osutils.py,$(SOURCE)/tachandler.py
+
+check:
+ rm -f .coverage
+ $(COVERAGE) run --omit=$(OMIT) --source=$(SOURCE) -m testtools.run discover
+ $(COVERAGE) report -m --fail-under=100
+
+check-doc:
+ $(MAKE) -C doc doctest
+
+html:
+ $(MAKE) -C doc html
+
+.PHONY: check check-doc html
diff --git a/PKG-INFO b/PKG-INFO
index c8100f1..d10fbcf 100644
--- a/PKG-INFO
+++ b/PKG-INFO
@@ -1,28 +1,30 @@
Metadata-Version: 1.1
Name: txfixtures
-Version: 0.1.4
+Version: 0.2.0
Summary: Treat Twisted applications as Python test fixtures
Home-page: https://launchpad.net/txfixtures
Author: Martin Pool
Author-email: mbp at canonical.com
-License: UNKNOWN
-Description: ********************************************
- Twisted integration with Python Testfixtures
- ********************************************
+License: GPLv3
+Description: Twisted integration with Python Testfixtures
+ ============================================
txfixtures hooks into the testtools 'test fixture' interface, so that you can
- write tests that rely on having an external Twisted daemon. ::
+ write tests that rely on having an external Twisted daemon.
- self.useFixture(LibrarianServerFixture)
+ See:
- See
- https://launchpad.net/txfixtures
- httsp://launchpad.net/testtools
+ - https://launchpad.net/txfixtures
+ - https://launchpad.net/testtools
Licence: GPLv3
-Platform: UNKNOWN
+
+Platform: POSIX
+Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
-Requires: fixtures
-Requires: testtools
-Requires: twisted
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
diff --git a/README b/README
deleted file mode 100644
index 4d4199d..0000000
--- a/README
+++ /dev/null
@@ -1,14 +0,0 @@
-********************************************
-Twisted integration with Python Testfixtures
-********************************************
-
-txfixtures hooks into the testtools 'test fixture' interface, so that you can
-write tests that rely on having an external Twisted daemon. ::
-
- self.useFixture(LibrarianServerFixture)
-
-See
- https://launchpad.net/txfixtures
- httsp://launchpad.net/testtools
-
-Licence: GPLv3
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..39212f4
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,12 @@
+Twisted integration with Python Testfixtures
+============================================
+
+txfixtures hooks into the testtools 'test fixture' interface, so that you can
+write tests that rely on having an external Twisted daemon.
+
+See:
+
+- https://launchpad.net/txfixtures
+- https://launchpad.net/testtools
+
+Licence: GPLv3
diff --git a/doc/Makefile b/doc/Makefile
new file mode 100644
index 0000000..2bb749c
--- /dev/null
+++ b/doc/Makefile
@@ -0,0 +1,216 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " applehelp to make an Apple Help Book"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " xml to make Docutils-native XML files"
+ @echo " pseudoxml to make pseudoxml-XML files for display purposes"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+ @echo " coverage to run coverage check of the documentation (if enabled)"
+
+.PHONY: clean
+clean:
+ rm -rf $(BUILDDIR)/*
+
+.PHONY: html
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+.PHONY: dirhtml
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+.PHONY: singlehtml
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+.PHONY: pickle
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+.PHONY: json
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+.PHONY: htmlhelp
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+.PHONY: qthelp
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/txreactorfixture.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/txreactorfixture.qhc"
+
+.PHONY: applehelp
+applehelp:
+ $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+ @echo
+ @echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+ @echo "N.B. You won't be able to view it unless you put it in" \
+ "~/Library/Documentation/Help or install it in your application" \
+ "bundle."
+
+.PHONY: devhelp
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/txreactorfixture"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/txreactorfixture"
+ @echo "# devhelp"
+
+.PHONY: epub
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+.PHONY: latex
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+.PHONY: latexpdf
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+.PHONY: latexpdfja
+latexpdfja:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through platex and dvipdfmx..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+.PHONY: text
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+.PHONY: man
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+.PHONY: texinfo
+texinfo:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+.PHONY: info
+info:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C $(BUILDDIR)/texinfo info
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+.PHONY: gettext
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+.PHONY: changes
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+.PHONY: linkcheck
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+.PHONY: doctest
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
+
+.PHONY: coverage
+coverage:
+ $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+ @echo "Testing of coverage in the sources finished, look at the " \
+ "results in $(BUILDDIR)/coverage/python.txt."
+
+.PHONY: xml
+xml:
+ $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+ @echo
+ @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+.PHONY: pseudoxml
+pseudoxml:
+ $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+ @echo
+ @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
diff --git a/doc/api.rst b/doc/api.rst
new file mode 100644
index 0000000..d641aa5
--- /dev/null
+++ b/doc/api.rst
@@ -0,0 +1,26 @@
+API documentation
+=================
+
+Generated reference documentation for all the public functionality of
+txfixtures.
+
+.. toctree::
+ :maxdepth: 2
+
+txfixtures.reactor
+------------------
+
+.. automodule:: txfixtures.reactor
+ :members:
+
+txfixtures.service
+------------------
+
+.. automodule:: txfixtures.service
+ :members:
+
+txfixtures.phantomjs
+--------------------
+
+.. automodule:: txfixtures.phantomjs
+ :members:
diff --git a/doc/conf.py b/doc/conf.py
new file mode 100644
index 0000000..d4e32fe
--- /dev/null
+++ b/doc/conf.py
@@ -0,0 +1,302 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# txfixtures documentation build configuration file, created by
+# sphinx-quickstart on Wed Nov 9 19:33:32 2016.
+#
+# 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.
+
+import sys
+import os
+
+# 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.
+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 = [
+ 'sphinx.ext.autodoc',
+ 'sphinx.ext.doctest',
+ 'sphinx.ext.todo',
+ 'sphinx.ext.coverage',
+ 'sphinx.ext.viewcode',
+ 'sphinx.ext.intersphinx',
+]
+
+# 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 encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'txfixtures'
+copyright = '2016, Free Ekanayaka'
+author = 'Free Ekanayaka'
+
+# 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.
+from txfixtures import __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
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+default_role = 'obj'
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+# -- 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 = 'sphinx_rtd_theme'
+
+# 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 themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (relative to this directory) to use as a favicon of
+# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# 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']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
+# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
+#html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# Now only 'ja' uses this config value
+#html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+#html_search_scorer = 'scorer.js'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'txfixturesdoc'
+
+# -- 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, 'txfixtures.tex', 'txfixtures Documentation',
+ 'Free Ekanayaka', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- 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, 'txfixtures', 'txfixtures Documentation',
+ [author], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- 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, 'txfixtures', 'txfixtures Documentation',
+ author, 'txfixtures', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False
+
+intersphinx_mapping = {
+ 'python': ('https://docs.python.org/3.5', None),
+ 'twisted': ('http://twistedmatrix.com/documents/current/api', None),
+ 'testtools': ('https://testtools.readthedocs.io/en/latest/', None),
+}
+
+autoclass_content = 'both'
diff --git a/doc/index.rst b/doc/index.rst
new file mode 100644
index 0000000..0a4f515
--- /dev/null
+++ b/doc/index.rst
@@ -0,0 +1,35 @@
+.. txreactorfixture documentation master file, created by
+ sphinx-quickstart on Wed Nov 9 19:33:32 2016.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Twisted integration with Python Testfixtures
+============================================
+
+txfixtures hooks into the testtools `test fixture`_ interface, so that you can
+write tests that rely on having an external Twisted daemon.
+
+See:
+
+* https://launchpad.net/txfixtures
+* https://launchpad.net/testtools
+
+Contents:
+
+.. toctree::
+ :maxdepth: 1
+
+ reactor
+ service
+ phantomjs
+ api
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+.. _`test fixture`: http://testtools.readthedocs.io/en/latest/for-test-authors.html#fixtures
+
diff --git a/doc/phantomjs.rst b/doc/phantomjs.rst
new file mode 100644
index 0000000..f02443d
--- /dev/null
+++ b/doc/phantomjs.rst
@@ -0,0 +1,40 @@
+Setup a phantomjs Selenium driver
+=================================
+
+The :class:`~txfixtures.phantomjs.PhantomJS` fixture starts a
+phantomjs_ service in the background and exposes it via its
+`webdriver` attribute, which can then be used by test cases for
+Selenium_-based assertions:
+
+.. doctest::
+
+ >>> from fixtures import FakeLogger
+ >>> from testtools import TestCase
+ >>> from txfixtures import Reactor, Service, PhantomJS
+
+ >>> TWIST_COMMAND = "twistd -n web".split(" ")
+
+ >>> class HTTPServerTest(TestCase):
+ ...
+ ... def setUp(self):
+ ... super().setUp()
+ ... self.logger = self.useFixture(FakeLogger())
+ ... self.useFixture(Reactor())
+ ...
+ ... # Create a sample web server
+ ... self.service = Service(TWIST_COMMAND)
+ ... self.service.expectPort(8080)
+ ... self.useFixture(self.service)
+ ...
+ ... self.phantomjs = self.useFixture(PhantomJS())
+ ...
+ ... def test_home_page(self):
+ ... self.phantomjs.webdriver.get("http://localhost:8080")
+ ... self.assertEqual("Twisted Web Demo", self.phantomjs.webdriver.title)
+
+ >>> test = HTTPServerTest(methodName="test_home_page")
+ >>> test.run().wasSuccessful()
+ True
+
+.. _phantomjs: http://phantomjs.org
+.. _Selenium: http://selenium-python.readthedocs.io/
diff --git a/doc/reactor.rst b/doc/reactor.rst
new file mode 100644
index 0000000..5f24f1d
--- /dev/null
+++ b/doc/reactor.rst
@@ -0,0 +1,48 @@
+Run asynchronous code from test cases
+=====================================
+
+The :class:`~txfixtures.reactor.Reactor` fixture can be used to drive
+asynchronous Twisted code from a regular synchronous Python
+:class:`~testtools.TestCase`.
+
+The approach differs from trial_ or `testtools twisted support`_:
+instead of starting the reactor in the main thread and letting it spin
+for a while waiting for the :class:`~twisted.internet.defer.Deferred`
+returned by the test to fire, this fixture will keep the reactor
+running in a background thread until cleanup.
+
+When used with testresources_'s :class:`FixtureResource` and
+:class:`OptimisingTestSuite`, this fixture makes it possible to have
+full control and monitoring over long-running processes that should be
+up for the whole test suite run, and maybe produce output useful for
+the test itself.
+
+The typical use case is integration testing.
+
+.. doctest::
+
+ >>> from testtools import TestCase
+
+ >>> from twisted.internet import reactor
+ >>> from twisted.internet.threads import blockingCallFromThread
+ >>> from twisted.internet.utils import getProcessOutput
+
+ >>> from txfixtures import Reactor
+
+ >>> class TestUsingAsyncAPIs(TestCase):
+ ...
+ ... def setUp(self):
+ ... super().setUp()
+ ... self.useFixture(Reactor())
+ ...
+ ... def test_uptime(self):
+ ... out = blockingCallFromThread(reactor, getProcessOutput, b"uptime")
+ ... self.assertIn("load average", out.decode("utf-8"))
+ ...
+ >>> test = TestUsingAsyncAPIs(methodName="test_uptime")
+ >>> test.run().wasSuccessful()
+ True
+
+.. _testresources: https://pypi.python.org/pypi/testresources
+.. _`testtools twisted support`: https://testtools.readthedocs.io/en/latest/twisted-support.html
+.. _trial: http://twistedmatrix.com/trac/wiki/TwistedTrial
diff --git a/doc/service.rst b/doc/service.rst
new file mode 100644
index 0000000..27310c9
--- /dev/null
+++ b/doc/service.rst
@@ -0,0 +1,96 @@
+Spawn, control and monitor test services
+========================================
+
+The :class:`~txfixtures.service.Service` fixture can be used to spawn
+a background service process (for instance a web application), and
+leave it running for the duration of the test suite (see
+:ref:`testresources-integration`).
+
+It supports real-time streaming of the service standard output to Python's
+:py:mod:`logging` system.
+
+Spawn a simple service fixture listening to a port
+--------------------------------------------------
+
+Let's create a test that spawns a dummy HTTP server that listens to
+port 8080:
+
+.. doctest::
+
+ >>> import socket
+
+ >>> from testtools import TestCase
+ >>> from txfixtures import Reactor, Service
+
+ >>> HTTP_SERVER = "python3 -m http.server 8080".split(" ")
+
+ >>> class HTTPServerTest(TestCase):
+ ...
+ ... def setUp(self):
+ ... super().setUp()
... 3217 lines suppressed ...
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/txfixtures.git
More information about the Python-modules-commits
mailing list