Move sphinx-build into tox

Change-Id: I8b98e96a5f8be1d86f388a2fd702eacd3ad07986

builddocs.sh

@@ -1,4 +0,0 @@
-#!/bin/sh
-
-sphinx-apidoc -f -o ./doc/source ./kollacli
-python setup.py build_sphinx

doc/source/conf.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# kollacli documentation build configuration file, created by
+# kolla-cli documentation build configuration file, created by
 # sphinx-quickstart on Thu Mar 17 18:17:04 2016.
 #
 # This file is execfile()d with the current directory set to its
@@ -47,7 +47,7 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 # General information about the project.
-project = u'kollacli'
+project = u'kolla-cli'
 copyright = u'2016, Oracle'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -180,7 +180,7 @@ html_static_path = ['_static']
 #html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'kollaclidoc'
+htmlhelp_basename = 'kolla-clidoc'
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -200,7 +200,7 @@ latex_elements = {
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  ('index', 'kollacli.tex', u'kollacli Documentation',
+  ('index', 'kolla-cli.tex', u'kolla-cli Documentation',
    u'Oracle', 'manual'),
 ]
 
@@ -230,7 +230,7 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'kollacli', u'kollacli Documentation',
+    ('index', 'kolla-cli', u'kolla-cli Documentation',
      [u'Oracle'], 1)
 ]
 
@@ -244,8 +244,8 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'kollacli', u'kollacli Documentation',
-   u'Oracle', 'kollacli', 'One line description of project.',
+  ('index', 'kolla-cli', u'kolla-cli Documentation',
+   u'Oracle', 'kolla-cli', 'One line description of project.',
    'Miscellaneous'),
 ]
 

doc/source/index.rst

@@ -3,14 +3,16 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to kollacli's documentation!
-====================================
+Welcome to kolla-cli's documentation!
+=====================================
 
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
+   modules
+
 Indices and tables
 ==================
 

doc/source/kolla_cli.api.rst

@@ -0,0 +1,99 @@
+api Package
+===========
+
+:mod:`certificate` Module
+-------------------------
+
+.. automodule:: kolla_cli.api.certificate
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`client` Module
+--------------------
+
+.. automodule:: kolla_cli.api.client
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`config` Module
+--------------------
+
+.. automodule:: kolla_cli.api.config
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`control_plane` Module
+---------------------------
+
+.. automodule:: kolla_cli.api.control_plane
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`exceptions` Module
+------------------------
+
+.. automodule:: kolla_cli.api.exceptions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`group` Module
+-------------------
+
+.. automodule:: kolla_cli.api.group
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`host` Module
+------------------
+
+.. automodule:: kolla_cli.api.host
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`job` Module
+-----------------
+
+.. automodule:: kolla_cli.api.job
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`password` Module
+----------------------
+
+.. automodule:: kolla_cli.api.password
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`properties` Module
+------------------------
+
+.. automodule:: kolla_cli.api.properties
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`service` Module
+---------------------
+
+.. automodule:: kolla_cli.api.service
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`support` Module
+---------------------
+
+.. automodule:: kolla_cli.api.support
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

doc/source/kolla_cli.commands.rst

@@ -0,0 +1,83 @@
+commands Package
+================
+
+:mod:`config` Module
+--------------------
+
+.. automodule:: kolla_cli.commands.config
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`exceptions` Module
+------------------------
+
+.. automodule:: kolla_cli.commands.exceptions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`group` Module
+-------------------
+
+.. automodule:: kolla_cli.commands.group
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`host` Module
+------------------
+
+.. automodule:: kolla_cli.commands.host
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`kolla_action` Module
+--------------------------
+
+.. automodule:: kolla_cli.commands.kolla_action
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`mode` Module
+------------------
+
+.. automodule:: kolla_cli.commands.mode
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`password` Module
+----------------------
+
+.. automodule:: kolla_cli.commands.password
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`property` Module
+----------------------
+
+.. automodule:: kolla_cli.commands.property
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`service` Module
+---------------------
+
+.. automodule:: kolla_cli.commands.service
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`support` Module
+---------------------
+
+.. automodule:: kolla_cli.commands.support
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

