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