Skip to content

Commit 0e4fea5

Browse files
dlevy-msft-sqldlevy-msft-sql
committed
feat: add devcontainer for VS Code and GitHub Codespaces
- Go 1.24 with gopls, delve, staticcheck, golangci-lint - SQL Server 2025 (Developer Edition) with health checks - go-sqlcmd built and installed from source (dogfooding!) - Pre-configured VS Code extensions (Go, MSSQL, Copilot, etc.) - Environment variables pre-set for testing - Add Development section to README with quick start guide - Add 'Open in Dev Containers' badge to README
1 parent ca107b8 commit 0e4fea5

File tree

8 files changed

+555
-0
lines changed

8 files changed

+555
-0
lines changed

‎.devcontainer/Dockerfile‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# go-sqlcmd Development Container
2+
FROM mcr.microsoft.com/devcontainers/go:1.24-bookworm
3+
4+
# Install additional OS packages
5+
RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
6+
&& apt-get install -y curl libkrb5-dev gnupg2 \
7+
&& apt-get clean -y && rm -rf /var/lib/apt/lists/*
8+
9+
# Install Microsoft ODBC driver and mssql-tools18 (legacy ODBC sqlcmd/bcp for compatibility testing)
10+
RUN curl -fsSL https://packages.microsoft.com/keys/microsoft.asc | gpg --dearmor -o /usr/share/keyrings/microsoft-prod.gpg \
11+
&& curl -fsSL https://packages.microsoft.com/config/debian/12/prod.list | tee /etc/apt/sources.list.d/mssql-release.list \
12+
&& apt-get update \
13+
&& ACCEPT_EULA=Y apt-get install -y msodbcsql18 mssql-tools18 unixodbc-dev \
14+
&& apt-get clean -y && rm -rf /var/lib/apt/lists/*
15+
ENV PATH="/opt/mssql-tools18/bin:${PATH}"
16+
17+
# Install golangci-lint for code quality
18+
# Download pre-built binary with SHA256 checksum verification (supply chain security)
19+
# Supports both amd64 and arm64 architectures
20+
ARG GOLANGCI_LINT_VERSION=1.64.8
21+
ARG GOLANGCI_LINT_SHA256_AMD64=b6270687afb143d019f387c791cd2a6f1cb383be9b3124d241ca11bd3ce2e54e
22+
ARG GOLANGCI_LINT_SHA256_ARM64=a6ab58ebcb1c48572622146cdaec2956f56871038a54ed1149f1386e287789a5
23+
RUN ARCH=$(dpkg --print-architecture) \
24+
&& if [ "$ARCH" = "amd64" ]; then \
25+
CHECKSUM="${GOLANGCI_LINT_SHA256_AMD64}"; \
26+
elif [ "$ARCH" = "arm64" ]; then \
27+
CHECKSUM="${GOLANGCI_LINT_SHA256_ARM64}"; \
28+
else \
29+
echo "Unsupported architecture: $ARCH" && exit 1; \
30+
fi \
31+
&& curl -fsSLO "https://github.com/golangci/golangci-lint/releases/download/v${GOLANGCI_LINT_VERSION}/golangci-lint-${GOLANGCI_LINT_VERSION}-linux-${ARCH}.tar.gz" \
32+
&& echo "${CHECKSUM} golangci-lint-${GOLANGCI_LINT_VERSION}-linux-${ARCH}.tar.gz" | sha256sum -c - \
33+
&& tar -xzf "golangci-lint-${GOLANGCI_LINT_VERSION}-linux-${ARCH}.tar.gz" \
34+
&& mv "golangci-lint-${GOLANGCI_LINT_VERSION}-linux-${ARCH}/golangci-lint" /usr/local/bin/ \
35+
&& rm -rf "golangci-lint-${GOLANGCI_LINT_VERSION}-linux-${ARCH}" "golangci-lint-${GOLANGCI_LINT_VERSION}-linux-${ARCH}.tar.gz" \
36+
&& golangci-lint --version
37+
38+
# Install additional Go tools (pinned versions for reproducibility)
39+
RUN go install golang.org/x/tools/gopls@v0.18.1 \
40+
&& go install github.com/go-delve/delve/cmd/dlv@v1.24.1 \
41+
&& go install honnef.co/go/tools/cmd/staticcheck@v0.6.1 \
42+
&& go install golang.org/x/text/cmd/gotext@v0.22.0
43+
44+
# Create bin directory for local sqlcmd builds
45+
RUN mkdir -p /home/vscode/bin && chown vscode:vscode /home/vscode/bin
46+
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.24 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: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
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+
"version": "latest",
85+
"moby": true
86+
},
87+
"ghcr.io/devcontainers/features/github-cli:1": {
88+
"version": "latest"
89+
}
90+
}
91+
}

‎.devcontainer/docker-compose.yml‎

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