Initial commit

Create a bare-bones test suite for Pulp. This initial version has numerous rough
edges:

* Only two test modules for Pulp are available.
* Test coverage is roughly 50%.
* The documentation contents are hare-brained and may not be structured well.
* The confugration management library may be extracted or dropped entirely.

All that said — it works. Installation is as easy as `pip install pulp-smash`,
and configuration is just `vi ~/.config/pulp-smash/settings.json`. Numerous make
recipes are in place. Travis integration should be set. Unit tests for Pulp
Smash itself have been properly separated from integration tests for Pulp. Basic
command line support is in place. And most critically, the test suite has been
tested against a live Pulp server.

.gitignore

@@ -0,0 +1,16 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# Generated documentation
+/docs/_build/
+
+# Created by `make package`. `pulp_smash.egg_info` is also used when another
+# package does a `pip install -e …/pulp_smash`.
+/build/
+/dist/
+/pulp_smash.egg-info/
+
+# Coverage information
+/.coverage
+/htmlcov/

.travis

@@ -0,0 +1,20 @@
+sudo: false
+language: python
+python:
+    - 2.7
+    - 3.3
+    - 3.4
+    - 3.5
+install:
+    - pip install -r requirements.txt -r requirements-dev.txt
+script:
+    - make lint
+    - make test-coverage
+    - make docs-html
+    - make docs-clean
+    - make package
+    - make package-clean
+after_success:
+    coveralls
+notifications:
+    irc: "chat.freenode.net#robottelo"

MANIFEST.in

@@ -0,0 +1 @@
+include VERSION

Makefile

@@ -0,0 +1,36 @@
+TEST_OPTIONS=-m unittest discover --start-directory tests --top-level-directory .
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of:"
+	@echo "  help           to show this message"
+	@echo "  docs-html      to generate HTML documentation"
+	@echo "  docs-clean     to remove documentation"
+	@echo "  lint           to run flake8 and pylint"
+	@echo "  test           to run unit tests"
+	@echo "  test-coverage  to run unit tests and measure test coverage"
+	@echo "  package        to generate installable Python packages"
+	@echo "  package-clean  to remove generated Python packages"
+
+docs-html:
+	@cd docs; $(MAKE) html
+
+docs-clean:
+	@cd docs; $(MAKE) clean
+
+lint:
+	flake8 .
+	pylint --reports=n --disable=I docs/conf.py pulp_smash tests setup.py
+
+test:
+	python $(TEST_OPTIONS)
+
+test-coverage:
+	coverage run --source pulp_smash.config $(TEST_OPTIONS)
+
+package:
+	./setup.py sdist bdist_wheel --universal
+
+package-clean:
+	rm -rf build dist pulp_smash.egg-info
+
+.PHONY: help docs-html docs-clean lint test test-coverage package package-clean

README.rst

@@ -0,0 +1,10 @@
+Pulp Smash
+==========
+
+Pulp Smash is a GPL-licensed Python library that facilitates easy testing of
+Pulp.
+
+Documentation can be generated locally::
+
+    pip install -r requirements.txt -r requirements-dev.txt
+    make docs-html

VERSION

@@ -0,0 +1 @@
+0.0.1

docs/Makefile

@@ -0,0 +1,192 @@
+# 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 clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage 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 "  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)"
+
+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/PulpSmash.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PulpSmash.qhc"
+
+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."
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/PulpSmash"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PulpSmash"
+	@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."
+
+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."
+
+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."
+
+coverage:
+	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+	@echo "Testing of coverage in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/coverage/python.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

docs/api/index.rst

@@ -0,0 +1,16 @@
+API Documentation
+=================
+
+This is the Pulp Smash API documentation. It is mostly auto generated from the
+source code. It is split into two sections: documentation on tests for Pulp
+(:doc:`pulp_smash`) and documentation on unit tests for Pulp Smash itself
+(:doc:`tests`).
+
+Beware that Pulp Smash is very new. Its API is **not stable**. This section of
+the documentation should be treated as a handy reference for developers, not a
+gospel.
+
+.. toctree::
+
+    pulp_smash
+    tests

docs/api/pulp_smash.config.base.rst

@@ -0,0 +1,7 @@
+`pulp_smash.config.base`
+========================
+
+Parent document: :mod:`pulp_smash.config`.
+
+.. automodule:: pulp_smash.config.base
+    :private-members:

docs/api/pulp_smash.config.mixins.rst

@@ -0,0 +1,6 @@
+`pulp_smash.config.mixins`
+==========================
+
+Parent document: :mod:`pulp_smash.config`.
+
+.. automodule:: pulp_smash.config.mixins

docs/api/pulp_smash.config.rst

@@ -0,0 +1,13 @@
+`pulp_smash.config`
+===================
+
+Parent document: :mod:`pulp_smash`.
+
+Child documents:
+
+.. toctree::
+
+    pulp_smash.config.base
+    pulp_smash.config.mixins
+
+.. automodule:: pulp_smash.config

docs/api/pulp_smash.rst

@@ -0,0 +1,13 @@
+`pulp_smash`
+============
+
+Parent document: :doc:`index`.
+
+Child documents:
+
+.. toctree::
+
+    pulp_smash.config
+    pulp_smash.tests
+
+.. automodule:: pulp_smash

docs/api/pulp_smash.tests.rst

@@ -0,0 +1,13 @@
+`pulp_smash.tests`
+==================
+
+Parent document: :mod:`pulp_smash`.
+
+Child documents:
+
+.. toctree::
+
+    pulp_smash.tests.test_content_applicability
+    pulp_smash.tests.test_login
+
+.. automodule:: pulp_smash.tests

docs/api/pulp_smash.tests.test_content_applicability.rst

@@ -0,0 +1,6 @@
+`pulp_smash.tests.test_content_applicability`
+=============================================
+
+Parent document: :mod:`pulp_smash.tests`.
+
+.. automodule:: pulp_smash.tests.test_content_applicability

docs/api/pulp_smash.tests.test_login.rst

@@ -0,0 +1,6 @@
+`pulp_smash.tests.test_login`
+=============================
+
+Parent document: :mod:`pulp_smash.tests`.
+
+.. automodule:: pulp_smash.tests.test_login

docs/api/tests.rst

@@ -0,0 +1,13 @@
+`tests`
+=======
+
+Parent document: :doc:`index`.
+
+Child documents:
+
+.. toctree::
+
+    tests.test_config
+    tests.test_config_mixins
+
+.. automodule:: tests

docs/api/tests.test_config.rst

@@ -0,0 +1,6 @@
+`tests.test_config`
+==========================
+
+Parent document: :mod:`tests`.
+
+.. automodule:: tests.test_config

docs/api/tests.test_config_mixins.rst

@@ -0,0 +1,6 @@
+`tests.test_config_mixins`
+==========================
+
+Parent document: :mod:`tests`.
+
+.. automodule:: tests.test_config_mixins