Merge branch 'develop'

Reviewed-on: #3

.drone.yml

@@ -0,0 +1,52 @@
+kind: pipeline
+type: docker
+name: build
+
+steps:
+  - name: build-image
+    image: plugins/docker
+    settings:
+      repo: t3hn3rd/asuro-build
+      tags: latest
+      dockerfile: Dockerfile
+      registry: docker.io
+      username:
+        from_secret: docker_username
+      password:
+        from_secret: docker_password
+
+  - name: compile
+    image: t3hn3rd/asuro-build:latest
+    depends_on:
+      - build-image
+    commands:
+      - git fetch --tags
+      - find . -type f -print0 | xargs -0 dos2unix
+      - chmod +x /drone/src/*.sh
+      - /drone/src/compile.sh
+
+  - name: upload-iso-artifact
+    image: alpine/git
+    depends_on:
+      - compile
+    when:
+      branch:
+        - master
+    environment:
+      GITEA_TOKEN:
+        from_secret: gitea_token
+    commands:
+      - apk add --no-cache curl
+      - chmod +w Asuro.iso
+      - cp Asuro.iso "Asuro-$(git rev-parse --short HEAD).iso"
+      - echo "Uploading Asuro-$(git rev-parse --short HEAD).iso to Gitea Packages..."
+      - |
+         curl -X PUT "https://gitea.spexeah.com/api/packages/Spexeah/generic/asuro-iso/$(git rev-parse --short HEAD)/Asuro.iso" \
+         -H "Authorization: token $GITEA_TOKEN" --upload-file "Asuro-$(git rev-parse --short HEAD).iso"
+      - echo "Updating latest ISO reference..."
+      - |
+        curl -X DELETE https://gitea.spexeah.com/api/packages/Spexeah/generic/asuro-iso/latest/Asuro.iso \
+        -H "Authorization: token $GITEA_TOKEN" || echo "No previous latest version found."
+      - |
+        curl -X PUT https://gitea.spexeah.com/api/packages/Spexeah/generic/asuro-iso/latest/Asuro.iso \
+        -H "Authorization: token $GITEA_TOKEN" --upload-file "Asuro-$(git rev-parse --short HEAD).iso"

.gitignore

@@ -10,5 +10,4 @@
 /*.sh~
 /*.img
 src/include/asuro.pas
-.vscode/launch.json
-.vscode
+localenv.json

.gitlab-ci.yml

@@ -1,73 +0,0 @@
-stages:
-  - Compile Versions
-  - Compile Sources
-  - Link
-  - Generate Documentation
-  - Deploy
-
-cache:
-  - key: ${CI_COMMIT_REF_SLUG}
-    paths:
-      - lib/*.o
-      - bin/kernel.bin
-      - doc
-
-before_script:
-  - chmod +x *.sh
-
-versions:
-  stage: Compile Versions
-  script:
-    - ./compile_vergen.sh
-  artifacts:
-    paths:
-      - release/*.svg
-      - src/include/asuro.pas
-
-compile_sources:
-  stage: Compile Sources
-  script:
-    - rm -f lib/*.so
-    - ./compile_sources.sh
-  needs:
-    - versions
-
-link:
-  stage: Link
-  script:
-    - ./compile_stub.sh
-    - ./compile_link.sh
-  needs:
-    - versions
-    - compile_sources
-
-isogen:
-  stage: Deploy
-  script:
-    - ./compile_isogen.sh
-    - ./compile_sumgen.sh
-  artifacts:
-    paths:
-      - ./Asuro.iso
-      - ./release/checksum.svg
-  needs:
-    - link
-
-docgen:
-  stage: Generate Documentation
-  only:
-    - master
-    - develop
-  script:
-    - ./compile_sourcelist.sh
-    - ./compile_docs.sh
-    # Remove comments when we want to use gitlab pages.
-    #- cp doc public
-  allow_failure: true
-  artifacts:
-    paths:
-      - doc
-      #- public/*
-      #- ./sources.list
-  needs:
-    - versions

.vscode/launch.json

@@ -3,18 +3,11 @@
         {
             "name":"Run",
             "request": "launch",
-            "type": "coreclr",
+            "type": "PowerShell",
             "preLaunchTask": "Build",
-            "program": "VBoxSDL",
-            "args": [
-                "--comment", 
-                "Asuro", 
-                "--startvm", 
-                "7d395c96-891c-4139-b77d-9b6b144b0b93"
-            ],
+            "script": "${workspaceFolder}/virtualbox-wrapper.ps1",
+            "args": ["-Command", "up"],
             "cwd": "${workspaceFolder}",
-            "console": "internalConsole",
-            "internalConsoleOptions": "neverOpen"
         }
     ]
 }

.vscode/tasks.json

@@ -9,14 +9,18 @@
             "command": "docker-compose",
             "args": [
                 "run",
-                "builder"
+                "builder",
             ],
             "type": "shell",
             "problemMatcher": [],
             "group": {
                 "kind": "build",
                 "isDefault": true
-            }
+            },
+            "dependsOn": [
+                "Close VirtualBox",
+                "Clean"
+            ]
         },
         {
             "label": "Build (Builder)",
@@ -26,6 +30,24 @@
                 "builder"
             ],
             "type": "shell"
+        },
+        {
+            "label": "Clean",
+            "command": "docker-compose",
+            "args": [
+                "down",
+                "--remove-orphans"
+            ],
+            "type": "shell"
+        },
+        {
+            "label": "Close VirtualBox",
+            "command": "./virtualbox-wrapper.ps1",
+            "args": [
+                "-Command", 
+                "down"
+            ],
+            "type": "shell"
         }
     ]
 }

Dockerfile

@@ -16,7 +16,7 @@ RUN curl -sL https://sourceforge.net/projects/freepascal/files/Linux/$FPC_VERSIO
 
 COPY compile.sh /compile.sh
 ADD https://raw.githubusercontent.com/fsaintjacques/semver-tool/master/src/semver /usr/bin/semver
-RUN mkdir /code && chmod +x /usr/bin/semver
+RUN chmod +x /usr/bin/semver
 WORKDIR /code
 RUN find . -type f -print0 | xargs -0 dos2unix
 ENTRYPOINT ["/bin/bash", "-c"]

compile.sh

@@ -20,26 +20,30 @@ runOrFail() {
 	fi
 }
 
-runOrFail $(pwd)/compile_stub.sh "Failed to compile stub!"
+declare -a run_steps=(
+	"compile_stub.sh" "Failed to compile stub!"
+	"compile_vergen.sh" "Versions failed to compile"
+	"compile_sources.sh" "Failed to compile FPC Sources!"
+	"compile_link.sh" "Failed linking!"
+	"compile_isogen.sh" "Failed to create ISO!"
+)
 
-#Generate .pas with versioning headers.
-runOrFail $(pwd)/compile_vergen.sh "Versions failed to compile"
-
-#Compile all .pas sources
-runOrFail $(pwd)/compile_sources.sh "Failed to compile FPC Sources!"
-
-#Link into a binary.
-runOrFail $(pwd)/compile_link.sh "Failed linking!"
-
-#Generate an ISO with GRUB as the Bootloader.
-runOrFail ./compile_isogen.sh "Failed to create ISO!"
+for ((i=0; i<${#run_steps[@]}; i+=2))
+do
+	if [ "$ERRCOUNT" -eq "0" ]
+	then
+			script=$(pwd)/"${run_steps[$i]}"
+			message="${run_steps[$i+1]}"
+			runOrFail "$script" "$message"
+	fi
+done
 
 #Call generate final artifacts based on failure or success of the above.
 if [ "$ERRCOUNT" -ne "0" ]
 then
-	./compile_finish.sh "failed"
+	. ./compile_finish.sh "failed"
 else
-	./compile_finish.sh "success"
+	. ./compile_finish.sh "success"
 fi
 
 cd ..

docker-compose.yml

@@ -1,4 +1,3 @@
-version: "3.9"
 services:
   builder:
     build: .

readme.md

@@ -13,8 +13,8 @@ We welcome everyone to give building/breaking/fixing/shooting Asuro a go, feel f
     I don't think this needs an explaination.
 * [VSCode (Optional, but highly recommended)](https://code.visualstudio.com/)
     Visual Studio code is our IDE of choice, and we have a number of recommended plugins.
-    * [C# Plugin by Microsoft](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp)
-        This plugin gives you the ability to use the 'coreclr' task type, allowing the automatic launching of virtualbox with the resulting image generated during compilation of Asuro.
+    * [PowerShell Plugin by Microsoft](https://marketplace.visualstudio.com/items?itemName=ms-vscode.powershell)
+        This plugin gives you the ability to use the 'PowerShell' task type, allowing the automatic launching of virtualbox with the resulting image generated during compilation of Asuro.
 * [VirtualBox](https://www.virtualbox.org/)
     Virtualbox is our Virtualisation environment of choice, don't ask why, it just is.
 
@@ -27,7 +27,7 @@ We welcome everyone to give building/breaking/fixing/shooting Asuro a go, feel f
 3. Install Docker for Windows.
 4. Install Git for Windows.
 5. Install VSCode & the listed plugins.
-6. Install VirtualBox.
+6. Install VirtualBox (v7+).
 7. Clone this repository.
 8. Run the following command in the root of the repo to build the docker image:
     ```powershell
@@ -50,32 +50,29 @@ We welcome everyone to give building/breaking/fixing/shooting Asuro a go, feel f
     ```xml
     <Machine uuid="{7d395c96-891c-4139-b77d-9b6b144b0b93}" name="Asuro" OSType="Linux" snapshotFolder="Snapshots" lastStateChange="2021-06-20T20:33:07Z">
     ```
-    Copy the uuid, in our case `7d395c96-891c-4139-b77d-9b6b144b0b93` and replace the uuid found in `.vscode\launch.json` under `args`, so that it looks something like this:
+    Copy the uuid, in our case `7d395c96-891c-4139-b77d-9b6b144b0b93` & create a `localenv.json` file in the project root with the following content:
     ```json
     {
-        "configurations": [
-            {
-                "name":"Run",
-                "request": "launch",
-                "type": "coreclr",
-                "preLaunchTask": "Build",
-                "program": "VBoxSDL",
-                "args": [
-                    "--comment", 
-                    "Asuro", 
-                    "--startvm", 
-                    "<YOUR UUID HERE>"
-                ],
-                "cwd": "${workspaceFolder}",
-                "console": "internalConsole",
-                "internalConsoleOptions": "neverOpen"
-            }
-        ]
+        "VirtualBox":{
+            "MachineName":"<YOUR_UUID_OR_MACHINE_NAME>"
+        }
     }
     ```
     This will allow VSCode to automatically launch VirtualBox once Asuro has been compiled.
+    
+    You can also enable the serial adapter "COM1" in mode "Raw File", give it a path, and provide this path in the `localenv.json` as follows:
+    ```json
+    {
+        "VirtualBox" : {
+            "MachineName": "<YOUR_UUID_OR_MACHINE_NAME>",
+            "LogLocation": "Fully\\Qualified\\Path\\To\\Your\\Log\\File"
+        }
+    }
+    ```
+    This will allow you to see the console output from Asuro in your host terminal.
 13. Open your project folder in VSCode, use CTRL+SHIFT+B to build & F5 to build + run in VBox.
 14. Congratulations! You can now play with Asuro!
 
-### Gotchas
+### Notes & Gotchas
+- The above process has been updated to be compatible with VirtualBox 7+, in which VBoxSDL was removed and vboxmanage should be used in its place. A small wrapper powershell script is used to achieve this.
 - It was noted that Windows builds above `20H2` seem to have issues installing WSL2. We may have to wait for a patch from Microsoft to fix this. Our devs are currently using build `20H2`.

virtualbox-wrapper.ps1

@@ -0,0 +1,58 @@
+<# 
+You need a local git-ignored localenv.json file with the following content:
+{
+  "virtualbox": {
+    "MachineName": "your-machine-name or guid"
+  }
+}
+#>
+
+param (
+  [Parameter(Mandatory=$true)]
+  [ValidateSet('up', 'down')]
+  [String]$Command
+)
+
+$Config = Get-Content .\localenv.json | ConvertFrom-Json
+$MachineName = $Config.virtualbox.MachineName
+$LogLocation = $Config.virtualbox.LogLocation
+$LogOutputEnabled = $LogLocation -ne $null
+
+if ($Command -eq 'up') {
+
+  if($LogOutputEnabled) {
+    Clear-Content $LogLocation
+  }
+
+  $MonitorJob = Start-Job -ArgumentList $MachineName -ScriptBlock {
+    param($MachineName)
+    Write-Output "Starting $MachineName"
+    VBoxManage.exe startvm $MachineName
+    $running=$true
+    while($running) {
+      $status=(VBoxManage.exe list runningvms)
+      if($status) {
+        $running=$status.contains($MachineName)
+      } else {
+        $running=$false
+      }
+    }
+  }
+  
+  if($LogOutputEnabled) {
+    $LogJob = Start-Job -ArgumentList $LogLocation -ScriptBlock {
+      param($LogLocation)
+      Get-Content -Path $LogLocation -Wait
+    }
+  }
+
+  while($MonitorJob.State -eq 'Running') {
+    if($LogOutputEnabled) {
+      Receive-Job $LogJob
+    }
+    Receive-Job $MonitorJob
+  }
+} elseif ($Command -eq 'down') {
+  Write-Output "Stopping $MachineName"
+  VBoxManage.exe controlvm $MachineName poweroff
+}