ElektraInitiative/libelektra: 0.9.5 Release

• guid: 8a56a045-3d2e-427d-84bb-8256635159d2
• author: Mihael Pranjic
• pubDate: Mon, 12 Apr 2021 08:43:05 +0200
• shortDesc: Java Binding Improvements, Breaking Change to kdbOpen

We are proud to release Elektra 0.9.5.

What is Elektra?

Elektra serves as a universal and secure framework to access configuration settings in a global, hierarchical key database. For more information, visit https://libelektra.org.

You can also read the news on our website

You can try out the latest Elektra release using our docker image elektra/elektra. This is the quickest way to get started with Elektra without compiling and other obstacles, simply run docker run -it elektra/elektra.

Highlights

• Breaking change to kdbOpen. see below
• Ongoing improvements of Java bindings and publishing of bindings to maven central for easy dependency integrations in Java projects

<a id="hl-1"></a>

kdbOpen Contracts

The signature of kdbOpen has been changed from

KDB *  kdbOpen (Key * errorKey);

to

KDB * kdbOpen(const KeySet * contract, Key *parentKey);

You can use kdbOpen (NULL, errorKey) to get the same behaviour as before.

The new parameter contract is similar to what could be done via kdbEnsure (which has been removed). Currently, the contract allows you to mount global plugins and add data into the global KeySet (passed to all plugins) during kdbOpen. This alone is already quite powerful, but we might more functionality in future releases.

For now, there are three use cases for the contract parameter. All of them are covered by helper functions:

int elektraGOptsContract (KeySet * contract, int argc, const char * const * argv, const char * const * envp, const Key * parentKey, KeySet * goptsConfig);
int elektraIoContract (KeySet * contract, ElektraIoInterface * ioBinding);
int elektraNotificationContract (KeySet * contract);

With elektraGOptsContract you can mount and set up the gopts plugin used for command-line argument parsing. The other two functions are the new way to configure Elektra's notification feature.

For more information take a look at doc/dev/kdb-contracts.md

Plugins

The following section lists news about the plugins we updated in this release.

Cache

• The cache plugin now only caches the parts of the global keyset that are below system:/elektra/cache or below system:/elektra/cached. The part below system:/elektra/cache is meant for internal data of the cache, so you should put data below system:/elektra/cached, if you want it to be cached. (Klemens Böswirth)

internalnotification

