Sanity Check
Pages 77
Project Management
- Roadmap
- Iteration Plans
- Development Process
- Issue Tracking
- Build Champion
- Release Process
- Running the Endgame
- Related Projects
Contributing
- How to Contribute
- Submitting Bugs and Suggestions
- Feedback Channels
- Source Code Organization
- Coding Guidelines
- Smoke Test
- Dealing with Test Flakiness
- Contributor License Agreement
- Extension API Guidelines
- Accessibility Guidelines
Documentation
Clone this wiki locally
Client
Download the correct bits and make sure they start and the window opens correctly.
Linux Snap
sudo snap install --classic --dangerous <file>.snap
Server
Linux Platforms
Note: You can run this test from Linux, Mac or Windows.
Pre-requisites
- Install and run Docker Desktop
- Install Dev Containers
Steps
- Install VS Code at the exact version (commit) that needs sanity checking. https://builds.code.visualstudio.com/builds/stable
- Run the following commands. They register the QEMU hardware emulator and start 5 kinds of containers:
docker run --privileged --rm tonistiigi/binfmt --install all
docker run -d amd64/ubuntu sleep inf
docker run -d arm64v8/ubuntu sleep inf
docker run -d arm32v7/ubuntu /bin/sh -c 'apt update && apt install -y libatomic1 && sleep inf'
docker run -d amd64/alpine sleep inf
docker run -d arm64v8/alpine sleep inf
- Check that you can connect to each of the containers using the "Attach in New Window" button for each container in the Remote Explorer. For each container:
- Check which platform you are on by running
uname -mfrom the integrated terminal. (Expect:x86_64for amd64,armv7lfor arm32 andaarch64for arm64) - Alpine Linux runs on
x86_64andaarch64, checkcat /etc/os-releaseshows Alpine as the distro.
- Check which platform you are on by running
- Use the Remote Explorer to remove the containers. Note that the current window's container cannot be removed, so use a new window instead.
Windows
Use the Remote-SSH extension to connect from any client platform to a Windows remote. You can connect to localhost on your own Windows machine, a parallels VM, or another machine. You'll need to set up and start OpenSSH services, such as the OpenSSH SSH Server service and the OpenSSH Authentication Agent service.
Note: if you are an AAD user on your Windows machine, you may have to apply this workaround.
Here is an example localhost config that can be added to your SSH config file:
Host localhost
HostName localhost
User <username>@microsoft.com
Where <username> can be found by running whoami /user on cmd.exe.
When connecting, the password is the same as the user password (which might be the Active Directory password, but definitely not the login pin).
Set the undocumented setting "remote.SSH.force32bitWindows": true to force a 32-bit VS Code server to be installed on a 64-bit Windows host. If you have previously connected to this host with this version of VS Code, you will first want to run the command "Kill VS Code Server on Host" to remove the previously installed server.
macOS
Use the Remote-SSH extension to connect from any client platform to a macOS remote (connecting to localhost is ok). To start the SSH server, you just have to enable Remote Login as described here.
CLI
Windows & macOS
- Download the CLI archive and extract it
- Run it with
./code tunneland make sure it starts and you see the license notice
Linux
Note: You can run this test from Linux, Mac or Windows.
Pre-requisites
- Install Docker Desktop
Steps
- Look up the build's commit id and replace
<commit>with that value below. - Check that the Remote Tunnels pre-release extension is installed on the Stable client, and that the Stable client is at the exact version (commit) that needs sanity checking. Since there is a limit to the number of tunnels that can be registered at once, unregister any unnecessary tunnels before and during this sanity test.
- Run the following commands one-by-one. They register the QEMU hardware emulator and start 5 Linux builds of the CLI:
export COMMIT="<commit>" # Bash
$env:COMMIT='<commit>' # PowerShell
docker run --privileged --rm tonistiigi/binfmt --install all
docker run -e COMMIT -it --rm --platform linux/amd64 mcr.microsoft.com/devcontainers/base:latest /bin/sh -c 'apt update && apt install -y wget libatomic1 ca-certificates python3-minimal && wget "https://update.code.visualstudio.com/commit:$COMMIT/cli-linux-x64/stable" -O- | tar -xz && ./code tunnel'
docker run -e COMMIT -it --rm --platform linux/arm64 mcr.microsoft.com/devcontainers/base:latest /bin/sh -c 'apt update && apt install -y wget libatomic1 ca-certificates python3-minimal && wget "https://update.code.visualstudio.com/commit:$COMMIT/cli-linux-arm64/stable" -O- | tar -xz && ./code tunnel'
docker run -e COMMIT -it --rm arm32v7/ubuntu /bin/sh -c 'apt update && apt install -y wget libatomic1 ca-certificates python3-minimal && wget "https://update.code.visualstudio.com/commit:$COMMIT/cli-linux-armhf/stable" -O- | tar -xz && ./code tunnel'
docker run -e COMMIT -it --rm amd64/alpine /bin/sh -c 'apk update && apk add musl libgcc libstdc++ && wget "https://update.code.visualstudio.com/commit:$COMMIT/cli-alpine-x64/stable" -O- | tar -xz && ./code tunnel'
docker run -e COMMIT -it --rm arm64v8/alpine /bin/sh -c 'apk update && apk add musl libgcc libstdc++ && wget "https://update.code.visualstudio.com/commit:$COMMIT/cli-alpine-arm64/stable" -O- | tar -xz && ./code tunnel'
- For each CLI test:
- Make sure the program starts and you see and can agree to the license
- Connect to the tunnel using the Remote Tunnels prerelease extension on the Stable client
- Check which platform you are on by running
uname -mfrom the integrated terminal. (Expect:x86_64for amd64,armv7lfor arm32 andaarch64for arm64) - Run
cat /etc/os-release. For Alpine Linux tunnels, ensure the output shows Alpine as the distro. Otherwise, ensure that Ubuntu or Debian are mentioned in the output. - Close the remote connection on the client. Then, hit Ctrl+C on the server.