VirtualBox + VSCode での開発環境を劇的に効率化！SSH接続とワンクリック起動自動化ガイド.

$ sudo apt update
$ sudo apt install openssh-server

$ sudo systemctl start ssh
$ sudo systemctl enable ssh

$ sudo systemctl status ssh

$ systemctl is-enabled ssh
enabled

$ sudo ufw allow 22

$ sudo ufw reload

$ sudo ufw status
状態: アクティブ
 
To                         Action      From
--                         ------      ----
22/tcp                     ALLOW       Anywhere
22/tcp (v6)                ALLOW       Anywhere (v6)

ssh your_guest_username@localhost -p 22222

Host your_ssh_alias
    HostName localhost
    User your_guest_username
    Port 22222

VBoxManage list vms

#!/bin/bash
 
# SSH サービス (sshd または ssh) がアクティブか確認
if systemctl is-active --quiet ssh || systemctl is-active --quiet sshd; then
    # VBoxControl コマンドが存在するか確認 (Guest Additions の一部)
    if command -v VBoxControl >/dev/null 2>&1; then
        /usr/bin/VBoxControl guestproperty set "/guestinfo/ssh.ready" "true"
    else
        echo "VBoxControl not found. Make sure Guest Additions are installed." >&2
    fi
fi

$ mkdir -p ~/bin
$ chmod +x ~/bin/set-ssh-ready.sh

[Unit]
Description=Set SSH Ready guest property for VirtualBox
After=network.target ssh.service sshd.service
 
[Service]
User=your_guest_username
Group=your_guest_username
ExecStart=/home/your_guest_username/bin/set-ssh-ready.sh
Type=oneshot
 
[Install]
WantedBy=multi-user.target

$ sudo systemctl daemon-reload
$ sudo systemctl enable set-ssh-ready.service

$ systemctl status set-ssh-ready.service
# ● set-ssh-ready.service - Set SSH Ready guest property for VirtualBox
#      Loaded: loaded (/etc/systemd/system/set-ssh-ready.service; enabled; ...)
#      Active: inactive (dead) since ...
#     Process: ... ExecStart=/home/your_guest_username/bin/set-ssh-ready.sh (code=exited, status=0/SUCCESS)
#    Main PID: ... (code=exited, status=0/SUCCESS)
 
$ VBoxControl guestproperty get "/guestinfo/ssh.ready"
# Value: true

VBoxManage guestproperty get "Your_VM_Name" "/guestinfo/ssh.ready"
# Expected output: Value: true

{
  "folders": [
    {
      // "your_ssh_alias" は 1.5 で設定したSSHホスト名
      // "your_guest_username" はゲストOSのユーザー名
      // "your_project_folder" はゲストOS内のプロジェクトフォルダ名
      "uri": "vscode-remote://ssh-remote+your_ssh_alias/home/your_guest_username/your_project_folder"
    }
  ],
  "remoteAuthority": "ssh-remote+your_ssh_alias", // SSHホスト名を指定
  "settings": {
    // ワークスペース固有の設定があれば記述
  },
  "tasks": {
    // このワークスペースで利用するタスク (例: VMシャットダウン)
    "version": "2.0.0",
    "tasks": [
      {
        "label": "Shutdown Guest VM",
        "type": "shell",
        "command": "VBoxManage controlvm \"Your_VM_Name\" poweroff", // ホストOSで実行されるコマンド
        "problemMatcher": [],
        "group": "build",
        "presentation": {
          "reveal": "always",
          "close": true
        }
      }
    ]
  }
}

<#
.SYNOPSIS
    VirtualBox VMをヘッドレスで起動し、SSH接続準備が整うまで待機後、
    VSCodeを指定のプロファイルとワークスペースで起動します。
.DESCRIPTION
    1. 指定されたVMが実行中でなければヘッドレスモードで起動します。
    2. VMが起動し、Guest Property "/guestinfo/ssh.ready" が "true" になるまで待機します。
    3. 指定されたVSCodeの実行パス、プロファイル名、ワークスペースファイルでVSCodeを起動します。
.NOTES
    Author: Riku-Mono
    Last Updated: 2025-06-07
    Requires: VirtualBox command line tools (VBoxManage) in PATH.
            Guest OS configured to set "/guestinfo/ssh.ready" property.
