.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. SPDX-License-Identifier: CC-BY-4.0
-.. Copyright (C) 2019 Wind River Systems, Inc.
+.. Copyright (C) 2021 Wind River Systems, Inc.
Developer-Guide
===============
:local:
-This project implements a reference implementation for O-RAN O2 IMS and DMS to expose INF platfrom to SMO with O2 interface.
+This project implements a reference implementation for O-RAN O2 IMS and DMS to expose the INF platform to SMO with the O2 interface.
-To contribute on this project, you are supposed to be familiar with INF platfrom as well as O-RAN O2 interface specifications:
+To contribute to this project, you are supposed to be familiar with the INF platform as well as O-RAN O2 interface specifications:
- `O-RAN SC INF platfrom`_
- `O-RAN O2 interface`_
-1. Prerequisite for build environment
--------------------------------------
+1. Prerequisite for building environment
+----------------------------------------
* A ubuntu 18.04 host is sufficient to build o2 projects
-::
+.. code:: shell
# clone code from gerrit repo
$ git clone "https://gerrit.o-ran-sc.org/r/pti/o2" && (cd "o2" && mkdir -p .git/hooks && curl -Lo `git rev-parse --git-dir`/hooks/commit-msg https://gerrit.o-ran-sc.org/r/tools/hooks/commit-msg; chmod +x `git rev-parse --git-dir`/hooks/commit-msg)
$ tox -e code
-1. local test with docker-compose
+2. Local test with docker-compose
---------------------------------
* To test with docker-compose, a docker engine is supposed to be installed as well
-::
+.. code:: shell
$ docker-compose build
$ docker-compose up -d
$ docker-compose run --rm --no-deps --entrypoint=pytest api /tests/unit /tests/integration
-3, Test with INF platform
+3. Test with INF platform
-------------------------
* To test with INF platform, you should install INF platform first, by default you will be able to use the 'admin' user
-::
+.. code:: shell
$ source ./admin_openrc.sh
$ export |grep OS_AUTH_URL
$ export |grep OS_PASSWORD
$ docker-compose run --rm --no-deps --entrypoint=pytest api /tests/integration-ocloud --log-level=DEBUG --log-file=/tests/debug.log
-4, Tear down docker containers
+4. Tear down docker containers
+------------------------------
-::
+.. code:: shell
$ docker-compose down --remove-orphans