Merge pull request 'DevOps Workflow Improvements' (#2) from feature/devlops-workflow-improvements into develop

Reviewed-on: #2

.gitignore

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

.vscode/launch.json

@@ -6,7 +6,7 @@
             "type": "PowerShell",
             "preLaunchTask": "Build",
             "script": "${workspaceFolder}/virtualbox-wrapper.ps1",
-            "args": ["-MachineName", "7d395c96-891c-4139-b77d-9b6b144b0b93"],
+            "args": ["-Command", "up"],
             "cwd": "${workspaceFolder}",
         }
     ]

.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"
         }
     ]
 }

docker-compose.yml

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

readme.md

@@ -50,23 +50,26 @@ 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": [
+        "VirtualBox":{
-            {
+            "MachineName":"<YOUR_UUID_OR_MACHINE_NAME>"
-                "name":"Run",
+        }
-                "request": "launch",
-                "type": "PowerShell",
-                "preLaunchTask": "Build",
-                "script": "${workspaceFolder}/virtualbox-wrapper.ps1",
-                "args": ["-MachineName", "7d395c96-891c-4139-b77d-9b6b144b0b93"],
-                "cwd": "${workspaceFolder}",
-            }
-        ]
     }
     ```
     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!
 

virtualbox-wrapper.ps1

@@ -1,16 +1,58 @@
-param (
+<# 
-  $MachineName
+You need a local git-ignored localenv.json file with the following content:
-)
+{
-
+  "virtualbox": {
-VBoxManage.exe startvm $MachineName
+    "MachineName": "your-machine-name or guid"
-
-$running=$true
-while($running) {
-  Start-Sleep -Seconds 1
-  $status=(VBoxManage.exe list runningvms)
-  if($status) {
-    $running=$status.contains($MachineName)
-  } else {
-    $running=$false
   }
 }
+#>
+
+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
+}