Update Windows build and deploy Github Action to use Wix

Author: retiutut

.github/workflows/windows_build_deploy.yml

@@ -12,89 +12,137 @@ permissions:
   contents: read
 
 env:
-  AWS_REGION : us-east-1
+  AWS_REGION: us-east-1
 
 jobs:
   build:
     name: Build for Windows
     runs-on: windows-latest
 
     steps:
-    - name: Clone Repository
-      uses: actions/checkout@v3
-
-    - name: Install Python 3.9
-      uses: actions/setup-python@v4
-      with:
-        python-version: '3.9'
-        architecture: 'x64'
-
-    - name: Install Processing
-      run: |
-        mkdir %GITHUB_WORKSPACE%\processing
-        cd %GITHUB_WORKSPACE%\processing
-        curl -O -L --insecure https://github.com/processing/processing4/releases/download/processing-1292-4.2/processing-4.2-windows-x64.zip
-        ls -l %GITHUB_WORKSPACE%\processing
-        unzip processing-4.2-windows-x64.zip
-        ls -l %GITHUB_WORKSPACE%\processing\processing-4.2
-        mkdir %userprofile%\documents\processing\libraries
-        xcopy %GITHUB_WORKSPACE%\OpenBCI_GUI\libraries\* %userprofile%\documents\processing\libraries /s /i /q
-        ls -l %userprofile%\documents\processing\libraries
-      shell: cmd
-    
-    - name: Set Path
-      run: |
-        echo %GITHUB_WORKSPACE%\processing\processing-4.2>>%GITHUB_PATH%
-        echo C:\Program Files (x86)\Windows Kits\10\bin\10.0.22621.0\x64>>%GITHUB_PATH%
-      shell: cmd
-
-    - name: Print Path
-      run: echo %PATH%
-      shell: cmd
-
-    - name: Check processing-java Command
-      run: processing-java --help
-      shell: cmd
-
-    - name: Run Unit Tests
-      run: python %GITHUB_WORKSPACE%\GuiUnitTests\run-unittests.py
-      shell: cmd
-
-    - name: Build
-      run: python %GITHUB_WORKSPACE%\release\build.py
-      shell: cmd
-
-    - name: Sign
-      run: |
-        dotnet tool install --global azuresigntool
-        mt -manifest %GITHUB_WORKSPACE%\release\windows\gui.manifest -outputresource:%GITHUB_WORKSPACE%\application.windows64\OpenBCI_GUI.exe;#1
-        mt -manifest %GITHUB_WORKSPACE%\release\windows\java.manifest -outputresource:%GITHUB_WORKSPACE%\application.windows64\java\bin\java.exe;#1
-        mt -manifest %GITHUB_WORKSPACE%\release\windows\javaw.manifest -outputresource:%GITHUB_WORKSPACE%\application.windows64\java\bin\javaw.exe;#1
-        azuresigntool sign --azure-key-vault-url "${{ secrets.AZURE_KEY_VAULT_URI }}" --azure-key-vault-client-id "${{ secrets.AZURE_CLIENT_ID }}" --azure-key-vault-tenant-id "${{ secrets.AZURE_TENANT_ID }}" --azure-key-vault-client-secret "${{ secrets.AZURE_CLIENT_SECRET }}" --azure-key-vault-certificate "${{ secrets.AZURE_CERT_NAME }}" --timestamp-rfc3161 http://timestamp.digicert.com --verbose %GITHUB_WORKSPACE%\application.windows64\OpenBCI_GUI.exe
-      shell: cmd
-  
-    - name: Package
-      run: python %GITHUB_WORKSPACE%\release\package.py
-      shell: cmd
-
-    - name: Configure AWS credentials
-      uses: aws-actions/configure-aws-credentials@v2
-      with:
-        role-to-assume: ${{ secrets.AWS_ROLE_TO_ASSUME }}
-        aws-region: ${{ env.AWS_REGION }}
-
-    - name: Get Branch Names
-      id: branch-name
-      uses: tj-actions/branch-names@v7
-
-    - name: Store Build on AWS
-      run: |
-        cd ${{ github.workspace }}
-        ls
-        echo "${{ steps.branch-name.outputs.head_ref_branch }}"
-        set S3_BRANCH_FOLDER=s3://openbci-public-gui-v6/${{ steps.branch-name.outputs.head_ref_branch }}
-        echo %S3_BRANCH_FOLDER%
-        aws s3 rm s3://openbci-public-gui-v6/latest  --recursive --exclude "*" --include "openbcigui_*_windows64.zip"
-        aws s3 cp ${{ github.workspace }}/. %S3_BRANCH_FOLDER%  --recursive --exclude "*" --include "openbcigui_*_windows64.zip"
-        aws s3 cp ${{ github.workspace }}/. s3://openbci-public-gui-v6/latest  --recursive --exclude "*" --include "openbcigui_*_windows64.zip"
-      shell: cmd
+      - name: Clone Repository
+        uses: actions/checkout@v4
+
+      - name: Install Python 3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.9'
+          architecture: 'x64'
+
+      - name: Install Processing
+        run: |
+          mkdir %GITHUB_WORKSPACE%\processing
+          cd %GITHUB_WORKSPACE%\processing
+          curl -O -L --insecure https://github.com/processing/processing4/releases/download/processing-1292-4.2/processing-4.2-windows-x64.zip
+          ls -l %GITHUB_WORKSPACE%\processing
+          unzip processing-4.2-windows-x64.zip
+          ls -l %GITHUB_WORKSPACE%\processing\processing-4.2
+          mkdir %userprofile%\documents\processing\libraries
+          xcopy %GITHUB_WORKSPACE%\OpenBCI_GUI\libraries\* %userprofile%\documents\processing\libraries /s /i /q
+          ls -l %userprofile%\documents\processing\libraries
+        shell: cmd
+
+      - name: Set Path
+        run: |
+          echo %GITHUB_WORKSPACE%\processing\processing-4.2>>%GITHUB_PATH%
+          echo C:\Program Files (x86)\Windows Kits\10\bin\10.0.22621.0\x64>>%GITHUB_PATH%
+        shell: cmd
+
+      - name: Print Path
+        run: echo %PATH%
+        shell: cmd
+
+      - name: Check processing-java Command
+        run: processing-java --help
+        shell: cmd
+
+      - name: Update Processing Application Icon File
+        run: |
+          echo ${{ env.gui-icon-parent-folder }}
+          ls -l ${{ env.gui-icon-parent-folder }}
+          echo ${{ env.processing-icon-path }}
+          ls -l ${{ env.processing-icon-path }}
+          xcopy ${{ env.gui-icon-path }} ${{ env.processing-icon-path }} /i /y
+        env:
+          gui-icon-parent-folder: ${{ github.workspace }}\release\windows\icons\application
+          gui-icon-path: ${{ github.workspace }}\release\windows\icons\application\application.ico
+          processing-icon-path: ${{ github.workspace }}\processing\processing-4.2\modes\java\application
+
+      - name: Update Processing Core Icon Files
+        run: |
+          ren ${{ env.processing-core-folder }}\core.jar core.zip
+          mkdir ${{ env.processing-core-icon-path }}
+          ls -l ${{ env.processing-core-folder }}
+          unzip ${{ env.processing-core-folder }}\core.zip -d ${{ env.processing-core-unzip-path }}
+          del ${{ env.processing-core-folder }}\core.zip
+          xcopy ${{ env.gui-core-icon-path }} ${{ env.processing-core-icon-path }} /e /i /y
+          cd ${{ env.processing-core-unzip-path }}
+          ls -l
+          7z a -r core.zip *
+          ren core.zip core.jar
+          echo "Updated Processing Core Icon Files"
+          ls -l
+          move core.jar ${{ env.processing-core-updated-jar-path }}
+          cd ${{ env.processing-core-updated-jar-path }}
+          rmdir ${{ env.processing-core-icon-path }} /s /q
+          ls -l
+        env:
+          processing-core-folder: ${{ github.workspace }}\processing\processing-4.2\core\library\
+          processing-core-unzip-path: ${{ github.workspace }}\processing\processing-4.2\core\library\core
+          gui-core-icon-path: ${{ github.workspace }}\release\windows\icons\core\*
+          processing-core-icon-path: ${{ github.workspace }}\processing\processing-4.2\core\library\core\icon
+          processing-core-updated-jar-path: ${{ github.workspace }}\processing\processing-4.2\core\library\
+        shell: cmd
+
+      - name: Run Unit Tests
+        run: python %GITHUB_WORKSPACE%\GuiUnitTests\run-unittests.py
+        shell: cmd
+
+      - name: Build
+        run: python %GITHUB_WORKSPACE%\release\build.py
+        shell: cmd
+
+      - name: Sign Executables
+        if: ${{ true }}
+        run: |
+          dotnet tool install --global azuresigntool
+          mt -manifest %GITHUB_WORKSPACE%\release\windows\gui.manifest -outputresource:%GITHUB_WORKSPACE%\application.windows64\OpenBCI_GUI.exe;#1
+          mt -manifest %GITHUB_WORKSPACE%\release\windows\java.manifest -outputresource:%GITHUB_WORKSPACE%\application.windows64\java\bin\java.exe;#1
+          mt -manifest %GITHUB_WORKSPACE%\release\windows\javaw.manifest -outputresource:%GITHUB_WORKSPACE%\application.windows64\java\bin\javaw.exe;#1
+          azuresigntool sign --azure-key-vault-url "${{ secrets.AZURE_KEY_VAULT_URI }}" --azure-key-vault-client-id "${{ secrets.AZURE_CLIENT_ID }}" --azure-key-vault-tenant-id "${{ secrets.AZURE_TENANT_ID }}" --azure-key-vault-client-secret "${{ secrets.AZURE_CLIENT_SECRET }}" --azure-key-vault-certificate "${{ secrets.AZURE_CERT_NAME }}" --timestamp-rfc3161 http://timestamp.digicert.com --verbose %GITHUB_WORKSPACE%\application.windows64\OpenBCI_GUI.exe
+        shell: cmd
+
+      - name: Package
+        id: package
+        run: python %GITHUB_WORKSPACE%\release\package.py
+        shell: cmd
+
+      - name: Sign MSI Package
+        if: ${{ true }}
+        run: |
+          azuresigntool sign --azure-key-vault-url "${{ secrets.AZURE_KEY_VAULT_URI }}" --azure-key-vault-client-id "${{ secrets.AZURE_CLIENT_ID }}" --azure-key-vault-tenant-id "${{ secrets.AZURE_TENANT_ID }}" --azure-key-vault-client-secret "${{ secrets.AZURE_CLIENT_SECRET }}" --azure-key-vault-certificate "${{ secrets.AZURE_CERT_NAME }}" --timestamp-rfc3161 http://timestamp.digicert.com --verbose ${{ env.msi-path }}
+        env:
+          msi-path: ${{ steps.package.outputs.msi_path }}
+        shell: cmd
+
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          role-to-assume: ${{ secrets.AWS_ROLE_TO_ASSUME }}
+          aws-region: ${{ env.AWS_REGION }}
+
+      - name: Get Branch Names
+        id: branch-name
+        uses: tj-actions/branch-names@v8
+
+      - name: Store Build on AWS
+        run: |
+          cd ${{ github.workspace }}
+          ls
+          echo "${{ steps.branch-name.outputs.head_ref_branch }}"
+          set S3_BRANCH_FOLDER=s3://openbci-public-gui-v7/${{ steps.branch-name.outputs.head_ref_branch }}
+          echo %S3_BRANCH_FOLDER%
+          aws s3 rm s3://openbci-public-gui-v6/latest  --recursive --exclude "*" --include "openbcigui_*_windows64.zip"
+          aws s3 cp ${{ github.workspace }}/. %S3_BRANCH_FOLDER%  --recursive --exclude "*" --include "openbcigui_*_windows64.zip"
+          aws s3 cp ${{ github.workspace }}/. s3://openbci-public-gui-v7/latest  --recursive --exclude "*" --include "openbcigui_*_windows64.zip"
+        shell: cmd

