Merge pull request #4 from HDE/docs

Initial documentation

.circleci/config.yml

@@ -8,4 +8,4 @@ jobs:
       - setup_remote_docker
       - checkout
       - run: docker-compose build
-      - run: docker-compose run -e WEB_APP_BASE_URL=http://webapp:5000 -e REMOTE_WEBDRIVERS=http://firefox:4444/wd/hub?browser=firefox --rm test
+      - run: docker-compose run -e WEB_APP_BASE_URL=http://webapp:5000 -e REMOTE_WEBDRIVERS=http://firefox:4444/wd/hub?browser=firefox -e DOCS_DIR=/code/docs/ -e SPHINXBUILD=/code/test-env/bin/sphinx-build --rm test

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = arsenic
+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)

docs/conf.py

@@ -0,0 +1,157 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# arsenic documentation build configuration file, created by
+# sphinx-quickstart on Tue May 23 17:11:19 2017.
+#
+# 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.
+
+# 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 = 'arsenic'
+copyright = '2017, HDE Inc'
+author = 'HDE Inc'
+
+# 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 = '0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1'
+
+# 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']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'arsenicdoc'
+
+
+# -- 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, 'arsenic.tex', 'arsenic Documentation',
+     'HDE Inc', '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, 'arsenic', 'arsenic 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, 'arsenic', 'arsenic Documentation',
+     author, 'arsenic', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

docs/contrib/extend.rst

@@ -0,0 +1,108 @@
+Extending
+#########
+
+
+Engine
+******
+
+An :ref:`Engine` must be an instance of :py:class:`arsenic.engines.Engine`. That class
+requires three parameters: A coroutine which starts a new HTTP session, a
+coroutine which starts a new subprocess and a coroutine which sleeps.
+
+The coroutine to start a new HTTP session takes a single argument which is
+either an instance of :py:class:`arsenic.engines.Auth` or :py:obj:`None`. It
+must return an instance of :py:class:`arsenic.engines.HTTPSession` which must
+implement two coroutine methods: :py:meth:`arsenic.engines.HTTPSession.request`
+and :py:meth:`arsenic.engines.HTTPSession.close`
+
+:py:meth:`arsenic.engines.HTTPSession.request` takes a single argument which is
+an instance of :py:class:`arsenic.engines.Request` and must return a single
+argument :py:class:`arsenic.engines.Response`.
+
+:py:meth:`arsenic.engines.HTTPSession.close` takes no arguments and has no
+return value and should close the session.
+
+The coroutine to start the subprocess takes three arguments, a list of strings
+which are the command to run, a dictionary where both the keys and values are
+strings which are the environment variables to use for the subprocess and a
+file object opened in text mode for writing to use for logging. It must return
+an object which has a coroutine method named ``close`` which takes no arguments
+and has no return value which stops the subprocess.
+
+The sleep coroutine takes an integer or float as argument which is the number of
+seconds the coroutine should sleep. It has no return value.
+
+Dummy example
+=============
+
+.. code-block:: python3
+
+    from typing import Optional, List, Dict, TextIO
+
+    from arsenic.engines import Auth, HTTPSession, Request, Response, Headers, Engine
+
+    from dummy import do_http_request, do_start_subprocess, do_sleep
+
+    class DummyHTTPSession(HTTPSession):
+        def __init__(self, auth):
+            self.auth = auth
+
+        async def request(self, request: Request) -> Response:
+            headers = {
+                **request.headers
+            }
+            if self.auth is not None:
+                headers.update(self.auth.get_headers())
+
+            status: int, body: bytes, headers: Headers = await do_http_request(
+                method=request.method,
+                url=request.url,
+                data=request.body,
+                headers=headers
+            )
+
+            return Response(
+                status=status,
+                body=body,
+                headers=headers,
+            )
+
+
+    async def start_http_session(auth: Optional[Auth]=None):
+        return DummyHTTPSession(auth)
+
+    class SubprocessContext:
+        def __init__(self, process):
+            self.process = process
+
+        async def close(self):
+            await self.process.stop()
+
+    async def start_subprocess(cmd: List[str], env: Dict[str, str], log: TextIO):
+        return SubprocessContext(do_start_subprocess(cmd, env, log))
+
+    DummyEngine = Engine(
+        http_sesion=start_http_session,
+        start_process=start_subprocess,
+        sleep=do_sleep
+    )
+
+
+Service
+*******
+
+A :ref:`Service` must be a subclass of :py:class:`arsenic.service.Service` and implement
+the :py:meth:`arsenic.service.Service.start` coroutine method. This method
+takes an instance of an :py:class:`arsenic.engines.Engine` as argument and must
+return an instance of :py:class:`arsenic.webdriver.WebDriver`.
+
+Browser
+*******
+
+A :ref:`Browser` is an object with an attribute ``capabilities`` which is a JSON
+serializable object that gets passed to the webdriver as the desired capabilities.
+
+For convenience there is a :py:class:`arsenic.browsers.Browser` class you can
+subclass and set the :py:attr:`arsenic.browsers.Browser.defaults` to a JSON
+serializable dictionary of default values. The class can be passed a dictionary
+of values to override when instantiated.

docs/contrib/testing.rst

@@ -0,0 +1,20 @@
+Testing
+#######
+
+Using circleci-local
+********************
+
+The easiest way to run the tests is using `circleci local`_. If you have it
+installed, simply run ``circleci build`` in the root directory.
+
+Manual
+******
+
+1. Install the test dependencies in ``tests/requirements.txt`` and ``tests/app/requirements.txt``.
+2. Run the app in ``tests/app/app.py``.
+3. Run ``WEB_APP_BASE_URL=http://localhost:5000 pytest`` in the root directory.
+
+
+
+
+.. _circleci local: https://circleci.com/docs/2.0/local-jobs/

docs/examples/aiohttp/app.py

@@ -0,0 +1,23 @@
+from aiohttp import web
+
+
+async def handle(request):
+    name = request.match_info.get('name', 'Anonymous')
+    text = f'<html><body><h1>Hello {name}</h1></body>'
+    return web.Response(text=text, content_type='text/html')
+
+
+def build_app():
+    app = web.Application()
+    app.router.add_get('/', handle)
+    app.router.add_get('/{name}', handle)
+    return app
+
+
+def main():
+    app = build_app()
+    web.run_app(app)
+
+
+if __name__ == '__main__':
+    main()