Fix facts setting in hostvars fact (#278)

Before this patch, complex variables (lists, dictionaries) were not fully expanded
on old Ansible versions (2.8 or earlier). As a result, it was impossible to use other
variables (e.g. `{{ common_memtx }}` value) in dictionaries and lists in `hosts.yml`.

We are now using the standard `set_fact` mechanism, which solves this problem.

Author: hackallcode

CHANGELOG.md

@@ -10,6 +10,10 @@ Please update `ansible-galaxy install` command in
 README.md to use the newest tag with new release
 -->
 
+### Fixed
+
+- Fix facts setting in `hostvars` fact
+
 ## [1.8.1] - 2021-03-31
 
 ### Fixed

doc/scenario.md

@@ -281,8 +281,7 @@ Some of useful facts are established during preparation, so you can use them at
   for example, in `delegate_to`;
 - `scenario_steps` - description of scenario steps. Each step is a dictionary with fields:
   - `name` - name of step;
-  - `path` - path to YAML file of step;
-- `role_vars` - dictionary with all role variables.
+  - `path` - path to YAML file of step.
 
 ## Role Steps Description
 

library/cartridge_connect_to_membership.py

@@ -27,9 +27,6 @@ def connect_to_membership(params):
     changed = False
 
     for instance_name, instance_vars in hostvars.items():
-        if 'role_vars' in instance_vars:
-            instance_vars = instance_vars['role_vars']
-
         if helpers.is_expelled(instance_vars) or helpers.is_stateboard(instance_vars):
             continue
 

library/cartridge_edit_topology.py

@@ -116,7 +116,7 @@ def get_configured_replicasets(hostvars, play_hosts):
     replicasets = {}
 
     for instance_name in play_hosts:
-        instance_vars = hostvars[instance_name]['role_vars']
+        instance_vars = hostvars[instance_name]
 
         if helpers.is_expelled(instance_vars) or helpers.is_stateboard(instance_vars):
             continue
@@ -144,7 +144,7 @@ def get_instances_to_configure(hostvars, play_hosts):
     instances = {}
 
     for instance_name in play_hosts:
-        instance_vars = hostvars[instance_name]['role_vars']
+        instance_vars = hostvars[instance_name]
 
         if helpers.is_stateboard(instance_vars):
             continue

library/cartridge_get_control_instance.py

@@ -105,7 +105,7 @@ def get_control_instance(params):
 
     if not control_instance_candidates:
         for instance_name in play_hosts:
-            instance_vars = hostvars[instance_name]['role_vars']
+            instance_vars = hostvars[instance_name]
 
             if helpers.is_expelled(instance_vars) or helpers.is_stateboard(instance_vars):
                 continue
@@ -118,8 +118,6 @@ def get_control_instance(params):
         return helpers.ModuleRes(failed=True, msg=errmsg)
 
     advertise_uris = [
-        hostvars[instance_name]['role_vars']['config']['advertise_uri']
-        if 'role_vars' in hostvars[instance_name] else
         hostvars[instance_name]['config']['advertise_uri']
         for instance_name in control_instance_candidates
     ]
@@ -135,8 +133,6 @@ def get_control_instance(params):
     # instance_vars['instance_info'], but if control instance is not
     # in play_hosts, instance_info isn't computed for it
     instance_vars = hostvars[control_instance_name]
-    if 'role_vars' in instance_vars:
-        instance_vars = instance_vars['role_vars']
     run_dir = instance_vars.get('cartridge_run_dir', helpers.DEFAULT_RUN_DIR)
     control_instance_console_sock = helpers.get_instance_console_sock(
         run_dir, app_name, control_instance_name,

library/cartridge_get_not_expelled_instance.py

@@ -15,7 +15,7 @@ def get_one_not_expelled_instance(params):
     not_expelled_instance_name = None
 
     for instance_name in play_hosts:
-        instance_vars = hostvars[instance_name]['role_vars']
+        instance_vars = hostvars[instance_name]
         if helpers.is_expelled(instance_vars) or helpers.is_stateboard(instance_vars):
             continue
 

library/cartridge_get_single_instances_for_each_machine.py

@@ -25,7 +25,7 @@ def get_one_not_expelled_instance_for_machine(params):
     for instance_name in play_hosts:
         instance_vars = hostvars[instance_name]
 
-        if helpers.is_expelled(instance_vars['role_vars']):
+        if helpers.is_expelled(instance_vars):
             continue
 
         machine_hostname = get_machine_hostname(instance_vars, instance_name)

library/cartridge_validate_config.py

@@ -104,12 +104,8 @@ def check_schema(schema, conf, path=''):
                 return errmsg
         return None
     elif isinstance(schema, type):
-        if schema in [float, int]:
-            if not (isinstance(conf, float) or isinstance(conf, int)):
-                return '{} must be {}'.format(path, schema)
-        else:
-            if not isinstance(conf, schema):
-                return '{} must be {}'.format(path, schema)
+        if not isinstance(conf, schema):
+            return '{} must be {}'.format(path, schema)
         return None
     else:
         return 'Wrong type'
@@ -217,13 +213,13 @@ def check_cluster_cookie_symbols(cluster_cookie):
     return None
 
 
-def check_required_params(role_vars, host):
+def check_required_params(instance_vars, host):
     for p in INSTANCE_REQUIRED_PARAMS:
-        if role_vars.get(p) is None:
+        if instance_vars.get(p) is None:
             errmsg = '"{}" must be specified (missed for "{}")'.format(p, host)
             return errmsg
 
-    errmsg = check_cluster_cookie_symbols(role_vars['cartridge_cluster_cookie'])
+    errmsg = check_cluster_cookie_symbols(instance_vars['cartridge_cluster_cookie'])
     if errmsg is not None:
         return errmsg
 
@@ -251,29 +247,29 @@ def check_instance_config(config, host):
     return None
 
 
-def check_params_the_same_for_all_hosts(role_vars, found_common_params):
+def check_params_the_same_for_all_hosts(instance_vars, found_common_params):
     for p in PARAMS_THE_SAME_FOR_ALL_HOSTS:
         if found_common_params.get(p) is not None:
-            if role_vars.get(p) != found_common_params.get(p):
+            if instance_vars.get(p) != found_common_params.get(p):
                 errmsg = '"{}" must be the same for all hosts'.format(p)
                 return errmsg
-        elif role_vars.get(p) is not None:
-            found_common_params[p] = role_vars.get(p)
+        elif instance_vars.get(p) is not None:
+            found_common_params[p] = instance_vars.get(p)
 
     return None
 
 
-def check_replicaset(role_vars, found_replicasets):
-    if 'replicaset_alias' not in role_vars:
+def check_replicaset(instance_vars, found_replicasets):
+    if 'replicaset_alias' not in instance_vars:
         return None
 
-    replicaset_alias = role_vars['replicaset_alias']
+    replicaset_alias = instance_vars['replicaset_alias']
 
-    replicaset = {p: role_vars.get(p) for p in REPLICASET_PARAMS}
+    replicaset = {p: instance_vars.get(p) for p in REPLICASET_PARAMS}
 
     if replicaset_alias not in found_replicasets:
         for p in REPLICASET_REQUIRED_PARAMS:
-            if p not in role_vars:
+            if p not in instance_vars:
                 errmsg = 'Parameter "{}" is required for all replicasets (missed for "{}")'.format(
                     p, replicaset_alias
                 )
@@ -483,53 +479,53 @@ def validate_config(params):
     warnings = []
 
     for host in params['hosts']:
-        role_vars = params['hostvars'][host]['role_vars']
+        instance_vars = params['hostvars'][host]
 
         # Validate types
-        errmsg = validate_types(role_vars)
+        errmsg = validate_types(instance_vars)
         if errmsg is not None:
             return helpers.ModuleRes(failed=True, msg=errmsg)
 
-        if role_vars.get('stateboard') is True:
-            errmsg = check_stateboard(role_vars)
+        if instance_vars.get('stateboard') is True:
+            errmsg = check_stateboard(instance_vars)
             if errmsg is not None:
                 return helpers.ModuleRes(failed=True, msg=errmsg)
             continue
 
         # All required params should be specified
-        errmsg = check_required_params(role_vars, host)
+        errmsg = check_required_params(instance_vars, host)
         if errmsg is not None:
             return helpers.ModuleRes(failed=True, msg=errmsg)
 
         # Instance config
-        errmsg = check_instance_config(role_vars['config'], host)
+        errmsg = check_instance_config(instance_vars['config'], host)
         if errmsg is not None:
             return helpers.ModuleRes(failed=True, msg=errmsg)
 
         # Params common for all instances
-        errmsg = check_params_the_same_for_all_hosts(role_vars, found_common_params)
+        errmsg = check_params_the_same_for_all_hosts(instance_vars, found_common_params)
         if errmsg is not None:
             return helpers.ModuleRes(failed=True, msg=errmsg)
 
         # Cartridge defaults
-        if 'cartridge_defaults' in role_vars:
-            if 'cluster_cookie' in role_vars['cartridge_defaults']:
+        if 'cartridge_defaults' in instance_vars:
+            if 'cluster_cookie' in instance_vars['cartridge_defaults']:
                 errmsg = 'Cluster cookie must be specified in "cartridge_cluster_cookie", not in "cartridge_defaults"'
                 return helpers.ModuleRes(failed=True, msg=errmsg)
 
         # Instance state
-        if role_vars.get('expelled') is True and role_vars.get('restarted') is True:
+        if instance_vars.get('expelled') is True and instance_vars.get('restarted') is True:
             errmsg = 'Flags "expelled" and "restarted" cannot be set at the same time'
             return helpers.ModuleRes(failed=True, msg=errmsg)
 
         # Replicasets
-        errmsg = check_replicaset(role_vars, found_replicasets)
+        errmsg = check_replicaset(instance_vars, found_replicasets)
         if errmsg is not None:
             return helpers.ModuleRes(failed=True, msg=errmsg)
 
         # Dist retention
-        if 'cartridge_keep_num_latest_dists' in role_vars:
-            keep_num_latest_dists = role_vars['cartridge_keep_num_latest_dists']
+        if 'cartridge_keep_num_latest_dists' in instance_vars:
+            keep_num_latest_dists = instance_vars['cartridge_keep_num_latest_dists']
             if keep_num_latest_dists <= 0:
                 errmsg = '"cartridge_keep_num_latest_dists" should be greater than 0'
                 return helpers.ModuleRes(failed=True, msg=errmsg)

molecule/common/tests/test_cluster.py

@@ -147,6 +147,9 @@ def test_services_status_and_config(host):
         instance_vars = variable_manager.get_vars(host=instance)
 
         instance_conf = instance_vars['config']
+        if instance_conf.get('memtx_memory') == '{{ common_memtx_memory }}':
+            instance_conf['memtx_memory'] = 268436000
+
         instance_name = instance_vars['inventory_hostname']
 
         conf_dir = instance_vars.get('cartridge_conf_dir', '/etc/tarantool/conf.d')

molecule/default/hosts.yml

@@ -12,6 +12,8 @@ all:
         # common cartridge opts
         cartridge_app_name: ['incorrect type to check playbook vars']
         cartridge_cluster_cookie: secret-cookie
+
+        common_memtx_memory: 268436000
         cartridge_defaults:
           some_option: 'default value'
 
@@ -82,7 +84,7 @@ all:
           config:
             advertise_uri: 'vm2:3201'
             http_port: 8201
-            memtx_memory: 268436000
+            memtx_memory: '{{ common_memtx_memory }}'
           instance_start_timeout: 120
           instance_discover_buckets_timeout: 120