Add black

.github/workflows/lint.yml

@@ -0,0 +1,21 @@
+name: Lint
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3.5.2
+
+      - name: Run linter
+        uses: psf/black@stable
+        with:
+          options: "--check --verbose"
+          version: "23.3.0"

glitch/__main__.py

@@ -16,55 +16,110 @@
 
 # NOTE: These are necessary in order for python to load the visitors.
 # Otherwise, python will not consider these types of rules.
-from glitch.analysis.design import DesignVisitor 
+from glitch.analysis.design import DesignVisitor
 from glitch.analysis.security import SecurityVisitor
 
+
 def parse_and_check(type, path, module, parser, analyses, errors, stats):
     inter = parser.parse(path, type, module)
     if inter != None:
         for analysis in analyses:
             errors += analysis.check(inter)
     stats.compute(inter)
 
+
 @click.command(
     help="PATH is the file or folder to analyze. OUTPUT is an optional file to which we can redirect the smells output."
 )
-@click.option('--tech',
-        type=click.Choice(Tech), required=True,
-        help="The IaC technology in which the scripts analyzed are written in.")
-@click.option('--tableformat',
-        type=click.Choice(("prettytable", "latex")), required=False, default="prettytable",
-        help="The presentation format of the tables that show stats about the run.")
-@click.option('--type',
-        type=click.Choice(UnitBlockType), default=UnitBlockType.unknown,
-        help="The type of scripts being analyzed.")
-@click.option('--config', type=click.Path(), default="configs/default.ini",
-    help="The path for a config file. Otherwise the default config will be used.")
-@click.option('--module', is_flag=True, default=False,
-    help="Use this flag if the folder you are going to analyze is a module (e.g. Chef cookbook).")
-@click.option('--dataset', is_flag=True, default=False,
-    help="Use this flag if the folder being analyzed is a dataset. A dataset is a folder with subfolders to be analyzed.")
-@click.option('--linter', is_flag=True, default=False,
-    help="This flag changes the output to be more usable for other interfaces, such as, extensions for code editors.")
-@click.option('--includeall', multiple=True,
-    help="Some files are ignored when analyzing a folder. For instance, sometimes only some" 
-         "folders in the folder structure are considered. Use this option if"
-         "you want to analyze all the files with a certain extension inside a folder. (e.g. --includeall yml)" 
-         "This flag is only relevant if you are using the dataset flag.")
-@click.option('--csv', is_flag=True, default=False,
-    help="Use this flag if you want the output to be in CSV format.")
-@click.option('--smell_types', cls=RulesListOption, multiple=True, 
-    help="The type of smell_types being analyzed.")
-@click.argument('path', type=click.Path(exists=True), required=True)
-@click.argument('output', type=click.Path(), required=False)
-def glitch(tech, type, path, config, module, csv, 
-        dataset, includeall, smell_types, output, tableformat, linter):
+@click.option(
+    "--tech",
+    type=click.Choice(Tech),
+    required=True,
+    help="The IaC technology in which the scripts analyzed are written in.",
+)
+@click.option(
+    "--tableformat",
+    type=click.Choice(("prettytable", "latex")),
+    required=False,
+    default="prettytable",
+    help="The presentation format of the tables that show stats about the run.",
+)
+@click.option(
+    "--type",
+    type=click.Choice(UnitBlockType),
+    default=UnitBlockType.unknown,
+    help="The type of scripts being analyzed.",
+)
+@click.option(
+    "--config",
+    type=click.Path(),
+    default="configs/default.ini",
+    help="The path for a config file. Otherwise the default config will be used.",
+)
+@click.option(
+    "--module",
+    is_flag=True,
+    default=False,
+    help="Use this flag if the folder you are going to analyze is a module (e.g. Chef cookbook).",
+)
+@click.option(
+    "--dataset",
+    is_flag=True,
+    default=False,
+    help="Use this flag if the folder being analyzed is a dataset. A dataset is a folder with subfolders to be analyzed.",
+)
+@click.option(
+    "--linter",
+    is_flag=True,
+    default=False,
+    help="This flag changes the output to be more usable for other interfaces, such as, extensions for code editors.",
+)
+@click.option(
+    "--includeall",
+    multiple=True,
+    help="Some files are ignored when analyzing a folder. For instance, sometimes only some"
+    "folders in the folder structure are considered. Use this option if"
+    "you want to analyze all the files with a certain extension inside a folder. (e.g. --includeall yml)"
+    "This flag is only relevant if you are using the dataset flag.",
+)
+@click.option(
+    "--csv",
+    is_flag=True,
+    default=False,
+    help="Use this flag if you want the output to be in CSV format.",
+)
+@click.option(
+    "--smell_types",
+    cls=RulesListOption,
+    multiple=True,
+    help="The type of smell_types being analyzed.",
+)
+@click.argument("path", type=click.Path(exists=True), required=True)
+@click.argument("output", type=click.Path(), required=False)
+def glitch(
+    tech,
+    type,
+    path,
+    config,
+    module,
+    csv,
+    dataset,
+    includeall,
+    smell_types,
+    output,
+    tableformat,
+    linter,
+):
     if config != "configs/default.ini" and not os.path.exists(config):
