Support windows tested in git bash

Author: JohT

README.md

@@ -37,7 +37,8 @@ Here are some reports that utilize Neo4j's [Graph Data Science Library](https://
 
 ## 🛠 Prerequisites
 
-- Java 17 is required (June 2023 Neo4j 5.x requirement)
+- Java 17 is [required for Neo4j](https://neo4j.com/docs/operations-manual/current/installation/requirements/#deployment-requirements-software) (5.x requirement)
+- [jq](https://github.com/jqlang/jq) the "lightweight and flexible command-line JSON processor" needs to be installed. Latest releases: https://github.com/jqlang/jq/releases/latest. Check using `jq --version`.
 - Python and a conda package manager are required for Jupyter Notebook reports
 - Chromium will automatically be downloaded if needed for Jupyter Notebook reports in PDF format
 

scripts/downloadMavenArtifact.sh

@@ -70,7 +70,7 @@ DOWNLOAD_URL="${BASE_URL}/${GROUP_ID_FOR_API}/${artifactId}/${version}/${ARTIFAC
 
 # Download Maven Artifact into the "targetDirectory"
 if [ ! -f "./${targetDirectory}/${ARTIFACT_FILENAME}" ] ; then
-    source ${SCRIPTS_DIR}/download.sh --url "${DOWNLOAD_URL}"
+    source "${SCRIPTS_DIR}/download.sh" --url "${DOWNLOAD_URL}"
 
     # Create artifacts targetDirectory if it doen't exist
     mkdir -p "./${targetDirectory}"

scripts/executeQueryFunctions.sh

@@ -49,7 +49,7 @@ execute_cypher_expect_results() {
 # Function to execute a cypher query from the given file (first and only argument) using Neo4j's HTTP API
 execute_cypher_http() { 
     # (Neo4j HTTP API Script) Execute the Cyper query contained in the file and print the results as CSV
-    source $SCRIPTS_DIR/executeQuery.sh "${@}" # "${@}": Get all function arguments and forward them
+    source "$SCRIPTS_DIR/executeQuery.sh" "${@}" # "${@}": Get all function arguments and forward them
 }
 
 # Function to execute a cypher query from the given file (first and only argument) with a summarized (console) output using Neo4j's HTTP API

scripts/setupJQAssistant.sh

@@ -52,7 +52,7 @@ JQASSISTANT_INSTALLATION_DIRECTORY="${TOOLS_DIRECTORY}/${JQASSISTANT_INSTALLATIO
 if [ ! -d "${JQASSISTANT_INSTALLATION_DIRECTORY}" ] ; then    
     jqassistant_cli_fulldownload_url=${JQASSISTANT_CLI_DOWNLOAD_URL}/${JQASSISTANT_CLI_ARTIFACT}/${JQASSISTANT_CLI_VERSION}/${JQASSISTANT_CLI_ARTIFACT}-${JQASSISTANT_CLI_VERSION}-${JQASSISTANT_CLI_DISTRIBUTION}
     jqassistant_cli_fulldownload_file="${JQASSISTANT_INSTALLATION_NAME}.zip"
-    source ${SCRIPTS_DIR}/download.sh --url "${jqassistant_cli_fulldownload_url}" --filename "${jqassistant_cli_fulldownload_file}"
+    source "${SCRIPTS_DIR}/download.sh" --url "${jqassistant_cli_fulldownload_url}" --filename "${jqassistant_cli_fulldownload_file}"
 
     # Unpack the ZIP file (-q option for less verbose output)
     unzip -q "${SHARED_DOWNLOADS_DIRECTORY}/${jqassistant_cli_fulldownload_file}" -d "${TOOLS_DIRECTORY}"

scripts/setupNeo4j.sh

@@ -71,11 +71,22 @@ fi
 # Download and extract Neo4j
 if [ ! -d "${NEO4J_INSTALLATION_DIRECTORY}" ] ; then
 
-    neo4jDownloadArchiveFileName="${NEO4J_INSTALLATION_NAME}-unix.tar.gz"
-    source ${SCRIPTS_DIR}/download.sh --url "https://dist.neo4j.org/${neo4jDownloadArchiveFileName}" || exit 1
+    neo4jInstallationSystemPostfix="unix.tar.gz"
+    if [[ "$OSTYPE" == "cygwin" ]] || [[ "$OSTYPE" == "msys" ]] || [[ "$OSTYPE" == "win32" ]]; then
+        neo4jInstallationSystemPostfix="windows.zip"
+    fi
+    echo "setupNeo4j: Using ${neo4jInstallationSystemPostfix} for operating system type ${OSTYPE}"
+
+    neo4jDownloadArchiveFileName="${NEO4J_INSTALLATION_NAME}-${neo4jInstallationSystemPostfix}"
+    source "${SCRIPTS_DIR}/download.sh" --url "https://dist.neo4j.org/${neo4jDownloadArchiveFileName}" || exit 1
 
-    # Extract the tar file
-    tar -xf "${SHARED_DOWNLOADS_DIRECTORY}/${neo4jDownloadArchiveFileName}" --directory "${TOOLS_DIRECTORY}" || exit 1
+    if [[ ${neo4jInstallationSystemPostfix} == "unix.tar.gz" ]]; then
+        # Extract the unix tar file
+        tar -xf "${SHARED_DOWNLOADS_DIRECTORY}/${neo4jDownloadArchiveFileName}" --directory "${TOOLS_DIRECTORY}" || exit 1
+    else
+        # Unpack the windows ZIP file (-q option for less verbose output, ignore warnings (backslash) with || true)
+        unzip -q "${SHARED_DOWNLOADS_DIRECTORY}/${neo4jDownloadArchiveFileName}" -d "${TOOLS_DIRECTORY}" || true
+    fi
 
     # Fail if Neo4j hadn't been downloaded successfully
     if [ ! -d "${NEO4J_INSTALLATION_DIRECTORY}" ] ; then
@@ -136,7 +147,7 @@ if [ ! -d "${NEO4J_INSTALLATION_DIRECTORY}" ] ; then
 
     # Set initial password for user "neo4j" otherwise the default password "neo4j" would need to be changed immediately (prompt).
     # This needs to be done after the configuration changes.
-    source ${SCRIPTS_DIR}/setupNeo4jInitialPassword.sh
+    source "${SCRIPTS_DIR}/setupNeo4jInitialPassword.sh"
 
     echo "setupNeo4j: Installed sucessfully"
 else
@@ -146,7 +157,7 @@ fi
 # Download and Install the Neo4j Plugin "Awesome Procedures for Neo4j" (APOC)
 if [ ! -f "${NEO4J_PLUGINS}/${NEO4J_APOC_PLUGIN_ARTIFACT}" ] ; then
 
-    source ${SCRIPTS_DIR}/download.sh --url "https://github.com/${NEO4J_APOC_PLUGIN_GITHUB}/releases/download/${NEO4J_APOC_PLUGIN_VERSION}/${NEO4J_APOC_PLUGIN_ARTIFACT}" || exit 1
+    source "${SCRIPTS_DIR}/download.sh" --url "https://github.com/${NEO4J_APOC_PLUGIN_GITHUB}/releases/download/${NEO4J_APOC_PLUGIN_VERSION}/${NEO4J_APOC_PLUGIN_ARTIFACT}" || exit 1
 
     # Uninstall previously installed Neo4j Plugin "Awesome Procedures for Neo4j" (APOC)
     rm -f "${NEO4J_PLUGINS}/apoc*.jar"
@@ -192,7 +203,7 @@ fi
 
 if [ ! -f "${NEO4J_PLUGINS}/${neo4jGraphDataScienceReleaseArtifact}" ] ; then
     # Download the Neo4j Plugin "Graph Data Science" (GDS)
-    source ${SCRIPTS_DIR}/download.sh --url "${neo4jGraphDataScienceDownloadUrl}/${neo4jGraphDataScienceReleaseArtifact}" || exit 1
+    source "${SCRIPTS_DIR}/download.sh" --url "${neo4jGraphDataScienceDownloadUrl}/${neo4jGraphDataScienceReleaseArtifact}" || exit 1
 
     # Uninstall previously installed Neo4j Plugin "Graph Data Science" (GDS)
     rm -f "${NEO4J_PLUGINS}/*graph-data-science*.jar"

scripts/setupNeo4jInitialPassword.sh

@@ -30,6 +30,12 @@ fi
 # Print the environment variable NEO4J_HOME that is used to execute the command
 echo "setupNeo4jInitialPassword: Using ${NEO4J_INSTALLATION_DIRECTORY} as NEO4J_HOME"
 
+isWindows=false
+if [[ "$OSTYPE" == "cygwin" ]] || [[ "$OSTYPE" == "msys" ]] || [[ "$OSTYPE" == "win32" ]]; then
+    isWindows=true
+fi
+echo "setupNeo4jInitialPassword: Detected isWindows=${isWindows} for operating system type ${OSTYPE}"
+
 # Extract the first component of the version number (=major version number)
 NEO4J_MAJOR_VERSION_NUMBER=$(echo "$NEO4J_VERSION" | cut -d'.' -f1)
 
@@ -38,12 +44,20 @@ if [[ "$NEO4J_MAJOR_VERSION_NUMBER" -ge 5 ]]; then
     echo "setupNeo4jInitialPassword: Neo4j v5 or higher detected"
     # Neo4j version < 5
     # Set the initial password using a temporary NEO4J_HOME environment variable pointing to the current setup
-    NEO4J_HOME="${NEO4J_INSTALLATION_DIRECTORY}" ${NEO4J_INSTALLATION_DIRECTORY}/bin/neo4j-admin dbms set-initial-password "${NEO4J_INITIAL_PASSWORD}"
+    if [ "${isWindows}" = true ] ; then
+        NEO4J_HOME="${NEO4J_INSTALLATION_DIRECTORY}" "${NEO4J_INSTALLATION_DIRECTORY}/bin/neo4j-admin.bat" dbms set-initial-password "${NEO4J_INITIAL_PASSWORD}"
+    else
+        NEO4J_HOME="${NEO4J_INSTALLATION_DIRECTORY}" "${NEO4J_INSTALLATION_DIRECTORY}/bin/neo4j-admin" dbms set-initial-password "${NEO4J_INITIAL_PASSWORD}"
+    fi
 else
     echo "setupNeo4jInitialPassword: Neo4j v4 or lower detected"
     # Neo4j version >= 5
     # Set the initial password using a temporary NEO4J_HOME environment variable pointing to the current setup
-    NEO4J_HOME="${NEO4J_INSTALLATION_DIRECTORY}" ${NEO4J_INSTALLATION_DIRECTORY}/bin/neo4j-admin set-initial-password "${NEO4J_INITIAL_PASSWORD}"
+    if [ "${isWindows}" = true ] ; then
+        NEO4J_HOME="${NEO4J_INSTALLATION_DIRECTORY}" "${NEO4J_INSTALLATION_DIRECTORY}/bin/neo4j-admin.bat" set-initial-password "${NEO4J_INITIAL_PASSWORD}"
+    else
+        NEO4J_HOME="${NEO4J_INSTALLATION_DIRECTORY}" "${NEO4J_INSTALLATION_DIRECTORY}/bin/neo4j-admin" set-initial-password "${NEO4J_INITIAL_PASSWORD}"
+    fi
 fi
 
 echo "setupNeo4jInitialPassword: Initial password set sucessfully"

scripts/startNeo4j.sh

@@ -83,4 +83,4 @@ if [ -n "${neo4jNotRunning}" ]; then
     exit 1
 fi
 
-source ${SCRIPTS_DIR}/waitForNeo4jHttp.sh || exit 1
+source "${SCRIPTS_DIR}/waitForNeo4jHttp.sh" || exit 1