.gitignore

@@ -27,3 +27,6 @@ libGanglionLib.so
 libGanglionScan.so
 libunicorn.so
 OpenBCI_GUI/out/
+release/wix/bin/*
+release/wix/obj/*
+UNITTEST_FAILURE

.prettierignore

@@ -0,0 +1 @@
+**/*.wxs

release/build.py

@@ -55,26 +55,6 @@ def clean():
                 os.remove(file_path)
                 print ("Successfully deleted " + file)
 
-def update_timestamp():
-    sketch = find_sketch_directory()
-    main_file = os.path.join(sketch, "OpenBCI_GUI.pde")
-
-    timestamp = subprocess.check_output(['git', 'log', '-1', '--date=format:"%Y/%m/%d %T"', '--format=%ad']).decode("utf-8").strip('"\n')
-
-    data = []
-    with open(main_file, 'r') as sketch_file:
-        data = sketch_file.readlines()
-
-    for i in range(0, len(data)):
-        if data[i].startswith("String localGUIVersionDate"):
-            print(data[i])
-            data[i] = "String localGUIVersionDate = \"" + timestamp + "\";\n"
-            print(data[i])
-            break
-
-    with open(main_file, 'w') as sketch_file:
-        sketch_file.writelines(data)
-
 def build():
     # unfortunately, processing-java always returns exit code 1,
     # so we can't reliably check for success or failure
