file_ensure_keys_values

Ensure that the file contains all pairs of "key separator value", with arbitrary separator between each key and its value.

⚙️ Compatible targets: Linux

⚠️ Deprecated: This method is deprecated and should not be used.

Parameters

Name	Documentation
path	File name to edit (absolute path on the target node). This parameter is required.
keys	Name of the dict structure (without "${}") containing the keys (keys of the dict), and values to define (values of the dict). This parameter is required.
separator	Separator between key and value, for example "=" or " " (without the quotes). This parameter can contain only whitespaces. This parameter is required.

Outcome conditions

You need to replace ${path} with its actual canonified value.

✅ Ok: file_ensure_keys_values_${path}_ok
- ☑️ Already compliant: file_ensure_keys_values_${path}_kept
- 🟨 Repaired: file_ensure_keys_values_${path}_repaired
❌ Error: file_ensure_keys_values_${path}_error

Example

method: file_ensure_keys_values
params:
  keys: VALUE
  path: VALUE
  separator: VALUE

Documentation

This method ensures key-value pairs are present in a file.

Usage

This method will iterate over the key-value pairs in the dict, and:

If the key is not defined in the destination, add the key + separator + value line.
If the key is already present in the file, replace the key + separator + anything by key + separator + value

This method always ignores spaces and tabs when replacing (which means for example that key = value will match the = separator).

Keys are considered unique (to allow replacing the value), so you should use file_ensure_lines_present if you want to have multiple lines with the same key.

Example

If you have an initial file (/etc/myfile.conf) containing:

key1 = something
key3 = value3

To define key-value pairs, use the variable_dict or variable_dict_from_file methods.

For example, if you use the following content (stored in /tmp/data.json):

{
   "key1": "value1",
   "key2": "value2"
}

With the following policy:

# Define the `content` variable in the `configuration` prefix from the json file
variable_dict_from_file("configuration", "content", "/tmp/data.json")
# Enforce the presence of the key-value pairs
file_ensure_keys_values("/etc/myfile.conf", "configuration.content", " = ")

The destination file (/etc/myfile.conf) will contain:

key1 = value1
key3 = value3
key2 = value2