nathan/vctp2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add support for customizable pivot titles and ranges in summary reports
Some checks failed
continuous-integration/drone/push Build was killed
Details

Browse Source
This commit is contained in:
Nathan Coad
2026-02-18 11:59:22 +11:00
parent 92c6797f05
commit 29c277f863
8 changed files with 217 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files

187
internal/report/snapshots.go
View File

@@ -15,6 +15,7 @@ import (
"sync"
"time"
"vctp/db"
"vctp/internal/settings"
"github.com/jmoiron/sqlx"
"github.com/xuri/excelize/v2"
@@ -545,7 +546,7 @@ func FormatSnapshotLabel(snapshotType string, snapshotTime time.Time, tableName
}
}
func CreateTableReport(logger *slog.Logger, Database db.Database, ctx context.Context, tableName string) ([]byte, error) {
func CreateTableReport(logger *slog.Logger, Database db.Database, ctx context.Context, tableName string, cfg *settings.Settings) ([]byte, error) {
if err := db.ValidateTableName(tableName); err != nil {
return nil, err
}
@@ -753,7 +754,7 @@ func CreateTableReport(logger *slog.Logger, Database db.Database, ctx context.Co
for _, spec := range specs {
reportHeaders = append(reportHeaders, spec.Name)
}
addSummaryPivotSheet(logger, xlsx, sheetName, reportHeaders, rowCount, tableName)
addSummaryPivotSheet(logger, xlsx, sheetName, reportHeaders, rowCount, tableName, cfg)
meta := reportMetadata{
TableName: tableName,
@@ -787,7 +788,7 @@ func CreateTableReport(logger *slog.Logger, Database db.Database, ctx context.Co
}
// SaveTableReport renders a table report and writes it to the destination directory with a .xlsx extension.
func SaveTableReport(logger *slog.Logger, Database db.Database, ctx context.Context, tableName, destDir string) (string, error) {
func SaveTableReport(logger *slog.Logger, Database db.Database, ctx context.Context, tableName, destDir string, cfg *settings.Settings) (string, error) {
if err := db.ValidateTableName(tableName); err != nil {
return "", err
}
@@ -802,7 +803,7 @@ func SaveTableReport(logger *slog.Logger, Database db.Database, ctx context.Cont
}
logger.Debug("Report directory ready", "dest", destDir)
data, err := CreateTableReport(logger, Database, ctx, tableName)
data, err := CreateTableReport(logger, Database, ctx, tableName, cfg)
if err != nil {
logger.Warn("Report render failed", "table", tableName, "error", err)
return "", err
@@ -890,6 +891,7 @@ func addTotalsChartSheet(logger *slog.Logger, database db.Database, ctx context.
}
type summaryPivotSpec struct {
Metric string
Title string
TitleCell string
PivotName string
@@ -900,7 +902,139 @@ type summaryPivotSpec struct {
DataSummary string
}
func addSummaryPivotSheet(logger *slog.Logger, xlsx *excelize.File, dataSheet string, headers []string, rowCount int, tableName string) {
func defaultSummaryPivotSpecs(summarySheet string) []summaryPivotSpec {
return []summaryPivotSpec{
{
Metric: "avg_vcpu",
Title: "Sum of Avg vCPUs",
TitleCell: "A1",
PivotName: "PivotAvgVcpu",
PivotRange: fmt.Sprintf("%s!A3:H40", summarySheet),
RowFields: []string{"Datacenter", "ResourcePool"},
DataField: "AvgVcpuCount",
DataName: "Sum of Avg vCPUs",
DataSummary: "Sum",
},
{
Metric: "avg_ram",
Title: "Sum of Avg RAM",
TitleCell: "J1",
PivotName: "PivotAvgRam",
PivotRange: fmt.Sprintf("%s!J3:P40", summarySheet),
RowFields: []string{"Datacenter"},
DataField: "AvgRamGB",
DataName: "Sum of Avg RAM",
DataSummary: "Sum",
},
{
Metric: "prorated_vm_count",
Title: "Sum of prorated VM count",
TitleCell: "A61",
PivotName: "PivotProratedVmCount",
PivotRange: fmt.Sprintf("%s!A63:H82", summarySheet),
RowFields: []string{"Datacenter"},
DataField: "AvgIsPresent",
DataName: "Sum of prorated VM count",
DataSummary: "Sum",
},
{
Metric: "vm_name_count",
Title: "Count of VM Name",
TitleCell: "J61",
PivotName: "PivotVmNameCount",
PivotRange: fmt.Sprintf("%s!J63:P82", summarySheet),
RowFields: []string{"Datacenter"},
DataField: "Name",
DataName: "Count of VM Name",
DataSummary: "Count",
},
}
}
func normalizePivotRange(summarySheet, pivotRange string) string {
trimmed := strings.TrimSpace(pivotRange)
if trimmed == "" {
return ""
}
if strings.Contains(trimmed, "!") {
return trimmed
}
return fmt.Sprintf("%s!%s", summarySheet, trimmed)
}
func titleCellFromPivotRange(pivotRange, fallback string) string {
trimmed := strings.TrimSpace(pivotRange)
if trimmed == "" {
return fallback
}
if bang := strings.Index(trimmed, "!"); bang >= 0 {
trimmed = trimmed[bang+1:]
}
trimmed = strings.ReplaceAll(trimmed, "$", "")
startCell := trimmed
if parts := strings.Split(trimmed, ":"); len(parts) > 0 {
startCell = parts[0]
}
col, row, err := excelize.CellNameToCoordinates(startCell)
if err != nil {
return fallback
}
titleRow := row - 2
if titleRow < 1 {
titleRow = 1
}
cell, err := excelize.CoordinatesToCellName(col, titleRow)
if err != nil {
return fallback
}
return cell
}
func resolveSummaryPivotSpecs(cfg *settings.Settings, summarySheet string) []summaryPivotSpec {
specs := defaultSummaryPivotSpecs(summarySheet)
if cfg == nil || cfg.Values == nil || len(cfg.Values.Settings.ReportSummaryPivots) == 0 {
return specs
}
specByMetric := make(map[string]*summaryPivotSpec, len(specs))
metricOrder := make([]string, 0, len(specs))
for i := range specs {
metric := strings.TrimSpace(strings.ToLower(specs[i].Metric))
if metric == "" {
continue
}
specByMetric[metric] = &specs[i]
metricOrder = append(metricOrder, metric)
}
for i, custom := range cfg.Values.Settings.ReportSummaryPivots {
metric := strings.TrimSpace(strings.ToLower(custom.Metric))
if metric == "" && i < len(metricOrder) {
metric = metricOrder[i]
}
spec := specByMetric[metric]
if spec == nil {
continue
}
if title := strings.TrimSpace(custom.Title); title != "" {
spec.Title = title
}
if name := strings.TrimSpace(custom.PivotName); name != "" {
spec.PivotName = name
}
if rng := normalizePivotRange(summarySheet, custom.PivotRange); rng != "" {
spec.PivotRange = rng
}
if cell := strings.TrimSpace(custom.TitleCell); cell != "" {
spec.TitleCell = cell
} else {
spec.TitleCell = titleCellFromPivotRange(spec.PivotRange, spec.TitleCell)
}
}
return specs
}
func addSummaryPivotSheet(logger *slog.Logger, xlsx *excelize.File, dataSheet string, headers []string, rowCount int, tableName string, cfg *settings.Settings) {
if logger == nil {
logger = slog.Default()
}
@@ -940,48 +1074,7 @@ func addSummaryPivotSheet(logger *slog.Logger, xlsx *excelize.File, dataSheet st
return header, ok
}
specs := []summaryPivotSpec{
{
Title: "Sum of Avg vCPUs",
TitleCell: "A1",
PivotName: "PivotAvgVcpu",
PivotRange: fmt.Sprintf("%s!A3:H40", summarySheet),
RowFields: []string{"Datacenter", "ResourcePool"},
DataField: "AvgVcpuCount",
DataName: "Sum of Avg vCPUs",
DataSummary: "Sum",
},
{
Title: "Sum of Avg RAM",
TitleCell: "J1",
PivotName: "PivotAvgRam",
PivotRange: fmt.Sprintf("%s!J3:P40", summarySheet),
RowFields: []string{"Datacenter"},
DataField: "AvgRamGB",
DataName: "Sum of Avg RAM",
DataSummary: "Sum",
},
{
Title: "Sum of prorated VM count",
TitleCell: "A41",
PivotName: "PivotProratedVmCount",
PivotRange: fmt.Sprintf("%s!A43:H62", summarySheet),
RowFields: []string{"Datacenter"},
DataField: "AvgIsPresent",
DataName: "Sum of prorated VM count",
DataSummary: "Sum",
},
{
Title: "Count of VM Name",
TitleCell: "J41",
PivotName: "PivotVmNameCount",
PivotRange: fmt.Sprintf("%s!J43:P62", summarySheet),
RowFields: []string{"Datacenter"},
DataField: "Name",
DataName: "Count of VM Name",
DataSummary: "Count",
},
}
specs := resolveSummaryPivotSpecs(cfg, summarySheet)
for _, spec := range specs {
xlsx.SetCellValue(summarySheet, spec.TitleCell, spec.Title)

2
internal/report/snapshots_pivot_test.go
View File

@@ -27,7 +27,7 @@ func TestAddSummaryPivotSheetCreatesPivotTables(t *testing.T) {
}
logger := slog.New(slog.NewTextHandler(io.Discard, nil))
addSummaryPivotSheet(logger, xlsx, dataSheet, headers, 1, "inventory_daily_summary_20260215")
addSummaryPivotSheet(logger, xlsx, dataSheet, headers, 1, "inventory_daily_summary_20260215", nil)
pivots, err := xlsx.GetPivotTables("Summary")
if err != nil {