CBG-3978: Write AuditEvents table to CSV for review/use by PM/Docs (#…

…6920)

base/audit_events_test.go

@@ -9,10 +9,15 @@
 package base
 
 import (
+	"bytes"
+	"encoding/csv"
 	"fmt"
+	"strconv"
+	"strings"
 	"testing"
 
 	"github.com/stretchr/testify/require"
+	"golang.org/x/exp/maps"
 )
 
 func TestValidateAuditEvents(t *testing.T) {
@@ -29,3 +34,43 @@ func validateAuditEvents(e events) error {
 	}
 	return nil
 }
+
+// TestGenerateAuditDescriptorCSV outputs a CSV of AuditEvents.
+func TestGenerateAuditDescriptorCSV(t *testing.T) {
+	b, err := generateCSVModuleDescriptor(AuditEvents)
+	require.NoError(t, err)
+	fmt.Print(string(b))
+}
+
+// generateCSVModuleDescriptor returns a CSV module descriptor for the given events.
+func generateCSVModuleDescriptor(e events) ([]byte, error) {
+	buf := bytes.NewBuffer(nil)
+	w := csv.NewWriter(buf)
+
+	// Write header
+	if err := w.Write([]string{"ID", "Name", "Description", "DefaultEnabled", "Filterable", "EventType", "MandatoryFields", "OptionalFields"}); err != nil {
+		return nil, err
+	}
+
+	for id, event := range e {
+		if err := w.Write([]string{
+			id.String(),
+			event.Name,
+			event.Description,
+			strconv.FormatBool(event.EnabledByDefault),
+			strconv.FormatBool(event.FilteringPermitted),
+			string(event.EventType),
+			strings.Join(maps.Keys(event.MandatoryFields), ", "),
+			strings.Join(maps.Keys(event.OptionalFields), ", "),
+		}); err != nil {
+			return nil, err
+		}
+	}
+
+	w.Flush()
+	if err := w.Error(); err != nil {
+		return nil, err
+	}
+
+	return buf.Bytes(), nil
+}

base/auditd_descriptor_test.go

@@ -14,7 +14,7 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-// TestGenerateAuditdModuleDescriptor outputs a generated auditd module descriptor for SGAuditEvents.
+// TestGenerateAuditdModuleDescriptor outputs a generated auditd module descriptor for AuditEvents.
 func TestGenerateAuditdModuleDescriptor(t *testing.T) {
 	b, err := generateAuditdModuleDescriptor(AuditEvents)
 	require.NoError(t, err)