1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3 .. Copyright (C) 2020 AT&T Intellectual Property
8 This document explains how to maintain the RIC Xapp framework.
9 Information for users of this framework (i.e., Xapp developers) is in the User Guide.
14 The framework requires Python version 3.7 or later, and depends on
15 these packages provided by the O-RAN-SC project and third parties:
22 Version bumping the framework
23 -----------------------------
25 This project follows semver. When changes are made, the versions are in:
27 #. ``docs/release-notes.rst``
33 These items in this repo must be kept in sync with the RMR version:
35 #. Dockerfile-Unit-Test
36 #. examples/Dockerfile-Ping
37 #. examples/Dockerfile-Pong
38 #. ``rmr-version.yaml`` controls what version of RMR is installed for
39 unit testing in Jenkins CI
45 Running the unit tests requires the python packages ``tox`` and ``pytest``.
47 The RMR library is also required during unit tests. If running directly from tox
48 (outside a Docker container), install RMR according to its instructions.
50 Upon completion, view the test coverage like this:
55 open htmlcov/index.html
57 Alternatively, if you cannot install RMR locally, you can run the unit
58 tests in Docker. This is somewhat less nice because you don't get the
59 pretty HTML report on coverage.
63 docker build --no-cache -f Dockerfile-Unit-Test .