ric-plt/xapp-frame-py.git
16 months agoG release step 2 of 2 73/10073/1 g-release 3.2.1
czichy [Mon, 12 Dec 2022 12:18:16 +0000 (14:18 +0200)]
G release step 2 of 2

Signed-off-by: czichy <thoralf.czichy@nokia.com>
Change-Id: I7f25cfbc6b7ef94249964608d9e5e5a7697658cc

16 months agoG release step 1 of 2 and whitespace fix 62/10062/2
czichy [Mon, 12 Dec 2022 10:39:24 +0000 (12:39 +0200)]
G release step 1 of 2 and whitespace fix

Signed-off-by: czichy <thoralf.czichy@nokia.com>
Change-Id: Ic15a3a8f8751148ff484f87679ad4bad2accc616
Signed-off-by: czichy <thoralf.czichy@nokia.com>
21 months agoFix missing __init__.py files, preventing proper pip install of entities and rnib 08/8808/1
Joao F. Santos [Mon, 25 Jul 2022 20:01:44 +0000 (20:01 +0000)]
Fix missing __init__.py files, preventing proper pip install of entities and rnib

Change-Id: Iaa66305ba734e2014382a0a25b1daf9fb95ed65f
Signed-off-by: Joao F. Santos <joaosantos@vt.edu>
22 months agoF release step 2 of 2 87/8587/1 f-release 3.2.0
czichy [Thu, 16 Jun 2022 13:09:18 +0000 (16:09 +0300)]
F release step 2 of 2

Signed-off-by: czichy <thoralf.czichy@nokia.com>
Change-Id: Ib0d2804baa90fa3381111880c97bf9d42f485013

22 months agoF release step 1 of 2 82/8582/1
czichy [Thu, 16 Jun 2022 11:59:25 +0000 (14:59 +0300)]
F release step 1 of 2

Signed-off-by: czichy <thoralf.czichy@nokia.com>
Change-Id: I1194405646ed5b2487bae78d04a36192df6bbbae

22 months agoRIC-642 related changes: REST subscription, rnib enhancements, symptomdata, rest... 69/8569/7
ehietala [Wed, 15 Jun 2022 09:21:41 +0000 (12:21 +0300)]
RIC-642 related changes: REST subscription, rnib enhancements, symptomdata, rest service with healthy and config interface

Signed-off-by: Erkki Hietala <erkki.hietala@nokia.com>
Change-Id: Ibcbc85b57da571fb9c0eb3adff9ba950aec6c4c9

2 years agoRelease ricxappframe 3.0.2 54/7454/1 3.0.2
Alexandre Huff [Wed, 22 Dec 2021 09:05:04 +0000 (06:05 -0300)]
Release ricxappframe 3.0.2

Issue-ID: RIC-862

Signed-off-by: Alexandre Huff <alexandrehuff@utfpr.edu.br>
Change-Id: Ic8531636b910988662010001d4209cd3b5bc3bd3

2 years agoxapp-frame-py version number upgrading from 3.0.1 to 3.0.2 32/7432/3
Alexandre Huff [Wed, 22 Dec 2021 00:05:29 +0000 (21:05 -0300)]
xapp-frame-py version number upgrading from 3.0.1 to 3.0.2

Issue-ID: RIC-862

Signed-off-by: Alexandre Huff <alexandrehuff@utfpr.edu.br>
Change-Id: Ic7a8521e523d4ac5c750130717876e0a903e67e3

2 years agoFix caching of error code data not happening 19/7419/1
Alexandre Huff [Fri, 17 Dec 2021 11:04:48 +0000 (08:04 -0300)]
Fix caching of error code data not happening

The state_to_status() function re-generates the mapping dict on
every call, which could negatively affect performance.
This change only generates the mapping dict on first call and
caches it for subsequent calls.

Issue-Id: RIC-862

Signed-off-by: Alexandre Huff <alexandrehuff@utfpr.edu.br>
Change-Id: Ida25c5d1f08b4b82e100b6c67ffe911bb8093224

2 years agoRelease ricxappframe 3.0.1 58/7258/1 e-release 3.0.1
Timo Tietavainen [Tue, 7 Dec 2021 10:18:28 +0000 (12:18 +0200)]
Release ricxappframe 3.0.1

Issue-Id: RIC-865

Signed-off-by: Timo Tietavainen <timo.tietavainen@nokia.com>
Change-Id: Idebe8c1d1a5a8ad1b0a879a230b5abe1bd480b74

2 years agoAdd config and rmr UTs back, fix exception memory free 40/7240/1
Timo Tietavainen [Sun, 5 Dec 2021 14:13:01 +0000 (16:13 +0200)]
Add config and rmr UTs back, fix exception memory free

Take configuration and rmr unit tests back into use after fixing the
tests. Improve earlier memory leak fix what was done in the version
3.0.0 to free memory also in a case when python exception has been
thrown.

Issue-Id: RIC-865

Signed-off-by: Timo Tietavainen <timo.tietavainen@nokia.com>
Change-Id: I2a6708fe3dd10d7fea8b5fb5ead8fd895d6826bd

2 years agoRelease ricxappframe 3.0.0 24/7224/1 3.0.0
Timo Tietavainen [Fri, 3 Dec 2021 11:46:47 +0000 (13:46 +0200)]
Release ricxappframe 3.0.0

Issue-Id: RIC-858

