Make markdown includes directory configurable and use sysin for template

Author: JohT

scripts/executeQuery.sh

@@ -26,6 +26,9 @@ set -o errexit -o pipefail
 SCRIPTS_DIR=${SCRIPTS_DIR:-$( CDPATH=. cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd -P )} # Repository directory containing the shell scripts
 #echo "executeQuery: SCRIPTS_DIR=$SCRIPTS_DIR" >&2
 
+MARKDOWN_SCRIPTS_DIR=${MARKDOWN_SCRIPTS_DIR:-"${SCRIPTS_DIR}/markdown"}
+#echo "executeQuery: MARKDOWN_SCRIPTS_DIR=${MARKDOWN_SCRIPTS_DIR}" >&2
+
 # Overrideable Defaults
 NEO4J_HTTP_PORT=${NEO4J_HTTP_PORT:-"7474"} # Neo4j HTTP API port for executing queries
 NEO4J_HTTP_TRANSACTION_ENDPOINT=${NEO4J_HTTP_TRANSACTION_ENDPOINT:-"db/neo4j/tx/commit"} # Since Neo4j v5: "db/<name>/tx/commit", Neo4j v4: "db/data/transaction/commit"
@@ -149,8 +152,8 @@ if [[ -n "${error_message}" ]]; then
 fi
 
 if [ "${output_markdown_table}" = "true" ] ; then
-  echo "executeQuery: Will output in Markdown Table Format" >&2
-  echo -n "${cypher_query_result}" | "${SCRIPTS_DIR}/markdown/formatQueryResultAsMarkdownTable.sh"
+  #echo "executeQuery: Will output in Markdown Table Format" >&2
+  echo -n "${cypher_query_result}" | "${MARKDOWN_SCRIPTS_DIR}/formatQueryResultAsMarkdownTable.sh"
 else
   # Output results in CSV format
   if [ "${no_source_reference}" = true ] ; then

scripts/markdown/embedMarkdownIncludes.sh

@@ -1,6 +1,7 @@
 #!/usr/bin/env bash
 
-# Processes a template_markdown_file markdown file, replacing placeholders like "<!-- include:intro.md -->" with the contents of the specified markdown files. The files to include needs to be in the "includes" subdirectory.
+# Processes template markdown (sysin) replacing placeholders like "<!-- include:intro.md -->" with the contents of the specified markdown files. The files to include needs to be in the "includes" subdirectory.
+# Can take an optional input for the directory that contains the markdown files to be included/embedded (defaults to "includes").
 
 # Fail on any error ("-e" = exit on first error, "-o pipefail" exist on errors within piped commands)
 set -o errexit -o pipefail
@@ -12,10 +13,20 @@ set -o errexit -o pipefail
 MARKDOWN_SCRIPTS_DIR=${MARKDOWN_SCRIPTS_DIR:-$( CDPATH=. cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd -P )} # Repository directory containing the shell scripts for markdown
 #echo "embedMarkdownIncludes: MARKDOWN_SCRIPTS_DIR=${MARKDOWN_SCRIPTS_DIR}" >&2
 
-template_markdown_file="$1"
-include_directory="includes"
+# Read all input (including multiline) into markdown_template
+markdown_template=$(cat)
 
-awk -v include_directory="${include_directory}" '
+includes_directory="$1"
+if [ -z "${includes_directory}" ] ; then
+  includes_directory="./includes"
+  echo "embedMarkdownIncludes: Using default include directory ${includes_directory}." >&2
+fi
+if [ ! -d "${includes_directory}" ] ; then
+  echo "embedMarkdownIncludes: Couldn't find include directory ${includes_directory}." >&2
+  exit 2
+fi
+
+echo -n "${markdown_template}" | awk -v includes_directory="${includes_directory}" '
   # Check if the filename is safe
   function is_safe(path) {
     if (substr(path, 1, 1) == "/") return 0
@@ -24,7 +35,7 @@ awk -v include_directory="${include_directory}" '
   }
 
   function include_file(path,   fullpath, line) {
-    fullpath = include_directory "/" path
+    fullpath = includes_directory "/" path
 
     if (!is_safe(path)) {
       print "ERROR: illegal include path: " path > "/dev/stderr"
@@ -56,6 +67,6 @@ awk -v include_directory="${include_directory}" '
       print
     }
   }
-' "${template_markdown_file}"
+'
 
 #echo "embedMarkdownIncludes: $(date +'%Y-%m-%dT%H:%M:%S%z') Successfully finished." >&2

scripts/markdown/testEmbedMarkdownIncludes.sh

@@ -61,7 +61,7 @@ expected_test_include_content="This is the included content for the test."
 echo "${expected_test_include_content}" > "${temporaryTestDirectory}/${testIncludeFile}"
 
 # - Execute script under test
-embeddedContent=$(cd "${temporaryTestDirectory}"; "${MARKDOWN_SCRIPTS_DIR}/embedMarkdownIncludes.sh" "${testMarkdownTemplate}" )
+embeddedContent=$(cat "${testMarkdownTemplate}" | "${MARKDOWN_SCRIPTS_DIR}/embedMarkdownIncludes.sh" "${temporaryTestDirectory}/includes")
 
 # - Verify results
 if [ "${embeddedContent}" != "${expected_test_include_content}" ]; then
@@ -71,15 +71,33 @@ fi
 # ------------------------------------------------------------
 # Test case                                                 --
 # ------------------------------------------------------------
-echo "testEmbedMarkdownIncludes: 2.) A missing include file results in an error."
+echo "testEmbedMarkdownIncludes: 2.) An existing include file in the DEFAULT directory is correctly embedded."
 
 # - Setup
-testMarkdownTemplateMissingInclude="testMarkdownTemplateMissingInclude.md"
-echo "<!-- include:nonExistentFile.md -->" > "${temporaryTestDirectory}/${testMarkdownTemplateMissingInclude}"
+testIncludeFile="includes/testInclude.md"
+expected_test_include_content="This is the included content for the test."
+echo "${expected_test_include_content}" > "${temporaryTestDirectory}/${testIncludeFile}"
+
+# - Execute script under test
+embeddedContent=$(cd "${temporaryTestDirectory}"; cat "${testMarkdownTemplate}" | "${MARKDOWN_SCRIPTS_DIR}/embedMarkdownIncludes.sh")
+
+# - Verify results
+if [ "${embeddedContent}" != "${expected_test_include_content}" ]; then
+  fail "2.) Test failed: Expected embedded content to be '${expected_test_include_content}', but got '${embeddedContent}'."
+fi
+
+# ------------------------------------------------------------
+# Test case                                                 --
+# ------------------------------------------------------------
+echo "testEmbedMarkdownIncludes: 3.) A missing include file results in an error."
+
+# - Setup
+testMarkdownTemplateMissingInclude="${temporaryTestDirectory}/testMarkdownTemplateMissingInclude.md"
+echo "<!-- include:nonExistentFile.md -->" > "${testMarkdownTemplateMissingInclude}"
 
 # - Execute script under test
 set +o errexit
-errorOutput=$(cd "${temporaryTestDirectory}"; { "${MARKDOWN_SCRIPTS_DIR}/embedMarkdownIncludes.sh" "${testMarkdownTemplateMissingInclude}" 2>&1 1>/dev/null; } )
+errorOutput=$( { cat "${testMarkdownTemplateMissingInclude}" | "${MARKDOWN_SCRIPTS_DIR}/embedMarkdownIncludes.sh" "${temporaryTestDirectory}/includes" 2>&1 1>/dev/null; } )
 exitCode=$?
 set -o errexit