doc/source/kolla_cli.common.ansible.rst

@@ -0,0 +1,35 @@
+ansible Package
+===============
+
+:mod:`actions` Module
+---------------------
+
+.. automodule:: kolla_cli.common.ansible.actions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`job` Module
+-----------------
+
+.. automodule:: kolla_cli.common.ansible.job
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`playbook` Module
+----------------------
+
+.. automodule:: kolla_cli.common.ansible.playbook
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`utils` Module
+-------------------
+
+.. automodule:: kolla_cli.common.ansible.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

doc/source/kolla_cli.common.rst

@@ -0,0 +1,98 @@
+common Package
+==============
+
+:mod:`ansible_inventory` Module
+-------------------------------
+
+.. automodule:: kolla_cli.common.ansible_inventory
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`host` Module
+------------------
+
+.. automodule:: kolla_cli.common.host
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`host_group` Module
+------------------------
+
+.. automodule:: kolla_cli.common.host_group
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`inventory` Module
+-----------------------
+
+.. automodule:: kolla_cli.common.inventory
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`passwords` Module
+-----------------------
+
+.. automodule:: kolla_cli.common.passwords
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`properties` Module
+------------------------
+
+.. automodule:: kolla_cli.common.properties
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`service` Module
+---------------------
+
+.. automodule:: kolla_cli.common.service
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`sshutils` Module
+----------------------
+
+.. automodule:: kolla_cli.common.sshutils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`subservice` Module
+------------------------
+
+.. automodule:: kolla_cli.common.subservice
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`support` Module
+---------------------
+
+.. automodule:: kolla_cli.common.support
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`utils` Module
+-------------------
+
+.. automodule:: kolla_cli.common.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    kolla_cli.common.ansible
+

doc/source/kolla_cli.rst

@@ -0,0 +1,29 @@
+kolla_cli Package
+=================
+
+:mod:`i18n` Module
+------------------
+
+.. automodule:: kolla_cli.i18n
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`shell` Module
+-------------------
+
+.. automodule:: kolla_cli.shell
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    kolla_cli.api
+    kolla_cli.commands
+    kolla_cli.common
+    kolla_cli.tests
+

doc/source/kolla_cli.tests.functional.rst

@@ -0,0 +1,107 @@
+functional Package
+==================
+
+:mod:`common` Module
+--------------------
+
+.. automodule:: kolla_cli.tests.functional.common
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_client_upgrade` Module
+---------------------------------
+
+.. automodule:: kolla_cli.tests.functional.test_client_upgrade
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_config` Module
+-------------------------
+
+.. automodule:: kolla_cli.tests.functional.test_config
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_deploy` Module
+-------------------------
+
+.. automodule:: kolla_cli.tests.functional.test_deploy
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_destroy` Module
+--------------------------
+
+.. automodule:: kolla_cli.tests.functional.test_destroy
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_group` Module
+------------------------
+
+.. automodule:: kolla_cli.tests.functional.test_group
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_host` Module
+-----------------------
+
+.. automodule:: kolla_cli.tests.functional.test_host
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_password` Module
+---------------------------
+
+.. automodule:: kolla_cli.tests.functional.test_password
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_property` Module
+---------------------------
+
+.. automodule:: kolla_cli.tests.functional.test_property
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_reconfigure` Module
+------------------------------
+
+.. automodule:: kolla_cli.tests.functional.test_reconfigure
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_service` Module
+--------------------------
+
+.. automodule:: kolla_cli.tests.functional.test_service
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_stop` Module
+-----------------------
+
+.. automodule:: kolla_cli.tests.functional.test_stop
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_support` Module
+--------------------------
+
+.. automodule:: kolla_cli.tests.functional.test_support
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

doc/source/kolla_cli.tests.rst

@@ -0,0 +1,11 @@
+tests Package
+=============
+
+Subpackages
+-----------
+
+.. toctree::
+
+    kolla_cli.tests.functional
+    kolla_cli.tests.unit
+

doc/source/kolla_cli.tests.unit.rst

