Consolidate output format flags into --output/-o

Co-authored-by: dev-ankit <1901680+dev-ankit@users.noreply.github.com>

Author: Copilot

README.md

@@ -30,19 +30,19 @@ python3 compare_runs.py test_runs/HTML-Report-292/report.csv test_runs/HTML-Repo
 - JSON output for scripting:
 
 ```
-python3 compare_runs.py test_runs/HTML-Report-292 test_runs/HTML-Report-294 --json
+python3 compare_runs.py test_runs/HTML-Report-292 test_runs/HTML-Report-294 -o json
 ```
 
-- Colorize output and show verdicts (green=better, red=worse):
+- Markdown output with emoji indicators (✅ better, ❌ worse, ➖ same):
 
 ```
-python3 compare_runs.py test_runs/HTML-Report-292 test_runs/HTML-Report-294 --color
+python3 compare_runs.py test_runs/HTML-Report-292 test_runs/HTML-Report-294 -o markdown
 ```
 
-- Markdown output with emoji indicators (✅ better, ❌ worse, ➖ same):
+- Colorize text output (green=better, red=worse):
 
 ```
-python3 compare_runs.py test_runs/HTML-Report-292 test_runs/HTML-Report-294 --markdown
+python3 compare_runs.py test_runs/HTML-Report-292 test_runs/HTML-Report-294 --color
 ```
 
 Exit code is `0` on success and `1` on error.
@@ -69,7 +69,7 @@ If a metric is not available for an item, it is shown as `-`.
 
 ## Markdown Output Example
 