#>
 
[CmdletBinding()]
param()
 
#======================================================================
# 🔧 設定 (ここを環境に合わせて変更してください)
#======================================================================
 
# VirtualBox 関連設定
$VMName = "<Your_VM_Name>"  # 例: "Linux Mint 22" (VBoxManage list vms で確認した名前)
 
# VSCode 関連設定
# VSCodeの実行ファイルのパス。通常は以下のいずれか。
# $EditorPath = "$env:LOCALAPPDATA\Programs\Microsoft VS Code\Code.exe" # User Installer
$EditorPath = "$env:ProgramFiles\Microsoft VS Code\Code.exe"      # System Installer (適宜コメント解除)
# $EditorPath = "<Path_To_Your_VSCode_Executable>" # 上記以外の場合
 
$EditorProfile = "<your_vscode_profile_name>" # 例: "dev-linux" (VSCodeで使うプロファイル名。存在しない場合は新規作成される)
$WorkspacePath = "<Path_To_Your_code-workspace_File>" # 例: "C:\Users\YourUser\Documents\VSCodeWorkspaces\my-linux-project.code-workspace" (2.3で作成したファイル)
 
# タイムアウト設定（秒）: VM起動とSSH準備の待機時間。スペックに合わせて調整してください。
$VMStartTimeoutSec = 120
$SSHReadyTimeoutSec = 120
 
#======================================================================
# 🧯 共通関数
#======================================================================
 
function Write-Log {
    param(
        [Parameter(Mandatory=$true)]
        [string]$Message,
        [ValidateSet("Info", "Success", "Waiting", "Warning", "Error")]
        [string]$Severity = "Info"
    )
    $Timestamp = Get-Date -Format "yyyy-MM-dd HH:mm:ss"
    $Prefix = switch ($Severity) {
        "Info"    { "ℹ️ [INFO]" }
        "Success" { "✅ [SUCCESS]" }
        "Waiting" { "⏳ [WAITING]" }
        "Warning" { "⚠️ [WARNING]" }
        "Error"   { "🛑 [ERROR]" }
        default   { "  [LOG]"  }
    }
    Write-Host "$Timestamp $Prefix $Message"
}
 
function Exit-Script {
    param (
        [string]$Message = "スクリプトを終了します。"
    )
    Write-Log $Message -Severity Error
    Start-Sleep -Seconds 5 # メッセージを読む時間
    exit 1
}
 
function Test-VBoxInstalled {
    try {
        & VBoxManage --version | Out-Null
        return $true
    } catch {
        Write-Log "VirtualBox (VBoxManage) がインストールされていないか、パスが通っていません。" -Severity Error
        return $false
    }
}
 
function Get-VMState {
    param (
        [Parameter(Mandatory=$true)]
        [string]$TargetVMName
    )
    try {
        $VMInfo = VBoxManage showvminfo $TargetVMName --machinereadable | Select-String -Pattern "^VMState="
        if ($VMInfo) {
            return ($VMInfo -split "=")[1].Trim('"')
        }
        return "notfound" # VMが見つからない場合
    } catch {
        Write-Log "VM '$TargetVMName' の状態取得に失敗: $($_.Exception.Message)" -Severity Error
        return "error"
    }
}
 
#======================================================================
# 🚀 VM起動処理
#======================================================================
function Start-VMHeadless {
    param(
        [Parameter(Mandatory=$true)]
        [string]$TargetVMName
    )
    Write-Log "VM '$TargetVMName' をヘッドレスモードで起動します..."
    try {
        # SSH準備完了フラグをリセット (念のため)
        VBoxManage guestproperty set $TargetVMName "/guestinfo/ssh.ready" "" | Out-Null
        $Result = & VBoxManage startvm $TargetVMName --type headless 2>&1
        if ($LASTEXITCODE -ne 0) {
            Write-Log "VM '$TargetVMName' の起動に失敗しました: $Result" -Severity Error
            return $false
        }
        Write-Log "VM '$TargetVMName' の起動コマンドを送信しました。" -Severity Info
        return $true
    } catch {
        Write-Log "VM '$TargetVMName' の起動中にエラーが発生しました: $($_.Exception.Message)" -Severity Error
        return $false
    }
}
 