@@ -0,0 +1,43 @@
+unit Package
+============
+
+:mod:`common` Module
+--------------------
+
+.. automodule:: kolla_cli.tests.unit.common
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_deploy_cmd` Module
+-----------------------------
+
+.. automodule:: kolla_cli.tests.unit.test_deploy_cmd
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_group_cmd` Module
+----------------------------
+
+.. automodule:: kolla_cli.tests.unit.test_group_cmd
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_host_cmd` Module
+---------------------------
+
+.. automodule:: kolla_cli.tests.unit.test_host_cmd
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_service_cmd` Module
+------------------------------
+
+.. automodule:: kolla_cli.tests.unit.test_service_cmd
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

doc/source/kollacli.api.rst

@@ -1,94 +0,0 @@
-kollacli.api package
-====================
-
-Submodules
-----------
-
-kollacli.api.client module
---------------------------
-
-.. automodule:: kollacli.api.client
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.api.control_plane module
----------------------------------
-
-.. automodule:: kollacli.api.control_plane
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.api.exceptions module
-------------------------------
-
-.. automodule:: kollacli.api.exceptions
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.api.group module
--------------------------
-
-.. automodule:: kollacli.api.group
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.api.host module
-------------------------
-
-.. automodule:: kollacli.api.host
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.api.job module
------------------------
-
-.. automodule:: kollacli.api.job
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.api.password module
-----------------------------
-
-.. automodule:: kollacli.api.password
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.api.properties module
-------------------------------
-
-.. automodule:: kollacli.api.properties
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.api.service module
----------------------------
-
-.. automodule:: kollacli.api.service
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.api.support module
----------------------------
-
-.. automodule:: kollacli.api.support
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: kollacli.api
-    :members:
-    :undoc-members:
-    :show-inheritance:

doc/source/kollacli.commands.rst

@@ -1,102 +0,0 @@
-kollacli.commands package
-=========================
-
-Submodules
-----------
-
-kollacli.commands.deploy module
--------------------------------
-
-.. automodule:: kollacli.commands.deploy
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.commands.exceptions module
------------------------------------
-
-.. automodule:: kollacli.commands.exceptions
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.commands.group module
-------------------------------
-
-.. automodule:: kollacli.commands.group
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.commands.host module
------------------------------
-
-.. automodule:: kollacli.commands.host
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.commands.password module
----------------------------------
-
-.. automodule:: kollacli.commands.password
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.commands.property module
----------------------------------
-
-.. automodule:: kollacli.commands.property
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.commands.pull module
------------------------------
-
-.. automodule:: kollacli.commands.pull
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.commands.reconfigure module
-------------------------------------
-
-.. automodule:: kollacli.commands.reconfigure
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.commands.service module
---------------------------------
-
-.. automodule:: kollacli.commands.service
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.commands.support module
---------------------------------
-
-.. automodule:: kollacli.commands.support
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.commands.upgrade module
---------------------------------
-
-.. automodule:: kollacli.commands.upgrade
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: kollacli.commands
-    :members:
-    :undoc-members:
-    :show-inheritance:

doc/source/kollacli.common.ansible.rst

@@ -1,38 +0,0 @@
-kollacli.common.ansible package
-===============================
-
-Submodules
-----------
-
-kollacli.common.ansible.actions module
---------------------------------------
-
-.. automodule:: kollacli.common.ansible.actions
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.common.ansible.job module
-----------------------------------
-
-.. automodule:: kollacli.common.ansible.job
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.common.ansible.playbook module
----------------------------------------
-
-.. automodule:: kollacli.common.ansible.playbook
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: kollacli.common.ansible
-    :members:
-    :undoc-members:
-    :show-inheritance:

doc/source/kollacli.common.rst

