Add change log for 2.4.2

Author: rogerdahl

CHANGELOG.md

@@ -1,9 +1,35 @@
 # Change Log
 
+## [2.4.2](https://github.com/DataONEorg/d1_python/tree/2.4.2) (2018-02-15)
+[Full Changelog](https://github.com/DataONEorg/d1_python/compare/2.4.1...2.4.2)
+
+* DataONE Generic Member Node (GMN)
+  * Add SysMeta XML doc to each object returned in BagIt from getPackage()
+  * Fix configuration checks performed at startup and improve messages
+  * Add option to limit number of objects to import in bulk importer
+  * Add tests for settings check performed at GMN startup
+
+* DataONE Client Library
+  * Move updateSystemMetadata() to baseclient to make it availble for CN calls
+
+* DataONE Common Library
+  * Update dependencies to current as of 2018-02-15
+  * Improve StringIterator to allow for more general usage
+
+* Tests and test framework
+  * Add memory_limit context manager and associated test
+    * Provides ability to fail unit tests that exceed a given memory usage target
+    * Based on psutil, which is added as a new dependency
+  * Add workaround for MultipartEncoder bug in Django test client
+  * Improve performance in instance generator
+    * Skip generating PyXB objects that will not be used in the final SysMeta object
+  * Ensure unique media types in test objects
+  * Check that dateSysMetadataModified of object obsoleted by update() is set to the GMN server's current datetime
+
 ## [2.4.1](https://github.com/DataONEorg/d1_python/tree/2.4.1) (2017-12-14)
 [Full Changelog](https://github.com/DataONEorg/d1_python/compare/2.4.0...2.4.1)
 
-* GMN
+* DataONE Generic Member Node (GMN)
   * Add XML Schema (XSD) validation of incoming Science Metadata documents
     * Applies to calls to MNStorage.create() and MNStorage.update()
     * Controlled by new SCIMETA_VALIDATION_* settings
@@ -12,7 +38,7 @@
   * Fix bug that prevented process_refresh_queue from running
   * Improve error handling and logging in bulk importer
 
-* d1_common
+* DataONE Common Library
   * Add new package for validating Science Metadata
     * The required schemas are included in the package
   * Improve error handling in multiprocessed iterators
@@ -29,7 +55,7 @@
 ## [2.4.0](https://github.com/DataONEorg/d1_python/tree/2.4.0) (2017-11-16)
 [Full Changelog](https://github.com/DataONEorg/d1_python/compare/2.3.8...2.4.0)
 
-* GMN
+* DataONE Generic Member Node (GMN)
   * Fix ServiceFailure caused by some `listObjects()` and `getLogRecords()` slice requests
   * Fix datetimes in DataONE types sometimes returned as naive instead of in the UTC timezone
   * Add support for returning BagIt zip archives from `getPackage()`
@@ -53,7 +79,7 @@
     * identifier related functionality
     * Misc
 
-* d1_common
+* DataONE Common Library
   * Add AccessPolicyWrapper, a wrapper for the AccessPolicy DataONE type adds type specific and intuitive methods directly on the object
     * Add SimpleXMLWrapper, similar functionality for XML
     * These abstract away the details of the types and provide for concise and intuitive code
@@ -66,10 +92,11 @@
   * Improve utilities for comparing and normalizing XML
   * New date-time functions to better handle timezones
 
-* d1_client
+* DataONE Client Library
   * Improve error handling in multiprocessed iterators
 
-* Test framework
+* Tests and test framework
+  * Add around 300 tests since 2.3.8.
   * Add support for running tests in parallel with `pytest.xdist`
     * Run of test set, currently around 1100 tests, reduced from 7 to 2 min on dev machine
     * Each worker runs against a separate copy of the GMN database, instantiated from shared template
@@ -87,17 +114,13 @@
   * Misc other smaller test framework improvements
 
 * Misc
-  * Add around 300 tests since 2.3.8.
   * Update dependencies to current as of 2017-11-16
-  * Refactoring:
-    * Better timezone support throughout d1_python
-    * Misc
+  * Better timezone support throughout d1_python
 
 ## [2.3.8](https://github.com/DataONEorg/d1_python/tree/2.3.8) (2017-10-20)
 [Full Changelog](https://github.com/DataONEorg/d1_python/compare/2.3.6...2.3.8)
 
-* Update all dependencies to current versions as of 2017-10-20
-* GMN:
+* DataONE Generic Member Node (GMN)
   * Add support for storing partial and out-of-order revision chains
     * Automatically combine chain fragments that are found to be part of the
     same chain
@@ -108,17 +131,24 @@
   * Add support for general migrations to bulk importer
   * Remove old migrate_v1_to_v2 command
   * Update database test fixtures and sample docs
-* Add misc methods, docstrings and tests to d1_common access_policy module
-* Update PyXB bindings to PyXB 1.2.6 and update generator script
-* Add multiprocessed log record iterator
-* Refactor multiprocessed iterators to improve reliability
-* Add API v1.2 MN method wrappers (view and package methods)
+
+* DataONE Client Library
+  * Add multiprocessed log record iterator
+  * Refactor multiprocessed iterators to improve reliability
+  * Add API v1.2 MN method wrappers (view and package methods)
+
+* DataONE Common Library
+  * Add misc methods, docstrings and tests to access_policy module
+  * Update PyXB bindings to PyXB 1.2.6 and update generator script
+
+* Misc
+  * Update dependencies to current as of 2017-10-20
+
 
 ## [2.3.6](https://github.com/DataONEorg/d1_python/tree/2.3.6) (2017-08-24)
 [Full Changelog](https://github.com/DataONEorg/d1_python/compare/2.3.5...2.3.6)
 
-* Update all dependencies to current versions as of 2017-08-24
-* GMN:
+* DataONE Generic Member Node (GMN)
   * Add extended listObjects() API
       * Fast method for retrieving large number of selected sysmeta values
       * Returns JSON
@@ -135,87 +165,72 @@
   * Keep track of ownership and versioning of sciobj filesystem store
   * Check every minute instead of every hour for new replication and sysmeta refresh tasks
   * Ongoing refactoring of diagnostics
-* Other:
-  * Add support for disabling timeout in d1_client by passing timeout=None, 0 or 0.0
-* Testing:
+
+* DataONE Client Library
+  * Add support for disabling timeout by passing timeout=None, 0 or 0.0
+
+* Tests and test framework
   * Add various small unit test improvements
   * Add automatic migration of test database
   * Update samples
   * Ensure that files deleted after previous build are not included in later releases
 
+* Misc
+  * Update dependencies to current as of 2017-08-24
 
 ## [2.3.5](https://github.com/DataONEorg/d1_python/tree/2.3.5) (2017-08-08)
 [Full Changelog](https://github.com/DataONEorg/d1_python/compare/2.3.4...2.3.5)
 
-* Update all dependencies to current versions as of 2017-08-07
-
-* Add general bulk importer management command
-  * Allows upgrading from any earlier version of GMN or other MN stack
-
-* Add shared module for handling obsolescence chains / revisions
-  * `d1_common/revision.py`
-
-* Rename methods for creating missing directory names
-  * `d1_common/util.py`
-
-* Add default page size of 100 records for getLogRecords()
-  * `d1_common/const.py`
-
-* Expose a ".total" attribute in iterators
-  * Clients can read the value from .total to keep track of progress. Earlier, clients had to perform a separate query using filter parameters matching those used by the iterator. There was also a potential race, in that the total could change between query by the iterator and by the client.
-
-* Change iterator arguments:
-  * ObjectListIterator: listObjects_args_dict -> list_objects_args
-  * LogRecordIterator: getLogRecords_dict -> get_log_records_arg_dict
-
-* Add get_and_save() wrapper for MNRead.get()
-  * This is a convenience method added because correctly saving the result
-from get() to a file is a bit tricky, while it is also the most common
-use of get().
-  * Add option to create missing directories for MNRead.get_and_save()
-
-* Add section in README.md about db fixtures for GMN, how they're used, how to generate them
-  * Improve procedure for regenerating db fixture
-
-* Add mock API handlers
-  * MNCore.getCapabilities()
-  * CNCore.listNodes()
-
-* Fix bug: SID did not resolve correctly
-  * Add tests for SID resolve
-
-* Update default User-Agent to DataONE_Python/x.y.z +http://dataone.org/
-
-* Add misc type related utilities to d1_common
-    * `d1_common/type_conversions.py`, etc.
-
-* Add support for v2 CNRead.synchronize()
-
-* Add description on how to use stream=True with MNRead.get()
-
-* Add handling of db where migrations are out of sync in fixture generator
-
-* Add cleardb diag management command
+* DataONE Generic Member Node (GMN)
+  * Add general bulk importer management command
+    * Allows upgrading from any earlier version of GMN or other MN stack
+  * Add cleardb diag management command
     * Remove cleardb from the diags page
     * Start code for other "diag" management commands
-
-* Improve the way that chains are represented in the db
+  * Improve the way that chains are represented in the db
     * Less code and faster SID related queries
+  * Update revision change related model name
+    * After earlier modifications in how the chains are represented, the old names were misleading
+  * Add SID filtering support
+      * Add support for passing SID as the getLogRecords() idFilter and listObjects() identifier args
+      * Note: We don't resolve SIDs for v1, so the v1 pidFilter argument cannot take a SID.
+      * Add tests for SID filtering
+  * Fix bug: Unable to run management commands
+  * Update node registration doc to reflects updated manage.py commands
+
+* DataONE Client Library
+  * Add support for v2 CNRead.synchronize()
+  * Expose a ".total" attribute in iterators
+    * Clients can read the value from .total to keep track of progress. Earlier, clients had to perform a separate query using filter parameters matching those used by the iterator. There was also a potential race, in that the total could change between query by the iterator and by the client.
+  * Change iterator arguments:
+    * ObjectListIterator: listObjects_args_dict -> list_objects_args
+    * LogRecordIterator: getLogRecords_dict -> get_log_records_arg_dict
+  * Add get_and_save() wrapper for MNRead.get()
+    * This is a convenience method added because correctly saving the result from get() to a file is a bit tricky, while it is also the most common use of get().
+  * Add option to create missing directories for MNRead.get_and_save()
+  * Add description on how to use stream=True with MNRead.get()
+
+* DataONE Common Library
+  * Add module for handling obsolescence chains / revisions
+    * `d1_common/revision.py`
+  * Rename methods for creating missing directory names
+    * `d1_common/util.py`
+  * Add default page size of 100 records for getLogRecords()
+    * `d1_common/const.py`
+  * Update default User-Agent to DataONE_Python/x.y.z +http://dataone.org/
+  * Add misc type related utilities to d1_common
+    * `d1_common/type_conversions.py`, etc.
 
-* Update revision change related model name
-    After earlier modifications in how the chains are represented, the old
-names were misleading.
-
-* Add SID filtering support
-    * Add support for passing SID as the getLogRecords() idFilter and listObjects() identifier args.
-    * Note: We don't resolve SIDs for v1, so the v1 pidFilter argument cannot take a
-SID.
-    * Add tests for SID filtering
-
-* Fix bug: Unable to run management commands
-
-* Update node registration doc to reflects updated manage.py commands
-
-* Add script that checks scimeta indexing
+* Tests and test framework
+  * Add section in README.md about db fixtures for GMN, how they're used, how to generate them
+    * Improve procedure for regenerating db fixture
+  * Add mock API handlers
+    * MNCore.getCapabilities()
+    * CNCore.listNodes()
+  * Fix bug: SID did not resolve correctly
+    * Add tests for SID resolve
+  * Add handling of db where migrations are out of sync in fixture generator
+  * Add script that checks scimeta indexing
 
-* Misc refactoring and internal improvements  
+* Misc
+  * Update dependencies to current as of 2017-08-07