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 = code,flake8,docs,docs-linkcheck
  22 minversion = 2.0
  23
  24 [pytest]
  25 testpaths = tests
  26
  27 [testenv:code]
  28 basepython = python3.8
  29 deps=
  30     pytest
  31     coverage
  32     pytest-cov
  33 setenv =
  34     LD_LIBRARY_PATH = /usr/local/lib/:/usr/local/lib64
  35     A1_RMR_RETRY_TIMES = 2
  36     INSTANCE_DELETE_NO_RESP_TTL = 3
  37     INSTANCE_DELETE_RESP_TTL = 3
  38     prometheus_multiproc_dir = /tmp
  39
  40 # Note, before this will work, for the first time on that machine, run ./install_deps.sh
  41 commands =
  42 # 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
  43     pytest --cov a1 --cov-report xml --cov-report term-missing --cov-report html --cov-fail-under=70 --junitxml=/tmp/tests.xml
  44     coverage xml -i
  45
  46 [testenv:flake8]
  47 basepython = python3.8
  48 skip_install = true
  49 deps = flake8
  50 commands = flake8 setup.py a1 tests
  51
  52 [flake8]
  53 extend-ignore = E501,E741,E731
  54
  55 [testenv:clm]
  56 # use pip to gather dependencies with versions for CLM analysis
  57 whitelist_externals = sh
  58 commands = sh -c 'pip freeze > requirements.txt'
  59
  60 # Docs
  61
  62 # verbatim as asked for by the docs instructions: https://wiki.o-ran-sc.org/display/DOC/Configure+Repo+for+Documentation
  63 [testenv:docs]
  64 basepython = python3.7
  65 deps =
  66     sphinx
  67     sphinx-rtd-theme
  68     sphinxcontrib-httpdomain
  69     recommonmark
  70     lfdocs-conf
  71
  72 commands =
  73     sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
  74     echo "Generated docs available in {toxinidir}/docs/_build/html"
  75 whitelist_externals = echo
  76
  77 [testenv:docs-linkcheck]
  78 basepython = python3.7
  79 deps = sphinx
  80        sphinx-rtd-theme
  81        sphinxcontrib-httpdomain
  82        recommonmark
  83        lfdocs-conf
  84 commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck