Enhancement | Catch and handle HCL parsing errors (#296)

* catch hcl parsing errors

* unnecessary

* Update leverage/modules/auth.py

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* black

* fix test

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Author: Franr

leverage/__init__.py

@@ -1,6 +1,7 @@
 """
     Binbash Leverage Command-line tool.
 """
+
 # pylint: disable=wrong-import-position
 
 __version__ = "0.0.0"

leverage/_internals.py

@@ -1,6 +1,7 @@
 """
 	Definitions for internal use of the cli.
 """
+
 from functools import wraps
 
 import click

leverage/_utils.py

@@ -1,9 +1,13 @@
 """
     General use utilities.
 """
+
+from pathlib import Path
 from subprocess import run
 from subprocess import PIPE
 
+import hcl2
+import lark
 from click.exceptions import Exit
 from configupdater import ConfigUpdater
 from docker import DockerClient
@@ -112,6 +116,20 @@ def __init__(self, exit_code: int, error_description: str):
         super(ExitError, self).__init__(exit_code)
 
 
+def parse_tf_file(file: Path):
+    """
+    Open and parse an HCL file.
+    In case of a parsing error, raise a user-friendly error.
+    """
+    with open(file) as f:
+        try:
+            parsed = hcl2.load(f)
+        except lark.exceptions.UnexpectedInput:
+            raise ExitError(1, f"There is a parsing error with the {f.name} file. Please review it.")
+        else:
+            return parsed
+
+
 class ContainerSession:
     """
     Handle the start/stop cycle of a container.

leverage/conf.py

@@ -1,6 +1,7 @@
 """
     Env variables loading utility.
 """
+
 from pathlib import Path
 
 from yaenv.core import Env

leverage/leverage.py

@@ -1,6 +1,7 @@
 """
     Binbash Leverage Command-line tool.
 """
+
 import click
 
 from leverage import __version__

leverage/logger.py

@@ -1,6 +1,7 @@
 """
     Logging utilities.
 """
+
 import logging
 from functools import wraps
 

leverage/modules/auth.py

@@ -2,13 +2,12 @@
 from pathlib import Path
 from configparser import NoSectionError, NoOptionError
 
-import hcl2
 import boto3
-from configupdater import ConfigUpdater
 from botocore.exceptions import ClientError
+from configupdater import ConfigUpdater
 
 from leverage import logger
-from leverage._utils import key_finder, ExitError, get_or_create_section
+from leverage._utils import key_finder, ExitError, get_or_create_section, parse_tf_file
 
 
 class SkipProfile(Exception):
@@ -66,8 +65,7 @@ def get_profiles(cli):
     # these are files from the layer we are currently on
     for name in ("config.tf", "locals.tf"):
         try:
-            with open(name) as tf_file:
-                tf_config = hcl2.load(tf_file)
+            tf_config = parse_tf_file(Path(name))
         except FileNotFoundError:
             continue
 
@@ -76,8 +74,7 @@ def get_profiles(cli):
         raw_profiles.update(set(key_finder(tf_config, "profile", "lookup")))
 
     # the profile value from <layer>/config/backend.tfvars
-    with open(cli.paths.local_backend_tfvars) as backend_config_file:
-        backend_config = hcl2.load(backend_config_file)
+    backend_config = parse_tf_file(cli.paths.local_backend_tfvars)
     tf_profile = backend_config["profile"]
 
     return tf_profile, raw_profiles

leverage/modules/credentials.py

@@ -1,6 +1,7 @@
 """
     Credentials managing module.
 """
+
 import csv
 import json
 import re

leverage/modules/project.py

@@ -1,6 +1,7 @@
 """
     Module for managing Leverage projects.
 """
+
 import re
 from pathlib import Path
 from shutil import copy2

leverage/modules/run.py

@@ -1,6 +1,7 @@
 """
     Tasks running module.
 """
+
 import re
 
 import click