@@ -1,109 +0,0 @@
-kollacli.common package
-=======================
-
-Subpackages
------------
-
-.. toctree::
-
-    kollacli.common.ansible
-
-Submodules
-----------
-
-kollacli.common.allinone module
--------------------------------
-
-.. automodule:: kollacli.common.allinone
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.common.host module
----------------------------
-
-.. automodule:: kollacli.common.host
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.common.host_group module
----------------------------------
-
-.. automodule:: kollacli.common.host_group
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.common.inventory module
---------------------------------
-
-.. automodule:: kollacli.common.inventory
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.common.passwords module
---------------------------------
-
-.. automodule:: kollacli.common.passwords
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.common.properties module
----------------------------------
-
-.. automodule:: kollacli.common.properties
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.common.service module
-------------------------------
-
-.. automodule:: kollacli.common.service
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.common.sshutils module
--------------------------------
-
-.. automodule:: kollacli.common.sshutils
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.common.subservice module
----------------------------------
-
-.. automodule:: kollacli.common.subservice
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.common.support module
-------------------------------
-
-.. automodule:: kollacli.common.support
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.common.utils module
-----------------------------
-
-.. automodule:: kollacli.common.utils
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: kollacli.common
-    :members:
-    :undoc-members:
-    :show-inheritance:

doc/source/kollacli.rst

@@ -1,39 +0,0 @@
-kollacli package
-================
-
-Subpackages
------------
-
-.. toctree::
-
-    kollacli.api
-    kollacli.commands
-    kollacli.common
-
-Submodules
-----------
-
-kollacli.i18n module
---------------------
-
-.. automodule:: kollacli.i18n
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kollacli.shell module
----------------------
-
-.. automodule:: kollacli.shell
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: kollacli
-    :members:
-    :undoc-members:
-    :show-inheritance:

doc/source/modules.rst

@@ -1,7 +1,7 @@
-kollacli
-========
+kolla_cli
+=========
 
 .. toctree::
    :maxdepth: 4
 
-   kollacli
+   kolla_cli

kolla_cli/common/inventory.py

@@ -72,11 +72,13 @@ class Inventory(object):
     """class version history
 
     4: (v4.0.1):
-        - removed concept of sub-services (not backward compatible)
+        removed concept of sub-services (not backward compatible)
     3: (v3.0.1):
-        - added aodh, ceph
-        - fix to ensure all sub-services have service as parent
+        added aodh, ceph
+        fix to ensure all sub-services have service as parent
+
     2: (v2.1.1) added ceilometer
+
     1: (v2.0.1) initial release
     """
     def __init__(self, inventory_path=None):
@@ -249,11 +251,10 @@ class Inventory(object):
         """setup multiple hosts
 
         hosts_info is a dict of format:
-        {'hostname1': {
-            'password': password
-            'uname': user_name
-            }
-        }
+            {'hostname1': {
+                'password': password
+                'uname': user_name}}
+
         The uname entry is optional.
         """
         failed_hosts = {}
@@ -523,31 +524,26 @@ class Inventory(object):
         groups.
 
         typical ansible json format:
-        {
-        'group': {
-            'hosts': [
-                '192.168.28.71',
-                '192.168.28.72'
-            ],
-            'vars': {
-                'ansible_ssh_user': 'johndoe',
-                'ansible_ssh_private_key_file': '~/.ssh/mykey',
-                'example_variable': 'value'
-            }
-            'children': [ 'marietta', '5points' ]
-        },
-        '_meta': {
-            'hostvars': {
-                '192.168.28.71': {
-                    'host_specific_var': 'bar'
-                },
-                '192.168.28.72': {
-                    'host_specific_var': 'foo'
-                }
-            }
-        }
-    }
-    """
+            {'group': {
+                'hosts': ['192.168.28.71', '192.168.28.72'],
+                'vars': {
+
+                    'ansible_ssh_user': 'johndoe',
+                    'ansible_ssh_private_key_file': '~/.ssh/mykey',
+                    'example_variable': 'value'},
+
+                'children': [ 'marietta', '5points' ]},
+
+             '_meta': {
+                 'hostvars': {
+
+                     '192.168.28.71': {
+                         'host_specific_var': 'bar'},
+
+                     '192.168.28.72': {
+                         'host_specific_var': 'foo'}}}}
+        """
+
         jdict = {}
 
         # if no filter provided, use all groups, all hosts

kolla_cli/common/utils.py

@@ -136,9 +136,10 @@ def run_cmd(cmd, print_output=True):
     """run a system command
 
     return:
-    - err_msg:  empty string=command succeeded
-                not None=command failed
-    - output:   string: all the output of the run command
+        err_msg:
+            empty string=command succeeded not None=command failed
+        output:
+            string: all the output of the run command
     """
     output = None
     try:

