1 .. ==================================================================================
2 .. Copyright (c) 2019 Nokia
3 .. Copyright (c) 2018-2019 AT&T Intellectual Property.
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
9 .. http://www.apache.org/licenses/LICENSE-2.0
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 .. ==================================================================================
18 A1 Mediator Release Notes
19 =========================
21 All notable changes to this project will be documented in this file.
23 The format is based on `Keep a Changelog <http://keepachangelog.com/>`__
24 and this project adheres to `Semantic Versioning <http://semver.org/>`__.
30 * Release 1.0.0 will be the Release A version of A1
39 * Read type GET to get schema for instance PUT
40 * Remove Utils (no longer needed)
41 * lots more tests (unit and integration)
47 * This is on the road to release 1.0.0. It is not meant to be tested (E2E) as it's own release
48 * Implement the Release A spec in the openapi.yaml
49 * Rework A1 to follow that spec
50 * Remove rmr_mapping now that we use policyid as the mtype to send and a well known mtype for the ACKs
51 * Add the delay receiver test to the tavern integration tests
52 * Remove unneeded ENV variables from helm charts
53 * Switch away from builder images to avoid quicksand; upgrade rmr at our own pace
60 * Update to later rmr-python
61 * Add docs about upgrading rmr
62 * remove bombarder since tavern runs apache bench
69 * Update to later rmr-python
75 * Greatly reduce the size of A1 docker from 1.25GB to ~278MB.
76 * Add a seperate dockerfile for unit testing
83 * Rename all /ric/ URLs to be consistent with requirements of /a1-p/
91 * Implement the GET on policies
92 * Add a new endpoint for healthcheck. NOTE, it has been decided by oran architecture documents that this policy interface should be named a1-p in all URLS. In a future release the existing URLs will be renamed (existing URLs were not changed in this release).
100 * Fix the 400, which was in the API, but wasn't actually implemented
101 * Update the test fixture manifests to reflect the latest adm control, paves way for next feature coming which is a policy GET
110 * Use base Docker with NNG version 1.1.1
119 * Upgrade RMR due to a bug that was preventing rmr from init in kubernetes
128 * Run unit tests as part of docker build
137 * Convert docs to appropriate format
138 * Move rmr string to int mapping to a file
147 * Use tavern to test the actual running docker container
148 * Restructures the integration tests to run as a single tox command
149 * Re-ogranizes the README and splits out the Developers guide, which is not needed by users.
158 * 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
159 * Adds a test "bombarding" script that tests this
168 * 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.
169 * Fix a bug in the unit tests (found using a fresh container with no RIC manifest!)
170 * Fix a (critical) bug in a1rmr due to a rename in the last iteration (RMR_ERR_RMR_RCV_RETRY_INTERVAL)
171 * Make unit tests faster by setting envs in tox
172 * Move to the now publically available rmr-python
173 * Return a 400 if am xapp does not expect a body, but the PUT provides one
174 * Adds a new test policy to the example RIC manifest and a new delayed receiver to test the aformentiond race condition
183 * Upgrade to rmr 0.10.0
184 * Fix bad api spec RE GET
185 * 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
194 * Rip some testing structures out of here that should have been in rmr (those are now in rmr 0.9.0, upgrade to that)
195 * Run Python BLACK for formatting
204 * Fix a blocking execution bug by moving from rmr's timeout to a non blocking call + retry loop + asyncronous sleep
205 * Changes the ENV RMR_RCV_TIMEOUT to RMR_RCV_RETRY_INTERVAL
214 * Update to rmr 0.8.3
215 * Change 503 to 504 for the case where downstream does not reply, per recommendation
216 * Add a 502 with different reasons if the xapp replies but with a bad/malformed/missing status
217 * Make testing much more modular, in anticipating of moving some unit test functionality into rmr itself
226 * Crash immediately if manifest isn't mounted
227 * Add unit tests for utils
237 * Upgrade A1 to rmr 0.8.0
238 * Go from deb RMR installation to git
239 * Remove obnoxious receiver logging
248 * Upgrade A1 to rmr 0.6.0
257 * Add license headers
266 * Introduce RIC Manifest
267 * Move some testing functionality into a helper module
268 * Read the policyname to rmr type mapping from manifest
269 * Do PUT payload validation based on the manifest
278 * Bump rmr python dep version
279 * Include a Dockerized test receiver
280 * Stencil out the mising GET
282 * Include a test docker compose file
291 * Initial Implementation