fix: change exception for a warning as the stack validation can fail because docker is not installed

Author: Carme, Pamy

stackconfig/cli.py

@@ -4,6 +4,7 @@
 
 from stackconfig.stackconfig import StackConfigCompose
 from stackconfig.utils.jinja2_utils import render_jijnja2_compose
+from stackconfig.utils.yaml_utils import remove_files
 
 
 @click.command()
@@ -42,16 +43,20 @@
 @click.option("--version", help="Set valid version for the final docker-compose file", default=None)
 def cli(file, output, j2template=None, j2data=None, version=None):
     try:
+        jinja_files = []
         file = list(set(file))
         if j2template:
             if not j2data:
                 print(
                     "WARNING: No yaml data file should be provided with the data to render the jinja template"
                 )
-            file = file + render_jijnja2_compose(list(set(j2template)), j2data)
+            jinja_files = render_jijnja2_compose(list(set(j2template)), j2data)
+            file = file + jinja_files
         stack_config = StackConfigCompose(file, output, version)
         stack_config.merge_stack_compose()
         print(f"INFO: The docker-compose file was saved in: {output}")
     except Exception as exc:
         print(f"ERROR: {str(exc)}")
         exit(1)
+    finally:
+        remove_files(jinja_files)

stackconfig/stackconfig.py

@@ -4,7 +4,7 @@
 from compose.cli.command import get_config_from_options
 
 
-from stackconfig.utils.yaml_utils import save_compose, load_compose
+from stackconfig.utils.yaml_utils import save_compose, load_compose, remove_files
 from stackconfig.utils.validate_compose import validate_docker_stack_compose
 
 
@@ -30,6 +30,8 @@ def merge_stack_compose(self):
         save_compose(compose_config_str, name_tmp_file, as_text=True)
         self.compose_dict = load_compose(name_tmp_file)
 
+        remove_files(name_tmp_file)
+
         if self.version and isinstance(self.version, str):
             self.compose_dict["version"] = self.version
 

stackconfig/utils/jinja2_utils.py

@@ -3,7 +3,7 @@
 from jinja2.nativetypes import NativeEnvironment
 from jinja2 import Undefined
 
-from stackconfig.utils.yaml_utils import save_compose, load_compose
+from stackconfig.utils.yaml_utils import load_compose
 
 
 def render_jijnja2_compose(templates, data_file=None, data_dict=None, jinja2_env=None):
@@ -36,7 +36,8 @@ def render_jijnja2_compose(templates, data_file=None, data_dict=None, jinja2_env
                 name = f.name
         except Exception as err:
             raise Exception(
-                f"Please be sure the template {template} is valid. Error: {str(err)}. Error-type: {type(err).__name__}"
+                f"Please be sure the template {template} is valid. Error: {str(err)}. Error-type: {type(err).__name__}. "
+                f"Be sure to escape docker syntax. i.e test-{{{{ '{{.Task.ID}}' }}}}"
             )
         template_files.append(name)
     return template_files

stackconfig/utils/validate_compose.py

@@ -1,7 +1,7 @@
 import tempfile
 import subprocess
 
-from stackconfig.utils.yaml_utils import save_compose
+from stackconfig.utils.yaml_utils import save_compose, remove_files
 
 
 def validate_docker_stack_compose(compose_dict):
@@ -15,5 +15,8 @@ def validate_docker_stack_compose(compose_dict):
     result = subprocess.getoutput(
         f"docker stack deploy -c {name_tmp_file} tmp_stack"
     )
+    remove_files([name_tmp_file])
     if "Additional property z_dummy is not allowed" not in result:
-        raise Exception(f"Invalid compose file: Please check {result}")
+        print(f"INFO: docker stack validation failed: {result}. "
+              f"This is only a warning as docker may not be installed or "
+              f"the user doesnt have perms to execute docker cmds.")

stackconfig/utils/yaml_utils.py

@@ -1,4 +1,5 @@
 import yaml
+import os
 
 
 def save_compose(compose_definition, path_to_save, as_text=False):
@@ -30,7 +31,14 @@ def load_compose(compose_path):
         with open(compose_path) as f:
             compose_definition = yaml.safe_load(f)
     except FileNotFoundError:
-        print("WARNING no compose file found at: {}".format(compose_path))
+        print("ERROR: no compose file found at: {}".format(compose_path))
         compose_definition = {}
 
     return compose_definition
+
+
+def remove_files(files_list):
+    if isinstance(files_list, str):
+        files_list = [files_list]
+    for jf in files_list:
+        os.remove(jf)