src/bindings/rmr-python/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 [X.X.X] - xxx
  11 --------------------
  12
  13 ::
  14     * This is a breaking change as it rquires that RMR version 1.10.2 or later be used.
  15     * The populate and set length function will reallocate the message buffer payload if the caller attempts to insert more bytes than the currrent message supports.
  16     * add ability to set subscription id when allocating a message
  17     * add testing involving subscription ids
  18
  19
  20 [1.0.0] - 10/24/2019
  21 --------------------
  22
  23 ::
  24
  25     * It's been past due to bump this to 1.0.0 since people depend on it!
  26     * Add the ability to set sbuf attributes in the same call that it is allocated
  27     * (breaking) removes bytes2meid
  28     * (breaking) rmr_set_meid now infers length
  29     * (breaking) rmr_get_meid now returns bytes, to be symmetric with set_meid
  30
  31
  32 [0.13.5] - 10/23/2019
  33 --------------------
  34
  35 ::
  36
  37     * Add an exceptions module and raise a proper exception when an allocated buffer has a NULL pointer. Likely due to a bad rmr context.
  38
  39 [0.13.4] - 10/21/2019
  40 --------------------
  41
  42 ::
  43
  44     * Correct cause of nil pointer exception in message summary.
  45
  46
  47 [0.13.3] - 10/10/2019
  48 --------------------
  49
  50 ::
  51
  52     * Add missing unit test for receive all.
  53     * Correct bug in summary function.
  54
  55 [0.13.2] - 10/2/2019
  56 --------------------
  57
  58 ::
  59
  60     * Fix a constant name (RMRFL_MT_CALL)
  61
  62 [0.13.1] - 10/1/2019
  63 --------------------
  64
  65 ::
  66
  67     * Correct unit test bug in rmr-python. With RMR 1.8.x connections are forced to be asynch by default to prevent kubernetes blocking the attempt for minutes. However, the asynch nature of connections makes unit tests concerned with the ability to send and receive messages non-deterministic as some connections are established before the first message is sent, and others are not. This change ensures that unit tests establish connections in a synchronous manner which ensures that the first send will not be rejected by NNG due to a pending connection.
  68
  69 [0.13.0] - 9/27/2019
  70 --------------------
  71
  72 ::
  73    * Add a helpers module to provide extensions and helper functions such as receive all queued messages.
  74    * Enhance unit test to check only for RMR constants which are needed.
  75    * Correct unprintable characters in documentation.
  76
  77
  78 [0.12.0] - 8/23/2019
  79 --------------------
  80
  81 ::
  82    * Add final unit tests for rmr.py; unit test coverage for rmr python is about 95%. The remaining functions are dangerous to unit test directly, e.g., rcv which may block forever
  83    * Fix a bug where meid was being intepreted as bytes (but then cast into a string); the correct interpretation is a string, so now it will truncate after a null byte.
  84    * Removes access to the raw function rmr_get_meid(ptr, dest) in favor of just rmr_get_meid(ptr). Also get_meid is now rmr_get_meid since it wasn't consistent with the naming.
  85
  86
  87 [0.11.0] - 8/21/2019
  88 --------------------
  89
  90 ::
  91    * Overhaul unit tests to remove mocking from the rmr tests, which gives much greater confidence in changing the code. More is still needed however, specifically test sends and test receives.
  92    * Adds an alias rmr_set_meid to rmr_bytes2meid for naming consistency.
  93    * Found a possible inconsistency/bug that requires further investigation later; setting meid takes bytes, but getting it returns a string.
  94
  95
  96 [0.10.8] - 8/20/2019
  97 --------------------
  98
  99 ::
 100    * Fix invocation of _rmr_alloc function
 101
 102
 103 [0.10.7] - 8/14/2019
 104 --------------------
 105
 106 ::
 107    * Finish sphinx documentation
 108    * Make public functions that wrap ctype declarions, allowing for docstrings
 109    * Fix a bug where rmr_set_stimeout was pointing to the wrong function
 110
 111
 112 [0.10.6] - 8/13/2019
 113 --------------------
 114
 115 ::
 116    * Moves Changelog.md to this file, to be consistent with rst-ification
 117    * Sets up a Dockerfile to generate documentation for rmr-python using sphinx
 118
 119
 120 [0.10.5] - 8/13/2019
 121 --------------------
 122
 123 ::
 124
 125    * Make the PYPI page for rmr look nicer.
 126
 127 .. _section-1:
 128
 129 [0.10.4] - 8/08/2019
 130 --------------------
 131
 132 ::
 133
 134    * Fix underlying problem getting errno from some environments; now references new RMR message field to get errno value.
 135    * Add /usr/local/lib64 to tox environment variable to support systems where libraries natually install in lib64 rather than lib.
 136
 137 .. _section-2:
 138
 139 [0.10.3] - 7/31/2019
 140 --------------------
 141
 142 ::
 143
 144    * (Correctly) Include license here per Jira RICPLT-1855
 145
 146 .. _section-3:
 147
 148 [0.10.2] - 7/31/2019
 149 --------------------
 150
 151 ::
 152
 153    * Include license here per Jira RICPLT-1855
 154
 155 .. _section-4:
 156
 157 [0.10.0] - 5/15/2019
 158 --------------------
 159
 160 ::
 161
 162    * Fix a bug in rmr mock that prevented it for being used for rmr_rcv (was only usable for rmr_torcv)
 163    * Add more unit tests, esp for message summary
 164    * Remove meid truncation in the case where a nil is present mid string
 165    * Change the defaul mock of meid and get_src to something more useful
 166
 167 .. _section-5:
 168
 169 [0.9.0] - 5/13/2019
 170 -------------------
 171
 172 ::
 173
 174    * Add a new module for mocking out rmr-python, useful for other packages that depend on rmr-python
 175
 176 .. _section-6:
 177
 178 [0.8.4] - 5/10/2019
 179 -------------------
 180
 181 ::
 182
 183    * Add some unit tests; more to come
 184
 185 .. _section-7:
 186
 187 [0.8.3] - 5/8/2019
 188 ------------------
 189
 190 ::
 191
 192    * Better loop indexing in meid string handling
 193
 194 .. _section-8:
 195
 196 [0.8.2] - 5/8/2019
 197 ------------------
 198
 199 ::
 200
 201    * Fix examples bug
 202    * add liscneses for LF push
 203
 204 .. _section-9:
 205
 206 [0.8.1] - 5/7/2019
 207 ------------------
 208
 209 ::
 210
 211    * Better andling of meid in message summary
 212
 213 .. _section-10:
 214
 215 [0.8.0] - 5/7/2019
 216 ------------------
 217
 218 ::
 219
 220    * Refactor some code to be more functional
 221    * Put back RMR_MAX_RCV_BYTES as a constant
 222    * Add tox.ini, although right now it only LINTs
 223
 224 .. _section-11:
 225
 226 [0.7.0] - 5/6/2019
 227 ------------------
 228
 229 ::
 230
 231    * Add constant fetching from RMr library
 232
 233 .. _section-12:
 234
 235 [0.6.0] - 5/6/2019
 236 ------------------
 237
 238 ::
 239
 240    * Add a new field to rmr_mbuf_t: sub_id
 241    * Fix prior commits lint-ailing python style
 242
 243 .. _section-13:
 244
 245 [0.5.0] - 5/3/2019
 246 ------------------
 247
 248 ::
 249
 250    * Add errno access via new function: rmr.errno()
 251    * Add new functions to access new RMr header fields: get_src, get_meid, rmr_bytes2meid
 252    * Add new RMr constants for error states
 253
 254 .. _section-14:
 255
 256 [0.4.1] - 4/8/2019
 257 ------------------
 258
 259 ::
 260
 261    * Fix a non-ascii encoding issue
 262
 263 .. _section-15:
 264
 265 [0.4.0] - 3/28/2019
 266 -------------------
 267
 268 ::
 269
 270    * Greatly imroved test sender/receiver
 271    * Three new functions implemented (rmr_close, rmr_set_stimeout, rmr_payload_size)
 272
 273 .. _section-16:
 274
 275 [0.3.0] - 3/26/2019
 276 -------------------
 277
 278 ::
 279
 280    * Support a new receive function that (hurray!) has a timeout
 281
 282 .. _section-17:
 283
 284 [0.2.1] - 3/25/2019
 285 -------------------
 286
 287 ::
 288
 289    * Add two new MR states
 290
 291 .. _section-18:
 292
 293 [0.2.0] - 3/25/2019
 294 -------------------
 295
 296 ::
 297
 298    * Switch to NNG from nanomessage
 299
 300 .. _section-19:
 301
 302 [0.1.0] - 3/14/2019
 303 -------------------
 304
 305 ::
 306
 307    * Initial Creation