• Fix use of kdb_long_double_t on armel platforms (#3450). (Mihael Pranjić)

Dbus & Dbusrecv

• Internal changes to ensure compatibility with the new elektraNotificationContract. (Klemens Böswirth)

YAML Smith & Yan LR

• Removed plugins yamlsmith and yanlr. (René Schwaiger)

Zeromqsend & Zeromqrecv

• Internal changes to ensure compatibility with the new elektraNotificationContract. (Klemens Böswirth)

Libraries

The text below summarizes updates to the C (and C++)-based libraries of Elektra.

Compatibility

• keyCopy and keyDup now take an additional flag. See below.
• kdbEnsure was removed and integrated into kdbOpen, which now takes an additional KeySet * contract parameter. See above

Core

<a id="key-copy"></a>

• The keyCopy and keyDup functions have been changed. They now take a flags argument which specifies which parts of the Key should be copied. The API also changed slightly. Most importantly NULL values are handled differently. For example, keyDup (NULL, KEY_CP_ALL) returns a key similar to what keyNew ("/", KEY_END) produces, whereas previously keyDup (NULL) returned NULl. (Klemens Böswirth)
• We added keyReplacePrefix, a function that allows you to easily move a key from one parent to another. (Klemens Böswirth)
• kdbEnsure was removed and replaced by similar functionality added to kdbOpen. see above (Klemens Böswirth)
• KEY_END is now defined as (void *) 0 instead of 0. This allows us to mark keyNew with the GCC attribute __attribute__ ((sentinel)), which causes a compiler warning, if keyNew calls don't use KEY_END as their last argument. (Klemens Böswirth)

Io

• elektraSetIoBinding has been removed. Use elektraIoContract instead. (Klemens Böswirth)

Notification

• elektraNotificationOpen has been removed. Use elektraNotificationContract instead. elektraNotificationClose has also been removed. There is no replacement, cleanup now happens automatially during kdbClose. (Klemens Böswirth)
• The contract for transport plugins has been changed. The exported functions "openNotification", "closeNotification" and"setIoBinding"are no longer used. Instead, plugins should retrieve the I/O binding from the keysystem:/elektra/io/bindingin the global keyset. The notification callback and context that were passed to"openNotification", can now be read from the global keyset as well. The keys aresystem:/elektra/notification/callbackandsystem:/elektra/notification/context` respectively. (Klemens Böswirth)

Bindings

Bindings allow you to utilize Elektra using various programming languages. This section keeps you up to date with the multi-language support provided by Elektra.

JNA

• Since internal iterator support for KeySet is due to being dropped, the following methods have been removed:

  • Elektra::ksNext
  • Elektra::ksCurrent
  • Elektra::ksGetCursor
  • Elektra::ksSetCursor
  • KeySet::next
  • KeySet::current
  • KeySet::rewind
  • KeySet::getCursor
  • KeySet::setCursor

  Until internal KeySet iterator support has been dropped form native library, Elektra::ksRewind is being retained while also being annotated as 'deprecated for removal'. The reason is, that we still need to rewind a KeySet before passing it to a native plugin via NativePlugin::set, NativePlugin::get or NativePlugin::error. (Michael Tucek)

  Furthermore Elektra::ksPop and KeySet::pop have been removed and KeySet::remove has been introduced as replacment. Until internal KeySet iterator support has been dropped form native library, Elektra::ksRewind is being retained while also being annotated as 'depricated for removal'. The reason is, that we still need to rewind a KeySet before passing it to a native plugin via NativePlugin::set, NativePlugin::get or NativePlugin::error. (Michael Tucek)

  Further more Elektra::ksPop and KeySet::pop have been removed and KeySet::remove has been introduced as replacment. (Michael Tucek)

• Renamed KeyException specializations: KeyInvalidNameException, KeyTypeConversionException, KeyTypeMismatchException

• Migration from Maven to Gradle (Michael Tucek)

• Updated documentation for usage of published artifacts (Michael Tucek)

• Integration of Maven Central publishing on Elektra release (Robert Sowula)

Outlook

Ongoing work on bringing the JNA binding up to scratch and improving developer experience. Both for JNA binding API consumers, as well as future JNA binding contrubutors. (Michael Tucek)

Python & Lua

Add support for keyset.remove(key). (Manuel Mausz)

Tools

• webd: update ini, y18n and elliptic dependencies. (Mihael Pranjić)
• Make search for providers not skip rest of plugins on exceptions. (Markus Raab)

Examples

• Fix enums in examples/spec. (Markus Raab)

Documentation

• Document names of different components. (Markus Raab)
• Update buildserver documentation (Robert Sowula)
• Reworked METADATA.ini (Markus Raab)
• Minor rewording in INSTALL.md (@a-kraschitzer)
• Write notes that \\ are due to shell recorder, and are not to be copied (Markus Raab)
• Add link to Go bindings (Markus Raab)
• Fix order of tutorials (Markus Raab)
• Added API-Reviews for multiple functions in the public API (Stefan Hanreich)
• Minor rewording in java-kdb.md (@aaronabebe)
• Added a short Visual Studio 2019 tutorial (/doc/tutorials/contributing-windows.md) (Dominic Jäger)
• Added hint regarding WSL filesystem configuration (/doc/tutorials/contributing-windows.md) (@tucek)
• Fixed broken link in yanlr-plugin readme (@lawli3t)
• Minor readability improvement in highlevel.md (Tobias Schubert @qwepoizt)
• Fix examples of spec plugin. (Robert Sowula)

Tests

• Added small test for jna Return plugin (Return.java), KeyNameIterator.java (@aaronabebe)

Packaging

• Change shlibs version compatibility policy of Debian packages to ">=". (Robert Sowula)
• Automate publishing of the release Elektra Docker images. (Robert Sowula)

Build CMake

• Fix issue where the library runpaths of the jni plugin could not be resolved. (Robert Sowula)

Docker

• Update Alpine Linux images to version 3.13.1 and update Elektra release image. (Mihael Pranjić)

Infrastructure Cirrus

• Update FreeBSD images from version 12.1 to 12.2 (Robert Sowula)
• Update brew before installing packages and print brew config. (Mihael Pranjić)
• Restart dbus service before running tests and find DBUS_LAUNCHD_SESSION_BUS_SOCKET manually (as workaround). (Mihael Pranjić)
• Use macOS Big Sur images. (Mihael Pranjić)

GitHub Actions

• Fix issues with dbus and java paths, exclude jni. (Mihael Pranjić)

Jenkins

• Update daily job to always keep the latest Docker images containing installed Elektra packages that were build on master or during release. (Robert Sowula)
• Add a cleanup of the aptly database to the daily job. (Robert Sowula)

Website

The website is generated from the repository, so all information about plugins, bindings and tools are always up to date. Furthermore, we changed:

• It is now possible to have two links on the same line of a markdown file rendered on the website. (Klemens Böswirth)
• The file doc/KEYNAMES.md is now rendered on the website. (Klemens Böswirth)
• Update ini dependency. (Dependa Bot)
• Update many dependencies (Node 14.x LTS, angular, bootstrap, ..) and fix broken RSS feed permalinks. (Mihael Pranjić)

Outlook

We are currently working on following topics:

• Elektrify KDE (Dardan Haxhimustafa), (Felix Resch) and (Mihael Pranjić)
• 1.0 API (Stefan Hanreich) and (Klemens Böswirth)
• Improve Java Development Experience (Michael Tucek)
• Elektrify GNOME (Mihael Pranjić)
• Continious Releases (Robert Sowula)
• KDB access using FUSE (Alexander Firbas)
• Default TOML plugin (Jakob Fischer)
• Improve Plugin Framework (Vid Leskovar)
• Improve 3-way merge (Dominic Jäger)
• Shell completion (Ulrike Schäfer)
• Ansible bindings (Thomas Waser)

Statistics

We closed 20 issues for this release.

About 19 authors changed 515 files with 19081 insertions(+) and 10602 deletions(-) in 375 commits.

Thanks to all authors for making this release possible!

Join the Initiative!

We welcome new contributors! Read here about how to get started.

As first step, you could give us feedback about these release notes. Contact us via our issue tracker.

Get the Release!

You can download the release from here or GitHub

The hashsums are:

• name: /home/mpranj/workspace/ftp/releases/elektra-0.9.5.tar.gz
• size: 7636892
• md5sum: 2245727ed0042645d98de34a1872fbb4
• sha1: c0181bbee212a46b5a9eda3180ff7673f657d6ed
• sha256: 0b6ee9d6bf13c3749f4d014df444606f84a2f5a797a541002f8d4e745007c3a5

The release tarball is also available signed using GnuPG from here or on GitHub

The following GPG Key was used to sign this release: 12CC44541E1B8AD9B66AFAD55262E7353324914A

Already built API-Docu can be found here or on GitHub.

Stay tuned!

Subscribe to the RSS feed to always get the release notifications.

If you also want to participate, or for any questions and comments please contact us via our issue tracker on GitHub.

Permalink to this NEWS entry

For more information, see https://libelektra.org

Best regards, Elektra Initiative