Merge pull request #281 from TypedDevs/feat/generate-report-html

Generate report html

Author: Chemaclass

.env.example

@@ -5,3 +5,4 @@ STOP_ON_FAILURE=
 SHOW_EXECUTION_TIME=
 DEFAULT_PATH=
 LOG_JUNIT=
+REPORT_HTML=

.gitignore

@@ -14,3 +14,4 @@ lib/bashunit
 
 # logger
 log-junit.xml
+report.html

CHANGELOG.md

@@ -7,6 +7,7 @@
 - Document how to verify the `sha256sum` of the final executable
 - Enable display execution time on MacOS with `SHOW_EXECUTION_TIME`
 - Add `-l|--log-junit <output.xml>` option
+- Add `-r|--report-html <report.html>` option
 
 ## [0.13.0](https://github.com/TypedDevs/bashunit/compare/0.12.0...0.13.0) - 2024-06-23
 

bashunit

@@ -62,6 +62,11 @@ while [[ $# -gt 0 ]]; do
       shift
       shift
       ;;
+    -r|--report-html)
+      REPORT_HTML="$2";
+      shift
+      shift
+      ;;
     --version)
       console_header::print_version
       trap '' EXIT && exit 0

docs/command-line.md

@@ -71,7 +71,7 @@ Filters the tests to be run based on the `test name`.
 :::
 
 ## Logging
-s
+
 > `bashunit -l|--log-junit log-junit.xml`
 
 Create a report XML file that follows the JUnit XML format and contains information about the test results of your bashunit tests.
@@ -82,7 +82,6 @@ Create a report XML file that follows the JUnit XML format and contains informat
 ```
 :::
 
-
 ## Output
 
 > `bashunit -s|--simple`
@@ -124,6 +123,18 @@ Running tests/functional/logic_test.sh
 ```
 :::
 
+## Report
+
+> `bashunit -r|--report-html report.html`
+
+Create a report HTML file that contains information about the test results of your bashunit tests.
+
+::: code-group
+```bash [Example]
+./bashunit ./tests --report-html report.html
+```
+:::
+
 ## Stop on failure
 
 > `bashunit -S|--stop-on-failure`

docs/configuration.md

@@ -61,6 +61,7 @@ Running tests/functional/logic_test.sh
 SIMPLE_OUTPUT=false
 ```
 :::
+
 ## Stop on failure
 
 > `STOP_ON_FAILURE=true|false`
@@ -75,7 +76,7 @@ Similar as using `-S|--stop-on-failure` option on the [command line](/command-li
 >
 > `HEADER_ASCII_ART=true|false`
 
-Specifies if you want to show the bashunit header. `true` by default.
+Specify if you want to show the bashunit header. `true` by default.
 
 Additionally, you can use the env-var `HEADER_ASCII_ART` to display bashunit in ASCII. `false` by default.
 
@@ -153,6 +154,18 @@ SHOW_EXECUTION_TIMER=false
 ```
 :::
 
+## Log JUnit
+
+> `LOG_JUNIT=log-junit.xml`
+
+Create a report XML file that follows the JUnit XML format and contains information about the test results of your bashunit tests.
+
+## Report HTML
+
+> `REPORT_HTML=report.html`
+
+Create a report HTML file that contains information about the test results of your bashunit tests.
+
 <script setup>
 import pkg from '../package.json'
 </script>

src/default_env_config.sh

@@ -9,4 +9,5 @@ _DEFAULT_STOP_ON_FAILURE=false
 _DEFAULT_SHOW_EXECUTION_TIME=true
 _DEFAULT_DEFAULT_PATH=
 _DEFAULT_LOG_JUNIT=
+_DEFAULT_REPORT_HTML=
 CAT="$(which cat)"

src/env_configuration.sh

@@ -36,3 +36,7 @@ fi
 if [[ -z "$LOG_JUNIT" ]]; then
   LOG_JUNIT=$_DEFAULT_LOG_JUNIT
 fi
+
+if [[ -z "$REPORT_HTML" ]]; then
+  REPORT_HTML=$_DEFAULT_REPORT_HTML
+fi

src/logger.sh

@@ -3,42 +3,41 @@
 TEST_NAMES=()
 TEST_STATUSES=()
 TEST_DURATIONS=()
-TEST_ERRORS=()
 
 function logger::test_snapshot() {
-  logger::log "$1" "$2" "snapshot" "$3"
+  logger::log "$1" "$2" "$3" "snapshot"
 }
 
 function logger::test_incomplete() {
-  logger::log "$1" "$2" "incomplete" "$3"
+  logger::log "$1" "$2" "$3" "incomplete"
 }
 
 function logger::test_skipped() {
-  logger::log "$1" "$2" "skipped" "$3"
+  logger::log "$1" "$2" "$3" "skipped"
 }
 
 function logger::test_passed() {
-  logger::log "$1" "$2" "passed" "$3"
+  logger::log "$1" "$2" "$3" "passed"
 }
 
 function logger::test_failed() {
-  logger::log "$1" "$2" "failed" "$3"
+  logger::log "$1" "$2" "$3" "failed"
 }
 
 function logger::log() {
-  local test_name="$1"
-  local start_time="$2"
-  local status="$3"
-  local error_msg="${4:-}"
+  local file="$1"
+  local test_name="$2"
+  local start_time="$3"
+  local status="$4"
 
   local end_time
   end_time=$(clock::now)
   local duration=$((end_time - start_time))
 
+  TEST_FILES+=("$file")
   TEST_NAMES+=("$test_name")
   TEST_STATUSES+=("$status")
   TEST_DURATIONS+=("$duration")
-  TEST_ERRORS+=("$error_msg")
 }
 
 function logger::generate_junit_xml() {
@@ -64,19 +63,136 @@ function logger::generate_junit_xml() {
     echo "             skipped=\"$tests_skipped\" snapshot=\"$tests_snapshot\">"
 
     for i in "${!TEST_NAMES[@]}"; do
+      local file="${TEST_FILES[$i]}"
       local name="${TEST_NAMES[$i]}"
       local status="${TEST_STATUSES[$i]}"
       local test_time="${TEST_DURATIONS[$i]}"
-      local msg="${TEST_ERRORS[$i]}"
 
-      echo "    <testcase name=\"$name\" time=\"$test_time\" status=\"$status\">"
-      if [[ -n $msg ]]; then
-        echo "      <message>$msg<message/>"
-      fi
+      echo "    <testcase file=\"$file\""
+      echo "        name=\"$name\""
+      echo "        status=\"$status\" time=\"$test_time\">"
       echo "    </testcase>"
     done
 
     echo "  </testsuite>"
     echo "</testsuites>"
   } > "$output_file"
 }
