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