-        raise click.BadOptionUsage('config', f"Invalid value for 'config': Path '{config}' does not exist.")
+        raise click.BadOptionUsage(
+            "config", f"Invalid value for 'config': Path '{config}' does not exist."
+        )
     elif os.path.isdir(config):
-        raise click.BadOptionUsage('config', f"Invalid value for 'config': Path '{config}' should be a file.")
+        raise click.BadOptionUsage(
+            "config", f"Invalid value for 'config': Path '{config}' should be a file."
+        )
     elif config == "configs/default.ini":
-        config = resource_filename('glitch', "configs/default.ini")
+        config = resource_filename("glitch", "configs/default.ini")
 
     parser = None
     if tech == Tech.ansible:
@@ -77,7 +132,7 @@ def glitch(tech, type, path, config, module, csv,
         parser = DockerParser()
     elif tech == Tech.terraform:
         parser = TerraformParser()
-        config = resource_filename('glitch', "configs/terraform.ini")
+        config = resource_filename("glitch", "configs/terraform.ini")
     file_stats = FileStats()
 
     if smell_types == ():
@@ -97,55 +152,68 @@ def glitch(tech, type, path, config, module, csv,
             iac_files = []
             for root, _, files in os.walk(path):
                 for name in files:
-                    name_split = name.split('.')
-                    if name_split[-1] in includeall \
-                            and not Path(os.path.join(root, name)).is_symlink():
+                    name_split = name.split(".")
+                    if (
+                        name_split[-1] in includeall
+                        and not Path(os.path.join(root, name)).is_symlink()
+                    ):
                         iac_files.append(os.path.join(root, name))
             iac_files = set(iac_files)
 
-            with alive_bar(len(iac_files), 
-                    title=f"ANALYZING ALL FILES WITH EXTENSIONS {includeall}") as bar:
+            with alive_bar(
+                len(iac_files),
+                title=f"ANALYZING ALL FILES WITH EXTENSIONS {includeall}",
+            ) as bar:
                 for file in iac_files:
-                    parse_and_check(type, file, module, parser, analyses, errors, file_stats)
+                    parse_and_check(
+                        type, file, module, parser, analyses, errors, file_stats
+                    )
                     bar()
         else:
             subfolders = [f.path for f in os.scandir(f"{path}") if f.is_dir()]
             with alive_bar(len(subfolders), title="ANALYZING SUBFOLDERS") as bar:
                 for d in subfolders:
-                    parse_and_check(type, d, module, parser, analyses, errors, file_stats)
+                    parse_and_check(
+                        type, d, module, parser, analyses, errors, file_stats
+                    )
                     bar()
 
         files = [f.path for f in os.scandir(f"{path}") if f.is_file()]
 
         with alive_bar(len(files), title="ANALYZING FILES IN ROOT FOLDER") as bar:
             for file in files:
-                parse_and_check(type, file, module, parser, analyses, errors, file_stats)
+                parse_and_check(
+                    type, file, module, parser, analyses, errors, file_stats
+                )
                 bar()
-    else:         
+    else:
         parse_and_check(type, path, module, parser, analyses, errors, file_stats)
-    
+
     errors = sorted(set(errors), key=lambda e: (e.path, e.line, e.code))
-    
+
     if output is None:
         f = sys.stdout
     else:
         f = open(output, "w")
 
     if linter:
         for error in errors:
-            print(Error.ALL_ERRORS[error.code] + "," + error.to_csv(), file = f)
+            print(Error.ALL_ERRORS[error.code] + "," + error.to_csv(), file=f)
     elif csv:
         for error in errors:
-            print(error.to_csv(), file = f)
+            print(error.to_csv(), file=f)
     else:
         for error in errors:
-            print(error, file = f)
+            print(error, file=f)
 
-    if f != sys.stdout: f.close()
+    if f != sys.stdout:
+        f.close()
     if not linter:
         print_stats(errors, get_smells(smell_types, tech), file_stats, tableformat)
 
+
 def main():
-    glitch(prog_name='glitch')
+    glitch(prog_name="glitch")
+
 
 main()