 |
Elektra 0.11.0
|
|
Elektra 0.11.0
|
The spec plugin is a global plugin that copies metadata from the spec-namespace to other namespaces using their key names as globbing expressions. Globbing resembles regular expressions. They do not have the same expressive power, but are easier to use. The semantics are more suitable to match path names:
* matches any key name of just one hierarchy. This means it complies with any character except slash or null.# matches Elektra array elements. (e.g. #0, #_10, #__987)._ matches anything that * matches, except array elements.The plugin copies the metadata of the corresponding spec key to every matching (see below) key in the other namespaces. The copied metadata is removed again during kdbSet (if remained unchanged).
The spec plugin also provides basic validation and structural checking. Specifically it supports:
_The matching of the spec (globbing) keys to the keys in the other namespaces is based on elektraKeyGlob(), which in turn is based on the well known fnmatch(3). However, there is special handling for array specifications (#) and wildcard specifications (_).
If a spec key has the metakey default set and the key does not exist in other namespaces, we create a key in the default:/ namespace. This key has the default value as its value. We also copy over metadata as always.
Keys which contain a part that is exactly # (e.g. my/#/key or my/#) are called array specifications. These keys are instantiated in order to support default values. If the key does not exist and default is specified in the spec namespace, the key is created in the default namespace. We also lookup the array size (defined by the array metakey) using a cascading ksLookup. This only looks at non-spec namespaces, if we don't find an array size there, we check the array parent in the spec namespace. If we still have no array size, the array is deemed to be empty. For empty arrays, we will simply validate that they are indeed empty.
Keys which contain a part that is exactly _ (e.g. my/_/key or my/_) are called wildcard specifications. It would be nice to have an "instantiation" procedure for _ similar to the one for arrays. However, this is not possible with the current implementation, since there is no way of knowing in advance, which keys matching the globbing expression may be requested via ksLookup.
Instead _ is simply treated like * during matching. Afterwards we check that no array elements were matched.
The basic functionality of the plugin is to just copy (using keyCopyMeta() so we don't waste memory) the metadata of spec keys to all matching (as described above) keys in other namespaces. This ensures that other plugins can do their work as expected, without manually setting metadata on every key. If a metakey on a target key already exists with different value, it gets overridden.
In addition to the basic functionality, the plugin does some validation itself.
If a spec key has the metakey require (the value of this metakey is irrelevant and ignored), we ensure that this key exists in at least one other namespace, i.e. it can be found using a cascading ksLookup. If the key cannot be found, this causes an error.
As hinted to above, we validate array sizes. If a spec key x/# is given, and the spec key x has the metakey array/min or array/max set, we validate the array size (given as metakey array on x) is within the limits of array/min and array/max. Both array/min and array/max have to be valid array-elements similar to array. If the array size is out of bounds, this causes an error for kdbSet or a warning for kdbGet.
Note: We don't actually validate that the array doesn't contain elements above the given array size. This is because it doesn't have anything to do with the specification, whether the array contains additional elements. Note also that we only copy metadata onto elements within the bounds of the array size.
A collision is when two specification keys exist, one as wildcard specification, the other as array specification, and it is not clear in this case what the correct specification is.
The spec plugin does not know what specification to take in this case, so it appends an error or warning (if kdbGet).
In case there is an error or warning, it is appended to the parent key.
If there is an error, the spec plugin returns ELEKTRA_PLUGIN_STATUS_ERROR, otherwise ELEKTRA_PLUGIN_STATUS_SUCCESS.
error is appended to the parent keyThis sample is creating keys and specifications for an application named webserver. The webserver application has a name and a port. In case a port is already in use, there is also an array key alternative_ports which is used to find another port for binding webserver.
A specification could look like this (yaml):
NOTE: 0 and 1 should be #0 and #1, the array elements.
Below is an explanation of each command.
Adding a specification key with a require metakey. This meta-set command should throw error as no key with the name /tests/sw/org/webserver/name exists.
Set the value for user:/tests/sw/org/webserver/name to web1.
Adding a specification key with a default metakey. After this meta-set command a default:/tests/sw/org/webserver/port with value 5000 should exist.
Adding an array key user:/tests/sw/org/webserver/alternative_ports/#0 which value is set to 5001.
Adding an array key user:/tests/sw/org/webserver/alternative_ports/#1 which value is set to 5002.
Adding a metakey array with value 2 at user:/tests/sw/org/webserver/alternative_ports.
Adding a specification metakey description. After this meta-set the all the array entries (#0 and #1) should contain the description.
Check if the description metakey was copied successfully.
Check if the description metakey was copied successfully.
# and _ keys do not work on MINGW_ globbing character 
1.9.1