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