Enhance dashboard export and import scripts with improved error handling and directory checks

angoca · angoca · commit 39aad12d9aeb · 2026-01-26T20:53:37.000-05:00
- Added checks to determine if the output path for Grafana and HTML dashboards is a directory, allowing for more flexible export options.
- Improved error messages for unknown dashboard types in the import script, ensuring clearer feedback for users.
- Updated unit tests to reflect changes in JSON structure, ensuring accurate validation of dashboard properties.
- Enhanced HTML dashboard tests for case-insensitive checks of basic structure and navigation links.
diff --git a/bin/dashboard/exportDashboard.sh b/bin/dashboard/exportDashboard.sh
@@ -102,7 +102,20 @@ export_grafana_dashboard() {
     
     log_info "Exporting Grafana dashboards to ${output}"
     
+    # Check if output is a directory or should be treated as directory path
+    # If output ends with /grafana or /html, and parent directory exists and is a directory, treat as directory
+    local output_parent
+    output_parent=$(dirname "${output}")
+    local should_copy_to_dir=false
     if [[ -d "${output}" ]]; then
+        should_copy_to_dir=true
+    elif [[ -d "${output_parent}" ]]; then
+        if [[ "${output}" == */grafana ]] || [[ "${output}" == */html ]]; then
+            should_copy_to_dir=true
+        fi
+    fi
+    
+    if [[ "${should_copy_to_dir}" == "true" ]]; then
         # Copy to directory
         # If output already ends with /grafana, don't add another grafana subdirectory
         if [[ "${output}" == */grafana ]]; then
@@ -186,7 +199,20 @@ export_html_dashboard() {
     
     log_info "Exporting HTML dashboards to ${output}"
     
+    # Check if output is a directory or should be treated as directory path
+    # If output ends with /grafana or /html, and parent directory exists and is a directory, treat as directory
+    local output_parent
+    output_parent=$(dirname "${output}")
+    local should_copy_to_dir=false
     if [[ -d "${output}" ]]; then
+        should_copy_to_dir=true
+    elif [[ -d "${output_parent}" ]]; then
+        if [[ "${output}" == */grafana ]] || [[ "${output}" == */html ]]; then
+            should_copy_to_dir=true
+        fi
+    fi
+    
+    if [[ "${should_copy_to_dir}" == "true" ]]; then
         # Copy to directory
         # If output already ends with /html, don't add another html subdirectory
         if [[ "${output}" == */html ]]; then
@@ -328,11 +354,25 @@ while [[ $# -gt 0 ]]; do
                         DASHBOARD_TYPE="${1}"
                         ;;
                     *)
-                        # If it's not a valid type, treat it as output
+                        # If it's not a valid type and no output file specified, it's an error
+                        # Otherwise, treat it as output file
                         if [[ -z "${OUTPUT_FILE}" ]]; then
-                            OUTPUT_FILE="${1}"
+                            # Check if it looks like a file path (contains / or .) or if it's clearly not a type
+                            if [[ "${1}" =~ / ]] || [[ "${1}" =~ \. ]]; then
+                                OUTPUT_FILE="${1}"
+                            else
+                                # Invalid dashboard type
+                                echo "ERROR: Unknown dashboard type: ${1}" >&2
+                                echo "Valid types are: grafana, html, all" >&2
+                                usage
+                                exit 1
+                            fi
                         else
-                            DASHBOARD_TYPE="${1}"
+                            # Already have output file, so this must be an invalid type
+                            echo "ERROR: Unknown dashboard type: ${1}" >&2
+                            echo "Valid types are: grafana, html, all" >&2
+                            usage
+                            exit 1
                         fi
                         ;;
                 esac
diff --git a/bin/dashboard/generateMetrics.sh b/bin/dashboard/generateMetrics.sh
@@ -347,6 +347,12 @@ while [[ $# -gt 0 ]]; do
             COMPONENT="${2}"
             shift 2
             ;;
+        --*)
+            # Unknown option starting with --
+            echo "ERROR: Unknown option: ${1}" >&2
+            usage
+            exit 1
+            ;;
         *)
             # If --component was already set, treat remaining positional args as format/output
             if [[ -z "${COMPONENT}" ]]; then
diff --git a/tests/unit/dashboard/test_grafana_dashboards.sh b/tests/unit/dashboard/test_grafana_dashboards.sh
@@ -58,13 +58,13 @@ setup() {
 @test "ingestion.json has required dashboard structure" {
     assert_file_exists "${TEST_DASHBOARD_DIR}/ingestion.json"
     
-    # Check for dashboard object
-    run jq -e '.dashboard' "${TEST_DASHBOARD_DIR}/ingestion.json" > /dev/null 2>&1
-    assert_success "ingestion.json missing dashboard object"
-    
-    # Check for title
-    run jq -e '.dashboard.title' "${TEST_DASHBOARD_DIR}/ingestion.json" > /dev/null 2>&1
+    # Check for title (structure is at root level, not under .dashboard)
+    run jq -e '.title' "${TEST_DASHBOARD_DIR}/ingestion.json" > /dev/null 2>&1
     assert_success "ingestion.json missing title"
+    
+    # Check for panels
+    run jq -e '.panels' "${TEST_DASHBOARD_DIR}/ingestion.json" > /dev/null 2>&1
+    assert_success "ingestion.json missing panels"
 }
 
 ##
@@ -121,17 +121,17 @@ setup() {
         local json_file="${TEST_DASHBOARD_DIR}/${dashboard}.json"
         assert_file_exists "${json_file}"
         
-        # Check for dashboard object
-        run jq -e '.dashboard' "${json_file}" > /dev/null 2>&1
-        assert_success "${dashboard}.json missing dashboard object"
-        
-        # Check for title
-        run jq -e '.dashboard.title' "${json_file}" > /dev/null 2>&1
+        # Check for title (structure is at root level, not under .dashboard)
+        run jq -e '.title' "${json_file}" > /dev/null 2>&1
         assert_success "${dashboard}.json missing title"
         
         # Check for schemaVersion
-        run jq -e '.dashboard.schemaVersion' "${json_file}" > /dev/null 2>&1
+        run jq -e '.schemaVersion' "${json_file}" > /dev/null 2>&1
         assert_success "${dashboard}.json missing schemaVersion"
+        
+        # Check for panels
+        run jq -e '.panels' "${json_file}" > /dev/null 2>&1
+        assert_success "${dashboard}.json missing panels"
     done
 }
 
@@ -145,11 +145,11 @@ setup() {
         local json_file="${TEST_DASHBOARD_DIR}/${dashboard}.json"
         
         # Check for tags array
-        run jq -e '.dashboard.tags' "${json_file}" > /dev/null 2>&1
+        run jq -e '.tags' "${json_file}" > /dev/null 2>&1
         assert_success "${dashboard}.json missing tags"
         
         # Check for "osm" tag
-        run jq -e '.dashboard.tags[] | select(. == "osm")' "${json_file}" > /dev/null 2>&1
+        run jq -e '.tags[] | select(. == "osm")' "${json_file}" > /dev/null 2>&1
         assert_success "${dashboard}.json missing 'osm' tag"
     done
 }
@@ -164,7 +164,7 @@ setup() {
         local json_file="${TEST_DASHBOARD_DIR}/${dashboard}.json"
         
         # Check for time object
-        run jq -e '.dashboard.time' "${json_file}" > /dev/null 2>&1
+        run jq -e '.time' "${json_file}" > /dev/null 2>&1
         assert_success "${dashboard}.json missing time configuration"
     done
 }
@@ -179,7 +179,7 @@ setup() {
         local json_file="${TEST_DASHBOARD_DIR}/${dashboard}.json"
         
         # Check for panels array
-        run jq -e '.dashboard.panels | length > 0' "${json_file}" > /dev/null 2>&1
+        run jq -e '.panels | length > 0' "${json_file}" > /dev/null 2>&1
         assert_success "${dashboard}.json missing panels or panels array is empty"
     done
 }
diff --git a/tests/unit/dashboard/test_html_dashboards.sh b/tests/unit/dashboard/test_html_dashboards.sh
@@ -32,14 +32,14 @@ teardown() {
 @test "overview.html exists and is valid HTML" {
     assert_file_exists "${TEST_DASHBOARD_DIR}/overview.html"
     
-    # Check for basic HTML structure
-    run grep -q "<!DOCTYPE html>" "${TEST_DASHBOARD_DIR}/overview.html"
+    # Check for basic HTML structure (case-insensitive)
+    run grep -qi "<!doctype html>" "${TEST_DASHBOARD_DIR}/overview.html"
     assert_success
     
-    run grep -q "<html" "${TEST_DASHBOARD_DIR}/overview.html"
+    run grep -qi "<html" "${TEST_DASHBOARD_DIR}/overview.html"
     assert_success
     
-    run grep -q "</html>" "${TEST_DASHBOARD_DIR}/overview.html"
+    run grep -qi "</html>" "${TEST_DASHBOARD_DIR}/overview.html"
     assert_success
 }
 
@@ -83,11 +83,11 @@ teardown() {
 @test "component_status.html exists and is valid HTML" {
     assert_file_exists "${TEST_DASHBOARD_DIR}/component_status.html"
     
-    # Check for basic HTML structure
-    run grep -q "<!DOCTYPE html>" "${TEST_DASHBOARD_DIR}/component_status.html"
+    # Check for basic HTML structure (case-insensitive)
+    run grep -qi "<!doctype html>" "${TEST_DASHBOARD_DIR}/component_status.html"
     assert_success
     
-    run grep -q "<html" "${TEST_DASHBOARD_DIR}/component_status.html"
+    run grep -qi "<html" "${TEST_DASHBOARD_DIR}/component_status.html"
     assert_success
 }
 
@@ -125,11 +125,11 @@ teardown() {
 @test "health_check.html exists and is valid HTML" {
     assert_file_exists "${TEST_DASHBOARD_DIR}/health_check.html"
     
-    # Check for basic HTML structure
-    run grep -q "<!DOCTYPE html>" "${TEST_DASHBOARD_DIR}/health_check.html"
+    # Check for basic HTML structure (case-insensitive)
+    run grep -qi "<!doctype html>" "${TEST_DASHBOARD_DIR}/health_check.html"
     assert_success
     
-    run grep -q "<html" "${TEST_DASHBOARD_DIR}/health_check.html"
+    run grep -qi "<html" "${TEST_DASHBOARD_DIR}/health_check.html"
     assert_success
 }
 
@@ -166,14 +166,24 @@ teardown() {
 ##
 @test "HTML dashboards have navigation links between pages" {
     # Check overview.html
-    run grep -q "component_status.html" "${TEST_DASHBOARD_DIR}/overview.html" || \
-        grep -q "health_check.html" "${TEST_DASHBOARD_DIR}/overview.html"
-    assert_success
+    if grep -q "component_status.html" "${TEST_DASHBOARD_DIR}/overview.html" || \
+       grep -q "health_check.html" "${TEST_DASHBOARD_DIR}/overview.html"; then
+        # Navigation link found
+        :
+    else
+        echo "No navigation links found in overview.html"
+        return 1
+    fi
     
     # Check component_status.html
-    run grep -q "overview.html" "${TEST_DASHBOARD_DIR}/component_status.html" || \
-        grep -q "health_check.html" "${TEST_DASHBOARD_DIR}/component_status.html"
-    assert_success
+    if grep -q "overview.html" "${TEST_DASHBOARD_DIR}/component_status.html" || \
+       grep -q "health_check.html" "${TEST_DASHBOARD_DIR}/component_status.html"; then
+        # Navigation link found
+        :
+    else
+        echo "No navigation links found in component_status.html"
+        return 1
+    fi
     
     # Check health_check.html
     run grep -q "overview.html" "${TEST_DASHBOARD_DIR}/health_check.html" || \
diff --git a/tests/unit/dashboard/test_importDashboard_third.sh b/tests/unit/dashboard/test_importDashboard_third.sh
@@ -33,17 +33,17 @@ teardown() {
     local test_file="${TEST_LOG_DIR}/test_dashboard.json"
     echo '{"dashboard": {"title": "Test"}}' > "${test_file}"
     
-    # Mock psql
-    # shellcheck disable=SC2317
-    function psql() {
-        return 0
-    }
-    export -f psql
+    # Set DASHBOARD_OUTPUT_DIR
+    # shellcheck disable=SC2030,SC2031
+    # SC2030/SC2031: Variable modification in subshell is expected in BATS tests
+    export DASHBOARD_OUTPUT_DIR="${TEST_LOG_DIR}/dashboards"
+    mkdir -p "${DASHBOARD_OUTPUT_DIR}/grafana"
     
-    run import_dashboard "${test_file}" "overwrite"
+    run import_grafana_dashboard "${test_file}" "true"
     assert_success
     
     rm -f "${test_file}"
+    rm -rf "${DASHBOARD_OUTPUT_DIR}"
 }
 
 ##
@@ -53,17 +53,17 @@ teardown() {
     local test_file="${TEST_LOG_DIR}/test_dashboard.json"
     echo '{"dashboard": {"title": "Test"}}' > "${test_file}"
     
-    # Mock psql
-    # shellcheck disable=SC2317
-    function psql() {
-        return 0
-    }
-    export -f psql
+    # Set DASHBOARD_OUTPUT_DIR
+    # shellcheck disable=SC2030,SC2031
+    # SC2030/SC2031: Variable modification in subshell is expected in BATS tests
+    export DASHBOARD_OUTPUT_DIR="${TEST_LOG_DIR}/dashboards"
+    mkdir -p "${DASHBOARD_OUTPUT_DIR}/grafana"
     
-    run import_dashboard "${test_file}" "skip"
+    run import_grafana_dashboard "${test_file}" "false"
     assert_success
     
     rm -f "${test_file}"
+    rm -rf "${DASHBOARD_OUTPUT_DIR}"
 }
 
 ##
@@ -73,15 +73,15 @@ teardown() {
     local test_file="${TEST_LOG_DIR}/test_dashboard.json"
     echo '{"dashboard": {"title": "Test"}}' > "${test_file}"
     
-    # Mock import_dashboard
-    # shellcheck disable=SC2317
-    function import_dashboard() {
-        return 0
-    }
-    export -f import_dashboard
+    # Set DASHBOARD_OUTPUT_DIR
+    # shellcheck disable=SC2030,SC2031
+    # SC2030/SC2031: Variable modification in subshell is expected in BATS tests
+    export DASHBOARD_OUTPUT_DIR="${TEST_LOG_DIR}/dashboards"
+    mkdir -p "${DASHBOARD_OUTPUT_DIR}/grafana"
     
-    run main --overwrite --file "${test_file}"
+    run bash "${BATS_TEST_DIRNAME}/../../../bin/dashboard/importDashboard.sh" --overwrite "${test_file}" grafana
     assert_success
     
     rm -f "${test_file}"
+    rm -rf "${DASHBOARD_OUTPUT_DIR}"
 }
