docs/release-notes.rst

   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
   4
   5 Release Notes
   6 =============
   7
   8 All notable changes to this project will be documented in this file.
   9
  10 The format is based on `Keep a Changelog <http://keepachangelog.com/>`__
  11 and this project adheres to `Semantic Versioning <http://semver.org/>`__.
  12
  13 [3.1.0] - 2022-03-22
  14 --------------------
  15 * Added the symptomdata module
  16
  17 [3.0.2] - 2021-12-17
  18 --------------------
  19 * Fix caching of error code data not happening (`RIC-862 <https://jira.o-ran-sc.org/browse/RIC-862>`_)
  20 * Improves performance of xapp-frame-py by caching the mapping dict of error codes.
  21
  22 [3.0.1] - 2021-12-07
  23 --------------------
  24 * Take configuration and rmr unit tests back into use after fixing the tests (`RIC-865 <https://jira.o-ran-sc.org/browse/RIC-865>`_)
  25 * Improve memory leak fix done in the version 3.0.0 to free memory also if python exception has been thrown.
  26
  27 [3.0.0] - 2021-12-03
  28 --------------------
  29 * Upgrade to RMR version 4.8.0 to fix memory leak in get_constants() function (`RIC-858 <https://jira.o-ran-sc.org/browse/RIC-858>`_)
  30 * From xapp-frame-py version 3.0.0 onwards it is required to have RMR version 4.8.0 or newer.
  31
  32 [2.3.0] - 2021-09-15
  33 --------------------
  34 * Add Xapp Registration (`RIC-706 <https://jira.o-ran-sc.org/browse/RIC-706>`_)
  35 * Integrate pylog (https://gerrit.o-ran-sc.org/r/admin/repos/com/pylog) with xapp-frame-py (`RIC-330 <https://jira.o-ran-sc.org/browse/RIC-330>`_)
  36
  37 [2.2.0] - 2021-06-23
  38 --------------------
  39 * Add E2AP package (`RIC-664 <https://jira.o-ran-sc.org/browse/RIC-664>`_)
  40
  41
  42 [2.1.0] - 2021-06-18
  43 --------------------
  44 * Add `RNIB <https://gerrit.o-ran-sc.org/r/admin/repos/ric-plt/nodeb-rnib>`_ feature (`RIC-788 <https://jira.o-ran-sc.org/browse/RIC-788>`_)
  45
  46
  47 [2.0.0] - 2021-06-14
  48 --------------------
  49 * Add Xapp registration/deregistration APIs (`RIC-706 <https://jira.o-ran-sc.org/browse/RIC-706>`_)
  50 * Upgrade SDL 3.0.0 version, SDL scaling (`RIC-699 <https://jira.o-ran-sc.org/browse/RIC-699>`_)
  51 * Upgrade SDL 3.0.0 version, notification fix (`RIC-795 <https://jira.o-ran-sc.org/browse/RIC-795>`_)
  52
  53
  54 [1.6.0] - 2020-10-23
  55 --------------------
  56 * Add SDL wrapping API (`RIC-659 <https://jira.o-ran-sc.org/browse/RIC-659>`_)
  57
  58
  59 [1.5.0] - 2020-07-10
  60 --------------------
  61 * Add Metrics API (`RIC-381 <https://jira.o-ran-sc.org/browse/RIC-381>`_)
  62
  63
  64 [1.4.0] - 2020-07-06
  65 --------------------
  66 * Revise Alarm manager to send via RMR wormhole (`RIC-529 <https://jira.o-ran-sc.org/browse/RIC-529>`_)
  67
  68
  69 [1.3.0] - 2020-06-24
  70 --------------------
  71 * Add configuration-change API (`RIC-425 <https://jira.o-ran-sc.org/browse/RIC-425>`_)
  72
  73
  74 [1.2.1] - 2020-06-22
  75 --------------------
  76 * Revise alarm message type (`RIC-514 <https://jira.o-ran-sc.org/browse/RIC-514>`_)
  77
  78
  79 [1.2.0] - 2020-06-04
  80 --------------------
  81 * Extend RMR module to support wormhole methods
  82 * Add alarm API (`RIC-380 <https://jira.o-ran-sc.org/browse/RIC-380>`_)
  83
  84
  85 [1.1.2] - 2020-05-13
  86 --------------------
  87 * Extend and publish class and method documentation as user guide in RST
  88
  89
  90 [1.1.1] - 2020-05-07
  91 --------------------
  92 * Use timeout on queue get method to avoid 100% CPU usage (`RIC-354 <https://jira.o-ran-sc.org/browse/RIC-354>`_)
  93 * Upgrade to RMR version 4.0.5
  94
  95
  96 [1.1.0] - 2020-05-06
  97 --------------------
  98 * Use RMR timeout on receive to avoid 100% CPU usage (`RIC-354 <https://jira.o-ran-sc.org/browse/RIC-354>`_)
  99 * Publish message-summary dict keys as constants to avoid hardcoding strings
 100 * Add wrapper and test for RMR method rmr_set_vlevel(int)
 101
 102
 103 [1.0.3] - 2020-04-29
 104 --------------------
 105 * Upgrade to RMR version 4.0.2
 106
 107
 108 [1.0.2] - 2020-04-22
 109 --------------------
 110 * Upgrade to RMR version 3.8.0
 111
 112
 113 [1.0.1] - 2020-04-10
 114 --------------------
 115 * Publish API documentation using Sphinx autodoc, which required
 116   changes so Sphinx can run when the RMR .so file is not available,
 117   such as during a ReadTheDocs build.
 118 * Create new subpackage rmr/rmrclib with the C library loaded via
 119   ctypes.
 120 * Extend sphinx configuration to mock the new rmrclib subpackage
 121 * Add method to get constants from RMR library and detect mock
 122   objects to work around a bug in Sphinx 3.0.0.
 123 * Split test files into test_rmr and test_rmrclib.
 124 * Add function to define argtype and restype values for library functions
 125 * Configure intersphinx link for RMR man pages at ReadTheDocs.io
 126
 127
 128 [1.0.0] - 4/6/2020
 129 ------------------
 130 * Python rmr has been moved into this repo. The module name has NOT
 131   changed in order to make the transition for repos very easy. The
 132   only transition needed should be prefixing rmr with ricxappframe in
 133   import statements, and to include this rather than rmr in setup.
 134
 135
 136 [0.7.0] - 4/2/2020
 137 ------------------
 138 * RMRXapps by default now implement the rmr healthcheck probe;
 139   users can also override it with a more complex handler if they
 140   wish
 141 * Fix a bug in the unit tests where a payload mismatch wouldn't
 142   actually fail the test (would now)
 143
 144
 145 [0.6.0] - 3/23/2020
 146 -------------------
 147 * Switch to SI95 for rmr
 148
 149
 150 [0.5.0] - 3/18/2020
 151 -------------------
 152 * All xapps (via the base class) now have a logger attribute that can
 153   be invoked to provide mdc logging. It is a passthrough to the RIC
 154   mdc logger for python (untouched, no value in an API on top at the
 155   current time).
 156
 157
 158 [0.4.1] - 3/17/2020
 159 -------------------
 160 * Switch tox to use py38
 161 * switch to latest builders
 162
 163
 164 [0.4.0] - 3/13/2020
 165 -------------------
 166 * Minor breaking change; switches the default behavior RE
 167   threading for RMRXapps. The default is not to return execution,
 168   but the caller (in `run`) can choose to loop in a thread.
 169 * Add Dockerized examples
 170
 171
 172 [0.3.0] - 3/10/2020
 173 -------------------
 174 * Large change to the "feel" of this framework: rather than subclass
 175   instantiation, xapps now use initialization and registration
 176   functions to register handlers
 177 * rmr xapps can now register handlers for specific message types (and
 178   they must prodive a default callback); if the user does this then
 179   "message to function routing" is now handled by the framework itself
 180 * RMRXapp now runs the polling loop in a thread, and returns execution
 181   back to the caller. The user is then free to loop, or do nothing,
 182   and call stop() when they want.
 183 * Raises tox coverage minimum to 70 from 50 (currently at 86)
 184
 185
 186 [0.2.0] - 3/3/2020
 187 ------------------
 188 * now allows for RMRXapps to call code before entering the infinite
 189   loop
 190 * stop is now called before throwing NotImplemented in the case where
 191   the client fails to provide a must have callback; this ensures there
 192   is no dangling rmr thread
 193 * stop now calls rmr_close to correctly free up any port(s)
 194 * (breaking) renames `loop` to `entrypoint` since the function does
 195   not have to contain a loop (though it most likely does)
 196 * Changes wording around the two types of xapps (docs only)
 197 * Uses a new version of rmr python that crashes when the rmr mrc fails
 198   to init, which prevents an xapp trying to use an unusable rmr
 199 * more unit test code coverage
 200 * Adds more fields to setup like long_desc and classifiers so the pypi
 201   page looks nicer
 202 * Removes a bad release file (will be added back in subseq. commit)
 203
 204
 205 [0.1.0] - 2/27/2020
 206 -------------------
 207 * Initial commit