8000 v0.3.0: breaking schema + contract changes (bundle) · Issue #11 · dominikzorgnotti/esx-hcl-check · GitHub
[go: up one dir, main page]

Skip to content

v0.3.0: breaking schema + contract changes (bundle) #11

Closed

Description

@dominikzorgnotti

Coordinated breaking release. All items ship together with one migration note so downstream consumers migrate once. Delivered as a single branch (feat/v0.3.0-schema) with one commit per item; one PR into main.

Included (agreed "recommended" scope)

  • No SSL verification #2 — JSON tag consistency: HostComponents fields (Datacenter/Cluster/Hostname/Results/Issues) are PascalCase; every other struct is snake_case. Fix to snake_case. (breaking: top-level -json field names change)
  • Populate source field in -unique aggregated output #13-field — source identifier: add a source/vCenter field to RawHostData + HostComponents, populated from the connected client. Reserves the schema slot so future multi-vCenter work is non-breaking. (additive)
  • Dominikzorgnotti patch 1 #1 — host skip reasons: add a skip-reason field to RawHostData + HostComponents; surface hosts skipped due to disconnected/maintenance/permission/property-collector error instead of silently dropping them. Thread through extractHostHardware early-returns and both formatters. (additive)
  • Bounded retry/backoff on Broadcom HCL calls #9 — stdout/stderr split: route diagnostics/progress/warnings to stderr; keep only report data (text table / JSON) on stdout. (breaking: anyone parsing stdout progress lines)
  • Network resilience: add timeouts and actionable connection errors #6 — typed CertStatus: replace the string cert fields + "ERROR" sentinel with a typed enum + custom MarshalJSON/UnmarshalJSON that preserves the "TRUE"/"FALSE"/"N/A"/"ERROR" wire values. Fixes the trust bug where a Broadcom API failure was indistinguishable from "not certified". (internal; wire values preserved)
  • Bounded retry/backoff on Broadcom HCL calls #10 — exit codes: 0 = all certified, 1 = uncertified hardware found, 2 = run error / could-not-determine. Uses the typed status from Network resilience: add timeouts and actionable connection errors #6. (breaking: exit-code contract)
  • Tests: targeted unit tests for CertStatus marshaling and the exit-code mapping (guardrails for the regression-prone parts).

Migration note (for the release body)

  • Top-level JSON keys renamed to snake_case (datacenter, cluster, hostname, results, issues)
  • New fields: source, host skip reason
  • Progress/diagnostic output moves from stdout to stderr
  • Exit code now reflects findings

Explicitly out of scope (non-breaking; ship later independently)

#4 cross-host dedup, #7 full test suite, #11 concurrency, #12 config file, #14 severity scoring, #15 HTML/CSV export.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

      0