Merge pull request #154 from strictdoc-project/stanislaw/examples

examples/04_convert_reqif_to_json: --stdout parameter

Author: stanislaw

tests/integration/examples/04_convert_reqif_to_json/expected/output.json

@@ -23,4 +23,4 @@
         "ReqIF.Text",
         "Status"
     ]
-}
+}

tests/integration/examples/04_convert_reqif_to_json/script.py

@@ -187,28 +187,51 @@ def main():
         "input_file", type=str, help="Path to the input ReqIF file."
     )
     main_parser.add_argument(
-        "output_dir", type=str, help="Path to the output dir."
+        "--output-dir",
+        type=str,
+        help="Path to the output dir.",
+        default="output/",
+    )
+    main_parser.add_argument(
+        "--stdout",
+        help="Makes the script write the output ReqIF to standard output.",
+        action="store_true",
+    )
+    main_parser.add_argument(
+        "--no-filesystem",
+        help=(
+            "Disables writing to the file system. "
+            "Should be used in combination with --stdout."
+        ),
+        action="store_true",
     )
 
     args = main_parser.parse_args()
     input_file: str = args.input_file
+    should_use_file_system: bool = not args.no_filesystem
+    should_use_stdout: bool = args.stdout
+
     if input_file.endswith(".reqifz"):
         reqifz_bundle: ReqIFZBundle = ReqIFZParser.parse(input_file)
         assert len(reqifz_bundle.reqif_bundles) == 1
         reqif_bundle = (list(reqifz_bundle.reqif_bundles.values()))[0]
     else:
         reqif_bundle = ReqIFParser.parse(input_file)
 
-    path_to_output_dir = args.output_dir
-    Path(path_to_output_dir).mkdir(exist_ok=True)
-
     req_dict = ReqIFToDictConverter.convert(reqif_bundle)
+    reqif_json = json.dumps(req_dict.get_as_dict(), indent=4)
 
-    path_to_output_file = os.path.join(path_to_output_dir, "output.json")
-    with open(path_to_output_file, "w", encoding="utf8") as json_file:
-        json.dump(
-            req_dict.get_as_dict(), json_file, ensure_ascii=False, indent=4
-        )
+    if should_use_file_system:
+        path_to_output_dir = args.output_dir
+        Path(path_to_output_dir).mkdir(exist_ok=True)
+
+        path_to_output_file = os.path.join(path_to_output_dir, "output.json")
+        with open(path_to_output_file, "w", encoding="utf8") as json_file:
+            json_file.write(reqif_json)
+            json_file.write("\n")
+
+    if should_use_stdout:
+        print(reqif_json)  # noqa: T201
 
 
 main()

tests/integration/examples/04_convert_reqif_to_json/test.itest

@@ -2,10 +2,14 @@ RUN: mkdir -p %S/Output
 RUN: %reqif passthrough %S/sample.reqif %S/Output/sample.reqif
 RUN: %diff %S/sample.reqif %S/Output/sample.reqif
 
-RUN: python %S/script.py %S/sample.reqif %S/Output/reqif
+RUN: python %S/script.py %S/sample.reqif --output-dir %S/Output/reqif
 RUN: %diff %S/expected/output.json %S/Output/reqif/output.json
 
-RUN: python %S/script.py %S/sample.reqifz %S/Output/reqifz
+RUN: mkdir %S/Output/reqif_stdout
+RUN: python %S/script.py %S/sample.reqif --stdout --no-filesystem | tee %S/Output/reqif_stdout/output.json
+RUN: %diff %S/expected/output.json %S/Output/reqif_stdout/output.json
+
+RUN: python %S/script.py %S/sample.reqifz --output-dir %S/Output/reqifz
 RUN: %diff %S/expected/output.json %S/Output/reqifz/output.json
 
 TODO: