|
| 1 | +[tools] |
| 2 | +go = "1.25" |
| 3 | +protoc = "29.6" |
| 4 | +"go:github.com/golangci/golangci-lint/v2/cmd/golangci-lint" = "2.12" |
| 5 | +"go:google.golang.org/protobuf/cmd/protoc-gen-go" = "1.36.11" |
| 6 | +"go:google.golang.org/grpc/cmd/protoc-gen-go-grpc" = "1.6.2" |
| 7 | + |
| 8 | +[tasks.test] |
| 9 | +description = "Run unit tests with coverage" |
| 10 | +run = "go test -coverprofile=coverage.out -coverpkg=./openshell/... -race ./..." |
| 11 | + |
| 12 | +[tasks."test:integration"] |
| 13 | +description = "Run integration tests" |
| 14 | +run = "go test -tags=integration -race ./..." |
| 15 | + |
| 16 | +[tasks.lint] |
| 17 | +description = "Run linter" |
| 18 | +run = "golangci-lint run ./..." |
| 19 | + |
| 20 | +[tasks.fmt] |
| 21 | +description = "Format code" |
| 22 | +run = "goimports -w . && go fmt ./..." |
| 23 | + |
| 24 | +[tasks.build] |
| 25 | +description = "Build all packages" |
| 26 | +run = "go build ./..." |
| 27 | + |
| 28 | +[tasks.ci] |
| 29 | +description = "Run full CI pipeline" |
| 30 | +depends = ["lint", "build", "test", "proto:check", "docs:check"] |
| 31 | + |
| 32 | +[tasks."docs:check"] |
| 33 | +description = "Verify every public package has a docs page" |
| 34 | +run = """ |
| 35 | +#!/usr/bin/env bash |
| 36 | +set -euo pipefail |
| 37 | +
|
| 38 | +DOCS_DIR="docs/src/api" |
| 39 | +SUMMARY="docs/src/SUMMARY.md" |
| 40 | +MISSING=0 |
| 41 | +
|
| 42 | +# Find all public packages with a doc.go (excluding internal, proto, types) |
| 43 | +for docfile in openshell/v1/*/doc.go; do |
| 44 | + pkg=$(basename "$(dirname "$docfile")") |
| 45 | +
|
| 46 | + # Skip internal packages and types (no user-facing docs needed) |
| 47 | + case "$pkg" in |
| 48 | + internal|types) continue ;; |
| 49 | + esac |
| 50 | +
|
| 51 | + # Check for matching docs page |
| 52 | + if [ ! -f "$DOCS_DIR/$pkg.md" ]; then |
| 53 | + echo "MISSING: $DOCS_DIR/$pkg.md (package openshell/v1/$pkg has doc.go but no docs page)" |
| 54 | + MISSING=$((MISSING + 1)) |
| 55 | + fi |
| 56 | +
|
| 57 | + # Check for SUMMARY.md entry |
| 58 | + if ! grep -q "api/$pkg.md" "$SUMMARY" 2>/dev/null; then |
| 59 | + echo "MISSING: SUMMARY.md entry for api/$pkg.md" |
| 60 | + MISSING=$((MISSING + 1)) |
| 61 | + fi |
| 62 | +done |
| 63 | +
|
| 64 | +if [ "$MISSING" -gt 0 ]; then |
| 65 | + echo "" |
| 66 | + echo "ERROR: $MISSING documentation gaps found." |
| 67 | + echo "Every public package with doc.go needs a docs/src/api/<pkg>.md page" |
| 68 | + echo "and a SUMMARY.md entry. See Constitution XIII." |
| 69 | + exit 1 |
| 70 | +fi |
| 71 | +
|
| 72 | +echo "Docs check passed: all public packages have documentation." |
| 73 | +""" |
| 74 | + |
| 75 | +[tasks."proto:gen"] |
| 76 | +description = "Generate Go bindings from proto files" |
| 77 | +run = """ |
| 78 | +#!/usr/bin/env bash |
| 79 | +set -euo pipefail |
| 80 | +
|
| 81 | +# Check required tools |
| 82 | +for tool in protoc protoc-gen-go protoc-gen-go-grpc; do |
| 83 | + if ! command -v "$tool" &>/dev/null; then |
| 84 | + echo "ERROR: $tool not found. Run 'mise install' to install it." |
| 85 | + exit 1 |
| 86 | + fi |
| 87 | +done |
| 88 | +
|
| 89 | +MODULE="github.com/NVIDIA/OpenShell/sdk/go" |
| 90 | +PROTO_DIR="proto" |
| 91 | +
|
| 92 | +# Create output directories |
| 93 | +mkdir -p "$PROTO_DIR/openshellv1" "$PROTO_DIR/datamodelv1" "$PROTO_DIR/sandboxv1" |
| 94 | +
|
| 95 | +# M flag mappings for Go package paths |
| 96 | +M_FLAGS="" |
| 97 | +M_FLAGS="$M_FLAGS --go_opt=Mopenshell.proto=$MODULE/proto/openshellv1" |
| 98 | +M_FLAGS="$M_FLAGS --go_opt=Mdatamodel.proto=$MODULE/proto/datamodelv1" |
| 99 | +M_FLAGS="$M_FLAGS --go_opt=Msandbox.proto=$MODULE/proto/sandboxv1" |
| 100 | +M_FLAGS="$M_FLAGS --go-grpc_opt=Mopenshell.proto=$MODULE/proto/openshellv1" |
| 101 | +M_FLAGS="$M_FLAGS --go-grpc_opt=Mdatamodel.proto=$MODULE/proto/datamodelv1" |
| 102 | +M_FLAGS="$M_FLAGS --go-grpc_opt=Msandbox.proto=$MODULE/proto/sandboxv1" |
| 103 | +
|
| 104 | +# Generate Go code for all proto files |
| 105 | +# Use module= option to strip the module prefix from the output path, |
| 106 | +# so files land in proto/openshellv1/ etc. instead of the full module path |
| 107 | +protoc \ |
| 108 | + --proto_path="$PROTO_DIR" \ |
| 109 | + --go_out=. \ |
| 110 | + --go_opt=module=$MODULE \ |
| 111 | + --go-grpc_out=. \ |
| 112 | + --go-grpc_opt=module=$MODULE \ |
| 113 | + $M_FLAGS \ |
| 114 | + "$PROTO_DIR/openshell.proto" \ |
| 115 | + "$PROTO_DIR/datamodel.proto" \ |
| 116 | + "$PROTO_DIR/sandbox.proto" |
| 117 | +
|
| 118 | +echo "Proto generation complete." |
| 119 | +echo "Generated packages:" |
| 120 | +for pkg in openshellv1 datamodelv1 sandboxv1; do |
| 121 | + echo " $PROTO_DIR/$pkg/: $(ls "$PROTO_DIR/$pkg/"*.go 2>/dev/null | wc -l | tr -d ' ') files" |
| 122 | +done |
| 123 | +""" |
| 124 | + |
| 125 | +[tasks."proto:check"] |
| 126 | +description = "Verify generated proto files are up to date" |
| 127 | +run = """ |
| 128 | +#!/usr/bin/env bash |
| 129 | +set -euo pipefail |
| 130 | +
|
| 131 | +# Check required tools |
| 132 | +for tool in protoc protoc-gen-go protoc-gen-go-grpc; do |
| 133 | + if ! command -v "$tool" &>/dev/null; then |
| 134 | + echo "ERROR: $tool not found. Run 'mise install' to install it." |
| 135 | + exit 1 |
| 136 | + fi |
| 137 | +done |
| 138 | +
|
| 139 | +MODULE="github.com/NVIDIA/OpenShell/sdk/go" |
| 140 | +PROTO_DIR="proto" |
| 141 | +WORK_DIR=$(mktemp -d) |
| 142 | +trap 'rm -rf "$WORK_DIR"' EXIT |
| 143 | +
|
| 144 | +# Create output directories in temp |
| 145 | +mkdir -p "$WORK_DIR/proto/openshellv1" "$WORK_DIR/proto/datamodelv1" "$WORK_DIR/proto/sandboxv1" |
| 146 | +
|
| 147 | +# M flag mappings (same as proto:gen) |
| 148 | +M_FLAGS="" |
| 149 | +M_FLAGS="$M_FLAGS --go_opt=Mopenshell.proto=$MODULE/proto/openshellv1" |
| 150 | +M_FLAGS="$M_FLAGS --go_opt=Mdatamodel.proto=$MODULE/proto/datamodelv1" |
| 151 | +M_FLAGS="$M_FLAGS --go_opt=Msandbox.proto=$MODULE/proto/sandboxv1" |
| 152 | +M_FLAGS="$M_FLAGS --go-grpc_opt=Mopenshell.proto=$MODULE/proto/openshellv1" |
| 153 | +M_FLAGS="$M_FLAGS --go-grpc_opt=Mdatamodel.proto=$MODULE/proto/datamodelv1" |
| 154 | +M_FLAGS="$M_FLAGS --go-grpc_opt=Msandbox.proto=$MODULE/proto/sandboxv1" |
| 155 | +
|
| 156 | +# Generate to temp directory |
| 157 | +protoc \ |
| 158 | + --proto_path="$PROTO_DIR" \ |
| 159 | + --go_out="$WORK_DIR" \ |
| 160 | + --go_opt=module=$MODULE \ |
| 161 | + --go-grpc_out="$WORK_DIR" \ |
| 162 | + --go-grpc_opt=module=$MODULE \ |
| 163 | + $M_FLAGS \ |
| 164 | + "$PROTO_DIR/openshell.proto" \ |
| 165 | + "$PROTO_DIR/datamodel.proto" \ |
| 166 | + "$PROTO_DIR/sandbox.proto" |
| 167 | +
|
| 168 | +# Diff against committed files |
| 169 | +DIFF_OUTPUT=$(diff -r "$WORK_DIR/proto" "$PROTO_DIR" \ |
| 170 | + --exclude="*.proto" \ |
| 171 | + --exclude="UPSTREAM_VERSION" \ |
| 172 | + 2>&1) || true |
| 173 | +
|
| 174 | +if [ -n "$DIFF_OUTPUT" ]; then |
| 175 | + echo "ERROR: Generated proto files are out of date." |
| 176 | + echo "Run 'mise run proto:gen' to regenerate." |
| 177 | + echo "" |
| 178 | + echo "$DIFF_OUTPUT" |
| 179 | + exit 1 |
| 180 | +fi |
| 181 | +
|
| 182 | +echo "Proto check passed: generated files are up to date." |
| 183 | +""" |
| 184 | + |
| 185 | +[tasks."proto:clean"] |
| 186 | +description = "Remove all generated proto files" |
| 187 | +run = """ |
| 188 | +#!/usr/bin/env bash |
| 189 | +set -euo pipefail |
| 190 | +
|
| 191 | +PROTO_DIR="proto" |
| 192 | +
|
| 193 | +# Remove all generated .pb.go files |
| 194 | +find "$PROTO_DIR" -name "*.pb.go" -delete 2>/dev/null || true |
| 195 | +
|
| 196 | +# Remove empty generated subdirectories |
| 197 | +for dir in "$PROTO_DIR"/*/; do |
| 198 | + [ -d "$dir" ] && rmdir "$dir" 2>/dev/null || true |
| 199 | +done |
| 200 | +
|
| 201 | +echo "Proto clean complete." |
| 202 | +""" |
| 203 | + |
| 204 | +[tasks."proto:sync"] |
| 205 | +description = "Sync proto files from upstream OpenShell repo" |
| 206 | +run = """ |
| 207 | +#!/usr/bin/env bash |
| 208 | +set -euo pipefail |
| 209 | +
|
| 210 | +UPSTREAM_PATH="${UPSTREAM_PATH:-../OpenShell/proto}" |
| 211 | +
|
| 212 | +if [ ! -d "$UPSTREAM_PATH" ]; then |
| 213 | + echo "ERROR: Upstream proto directory not found: $UPSTREAM_PATH" |
| 214 | + echo "Set UPSTREAM_PATH env var to the correct location." |
| 215 | + exit 1 |
| 216 | +fi |
| 217 | +
|
| 218 | +PROTO_DIR="proto" |
| 219 | +mkdir -p "$PROTO_DIR" |
| 220 | +
|
| 221 | +PROTO_FILES="openshell.proto datamodel.proto sandbox.proto" |
| 222 | +for f in $PROTO_FILES; do |
| 223 | + src="$UPSTREAM_PATH/$f" |
| 224 | + if [ ! -f "$src" ]; then |
| 225 | + echo "ERROR: Proto file not found: $src" |
| 226 | + exit 1 |
| 227 | + fi |
| 228 | + cp "$src" "$PROTO_DIR/$f" |
| 229 | + echo "Copied $f" |
| 230 | +done |
| 231 | +
|
| 232 | +# Record upstream commit SHA |
| 233 | +UPSTREAM_REPO_DIR="$(cd "$UPSTREAM_PATH/.." && pwd)" |
| 234 | +if [ -d "$UPSTREAM_REPO_DIR/.git" ]; then |
| 235 | + SHA=$(git -C "$UPSTREAM_REPO_DIR" rev-parse HEAD) |
| 236 | +else |
| 237 | + SHA="unknown" |
| 238 | +fi |
| 239 | +echo "$SHA" > "$PROTO_DIR/UPSTREAM_VERSION" |
| 240 | +echo "Upstream version: $SHA" |
| 241 | +echo "Proto sync complete." |
| 242 | +""" |
0 commit comments