tox.ini

   1 # ==================================================================================
   2 #       Copyright (c) 2019-2020 Nokia
   3 #       Copyright (c) 2018-2020 AT&T Intellectual Property.
   4 #
   5 #   Licensed under the Apache License, Version 2.0 (the "License");
   6 #   you may not use this file except in compliance with the License.
   7 #   You may obtain a copy of the License at
   8 #
   9 #          http://www.apache.org/licenses/LICENSE-2.0
  10 #
  11 #   Unless required by applicable law or agreed to in writing, software
  12 #   distributed under the License is distributed on an "AS IS" BASIS,
  13 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 #   See the License for the specific language governing permissions and
  15 #   limitations under the License.
  16 # ==================================================================================
  17
  18 # Code
  19
  20 [tox]
  21 envlist = py38,flake8,docs,docs-linkcheck
  22 minversion = 2.0
  23
  24 [testenv]
  25 basepython = python3.8
  26 deps=
  27     pytest
  28     coverage
  29     pytest-cov
  30 setenv =
  31     LD_LIBRARY_PATH = /usr/local/lib/:/usr/local/lib64
  32     A1_RMR_RETRY_TIMES = 2
  33     INSTANCE_DELETE_NO_RESP_TTL = 3
  34     INSTANCE_DELETE_RESP_TTL = 3
  35
  36 # Note, before this will work, for the first time on that machine, run ./install_deps.sh
  37 commands =
  38 # sometimes the -s flag is helpful; add -s after pytest; which streams the logs as they come in, rather than saving them all for the end of tests
  39     pytest --cov a1 --cov-report xml --cov-report term-missing --cov-report html --cov-fail-under=70
  40     coverage xml -i
  41
  42 [testenv:flake8]
  43 basepython = python3.8
  44 skip_install = true
  45 deps = flake8
  46 commands = flake8 setup.py a1 tests
  47
  48 [flake8]
  49 extend-ignore = E501,E741,E731
  50
  51 # Docs
  52
  53 # verbatim as asked for by the docs instructions: https://wiki.o-ran-sc.org/display/DOC/Configure+Repo+for+Documentation
  54 [testenv:docs]
  55 basepython = python3.7
  56 deps =
  57     sphinx
  58     sphinx-rtd-theme
  59     sphinxcontrib-httpdomain
  60     recommonmark
  61     lfdocs-conf
  62
  63 commands =
  64     sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
  65     echo "Generated docs available in {toxinidir}/docs/_build/html"
  66 whitelist_externals = echo
  67
  68 [testenv:docs-linkcheck]
  69 basepython = python3.7
  70 deps = sphinx
  71        sphinx-rtd-theme
  72        sphinxcontrib-httpdomain
  73        recommonmark
  74        lfdocs-conf
  75 commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck