Devcontainer Improvements (bitwarden#4466)

justindbaur · withinfocus · web-flow · commit b61b1eadaff8 · 2024-07-08T10:48:02.000-04:00
* Optionally Run `docker-compose`

* Use Traversal Projects Over Solution Files

* Cleanup VSCode Tasks

* Bind DataProtection Keys to Host

- Makes it so the container can be rebuilt without corrupting data

* Update .vscode/tasks.json

Co-authored-by: Matt Bishop &lt;mbishop@bitwarden.com&gt;

---------

Co-authored-by: Matt Bishop &lt;mbishop@bitwarden.com&gt;
diff --git a/.devcontainer/community_dev/devcontainer.json b/.devcontainer/community_dev/devcontainer.json
@@ -3,6 +3,13 @@
   "dockerComposeFile": "../../.devcontainer/bitwarden_common/docker-compose.yml",
   "service": "bitwarden_server",
   "workspaceFolder": "/workspace",
+  "mounts": [
+    {
+      "source": "../../dev/.data/keys",
+      "target": "/home/vscode/.aspnet/DataProtection-Keys",
+      "type": "bind"
+    }
+  ],
   "customizations": {
     "vscode": {
       "settings": {},
diff --git a/.devcontainer/internal_dev/devcontainer.json b/.devcontainer/internal_dev/devcontainer.json
@@ -3,8 +3,16 @@
   "dockerComposeFile": [
     "../../.devcontainer/bitwarden_common/docker-compose.yml",
     "../../.devcontainer/internal_dev/docker-compose.override.yml"
-  ],  "service": "bitwarden_server",
+  ],
+  "service": "bitwarden_server",
   "workspaceFolder": "/workspace",
+  "mounts": [
+    {
+      "source": "../../dev/.data/keys",
+      "target": "/home/vscode/.aspnet/DataProtection-Keys",
+      "type": "bind"
+    }
+  ],
   "customizations": {
     "vscode": {
       "settings": {},
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -3,6 +3,7 @@
     "tasks": [
         {
             "label": "buildIdentityApi",
+            "hide": true,
             "dependsOrder": "sequence",
             "dependsOn": [
                 "buildIdentity",
@@ -14,6 +15,7 @@
         },
         {
             "label": "buildIdentityApiAdmin",
+            "hide": true,
             "dependsOrder": "sequence",
             "dependsOn": [
                 "buildIdentity",
@@ -26,6 +28,7 @@
         },
         {
             "label": "buildFullServer",
+            "hide": true,
             "dependsOrder": "sequence",
             "dependsOn": [
                 "buildAdmin",
@@ -40,6 +43,7 @@
         },
         {
             "label": "buildSelfHostBit",
+            "hide": true,
             "dependsOrder": "sequence",
             "dependsOn": [
                 "buildAdmin",
@@ -52,6 +56,7 @@
         },
         {
             "label": "buildSelfHostOss",
+            "hide": true,
             "dependsOrder": "sequence",
             "dependsOn": [
                 "buildAdmin",
@@ -62,6 +67,7 @@
         },
         {
             "label": "buildIcons",
+            "hide": true,
             "command": "dotnet",
             "type": "process",
             "args": [
@@ -74,6 +80,7 @@
         },
         {
             "label": "buildPortal",
+            "hide": true,
             "command": "dotnet",
             "type": "process",
             "args": [
@@ -86,6 +93,7 @@
         },
         {
             "label": "buildSso",
+            "hide": true,
             "command": "dotnet",
             "type": "process",
             "args": [
@@ -98,6 +106,7 @@
         },
         {
             "label": "buildEvents",
+            "hide": true,
             "command": "dotnet",
             "type": "process",
             "args": [
@@ -110,6 +119,7 @@
         },
         {
             "label": "buildEventsProcessor",
+            "hide": true,
             "command": "dotnet",
             "type": "process",
             "args": [
@@ -122,6 +132,7 @@
         },
         {
             "label": "buildAdmin",
+            "hide": true,
             "command": "dotnet",
             "type": "process",
             "args": [
@@ -134,6 +145,7 @@
         },
         {
             "label": "buildIdentity",
+            "hide": true,
             "command": "dotnet",
             "type": "process",
             "args": [
@@ -146,6 +158,7 @@
         },
         {
             "label": "buildAPI",
+            "hide": true,
             "command": "dotnet",
             "type": "process",
             "args": [
@@ -162,6 +175,7 @@
         },
         {
             "label": "buildNotifications",
+            "hide": true,
             "command": "dotnet",
             "type": "process",
             "args": [
@@ -178,6 +192,7 @@
         },
         {
             "label": "buildBilling",
+            "hide": true,
             "command": "dotnet",
             "type": "process",
             "args": [
@@ -192,20 +207,6 @@
                 "isDefault": true
             }
         },
-        {
-            "label": "clean",
-            "type": "shell",
-            "command": "dotnet clean",
-            "presentation": {
-                "echo": true,
-                "reveal": "always",
-                "focus": false,
-                "panel": "shared",
-                "showReuseMessage": true,
-                "clear": false
-            },
-            "problemMatcher": "$msCompile"
-        },
         {
             "label": "test",
             "type": "shell",
@@ -225,13 +226,15 @@
             "problemMatcher": "$msCompile"
         },
         {
-            "label": "Setup Secrets",
+            "label": "Set Up Secrets",
+            "detail": "A task to run setup_secrets.ps1",
             "type": "shell",
             "command": "pwsh -WorkingDirectory ${workspaceFolder}/dev -Command '${workspaceFolder}/dev/setup_secrets.ps1 -clear:$${input:setupSecretsClear}'",
             "problemMatcher": []
         },
         {
             "label": "Install Dev Cert",
+            "detail": "A task to install the Bitwarden developer cert to run your local install as an admin.",
             "type": "shell",
             "command": "dotnet tool install -g dotnet-certificate-tool -g && certificate-tool add --file ${workspaceFolder}/dev/dev.pfx --password '${input:certPassword}'",
             "problemMatcher": []
diff --git a/bitwarden_license/test/Bitwarden.License.Tests.proj b/bitwarden_license/test/Bitwarden.License.Tests.proj
@@ -0,0 +1,5 @@
+<Project Sdk="Microsoft.Build.Traversal">
+  <ItemGroup>
+    <ProjectReference Include="**\*.*proj" />
+  </ItemGroup>
+</Project>
diff --git a/bitwarden_license/test/bitwarden_license.tests.sln b/bitwarden_license/test/bitwarden_license.tests.sln
diff --git a/dev/ef_migrate.ps1 b/dev/ef_migrate.ps1
@@ -9,7 +9,11 @@ $service = "mysql"
 
 Write-Output "--- Attempting to start $service service ---"
 
-docker-compose --profile $service up -d --no-recreate
+# Attempt to start mysql but if docker-compose doesn't
+# exist just trust that the user has it running some other way
+if (command -v docker-compose) {
+  docker-compose --profile $service up -d --no-recreate
+}
 
 dotnet tool restore
 
diff --git a/global.json b/global.json
@@ -2,5 +2,8 @@
   "sdk": {
     "version": "8.0.100",
     "rollForward": "latestFeature"
+  },
+  "msbuild-sdks": {
+    "Microsoft.Build.Traversal": "4.1.0"
   }
 }
diff --git a/test/Bitwarden.Tests.proj b/test/Bitwarden.Tests.proj
@@ -0,0 +1,5 @@
+<Project Sdk="Microsoft.Build.Traversal">
+  <ItemGroup>
+    <ProjectReference Include="**\*.*proj" />
+  </ItemGroup>
+</Project>
diff --git a/test/bitwarden.tests.sln b/test/bitwarden.tests.sln

Original file line number	Diff line number	Diff line change
`@@ -2,5 +2,8 @@`
`2`	`2`	`"sdk": {`
`3`	`3`	`"version": "8.0.100",`
`4`	`4`	`"rollForward": "latestFeature"`
	`5`	`+ },`
	`6`	`+ "msbuild-sdks": {`
	`7`	`+ "Microsoft.Build.Traversal": "4.1.0"`
`5`	`8`	`}`
`6`	`9`	`}`