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