Bring tests to current openstack release

Switch from oslosphinx to openstackdocstheme
That's what the OpenStack community is using today. Also with newer
Sphinx versions, the current approach does no longer build.

Re-add docs and requirements tests.

Switch to xena standard jobs.

Conflicts:
    doc/requirements.txt
    doc/source/conf.py
    requirements.txt
    scciclient/tests/irmc/test_elcm.py
    scciclient/tests/irmc/test_ipmi.py
    scciclient/tests/irmc/test_scci.py
    scciclient/tests/irmc/test_snmp.py
    scciclient/tests/irmc/viom/test_client.py
    scciclient/tests/irmc/viom/test_elcm.py
    test-requirements.txt

Change-Id: I3f93a400bb83f4a91bd77ebe69f609949cd43ca7

.zuul.yaml

@@ -1,3 +1,5 @@
 - project:
     templates:
-      - openstack-python3-wallaby-jobs
+      - check-requirements
+      - openstack-python3-xena-jobs
+      - publish-openstack-docs-pti

doc/requirements.txt

@@ -1,3 +1,3 @@
-
-sphinx!=1.6.6,!=1.6.7,>=1.6.2
-oslosphinx>=4.7.0 # Apache-2.0
+sphinx!=1.6.6,!=1.6.7,>=2.0.0,!=2.1.0,!=3.0.0;python_version>='3.4' # BSD
+sphinx!=1.6.6,!=1.6.7,>=2.0.0,<2.0.0;python_version=='2.7' # BSD
+openstackdocstheme>=2.2.1 # Apache-2.0

doc/source/conf.py

@@ -22,8 +22,7 @@ sys.path.insert(0, os.path.abspath('../..'))
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
     'sphinx.ext.autodoc',
-    #'sphinx.ext.intersphinx',
-    'oslosphinx'
+    'openstackdocstheme'
 ]
 
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
@@ -57,6 +56,7 @@ pygments_style = 'sphinx'
 # html_theme_path = ["."]
 # html_theme = '_theme'
 # html_static_path = ['static']
