2026-01-29 01:07:19 +00:00
|
|
|
// Package sdk provides OpenAPI SDK generation and diff capabilities.
|
|
|
|
|
package sdk
|
|
|
|
|
|
|
|
|
|
import (
|
|
|
|
|
"context"
|
|
|
|
|
"fmt"
|
2026-01-29 01:20:58 +00:00
|
|
|
"path/filepath"
|
|
|
|
|
|
feat(mcp): add workspace root validation to prevent path traversal (#100)
* feat(mcp): add workspace root validation to prevent path traversal
- Add workspaceRoot field to Service for restricting file operations
- Add WithWorkspaceRoot() option for configuring the workspace directory
- Add validatePath() helper to check paths are within workspace
- Apply validation to all file operation handlers
- Default to current working directory for security
- Add comprehensive tests for path validation
Closes #82
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
* refactor: move CLI commands from pkg/ to internal/cmd/
- Move 18 CLI command packages to internal/cmd/ (not externally importable)
- Keep 16 library packages in pkg/ (externally importable)
- Update all import paths throughout codebase
- Cleaner separation between CLI logic and reusable libraries
CLI commands moved: ai, ci, dev, docs, doctor, gitcmd, go, monitor,
php, pkgcmd, qa, sdk, security, setup, test, updater, vm, workspace
Libraries remaining: agentic, build, cache, cli, container, devops,
errors, framework, git, i18n, io, log, mcp, process, release, repos
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
* refactor(mcp): use pkg/io Medium for sandboxed file operations
Replace manual path validation with pkg/io.Medium for all file operations.
This delegates security (path traversal, symlink bypass) to the sandboxed
local.Medium implementation.
Changes:
- Add io.NewSandboxed() for creating sandboxed Medium instances
- Refactor MCP Service to use io.Medium instead of direct os.* calls
- Remove validatePath and resolvePathWithSymlinks functions
- Update tests to verify Medium-based behaviour
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
* fix: correct import path and workflow references
- Fix pkg/io/io.go import from core-gui to core
- Update CI workflows to use internal/cmd/updater path
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
* fix(security): address CodeRabbit review issues for path validation
- pkg/io/local: add symlink resolution and boundary-aware containment
- Reject absolute paths in sandboxed Medium
- Use filepath.EvalSymlinks to prevent symlink bypass attacks
- Fix prefix check to prevent /tmp/root matching /tmp/root2
- pkg/mcp: fix resolvePath to validate and return errors
- Changed resolvePath from (string) to (string, error)
- Update deleteFile, renameFile, listDirectory, fileExists to handle errors
- Changed New() to return (*Service, error) instead of *Service
- Properly propagate option errors instead of silently discarding
- pkg/io: wrap errors with E() helper for consistent context
- Copy() and MockMedium.Read() now use coreerr.E()
- tests: rename to use _Good/_Bad/_Ugly suffixes per coding guidelines
- Fix hardcoded /tmp in TestPath to use t.TempDir()
- Add TestResolvePath_Bad_SymlinkTraversal test
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
* style: fix gofmt formatting
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
* style: fix gofmt formatting across all files
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-01 21:59:34 +00:00
|
|
|
"github.com/host-uk/core/internal/cmd/sdk/generators"
|
2026-01-29 01:07:19 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
|
|
// Config holds SDK generation configuration from .core/release.yaml.
|
|
|
|
|
type Config struct {
|
|
|
|
|
// Spec is the path to the OpenAPI spec file (auto-detected if empty).
|
|
|
|
|
Spec string `yaml:"spec,omitempty"`
|
|
|
|
|
// Languages to generate SDKs for.
|
|
|
|
|
Languages []string `yaml:"languages,omitempty"`
|
|
|
|
|
// Output directory (default: sdk/).
|
|
|
|
|
Output string `yaml:"output,omitempty"`
|
|
|
|
|
// Package naming configuration.
|
|
|
|
|
Package PackageConfig `yaml:"package,omitempty"`
|
|
|
|
|
// Diff configuration for breaking change detection.
|
|
|
|
|
Diff DiffConfig `yaml:"diff,omitempty"`
|
|
|
|
|
// Publish configuration for monorepo publishing.
|
|
|
|
|
Publish PublishConfig `yaml:"publish,omitempty"`
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// PackageConfig holds package naming configuration.
|
|
|
|
|
type PackageConfig struct {
|
|
|
|
|
// Name is the base package name.
|
|
|
|
|
Name string `yaml:"name,omitempty"`
|
|
|
|
|
// Version is the SDK version (supports templates like {{.Version}}).
|
|
|
|
|
Version string `yaml:"version,omitempty"`
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// DiffConfig holds breaking change detection configuration.
|
|
|
|
|
type DiffConfig struct {
|
|
|
|
|
// Enabled determines whether to run diff checks.
|
|
|
|
|
Enabled bool `yaml:"enabled,omitempty"`
|
|
|
|
|
// FailOnBreaking fails the release if breaking changes are detected.
|
|
|
|
|
FailOnBreaking bool `yaml:"fail_on_breaking,omitempty"`
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// PublishConfig holds monorepo publishing configuration.
|
|
|
|
|
type PublishConfig struct {
|
|
|
|
|
// Repo is the SDK monorepo (e.g., "myorg/sdks").
|
|
|
|
|
Repo string `yaml:"repo,omitempty"`
|
|
|
|
|
// Path is the subdirectory for this SDK (e.g., "packages/myapi").
|
|
|
|
|
Path string `yaml:"path,omitempty"`
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// SDK orchestrates OpenAPI SDK generation.
|
|
|
|
|
type SDK struct {
|
|
|
|
|
config *Config
|
|
|
|
|
projectDir string
|
2026-01-29 03:15:08 +00:00
|
|
|
version string
|
2026-01-29 01:07:19 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// New creates a new SDK instance.
|
|
|
|
|
func New(projectDir string, config *Config) *SDK {
|
|
|
|
|
if config == nil {
|
|
|
|
|
config = DefaultConfig()
|
|
|
|
|
}
|
|
|
|
|
return &SDK{
|
|
|
|
|
config: config,
|
|
|
|
|
projectDir: projectDir,
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2026-01-29 03:15:08 +00:00
|
|
|
// SetVersion sets the SDK version for generation.
|
|
|
|
|
// This updates both the internal version field and the config's Package.Version.
|
|
|
|
|
func (s *SDK) SetVersion(version string) {
|
|
|
|
|
s.version = version
|
|
|
|
|
if s.config != nil {
|
|
|
|
|
s.config.Package.Version = version
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2026-01-29 01:07:19 +00:00
|
|
|
// DefaultConfig returns sensible defaults for SDK configuration.
|
|
|
|
|
func DefaultConfig() *Config {
|
|
|
|
|
return &Config{
|
|
|
|
|
Languages: []string{"typescript", "python", "go", "php"},
|
|
|
|
|
Output: "sdk",
|
|
|
|
|
Diff: DiffConfig{
|
|
|
|
|
Enabled: true,
|
|
|
|
|
FailOnBreaking: false,
|
|
|
|
|
},
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Generate generates SDKs for all configured languages.
|
|
|
|
|
func (s *SDK) Generate(ctx context.Context) error {
|
2026-01-29 01:20:58 +00:00
|
|
|
// Generate for each language
|
|
|
|
|
for _, lang := range s.config.Languages {
|
|
|
|
|
if err := s.GenerateLanguage(ctx, lang); err != nil {
|
|
|
|
|
return err
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return nil
|
2026-01-29 01:07:19 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// GenerateLanguage generates SDK for a specific language.
|
|
|
|
|
func (s *SDK) GenerateLanguage(ctx context.Context, lang string) error {
|
2026-01-29 01:20:58 +00:00
|
|
|
specPath, err := s.DetectSpec()
|
|
|
|
|
if err != nil {
|
|
|
|
|
return err
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
registry := generators.NewRegistry()
|
|
|
|
|
registry.Register(generators.NewTypeScriptGenerator())
|
|
|
|
|
registry.Register(generators.NewPythonGenerator())
|
|
|
|
|
registry.Register(generators.NewGoGenerator())
|
|
|
|
|
registry.Register(generators.NewPHPGenerator())
|
|
|
|
|
|
|
|
|
|
gen, ok := registry.Get(lang)
|
|
|
|
|
if !ok {
|
|
|
|
|
return fmt.Errorf("sdk.GenerateLanguage: unknown language: %s", lang)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if !gen.Available() {
|
|
|
|
|
fmt.Printf("Warning: %s generator not available. Install with: %s\n", lang, gen.Install())
|
|
|
|
|
fmt.Printf("Falling back to Docker...\n")
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
outputDir := filepath.Join(s.projectDir, s.config.Output, lang)
|
|
|
|
|
opts := generators.Options{
|
|
|
|
|
SpecPath: specPath,
|
|
|
|
|
OutputDir: outputDir,
|
|
|
|
|
PackageName: s.config.Package.Name,
|
|
|
|
|
Version: s.config.Package.Version,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
fmt.Printf("Generating %s SDK...\n", lang)
|
|
|
|
|
if err := gen.Generate(ctx, opts); err != nil {
|
|
|
|
|
return fmt.Errorf("sdk.GenerateLanguage: %s generation failed: %w", lang, err)
|
|
|
|
|
}
|
|
|
|
|
fmt.Printf("Generated %s SDK at %s\n", lang, outputDir)
|
|
|
|
|
|
|
|
|
|
return nil
|
2026-01-29 01:07:19 +00:00
|
|
|
}
|