[AD-915] Auto Installer - JVM included (#124)

* [AD-915] Embed JRE into install. Simplify versioning of JDBC driver.

* [AD-915] Fixed setting the JDBC_DRIVER_VERSION

* [AD-915] Fixed setting the JDBC_DRIVER_VERSION

* [AD-915] Fixed setting the JDBC_DRIVER_VERSION

* [AD-915] Attempting to debug Windows 32-bit JDBC installer

* [AD-915] Attempting fix to Windows 32-bit JDBC installer

* [AD-915] Correct indentation formatting.

* [AD-915] Code review improvements.

* [AD-915] Temporary enable creating artifacts to get 32-bit installer.

* [AD-915] Remove unnecessary "verbose" on jpackage command.

* [AD-915] Fixed Platform setting in JDBC installer main.wxs.in

* [AD-915] Replace JDK installation with script on Windows.

* [AD-915] Attempt fix of JDK installation with script on Windows.

* [AD-915] Attempt fix of JDK installation with script on Windows.

* [AD-915] Increase tracing info for JDK installation with script on Windows.

* [AD-915] Change parameter to JDK installer script.

* [AD-915] Create JDKs directory, if not exists.

* [AD-915] Fix syntax - Create JDKs directory, if not exists.

* [AD-915] Fix location - Create JDKs directory, if not exists.

* [AD-915] Fix setting of JAVA_HOME environment variable in GitHub workflow.

* [AD-915] Get full path of JDKs folder.

* [AD-915] Fix Resolve-Path call.

* [AD-915] Add path to $JAVA_HOME/bin

* [AD-915] Refactor code to use 'jlink' and create a runtime image instead of application for 'jpackage'.

* [AD-915] Attempt to build Windows 32-bit installer using 'jpackage'.

* [AD-915] Attempt #2 to build Windows 32-bit installer using 'jpackage'.

* [AD-915] More clean-up and make release artifacts smaller/cleaner.

* [AD-915] Attempt to fix clean-up and make release artifacts smaller/cleaner.

* [AD-915] Attempt #2 to fix clean-up and make release artifacts smaller/cleaner.

* [AD-915] Attempt #3 to clean-up and make release artifacts smaller/cleaner.

* [AD-915] Attempt #4 to clean-up and make release artifacts smaller/cleaner.

* [AD-915] Remove commented unused code.

* [AD-915] Fix path to JVM.dll in JDBC installer template.

* [AD-915] Set artifacts to be made on push to the develop branch.

* [AD-915] Improve naming and version numbers for installer

* [AD-915] Remove unused icon file.

* [AD-915] Rename a installer resource for better clarity.

* [AD-915] Add tracing for JLINK_VERSION.

* [AD-915] Fix issue with JLINK_VERSION having more than 3 version components.

* [AD-915] Code review changes.

* [AD-915] Revert code to create artifacts - so now only on push to develop branch.

Author: Bruce Irschick

.github/workflows/linux-build.yml

@@ -27,7 +27,6 @@ env:
   DOC_DB_ODBC_INTEGRATION_TEST: 1
   DOC_DB_LOG_PATH: "${{github.workspace}}/build/odbc/logs"
   DOC_DB_LOG_LEVEL: "debug"
-  JDBC_DRIVER_VERSION: "1.3.1"
   JAVA_HOME: "/usr/lib/jvm/java-17-amazon-corretto/"
 
 jobs:
@@ -71,6 +70,11 @@ jobs:
         sudo apt update
         sudo apt install libcurl4-openssl-dev libssl-dev uuid-dev zlib1g-dev libpulse-dev linux-headers-$(uname -r) gcc gcc-multilib  g++ g++-multilib linux-headers-$(uname -r) build-essential valgrind libboost-all-dev libbson-dev libsasl2-dev lcov
 
+    - name: Update environment with JDBC_DRIVER_VERSION
+      run: |
+        read -r JDBC_DRIVER_VERSION < ./src/JDBC_DRIVER_VERSION.txt
+        echo "JDBC_DRIVER_VERSION=$JDBC_DRIVER_VERSION" >> $GITHUB_ENV
+
     - name: Cache DocumentDB JDBC JAR
       id: cache-documentdb-jdbc-jar
       uses: actions/cache@v3
@@ -214,6 +218,11 @@ jobs:
         sudo apt update
         sudo apt install libcurl4-openssl-dev libssl-dev uuid-dev zlib1g-dev libpulse-dev linux-headers-$(uname -r) gcc gcc-multilib  g++ g++-multilib linux-headers-$(uname -r) build-essential valgrind libboost-all-dev libbson-dev libsasl2-dev lcov
 
+    - name: Update environment with JDBC_DRIVER_VERSION
+      run: |
+        read -r JDBC_DRIVER_VERSION < ./src/JDBC_DRIVER_VERSION.txt
+        echo "JDBC_DRIVER_VERSION=$JDBC_DRIVER_VERSION" >> $GITHUB_ENV
+
     - name: Cache DocumentDB JDBC JAR
       id: cache-documentdb-jdbc-jar
       uses: actions/cache@v3

.github/workflows/mac-build.yml

@@ -27,7 +27,6 @@ env:
   DOC_DB_ODBC_INTEGRATION_TEST: 1
   DOC_DB_LOG_PATH: "${{github.workspace}}/build/odbc/logs"
   DOC_DB_LOG_LEVEL: "debug"
-  JDBC_DRIVER_VERSION: "1.3.1"
   ODBCINSTINI: "${{github.workspace}}/build/odbc/lib/documentdb-odbc-install.ini"
   ODBCINI: "${{github.workspace}}/odbc.ini"
 
@@ -64,6 +63,11 @@ jobs:
         chmod +x scripts/install_dependencies_mac.sh
         ./scripts/install_dependencies_mac.sh
 
+    - name: Update environment with JDBC_DRIVER_VERSION
+      run: |
+        read -r JDBC_DRIVER_VERSION < ./src/JDBC_DRIVER_VERSION.txt
+        echo "JDBC_DRIVER_VERSION=$JDBC_DRIVER_VERSION" >> $GITHUB_ENV
+
     - name: Cache DocumentDB JDBC JAR
       id: cache-documentdb-jdbc-jar
       uses: actions/cache@v3

.github/workflows/mac-debug-build.yml

@@ -27,7 +27,6 @@ env:
   DOC_DB_ODBC_INTEGRATION_TEST: 1
   DOC_DB_LOG_PATH: "${{github.workspace}}/build/odbc/logs"
   DOC_DB_LOG_LEVEL: "debug"
-  JDBC_DRIVER_VERSION: "1.3.1"
   ODBCINSTINI: "${{github.workspace}}/build/odbc/lib/documentdb-odbc-install.ini"
   ODBCINI: "${{github.workspace}}/odbc.ini"
 
@@ -71,6 +70,11 @@ jobs:
         echo "/Library/Developer/CommandLineTools/usr/bin" >> $GITHUB_PATH
         echo "/usr/local/bin/" >> $GITHUB_PATH
 
+    - name: Update environment with JDBC_DRIVER_VERSION
+      run: |
+        read -r JDBC_DRIVER_VERSION < ./src/JDBC_DRIVER_VERSION.txt
+        echo "JDBC_DRIVER_VERSION=$JDBC_DRIVER_VERSION" >> $GITHUB_ENV
+
     - name: Cache DocumentDB JDBC JAR
       id: cache-documentdb-jdbc-jar
       uses: actions/cache@v3

.github/workflows/win-build.yml

@@ -29,7 +29,6 @@ env:
   DOC_DB_PRIV_KEY_FILE: ~/certs/docdb-sshtunnel.pem
   DOC_DB_LOG_PATH: "${{github.workspace}}/build/odbc/logs"
   DOC_DB_LOG_LEVEL: "debug"
-  JDBC_DRIVER_VERSION: "1.3.1"
   MONGO_IMPORT_COMMAND: "mongoimport.exe"
   # Artifacts are created when pushing to develop branch on merge of pull requests.
   SHOULD_CREATE_ARTIFACTS: ${{ github.event_name == 'push' && github.ref == 'refs/heads/develop' }}
@@ -61,16 +60,36 @@ jobs:
       run: |
         Get-Content ./src/ODBC_DRIVER_VERSION.txt | ForEach-Object { echo "ODBC_DRIVER_VERSION=$_"; break; } >> $env:GITHUB_ENV
 
-    - name: Get Java distribution
+    - name: Update environment with JDBC_DRIVER_VERSION
+      shell: pwsh
+      run: |
+        echo "JDBC_DRIVER_VERSION=$($(Get-Content -Path ./src/JDBC_DRIVER_VERSION.txt -Raw).ToString().Trim())" >> $env:GITHUB_ENV
+
+    # Get first JDK to provide access to jpackage
+    - name: Get Java distribution (JDK 17, 32-bit)
       uses: actions/setup-java@v2
       with:
         distribution: 'temurin'
         java-version: '17'
         architecture: x86
 
+    # Get second JDK to provide access to jlink
+    - name: Get Java distribution (JDK 11, 32-bit)
+      shell: pwsh
+      run: |
+        . ./scripts/functions_win.ps1
+        Install-JavaJdk -InstallParentPath "jdks" -PlatformArchitecture "x86" -JdkVersion "11"
+        echo "JAVA_HOME=$env:JAVA_HOME" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
+
     - name: "Update path for Java"
       run: |
-        echo "${{ env.JAVA_HOME }}\bin\server" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
+        echo "${{env.JAVA_HOME}}\bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
+        echo "${{env.JAVA_HOME}}\bin\server" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
+
+    - name: Ensure jlink and jpackage have the expected versions
+      run: |
+        if ( -not ((jlink --version) -like "11*") ) { exit 1 }
+        if ( -not ((jpackage --version) -like "17*") ) { exit 1 }
 
     - name: "Update path for WIX Toolset"
       run: |
@@ -134,7 +153,14 @@ jobs:
       uses: actions/upload-artifact@v3
       with:
         name: docdb-odbc-driver-win32-${{env.ODBC_DRIVER_VERSION}}
-        path: build/odbc/cmake/Release
+        path: |
+          build/odbc/cmake/Release/*.dll
+          build/odbc/cmake/Release/*.msi
+          build/odbc/cmake/Release/*.exe
+          build/odbc/cmake/Release/*.pdb
+          !build/odbc/cmake/Release/images
+          !build/odbc/cmake/Release/jpackage-resources
+          !build/odbc/cmake/Release/runtime-image
 
     - name: Upload performance test at push to develop
       if: ${{env.SHOULD_CREATE_ARTIFACTS == 'true'}}
@@ -229,15 +255,21 @@ jobs:
       run: |
         Get-Content ./src/ODBC_DRIVER_VERSION.txt | ForEach-Object { echo "ODBC_DRIVER_VERSION=$_"; break; } >> $env:GITHUB_ENV
 
+    - name: Update environment with JDBC_DRIVER_VERSION
+      shell: pwsh
+      run: |
+        echo "JDBC_DRIVER_VERSION=$($(Get-Content -Path ./src/JDBC_DRIVER_VERSION.txt -Raw).ToString().Trim())" >> $env:GITHUB_ENV
+
     - name: Get Java distribution
-      uses: actions/setup-java@v2
-      with:
-        distribution: 'temurin'
-        java-version: '17'
-        architecture: x64
+      shell: pwsh
+      run: |
+        . ./scripts/functions_win.ps1
+        Install-JavaJdk -InstallParentPath "jdks" -PlatformArchitecture "x64"
+        echo "JAVA_HOME=$env:JAVA_HOME" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
 
     - name: "Update path for Java"
       run: |
+        echo "${{env.JAVA_HOME}}\bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
         echo "${{env.JAVA_HOME}}\bin\server" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
 
     - name: "Update path for WIX Toolset"
@@ -301,7 +333,14 @@ jobs:
       uses: actions/upload-artifact@v3
       with:
         name: docdb-odbc-driver-amd64-${{env.ODBC_DRIVER_VERSION}}
-        path: build/odbc/cmake/Release
+        path: |
+          build/odbc/cmake/Release/*.dll
+          build/odbc/cmake/Release/*.msi
+          build/odbc/cmake/Release/*.exe
+          build/odbc/cmake/Release/*.pdb
+          !build/odbc/cmake/Release/images
+          !build/odbc/cmake/Release/jpackage-resources
+          !build/odbc/cmake/Release/runtime-image
 
     - name: Upload performance test at push to develop
       if: ${{env.SHOULD_CREATE_ARTIFACTS == 'true'}}
@@ -367,15 +406,21 @@ jobs:
     steps:
     - uses: actions/checkout@v2
 
+    - name: Update environment with JDBC_DRIVER_VERSION
+      shell: pwsh
+      run: |
+        echo "JDBC_DRIVER_VERSION=$($(Get-Content -Path ./src/JDBC_DRIVER_VERSION.txt -Raw).ToString().Trim())" >> $env:GITHUB_ENV
+
     - name: Get Java distribution
-      uses: actions/setup-java@v2
-      with:
-        distribution: 'temurin'
-        java-version: '17'
-        architecture: x64
+      shell: pwsh
+      run: |
+        . ./scripts/functions_win.ps1
+        Install-JavaJdk -InstallParentPath "jdks" -PlatformArchitecture "x64"
+        echo "JAVA_HOME=$env:JAVA_HOME" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
 
     - name: "Update path for Java"
       run: |
+        echo "${{env.JAVA_HOME}}\bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
         echo "${{env.JAVA_HOME}}\bin\server" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
 
     - name: "Update path for WIX Toolset"

build_linux_debug64.sh

@@ -12,9 +12,7 @@ cmake ../src -DCMAKE_BUILD_TYPE="$BUILD_TYPE" -DCODE_COVERAGE="ON" -DBUILD_SHARE
 cd ..
 
 # Download the DocumentDB JDBC Driver
-if [ -z "$JDBC_DRIVER_VERSION" ]; then 
-    JDBC_DRIVER_VERSION="1.3.1"
-fi
+read -r JDBC_DRIVER_VERSION < "${PROJECT_DIR}/src/odbc/JDBC_DRIVER_VERSION.txt"
 JDBC_DRIVER_FILENAME="documentdb-jdbc-$JDBC_DRIVER_VERSION-all.jar"
 JDBC_DRIVER_FULLPATH="$DRIVER_BIN_DIR/libs/$JDBC_DRIVER_FILENAME"
 export DOCUMENTDB_HOME="$DRIVER_BIN_DIR"

build_linux_release64_deb.sh

@@ -9,9 +9,7 @@ cmake ../src -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DCODE_COVERAGE="OFF" -DBUILD_SHARED
 cd ..
 
 # Download the DocumentDB JDBC Driver
-if [ -z "$JDBC_DRIVER_VERSION" ]; then
-    JDBC_DRIVER_VERSION="1.3.1"
-fi
+read -r JDBC_DRIVER_VERSION < "${PROJECT_DIR}/src/odbc/JDBC_DRIVER_VERSION.txt"
 JDBC_DRIVER_FILENAME="documentdb-jdbc-$JDBC_DRIVER_VERSION-all.jar"
 JDBC_DRIVER_FULLPATH="$DRIVER_BIN_DIR/libs/$JDBC_DRIVER_FILENAME"
 export DOCUMENTDB_HOME="$DRIVER_BIN_DIR"

build_mac_debug64.sh

@@ -12,9 +12,7 @@ cmake ../src -DCMAKE_BUILD_TYPE="$BUILD_TYPE" -DCODE_COVERAGE="ON" -DBUILD_SHARE
 cd ..
 
 # Download the DocumentDB JDBC Driver
-if [ -z "$JDBC_DRIVER_VERSION" ]; then 
-    JDBC_DRIVER_VERSION="1.3.1"
-fi
+read -r JDBC_DRIVER_VERSION < "${PROJECT_DIR}/src/odbc/JDBC_DRIVER_VERSION.txt"
 JDBC_DRIVER_FILENAME="documentdb-jdbc-$JDBC_DRIVER_VERSION-all.jar"
 JDBC_DRIVER_FULLPATH="$DRIVER_BIN_DIR/libs/$JDBC_DRIVER_FILENAME"
 export DOCUMENTDB_HOME="$DRIVER_BIN_DIR"

build_mac_release64.sh

@@ -9,9 +9,7 @@ cmake ../src -DCMAKE_BUILD_TYPE="$BUILD_TYPE" -DCODE_COVERAGE="OFF" -DBUILD_SHAR
 make -j 4
 
 # Download the DocumentDB JDBC Driver
-if [ -z "$JDBC_DRIVER_VERSION" ]; then 
-    JDBC_DRIVER_VERSION="1.3.1"
-fi
+read -r JDBC_DRIVER_VERSION < "${PROJECT_DIR}/src/odbc/JDBC_DRIVER_VERSION.txt"
 JDBC_DRIVER_FILENAME="documentdb-jdbc-$JDBC_DRIVER_VERSION-all.jar"
 JDBC_DRIVER_FULLPATH="$DRIVER_BIN_DIR/libs/$JDBC_DRIVER_FILENAME"
 export DOCUMENTDB_HOME="$DRIVER_BIN_DIR"

scripts/build_windows.ps1

@@ -20,7 +20,7 @@ $DRIVER_SOURCE_DIR = "${WORKING_DIR}\src"
 $DRIVER_BUILD_DIR = "${BUILD_DIR}\odbc\cmake"
 
 # Download the JDBC driver
-$JDBC_DRIVER_VERSION = if ($JDBC_DRIVER_VERSION -eq $null) { "1.3.1" } else { $JDBC_DRIVER_VERSION }
+$JDBC_DRIVER_VERSION = $($(Get-Content -Path ./src/JDBC_DRIVER_VERSION.txt -Raw).ToString().Trim())
 $JDBC_DRIVER_FILENAME = "documentdb-jdbc-$JDBC_DRIVER_VERSION-all.jar"
 $JDBC_DRIVER_FULLPATH = "$DRIVER_BUILD_DIR\$CONFIGURATION\libs\$JDBC_DRIVER_FILENAME"
 if (-not (Test-Path -Path $JDBC_DRIVER_FULLPATH -PathType Leaf)) {