+html_theme = 'openstackdocs'
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = '%sdoc' % project
@@ -73,3 +73,6 @@ latex_documents = [
 
 # Example configuration for intersphinx: refer to the Python standard library.
 #intersphinx_mapping = {'http://docs.python.org/': None}
+
+# openstackdocstheme options
+openstackdocs_repo_name = 'x/python-scciclient'

requirements.txt

@@ -7,5 +7,7 @@ pyghmi>=1.0.24 # Apache-2.0
 pysnmp>=4.2.3 # BSD
 requests>=2.14.2 # Apache-2.0
 six>=1.10.0 # MIT
-oslo.utils>=3.33.0 # Apache-2.0
-oslo.serialization!=2.19.1,>=2.18.0 # Apache-2.0
+oslo.utils!=3.39.1,!=3.40.0,!=3.40.1,>=3.33.0;python_version>='3.0' # Apache-2.0
+oslo.utils!=3.39.1,!=3.40.0,!=3.40.1,>=3.33.0,<4.0.0;python_version<'3.0' # Apache-2.0
+oslo.serialization!=2.19.1,>=2.18;python_version>='3.0' # Apache-2.0
+oslo.serialization!=2.19.1,>=2.18,<3.0.0;python_version<'3.0' # Apache-2.0

scciclient/tests/irmc/test_elcm.py

@@ -16,7 +16,8 @@
 Test class for iRMC eLCM functionality.
 """
 
-import mock
+import sys
+
 from oslo_utils import encodeutils
 import requests
 from requests_mock.contrib import fixture as rm_fixture
@@ -25,6 +26,11 @@ import testtools
 from scciclient.irmc import elcm
 from scciclient.irmc import scci
 
+if sys.version_info[0] == 2:
+    import mock
+elif sys.version_info[0] == 3:
+    from unittest import mock
+
 
 class ELCMTestCase(testtools.TestCase):
     """Tests for eLCM"""

scciclient/tests/irmc/test_ipmi.py

@@ -15,13 +15,19 @@
 Test class for IPMI Module.
 """
 
-import mock
+import sys
+
 from pyghmi import exceptions as ipmi_exception
 from pyghmi.ipmi import command as ipmi_command
 import testtools
 
 from scciclient.irmc import ipmi
 
+if sys.version_info[0] == 2:
+    import mock
+elif sys.version_info[0] == 3:
+    from unittest import mock
+
 
 @mock.patch.object(ipmi_command, 'Command', new=mock.Mock())
 class IpmiTestCase(testtools.TestCase):

scciclient/tests/irmc/test_scci.py

@@ -16,10 +16,10 @@ Test class for iRMC Power Driver
 """
 
 import os
+import sys
 import time
 import xml.etree.ElementTree as ET
 
-import mock
 from requests_mock.contrib import fixture as rm_fixture
 import six
 import six.moves.builtins as __builtin__
@@ -29,6 +29,11 @@ from scciclient.irmc import ipmi
 from scciclient.irmc import scci
 from scciclient.irmc import snmp
 
+if sys.version_info[0] == 2:
+    import mock
+elif sys.version_info[0] == 3:
+    from unittest import mock
+
 if six.PY3:
     import io
     file = io.BytesIO

scciclient/tests/irmc/test_snmp.py

@@ -15,14 +15,19 @@
 Test class for snmp module.
 """
 
+import sys
 
-import mock
 from pysnmp.entity.rfc3413.oneliner import cmdgen
 from pysnmp import error as snmp_error
 import testtools
 
 from scciclient.irmc import snmp
 
+if sys.version_info[0] == 2:
+    import mock
+elif sys.version_info[0] == 3:
+    from unittest import mock
+
 
 class IRMCSnmpTestCase(testtools.TestCase):
     """Tests for SNMP module

scciclient/tests/irmc/viom/test_client.py

@@ -12,13 +12,19 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-import mock
+import sys
+
 import testtools
 
 from scciclient.irmc import scci
 from scciclient.irmc.viom import client as viom_client
 from scciclient.irmc.viom import elcm as viom_elcm
 
+if sys.version_info[0] == 2:
+    import mock
+elif sys.version_info[0] == 3:
+    from unittest import mock
+
 
 class VIOMConfigurationTestCase(testtools.TestCase):
 

scciclient/tests/irmc/viom/test_elcm.py

@@ -16,15 +16,20 @@
 Test class for iRMC eLCM functionality.
 """
 
+import sys
 import time
 
-import mock
 import testtools
 
 from scciclient.irmc import elcm
 from scciclient.irmc import scci
 from scciclient.irmc.viom import elcm as viom_elcm
 
+if sys.version_info[0] == 2:
+    import mock
+elif sys.version_info[0] == 3:
+    from unittest import mock
+
 
 class ELCMVIOMClientTestCase(testtools.TestCase):
     """Test for ELCMViomClient."""

test-requirements.txt

@@ -4,11 +4,9 @@
 
 coverage!=4.4,>=4.0 # Apache-2.0
 fixtures>=3.0.0 # Apache-2.0/BSD
-mock>=2.0.0 # BSD
 python-subunit>=1.0.0 # Apache-2.0/BSD
-oslotest>=3.2.0,<4;python_version<'3.6'  # Apache-2.0
-oslotest>=3.2.0;python_version>='3.6'  # Apache-2.0
-stestr>=2.0.0,!=2.3.0,!=3.0.0  # Apache-2.0
+oslotest>=3.2.0 # Apache-2.0
+stestr>=2.0.0,!=2.3.0 # Apache-2.0
 testscenarios>=0.4 # Apache-2.0/BSD
 testtools>=2.2.0 # MIT
 requests-mock>=1.2.0 # Apache-2.0

tox.ini

@@ -49,7 +49,8 @@ basepython = python3
 deps =
     -r{toxinidir}/requirements.txt
     -r{toxinidir}/doc/requirements.txt
-commands = python setup.py build_sphinx
+commands =
+  sphinx-build -b html doc/source doc/build/html
 
 [flake8]
 ignore = W503,W504,W605