Merge branch 'topic/log_files' into 'master'

Improve the replay.py script

See merge request eng/ide/ada_language_server!1418

Author: AnthonyLeonardoGracio

README.md

@@ -144,6 +144,8 @@ formatting might no succeed on incomplete/illegal code.
 
 You can use the VS Code `Issue Reporter` to report issues. Just click on the `Help -> Report Issue` menu, select `An extension` for the `File on` entry and `Language Support for Ada` for the extension name. Put as many information you can in the description, like steps to reproduce, stacktraces or system information (VS Code automatically includes it by default). This will create a GitHub issue in the [Ada Language Server](https://github.com/AdaCore/ada_language_server/) repository.
 
+ALS log files can be found under the `~/.als` directory (`%USERPROFILE%/.als` on Windows). Feel free to attach them on the issues, it helps a lot for further investigation, specially when the `ALS.IN` and `ALS.OUT` traces are enabled (more info about traces configuration can be found [here](doc/traces.md).)
+
 
 ### Getting started
 

scripts/replay.py

@@ -1,25 +1,44 @@
 #!/usr/bin/env python
 
-""" Development utility to replay the most recent trace file, and output it
-as protocol strings. This assumes that the trace file is in ~/.als/in.txt
-
-To use this, do
-
-   replay.py > log
-
-then you can replay at will with
+"""
+Development utility to replay an ALS session based on a log file containing
+the ALS.IN and ALS.OUT traces, and output it as protocol strings.
 
-  ada_language_server < log
+Usage: replay.py --log-file <path_to_log_file> --output-file <output_file>
 """
 
-import os
+import argparse
 from json_transformations import python_to_protocol_string, traces_to_test
 
-als_dir = os.path.join(os.path.expanduser('~'), '.als')
-inout_file = os.path.join(als_dir, 'inout.txt')
+
+argParser = argparse.ArgumentParser()
+argParser.add_argument(
+    "-l",
+    "--log-file",
+    help="Path to the log file containing ALS.IN and ALS.OUT traces.",
+    required=True,
+)
+argParser.add_argument(
+    "-o",
+    "--output-file",
+    help="Path to the output file containing all the ALS requests retrieved "
+    + "from the log file. Then you can replay a session like this: "
+    + "ada_language_server < <output_file>",
+    required=False,
+)
+args = argParser.parse_args()
+
+inout_file = args.log_file
+output_file = args.output_file
 test = traces_to_test(inout_file, None, True)
 result = ""
 for x in test:
     if "send" in x:
         result += python_to_protocol_string([x["send"]["request"]])
-print(result + "\r")
+
+# Print on stdout if no output file has been specified
+if output_file:
+    with open(output_file, "w") as file:
+        file.write(result + "\r")
+else:
+    print(result + "\r")