Skip to content

Commit bdc375d

Browse files
dlevy-msft-sqldlevy-msft-sql
authored
feat: add devcontainer for VS Code and GitHub Codespaces (#692)
1 parent 9986ed0 commit bdc375d

10 files changed

Lines changed: 626 additions & 0 deletions

File tree

‎.devcontainer/Dockerfile‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# go-sqlcmd Development Container
2+
# The Go major.minor version here must match the 'go' directive in go.mod.
3+
# GOTOOLCHAIN=auto lets Go download the exact patch version (e.g. 1.25.9)
4+
# when the base image is slightly behind. Downloads are verified against
5+
# sum.golang.org.
6+
FROM mcr.microsoft.com/devcontainers/go:1.25-bookworm
7+
ENV GOTOOLCHAIN=auto
8+
9+
# The base image sets GOPATH=/go owned by root. Override to a user-writable
10+
# location so GOTOOLCHAIN=auto can download patch releases without sudo.
11+
ENV GOPATH=/home/vscode/go
12+
13+
# Install additional OS packages
14+
RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
15+
&& apt-get install -y curl libkrb5-dev gnupg2 \
16+
&& apt-get clean -y && rm -rf /var/lib/apt/lists/*
17+
18+
# Install Microsoft ODBC driver and mssql-tools18 (legacy ODBC sqlcmd/bcp for compatibility testing)
19+
RUN curl -fsSL https://packages.microsoft.com/keys/microsoft.asc | gpg --dearmor -o /usr/share/keyrings/microsoft-prod.gpg \
20+
&& curl -fsSL https://packages.microsoft.com/config/debian/12/prod.list | tee /etc/apt/sources.list.d/mssql-release.list \
21+
&& apt-get update \
22+
&& ACCEPT_EULA=Y apt-get install -y msodbcsql18 mssql-tools18 unixodbc-dev \
23+
&& apt-get clean -y && rm -rf /var/lib/apt/lists/*
24+
ENV PATH="/opt/mssql-tools18/bin:${PATH}"
25+
26+
# Install golangci-lint for code quality
27+
# Download pre-built binary with SHA256 checksum verification (supply chain security)
28+
# Supports both amd64 and arm64 architectures
29+
ARG GOLANGCI_LINT_VERSION=1.64.8
30+
ARG GOLANGCI_LINT_SHA256_AMD64=b6270687afb143d019f387c791cd2a6f1cb383be9b3124d241ca11bd3ce2e54e
31+
ARG GOLANGCI_LINT_SHA256_ARM64=a6ab58ebcb1c48572622146cdaec2956f56871038a54ed1149f1386e287789a5
32+
RUN ARCH=$(dpkg --print-architecture) \
33+
&& if [ "$ARCH" = "amd64" ]; then \
34+
CHECKSUM="${GOLANGCI_LINT_SHA256_AMD64}"; \
35+
elif [ "$ARCH" = "arm64" ]; then \
36+
CHECKSUM="${GOLANGCI_LINT_SHA256_ARM64}"; \
37+
else \
38+
echo "Unsupported architecture: $ARCH" && exit 1; \
39+
fi \
40+
&& curl -fsSLO "https://github.com/golangci/golangci-lint/releases/download/v${GOLANGCI_LINT_VERSION}/golangci-lint-${GOLANGCI_LINT_VERSION}-linux-${ARCH}.tar.gz" \
41+
&& echo "${CHECKSUM} golangci-lint-${GOLANGCI_LINT_VERSION}-linux-${ARCH}.tar.gz" | sha256sum -c - \
42+
&& tar -xzf "golangci-lint-${GOLANGCI_LINT_VERSION}-linux-${ARCH}.tar.gz" \
43+
&& mv "golangci-lint-${GOLANGCI_LINT_VERSION}-linux-${ARCH}/golangci-lint" /usr/local/bin/ \
44+
&& rm -rf "golangci-lint-${GOLANGCI_LINT_VERSION}-linux-${ARCH}" "golangci-lint-${GOLANGCI_LINT_VERSION}-linux-${ARCH}.tar.gz" \
45+
&& golangci-lint --version
46+
47+
# Install additional Go tools (pinned versions for reproducibility)
48+
# These versions must be compatible with the Go version in the base image.
49+
RUN go install golang.org/x/tools/gopls@v0.21.1 \
50+
&& go install github.com/go-delve/delve/cmd/dlv@v1.26.1 \
51+
&& go install honnef.co/go/tools/cmd/staticcheck@v0.7.0 \
52+
&& go install golang.org/x/text/cmd/gotext@v0.35.0
53+
54+
# Fix ownership: go install ran as root and populated $GOPATH with root-owned
55+
# files. chown the entire tree so vscode can write (GOTOOLCHAIN=auto downloads).
56+
RUN mkdir -p /home/vscode/bin \
57+
&& chown -R vscode:vscode /home/vscode/go /home/vscode/bin
58+
ENV PATH="/home/vscode/bin:${PATH}"

‎.devcontainer/README.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# go-sqlcmd Development Container
2+
3+
Dev Container / Codespaces environment with Go 1.25 and SQL Server 2025.
4+
5+
## Quick Start
6+
7+
**VS Code**: Open repo → click "Reopen in Container" when prompted.
8+
9+
**Codespaces**: Click "Code" → "Codespaces" → "Create codespace".
10+
11+
First build takes ~5 minutes.
12+
13+
## Commands
14+
15+
| Alias | What it does |
16+
|-------|--------------|
17+
| `gtest` | Run tests |
18+
| `ginstall` | Build and install sqlcmd to ~/bin |
19+
| `glint` | Run golangci-lint |
20+
| `sql` | Connect to SQL Server (go-sqlcmd) |
21+
| `sql-legacy` | Connect with legacy ODBC sqlcmd |
22+
| `test-db` | Test database connection |
23+
24+
## SQL Server Connection
25+
26+
- **Server**: `localhost,1433`
27+
- **User**: `sa`
28+
- **Password**: `$SQLCMDPASSWORD` env var (`SqlCmd@2025!` for local dev)
29+
- **Database**: `master` or `SqlCmdTest`
30+
31+
Port 1433 is forwarded — connect from host tools (ADS, SSMS) using same credentials.
32+
33+
## Two sqlcmd Versions
34+
35+
- **go-sqlcmd**: `~/bin/sqlcmd` (default in PATH, use `sql` alias)
36+
- **Legacy ODBC**: `/opt/mssql-tools18/bin/sqlcmd` (use `sql-legacy` alias)
37+
38+
## Customization
39+
40+
**Change SQL version**: Edit `docker-compose.yml` image tag.
41+
42+
**Add setup scripts**: Edit `.devcontainer/mssql/setup.sql`.
43+
44+
**Change password**: Update `docker-compose.yml` and `devcontainer.json`.
45+
46+
## Troubleshooting
47+
48+
- **ARM64 (Apple Silicon)**: Use GitHub Codespaces instead - SQL Server has no native ARM64 images
49+
- **SQL Server not starting**: Check `docker logs $(docker ps -qf "name=db")`. Needs 2GB+ RAM
50+
- **Connection refused**: Wait ~30s for SQL Server to start
51+
- **sqlcmd not found**: Run `ginstall`

‎.devcontainer/devcontainer.json‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
{
2+
"name": "go-sqlcmd Development",
3+
"dockerComposeFile": "docker-compose.yml",
4+
"service": "devcontainer",
5+
"workspaceFolder": "/workspaces/go-sqlcmd",
6+
"shutdownAction": "stopCompose",
7+
8+
// Configure tool-specific properties
9+
"customizations": {
10+
"vscode": {
11+
"extensions": [
12+
"golang.go",
13+
"ms-mssql.mssql",
14+
"ms-azuretools.vscode-docker",
15+
"GitHub.copilot",
16+
"GitHub.copilot-chat",
17+
"eamodio.gitlens",
18+
"EditorConfig.EditorConfig",
19+
"streetsidesoftware.code-spell-checker"
20+
],
21+
"settings": {
22+
"go.toolsManagement.autoUpdate": false,
23+
"go.useLanguageServer": true,
24+
"go.lintTool": "golangci-lint",
25+
"go.lintFlags": ["--fast"],
26+
"go.testEnvVars": {
27+
"SQLCMDSERVER": "localhost",
28+
"SQLCMDUSER": "sa",
29+
"SQLCMDPASSWORD": "${env:SQLCMDPASSWORD}",
30+
"SQLCMDDATABASE": "master"
31+
},
32+
"mssql.connections": [
33+
{
34+
"server": "localhost,1433",
35+
"database": "master",
36+
"authenticationType": "SqlLogin",
37+
"user": "sa",
38+
"password": "",
39+
"savePassword": false,
40+
"profileName": "sqlcmd-container (use SQLCMDPASSWORD env var)",
41+
"encrypt": "Optional",
42+
"trustServerCertificate": true
43+
}
44+
],
45+
"editor.formatOnSave": true,
46+
"editor.defaultFormatter": "golang.go",
47+
"[go]": {
48+
"editor.formatOnSave": true,
49+
"editor.codeActionsOnSave": {
50+
"source.organizeImports": "explicit"
51+
}
52+
},
53+
"terminal.integrated.defaultProfile.linux": "bash"
54+
}
55+
}
56+
},
57+
58+
// Forward the SQL Server port
59+
"forwardPorts": [1433],
60+
"portsAttributes": {
61+
"1433": {
62+
"label": "SQL Server",
63+
"onAutoForward": "silent"
64+
}
65+
},
66+
67+
// Use 'postCreateCommand' to run commands after the container is created
68+
"postCreateCommand": "bash .devcontainer/post-create.sh",
69+
70+
// Environment variables for tests - password must match docker-compose.yml
71+
// This is a development-only container credential, not a production secret.
72+
// For GitHub Codespaces, you can override SQLCMDPASSWORD via Codespaces Secrets.
73+
"remoteEnv": {
74+
"SQLCMDSERVER": "localhost",
75+
"SQLCMDUSER": "sa",
76+
"SQLCMDPASSWORD": "${localEnv:SQLCMDPASSWORD:SqlCmd@2025!}",
77+
"SQLCMDDATABASE": "master",
78+
"SQLCMDDBNAME": "master"
79+
},
80+
81+
// Features to add to the dev container
82+
"features": {
83+
"ghcr.io/devcontainers/features/docker-in-docker:2": {
84+
"moby": true
85+
},
86+
"ghcr.io/devcontainers/features/github-cli:1": {}
87+
}
88+
}

‎.devcontainer/docker-compose.yml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
services:
2+
devcontainer:
3+
build:
4+
context: .
5+
dockerfile: Dockerfile
6+
volumes:
7+
- ..:/workspaces/go-sqlcmd:cached
8+
# Overrides default command so things don't shut down after the process ends.
9+
command: sleep infinity
10+
# Runs app on the same network as the database container, allows "forwardPorts" in devcontainer.json function.
11+
network_mode: service:db
12+
depends_on:
13+
db:
14+
condition: service_healthy
15+
16+
db:
17+
image: mcr.microsoft.com/mssql/server:2025-CU3-ubuntu-22.04
18+
restart: unless-stopped
19+
environment:
20+
ACCEPT_EULA: "Y"
21+
# Password can be overridden via SQLCMDPASSWORD environment variable
22+
SA_PASSWORD: "${SQLCMDPASSWORD:-SqlCmd@2025!}"
23+
MSSQL_SA_PASSWORD: "${SQLCMDPASSWORD:-SqlCmd@2025!}"
24+
MSSQL_PID: "Developer"
25+
volumes:
26+
- mssql-data:/var/opt/mssql
27+
healthcheck:
28+
test: ["CMD-SHELL", "/opt/mssql-tools18/bin/sqlcmd -S localhost -U sa -P \"$$MSSQL_SA_PASSWORD\" -C -Q \"SELECT 1\" || exit 1"]
29+
interval: 10s
30+
timeout: 5s
31+
retries: 15
32+
start_period: 45s
33+
34+
volumes:
35+
mssql-data:

‎.devcontainer/mssql/setup.sql‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
-- go-sqlcmd Development Database Setup
2+
-- This script runs automatically when the devcontainer starts
3+
4+
USE master;
5+
GO
6+
7+
-- Create a test database for development
8+
IF NOT EXISTS (SELECT * FROM sys.databases WHERE name = 'SqlCmdTest')
9+
BEGIN
10+
CREATE DATABASE SqlCmdTest;
11+
PRINT 'Created database: SqlCmdTest';
12+
END
13+
GO
14+
15+
-- Enable contained database authentication for testing
16+
-- Use TRY/CATCH in case this fails on certain SQL Server configurations
17+
BEGIN TRY
18+
EXEC sp_configure 'contained database authentication', 1;
19+
RECONFIGURE;
20+
END TRY
21+
BEGIN CATCH
22+
PRINT 'Note: Could not enable contained database authentication (may already be enabled or not supported)';
23+
END CATCH;
24+
GO
25+
26+
-- Make SqlCmdTest a contained database for testing
27+
BEGIN TRY
28+
ALTER DATABASE SqlCmdTest SET CONTAINMENT = PARTIAL;
29+
END TRY
30+
BEGIN CATCH
31+
PRINT 'Note: Could not set database containment (may not be supported)';
32+
END CATCH;
33+
GO
34+
35+
USE SqlCmdTest;
36+
GO
37+
38+
-- Create a sample table for quick testing
39+
IF NOT EXISTS (SELECT * FROM sys.tables WHERE name = 'TestTable')
40+
BEGIN
41+
CREATE TABLE TestTable (
42+
ID INT IDENTITY(1,1) PRIMARY KEY,
43+
Name NVARCHAR(100) NOT NULL,
44+
Value NVARCHAR(MAX),
45+
CreatedAt DATETIME2 DEFAULT GETUTCDATE()
46+
);
47+
48+
INSERT INTO TestTable (Name, Value) VALUES
49+
('Test1', 'Sample value 1'),
50+
('Test2', 'Sample value 2'),
51+
('Test3', 'Sample value 3');
52+
53+
PRINT 'Created table: TestTable with sample data';
54+
END
55+
GO
56+
57+
-- Create a view for testing
58+
IF NOT EXISTS (SELECT * FROM sys.views WHERE name = 'TestView')
59+
BEGIN
60+
EXEC('CREATE VIEW TestView AS SELECT ID, Name, CreatedAt FROM TestTable');
61+
PRINT 'Created view: TestView';
62+
END
63+
GO
64+
65+
PRINT 'go-sqlcmd development database setup complete!';
66+
PRINT 'Test database: SqlCmdTest';
67+
PRINT 'Sample table: TestTable (3 rows)';
68+
PRINT 'Sample view: TestView';
69+
GO

0 commit comments

Comments
 (0)