kolla_cli/tests/functional/test_group.py

@@ -158,17 +158,17 @@ class TestFunctional(KollaCliTest):
         """check groups
 
         group listhosts -f json:
-            group listhosts -f json
-                [{"Group Name": "compute", "Hosts": []},
-                {"Group Name": "control", "Hosts": ["ub-target1"]},
-                {"Group Name": "network", "Hosts": []}]
+            [{"Group Name": "compute", "Hosts": []},
+             {"Group Name": "control", "Hosts": ["ub-target1"]},
+             {"Group Name": "network", "Hosts": []}]
 
-            group listservices -f json:
-                [{"Group Name": "compute", "Services": []},
-                {"Group Name": "control",
-                    "Services": ["glance", "keystone", "mysqlcluster",
-                        "nova", "rabbitmq"]},
-                {"Group Name": "network", "Services": ["haproxy", "neutron"]}]
+        group listservices -f json:
+            [{"Group Name": "compute", "Services": []},
+             {"Group Name": "control",
+              "Services": ["glance", "keystone", "mysqlcluster",
+                           "nova", "rabbitmq"]},
+             {"Group Name": "network",
+              "Services": ["haproxy", "neutron"]}]
         """
         # check hosts in groups
         msg = self.run_cli_cmd('group listhosts -f json')
@@ -224,12 +224,9 @@ class TestFunctional(KollaCliTest):
         """get default groups
 
         return a dict:
-        {
-          groupname: {
-                      Services: [svc1, svc2...],
-                      Hosts: []
-                      }
-        }
+            {groupname: {
+                 Services: [svc1, svc2...],
+                 Hosts: []}}
         """
         ansible_inventory = AnsibleInventory()
         groupnames = ansible_inventory.groups

kolla_cli/tests/functional/test_service.py

@@ -64,17 +64,17 @@ class TestFunctional(KollaCliTest):
     def test_listgroups(self):
         """$ kolla-cli service listgroups
 
-        +------------------------+-------------------------+
-        | Service                | Groups                  |
-        +------------------------+-------------------------+
-        | cinder                 | ['control', 'control2'] |
-        | cinder-api             |                         |
-        | cinder-backup          | ['storage']             |
-        | cinder-scheduler       |                         |
-        | cinder-volume          | ['storage']             |
-        | glance                 | ['control', 'control2'] |
-        | glance-api             |                         |
-        | glance-registry        |                         |
+        +------------------------+-------------------------+ \
+        | Service                | Groups                  | \
+        +------------------------+-------------------------+ \
+        | cinder                 | ['control', 'control2'] | \
+        | cinder-api             |                         | \
+        | cinder-backup          | ['storage']             | \
+        | cinder-scheduler       |                         | \
+        | cinder-volume          | ['storage']             | \
+        | glance                 | ['control', 'control2'] | \
+        | glance-api             |                         | \
+        | glance-registry        |                         | \
         ...
 
         """

test-requirements.txt

@@ -17,6 +17,7 @@ oslo.utils>=3.33.0 # Apache-2.0
 oslotest>=3.2.0 # Apache-2.0
 stestr>=2.0.0 # Apache-2.0
 pexpect>=4.0.1
+openstackdocstheme>=1.19.0 # Apache-2.0
 sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7'  # BSD
 sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4'  # BSD
 sphinxcontrib-pecanwsme>=0.8

tox.ini

@@ -90,7 +90,14 @@ commands = bandit -r kolla_cli -x tests
 
 [testenv:docs]
 basepython = python3
-commands = ./builddocs.sh
+whitelist_externals = rm
+deps =
+   -c{env:UPPER_CONSTRAINTS_FILE:https://opendev.org/openstack/requirements/raw/branch/master/upper-constraints.txt}
+   -r{toxinidir}/requirements.txt
+   -r{toxinidir}/test-requirements.txt
+commands =
+  rm -rf doc/build
+  sphinx-build -W -b html doc/source doc/build/html
 
 [testenv:cover]
 basepython = python3