Rename the --sheet option to --model #1524

Signed-off-by: tdruez <[email protected]>

docs/command-line-interface.rst

@@ -396,15 +396,15 @@ your outputs on the host machine when running with Docker.
 
 .. _cli_report:
 
-`$ scanpipe report --sheet SHEET`
+`$ scanpipe report --model MODEL`
 ---------------------------------
 
 Generates an XLSX report of selected projects based on the provided criteria.
 
 Required arguments:
 
-- ``--sheet {package,dependency,resource,relation,message,todo}``
-  Specifies the sheet to include in the XLSX report. Available choices are based on
+- ``--model {package,dependency,resource,relation,message,todo}``
+  Specifies the model to include in the XLSX report. Available choices are based on
   predefined object types.
 
 Optional arguments:
@@ -428,12 +428,12 @@ Example usage:
 1. Generate a report for all projects tagged with "d2d" and include the **TODOS**
 worksheet::
 
-   $ scanpipe report --sheet todo --label d2d
+   $ scanpipe report --model todo --label d2d
 
 2. Generate a report for projects whose names contain the word "audit" and include the
 **PACKAGES** worksheet::
 
-   $ scanpipe report --sheet package --search audit
+   $ scanpipe report --model package --search audit
 
 .. _cli_check_compliance:
 

scanpipe/management/commands/report.py

@@ -46,10 +46,10 @@ def add_arguments(self, parser):
             ),
         )
         parser.add_argument(
-            "--sheet",
+            "--model",
             required=True,
             choices=list(output.object_type_to_model_name.keys()),
-            help="Specifies the sheet to include in the XLSX report.",
+            help="Specifies the model to include in the XLSX report.",
         )
         parser.add_argument(
             "--search",
@@ -73,7 +73,7 @@ def handle(self, *args, **options):
         output_directory = options["output_directory"]
         labels = options["labels"]
         search = options["search"]
-        sheet = options["sheet"]
+        model = options["model"]
 
         if not (labels or search):
             raise CommandError(
@@ -100,7 +100,7 @@ def handle(self, *args, **options):
         else:
             output_file = Path(filename)
 
-        output_file = output.get_xlsx_report(project_qs, sheet, output_file)
+        output_file = output.get_xlsx_report(project_qs, model, output_file)
 
         run_time = timer() - start_time
         if self.verbosity > 0:

scanpipe/tests/pipes/test_output.py

@@ -260,6 +260,7 @@ def test_scanpipe_pipes_outputs_get_xlsx_report(self):
 
         model_short_name = "todo"
         output_file = output.get_xlsx_report(project_qs, model_short_name)
+        workbook = openpyxl.load_workbook(output_file, read_only=True, data_only=True)
         expected_sheet_names = [
             "TODOS",
         ]

scanpipe/tests/test_commands.py

@@ -1104,16 +1104,16 @@ def test_scanpipe_management_command_report(self):
         make_resource_file(project1, path="file.ext", status=flag.REQUIRES_REVIEW)
         make_project("project2")
 
-        expected = "Error: the following arguments are required: --sheet"
+        expected = "Error: the following arguments are required: --model"
         with self.assertRaisesMessage(CommandError, expected):
             call_command("report")
 
-        options = ["--sheet", "UNKNOWN"]
-        expected = "Error: argument --sheet: invalid choice: 'UNKNOWN'"
+        options = ["--model", "UNKNOWN"]
+        expected = "Error: argument --model: invalid choice: 'UNKNOWN'"
         with self.assertRaisesMessage(CommandError, expected):
             call_command("report", *options)
 
-        options = ["--sheet", "todo"]
+        options = ["--model", "todo"]
         expected = "You must provide either --label or --search to select projects."
         with self.assertRaisesMessage(CommandError, expected):
             call_command("report", *options)