Repository files navigation

Adevelopment container is a running container with a well-defined tool/runtime stack and its prerequisites. You can try out development containers withGitHub Codespaces orVisual Studio Code Dev Containers.

This is a sample project that lets you try out either option in a few easy steps. We have a variety of othervscode-remote-try-* sample projects, too.

Note: If you already have a Codespace or dev container, you can jump to theThings to try section.

Follow these steps to open this sample in a Codespace:

1. Click theCode drop-down menu.
2. Click on theCodespaces tab.
3. ClickCreate codespace on main .

For more info, check out theGitHub documentation.

If you already have VS Code and Docker installed, you can click the badge above orhere to get started. Clicking these links will cause VS Code to automatically install the Dev Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use.

Follow these steps to open this sample in a container using the VS Code Dev Containers extension:

1. If this is your first time using a development container, please ensure your system meets the pre-reqs (i.e. have Docker installed) in thegetting started steps.

2. To use this repository, you can either open the repository in an isolated Docker volume:

   • PressF1 and select theDev Containers: Try a Sample... command.
   • Choose the "Go" sample, wait for the container to start, and try things out!

     Note: Under the hood, this will use theDev Containers: Clone Repository in Container Volume... command to clone the source code in a Docker volume instead of the local filesystem.Volumes are the preferred mechanism for persisting container data.

   Or open a locally cloned copy of the code:

   • Clone this repository to your local filesystem.
   • PressF1 and select theDev Containers: Open Folder in Container... command.
   • Select the cloned copy of this folder, wait for the container to start, and try things out!

Once you have this sample opened, you'll be able to work with it like you would locally.

Some things to try:

1. Edit:

   • Openserver.go
   • Try adding some code and check out the language features.
   • Make a spelling mistake and notice it is detected. TheCode Spell Checker extension was automatically installed because it is referenced in.devcontainer/devcontainer.json.
   • Also notice that utilities likegopls and theGo extension are installed. Tools are installed in themcr.microsoft.com/devcontainers/go image and Dev Container settings and metadata are automatically picked up fromimage labels.

2. Terminal: Pressctrl+shift+` and typeuname and other Linux commands from the terminal window.

3. Build, Run, and Debug:

   • Openserver.go
   • Add a breakpoint (e.g. on line 22).
   • PressF5 to launch the app in the container.
   • Once the breakpoint is hit, try hovering over variables, examining locals, and more.
   • Continue (F5). You can connect to the server in the container by either:
     • Clicking onOpen in Browser in the notification telling you:Your service running on port 9000 is available.
     • Clicking the globe icon in the 'Ports' view. The 'Ports' view gives you an organized table of your forwarded ports, and you can get there by clicking on the "1" in the status bar, which means your app has 1 forwarded port.
   • Notice port 9000 in the 'Ports' view is labeled "Hello Remote World." Indevcontainer.json, you can set"portsAttributes", such as a label for your forwarded ports and the action to be taken when the port is autoforwarded.

   Note: In Dev Containers, you can access your app athttp://localhost:9000 in a local browser. But in a browser-based Codespace, you must click the link from the notification or thePorts view so that the service handles port forwarding in the browser and generates the correct URL.

4. Rebuild or update your container:

   You may want to make changes to your container, such as installing a different version of a software or forwarding a new port. You'll rebuild your container for your changes to take effect.

   Open browser automatically: As an example change, let's update theportsAttributes in the.devcontainer/devcontainer.json file to open a browser when our port is automatically forwarded.

   • Open the.devcontainer/devcontainer.json file.
   • Modify the"onAutoForward" attribute in yourportsAttributes from"notify" to"openBrowser".
   • PressF1 and select theDev Containers: Rebuild Container orCodespaces: Rebuild Container command so the modifications are picked up.

5. Install Node.js using a Dev Container Feature:

   • PressF1 and select theDev Containers: Configure Container Features... orCodespaces: Configure Container Features... command.
   • Type "node" in the text box at the top.
   • Check the check box next to "Node.js (via nvm) and yarn" (published by devcontainers)
   • Click OK
   • PressF1 and select theDev Containers: Rebuild Container orCodespaces: Rebuild Container command so the modifications are picked up.

6. Refactoring - rename:

   • Openhello.go, select method nameHello pressF1 and run theRename Symbol command.

7. Refactoring - extract:

   • Openhello.go and select string, pressF1 and run theGo: Extract to variable command.
   • Openhello.go and select line with return statement, pressF1 and run theGo: Extract to function command.

8. Generate tests:

   • Openhello.go and pressF1 and run theGo: Generate Unit Tests For File command.
   • Implement a test case: Open filehello_test.go and edit the line with theTODO comment:{"hello without name", "Hello, "},
   • You can toggle between implementation file and test file with pressF1 and run theGo: Toggle Test File
   • Tests can also run as benchmarks: Open filehello_test.go, pressF1 and run theGo: Benchmark File

9. Stub generation: (details)

   • define a structtype mock struct {}, enter a new line , pressF1 and run theGo: Generate interface stubs command.
   • edit commandm *mock http.ResponseWriter

10. Fill structs: (details)

• Openhello.go and selectUser{} of variable asignment, pressF1 and run theGo: Fill struct command.

11. Add json tags to structs: (details)

• Openhello.go and go with cursor in to a struct, pressF1 and run theGo: Add Tags To Struct Fields command.

This project welcomes contributions and suggestions. Most contributions require you to agree to aContributor License Agreement (CLA) declaring that you have the right to, and actually do, grant usthe rights to use your contribution. For details, visithttps://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to providea CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructionsprovided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted theMicrosoft Open Source Code of Conduct.For more information see theCode of Conduct FAQ orcontactopencode@microsoft.com with any additional questions or comments.

Copyright © Microsoft Corporation All rights reserved.
Licensed under the MIT License. See LICENSE in the project root for license information.