@@ -98,7 +78,6 @@ def delete_source_directory():
 
 def main ():
     clean()
-    update_timestamp()
     build()
     delete_source_directory()
 

release/package.py

@@ -37,11 +37,12 @@ def main ():
             if line.startswith("String localGUIVersionString"):
                 quotes_pos = [pos for pos, char in enumerate(line) if char == '"']
                 version = line[quotes_pos[0]+1:quotes_pos[1]]
-                print(version)
+                print("GUI Version: " + version)
                 break
 
     new_name = "openbcigui_" + version + "_"
     build_directory = os.path.join(os.getcwd(), flavors[LOCAL_OS])
+    print("Build directory: " + build_directory)
 
     # Allow GUI to launch from directory with spaces #916
     if LOCAL_OS == LINUX:
@@ -60,15 +61,57 @@ def main ():
 
     if LOCAL_OS == MAC:
         shutil.move(flavors[LOCAL_OS] + ".dmg", new_name + "macosx.dmg")
-    else: # Windows and Linux
+    elif LOCAL_OS == LINUX:
         release_directory = flavors[LOCAL_OS].replace("application.", new_name)
         release_directory = os.path.join(os.getcwd(), release_directory)
+        print("Release directory: " + release_directory)
 
         temporary_directory = os.path.join(sketch_directory, "OpenBCI_GUI")