Signed-off-by: Timo Tietavainen <timo.tietavainen@nokia.com>
Change-Id: If53387dc97fc46f187ce23b21ebb39ae56b4ec15

2 years agoFix memory leak in xapp-frame-py get_constants() 09/7209/3
Timo Tietavainen [Fri, 3 Dec 2021 01:56:50 +0000 (03:56 +0200)]
Fix memory leak in xapp-frame-py get_constants()

Xapp-frame-py get_constants() function calls c-code RMR library's
rmr_get_consts() function what allocates dynamic memory with strdup
call and returns allocated string to the caller in this case to
python's get_constants() via ctypes interface. This memory should be
freed, otherwise it causes memory leak. With this commit update RMR
version to 4.8.0 what has rmr_free_consts() function and call this
function in the end of get_constants() function to release allocated
memory.

Note that from now on it is required to have RMR version 4.8.0 or
newer version installed because rmr_free_consts() function was
introduced first time in RMR version 4.8.0. That's why bump
xapp-frame-py major version, new version is 3.0.0.

Temporally out scoped few unit test files because some change in
RMR version 4.5.2 causes UT failure. UTs will be fixed later.

Issue-Id: RIC-858

Signed-off-by: Timo Tietavainen <timo.tietavainen@nokia.com>
Change-Id: Ia4a134c5140760b1a1d6016da1e6763fec865c7a

2 years agoAdding Erkki and removing Scott from committers 56/6856/2
czichy [Thu, 14 Oct 2021 08:19:06 +0000 (11:19 +0300)]
Adding Erkki and removing Scott from committers

Signed-off-by: czichy <thoralf.czichy@nokia.com>
Change-Id: I3efc38a9880c369dd7116c028f22d01b3517163a
Signed-off-by: czichy <thoralf.czichy@nokia.com>
2 years agoRelease ricxappframe 2.3.0 36/6736/2 2.3.0
naman.gupta [Thu, 23 Sep 2021 08:52:41 +0000 (14:22 +0530)]
Release ricxappframe 2.3.0

Signed-off-by: naman.gupta <naman.gupta@samsung.com>
Change-Id: Ib6d3a73654806820933afa77dc18dd7469655909

2 years agoXapp-frame-py version number upgrading 09/6709/3
naman.gupta [Fri, 17 Sep 2021 07:24:16 +0000 (12:54 +0530)]
Xapp-frame-py version number upgrading

 Xapp-frame-py version number upgrading from the current version 2.2.0 to 2.3.0

Signed-off-by: naman.gupta <naman.gupta@samsung.com>
Change-Id: Ib6d3a73654806820973afa77dc18dd7469655909

2 years agoXapp Registration reading configuration from env 49/6649/10
naman.gupta [Fri, 3 Sep 2021 08:15:45 +0000 (13:45 +0530)]
Xapp Registration reading configuration from env

Xapp Registration reading configuration from env instead of
configuration as part of the configuration related to xapp comes from
xapp descriptor and rest of the general configuration is part of the xappframework

Issue-ID: RIC-706
Signed-off-by: naman.gupta <naman.gupta@samsung.com>
Change-Id: Ib6d3a73654806820973afa77dc18dd7469255909

2 years agoIntegrate pylog with xapp-frame-py 51/6551/2
subhash kumar singh [Mon, 2 Aug 2021 18:53:32 +0000 (00:23 +0530)]
Integrate pylog with xapp-frame-py

