docs/release-notes.rst

   1 .. ==================================================================================
   2 ..       Copyright (c) 2019 Nokia
   3 ..       Copyright (c) 2018-2019 AT&T Intellectual Property.
   4 ..
   5 ..   Licensed under the Apache License, Version 2.0 (the "License");
   6 ..   you may not use this file except in compliance with the License.
   7 ..   You may obtain a copy of the License at
   8 ..
   9 ..          http://www.apache.org/licenses/LICENSE-2.0
  10 ..
  11 ..   Unless required by applicable law or agreed to in writing, software
  12 ..   distributed under the License is distributed on an "AS IS" BASIS,
  13 ..   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 ..   See the License for the specific language governing permissions and
  15 ..   limitations under the License.
  16 .. ==================================================================================
  17
  18 A1 Mediator Release Notes
  19 =========================
  20
  21 All notable changes to this project will be documented in this file.
  22
  23 The format is based on `Keep a Changelog <http://keepachangelog.com/>`__
  24 and this project adheres to `Semantic
  25 Versioning <http://semver.org/>`__.
  26
  27 [0.8.1] - 5/31/2019
  28 -------------------
  29
  30 ::
  31
  32    * Run unit tests as part of docker build
  33
  34
  35
  36 [0.8.0] - 5/28/2019
  37 -------------------
  38
  39 ::
  40
  41    * Convert docs to appropriate format
  42    * Move rmr string to int mapping to a file
  43
  44
  45
  46 [0.7.2] - 5/24/2019
  47 -------------------
  48
  49 ::
  50
  51    * Use tavern to test the actual running docker container
  52    * Restructures the integration tests to run as a single tox command
  53    * Re-ogranizes the README and splits out the Developers guide, which is not needed by users.
  54
  55 .. _section-1:
  56
  57 [0.7.1] - 5/23/2019
  58 -------------------
  59
  60 ::
  61
  62    * Adds a defense mechanism against A1 getting queue-overflowed with messages A1 doesnt care about; A1 now ignores all incoming messages it's not waiting for, so it's queue size should now always be "tiny", i.e., never exceeding the number of valid requests it's waiting for ACKs back for
  63    * Adds a test "bombarding" script that tests this
  64
  65 .. _section-2:
  66
  67 [0.7.0] - 5/22/19
  68 -----------------
  69
  70 ::
  71
  72    * Main purpose of this change is to fix a potential race condition where A1 sends out M1 expecting ACK1, and while waiting for ACK1, sends out M2 expecting ACK2, but gets back ACK2, ACK1. Prior to this change, A1 may have eaten ACK2 and never fufilled the ACK1 request.
  73    * Fix a bug in the unit tests (found using a fresh container with no RIC manifest!)
  74    * Fix a (critical) bug in a1rmr due to a rename in the last iteration (RMR_ERR_RMR_RCV_RETRY_INTERVAL)
  75    * Make unit tests faster by setting envs in tox
  76    * Move to the now publically available rmr-python
  77    * Return a 400 if am xapp does not expect a body, but the PUT provides one
  78    * Adds a new test policy to the example RIC manifest and a new delayed receiver to test the aformentiond race condition
  79
  80 .. _section-3:
  81
  82 [0.6.0]
  83 -------
  84
  85 ::
  86
  87    * Upgrade to rmr 0.10.0
  88    * Fix bad api spec RE GET
  89    * Fix a (big) bug where transactionid wasn't being checked, which wouldn't have worked on sending two policies to the same downstream policy handler
  90
  91 .. _section-4:
  92
  93 [0.5.1] - 5/13/2019
  94 -------------------
  95
  96 ::
  97
  98    * Rip some testing structures out of here that should have been in rmr (those are now in rmr 0.9.0, upgrade to that)
  99    * Run Python BLACK for formatting
 100
 101 .. _section-5:
 102
 103 [0.5.0] - 5/10/2019
 104 -------------------
 105
 106 ::
 107
 108    * Fix a blocking execution bug by moving from rmr's timeout to a non blocking call + retry loop + asyncronous sleep
 109    * Changes the ENV RMR_RCV_TIMEOUT to RMR_RCV_RETRY_INTERVAL
 110
 111 .. _section-6:
 112
 113 [0.4.0] - 5/9.2019
 114 ------------------
 115
 116 ::
 117
 118    * Update to rmr 0.8.3
 119    * Change 503 to 504 for the case where downstream does not reply, per recommendation
 120    * Add a 502 with different reasons if the xapp replies but with a bad/malformed/missing status
 121    * Make testing much more modular, in anticipating of moving some unit test functionality into rmr itself
 122
 123 .. _section-7:
 124
 125 [0.3.4] - 5/8/2019
 126 ------------------
 127
 128 ::
 129
 130    * Crash immediately if manifest isn't mounted
 131    * Add unit tests for utils
 132    * Add missing lic
 133
 134 .. _section-8:
 135
 136 [0.3.3]
 137 -------
 138
 139 ::
 140
 141    * Upgrade A1 to rmr 0.8.0
 142    * Go from deb RMR installation to git
 143    * Remove obnoxious receiver logging
 144
 145 .. _section-9:
 146
 147 [0.3.2]
 148 -------
 149
 150 ::
 151
 152    * Upgrade A1 to rmr 0.6.0
 153
 154 .. _section-10:
 155
 156 [0.3.1]
 157 -------
 158
 159 ::
 160
 161    * Add license headers
 162
 163 .. _section-11:
 164
 165 [0.3.0]
 166 -------
 167
 168 ::
 169
 170    * Introduce RIC Manifest
 171    * Move some testing functionality into a helper module
 172    * Read the policyname to rmr type mapping from manifest
 173    * Do PUT payload validation based on the manifest
 174
 175 .. _section-12:
 176
 177 [0.2.0]
 178 -------
 179
 180 ::
 181
 182    * Bump rmr python dep version
 183    * Include a Dockerized test receiver
 184    * Stencil out the mising GET
 185    * Update the OpenAPI
 186    * Include a test docker compose file
 187
 188 .. _section-13:
 189
 190 [0.1.0]
 191 -------
 192
 193 ::
 194
 195    * Initial Implementation