#======================================================================
# ⏳ VM起動およびSSH準備完了待機処理
#======================================================================
function WaitFor-VMStateAndSSHReady {
    param(
        [Parameter(Mandatory=$true)]
        [string]$TargetVMName,
        [Parameter(Mandatory=$true)]
        [string]$DesiredState, # 例: "running"
        [int]$VMTimeout,
        [int]$SSHTimeout
    )
 
    Write-Log "VM '$TargetVMName' が '$DesiredState' 状態になるのを待機中... (タイムアウト: ${VMTimeout}秒)"
    $Stopwatch = [System.Diagnostics.Stopwatch]::StartNew()
    while ($Stopwatch.Elapsed.TotalSeconds -lt $VMTimeout) {
        $CurrentState = Get-VMState -TargetVMName $TargetVMName
        if ($CurrentState -eq $DesiredState) {
            Write-Log "VM '$TargetVMName' が '$DesiredState' 状態になりました。($($Stopwatch.Elapsed.ToString('hh\:mm\:ss')) 経過)" -Severity Success
            $Stopwatch.Stop()
            break
        }
        Write-Log "現在のVM状態: '$CurrentState'... ($($Stopwatch.Elapsed.ToString('hh\:mm\:ss')) 経過)" -Severity Waiting
        Start-Sleep -Seconds 2
    }
 
    if ($Stopwatch.IsRunning) { # タイムアウトした場合
        $Stopwatch.Stop()
        Write-Log "タイムアウト: VM '$TargetVMName' が '$DesiredState' 状態になりませんでした。" -Severity Error
        return $false
    }
 
    Write-Log "ゲストOSのSSH接続準備を待機中... (タイムアウト: ${SSHTimeout}秒)"
    $Stopwatch.Restart()
    while ($Stopwatch.Elapsed.TotalSeconds -lt $SSHTimeout) {
        try {
            $Result = VBoxManage guestproperty get $TargetVMName "/guestinfo/ssh.ready"
            if ($Result -match "Value: true") {
                Write-Log "SSH接続準備が完了しました。($($Stopwatch.Elapsed.ToString('hh\:mm\:ss')) 経過)" -Severity Success
                return $true
            }
            Write-Log "SSH準備状態確認中... ($($Stopwatch.Elapsed.ToString('hh\:mm\:ss')) 経過): $Result" -Severity Waiting
        } catch {
            Write-Log "Guest Propertyの取得に失敗しました。VMが完全に起動していない可能性があります。 ($($Stopwatch.Elapsed.ToString('hh\:mm\:ss')) 経過)" -Severity Warning
        }
        Start-Sleep -Seconds 5
    }
 
    Write-Log "タイムアウト: SSH接続準備が完了しませんでした。" -Severity Error
    Write-Log "VM '$TargetVMName' をシャットダウンします。" -Severity Warning
    try {
        VBoxManage controlvm $TargetVMName poweroff | Out-Null
    } catch {
        Write-Log "VM '$TargetVMName' のシャットダウン中にエラーが発生しました: $($_.Exception.Message)" -Severity Error
    }
    return $false
}
 