Integrate pylog (https://gerrit.o-ran-sc.org/r/admin/repos/com/pylog)
with xapp-frame-py.

Issue-ID: RIC-330
Signed-off-by: subhash kumar singh <subh.singh@samsung.com>
Change-Id: I305a7a9090d83a9b4e266760f8fd76a045aa5cc4

2 years agoRelease ricxappframe 2.2.0 03/6403/1 dawn 2.2.0
Timo Tietavainen [Wed, 23 Jun 2021 11:53:38 +0000 (14:53 +0300)]
Release ricxappframe 2.2.0

Issue-ID : RIC-664

Signed-off-by: Timo Tietavainen <timo.tietavainen@nokia.com>
Change-Id: Ia12fe03cf378270690aa550bdcf2aa8cc9660bf8

2 years agoUpdate version to 2.2.0 99/6399/2
Timo Tietavainen [Wed, 23 Jun 2021 11:07:31 +0000 (14:07 +0300)]
Update version to 2.2.0

Update xapp-frame-py version to 2.2.0 and update release notes.
E2AP package has been added in version 2.2.0.

Issue-ID : RIC-664

Signed-off-by: Timo Tietavainen <timo.tietavainen@nokia.com>
Change-Id: I23c6795974b0168a3d8c7eb64e60ad07902798e8

2 years agoMerge "Add E2AP package that supports asn1 encoding/decoding function for E2AP."
Timo Tietavainen [Wed, 23 Jun 2021 10:53:41 +0000 (10:53 +0000)]
Merge "Add E2AP package that supports asn1 encoding/decoding function for E2AP."

2 years agoRelease ricxappframe 2.1.0 53/6353/1 2.1.0
Timo Tietavainen [Fri, 18 Jun 2021 14:53:15 +0000 (17:53 +0300)]
Release ricxappframe 2.1.0

Issue-ID: RIC-788

Signed-off-by: Timo Tietavainen <timo.tietavainen@nokia.com>
Change-Id: Ie30966d33d2b243995b73da2c03f00fcab747f97

2 years agoAdd rnib functionality 45/6345/2
yc999.jang [Thu, 10 Jun 2021 10:04:18 +0000 (19:04 +0900)]
Add rnib functionality
- The *_pb2.py files were added that compiled by protoc
- `get_list_gnb_ids`, `get_list_enb_ids` added to the _BaseXapp
- rnib repo added as a submodule

Issue-ID: RIC-788

Signed-off-by: yc999.jang <yc999.jang@samsung.com>
Change-Id: Id5c3392592422597b939fccda902c04369566e9e

2 years agoRelease ricxappframe 2.0.0 19/6319/1 2.0.0
Timo Tietavainen [Mon, 14 Jun 2021 17:19:02 +0000 (20:19 +0300)]
Release ricxappframe 2.0.0

Issue-ID: RIC-706
Issue-ID: RIC-699
Issue-ID: RIC-795

Signed-off-by: Timo Tietavainen <timo.tietavainen@nokia.com>
Change-Id: Idc8dafd6f3b7b2b34c2de797c4fbbc50b9c1ed2d

2 years agoUpgrade available Python SDL version to 3.0.0 18/6318/1
Timo Tietavainen [Mon, 14 Jun 2021 16:37:49 +0000 (19:37 +0300)]
Upgrade available Python SDL version to 3.0.0

Update XAPP-FRAME-PY module dependencies to use latest SDL version 3.0.0
(RIC-699) what contains support for SDL multi-namespace and sentinel based
DB capacity scaling features. Also Notification packing has been fixed in
SDL version 3.0.0 (RIC-795).
XAPP-FRAME API change: received SDL events are now returned as a list of
strings, earlier only one event of type string was possible to return.
This change applies to following XAPP-FRAME APIs: 'handle_events()' and
a callback function registered by the 'subscribe_channel()' call.
Bump XAPP-FRAME-PY version to 2.0.0.

Issue-ID: RIC-699

Signed-off-by: Timo Tietavainen <timo.tietavainen@nokia.com>
Change-Id: Ica3c89d5a47451874fbc5ccd9a6b021fd30f6a53

2 years agoAdd E2AP package that supports asn1 encoding/decoding function for E2AP. 80/4880/5
Heewon Park [Thu, 22 Oct 2020 08:36:04 +0000 (17:36 +0900)]
Add E2AP package that supports asn1 encoding/decoding function for E2AP.

   - indication
   - subscription request/response
   - control request

Issue-ID : RIC-664

Signed-off-by: Heewon Park <h_w.park@samsung.com>
Change-Id: Id1bb533dd4cf16006f73c8e6b928cca65a832e4b

2 years agoUpadated Xappframework for Xapp registration/deregistration to RIC 79/6279/6
Naman Gupta [Thu, 3 Jun 2021 16:19:17 +0000 (21:49 +0530)]
Upadated Xappframework for Xapp registration/deregistration to RIC

Issue-ID: RIC-706
Change-Id: Ie1363d6f937b6412753439a409f17aa850e3a462
Signed-off-by: naman.gupta <naman.gupta@samsung.com>
3 years agoRelease ricxappframe 1.6.0 10/5010/1 cherry 1.6.0
yc999.jang [Mon, 9 Nov 2020 06:37:29 +0000 (15:37 +0900)]
Release ricxappframe 1.6.0

Issue-ID: RIC-662

Signed-off-by: yc999.jang <yc999.jang@samsung.com>
Change-Id: I20d1ecd6d4503e29f7dc9791d2aeddbcc0a1dcee

3 years agoAdd sdlpy wrapping functions 64/4864/3
yc999.jang [Tue, 20 Oct 2020 07:36:02 +0000 (16:36 +0900)]
Add sdlpy wrapping functions

Update ricsdl version requirement for notification support

Issue-ID: RIC-662

Signed-off-by: Youngcheol Jang <yc999.jang@samsung.com>
Change-Id: Ice8c68b25a5f4f7e5a9e5426ebc16e5fa8cc7b82

3 years agoAdd xml coverage capture location to tox 54/4854/1
E. Scott Daniels [Fri, 16 Oct 2020 14:18:32 +0000 (10:18 -0400)]
Add xml coverage capture location to tox

The tox init file is changed to add a filename for the capture
of coverage data from the unit tests.

Issue-ID: RIC-659

Signed-off-by: E. Scott Daniels <daniels@research.att.com>
Change-Id: I349b863ba46ac92a71d6af6fb537a8682dc85a88

3 years agoRemove use of "localhost" in unit tests 34/4834/1
E. Scott Daniels [Mon, 12 Oct 2020 13:36:39 +0000 (09:36 -0400)]
Remove use of "localhost" in unit tests

In some container environments localhost is defined multiple times
in /etc/hosts. This can cause unit tests to fail if "localhost" is
used to create a connection. This change switches to use the loop
back address (127.0.0.1) for unit tests.

Issue-ID: RIC-654

Signed-off-by: E. Scott Daniels <daniels@research.att.com>
Change-Id: Ia48ffac700b54dce59f878f46f1f011dce1df260

3 years agoChange committers 48/4748/3
czichy [Mon, 21 Sep 2020 10:35:18 +0000 (13:35 +0300)]
Change committers

Signed-off-by: czichy <thoralf.czichy@nokia.com>
Change-Id: Ifeebc4c1b507fa16039ad4d88f5edaeb7fcaef87

3 years agoAdd metrics API 28/4428/4
Lott, Christopher (cl778h) [Thu, 23 Jul 2020 10:34:58 +0000 (06:34 -0400)]
Add metrics API

Defines MetricsData, MetricsReport and MetricsManager classes
so client xApps can generate and send reports via RMR.

Issue-ID: RIC-381
Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: I46890db2e9fedd007412cb480f592d059687ccf8

3 years agoCorrect doc for alarm message-type value 28/4328/2
Lott, Christopher (cl778h) [Tue, 7 Jul 2020 09:56:07 +0000 (05:56 -0400)]
Correct doc for alarm message-type value

Value was previously 13111, now 110.

Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: I62ec74376b12125cb5dc16ceddf4bf439629a646

3 years agoMerge "Revise Alarm manager to send via RMR wormhole"
Jack Lucas [Mon, 6 Jul 2020 21:02:57 +0000 (21:02 +0000)]
Merge "Revise Alarm manager to send via RMR wormhole"

3 years agoRevise Alarm manager to send via RMR wormhole 23/4323/2
Lott, Christopher (cl778h) [Mon, 6 Jul 2020 19:13:07 +0000 (15:13 -0400)]
Revise Alarm manager to send via RMR wormhole

Read target host and port from environment variables
ALARM_MGR_SERVICE_NAME and ALARM_MGR_SERVICE_PORT

Bump version to 1.4.0

Issue-ID: RIC-529
Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: I672fa35146fb1a71148e1a69efd67d8421372880

3 years agoResize o-ran logo from 367x370 to 149x150 22/4322/3
Aric Gardner [Mon, 6 Jul 2020 18:17:30 +0000 (14:17 -0400)]
Resize o-ran logo from 367x370 to 149x150

Preview of logo here: https://imgur.com/a/9cg32Eq

Also, remove logo in docs/ dir
logo should only exist in _static/

Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Change-Id: Icff740e9d04f4d34e3e7ed94588b208a7e136ec9

3 years agoImprove class documentation for xapp writers 80/4280/3
Lott, Christopher (cl778h) [Tue, 30 Jun 2020 15:08:00 +0000 (11:08 -0400)]
Improve class documentation for xapp writers

Also bump RMR version used in test from 4.0.5 to 4.1.2

Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: I6179a12d460c609bde9af6b41f58abfae96ad0ab

3 years agoRelease ricxappframe version 1.3.0 to pypi.org 68/4268/1 1.3.0
Lott, Christopher (cl778h) [Mon, 29 Jun 2020 16:59:51 +0000 (12:59 -0400)]
Release ricxappframe version 1.3.0 to pypi.org

Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: Ifdd91eb74500f2a0c2dad9ea2c0371ffb3807439

3 years agoMerge "Add configuration-change API"
Jack Lucas [Mon, 29 Jun 2020 16:47:20 +0000 (16:47 +0000)]
Merge "Add configuration-change API"

3 years agoRelease ricxappframe version 1.2.1 to pypi.org 34/4234/1 1.2.1
Lott, Christopher (cl778h) [Thu, 25 Jun 2020 15:18:54 +0000 (11:18 -0400)]
Release ricxappframe version 1.2.1 to pypi.org

Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: If223b9cf3961866532ac15b9c78d2267ddd064ee

3 years agoAdd configuration-change API 47/4147/3
Lott, Christopher (cl778h) [Tue, 16 Jun 2020 20:12:26 +0000 (16:12 -0400)]
Add configuration-change API

If a configuration file path is defined in an environment variable,
use the Linux kernel's inotify feature to define a watcher on that file.
Xapps that subclass RMRXapp can supply a configuration-change handler
that the framework invokes on write events by polling the watcher.
Xapps that subclass Xapp must invoke a method to poll the watcher.

Bump version to 1.3.0

Issue-ID: RIC-425
Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: I070b36bc7e5a9dcd66c08da0304f7bf9e6a794a1

3 years agoChange alarm msg type to 110 to match RMR constant 19/4219/1
Lott, Christopher (cl778h) [Mon, 22 Jun 2020 20:16:48 +0000 (16:16 -0400)]
Change alarm msg type to 110 to match RMR constant

Issue-ID: RIC-514
Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: I3df9dbfaf9dc5ac1a1bb5180c1eb71b986e2b4cc

3 years agoMerge "Release ricxappframe version 1.2.0 to pypi.org"
Jack Lucas [Thu, 11 Jun 2020 17:37:20 +0000 (17:37 +0000)]
Merge "Release ricxappframe version 1.2.0 to pypi.org"

3 years agoRelease ricxappframe version 1.2.0 to pypi.org 69/4069/2 1.2.0
Lott, Christopher (cl778h) [Thu, 11 Jun 2020 13:27:55 +0000 (09:27 -0400)]
Release ricxappframe version 1.2.0 to pypi.org

Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: Iaed01d4b7440cc89a3bbe2068a696976ffe90544

3 years agoAdd doc required package ricsdl 73/4073/1
Lott, Christopher (cl778h) [Thu, 11 Jun 2020 17:01:58 +0000 (13:01 -0400)]
Add doc required package ricsdl

Add required python package ricsdl for RTD build of user-guide.rst API

Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: I4bbe1dfad17feb8614d3ecde6bae09ad2b7b8629

3 years agoAdd example usage of alarm API 68/4068/1
Lott, Christopher (cl778h) [Thu, 11 Jun 2020 13:13:49 +0000 (09:13 -0400)]
Add example usage of alarm API

Add required doc packages to fix RTD build failure (mdclogpy, msgpack)
of alarm API page.

Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: I268956ae16e9fc934ba92c1d6abfe50b9bca99de

3 years agoReplacing committer 66/4066/2
czichy [Thu, 11 Jun 2020 11:45:46 +0000 (14:45 +0300)]
Replacing committer

Signed-off-by: czichy <thoralf.czichy@nokia.com>
Change-Id: I8afbb5f6e642a6feb9f5272e23fcb8c56eb37eaf

3 years agoAdd alarm API module ricxappframe.alarm.alarm 43/3943/7
Lott, Christopher (cl778h) [Tue, 2 Jun 2020 00:53:12 +0000 (20:53 -0400)]
Add alarm API module ricxappframe.alarm.alarm

New python module provides data types like AlarmDetail and
an AlarmManager class to create, raise and clear alarms by
sending messages via RMR, which should route to Alarm Adapter.
Builds JSON messages to match implementation in ric-plt/alarm-go.
Add JSON schema for alarm message as documentation.
Bump xappframepy version to 1.2.0.

Issue-ID: RIC-380
Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: I746bca0c0982314b6837c042b60747398a92f456

3 years agoExtend RMR module to support wormhole methods 84/3984/1
Lott, Christopher (cl778h) [Wed, 3 Jun 2020 20:27:02 +0000 (16:27 -0400)]
Extend RMR module to support wormhole methods

Bump version to 1.2.0.

Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: I1e148993e4b1758fe0c6f191169cf0200eafdaf3

3 years agoExtend class/method docs and publish as user guide 74/3674/10
Lott, Christopher (cl778h) [Tue, 12 May 2020 19:05:59 +0000 (15:05 -0400)]
Extend class/method docs and publish as user guide

Minor changes to simplify the SDL wrapper methods, none functional.

Bump version to 1.1.2.

Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: Ie1d8ace03315bfd9a75aadc933aa66cf3be3e7ff

3 years agoMerge "Cleanup releases directory by removing old file"
Timo Tietavainen [Fri, 8 May 2020 09:40:07 +0000 (09:40 +0000)]
Merge "Cleanup releases directory by removing old file"

3 years agoCleanup releases directory by removing old file 28/3628/1
Lott, Christopher (cl778h) [Thu, 7 May 2020 20:48:08 +0000 (16:48 -0400)]
Cleanup releases directory by removing old file

Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: I5e94adcea893cb208741c26fb83bfb882817137c

3 years agoRelease ricxappframe version 1.1.1 to pypi.org 27/3627/1 1.1.1
Lott, Christopher (cl778h) [Thu, 7 May 2020 20:44:26 +0000 (16:44 -0400)]
Release ricxappframe version 1.1.1 to pypi.org

Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: Iafc80402684f58012985d5d104d9d1b4bbf06f48

3 years agoUse blocking get call w/ timeout to read msg queue 17/3617/5
Lott, Christopher (cl778h) [Thu, 7 May 2020 12:39:49 +0000 (08:39 -0400)]
Use blocking get call w/ timeout to read msg queue

Add parameters to the queue get method in the xapp_frame loop that reads
messages so it waits for a message to arrive and occasionally checks for
the end-loop flag, instead of spinning the CPU at 100% while waiting.

Upgrade all to use the latest RMR, version 4.0.5.

Tweak the example xapps to emit their names in log messages.

Improve documentation especially the package overview shown at PyPI.

Issue-ID: RIC-354
Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: I08692e6ef60d199cb0b92c1c99740ae808b8885c

3 years agoRelease ricxappframe version 1.1.0 to pypi.org 16/3616/1 1.1.0
Lott, Christopher (cl778h) [Thu, 7 May 2020 11:50:13 +0000 (07:50 -0400)]
Release ricxappframe version 1.1.0 to pypi.org

Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: I290e1e7b1d0d297dfd3d5b6133676f090138ac8f

3 years agoDefine message-summary dict keys as constants 94/3594/8
Lott, Christopher (cl778h) [Wed, 6 May 2020 13:23:55 +0000 (09:23 -0400)]
Define message-summary dict keys as constants

Refactor code to eliminate hardcoded strings like "message state".
Add wrapper method and test for method rmr_set_vlevel.
Unpin xappframepy version in Ping/Pong Dockerfiles.
Use constants for message-state values instead of integers.
Drop all mentions of NNG.
Bump version to 1.1.0.

Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: I27c0bcb4ae6d6a85b518510fd1a4c651d3445313

3 years agoBlock on RMR read to avoid 100% CPU usage on wait 89/3589/2
Lott, Christopher (cl778h) [Tue, 5 May 2020 22:31:54 +0000 (18:31 -0400)]
Block on RMR read to avoid 100% CPU usage on wait

Extend the receive-all helper method to accept a timeout parameter and
pass to rmr_torcv_msg so RMR waits for a notification that a message
has arrived, instead of spinning the processor while waiting.

Issue-ID: RIC-354
Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: I9149dcdad946f8bac1294eed28260b4c38d1056a

3 years agoPromote ricxappframe 1.0.2 to pypi.org 31/3531/3 1.0.2
Lott, Christopher (cl778h) [Wed, 29 Apr 2020 13:34:27 +0000 (09:34 -0400)]
Promote ricxappframe 1.0.2 to pypi.org

Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: Id8c60035fab0273203d30c3b56b9b8680c0c4ba5

3 years agoDrop clutter of PyPI release control files 30/3530/2
Lott, Christopher (cl778h) [Wed, 29 Apr 2020 13:30:49 +0000 (09:30 -0400)]
Drop clutter of PyPI release control files

Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: I08a0769a805c13de93b18fb2fc9593040425c1cc

4 years agoUpgrade to RMR version 4.0.2 32/3532/2
Lott, Christopher (cl778h) [Wed, 29 Apr 2020 13:58:37 +0000 (09:58 -0400)]
Upgrade to RMR version 4.0.2

Bump version to 1.0.3 and add release notes
Add developer guide with guidance on bumping the version

Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: If2fd64c1791c549c674c0779d58d2ac0d4cf1f72

4 years agoUpgrade to RMR version 3.8.0 from released image 86/3386/1
Lott, Christopher (cl778h) [Wed, 22 Apr 2020 13:52:23 +0000 (09:52 -0400)]
Upgrade to RMR version 3.8.0 from released image

Bump version to 1.0.2 and add release notes

Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: Ie7b9882106b6f6670312f6fa9187191fce104ab8

4 years agoReport python dependencies for CLM analysis 02/3302/2
Lott, Christopher (cl778h) [Thu, 16 Apr 2020 20:15:49 +0000 (16:15 -0400)]
Report python dependencies for CLM analysis

Define new environment 'clm' with command 'pip freeze' to report code
and test dependencies with version strings as installed by tox for
CLM analysis.

Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: Ic96e7f7940b39803c44655c9798bdd5dc98378ba

4 years agoRelease xapp-frame-py @ 1.0.1 to pypi 62/3262/1 1.0.1
Lott, Christopher (cl778h) [Tue, 14 Apr 2020 12:58:45 +0000 (08:58 -0400)]
Release xapp-frame-py @ 1.0.1 to pypi

Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: Idcd6aa46402114e19103af6787da059303c418c2

4 years agoRefactor definition of method restype & argtypes 48/3248/5
Lott, Christopher (cl778h) [Fri, 10 Apr 2020 20:02:11 +0000 (16:02 -0400)]
Refactor definition of method restype & argtypes

Use a helper method to set Ctype argument and response types.
Bump version to 1.0.1
Add release note for 1.0.1, generate API docs with autodoc.
Revise release notes to drop code-style formatting of English text.
Add link to RMR man pages at ReadTheDocs.io

Issue-ID: RIC-228
Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: I989566c93f25fa5555b306c569a4bf1d817be2fc

4 years agoMove wrapped C library to subpackage 38/3238/9
Lott, Christopher (cl778h) [Thu, 9 Apr 2020 22:25:19 +0000 (18:25 -0400)]
Move wrapped C library to subpackage

Create new subpackage rmr/rmrclib with the C library loaded via ctypes.
Add method to get constants from RMR library and detect mock objects.
Split test files into test_rmr and test_rmrclib.
Extend sphinx configuration to mock the rmrclib subpackage, so the
rmr package receives a mock instead of a real object.
This change allows generation of API documentation by Sphinx
when the .so file is not available and import fails, for example
at ReadTheDocs.

Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: Idb9bb1d7a534c4142ea0353b5a48d3132e55f6e6

4 years agoExtend doc of RMR python binding methods 37/3237/4
Lott, Christopher (cl778h) [Thu, 9 Apr 2020 18:49:02 +0000 (14:49 -0400)]
Extend doc of RMR python binding methods

Also add type hints to function definitions
No functional changes

Issue-ID: RIC-228
Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: I709a30a1bf3b3ab52701430ac0f9c01df6dea9d7

4 years agoAdd generated API doc to RST 21/3221/2
Lott, Christopher (cl778h) [Wed, 8 Apr 2020 16:41:07 +0000 (12:41 -0400)]
Add generated API doc to RST

The ReadTheDocs builder will never have RMR library installed,
so it's nearly impossible to use the sphinx autodoc API generator
to extract Pydoc strings from the code.  This hack adds the
generated strings to a static file which will require manual
maintenance, poor but an improvement on zero documentation.

Issue-ID: RIC-228
Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: Icf3121c960424eb5f83eac76dbcae55d2f64624b

4 years agoMove rmr python api docs over. 16/3216/3
Tommy Carpenter [Wed, 8 Apr 2020 11:04:51 +0000 (07:04 -0400)]
Move rmr python api docs over.

Issue-ID: RIC-228
Change-Id: I37772a558a316b12e424f12ad3523cb0a048abe6
Signed-off-by: Tommy Carpenter <tc677g@att.com>
4 years agoRelease 100 77/3177/1 1.0.0
Tommy Carpenter [Mon, 6 Apr 2020 23:26:32 +0000 (19:26 -0400)]
Release 100

Issue-ID: RIC-228
Change-Id: I96947579dc66fcda6c7c6a896309ff3ecf739c33
Signed-off-by: Tommy Carpenter <tc677g@att.com>
4 years agoMove rmr python here. 72/3172/3
Tommy Carpenter [Mon, 6 Apr 2020 18:42:57 +0000 (14:42 -0400)]
Move rmr python here.

The decision was made to move rmr python into the xapp frame.
The module name has not been changed otherwise, so apps transitioning
to this should only need to prefix "rmr" with "ricxappframe." to
transition (and, replace rmr with ricxappframe if they are not already
using the framework).

Some small changes have been made in the unit tests, such as port
numbers and monkeypatching statements, but otherwise all "new" code is
identical to rmr python.

Issue-ID: RIC-228
Change-Id: I5e80cfd39c1511db93b95ac5e442a2acfc0733a2
Signed-off-by: Tommy Carpenter <tc677g@att.com>
4 years agoRelease 070 33/3133/1 0.7.0
Tommy Carpenter [Fri, 3 Apr 2020 13:11:40 +0000 (09:11 -0400)]
Release 070

Issue-ID: RIC-228
Change-Id: Ieeda2adbdaef8832e416f3b8fc86e8859aea36a2
Signed-off-by: Tommy Carpenter <tc677g@att.com>
4 years agoImplement healthcheck handler 28/3128/4
Tommy Carpenter [Thu, 2 Apr 2020 23:45:19 +0000 (19:45 -0400)]
Implement healthcheck handler

Issue-ID: RIC-228
Change-Id: I1136cbc1fb3e9b7e542033e8cba8d23ba79b15bd
Signed-off-by: Tommy Carpenter <tc677g@att.com>
4 years agoRemove invalid key-value pair from .gitreview 25/3125/1
Lott, Christopher (cl778h) [Thu, 2 Apr 2020 19:45:31 +0000 (15:45 -0400)]
Remove invalid key-value pair from .gitreview

Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: I9817c3ad360ee7e394732d492ce364cec2adfff7

4 years agoNo code change; test with 3.6.3 only. 63/3063/1
Tommy Carpenter [Mon, 30 Mar 2020 20:17:51 +0000 (16:17 -0400)]
No code change; test with 3.6.3 only.

Issue-ID: RIC-228
Change-Id: I441f4473fbdbaf1af7077d607bf4724cc9835bd0
Signed-off-by: Tommy Carpenter <tc677g@att.com>
4 years agoRelease 060 70/2970/1 0.6.0
Tommy Carpenter [Wed, 25 Mar 2020 12:12:12 +0000 (08:12 -0400)]
Release 060

Issue-ID: RIC-228
Change-Id: I6adf0331c0bdfa684c25600e46ae05c418b538bc
Signed-off-by: Tommy Carpenter <tc677g@att.com>
4 years agoSwitch to SI95 24/2924/2
Tommy Carpenter [Mon, 23 Mar 2020 13:17:47 +0000 (09:17 -0400)]
Switch to SI95

Issue-ID: RIC-228
Change-Id: I806ad3f88eec550338ffba7812a6bd1e1ee3016f
Signed-off-by: Tommy Carpenter <tc677g@att.com>
4 years agoRelease 050 21/2921/1 0.5.0
Tommy Carpenter [Mon, 23 Mar 2020 12:07:46 +0000 (08:07 -0400)]
Release 050

Issue-ID: RIC-228
Change-Id: I59ec8c7e1e6f208401e0f78bea29051830df0b05
Signed-off-by: Tommy Carpenter <tc677g@att.com>
4 years agoXapps now have an accessible mdc logger. 48/2848/1
Tommy Carpenter [Wed, 18 Mar 2020 14:34:28 +0000 (10:34 -0400)]
Xapps now have an accessible mdc logger.

Issue-ID: RIC-228
Change-Id: Ic1a4a6931398535821db238ed0e67c8181c163bd
Signed-off-by: Tommy Carpenter <tc677g@att.com>
4 years agoSwitch to py38, latest go builder 36/2836/3
Tommy Carpenter [Tue, 17 Mar 2020 21:41:42 +0000 (17:41 -0400)]
Switch to py38, latest go builder

Issue-ID: RIC-228
Change-Id: I33910f9573e50b43eb1941c3178d2402ea88f0b9
Signed-off-by: Tommy Carpenter <tc677g@att.com>
4 years agoAdd Dockerized example (no code or version change) 06/2806/1
Tommy Carpenter [Mon, 16 Mar 2020 13:29:23 +0000 (09:29 -0400)]
Add Dockerized example (no code or version change)

Issue-ID: RIC-228
Change-Id: I69239ea7bb55b8e9962c62be1c12430fe2155448
Signed-off-by: Tommy Carpenter <tc677g@att.com>
4 years agoRelease 040 76/2776/2 0.4.0
Tommy Carpenter [Fri, 13 Mar 2020 15:17:02 +0000 (11:17 -0400)]
Release 040

Issue-ID: RIC-228
Change-Id: I8eddf555e3724f597f69e04b161d116be83d9d38
Signed-off-by: Tommy Carpenter <tc677g@att.com>
4 years agoDo not thread by default, but let the user choose. 72/2772/2
Tommy Carpenter [Fri, 13 Mar 2020 13:36:36 +0000 (09:36 -0400)]
Do not thread by default, but let the user choose.

Issue-ID: RIC-228
Change-Id: Iab4acea6b235cdf5acf734b23b0aa735ee41e19c
Signed-off-by: Tommy Carpenter <tc677g@att.com>
4 years agoRelease 030 47/2747/1 0.3.0
Tommy Carpenter [Wed, 11 Mar 2020 11:58:32 +0000 (07:58 -0400)]
Release 030

Issue-ID: RIC-228
Change-Id: Icfbedffbcab902bc50c6f11036847a70634959a0
Signed-off-by: Tommy Carpenter <tc677g@att.com>
4 years agoChanges to framework usage: 16/2716/6
Tommy Carpenter [Mon, 9 Mar 2020 17:46:37 +0000 (13:46 -0400)]
Changes to framework usage:

    * rather than subclass instantiation, xapps now use initialization and registration functions to register handlers
    * rmr xapps can now register handlers for specific message types (and they must prodive a default callback); if the user does this then "message to function routing" is now handled by the framework itself
    * RMRXapp now runs the polling loop in a thread, and returns execution back to the caller. The user is then free to loop, or do nothing, and call stop() when they want.
    * Raises tox coverage minimum to 70 from 50 (currently at 86)

Issue-ID: RIC-228
Change-Id: I15bfb708dbd14a46dc1207296e77383642d22b29
Signed-off-by: Tommy Carpenter <tc677g@att.com>
4 years agoRemove junit option from pytest invocation 92/2692/1
Lott, Christopher (cl778h) [Thu, 5 Mar 2020 20:08:50 +0000 (15:08 -0500)]
Remove junit option from pytest invocation

Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: I883197c58da7a57c7470f0b30ee6812298613cd2

4 years agoUpdate install docs (only). 88/2688/4
Tommy Carpenter [Thu, 5 Mar 2020 14:40:22 +0000 (09:40 -0500)]
Update install docs (only).

Issue-ID: RIC-228
Change-Id: I7cf31f1cf2e64cd459462a4268d06dd12d8966a3
Signed-off-by: Tommy Carpenter <tc677g@att.com>
4 years agoRelease 020 72/2672/1 0.2.0
Tommy Carpenter [Wed, 4 Mar 2020 14:31:57 +0000 (09:31 -0500)]
Release 020

Issue-ID: RIC-228
Change-Id: I184f09eb1abc8e6ea5868f32a9b84c116ca6df87
Signed-off-by: Tommy Carpenter <tc677g@att.com>
4 years agoFixes and enhancements: 37/2637/4
Tommy Carpenter [Tue, 3 Mar 2020 15:21:24 +0000 (10:21 -0500)]
Fixes and enhancements:

    * now allows for RMR Xapps to call code before entering the infinite loop
    * stop is now called before throwing NotImplemented in the case where the client fails to provide a must have callback; this ensures there is no dangling rmr thread
    * stop now calls rmr_close to correctly free up any port(s)
    * (breaking) renames `loop` to `entrypoint` since the function does not have to contain a loop (though it most likely does)
    * Changes wording around the two types of xapps (docs only)
    * Uses a new version of rmr python that crashes when the rmr mrc fails to init, which prevents an xapp trying to use an unusable rmr
    * more unit test code coverage
    * Adds more fields to setup like long_desc and classifiers so the pypi page looks nicer
    * Removes a bad release file (will be added back in subseq. commit)

Issue-ID: RIC-228
Change-Id: I2fa0fcce61f54d4ce1d6176ae71eb2139b1005a5
Signed-off-by: Tommy Carpenter <tc677g@att.com>
4 years agoRelease (by request) 30/2630/1
Tommy Carpenter [Mon, 2 Mar 2020 19:01:51 +0000 (14:01 -0500)]
Release (by request)

Change-Id: I3f6044e93fc6b1883a7ef3373061c00cae3f35bf
Signed-off-by: Tommy Carpenter <tc677g@att.com>
4 years agoAdd documentation in the required format. 17/2617/5
Tommy Carpenter [Fri, 28 Feb 2020 14:17:46 +0000 (09:17 -0500)]
Add documentation in the required format.

Also twiddles the tox to name the code job so that the verify job can be
changed to not run docs.

Issue-ID: RIC-228
Change-Id: I5ded9ae6d421f0906f9fb544ee78dfbf9e8f4291
Signed-off-by: Tommy Carpenter <tc677g@att.com>
4 years agoInitial pass of the py xapp frame 00/2600/11
Tommy Carpenter [Wed, 26 Feb 2020 19:12:54 +0000 (14:12 -0500)]
Initial pass of the py xapp frame

This is not yet completed:
- Docs will come soon
- More unit test coverage will come soon
- More functionality will come soon

However, to avoid a gargantuan commit at the beginning that solves world
hunger, we cut off here on a basically usable framework.

NOTE: a significant portion of this code is *already reviewed* as it
came out of A1. For example, the entire SDLWrapper class, and most of
the RMRLoop. This code will
be deleted from A1 when this is in pypi.

Issue-ID: RIC-228
Change-Id: I9f87b0178cf5fb1cb6b988c29ce11218ed575607
Signed-off-by: Tommy Carpenter <tc677g@att.com>
4 years agoAutomation adds INFO.yaml 89/2589/5
LF Jenkins CI [Wed, 26 Feb 2020 16:39:36 +0000 (16:39 +0000)]
Automation adds INFO.yaml

Change-Id: I322e5d24b4eee1d534198081023916d7d4805e22
Signed-off-by: lf-jobbuilder <releng+lf-jobbuilder@linuxfoundation.org>
4 years agoAutomation adds .gitreview 87/2587/2
LF Jenkins CI [Wed, 26 Feb 2020 16:25:59 +0000 (16:25 +0000)]
Automation adds .gitreview

Change-Id: I86d9bfb51aeaac3a794e398cd0ddbac038a51a68
Signed-off-by: lf-jobbuilder <releng+lf-jobbuilder@linuxfoundation.org>
4 years agoInitial empty repository
LF Jenkins CI [Thu, 6 Feb 2020 23:48:01 +0000 (23:48 +0000)]
Initial empty repository