docs/release-notes.rst

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