Merge pull request #349 from Marinovsky/bug-7350-IncludeParametersInReportAndStatistics

Include parameters in report and statistics

Author: Martin-Molinero

README.md

@@ -1255,6 +1255,7 @@ Options:
   --backtest-results FILE      Path to the JSON file containing the backtest results
   --live-results FILE          Path to the JSON file containing the live trading results
   --report-destination FILE    Path where the generated report is stored as HTML (defaults to ./report.html)
+  --css FILE                   Path where the CSS override file is stored
   -d, --detach                 Run the report creator in a detached Docker container and return immediately
   --strategy-name TEXT         Name of the strategy, will appear at the top-right corner of each page
   --strategy-version TEXT      Version number of the strategy, will appear next to the project name

lean/commands/report.py

@@ -52,6 +52,9 @@ def _find_project_directory(backtest_file: Path) -> Optional[Path]:
               type=PathParameter(exists=False, file_okay=True, dir_okay=False),
               default=lambda: Path.cwd() / "report.html",
               help="Path where the generated report is stored as HTML (defaults to ./report.html)")
+@option("--css",
+              type=PathParameter(exists=False, file_okay=True, dir_okay=False),
+              help="Path where the CSS override file is stored")
 @option("--detach", "-d",
               is_flag=True,
               default=False,
@@ -83,6 +86,7 @@ def _find_project_directory(backtest_file: Path) -> Optional[Path]:
 def report(backtest_results: Optional[Path],
            live_results: Optional[Path],
            report_destination: Path,
+           css: Optional[Path],
            detach: bool,
            strategy_name: Optional[str],
            strategy_version: Optional[str],
@@ -157,6 +161,7 @@ def report(backtest_results: Optional[Path],
         "live-data-source-file": "live-data-source-file.json" if live_results is not None else "",
         "backtest-data-source-file": "backtest-data-source-file.json",
         "report-destination": "/tmp/report.html",
+        "report-css-override-file": "report_override.css" if (css is not None) and (css.exists()) else "",
         "report-format": "pdf" if pdf else "",
         "environment": "report",
 
@@ -222,6 +227,15 @@ def report(backtest_results: Optional[Path],
         }
     }
 
+    if css is not None:
+        if css.exists():
+            run_options["mounts"].append(Mount(target="/Lean/Report/bin/Debug/report_override.css",
+                                               source=str(css),
+                                               type="bind",
+                                               read_only=True))
+        else:
+            logger.info(f"CSS override file '{css}' could not be found")
+
     if pdf:
         run_options["commands"].append(f'cp /tmp/report.pdf "/Output/{report_destination.name.replace(".html", ".pdf")}"')
     if live_results is not None:

tests/commands/test_report.py

@@ -42,6 +42,11 @@ def setup_backtest_results() -> None:
     with results_path.open("w+", encoding="utf-8") as file:
         file.write("{}")
 
+    css_path = Path.cwd() / f"{results_id}.css"
+    css_path.parent.mkdir(parents=True, exist_ok=True)
+    with css_path.open("w+", encoding="utf-8") as file:
+        file.write("")
+
     results_config_path = results_dir / "config"
     with results_config_path.open("w+", encoding="utf-8") as file:
         file.write(json.dumps({'id': results_id}))
@@ -206,6 +211,39 @@ def test_report_mounts_given_backtest_data_source_file() -> None:
     mount = [m for m in kwargs["mounts"] if m["Target"] == "/Lean/Report/bin/Debug/backtest-data-source-file.json"][0]
     assert mount["Source"] == str(Path.cwd() / "Python Project" / "backtests" / "2020-01-01_00-00-00" / "1459804915.json")
 
+def test_report_mounts_given_css_override_file() -> None:
+    docker_manager = mock.Mock()
+    docker_manager.run_image.side_effect = run_image
+    initialize_container(docker_manager_to_use=docker_manager)
+
+    result = CliRunner().invoke(lean, ["report",
+                                       "--css",
+                                       "1459804915.css"])
+
+    assert result.exit_code == 0
+
+    docker_manager.run_image.assert_called_once()
+    args, kwargs = docker_manager.run_image.call_args
+
+    mount = [m for m in kwargs["mounts"] if m["Target"] == "/Lean/Report/bin/Debug/report_override.css"][0]
+    assert mount["Source"] == str(Path.cwd() / "1459804915.css")
+
+def test_report_runs_even_when_css_override_file_does_not_exist() -> None:
+    docker_manager = mock.Mock()
+    docker_manager.run_image.side_effect = run_image
+    initialize_container(docker_manager_to_use=docker_manager)
+
+    result = CliRunner().invoke(lean, ["report",
+                                       "--css",
+                                       "1459804916.css"])
+
+    assert result.exit_code == 0
+
+    docker_manager.run_image.assert_called_once()
+    args, kwargs = docker_manager.run_image.call_args
+
+    mount = [m for m in kwargs["mounts"] if m["Target"] == "/Lean/Report/bin/Debug/report_override.css"]
+    assert len(mount) == 0
 
 def test_report_finds_latest_backtest_data_source_file_when_not_given() -> None:
     docker_manager = mock.Mock()