Files
35759c47af V1beta3 (#1873)
* Change workflow branch from 'main' to 'v1beta3'

* Auto updater (#1849)

* added auto updater

* updated docs

* commit to trigger actions

* Auto-collectors: foundational discovery, image metadata, CLI integrat… (#1845)

* Auto-collectors: foundational discovery, image metadata, CLI integration; reset PRD markers

* Address PR review feedback

- Implement missing namespace exclude patterns functionality
- Fix image facts collector to use empty Data field instead of static string
- Correct APIVersion to use troubleshoot.sh/v1beta2 consistently

* Fix bug bot issues: API parsing, EOF error, and API group corrections

- Fix RBAC API parsing errors in rbac_checker.go (getAPIGroup/getAPIVersion functions)
- Fix FakeReader EOF error to use standard io.EOF instead of custom error
- Fix incorrect API group from troubleshoot.sh to troubleshoot.replicated.com in run.go

These changes address the issues identified by the bug bot and ensure proper
interface compliance and consistent API group usage.

* Fix multiple bug bot issues

- Fix RBAC API parsing errors in rbac_checker.go (getAPIGroup/getAPIVersion functions)
- Fix FakeReader EOF error to use standard io.EOF instead of custom error
- Fix incorrect API group from troubleshoot.sh to troubleshoot.replicated.com in run.go
- Fix image facts collector Data field to contain structured JSON instead of static strings

These changes address all issues identified by the bug bot and ensure proper
interface compliance, consistent API usage, and meaningful data fields.

* Update auto_discovery.go

* Fix TODO comments in Auto-collector section

Fixed 3 of 4 TODOs as requested in PR review:

1. pkg/collect/images/registry_client.go (line 46):
   - Implement custom CA certificate loading
   - Add x509 import and certificate parsing logic
   - Enables image collection from private registries with custom CAs

2. cmd/troubleshoot/cli/diff.go (line 209):
   - Implement bundle file count functionality
   - Add tar/gzip imports and getFileCountFromBundle() function
   - Properly counts files in support bundle archives (.gz/.tgz)

3. cmd/troubleshoot/cli/run.go (line 338):
   - Replace TODO with clarifying comment about RemoteCollectors usage
   - Confirmed RemoteCollectors are still actively used in preflights

The 4th TODO (diff.go line 196) is left as-is since it's explicitly marked
as Phase 4 future work (Support Bundle Differencing implementation).

Addresses PR review feedback about unimplemented TODO comments.

---------

Co-authored-by: Benjamin Yang <benjaminyang@Benjamins-MacBook-Pro.local>

* resetting make targets and github workflows to support v1beta3 releas… (#1853)

* resetting make targets and github workflows to support v1beta3 release later

* removing generate

* remove

* removing

* removing

* Support bundle diff (#1855)

implemented support bundle diff command

* Preflight docs and template subcommands (#1847)

* Added docs and template subcommands with test files

* uses helm templating preflight yaml files

* merge doc requirements for multiple inputs

* Helm aware rendering and markdown output

* v1beta3 yaml structure better mirrors beta2

* Update sample-preflight-templated.yaml

* Added docs and template subcommands with test files

* uses helm templating preflight yaml files

* merge doc requirements for multiple inputs

* Helm aware rendering and markdown output

* v1beta3 yaml structure better mirrors beta2

* Update sample-preflight-templated.yaml

* Added/updated documentation on subcommands

* Update docs.go

* commit to trigger actions

* Updated yaml spec (#1851)

* v1beta3 spec can be read by preflight

* added test files for ease of testing

* updated v1beta3 guide doc and added tests

* fixed not removing tmp files from v1beta3 processing

* created v1beta2 to v1beta3 converter

* Updated yaml spec (#1863)

* v1beta3 spec can be read by preflight

* added test files for ease of testing

* v1beta3 renderer fixes

* fixed gitignore issue

* Auto support bundle upload (#1860)

* basic auto uploading support bundles

* added upload command

* added default vendor endpoint

* added auth system from replicated cli

* fixed case sensitivity issue in YAML parsing

* support bundle uploads for end customers

* app slug flag and detection without licenseID

* moved v1beta3 examples to proper directory

* does not auto update for package managers (#1850)

* V1beta3 cleanup (#1869)

* moving some files around

* more cleanup

* removing more unused

* update ci for v1beta3 (#1870)

* fmt:

* removing unused examples

* add a v1beta3 fixture

* removing coverage reporting

* adding brew (#1872)

* Fixing testing errors (#1871)

fix: resolve failing unit tests and diff consistency in v1beta3

- Fix readLinesFromReader to return lines WITH newlines (like difflib.SplitLines)
- Update test expectations to match correct function behavior with newlines
- This ensures consistency between streaming and non-streaming diff paths
- Fix timeout test by changing from 10ms to 500ms to eliminate flaky failures

Fixes TestReadLinesFromReader and Test_loadSupportBundleSpecsFromURIs_TimeoutError
Resolves diff output inconsistency between code paths

* Fix/exec textanalyze path clean (#1865)

* created roadmap and yaml claude agent

* Update roadmap.md

* Fix textAnalyze analyzer to auto-match exec collector nested paths

- Auto-detect exec output files (*-stdout.txt, *-stderr.txt, *-errors.json)
- Convert simple filenames to wildcard patterns automatically
- Preserve existing wildcard patterns
- Fixes 'No matching file' errors for exec + textAnalyze workflows

---------

Co-authored-by: Noah Campbell <noah.edward.campbell@gmail.com>

* bump goreleaser to v2

* remove collect binary and risc binary

* remove this check

* add debug logging

* larger runner for release

* dropping goreleaser

* fix syntax

* fix syntax

* goreleaser

* larger

* prerelease auto and more

* publish to directory:

* some more goreleaser/homebrew stuffs

* removing risc

* bump example

* Advanced analysis clean (#1868)

* created roadmap and yaml claude agent

* Update roadmap.md

* feat: Clean advanced analysis implementation - core agents, engine, artifacts

* Remove unrelated files - keep only advanced analysis implementation

* fix: Fix goroutine leak in hosted agent rate limiter

- Added stop channel and stopped flag to RateLimiter struct
- Modified replenishTokens to listen for stop signal and exit cleanly
- Added Stop() method to gracefully shutdown rate limiter
- Added Stop() method to HostedAgent to cleanup rate limiter on shutdown

Fixes cursor bot issue: Rate Limiter Goroutine Leak

* fix: Fix analyzer config and model validation bugs

Bug 1: Analyzer Config Missing File Path
- Added filePath to DeploymentStatus analyzer config in convertAnalyzerToSpec
- Sets namespace-specific path (cluster-resources/deployments/{namespace}.json)
- Falls back to generic path (cluster-resources/deployments.json) if no namespace
- Fixes LocalAgent.analyzeDeploymentStatus backward compatibility

Bug 2: HealthCheck Fails Model Validation
- Changed Ollama model validation from prefix match to exact match
- Prevents false positives where llama2:13b would match request for llama2:7b
- Ensures agent only reports healthy when exact model is available

Both fixes address cursor bot reported issues and maintain backward compatibility.

* fixing lint errors

* fixing lint errors

* adding CLI flags

* fix: resolve linting errors for CI

- Remove unnecessary nil check in host_kernel_configs.go (len() for nil slices is zero)
- Remove unnecessary fmt.Sprintf() calls in ceph.go for static strings
- Apply go fmt formatting fixes

Fixes failing lint CI check

* fix: resolve CI failures in build-test workflow and Ollama tests

1. Fix GitHub Actions workflow logic error:
   - Replace problematic contains() expression with explicit job result checks
   - Properly handle failure and cancelled states for each job
   - Prevents false positive failures in success summary job

2. Fix Ollama agent parseLLMResponse panics:
   - Add proper error handling for malformed JSON in LLM responses
   - Return error when JSON is found but invalid (instead of silent fallback)
   - Add error when no meaningful content can be parsed from response
   - Prevents nil pointer dereference in test assertions

Fixes failing build-test/success and build-test/test CI checks

* fix: resolve all CI failures and cursor bot issues

1. Fix disable-ollama flag logic bug:
   - Remove disable-ollama from advanced analysis trigger condition
   - Prevents unintended advanced analysis mode when no agents registered
   - Allows proper fallback to legacy analysis

2. Fix diff test consistency:
   - Update test expectations to match function behavior (lines with newlines)
   - Ensures consistency between streaming and non-streaming diff paths

3. Fix Ollama agent error handling:
   - Add proper error return for malformed JSON in LLM responses
   - Add meaningful content validation for markdown parsing
   - Prevents nil pointer panics in test assertions

4. Fix analysis engine mock agent:
   - Mock agent now processes and returns results for all provided analyzers
   - Fixes test expectation mismatch (expected 8 results, got 1)

Resolves all failing CI checks: lint, test, and success workflow logic

---------

Co-authored-by: Noah Campbell <noah.edward.campbell@gmail.com>

* Auto-Collect (#1867)

* Fix auto-collector missing files issue

- Add KOTS-aware detection for diagnostic files
- Replace silent RBAC filtering with user warnings
- Enhance error file collection for troubleshooting
- Achieve parity with traditional support bundles

Resolves issue where auto-collector was missing:
- KOTS diagnostic files (now 4 vs 3)
- ConfigMaps (now 6 vs 6)
- Maintains superior log collection (24 vs 0)

Final result: [SUCCESS] comprehensive collection achieved

* fixing bugbog

* fix: resolve production readiness issues in auto-collect branch

1. Fix diff test expectations (lines should have newlines for difflib consistency)
2. Fix preflight tests to use existing v1beta3 example file
3. Fix autodiscovery test context parameter (function signature update)

Resolves TestReadLinesFromReader and preflight v1beta3 test failures

* fix: resolve autodiscovery tests and cursor bot image matching issues

1. Fix cursor bot image matching bug in isKotsadmImage:
   - Replace flawed prefix matching with proper image component detection
   - Handle private registries correctly (registry.company.com/kotsadm/kotsadm:v1.0.0)
   - Prevent false positives with proper delimiter checking
   - Add helper functions: containsImageComponent, splitImagePath, removeTagAndDigest

2. Fix autodiscovery test failures:
   - Add TestMode flag to DiscoveryOptions to control KOTS diagnostic collection
   - Tests use TestMode=true to get only foundational collectors (no KOTS diagnostics)
   - Preserves production behavior while enabling clean testing

Resolves failing TestDiscoverer_DiscoverFoundational tests and cursor bot issues

* Cron job clean (#1862)

* created roadmap and yaml claude agent

* Update roadmap.md

* chore(deps): bump sigstore/cosign-installer from 3.9.2 to 3.10.0 (#1857)

Bumps [sigstore/cosign-installer](https://github.com/sigstore/cosign-installer) from 3.9.2 to 3.10.0.
- [Release notes](https://github.com/sigstore/cosign-installer/releases)
- [Commits](https://github.com/sigstore/cosign-installer/compare/v3.9.2...v3.10.0)

---
updated-dependencies:
- dependency-name: sigstore/cosign-installer
  dependency-version: 3.10.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps): bump the security group with 2 updates (#1858)

Bumps the security group with 2 updates: [github.com/vmware-tanzu/velero](https://github.com/vmware-tanzu/velero) and [helm.sh/helm/v3](https://github.com/helm/helm).


Updates `github.com/vmware-tanzu/velero` from 1.16.2 to 1.17.0
- [Release notes](https://github.com/vmware-tanzu/velero/releases)
- [Changelog](https://github.com/vmware-tanzu/velero/blob/main/CHANGELOG.md)
- [Commits](https://github.com/vmware-tanzu/velero/compare/v1.16.2...v1.17.0)

Updates `helm.sh/helm/v3` from 3.18.6 to 3.19.0
- [Release notes](https://github.com/helm/helm/releases)
- [Commits](https://github.com/helm/helm/compare/v3.18.6...v3.19.0)

---
updated-dependencies:
- dependency-name: github.com/vmware-tanzu/velero
  dependency-version: 1.17.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: security
- dependency-name: helm.sh/helm/v3
  dependency-version: 3.19.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: security
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps): bump helm.sh/helm/v3 from 3.18.6 to 3.19.0 in /examples/sdk/helm-template in the security group (#1859)

chore(deps): bump helm.sh/helm/v3

Bumps the security group in /examples/sdk/helm-template with 1 update: [helm.sh/helm/v3](https://github.com/helm/helm).


Updates `helm.sh/helm/v3` from 3.18.6 to 3.19.0
- [Release notes](https://github.com/helm/helm/releases)
- [Commits](https://github.com/helm/helm/compare/v3.18.6...v3.19.0)

---
updated-dependencies:
- dependency-name: helm.sh/helm/v3
  dependency-version: 3.19.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: security
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Add cron job support bundle scheduler

Complete implementation with K8s integration:
- pkg/schedule/job.go: Job management and persistence
- pkg/schedule/daemon.go: Real-time scheduler daemon
- pkg/schedule/cli.go: CLI commands (create, list, delete, daemon)
- pkg/schedule/schedule_test.go: Comprehensive unit tests
- cmd/troubleshoot/cli/root.go: CLI integration

* fixing bugbot

* Fix all bugbot errors: auto-update stability, job cooldown timing, and daemon execution

* Deleting Agent

* removed unused flags

* fixing auto-upload

* fixing markdown files

* namespace not required flag for auto collectors to work

* loosened cron job validation

* writes logs to logfile

* fix: resolve autoFromEnv variable scoping issue for CI

- Ensure autoFromEnv variable and its usage are in correct scope
- Fix build errors: declared and not used / undefined variable
- All functionality preserved and tested locally
- Force add to override gitignore

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Noah Campbell <noah.edward.campbell@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* feat: clean tokenization system implementation (#1874)

Core tokenization functionality with minimal file changes:

 Core Features:
- Intelligent tokenization engine (tokenizer.go)
- Context-aware secret classification (PASSWORD, APIKEY, DATABASE, etc.)
- Cross-file correlation with deterministic HMAC-SHA256 tokens
- Optional encrypted mapping for token→original value resolution

 Integration:
- CLI flags: --tokenize, --redaction-map, --encrypt-redaction-map
- Updated all redactor types: literal, single-line, multi-line, YAML
- Support bundle integration with auto-upload compatibility
- Backward compatibility: preserves ***HIDDEN*** when disabled

 Production Ready:
- Only 11 essential files (vs 31 in original PR)
- No excessive test files or documentation
- Clean build, all functionality verified
- Maintains existing redaction behavior by default

Token format: ***TOKEN_<TYPE>_<HASH>*** (e.g., ***TOKEN_PASSWORD_A1B2C3***)

* Removes silent failing (#1877)

* preserves stdout and stderr from collectors

* Delete eliminate-silent-failures.md

* Update host_kernel_modules_test.go

* added error logs when a collector fails to start

* Update host_filesystem_performance_linux.go

* fixed error saving logic inconsistency

* Update collect.go

* Improved error handling for support bundles and redactors for windows (#1878)

* improved error handling and window locking

* Delete all-windows-collectors.yaml

* addressing bugbot concerns

* Update host_tcpportstatus.go

* Update redact.go

* Add regression test suite to github actions

* Update regression-test.yaml

* Update regression-test.yaml

* Update regression-test.yaml

* create test/output directory

* handle node-specific files and multiple report arguments

* simplify comparison to detect code regressions only

* handle empty structural_compare rules

* removed v1beta3 branch from github workflow

* Update Makefile

* removed outdated actions

* Update Makefile

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Noah Campbell <noah.edward.campbell@gmail.com>
Co-authored-by: Benjamin Yang <82779168+bennyyang11@users.noreply.github.com>
Co-authored-by: Benjamin Yang <benjaminyang@Benjamins-MacBook-Pro.local>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-10-08 10:22:11 -07:00

980 lines
28 KiB
Go

package generators
import (
"context"
"fmt"
"regexp"
"strings"
"github.com/pkg/errors"
analyzer "github.com/replicatedhq/troubleshoot/pkg/analyze"
"github.com/replicatedhq/troubleshoot/pkg/constants"
"go.opentelemetry.io/otel"
"go.opentelemetry.io/otel/attribute"
"k8s.io/klog/v2"
)
// AnalyzerGenerator generates analyzer specifications from requirements
type AnalyzerGenerator struct {
templates map[string]AnalyzerTemplate
validators map[string]RequirementValidator
}
// AnalyzerTemplate defines how to generate analyzers for specific requirement types
type AnalyzerTemplate struct {
Name string
Description string
Category string
Priority int
Generator func(ctx context.Context, req interface{}) ([]analyzer.AnalyzerSpec, error)
Validator func(req interface{}) error
}
// RequirementValidator validates requirement specifications
type RequirementValidator func(requirement interface{}) error
// GenerationOptions configures analyzer generation
type GenerationOptions struct {
IncludeOptional bool
Strict bool
DefaultPriority int
CategoryFilter []string
CustomTemplates map[string]AnalyzerTemplate
}
// NewAnalyzerGenerator creates a new analyzer generator with default templates
func NewAnalyzerGenerator() *AnalyzerGenerator {
g := &AnalyzerGenerator{
templates: make(map[string]AnalyzerTemplate),
validators: make(map[string]RequirementValidator),
}
// Register default templates
g.registerDefaultTemplates()
g.registerDefaultValidators()
return g
}
// GenerateAnalyzers creates analyzer specifications from requirements
func (g *AnalyzerGenerator) GenerateAnalyzers(ctx context.Context, requirements *analyzer.RequirementSpec, opts *GenerationOptions) ([]analyzer.AnalyzerSpec, error) {
ctx, span := otel.Tracer(constants.LIB_TRACER_NAME).Start(ctx, "AnalyzerGenerator.GenerateAnalyzers")
defer span.End()
if requirements == nil {
return nil, errors.New("requirements cannot be nil")
}
if opts == nil {
opts = &GenerationOptions{
IncludeOptional: true,
DefaultPriority: 5,
}
}
var allSpecs []analyzer.AnalyzerSpec
// Generate Kubernetes version analyzers
if specs, err := g.generateKubernetesAnalyzers(ctx, &requirements.Spec.Kubernetes, opts); err == nil {
allSpecs = append(allSpecs, specs...)
} else {
klog.Warningf("Failed to generate Kubernetes analyzers: %v", err)
}
// Generate resource requirement analyzers
if specs, err := g.generateResourceAnalyzers(ctx, &requirements.Spec.Resources, opts); err == nil {
allSpecs = append(allSpecs, specs...)
} else {
klog.Warningf("Failed to generate resource analyzers: %v", err)
}
// Generate storage requirement analyzers
if specs, err := g.generateStorageAnalyzers(ctx, &requirements.Spec.Storage, opts); err == nil {
allSpecs = append(allSpecs, specs...)
} else {
klog.Warningf("Failed to generate storage analyzers: %v", err)
}
// Generate network requirement analyzers
if specs, err := g.generateNetworkAnalyzers(ctx, &requirements.Spec.Network, opts); err == nil {
allSpecs = append(allSpecs, specs...)
} else {
klog.Warningf("Failed to generate network analyzers: %v", err)
}
// Generate custom analyzers
for _, customReq := range requirements.Spec.Custom {
if specs, err := g.generateCustomAnalyzers(ctx, &customReq, opts); err == nil {
allSpecs = append(allSpecs, specs...)
} else {
klog.Warningf("Failed to generate custom analyzer %s: %v", customReq.Name, err)
}
}
// Apply category filtering if specified
if len(opts.CategoryFilter) > 0 {
allSpecs = g.filterByCategory(allSpecs, opts.CategoryFilter)
}
// Sort by priority (higher priority first)
g.sortByPriority(allSpecs)
span.SetAttributes(
attribute.Int("total_generated", len(allSpecs)),
attribute.String("requirements_name", requirements.Metadata.Name),
attribute.Bool("include_optional", opts.IncludeOptional),
)
return allSpecs, nil
}
// generateKubernetesAnalyzers creates analyzers for Kubernetes requirements
func (g *AnalyzerGenerator) generateKubernetesAnalyzers(ctx context.Context, req *analyzer.KubernetesRequirements, opts *GenerationOptions) ([]analyzer.AnalyzerSpec, error) {
var specs []analyzer.AnalyzerSpec
// Kubernetes version check analyzer
if req.MinVersion != "" || req.MaxVersion != "" {
spec := analyzer.AnalyzerSpec{
Name: "kubernetes-version-requirement",
Type: "cluster",
Category: "kubernetes",
Priority: 10,
Config: map[string]interface{}{
"checkName": "Kubernetes Version Check",
"minVersion": req.MinVersion,
"maxVersion": req.MaxVersion,
"outcomes": g.generateVersionOutcomes(req.MinVersion, req.MaxVersion),
},
}
specs = append(specs, spec)
}
// Required components analyzer
if len(req.Required) > 0 {
spec := analyzer.AnalyzerSpec{
Name: "kubernetes-components-required",
Type: "cluster",
Category: "kubernetes",
Priority: 9,
Config: map[string]interface{}{
"checkName": "Required Components Check",
"required": req.Required,
"outcomes": g.generateComponentOutcomes(req.Required, true),
},
}
specs = append(specs, spec)
}
// Forbidden components analyzer
if len(req.Forbidden) > 0 {
spec := analyzer.AnalyzerSpec{
Name: "kubernetes-components-forbidden",
Type: "cluster",
Category: "kubernetes",
Priority: 8,
Config: map[string]interface{}{
"checkName": "Forbidden Components Check",
"forbidden": req.Forbidden,
"outcomes": g.generateComponentOutcomes(req.Forbidden, false),
},
}
specs = append(specs, spec)
}
return specs, nil
}
// generateResourceAnalyzers creates analyzers for resource requirements
func (g *AnalyzerGenerator) generateResourceAnalyzers(ctx context.Context, req *analyzer.ResourceRequirements, opts *GenerationOptions) ([]analyzer.AnalyzerSpec, error) {
var specs []analyzer.AnalyzerSpec
// Node resources analyzer
if req.CPU.Min != "" || req.Memory.Min != "" || req.Disk.Min != "" {
spec := analyzer.AnalyzerSpec{
Name: "node-resources-requirement",
Type: "resources",
Category: "capacity",
Priority: 9,
Config: map[string]interface{}{
"checkName": "Node Resources Check",
"cpu": req.CPU,
"memory": req.Memory,
"disk": req.Disk,
"outcomes": g.generateResourceOutcomes(req),
},
}
specs = append(specs, spec)
}
// Cluster capacity analyzer
if req.CPU.Min != "" || req.Memory.Min != "" {
spec := analyzer.AnalyzerSpec{
Name: "cluster-capacity-requirement",
Type: "resources",
Category: "capacity",
Priority: 8,
Config: map[string]interface{}{
"checkName": "Cluster Capacity Check",
"requirements": req,
"outcomes": g.generateClusterCapacityOutcomes(req),
},
}
specs = append(specs, spec)
}
return specs, nil
}
// generateStorageAnalyzers creates analyzers for storage requirements
func (g *AnalyzerGenerator) generateStorageAnalyzers(ctx context.Context, req *analyzer.StorageRequirements, opts *GenerationOptions) ([]analyzer.AnalyzerSpec, error) {
var specs []analyzer.AnalyzerSpec
// Storage class analyzer
if len(req.Classes) > 0 {
spec := analyzer.AnalyzerSpec{
Name: "storage-class-requirement",
Type: "storage",
Category: "storage",
Priority: 8,
Config: map[string]interface{}{
"checkName": "Storage Class Check",
"storageClass": req.Classes[0], // Use first class as primary
"outcomes": g.generateStorageClassOutcomes(req.Classes),
},
}
specs = append(specs, spec)
}
// Persistent volume analyzer
if req.MinCapacity != "" {
spec := analyzer.AnalyzerSpec{
Name: "persistent-volume-requirement",
Type: "storage",
Category: "storage",
Priority: 7,
Config: map[string]interface{}{
"checkName": "Persistent Volume Capacity Check",
"minCapacity": req.MinCapacity,
"accessModes": req.AccessModes,
"outcomes": g.generatePVOutcomes(req),
},
}
specs = append(specs, spec)
}
return specs, nil
}
// generateNetworkAnalyzers creates analyzers for network requirements
func (g *AnalyzerGenerator) generateNetworkAnalyzers(ctx context.Context, req *analyzer.NetworkRequirements, opts *GenerationOptions) ([]analyzer.AnalyzerSpec, error) {
var specs []analyzer.AnalyzerSpec
// Port connectivity analyzer
for _, port := range req.Ports {
spec := analyzer.AnalyzerSpec{
Name: fmt.Sprintf("port-connectivity-%d", port.Port),
Type: "network",
Category: "networking",
Priority: 7,
Config: map[string]interface{}{
"checkName": fmt.Sprintf("Port %d Connectivity Check", port.Port),
"port": port.Port,
"protocol": port.Protocol,
"required": port.Required,
"outcomes": g.generatePortOutcomes(port),
},
}
specs = append(specs, spec)
}
// General connectivity analyzer
if len(req.Connectivity) > 0 {
spec := analyzer.AnalyzerSpec{
Name: "network-connectivity-requirement",
Type: "network",
Category: "networking",
Priority: 6,
Config: map[string]interface{}{
"checkName": "Network Connectivity Check",
"connectivity": req.Connectivity,
"outcomes": g.generateConnectivityOutcomes(req.Connectivity),
},
}
specs = append(specs, spec)
}
return specs, nil
}
// generateCustomAnalyzers creates analyzers for custom requirements
func (g *AnalyzerGenerator) generateCustomAnalyzers(ctx context.Context, req *analyzer.CustomRequirement, opts *GenerationOptions) ([]analyzer.AnalyzerSpec, error) {
var specs []analyzer.AnalyzerSpec
// Check if we have a template for this custom type
template, exists := g.templates[req.Type]
if exists {
customSpecs, err := template.Generator(ctx, req)
if err != nil {
return nil, errors.Wrapf(err, "failed to generate custom analyzer %s", req.Name)
}
specs = append(specs, customSpecs...)
} else {
// Generic custom analyzer
spec := analyzer.AnalyzerSpec{
Name: req.Name,
Type: req.Type,
Category: "custom",
Priority: opts.DefaultPriority,
Config: map[string]interface{}{
"checkName": req.Name,
"condition": req.Condition,
"context": req.Context,
"outcomes": g.generateCustomOutcomes(req),
},
}
specs = append(specs, spec)
}
return specs, nil
}
// Outcome generation methods
func (g *AnalyzerGenerator) generateVersionOutcomes(minVersion, maxVersion string) []map[string]interface{} {
var outcomes []map[string]interface{}
// Pass condition
passCondition := "true"
if minVersion != "" && maxVersion != "" {
passCondition = fmt.Sprintf(">= %s && < %s", minVersion, maxVersion)
} else if minVersion != "" {
passCondition = fmt.Sprintf(">= %s", minVersion)
} else if maxVersion != "" {
passCondition = fmt.Sprintf("< %s", maxVersion)
}
outcomes = append(outcomes, map[string]interface{}{
"pass": map[string]interface{}{
"when": passCondition,
"message": "Kubernetes version meets requirements",
},
})
// Fail condition
if minVersion != "" {
outcomes = append(outcomes, map[string]interface{}{
"fail": map[string]interface{}{
"when": fmt.Sprintf("< %s", minVersion),
"message": fmt.Sprintf("Kubernetes version is below minimum required version %s", minVersion),
},
})
}
if maxVersion != "" {
outcomes = append(outcomes, map[string]interface{}{
"fail": map[string]interface{}{
"when": fmt.Sprintf(">= %s", maxVersion),
"message": fmt.Sprintf("Kubernetes version is at or above maximum supported version %s", maxVersion),
},
})
}
return outcomes
}
func (g *AnalyzerGenerator) generateComponentOutcomes(components []string, required bool) []map[string]interface{} {
var outcomes []map[string]interface{}
for _, component := range components {
if required {
outcomes = append(outcomes, map[string]interface{}{
"fail": map[string]interface{}{
"when": fmt.Sprintf("missing %s", component),
"message": fmt.Sprintf("Required component %s is missing", component),
},
})
} else {
outcomes = append(outcomes, map[string]interface{}{
"fail": map[string]interface{}{
"when": fmt.Sprintf("present %s", component),
"message": fmt.Sprintf("Forbidden component %s is present", component),
},
})
}
}
// Default pass outcome
if required {
outcomes = append(outcomes, map[string]interface{}{
"pass": map[string]interface{}{
"message": "All required components are present",
},
})
} else {
outcomes = append(outcomes, map[string]interface{}{
"pass": map[string]interface{}{
"message": "No forbidden components are present",
},
})
}
return outcomes
}
func (g *AnalyzerGenerator) generateResourceOutcomes(req *analyzer.ResourceRequirements) []map[string]interface{} {
var outcomes []map[string]interface{}
// CPU requirements
if req.CPU.Min != "" {
outcomes = append(outcomes, map[string]interface{}{
"fail": map[string]interface{}{
"when": fmt.Sprintf("cpu < %s", req.CPU.Min),
"message": fmt.Sprintf("Insufficient CPU resources. Minimum required: %s", req.CPU.Min),
},
})
}
// Memory requirements
if req.Memory.Min != "" {
outcomes = append(outcomes, map[string]interface{}{
"fail": map[string]interface{}{
"when": fmt.Sprintf("memory < %s", req.Memory.Min),
"message": fmt.Sprintf("Insufficient memory resources. Minimum required: %s", req.Memory.Min),
},
})
}
// Disk requirements
if req.Disk.Min != "" {
outcomes = append(outcomes, map[string]interface{}{
"warn": map[string]interface{}{
"when": fmt.Sprintf("disk < %s", req.Disk.Min),
"message": fmt.Sprintf("Low disk space. Minimum recommended: %s", req.Disk.Min),
},
})
}
// Pass condition
outcomes = append(outcomes, map[string]interface{}{
"pass": map[string]interface{}{
"message": "Resource requirements are satisfied",
},
})
return outcomes
}
func (g *AnalyzerGenerator) generateClusterCapacityOutcomes(req *analyzer.ResourceRequirements) []map[string]interface{} {
var outcomes []map[string]interface{}
outcomes = append(outcomes, map[string]interface{}{
"fail": map[string]interface{}{
"when": "clusterCapacity < requirements",
"message": "Cluster does not have sufficient capacity to meet requirements",
},
})
outcomes = append(outcomes, map[string]interface{}{
"warn": map[string]interface{}{
"when": "clusterCapacity < requirements * 1.2",
"message": "Cluster capacity is close to requirements. Consider adding buffer capacity",
},
})
outcomes = append(outcomes, map[string]interface{}{
"pass": map[string]interface{}{
"message": "Cluster has sufficient capacity for requirements",
},
})
return outcomes
}
func (g *AnalyzerGenerator) generateStorageClassOutcomes(classes []string) []map[string]interface{} {
var outcomes []map[string]interface{}
for _, class := range classes {
outcomes = append(outcomes, map[string]interface{}{
"fail": map[string]interface{}{
"when": fmt.Sprintf("storageClass == %s && !exists", class),
"message": fmt.Sprintf("Required storage class %s does not exist", class),
},
})
}
outcomes = append(outcomes, map[string]interface{}{
"pass": map[string]interface{}{
"message": "Required storage classes are available",
},
})
return outcomes
}
func (g *AnalyzerGenerator) generatePVOutcomes(req *analyzer.StorageRequirements) []map[string]interface{} {
var outcomes []map[string]interface{}
outcomes = append(outcomes, map[string]interface{}{
"fail": map[string]interface{}{
"when": fmt.Sprintf("availableCapacity < %s", req.MinCapacity),
"message": fmt.Sprintf("Insufficient storage capacity. Minimum required: %s", req.MinCapacity),
},
})
if len(req.AccessModes) > 0 {
for _, mode := range req.AccessModes {
outcomes = append(outcomes, map[string]interface{}{
"warn": map[string]interface{}{
"when": fmt.Sprintf("!accessMode.%s", mode),
"message": fmt.Sprintf("Access mode %s may not be supported", mode),
},
})
}
}
outcomes = append(outcomes, map[string]interface{}{
"pass": map[string]interface{}{
"message": "Storage requirements are satisfied",
},
})
return outcomes
}
func (g *AnalyzerGenerator) generatePortOutcomes(port analyzer.PortRequirement) []map[string]interface{} {
var outcomes []map[string]interface{}
if port.Required {
outcomes = append(outcomes, map[string]interface{}{
"fail": map[string]interface{}{
"when": fmt.Sprintf("port.%d.%s == false", port.Port, strings.ToLower(port.Protocol)),
"message": fmt.Sprintf("Required port %d/%s is not accessible", port.Port, port.Protocol),
},
})
}
outcomes = append(outcomes, map[string]interface{}{
"pass": map[string]interface{}{
"when": fmt.Sprintf("port.%d.%s == true", port.Port, strings.ToLower(port.Protocol)),
"message": fmt.Sprintf("Port %d/%s is accessible", port.Port, port.Protocol),
},
})
return outcomes
}
func (g *AnalyzerGenerator) generateConnectivityOutcomes(connectivity []string) []map[string]interface{} {
var outcomes []map[string]interface{}
for _, target := range connectivity {
outcomes = append(outcomes, map[string]interface{}{
"fail": map[string]interface{}{
"when": fmt.Sprintf("connectivity.%s == false", target),
"message": fmt.Sprintf("Cannot reach %s", target),
},
})
}
outcomes = append(outcomes, map[string]interface{}{
"pass": map[string]interface{}{
"message": "All connectivity requirements are satisfied",
},
})
return outcomes
}
func (g *AnalyzerGenerator) generateCustomOutcomes(req *analyzer.CustomRequirement) []map[string]interface{} {
var outcomes []map[string]interface{}
// Parse the condition and generate appropriate outcomes
condition := req.Condition
if condition == "" {
condition = "true"
}
// Basic pattern matching for common conditions
if strings.Contains(condition, ">=") || strings.Contains(condition, ">") {
outcomes = append(outcomes, map[string]interface{}{
"fail": map[string]interface{}{
"when": fmt.Sprintf("!(%s)", condition),
"message": fmt.Sprintf("Custom requirement '%s' not met", req.Name),
},
})
}
outcomes = append(outcomes, map[string]interface{}{
"pass": map[string]interface{}{
"when": condition,
"message": fmt.Sprintf("Custom requirement '%s' is satisfied", req.Name),
},
})
return outcomes
}
// Helper methods
func (g *AnalyzerGenerator) filterByCategory(specs []analyzer.AnalyzerSpec, categories []string) []analyzer.AnalyzerSpec {
if len(categories) == 0 {
return specs
}
var filtered []analyzer.AnalyzerSpec
categorySet := make(map[string]bool)
for _, cat := range categories {
categorySet[cat] = true
}
for _, spec := range specs {
if categorySet[spec.Category] {
filtered = append(filtered, spec)
}
}
return filtered
}
func (g *AnalyzerGenerator) sortByPriority(specs []analyzer.AnalyzerSpec) {
// Simple bubble sort by priority (higher first)
n := len(specs)
for i := 0; i < n-1; i++ {
for j := 0; j < n-1-i; j++ {
if specs[j].Priority < specs[j+1].Priority {
specs[j], specs[j+1] = specs[j+1], specs[j]
}
}
}
}
// Template and validator registration
func (g *AnalyzerGenerator) registerDefaultTemplates() {
// Register built-in analyzer templates
g.templates["database"] = AnalyzerTemplate{
Name: "Database Analyzer",
Description: "Analyzes database connectivity and requirements",
Category: "database",
Priority: 7,
Generator: g.generateDatabaseAnalyzer,
Validator: g.validateDatabaseRequirement,
}
g.templates["api"] = AnalyzerTemplate{
Name: "API Analyzer",
Description: "Analyzes API endpoint connectivity and requirements",
Category: "api",
Priority: 6,
Generator: g.generateAPIAnalyzer,
Validator: g.validateAPIRequirement,
}
}
func (g *AnalyzerGenerator) registerDefaultValidators() {
g.validators["version"] = func(req interface{}) error {
// Validate version format
versionStr, ok := req.(string)
if !ok {
return errors.New("version must be a string")
}
// Basic semantic version validation
versionRegex := regexp.MustCompile(`^v?\d+\.\d+(\.\d+)?(-.*)?$`)
if !versionRegex.MatchString(versionStr) {
return errors.Errorf("invalid version format: %s", versionStr)
}
return nil
}
g.validators["resource"] = func(req interface{}) error {
// Validate resource specifications
resourceStr, ok := req.(string)
if !ok {
return errors.New("resource must be a string")
}
// Validate resource format (e.g., "100m", "1Gi", "500Mi")
resourceRegex := regexp.MustCompile(`^(\d+(\.\d+)?)(m|Mi|Gi|Ti|Ki|k|M|G|T)?$`)
if !resourceRegex.MatchString(resourceStr) {
return errors.Errorf("invalid resource format: %s", resourceStr)
}
return nil
}
}
// Custom analyzer generators
func (g *AnalyzerGenerator) generateDatabaseAnalyzer(ctx context.Context, req interface{}) ([]analyzer.AnalyzerSpec, error) {
customReq, ok := req.(*analyzer.CustomRequirement)
if !ok {
return nil, errors.New("invalid database requirement type")
}
spec := analyzer.AnalyzerSpec{
Name: fmt.Sprintf("database-%s", customReq.Name),
Type: "database",
Category: "database",
Priority: 7,
Config: map[string]interface{}{
"checkName": fmt.Sprintf("Database %s Check", customReq.Name),
"uri": customReq.Context["uri"],
"timeout": "10s",
"outcomes": []map[string]interface{}{
{
"fail": map[string]interface{}{
"when": "error",
"message": "Database connection failed",
},
},
{
"pass": map[string]interface{}{
"message": "Database connection successful",
},
},
},
},
}
return []analyzer.AnalyzerSpec{spec}, nil
}
func (g *AnalyzerGenerator) generateAPIAnalyzer(ctx context.Context, req interface{}) ([]analyzer.AnalyzerSpec, error) {
customReq, ok := req.(*analyzer.CustomRequirement)
if !ok {
return nil, errors.New("invalid API requirement type")
}
spec := analyzer.AnalyzerSpec{
Name: fmt.Sprintf("api-%s", customReq.Name),
Type: "http",
Category: "api",
Priority: 6,
Config: map[string]interface{}{
"checkName": fmt.Sprintf("API %s Check", customReq.Name),
"get": map[string]interface{}{
"url": customReq.Context["url"],
},
"outcomes": []map[string]interface{}{
{
"fail": map[string]interface{}{
"when": "status != 200",
"message": "API endpoint is not accessible",
},
},
{
"pass": map[string]interface{}{
"when": "status == 200",
"message": "API endpoint is accessible",
},
},
},
},
}
return []analyzer.AnalyzerSpec{spec}, nil
}
// Custom requirement validators
func (g *AnalyzerGenerator) validateDatabaseRequirement(req interface{}) error {
customReq, ok := req.(*analyzer.CustomRequirement)
if !ok {
return errors.New("invalid requirement type")
}
if customReq.Context == nil {
return errors.New("database requirement must have context")
}
if _, exists := customReq.Context["uri"]; !exists {
return errors.New("database requirement must specify 'uri' in context")
}
return nil
}
func (g *AnalyzerGenerator) validateAPIRequirement(req interface{}) error {
customReq, ok := req.(*analyzer.CustomRequirement)
if !ok {
return errors.New("invalid requirement type")
}
if customReq.Context == nil {
return errors.New("API requirement must have context")
}
if _, exists := customReq.Context["url"]; !exists {
return errors.New("API requirement must specify 'url' in context")
}
return nil
}
// RegisterTemplate registers a custom analyzer template
func (g *AnalyzerGenerator) RegisterTemplate(name string, template AnalyzerTemplate) error {
if name == "" {
return errors.New("template name cannot be empty")
}
if template.Generator == nil {
return errors.New("template generator cannot be nil")
}
g.templates[name] = template
return nil
}
// RegisterValidator registers a custom requirement validator
func (g *AnalyzerGenerator) RegisterValidator(name string, validator RequirementValidator) error {
if name == "" {
return errors.New("validator name cannot be empty")
}
if validator == nil {
return errors.New("validator cannot be nil")
}
g.validators[name] = validator
return nil
}
// ValidateRequirements validates a requirement specification
func (g *AnalyzerGenerator) ValidateRequirements(ctx context.Context, requirements *analyzer.RequirementSpec) error {
if requirements == nil {
return errors.New("requirements cannot be nil")
}
// Validate Kubernetes requirements
if err := g.validateKubernetesRequirements(&requirements.Spec.Kubernetes); err != nil {
return errors.Wrap(err, "invalid Kubernetes requirements")
}
// Validate resource requirements
if err := g.validateResourceRequirements(&requirements.Spec.Resources); err != nil {
return errors.Wrap(err, "invalid resource requirements")
}
// Validate storage requirements
if err := g.validateStorageRequirements(&requirements.Spec.Storage); err != nil {
return errors.Wrap(err, "invalid storage requirements")
}
// Validate network requirements
if err := g.validateNetworkRequirements(&requirements.Spec.Network); err != nil {
return errors.Wrap(err, "invalid network requirements")
}
// Validate custom requirements
for i, customReq := range requirements.Spec.Custom {
if err := g.validateCustomRequirement(&customReq); err != nil {
return errors.Wrapf(err, "invalid custom requirement at index %d", i)
}
}
return nil
}
func (g *AnalyzerGenerator) validateKubernetesRequirements(req *analyzer.KubernetesRequirements) error {
if req.MinVersion != "" {
if err := g.validators["version"](req.MinVersion); err != nil {
return errors.Wrap(err, "invalid minVersion")
}
}
if req.MaxVersion != "" {
if err := g.validators["version"](req.MaxVersion); err != nil {
return errors.Wrap(err, "invalid maxVersion")
}
}
return nil
}
func (g *AnalyzerGenerator) validateResourceRequirements(req *analyzer.ResourceRequirements) error {
if req.CPU.Min != "" {
if err := g.validators["resource"](req.CPU.Min); err != nil {
return errors.Wrap(err, "invalid CPU minimum")
}
}
if req.Memory.Min != "" {
if err := g.validators["resource"](req.Memory.Min); err != nil {
return errors.Wrap(err, "invalid memory minimum")
}
}
if req.Disk.Min != "" {
if err := g.validators["resource"](req.Disk.Min); err != nil {
return errors.Wrap(err, "invalid disk minimum")
}
}
return nil
}
func (g *AnalyzerGenerator) validateStorageRequirements(req *analyzer.StorageRequirements) error {
if req.MinCapacity != "" {
if err := g.validators["resource"](req.MinCapacity); err != nil {
return errors.Wrap(err, "invalid minCapacity")
}
}
// Validate access modes
validAccessModes := map[string]bool{
"ReadWriteOnce": true,
"ReadOnlyMany": true,
"ReadWriteMany": true,
}
for _, mode := range req.AccessModes {
if !validAccessModes[mode] {
return errors.Errorf("invalid access mode: %s", mode)
}
}
return nil
}
func (g *AnalyzerGenerator) validateNetworkRequirements(req *analyzer.NetworkRequirements) error {
for _, port := range req.Ports {
if port.Port <= 0 || port.Port > 65535 {
return errors.Errorf("invalid port number: %d", port.Port)
}
validProtocols := map[string]bool{
"TCP": true,
"UDP": true,
}
if port.Protocol != "" && !validProtocols[strings.ToUpper(port.Protocol)] {
return errors.Errorf("invalid protocol: %s", port.Protocol)
}
}
return nil
}
func (g *AnalyzerGenerator) validateCustomRequirement(req *analyzer.CustomRequirement) error {
if req.Name == "" {
return errors.New("custom requirement name cannot be empty")
}
if req.Type == "" {
return errors.New("custom requirement type cannot be empty")
}
// Check if we have a specific validator for this type
if validator, exists := g.validators[req.Type]; exists {
return validator(req)
}
// Check if we have a template with validator for this type
if template, exists := g.templates[req.Type]; exists && template.Validator != nil {
return template.Validator(req)
}
return nil
}