Release ricxappframe version 1.1.1 to pypi.org

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

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

Release ricxappframe version 1.1.0 to pypi.org

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

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

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

Promote ricxappframe 1.0.2 to pypi.org

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

Drop clutter of PyPI release control files

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

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

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

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

Release xapp-frame-py @ 1.0.1 to pypi

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

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

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

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

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

Move rmr python api docs over.

Issue-ID: RIC-228
Change-Id: I37772a558a316b12e424f12ad3523cb0a048abe6
Signed-off-by: Tommy Carpenter <tc677g@att.com>

Release 100

Issue-ID: RIC-228
Change-Id: I96947579dc66fcda6c7c6a896309ff3ecf739c33
Signed-off-by: Tommy Carpenter <tc677g@att.com>

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>

Release 070

Issue-ID: RIC-228
Change-Id: Ieeda2adbdaef8832e416f3b8fc86e8859aea36a2
Signed-off-by: Tommy Carpenter <tc677g@att.com>

Implement healthcheck handler

Issue-ID: RIC-228
Change-Id: I1136cbc1fb3e9b7e542033e8cba8d23ba79b15bd
Signed-off-by: Tommy Carpenter <tc677g@att.com>

Remove invalid key-value pair from .gitreview

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

No code change; test with 3.6.3 only.

Issue-ID: RIC-228
Change-Id: I441f4473fbdbaf1af7077d607bf4724cc9835bd0
Signed-off-by: Tommy Carpenter <tc677g@att.com>

Release 060

Issue-ID: RIC-228
Change-Id: I6adf0331c0bdfa684c25600e46ae05c418b538bc
Signed-off-by: Tommy Carpenter <tc677g@att.com>

Switch to SI95

Issue-ID: RIC-228
Change-Id: I806ad3f88eec550338ffba7812a6bd1e1ee3016f
Signed-off-by: Tommy Carpenter <tc677g@att.com>

Release 050

Issue-ID: RIC-228
Change-Id: I59ec8c7e1e6f208401e0f78bea29051830df0b05
Signed-off-by: Tommy Carpenter <tc677g@att.com>

Xapps now have an accessible mdc logger.

Issue-ID: RIC-228
Change-Id: Ic1a4a6931398535821db238ed0e67c8181c163bd
Signed-off-by: Tommy Carpenter <tc677g@att.com>

Switch to py38, latest go builder

Issue-ID: RIC-228
Change-Id: I33910f9573e50b43eb1941c3178d2402ea88f0b9
Signed-off-by: Tommy Carpenter <tc677g@att.com>

Add Dockerized example (no code or version change)

Issue-ID: RIC-228
Change-Id: I69239ea7bb55b8e9962c62be1c12430fe2155448
Signed-off-by: Tommy Carpenter <tc677g@att.com>

Release 040

Issue-ID: RIC-228
Change-Id: I8eddf555e3724f597f69e04b161d116be83d9d38
Signed-off-by: Tommy Carpenter <tc677g@att.com>

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>

Release 030

Issue-ID: RIC-228
Change-Id: Icfbedffbcab902bc50c6f11036847a70634959a0
Signed-off-by: Tommy Carpenter <tc677g@att.com>

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>

Remove junit option from pytest invocation

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

Update install docs (only).

Issue-ID: RIC-228
Change-Id: I7cf31f1cf2e64cd459462a4268d06dd12d8966a3
Signed-off-by: Tommy Carpenter <tc677g@att.com>

Release 020

Issue-ID: RIC-228
Change-Id: I184f09eb1abc8e6ea5868f32a9b84c116ca6df87
Signed-off-by: Tommy Carpenter <tc677g@att.com>

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>

Release (by request)

Change-Id: I3f6044e93fc6b1883a7ef3373061c00cae3f35bf
Signed-off-by: Tommy Carpenter <tc677g@att.com>

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>

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>

Automation adds INFO.yaml

Change-Id: I322e5d24b4eee1d534198081023916d7d4805e22
Signed-off-by: lf-jobbuilder <releng+lf-jobbuilder@linuxfoundation.org>

Automation adds .gitreview

Change-Id: I86d9bfb51aeaac3a794e398cd0ddbac038a51a68
Signed-off-by: lf-jobbuilder <releng+lf-jobbuilder@linuxfoundation.org>

Initial empty repository