+        print("Temporary directory: " + temporary_directory)
         os.rename(build_directory, temporary_directory)
         os.mkdir(release_directory)
         shutil.move(temporary_directory, release_directory)
         shutil.make_archive(release_directory, 'zip', release_directory)
+    else:
+        update_wix_version(version)
+        print("Making WiX installer for Windows")
+        wix_command = f'dotnet build {os.getcwd()}\\release\\wix\\OpenBCI_GUI.wixproj -c Release -p:ProductVersion={version}'
+        print(wix_command)
+        os.system(wix_command)
+        name = 'msi_path'
+        found_msi_files = [f for f in os.listdir(os.path.join(os.getcwd(), 'release', 'wix', 'bin', 'Release', 'en-US')) if f.endswith('.msi')]
+        print(f'Found MSI files: {found_msi_files}')
+        msi_path = os.path.join(os.getcwd(), 'release', 'wix', 'bin', 'Release', 'en-US', found_msi_files[0])
+        github_output = os.getenv('GITHUB_OUTPUT')
+        if github_output is not None:
+            with open(os.environ['GITHUB_OUTPUT'], 'a') as fh:
+                print(f'{name}={msi_path}', file=fh)
+        else:
+            print(f'{name}={msi_path}')
+
+def update_wix_version(version):
+    wix_file = os.path.join(os.getcwd(), "release", "wix", "Package.wxs")
+    with open(wix_file, 'r') as file :
+        filedata = file.read()
+
+    filedata = replace_between_identifiers(filedata, 'Version="', '"', version + '"')
+    with open(wix_file, 'w') as file:
+        file.write(filedata)
+                                
+def replace_between_identifiers(text, start_id, end_id, replacement):
+    start_index = text.find(start_id)
+    end_index = text.find(end_id, start_index + len(start_id))
+    
+    if start_index == -1 or end_index == -1:
+        # If either identifier is not found, return the original text
+        return text
+    
+    # Include the end identifier in the part to be replaced
+    end_index += len(end_id)
+    
+    # Replace the part between the identifiers
+    new_text = text[:start_index + len(start_id)] + replacement + text[end_index:]
+    return new_text
 
 if __name__ == "__main__":
     main ()