Add consistency test for validate config facts (#403)

Before this patch, it was easy to forget to add new facts
to the `validate_config` step.

Now there is a test for it.

Author: hackallcode

consistency/test_facts.py

@@ -1,9 +1,16 @@
 import os
 import re
+import sys
 import unittest
 
 import yaml
 
+import module_utils.helpers as helpers
+
+sys.modules['ansible.module_utils.helpers'] = helpers
+import library.cartridge_validate_config as validate_config
+import unit.test_validate_config as test_validate_config
+
 
 # This tests protects against inattentive people, who do not completely change the variables list
 
@@ -17,6 +24,7 @@ def setUp(self):
         with open(self.defaults_file, 'r') as f:
             try:
                 self.defaults = yaml.safe_load(f)
+                self.cached_facts_names = self.defaults['cartridge_cached_fact_names_by_target']
             except yaml.YAMLError as e:
                 self.fail("Impossible to parse 'defaults/main.yml': %s" % e)
 
@@ -32,6 +40,14 @@ def setUp(self):
             text = f.read()
             self.doc_facts = re.findall(r'\n[*-][^`]*`([^`]+)`', text)
 
+        self.validate_config_facts = list(validate_config.SCHEMA.keys())
+
+        self.test_validate_config_facts = set()
+        for params in test_validate_config.PARAMS_BY_TYPES.values():
+            for param in params:
+                self.test_validate_config_facts.add(param.split('.')[0].split('[')[0])
+        self.test_validate_config_facts = list(self.test_validate_config_facts)
+
         self.not_user_facts = [
             # Role defaults
             'cartridge_role_scenarios',
@@ -73,3 +89,28 @@ def test_doc_facts(self):
             sorted(default_names), sorted(self.doc_facts + self.not_user_facts),
             'List of facts in defaults and in documentation is different',
         )
+
+    # If someone added a variable to defaults, but forgot to add it to validate config
+    def test_validate_config_facts(self):
+        default_names = list(self.defaults.keys())
+
+        self.assertEqual(
+            sorted(default_names), sorted(self.validate_config_facts + self.not_user_facts),
+            'List of facts in defaults and in validate config step is different',
+        )
+
+    # If someone added a variable to validate config step, but forgot to add it to cached facts list
+    def test_validate_config_cached_facts(self):
+        cached_facts_names = self.cached_facts_names['validate_config']
+
+        self.assertEqual(
+            sorted(self.validate_config_facts), sorted(cached_facts_names),
+            'List of facts in cached facts and in validate config step is different',
+        )
+
+    # If someone added a variable to validate config step, but forgot to add it to test of validate config
+    def test_validate_config_test_facts(self):
+        self.assertEqual(
+            sorted(self.validate_config_facts), sorted(self.test_validate_config_facts),
+            'List of facts in validate config step and in test of this step is different',
+        )

defaults/main.yml

@@ -316,6 +316,17 @@ cartridge_cached_fact_names_by_target:
     - cartridge_force_restore
     - cartridge_allow_alien_backup
     - cartridge_skip_cleanup_on_restore
+    - cartridge_app_config_path
+    - cartridge_app_config_upload_http_timeout
+    - cartridge_app_config_upload_mode
+    - cartridge_app_config_upload_url
+    - cartridge_create_user_group_for_tgz
+    - cartridge_force_advertise_uris_change
+    - cartridge_force_leader_control_instance
+    - cartridge_ignore_extra_cluster_instances
+    - cartridge_ignore_extra_cluster_replicasets
+    - cartridge_ignore_renamed_replicasets
+    - cartridge_tdg_token
   count_disabled_instances:
     - instance_info
     - disabled

library/cartridge_validate_config.py

@@ -34,6 +34,17 @@
     'edit_topology_timeout',
     'edit_topology_healthy_timeout',
     'edit_topology_allow_missed_instances',
+    'cartridge_app_config_path',
+    'cartridge_app_config_upload_http_timeout',
+    'cartridge_app_config_upload_mode',
+    'cartridge_app_config_upload_url',
+    'cartridge_create_user_group_for_tgz',
+    'cartridge_force_advertise_uris_change',
+    'cartridge_force_leader_control_instance',
+    'cartridge_ignore_extra_cluster_instances',
+    'cartridge_ignore_extra_cluster_replicasets',
+    'cartridge_ignore_renamed_replicasets',
+    'cartridge_tdg_token',
 ]
 
 CONFIG_REQUIRED_PARAMS = ['advertise_uri']
@@ -223,6 +234,17 @@
     'show_issues': bool,
     'wait_cluster_has_no_issues_retries': int,
     'wait_cluster_has_no_issues_delay': int,
+    'cartridge_app_config_path': str,
+    'cartridge_app_config_upload_http_timeout': int,
+    'cartridge_app_config_upload_mode': str,
+    'cartridge_app_config_upload_url': str,
+    'cartridge_create_user_group_for_tgz': bool,
+    'cartridge_force_advertise_uris_change': bool,
+    'cartridge_force_leader_control_instance': bool,
+    'cartridge_ignore_extra_cluster_instances': bool,
+    'cartridge_ignore_extra_cluster_replicasets': bool,
+    'cartridge_ignore_renamed_replicasets': bool,
+    'cartridge_tdg_token': str,
 }