#======================================================================
# 🖥️ VSCode起動処理
#======================================================================
function Start-VSCode {
    param(
        [Parameter(Mandatory=$true)]
        [string]$EditorExecPath,
        [string]$TargetProfile,
        [string]$TargetWorkspacePath
    )
    Write-Log "VSCodeを起動します..."
    Write-Log "  実行パス: $EditorExecPath"
    Write-Log "  プロファイル: $TargetProfile"
    Write-Log "  ワークスペース: $TargetWorkspacePath"
 
    if (-not (Test-Path $EditorExecPath -PathType Leaf)) {
        Write-Log "指定されたVSCodeの実行パスが見つかりません: $EditorExecPath" -Severity Error
        return $false
    }
    if (-not (Test-Path $TargetWorkspacePath -PathType Leaf) -and $TargetWorkspacePath) {
        Write-Log "指定されたワークスペースファイルが見つかりません: $TargetWorkspacePath" -Severity Warning
        Write-Log "ワークスペースなしで続行します。"
        $TargetWorkspacePath = $null # ワークスペースなしで起動
    }
 
    $Arguments = New-Object System.Collections.Generic.List[string]
    if ($TargetProfile) {
        $Arguments.Add("--profile")
        $Arguments.Add "$TargetProfile"
    }
    if ($TargetWorkspacePath) {
        $Arguments.Add "`"$TargetWorkspacePath`"" # パスは引用符で囲む
    }
 
    try {
        Start-Process -FilePath $EditorExecPath -ArgumentList $Arguments
        Write-Log "VSCodeの起動コマンドを送信しました。" -Severity Info
        return $true
    } catch {
        Write-Log "VSCodeの起動に失敗しました: $($_.Exception.Message)" -Severity Error
        return $false
    }
}
 
#======================================================================
# ⭐ メイン処理
#======================================================================
Write-Log "開発環境起動スクリプトを開始します。"
 
# 0. VirtualBoxが利用可能か確認
if (-not (Test-VBoxInstalled)) {
    Exit-Script "VirtualBox (VBoxManage) の準備ができていません。"
}
 
# 1. VMの状態確認と起動処理
$CurrentVMState = Get-VMState -TargetVMName $VMName
if ($CurrentVMState -eq "running") {
    Write-Log "VM '$VMName' は既に実行中です。" -Severity Info
} elseif ($CurrentVMState -eq "poweroff" -or $CurrentVMState -eq "aborted" -or $CurrentVMState -eq "saved") {
    Write-Log "VM '$VMName' は現在 '$CurrentVMState' 状態です。起動します。"
    if (-not (Start-VMHeadless -TargetVMName $VMName)) {
        Exit-Script "VM '$VMName' の起動に失敗しました。"
    }
} elseif ($CurrentVMState -eq "notfound") {
    Exit-Script "VM '$VMName' が見つかりません。VM名を確認してください。"
} else {
    Exit-Script "VM '$VMName' は予期せぬ状態 ($CurrentVMState) です。手動で確認してください。"
}
 
# 2. VMの起動完了とSSH準備完了を待機
if (-not (WaitFor-VMStateAndSSHReady -TargetVMName $VMName -DesiredState "running" -VMTimeout $VMStartTimeoutSec -SSHTimeout $SSHReadyTimeoutSec)) {
    Exit-Script "VMの準備がタイムアウトしました。"
}
 
# 3. VSCodeを起動
if (-not (Start-VSCode -EditorExecPath $EditorPath -TargetProfile $EditorProfile -TargetWorkspacePath $WorkspacePath)) {
    Exit-Script "VSCodeの起動に失敗しました。"
}
 
Write-Log "開発環境の起動処理が完了しました。" -Severity Success
Start-Sleep -Seconds 3 # 完了メッセージ表示用

powershell.exe -ExecutionPolicy Bypass -File "<Path_To_Your_Script_File.ps1>"

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "Dev Server: Frontend",
      "type": "shell",
      "command": "npm run dev", // フロントエンドの起動コマンド
      "options": {
        "cwd": "${workspaceFolder}/frontend" // フロントエンドのディレクトリ
      },
      "problemMatcher": [],
      "isBackground": true // バックグラウンドで実行
    },
    {
      "label": "Dev Server: Backend",
      "type": "shell",
      // バックエンドの起動コマンド (仮想環境有効化、環境変数設定などを含む例)
      "command": "source ~/venvs/myproject_venv/bin/activate && export DB_USER='<db_user>' && python manage.py runserver 0.0.0.0:8000",
      "options": {
        "cwd": "${workspaceFolder}/backend" // バックエンドのディレクトリ
      },
      "problemMatcher": [],
      "isBackground": true
    },
    {
      "label": "Start All Dev Servers",
      "dependsOn": ["Dev Server: Frontend", "Dev Server: Backend"],
      "dependsOrder": "parallel", // 並列実行
      "group": {
        "kind": "build",
        "isDefault": true // ビルドタスクのデフォルトにする
      },
      "problemMatcher": []
    }
  ]
}

"C:\Program Files\Oracle\VirtualBox\VBoxManage.exe" controlvm "Your_VM_Name" poweroff