Add comments on existing tasks

Author: kyasbal

pkg/task/inspection/commonlogk8sauditv2/impl/common_task.go

@@ -19,6 +19,7 @@ import (
 	commonlogk8sauditv2_contract "github.com/GoogleCloudPlatform/khi/pkg/task/inspection/commonlogk8sauditv2/contract"
 )
 
+// LogSorterTask is the task to sort logs by time.
 var LogSorterTask = inspectiontaskbase.NewLogSorterByTimeTask(
 	commonlogk8sauditv2_contract.LogSorterTaskID,
 	commonlogk8sauditv2_contract.SuccessLogFilterTaskID.Ref(),

pkg/task/inspection/commonlogk8sauditv2/impl/error_historymodifier_task.go

@@ -26,6 +26,7 @@ import (
 	commonlogk8sauditv2_contract "github.com/GoogleCloudPlatform/khi/pkg/task/inspection/commonlogk8sauditv2/contract"
 )
 
+// NonSuccessLogHistoryModifierTask is the task to generate history from non-success logs.
 var NonSuccessLogHistoryModifierTask = inspectiontaskbase.NewHistoryModifierTask[struct{}](commonlogk8sauditv2_contract.NonSuccessLogHistoryModifierTaskID, &nonSuccessLogHistoryModifierTaskSetting{
 	subresourceMapToWriteToParent: map[string]struct{}{
 		"status":   {},
@@ -35,6 +36,7 @@ var NonSuccessLogHistoryModifierTask = inspectiontaskbase.NewHistoryModifierTask
 })
 
 type nonSuccessLogHistoryModifierTaskSetting struct {
+	// subresourceMapToWriteToParent is the map of subresources to write to the parent resource.
 	subresourceMapToWriteToParent map[string]struct{}
 }
 
@@ -60,6 +62,7 @@ func (e *nonSuccessLogHistoryModifierTaskSetting) ModifyChangeSetFromLog(ctx con
 
 var _ inspectiontaskbase.HistoryModifer[struct{}] = (*nonSuccessLogHistoryModifierTaskSetting)(nil)
 
+// addEventForLog adds an event for the log.
 func (e *nonSuccessLogHistoryModifierTaskSetting) addEventForLog(l *log.Log, cs *history.ChangeSet) error {
 	fieldSet := log.MustGetFieldSet(l, &commonlogk8sauditv2_contract.K8sAuditLogFieldSet{})
 	op := *fieldSet.K8sOperation

pkg/task/inspection/commonlogk8sauditv2/impl/logsummary_task.go

@@ -26,11 +26,13 @@ import (
 	commonlogk8sauditv2_contract "github.com/GoogleCloudPlatform/khi/pkg/task/inspection/commonlogk8sauditv2/contract"
 )
 
+// LogSerializerTask is the task to serialize k8s audit logs.
 var LogSerializerTask = inspectiontaskbase.NewLogSerializerTask(
 	commonlogk8sauditv2_contract.K8sAuditLogSerializerTaskID,
 	commonlogk8sauditv2_contract.K8sAuditLogProviderRef,
 )
 
+// LogSummaryGrouperTask is the task to group logs for summary generation.
 var LogSummaryGrouperTask = inspectiontaskbase.NewLogGrouperTask(
 	commonlogk8sauditv2_contract.LogSummaryGrouperTaskID,
 	commonlogk8sauditv2_contract.K8sAuditLogProviderRef,
@@ -40,6 +42,7 @@ var LogSummaryGrouperTask = inspectiontaskbase.NewLogGrouperTask(
 	},
 )
 
+// LogSummaryHistoryModifierTask is the task to generate log summary from given k8s audit log.
 var LogSummaryHistoryModifierTask = inspectiontaskbase.NewHistoryModifierTask[struct{}](
 	commonlogk8sauditv2_contract.LogSummaryHistoryModifierTaskID,
 	&logSummaryHistoryModifierSetting{},
@@ -70,12 +73,13 @@ func (s *logSummaryHistoryModifierSetting) ModifyChangeSetFromLog(ctx context.Co
 		cs.SetLogSeverity(enum.SeverityError)
 	}
 
-	cs.SetLogSummary(s.getLogSummary(commonFieldSet))
+	cs.SetLogSummary(s.logSummary(commonFieldSet))
 
 	return struct{}{}, nil
 }
 
-func (s *logSummaryHistoryModifierSetting) getLogSummary(fieldSet *commonlogk8sauditv2_contract.K8sAuditLogFieldSet) string {
+// logSummary generates the summary string from given log field set.
+func (s *logSummaryHistoryModifierSetting) logSummary(fieldSet *commonlogk8sauditv2_contract.K8sAuditLogFieldSet) string {
 	if fieldSet.IsError {
 		return fmt.Sprintf("【%s(%d)】%s %s", fieldSet.StatusMessage, fieldSet.StatusCode, fieldSet.VerbString(), fieldSet.RequestURI)
 	} else {

pkg/task/inspection/commonlogk8sauditv2/impl/logsummary_task_test.go

@@ -59,7 +59,7 @@ func TestLogSummaryHistoryModifierSetting_getLogSummary(t *testing.T) {
 	for _, tc := range testCases {
 		t.Run(tc.desc, func(t *testing.T) {
 			setting := &logSummaryHistoryModifierSetting{}
-			got := setting.getLogSummary(tc.input)
+			got := setting.logSummary(tc.input)
 			if got != tc.want {
 				t.Errorf("got %q, want %q", got, tc.want)
 			}

pkg/task/inspection/commonlogk8sauditv2/impl/manifest_generator_task.go

@@ -38,6 +38,7 @@ import (
 
 var bodyPlaceholderForMetadataLevelAuditLog = "# Resource data is unavailable. Audit logs for this resource is recorded at metadata level."
 
+// ManifestGeneratorTask is the task to generate manifest from k8s audit logs.
 var ManifestGeneratorTask = inspectiontaskbase.NewProgressReportableInspectionTask(commonlogk8sauditv2_contract.ManifestGeneratorTaskID, []taskid.UntypedTaskReference{
 	commonlogk8sauditv2_contract.ChangeTargetGrouperTaskID.Ref(),
 	googlecloudk8scommon_contract.K8sResourceMergeConfigTaskID.Ref(),
@@ -96,12 +97,17 @@ var ManifestGeneratorTask = inspectiontaskbase.NewProgressReportableInspectionTa
 })
 
 type groupManifestGenerator struct {
-	prevRevisionReader  *structured.NodeReader
+	// prevRevisionReader is the reader for the previous revision.
+	prevRevisionReader *structured.NodeReader
+	// mergeConfigRegistry is the registry for merge config.
 	mergeConfigRegistry *k8s.K8sManifestMergeConfigRegistry
-	prevRevisionBody    string
-	resourceName        string
+	// prevRevisionBody is the body of the previous revision.
+	prevRevisionBody string
+	// resourceName is the name of the resource.
+	resourceName string
 }
 
+// Process processes the log to generate manifest.
 func (g *groupManifestGenerator) Process(ctx context.Context, l *log.Log) (*commonlogk8sauditv2_contract.ResourceChangeLog, error) {
 	if g.prevRevisionReader == nil {
 		g.prevRevisionReader = structured.NewNodeReader(structured.NewEmptyMapNode())
@@ -236,7 +242,7 @@ kind: %s
 	}
 }
 
-// Remove @type in response or request payload
+// removeAtType removes @type in response or request payload.
 func removeAtType(yamlString string) string {
 	lines := strings.Split(yamlString, "\n")
 	var result []string