Synnefo

# Makefile for Sphinx documentation

#

# You can set these variables from the command line.

SPHINXOPTS    =

SPHINXBUILD   = sphinx-build

PAPER         =

BUILDDIR      = _build

# 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 clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext

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 "  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 "  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 "  linkcheck  to check all external links for integrity"

	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"

clean:

	-rm -rf $(BUILDDIR)/*

html:

	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

	@echo

	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

dirhtml:

	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml

	@echo

	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."

singlehtml:

	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml

	@echo

	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."

pickle:

	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle

	@echo

	@echo "Build finished; now you can process the pickle files."

json:

	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json

	@echo

	@echo "Build finished; now you can process the JSON files."

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."

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/snf-occi.qhcp"

	@echo "To view the help file:"

	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/snf-occi.qhc"

devhelp:

	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp

	@echo

	@echo "Build finished."

	@echo "To view the help file:"

	@echo "# mkdir -p $$HOME/.local/share/devhelp/snf-occi"

	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/snf-occi"

	@echo "# devhelp"

epub:

	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub

	@echo

	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."

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)."

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."

text:

	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text

	@echo

	@echo "Build finished. The text files are in $(BUILDDIR)/text."

man:

	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man

	@echo

	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."

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)."

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."

gettext:

	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale

	@echo

	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."

changes:

	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes

	@echo

	@echo "The overview file is in $(BUILDDIR)/changes."

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."

doctest:

	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest

	@echo "Testing of doctests in the sources finished, look at the " \

	      "results in $(BUILDDIR)/doctest/output.txt."

import sys, os

sys.path.insert(0, os.path.abspath('../'))

from synnefo_tools.version import __version__

extensions = []

# Add any paths that contain templates here, relative to this directory.

templates_path = ['_templates']

# The suffix of source filenames.

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 = u'snf-occi'

copyright = u'2012-2013, GRNET'

# 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.

#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

# 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 = []

# -- 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 = 'default'

html_theme_options = {

        'collapsiblesidebar': 'true',

        'footerbgcolor':    '#55b577',

        'footertextcolor':  '#000000',

        'sidebarbgcolor':   '#ffffff',

        'sidebarbtncolor':  '#f2f2f2',

        'sidebartextcolor': '#000000',

        'sidebarlinkcolor': '#328e4a',

        'relbarbgcolor':    '#55b577',

        'relbartextcolor':  '#ffffff',

        'relbarlinkcolor':  '#ffffff',

        'bgcolor':          '#ffffff',

        'textcolor':        '#000000',

        'headbgcolor':      '#ffffff',

        'headtextcolor':    '#000000',

        'headlinkcolor':    '#c60f0f',

        'linkcolor':        '#328e4a',

        'visitedlinkcolor': '#63409b',

        'codebgcolor':      '#eeffcc',

        'codetextcolor':    '#333333'

}

# 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 (within the static path) to use as 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']

# 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

# Output file base name for HTML help builder.

htmlhelp_basename = 'snf-occidoc'

# -- 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': '',

}

# Grouping the document tree into LaTeX files. List of tuples

# (source start file, target name, title, author, documentclass [howto/manual]).

latex_documents = [

  ('index', 'snf-occi.tex', u'snf-occi Documentation',

   u'John Giannelos', '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 = [

    ('index', 'snf-occi', u'snf-occi Documentation',

     [u'John Giannelos'], 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 = [

  ('index', 'snf-occi', u'snf-occi Documentation',

   u'John Giannelos', 'snf-occi', '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'

intersphinx_mapping = {

    'python': ('http://docs.python.org/', None),

    'django': ('https://docs.djangoproject.com/en/dev/',

               'https://docs.djangoproject.com/en/dev/_objects/')

}

snf-burnin documentation

=========================

**snf-burnin** is an integration testing tool for a running Synnefo deployment. It runs test scenarios from the following categories:

* Authentication 

* Images

* Flavors

* Servers

* Networking

.. toctree::

   :maxdepth: 2

Usage

=====

**Example:**

::

   snf-burnin --api=API_URL --token=TOKEN --image-id=IMAGE-ID --log-folder=LOG_FOLDER --plankton=PLANKTON_API --plankton-user=PLANKTON_SYSTEM_USER

For more info 

::

   snf-burnin --help

::

  Options:

  -h, --help                        show this help message and exit

  --api=API             	    The API URI to use to reach the Synnefo API

  --plankton=PLANKTON   	    The API URI to use to reach the Plankton API

  --plankton-user=PLANKTON_USER	    Owner of system images

  --token=TOKEN                     The token to use for authentication to the API

  --nofailfast          	    Do not fail immediately if one of the tests fails (EXPERIMENTAL)

  --no-ipv6             	    Disables ipv6 related tests

  --action-timeout=TIMEOUT	    Wait SECONDS seconds for a server action to complete, then the test is considered failed

  --build-warning=TIMEOUT           Warn if TIMEOUT seconds have passed and a build operation is still pending

  --build-fail=BUILD_TIMEOUT  	    Fail the test if TIMEOUT seconds have passed and a build operation is still incomplete

  --query-interval=INTERVAL 	    Query server status when requests are pending every INTERVAL seconds

  --fanout=COUNT             	    Spawn up to COUNT child processes to execute in parallel, essentially have up to COUNT server build requests outstanding (EXPERIMENTAL)

  --force-flavor=FLAVOR ID	    Force all server creations to use the specified FLAVOR ID instead of a randomly chosen one, useful if disk space is scarce 

  --image-id=IMAGE ID               Test the specified image id, use 'all' to test all available images (mandatory argument)

  --show-stale          	    Show stale servers from previous runs, whose name starts with `snf-test-'

  --delete-stale        	    Delete stale servers from previous runs, whose name starts with `snf-test-'

  --force-personality=PERSONALITY_PATH

                                    Force a personality file injection. File path required.

  --log-folder=LOG_FOLDER           Define the absolute path where the output log is stored.

Detailed description of testcases

=================================

ImagesTestCase

---------------

* Test image list actually returns images

* Test detailed image list actually returns images

* Test simple and detailed image lists have the same length

* Test simple and detailed images have the same names

* Test system images have the same name

* Test system images have unique names

* Test every image has specific metadata

FlavorsTestCase

----------------

* Test flavor list actually returns flavors

* Test simple and detailed flavor lists have the same length

* Test simple and detailed flavors have the same names

* Test flavors have unique names

* Test flavor names have correct format 

ServersTestCase

----------------

* Test simple and detailed server list have the same length

* Test simple and detailed servers have the same names

SpawnServerTestcase

--------------------

* Submit create server

* Test server is in BUILD state in server list

* Test server is in BUILD state in details

* Change server metadata

* Verify the changed metadata are correct

* Verify server metadata are set based on image metadata

* Wait until server change state to ACTIVE, and verify state

* Test if OOB server console works

* Test server has IPv4

* Test server has IPv6

* Test server responds to ping on IPv4 address

* Test server responds to ping on IPv6 address

* Submit shutdown request

* Verify server status is STOPPED

* Submit start request 

* Test server status is ACTIVE

* Test server responds to ping on IPv4 address (verify if is actually up and running)

* Test server responds to ping on IPv6 address (verify if is actually up and running)

* Test SSH to server and verify hostname (IPv4)

* Test SSH to server and verify hostname (IPv6)

* Test RDP connection to server (only available to Windows Images) (IPv4)

* Test RDP connection to server (only available to Windows Images) (IPv6)

* Test file injection for personality enforcement

* Submit server delete request

* Test server becomes DELETED

* Test server is no longer in server list

NetworkTestCase

===============

* Submit create server A request

* Test server A becomes ACTIVE

* Submit create server B request

* Test server B becomes ACTIVE

* Submit create private network request

* Connect VMs to private network

* Test if VMs are connected to network

* Submit reboot request to server A

* Test server A responds to ping on IPv4 address (verify if is actually up and running)

* Submit reboot request to server B

* Test server B responds to ping on IPv4 address (verify if is actually up and running)

* Connect via SSH and setup the new network interface in server A

* Connect via SSH and setup the new network interface in server B

* Connect via SSH to server A and test if server B responds to ping on IPv4 address

* Disconnect servers from network and verify the network details

* Send delete network request and verify that the network is deleted from the list

* Send request to delete servers and wait until they are actually deleted

Indices and tables

==================

* :ref:`genindex`

* :ref:`search`