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.4] - 7/16/2019
  28 -------------------
  29
  30 ::
  31
  32    * Fix the 400, which was in the API, but wasn't actually implemented
  33    * Update the test fixture manifests to reflect the latest adm control, paves way for next feature coming which is a policy GET
  34
  35
  36
  37 [0.8.3] - 6/18/2019
  38 -------------------
  39
  40 ::
  41
  42    * Use base Docker with NNG version 1.1.1
  43
  44
  45
  46 [0.8.2] - 6/5/2019
  47 -------------------
  48
  49 ::
  50
  51    * Upgrade RMR due to a bug that was preventing rmr from init in kubernetes
  52
  53
  54
  55 [0.8.1] - 5/31/2019
  56 -------------------
  57
  58 ::
  59
  60    * Run unit tests as part of docker build
  61
  62
  63
  64 [0.8.0] - 5/28/2019
  65 -------------------
  66
  67 ::
  68
  69    * Convert docs to appropriate format
  70    * Move rmr string to int mapping to a file
  71
  72
  73
  74 [0.7.2] - 5/24/2019
  75 -------------------
  76
  77 ::
  78
  79    * Use tavern to test the actual running docker container
  80    * Restructures the integration tests to run as a single tox command
  81    * Re-ogranizes the README and splits out the Developers guide, which is not needed by users.
  82
  83 .. _section-1:
  84
  85 [0.7.1] - 5/23/2019
  86 -------------------
  87
  88 ::
  89
  90    * 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
  91    * Adds a test "bombarding" script that tests this
  92
  93 .. _section-2:
  94
  95 [0.7.0] - 5/22/19
  96 -----------------
  97
  98 ::
  99
 100    * 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.
 101    * Fix a bug in the unit tests (found using a fresh container with no RIC manifest!)
 102    * Fix a (critical) bug in a1rmr due to a rename in the last iteration (RMR_ERR_RMR_RCV_RETRY_INTERVAL)
 103    * Make unit tests faster by setting envs in tox
 104    * Move to the now publically available rmr-python
 105    * Return a 400 if am xapp does not expect a body, but the PUT provides one
 106    * Adds a new test policy to the example RIC manifest and a new delayed receiver to test the aformentiond race condition
 107
 108 .. _section-3:
 109
 110 [0.6.0]
 111 -------
 112
 113 ::
 114
 115    * Upgrade to rmr 0.10.0
 116    * Fix bad api spec RE GET
 117    * 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
 118
 119 .. _section-4:
 120
 121 [0.5.1] - 5/13/2019
 122 -------------------
 123
 124 ::
 125
 126    * Rip some testing structures out of here that should have been in rmr (those are now in rmr 0.9.0, upgrade to that)
 127    * Run Python BLACK for formatting
 128
 129 .. _section-5:
 130
 131 [0.5.0] - 5/10/2019
 132 -------------------
 133
 134 ::
 135
 136    * Fix a blocking execution bug by moving from rmr's timeout to a non blocking call + retry loop + asyncronous sleep
 137    * Changes the ENV RMR_RCV_TIMEOUT to RMR_RCV_RETRY_INTERVAL
 138
 139 .. _section-6:
 140
 141 [0.4.0] - 5/9.2019
 142 ------------------
 143
 144 ::
 145
 146    * Update to rmr 0.8.3
 147    * Change 503 to 504 for the case where downstream does not reply, per recommendation
 148    * Add a 502 with different reasons if the xapp replies but with a bad/malformed/missing status
 149    * Make testing much more modular, in anticipating of moving some unit test functionality into rmr itself
 150
 151 .. _section-7:
 152
 153 [0.3.4] - 5/8/2019
 154 ------------------
 155
 156 ::
 157
 158    * Crash immediately if manifest isn't mounted
 159    * Add unit tests for utils
 160    * Add missing lic
 161
 162 .. _section-8:
 163
 164 [0.3.3]
 165 -------
 166
 167 ::
 168
 169    * Upgrade A1 to rmr 0.8.0
 170    * Go from deb RMR installation to git
 171    * Remove obnoxious receiver logging
 172
 173 .. _section-9:
 174
 175 [0.3.2]
 176 -------
 177
 178 ::
 179
 180    * Upgrade A1 to rmr 0.6.0
 181
 182 .. _section-10:
 183
 184 [0.3.1]
 185 -------
 186
 187 ::
 188
 189    * Add license headers
 190
 191 .. _section-11:
 192
 193 [0.3.0]
 194 -------
 195
 196 ::
 197
 198    * Introduce RIC Manifest
 199    * Move some testing functionality into a helper module
 200    * Read the policyname to rmr type mapping from manifest
 201    * Do PUT payload validation based on the manifest
 202
 203 .. _section-12:
 204
 205 [0.2.0]
 206 -------
 207
 208 ::
 209
 210    * Bump rmr python dep version
 211    * Include a Dockerized test receiver
 212    * Stencil out the mising GET
 213    * Update the OpenAPI
 214    * Include a test docker compose file
 215
 216 .. _section-13:
 217
 218 [0.1.0]
 219 -------
 220
 221 ::
 222
 223    * Initial Implementation