+
+function logger::generate_report_html() {
+  local output_file="$1"
+  local test_passed
+  test_passed=$(state::get_tests_passed)
+  local tests_skipped
+  tests_skipped=$(state::get_tests_skipped)
+  local tests_incomplete
+  tests_incomplete=$(state::get_tests_incomplete)
+  local tests_snapshot
+  tests_snapshot=$(state::get_tests_snapshot)
+  local tests_failed
+  tests_failed=$(state::get_tests_failed)
+  local time
+  time=$(clock::runtime_in_milliseconds)
+
+  # Temporary file to store test cases by file
+  local temp_file="temp_test_cases.txt"
+
+  # Collect test cases by file
+  : > "$temp_file"  # Clear temp file if it exists
+  for i in "${!TEST_NAMES[@]}"; do
+    local file="${TEST_FILES[$i]}"
+    local name="${TEST_NAMES[$i]}"
+    local status="${TEST_STATUSES[$i]}"
+    local test_time="${TEST_DURATIONS[$i]}"
+    local test_case="$file|$name|$status|$test_time"
+
+    echo "$test_case" >> "$temp_file"
+  done
+
+  {
+    echo "<!DOCTYPE html>"
+    echo "<html lang=\"en\">"
+    echo "<head>"
+    echo "  <meta charset=\"UTF-8\">"
+    echo "  <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">"
+    echo "  <title>Test Report</title>"
+    echo "  <style>"
+    echo "    body { font-family: Arial, sans-serif; }"
+    echo "    table { width: 100%; border-collapse: collapse; }"
+    echo "    th, td { border: 1px solid #ddd; padding: 8px; text-align: left; }"
+    echo "    th { background-color: #f2f2f2; }"
+    echo "    .passed { background-color: #dff0d8; }"
+    echo "    .failed { background-color: #f2dede; }"
+    echo "    .skipped { background-color: #fcf8e3; }"
+    echo "    .incomplete { background-color: #d9edf7; }"
+    echo "    .snapshot { background-color: #dfe6e9; }"
+    echo "  </style>"
+    echo "</head>"
+    echo "<body>"
+    echo "  <h1>Test Report</h1>"
+    echo "  <table>"
+    echo "    <thead>"
+    echo "      <tr>"
+    echo "        <th>Total Tests</th>"
+    echo "        <th>Passed</th>"
+    echo "        <th>Failed</th>"
+    echo "        <th>Incomplete</th>"
+    echo "        <th>Skipped</th>"
+    echo "        <th>Snapshot</th>"
+    echo "        <th>Time (ms)</th>"
+    echo "      </tr>"
+    echo "    </thead>"
+    echo "    <tbody>"
+    echo "      <tr>"
+    echo "        <td>${#TEST_NAMES[@]}</td>"
+    echo "        <td>$test_passed</td>"
+    echo "        <td>$tests_failed</td>"
+    echo "        <td>$tests_incomplete</td>"
+    echo "        <td>$tests_skipped</td>"
+    echo "        <td>$tests_snapshot</td>"
+    echo "        <td>${time}</td>"
+    echo "      </tr>"
+    echo "    </tbody>"
+    echo "  </table>"
+    echo "  <p>Time: $time ms</p>"
+
+    # Read the temporary file and group by file
+    local current_file=""
+    while IFS='|' read -r file name status test_time; do
+      if [ "$file" != "$current_file" ]; then
+        if [ -n "$current_file" ]; then
+          echo "    </tbody>"
+          echo "  </table>"
+        fi
+        echo "  <h2>File: $file</h2>"
+        echo "  <table>"
+        echo "    <thead>"
+        echo "      <tr>"
+        echo "        <th>Test Name</th>"
+        echo "        <th>Status</th>"
+        echo "        <th>Time (ms)</th>"
+        echo "      </tr>"
+        echo "    </thead>"
+        echo "    <tbody>"
+        current_file="$file"
+      fi
+      echo "      <tr class=\"$status\">"
+      echo "        <td>$name</td>"
+      echo "        <td>$status</td>"
+      echo "        <td>$test_time</td>"
+      echo "      </tr>"
+    done < "$temp_file"
+
+    # Close the last table
+    if [ -n "$current_file" ]; then
+      echo "    </tbody>"
+      echo "  </table>"
+    fi
+
+    echo "</body>"
+    echo "</html>"
+  } > "$output_file"
+
+  # Clean up temporary file
+  rm -f "$temp_file"
+}

src/main.sh

@@ -13,6 +13,10 @@ function main::exec_tests() {
     logger::generate_junit_xml "$LOG_JUNIT"
   fi
 
+  if [[ -n "$REPORT_HTML" ]]; then
+    logger::generate_report_html "$REPORT_HTML"
+  fi
+
   exit $exit_code
 }