feat: redirect stdout/stderr to log file

Author: DanielleMaywood

src/code-server/README.md

@@ -28,6 +28,7 @@ VS Code in the browser
 | disableWorkspaceTrust | Disable Workspace Trust feature. This only affects the current session. | boolean | false |
 | extensions | Comma-separated list of VS Code extensions to install. Format: 'publisher.extension[@version]' (e.g., 'ms-python.python,ms-azuretools.vscode-docker'). | string | - |
 | host | The address to bind to for the code-server. Use '0.0.0.0' to listen on all interfaces. | string | 127.0.0.1 |
+| logFile | Path to a file to send stdout and stderr logs to from code-server. | string | /tmp/code-server.log |
 | port | The port to bind to for the code-server. | string | 8080 |
 | socket | Path to a socket. When specified, host and port will be ignored. | string | - |
 | socketMode | File mode of the socket when using the socket option. | string | - |

src/code-server/devcontainer-feature.json

@@ -70,6 +70,11 @@
             "default": "127.0.0.1",
             "description": "The address to bind to for the code-server. Use '0.0.0.0' to listen on all interfaces."
         },
+        "logFile": {
+            "type": "string",
+            "default": "/tmp/code-server.log",
+            "description": "Path to a file to send stdout and stderr logs to from code-server."
+        },
         "port": {
             "type": "string",
             "default": "8080",

src/code-server/install.sh

@@ -84,7 +84,7 @@ if [[ \$(whoami) != "$_REMOTE_USER" ]]; then
 else
 	$(declare -p FLAGS)
 
-	code-server "\${FLAGS[@]}" "$CODE_SERVER_WORKSPACE"
+	code-server "\${FLAGS[@]}" "$CODE_SERVER_WORKSPACE" >"$LOGFILE" 2>&1
 fi
 EOF
 

test/code-server/code-server-log-file.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+set -e
+
+# Optional: Import test library bundled with the devcontainer CLI
+source dev-container-features-test-lib
+
+# Feature-specific tests
+check "code-server version" code-server --version
+check "code-server running" pgrep -f 'code-server/lib/node.*/code-server'
+check "code-server listening" lsof -i "@0.0.0.0:8080"
+
+check "code-server log-file" test -f /tmp/code-server-log-file.log
+check "code-server log-file content" grep "HTTP server listening on http://127.0.0.1:8080/" < /tmp/code-server-log-file.log
+
+# Report results
+reportResults

test/code-server/scenarios.json

@@ -160,5 +160,13 @@
                 "socketMode": "777"
             }
         }
+    },
+    "code-server-log-file": {
+        "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
+        "features": {
+            "code-server": {
+                "logFile": "/tmp/code-server-log-file.log"
+            }
+        }
     }
 }

test/code-server/test.sh

@@ -9,5 +9,8 @@ check "code-server version" code-server --version
 check "code-server running" pgrep -f 'code-server/lib/node.*/code-server'
 check "code-server listening" lsof -i "@127.0.0.1:8080"
 
+check "code-server log-file" test -f /tmp/code-server.log
+check "code-server log-file content" grep "HTTP server listening on http://127.0.0.1:8080/" < /tmp/code-server.log
+
 # Report results
 reportResults