$darkmode
Elektra 0.11.0
|
We are proud to release Elektra 0.8.24.
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.
For a small demo see here:
You can also read the news on our website
The new release of Elektra Web features many UX improvements from the usability test!
Try it out now on: http://webdemo.libelektra.org/
elektra/web
Thanks to Daniel Bugl.
Elektra's notification feature which allows applications to keep persistent configuration settings in sync with the key database and other applications was greatly improved with this release:
More details can be found in this news. Check out the updated notification tutorial and notification examples (polling, async and reload.
At Akademy 2018 we had a successful Config Workshop.
We generally agreed that misconfiguration is important and the situation in FLOSS needs to improve. We discussed how Elektra can be used in KDE and came up with the idea that KConfig could be moved to a Elektra plugin. Then KConfig could be patched to use Elektra instead. This would lead to the situation that KDE users would have the same user experience with the advantages of Elektra, like:
For more information see the Slides
Elektra supports specifying the semantics of keys via metakeys in the spec
namespace. An example is the metakey check/range
which can be used to specify that a key only holds numbers in a given range. Another metakey is check/enum
which only allows specific keywords to be the content of a key. Up to now these semantics are only being checked at runtime. Therefore a type system was developed to be able to check configuration specifications statically. As an example, it would detect when one accidentally adds both a range and an enum check if their possible contents are not compatible with each other.
The type system is available as a plugin that gets mounted along with a configuration specification into the spec namespace. Furthermore we include a set of type definitions for commonly used metakeys such as check/range
, check/enum
, check/validation
, fallback
or override
.
For more details see the typechecker readme
Thanks to Armin Wurzinger.
Next to the Puppet Resource Type we now also prepared a Chef Cookbook which allows us to use Elektra from within Chef.
For example, to set mount a configuration file, you can use:
And to add an hosts entry, you can use:
Note that currently
kdb
is invoked and Elektra needs to be installed for managed systems.
Thanks to Michael Zronek and Vanessa Kos.
, where pluginname
specifies the name of your new plugin. _(René Schwaiger)_
crypto
plugin now uses Elektra's libinvoke
and the base64
plugin in order to encode and decode Base64 strings. This improvement reduces code duplication between the two plugins. _(Peter Nirschl)_fcrypt
plugin will consider the environment variable TMPDIR
in order to detect its temporary directory. See [#1973] _(Peter Nirschl)_fstab
plugin now passes tests on musl builds. _(Lukas Winkler)_BUILD_STATIC
or BUILD_FULL
build variants, since otherwise the plugin breaks the kdb
tool. _(René Schwaiger)_testscr_check_kdb_internal_check
) for the plugin, since it always fails. _(René Schwaiger)_list
plugin now allows us to pass common configuration for all plugins by using keys below the "config/" setting. The updated plugin documentation contains more information and an example. _(Thomas Wahringer)_list
plugin which is responsible for global mounting had a bug which prevented globally mounted plugins from being configurable. _(Thomas Wahringer)_ccode
instead of the “provider” code
. _(René Schwaiger)_check/range
, check/enum
and default
are supported. _(Armin Wurzinger)_tcl
plugin does not fail anymore, if its configuration file does not exist and you try to retrieve the plugin contract. _(René Schwaiger)_printf
statements. _(René Schwaiger)_. _(René Schwaiger)_
YAML CPP now requires at least yaml-cpp 0.6
, since the current MSR test for the plugin triggers two bugs:
in earlier versions of the yaml-cpp library. _(René Schwaiger)_
array
metadata for arrays containing arrays. _(René Schwaiger)_KeySet
data structure to a textual representation in the YAML serialization format. The plugin is currently in a very early stage of development. Please be advised, that it is quite likely that the plugin will produce incorrect or even invalid YAML data, especially if your KeySet
contains special characters.KeySet
data structure. If you want to write data in the YAML format please take a look at the YAML Smith plugin. _(René Schwaiger)_ZMQ_PUB
and ZMQ_SUB
sockets to send and receive notifications. The plugins can be used instead or along with the "dbus" and "dbusrecv" transport plugins. Check out the plugin documentation for more information. _(Thomas Wahringer)_simpleini
silently on non-glibc systems but output a message like for other plugins _(Markus Raab)_We updated the infos/status
clause of the following plugins:
boolean
,constants
,csvstorage
,hexnumber
,internalnotification
,ruby
,simpleini
,uname
, andxerces
. _(René Schwaiger)_
strdup
with elektraStrDup
(for C99 compatibility). _(Markus Raab)_key.delBaseName()
. _(René Schwaiger)_elektraArrayGetNextKey
now uses NULL
instead of the empty string as init value for the returned key. _(René Schwaiger)_pluginprocess
that is used to execute plugins run inside own processes has been improved. This is useful as some plugins like Haskell-based plugins or python
can only be started once inside a single process, while libelektra may call a plugin several times. The library now uses an improved communication protocol that separates between pluginprocess-related data and keysets passed to plugins. This avoids any possible name clashes between keys used by a plugin and keys used by pluginprocess. The documentation of the plugin has been improved as well, some mistakes were corrected and it should be more clear how to store plugin data besides pluginprocess's data structure. Tests have been added to the library to ensure its correct functionality. _(Armin Wurzinger)_int
, unsigned int
, long
, unsigned long
, long long
, unsinged long long
, float
and double
. It also supports all of Elektra's kdb_*_t
types defined in kdbtypes.h
. Also contexts for callbacks were added and elektraNotificationRegisterCallbackSameOrBelow()
allows for notifications for the registered key or below. _(Thomas Wahringer)_kdb find
lists keys of the database matching a certain regular expression. _(Markus Raab)_5.11
. _(René Schwaiger)_check_formatting.sh
now also checks the formatting of CMake code if you installed sponge
and cmake-format
. _(René Schwaiger)_check_formatting.sh
now no longer writes to stdout if clang-format5.0 can not be found. _(Lukas Winkler)_check_bashisms.sh
should now work correctly again, if the system uses the GNU version find
. _(René Schwaiger)_reformat-cmake
now checks if cmake-format
works before it reformats CMake files. Thank you to Klemens Böswirth for the detailed description of the problem. _(René Schwaiger)_scripts/build/run_icheck
now no longer leaves the base directory of the project when checking if the ABI changed. _(Lukas Winkler)_info/
meta attributes of the file plugin. _(René Schwaiger)_copy-template
is now location independent. It will always create a new plugin in src/plugins
. _(René Schwaiger)_-p
to create a new plugin based on cpptemplate
.kdb change-resolver-symlink
and kdb change-storage-symlink
referenced the wrong command. _(Lukas Winkler, René Schwaiger)_kdb
and kdb set
now mentions the --
argument that stops processing of command line switches. This is useful for setting negative values among other things. _(Klemens Böswirth)_/tests
(see issue #1887). _(René Schwaiger)_kdb set
commands to ensure we only add tests that store data below /tests
. _(René Schwaiger)_stdout
if you add the check #>
. _(René Schwaiger)_kdb ls
. _(René Schwaiger)_-
in checks as option character any more. _(René Schwaiger)_add_plugin
helper now respects ENABLE_KDB_TESTING
when adding Markdown Shell Recorder tests. _(Lukas Winkler)_kdb find
now removes the configuration file at the end of the test. _(René Schwaiger)_bash
compatible shell anymore. _(René Schwaiger)_SHARED_ONLY
no longer get tested in the script check_kdb_internal_check.sh
if executed with kdb-full or kdb-static. _(Armin Wurzinger)_compare_regex_to_line_files
which allows to compare a file made of regex patterns to be compared with a text file line by line. _(Lukas Winkler)_fcrypt
and crypto
unit tests if the gpg
binary is not available. _(Peter Nirschl)_gpg
tests as the gpg-agents
that were spawned did not get cleaned up afterwards. _(Lukas Winkler)_testkdb_allplugins
) for the semlock
plugin, since the test reported memory leaks on the latest version of Debian Unstable. _(René Schwaiger)_compare_keyset
now supports the comparison of two empty key sets. _(René Schwaiger)_exit_if_fail
now really exits the test progamm if the test fails. _(René Schwaiger)_compare_keyset
that checks if two key sets are equal. _(René Schwaiger)_As written in the previous release notes:
Another important change is:
GTEST_ROOT
to the path of you local copy of the Google Test framework. _(René Schwaiger)_GTEST_ROOT
now respects the environment variable GTEST_ROOT
if it is set. _(Lukas Winkler)_BUILD_SHARED
builds, but to be excluded from any BUILD_FULL
or BUILD_STATIC
builds using the new optional argument ONLY_SHARED
for our CMake macro add_plugin
. This way BUILD_SHARED
can be combined with the other options without excluding such plugins. The CMake messages about plugin inclusion have been updated to indicate this behavior. This behavior has been applied for the Haskell plugins- and bindings and JNI plugin as they currently don't support full or static builds. _(Armin Wurzinger)_testlib_notification
on ASAN enabled builds, since Clang reports that the test leaks memory. _(René Schwaiger)_validation.md
for ASAN builds. It leaks memory and thus fails the test during spec mount. _(Lukas Winkler)_BUILD_FULL
or BUILD_STATIC
as this is currently unsupported. Another issue when building Haskell plugins with a cached sandbox is fixed as well. _(Armin Wurzinger)_BUILD_TESTING=OFF
when spec
or list
plugins are not selected.PROJECT_SOURCE_DIR
, resulting in easier readable coverage reports. _(Lukas Winkler)_add_plugintest
and add_plugin
now also support adding a C++ test instead of a C test. _(René Schwaiger)_add_plugintest
now also supports setting environment variables for C/C++ based tests. _(René Schwaiger)_ftw.h
, if the current build use the compiler switch -Werror
. _(René Schwaiger)_We now ignore warnings about
caused by code generated via SWIG in the Ruby binding and plugin. _(René Schwaiger)_
clang-5.0
is now used for clang tests by the build system _(Lukas Winkler)_withDockerEnv
Jenkinsfile helper now no longer provides stages automatically. _(Lukas Winkler)_STATIC
and FULL
linked builds. _(Lukas Winkler)_clang
tests have been ported to the new build system _(Lukas Winkler et al)_icheck
build server job has been ported to our new build system. _(Lukas Winkler)_elektra-gcc-configure-debian-optimizations
to new build system. _(Lukas Winkler)_elektra-gcc-configure-mingw-w64
to new build system. _(Lukas Winkler)_debian-multiconfig-gcc-stable
to new build system. _(Lukas Winkler)_elektra-ini-mergerequests
to new build system. _(Lukas Winkler)_elektra-gcc-configure-debian-nokdbtest
to new build system. _(Lukas Winkler)_elektra-gcc-configure-xdg
to new build system. _(Lukas Winkler)_elektra-gcc-i386
to new build system. _(Lukas Winkler)_elektra-gcc-configure-debian-musl
to new build system. _(Lukas Winkler)_elektra-gcc-configure-debian-nokdbtest
test. Instead we are now removing write permissions of Elektra's paths to detect if we write to the filesystem even though tests are not tagged as such. _(Lukas Winkler)_elektra-gcc-configure-debian-withspace
test. We now test for compatibility of spaced build paths during normal tests. _(Lukas Winkler)_PLUGINS=NODEP
config. They did not provide any additional coverage. Instead we added a new test checking if PLUGINS=NODEP
builds in an minimal Docker image. _(Lukas Winkler)_master
fails _(Lukas Winkler)_cmake-format
. _(René Schwaiger)_We now specify custom binding, plugin and tool configuration for jobs via the environment variables:
BINDINGS
,PLUGINS
, andTOOLS
. We also added environment variables for the build configuration options BUILD_FULL
, COMMON_FLAGS
, ENABLE_ASAN
and the command used to test the build (TEST_COMMAND
). _(René Schwaiger)_
🍏 Clang ASAN
and 🐧 GCC ASAN
now only build the kdb
tool and the cpp
binding. This update ensures, that we do not hit the job timeout for public repositories that often. _(René Schwaiger)_2.5.1
) to build and test the Ruby binding/plugin. _(René Schwaiger)_As always, the ABI and API of kdb.h is fully compatible, i.e. programs compiled against an older 0.8 version of Elektra will continue to work (ABI) and you will be able to recompile programs without errors (API).
Following changes were made:
delBaseName()
. This does not affect ABI compatibility, also C++ programs compiled against 0.8.24 and using delBaseName()
will work with Elektra 0.8.23 or older.kdbtypes.h
now comes with support for C99 types.kdbnotificationinternal.h
, kdbioplugin.h
. _(Thomas Wahringer)_kdbio
. For example, instead of including elektra/kdbio_ev.h
users of the binding now include elektra/kdbio/ev.h
. _(Thomas Wahringer)_The new plugins are:
The new tool is: kdb-find
The website is generated from the repository, so all information about plugins, bindings and tools are always up-to-date.
We are currently working on following topics:
ksLookup (...)
is now in preparation. The preparation includes a new KeySet flag KS_FLAG_NAME_CHANGE
, this flag will be used by the hybrid search. The hybrid search combines the best properties of the binary search and the OPMPHM. The hybrid search uses a modified branch predictor to predicts KeySet changes and decides if binary search or OPMPHM would be faster. _(Kurt Micheli)_Following persons made in total 1734 commits:
Commits | Author |
---|---|
1 | Mihael Pranjic mpran j@li mun.o rg |
2 | Thomas Waser thoma s.wa ser@l ibel ektra .org |
7 | Michael Zronek micha el.z ronek @gma il.co m |
12 | Kurt Micheli e1026 558@ stude nt.t uwien .ac. at |
17 | Peter Nirschl peter .nir schl@ gmai l.com |
21 | Klemens Böswirth k.boe swir th+gi t@gm ail.c om |
197 | Markus Raab elekt ra@m arkus -raa b.org |
102 | Thomas Wahringer thoma s.wa hring er@l ibele ktra .org |
117 | Daniel Bugl me@om nida n.net |
265 | Lukas Winkler derwi nlu+ git@g mail .com |
249 | Armin Wurzinger e1528 532@ stude nt.t uwien .ac. at |
744 | René Schwaiger sanss ecou rs@me .com |
In total there were 792 files changed with 27677 insertions(+) and 39176 deletions(-).
You can download the release from here or GitHub
The hashsums are:
The release tarball is also available signed by Markus Raab using GnuPG from here or on GitHub
Already built API documentation can be found online or GitHub.
Subscribe to the RSS feed to always get the release notifications.
For any questions and comments, please contact the issue tracker on GitHub or Markus Raab by email using elekt. ra@m arkus -raa b.org
For more information, see https://libelektra.org
Best regards, Elektra Initiative