-The `--markdown` flag produces markdown tables with emoji indicators for verdicts:
+The `-o markdown` flag produces markdown tables with emoji indicators for verdicts:
 
 ```markdown
 ## Aggregated

compare_runs.py

@@ -504,11 +504,10 @@ def render_comparison(
 def compare_reports(
     base_path: Path,
     curr_path: Path,
-    as_json: bool = False,
+    output_format: str = "text",
     *,
     colorize: bool = False,
     show_verdict: bool = True,
-    as_markdown: bool = False,
 ) -> int:
     # Resolve paths (extract zip files if needed)
     base_path = _resolve_path(base_path)
@@ -537,7 +536,7 @@ def compare_reports(
     base_html_map = load_html_feature_map(base_path if base_path.is_dir() else base_path.parent)
     curr_html_map = load_html_feature_map(curr_path if curr_path.is_dir() else curr_path.parent)
 
-    if as_json:
+    if output_format == "json":
         # Produce a structured JSON dict
         out: Dict[str, Dict[str, Dict[str, Optional[float]]]] = {}
         for key in all_keys:
@@ -589,7 +588,7 @@ def compare_reports(
         return 0
 
     # Human readable output
-    if as_markdown:
+    if output_format == "markdown":
         print("# Locust Performance Comparison")
         print("")
         print_section_markdown("Aggregated", 2)
@@ -681,16 +680,17 @@ def main():
     )
     parser.add_argument("base", type=Path, help="Base run directory or report.csv path")
     parser.add_argument("current", type=Path, help="Current run directory or report.csv path")
-    parser.add_argument("--json", action="store_true", help="Output results as JSON")
     parser.add_argument(
-        "--markdown",
-        action="store_true",
-        help="Output results as Markdown with emoji indicators (✅ better, ❌ worse, ➖ same)",
+        "-o",
+        "--output",
+        choices=["text", "json", "markdown"],
+        default="text",
+        help="Output format: text (default), json, or markdown with emoji indicators (✅ better, ❌ worse, ➖ same)",
     )
     parser.add_argument(
         "--color",
         action="store_true",
-        help="Colorize rows: green if better, red if worse",
+        help="Colorize rows: green if better, red if worse (only for text output)",
     )
     parser.add_argument(
         "--no-verdict",
@@ -704,10 +704,9 @@ def main():
         return compare_reports(
             args.base,
             args.current,
-            as_json=args.json,
+            output_format=args.output,
             colorize=args.color,
             show_verdict=args.show_verdict,
-            as_markdown=args.markdown,
         )
     except Exception as e:
         print(f"Error: {e}")

tests/test_compare_reports.py

@@ -15,7 +15,7 @@ class TestCompareReportsJson:
     """Tests for compare_reports with JSON output."""
 
     def test_json_output_structure(self, temp_test_dir, temp_test_dir_v2, capsys):
-        result = compare_reports(temp_test_dir, temp_test_dir_v2, as_json=True)
+        result = compare_reports(temp_test_dir, temp_test_dir_v2, output_format="json")
         assert result == 0
 
         captured = capsys.readouterr()
@@ -27,7 +27,7 @@ def test_json_output_structure(self, temp_test_dir, temp_test_dir_v2, capsys):
         assert "/api/login" in data
 
     def test_json_output_metrics(self, temp_test_dir, temp_test_dir_v2, capsys):
-        compare_reports(temp_test_dir, temp_test_dir_v2, as_json=True)
+        compare_reports(temp_test_dir, temp_test_dir_v2, output_format="json")
 
         captured = capsys.readouterr()
         data = json.loads(captured.out)
@@ -42,7 +42,7 @@ def test_json_output_metrics(self, temp_test_dir, temp_test_dir_v2, capsys):
         assert "pct_change" in metric
 
     def test_json_output_values(self, temp_test_dir, temp_test_dir_v2, capsys):
-        compare_reports(temp_test_dir, temp_test_dir_v2, as_json=True)
+        compare_reports(temp_test_dir, temp_test_dir_v2, output_format="json")
 
         captured = capsys.readouterr()
         data = json.loads(captured.out)
@@ -61,7 +61,7 @@ class TestCompareReportsHuman:
     """Tests for compare_reports with human-readable output."""
 
     def test_human_output_includes_sections(self, temp_test_dir, temp_test_dir_v2, capsys):
-        result = compare_reports(temp_test_dir, temp_test_dir_v2, as_json=False)
+        result = compare_reports(temp_test_dir, temp_test_dir_v2, output_format="text")
         assert result == 0
 
         captured = capsys.readouterr()
@@ -72,7 +72,7 @@ def test_human_output_includes_sections(self, temp_test_dir, temp_test_dir_v2, c
         assert "Endpoint:" in output
 
     def test_human_output_includes_metrics(self, temp_test_dir, temp_test_dir_v2, capsys):
-        compare_reports(temp_test_dir, temp_test_dir_v2, as_json=False)
+        compare_reports(temp_test_dir, temp_test_dir_v2, output_format="text")
 
         captured = capsys.readouterr()
         output = captured.out
@@ -83,7 +83,7 @@ def test_human_output_includes_metrics(self, temp_test_dir, temp_test_dir_v2, ca
         assert "Average Response Time" in output
 
     def test_human_output_includes_verdict(self, temp_test_dir, temp_test_dir_v2, capsys):
-        compare_reports(temp_test_dir, temp_test_dir_v2, as_json=False, show_verdict=True)
+        compare_reports(temp_test_dir, temp_test_dir_v2, output_format="text", show_verdict=True)
 
         captured = capsys.readouterr()
         output = captured.out
@@ -94,7 +94,7 @@ def test_human_output_includes_verdict(self, temp_test_dir, temp_test_dir_v2, ca
         assert "better" in output or "worse" in output or "same" in output
 
     def test_human_output_no_verdict(self, temp_test_dir, temp_test_dir_v2, capsys):
-        compare_reports(temp_test_dir, temp_test_dir_v2, as_json=False, show_verdict=False)
+        compare_reports(temp_test_dir, temp_test_dir_v2, output_format="text", show_verdict=False)
 
         captured = capsys.readouterr()
         output = captured.out
@@ -105,7 +105,7 @@ def test_human_output_no_verdict(self, temp_test_dir, temp_test_dir_v2, capsys):
         assert "Verdict" not in header_line
 
     def test_human_output_colorize(self, temp_test_dir, temp_test_dir_v2, capsys):
-        compare_reports(temp_test_dir, temp_test_dir_v2, as_json=False, colorize=True)
+        compare_reports(temp_test_dir, temp_test_dir_v2, output_format="text", colorize=True)
 
         captured = capsys.readouterr()
         output = captured.out
@@ -119,7 +119,7 @@ class TestCompareReportsEdgeCases:
 
     def test_compare_same_report(self, temp_test_dir, capsys):
         """Comparing a report to itself should show no changes."""
-        compare_reports(temp_test_dir, temp_test_dir, as_json=True)
+        compare_reports(temp_test_dir, temp_test_dir, output_format="json")
 
         captured = capsys.readouterr()
         data = json.loads(captured.out)
@@ -141,7 +141,7 @@ def test_compare_with_missing_endpoint(self, sample_csv_content, sample_csv_cont
             base_path.write_text(base_csv)
             curr_path.write_text(sample_csv_content_v2)
 
-            compare_reports(Path(base_dir), Path(curr_dir), as_json=True)
+            compare_reports(Path(base_dir), Path(curr_dir), output_format="json")
 
             captured = capsys.readouterr()
             data = json.loads(captured.out)
@@ -164,7 +164,7 @@ def test_compare_with_new_endpoint(self, sample_csv_content, sample_csv_content_
             base_path.write_text(sample_csv_content)
             curr_path.write_text(curr_csv)
 
-            compare_reports(Path(base_dir), Path(curr_dir), as_json=True)
+            compare_reports(Path(base_dir), Path(curr_dir), output_format="json")
 
             captured = capsys.readouterr()
             data = json.loads(captured.out)
@@ -195,7 +195,7 @@ def test_json_includes_html_features(self, temp_dir_with_html, capsys):
                 if html_file.name != "htmlpublisher-wrapper.html":
                     shutil.copy(html_file, other / html_file.name)
 
-            compare_reports(temp_dir_with_html, other, as_json=True)
+            compare_reports(temp_dir_with_html, other, output_format="json")
 
             captured = capsys.readouterr()
             data = json.loads(captured.out)
@@ -218,7 +218,7 @@ def test_human_output_includes_html_section(self, temp_dir_with_html, capsys):
                 if html_file.name != "htmlpublisher-wrapper.html":
                     shutil.copy(html_file, other / html_file.name)
 
-            compare_reports(temp_dir_with_html, other, as_json=False)
+            compare_reports(temp_dir_with_html, other, output_format="text")
 
             captured = capsys.readouterr()
             output = captured.out
@@ -238,7 +238,7 @@ def test_compare_real_reports(self, real_test_runs_path, capsys):
         if not base.exists() or not curr.exists():
             pytest.skip("Real test data not available")
 
-        result = compare_reports(base, curr, as_json=True)
+        result = compare_reports(base, curr, output_format="json")
         assert result == 0
 
         captured = capsys.readouterr()

tests/test_markdown_output.py

@@ -31,7 +31,7 @@ def test_verdict_to_emoji_none(self):
 
     def test_markdown_output_structure(self, temp_test_dir, temp_test_dir_v2, capsys):
         """Test that markdown output has correct structure."""
-        result = compare_reports(temp_test_dir, temp_test_dir_v2, as_markdown=True)
+        result = compare_reports(temp_test_dir, temp_test_dir_v2, output_format="markdown")
         assert result == 0
 
         captured = capsys.readouterr()
@@ -48,7 +48,7 @@ def test_markdown_output_structure(self, temp_test_dir, temp_test_dir_v2, capsys
 
     def test_markdown_output_includes_metrics(self, temp_test_dir, temp_test_dir_v2, capsys):
         """Test that markdown output includes all expected metrics."""
-        compare_reports(temp_test_dir, temp_test_dir_v2, as_markdown=True)
+        compare_reports(temp_test_dir, temp_test_dir_v2, output_format="markdown")
 
         captured = capsys.readouterr()
         output = captured.out
@@ -61,7 +61,7 @@ def test_markdown_output_includes_metrics(self, temp_test_dir, temp_test_dir_v2,
 
     def test_markdown_output_includes_emojis(self, temp_test_dir, temp_test_dir_v2, capsys):
         """Test that markdown output includes emoji indicators."""
-        compare_reports(temp_test_dir, temp_test_dir_v2, as_markdown=True, show_verdict=True)
+        compare_reports(temp_test_dir, temp_test_dir_v2, output_format="markdown", show_verdict=True)
 
         captured = capsys.readouterr()
         output = captured.out
@@ -71,7 +71,7 @@ def test_markdown_output_includes_emojis(self, temp_test_dir, temp_test_dir_v2,
 
     def test_markdown_output_no_verdict(self, temp_test_dir, temp_test_dir_v2, capsys):
         """Test markdown output without verdict column."""
-        compare_reports(temp_test_dir, temp_test_dir_v2, as_markdown=True, show_verdict=False)
+        compare_reports(temp_test_dir, temp_test_dir_v2, output_format="markdown", show_verdict=False)
 
         captured = capsys.readouterr()
         output = captured.out
@@ -85,7 +85,7 @@ def test_markdown_output_no_verdict(self, temp_test_dir, temp_test_dir_v2, capsy
 
     def test_markdown_output_no_color_codes(self, temp_test_dir, temp_test_dir_v2, capsys):
         """Test that markdown output does not contain ANSI color codes."""
-        compare_reports(temp_test_dir, temp_test_dir_v2, as_markdown=True)
+        compare_reports(temp_test_dir, temp_test_dir_v2, output_format="markdown")
 
         captured = capsys.readouterr()
         output = captured.out
@@ -97,7 +97,7 @@ def test_markdown_output_no_color_codes(self, temp_test_dir, temp_test_dir_v2, c
 
     def test_markdown_table_format(self, temp_test_dir, temp_test_dir_v2, capsys):
         """Test that markdown tables are properly formatted."""
-        compare_reports(temp_test_dir, temp_test_dir_v2, as_markdown=True, show_verdict=True)
+        compare_reports(temp_test_dir, temp_test_dir_v2, output_format="markdown", show_verdict=True)
 
         captured = capsys.readouterr()
         output = captured.out
@@ -130,7 +130,7 @@ def test_markdown_with_html_features(self, temp_dir_with_html, capsys):
                 if html_file.name != "htmlpublisher-wrapper.html":
                     shutil.copy(html_file, other / html_file.name)
 
-            compare_reports(temp_dir_with_html, other, as_markdown=True)
+            compare_reports(temp_dir_with_html, other, output_format="markdown")
 
             captured = capsys.readouterr()
             output = captured.out
@@ -141,7 +141,7 @@ def test_markdown_with_html_features(self, temp_dir_with_html, capsys):
 
     def test_markdown_output_values(self, temp_test_dir, temp_test_dir_v2, capsys):
         """Test that markdown output contains correct values."""
-        compare_reports(temp_test_dir, temp_test_dir_v2, as_markdown=True)
+        compare_reports(temp_test_dir, temp_test_dir_v2, output_format="markdown")
 
         captured = capsys.readouterr()
         output = captured.out
@@ -156,7 +156,7 @@ class TestMarkdownCompatibility:
 
     def test_json_still_works(self, temp_test_dir, temp_test_dir_v2, capsys):
         """Test that JSON output is not affected by markdown changes."""
-        result = compare_reports(temp_test_dir, temp_test_dir_v2, as_json=True)
+        result = compare_reports(temp_test_dir, temp_test_dir_v2, output_format="json")
         assert result == 0
 
         captured = capsys.readouterr()
@@ -165,7 +165,7 @@ def test_json_still_works(self, temp_test_dir, temp_test_dir_v2, capsys):
 
     def test_normal_output_still_works(self, temp_test_dir, temp_test_dir_v2, capsys):
         """Test that normal human-readable output still works."""
-        result = compare_reports(temp_test_dir, temp_test_dir_v2, as_json=False, as_markdown=False)
+        result = compare_reports(temp_test_dir, temp_test_dir_v2, output_format="text")
         assert result == 0
 
         captured = capsys.readouterr()
@@ -177,7 +177,7 @@ def test_normal_output_still_works(self, temp_test_dir, temp_test_dir_v2, capsys
 
     def test_color_output_still_works(self, temp_test_dir, temp_test_dir_v2, capsys):
         """Test that colorized output still works."""
-        result = compare_reports(temp_test_dir, temp_test_dir_v2, colorize=True, as_markdown=False)
+        result = compare_reports(temp_test_dir, temp_test_dir_v2, output_format="text", colorize=True)
         assert result == 0
 
         captured = capsys.readouterr()

tests/test_zip_support.py

@@ -112,7 +112,7 @@ def test_compare_zip_to_zip(self, sample_csv_content, sample_csv_content_v2, cap
             with zipfile.ZipFile(curr_zip, "w") as zf:
                 zf.writestr("report.csv", sample_csv_content_v2)
 
-            result = compare_reports(base_zip, curr_zip, as_json=True)
+            result = compare_reports(base_zip, curr_zip, output_format="json")
             assert result == 0
 
             captured = capsys.readouterr()
@@ -126,7 +126,7 @@ def test_compare_zip_to_directory(self, sample_csv_content, temp_test_dir_v2, ca
             with zipfile.ZipFile(base_zip, "w") as zf:
                 zf.writestr("report.csv", sample_csv_content)
 
-            result = compare_reports(base_zip, temp_test_dir_v2, as_json=True)
+            result = compare_reports(base_zip, temp_test_dir_v2, output_format="json")
             assert result == 0
 
     def test_compare_directory_to_zip(self, temp_test_dir, sample_csv_content_v2, capsys):
@@ -137,7 +137,7 @@ def test_compare_directory_to_zip(self, temp_test_dir, sample_csv_content_v2, ca
             with zipfile.ZipFile(curr_zip, "w") as zf:
                 zf.writestr("report.csv", sample_csv_content_v2)
 
-            result = compare_reports(temp_test_dir, curr_zip, as_json=True)
+            result = compare_reports(temp_test_dir, curr_zip, output_format="json")
             assert result == 0
 
     def test_zip_with_nested_directory_structure(self, sample_csv_content, sample_csv_content_v2, capsys):
@@ -152,7 +152,7 @@ def test_zip_with_nested_directory_structure(self, sample_csv_content, sample_cs
             with zipfile.ZipFile(curr_zip, "w") as zf:
                 zf.writestr("HTML-Report-200/report.csv", sample_csv_content_v2)
 
-            result = compare_reports(base_zip, curr_zip, as_json=True)
+            result = compare_reports(base_zip, curr_zip, output_format="json")
             assert result == 0
 
     def test_zip_with_html_files(self, sample_csv_content, sample_html_template_args, capsys):
@@ -169,7 +169,7 @@ def test_zip_with_html_files(self, sample_csv_content, sample_html_template_args
                 zf.writestr("report.csv", sample_csv_content)
                 zf.writestr("feature_test.html", sample_html_template_args)
 
-            result = compare_reports(base_zip, curr_zip, as_json=True)
+            result = compare_reports(base_zip, curr_zip, output_format="json")
             assert result == 0
 
             captured = capsys.readouterr()