Add basic acorn events subcommand (#1562) (#1604)

* Add public and private API types for acorn events
* Add aggregated API server for acorn events
* Emit initial set of App related events
* Add basic events subcommand and client
* Generate basic acorn events docs
* Add event unit tests for app image pull handler

Signed-off-by: Nick Hale <[email protected]>

Author: njhale

docs/docs/100-reference/01-command-line/acorn.md

@@ -33,6 +33,7 @@ acorn [flags]
 * [acorn container](acorn_container.md)	 - Manage containers
 * [acorn credential](acorn_credential.md)	 - Manage registry credentials
 * [acorn dev](acorn_dev.md)	 - Run an app from an image or Acornfile in dev mode or attach a dev session to a currently running app
+* [acorn events](acorn_events.md)	 - List events about Acorn resources
 * [acorn exec](acorn_exec.md)	 - Run a command in a container
 * [acorn fmt](acorn_fmt.md)	 - Format an Acornfile
 * [acorn image](acorn_image.md)	 - Manage images

docs/docs/100-reference/01-command-line/acorn_events.md

@@ -0,0 +1,53 @@
+---
+title: "acorn events"
+---
+## acorn events
+
+List events about Acorn resources
+
+```
+acorn events [flags]
+```
+
+### Examples
+
+```
+# List all events in the current project
+  acorn events
+
+  # List events across all projects
+  acorn -A events
+
+  # List the last 10 events 
+  acorn events --tail 10
+
+# Getting Details 
+  # The 'details' field provides additional information about an event.
+  # By default, this field is elided from this command's output, but can be enabled via the '--details' flag.
+  acorn events --details
+
+```
+
+### Options
+
+```
+  -d, --details         Don't strip event details from response
+  -h, --help            help for events
+  -o, --output string   Output format (json, yaml, {{gotemplate}})
+  -t, --tail int        Return this number of latest events
+```
+
+### Options inherited from parent commands
+
+```
+  -A, --all-projects        Use all known projects
+      --debug               Enable debug logging
+      --debug-level int     Debug log level (valid 0-9) (default 7)
+      --kubeconfig string   Explicitly use kubeconfig file, overriding current project
+  -j, --project string      Project to work in
+```
+
+### SEE ALSO
+
+* [acorn](acorn.md)	 - 
+

go.mod

@@ -53,6 +53,7 @@ require (
 	github.com/spf13/pflag v1.0.5
 	github.com/stretchr/testify v1.8.1
 	github.com/tonistiigi/fsutil v0.0.0-20220315205639-9ed612626da3
+	github.com/wI2L/jsondiff v0.3.0
 	golang.org/x/crypto v0.6.0
 	golang.org/x/exp v0.0.0-20221114191408-850992195362
 	golang.org/x/sync v0.1.0
@@ -249,6 +250,9 @@ require (
 	github.com/tent/canonical-json-go v0.0.0-20130607151641-96e4ba3a7613 // indirect
 	github.com/thales-e-security/pool v0.0.2 // indirect
 	github.com/theupdateframework/go-tuf v0.5.2-0.20220930112810-3890c1e7ace4 // indirect
+	github.com/tidwall/gjson v1.14.3 // indirect
+	github.com/tidwall/match v1.1.1 // indirect
+	github.com/tidwall/pretty v1.2.1 // indirect
 	github.com/titanous/rocacheck v0.0.0-20171023193734-afe73141d399 // indirect
 	github.com/tmc/grpc-websocket-proxy v0.0.0-20201229170055-e5319fda7802 // indirect
 	github.com/tonistiigi/units v0.0.0-20180711220420-6950e57a87ea // indirect

go.sum

@@ -1307,8 +1307,14 @@ github.com/thales-e-security/pool v0.0.2 h1:RAPs4q2EbWsTit6tpzuvTFlgFRJ3S8Evf5gt
 github.com/thales-e-security/pool v0.0.2/go.mod h1:qtpMm2+thHtqhLzTwgDBj/OuNnMpupY8mv0Phz0gjhU=
 github.com/theupdateframework/go-tuf v0.5.2-0.20220930112810-3890c1e7ace4 h1:1i/Afw3rmaR1gF3sfVkG2X6ldkikQwA9zY380LrR5YI=
 github.com/theupdateframework/go-tuf v0.5.2-0.20220930112810-3890c1e7ace4/go.mod h1:vAqWV3zEs89byeFsAYoh/Q14vJTgJkHwnnRCWBBBINY=
+github.com/tidwall/gjson v1.14.3 h1:9jvXn7olKEHU1S9vwoMGliaT8jq1vJ7IH/n9zD9Dnlw=
+github.com/tidwall/gjson v1.14.3/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk=
+github.com/tidwall/match v1.1.1 h1:+Ho715JplO36QYgwN9PGYNhgZvoUSc9X2c80KVTi+GA=
+github.com/tidwall/match v1.1.1/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM=
 github.com/tidwall/pretty v1.0.0/go.mod h1:XNkn88O1ChpSDQmQeStsy+sBenx6DDtFZJxhVysOjyk=
-github.com/tidwall/pretty v1.2.0 h1:RWIZEg2iJ8/g6fDDYzMpobmaoGh5OLl4AXtGUGPcqCs=
+github.com/tidwall/pretty v1.2.0/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU=
+github.com/tidwall/pretty v1.2.1 h1:qjsOFOWWQl+N3RsoF5/ssm1pHmJJwhjlSbZ51I6wMl4=
+github.com/tidwall/pretty v1.2.1/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU=
 github.com/titanous/rocacheck v0.0.0-20171023193734-afe73141d399 h1:e/5i7d4oYZ+C1wj2THlRK+oAhjeS/TRQwMfkIuet3w0=
 github.com/titanous/rocacheck v0.0.0-20171023193734-afe73141d399/go.mod h1:LdwHTNJT99C5fTAzDz0ud328OgXz+gierycbcIx2fRs=
 github.com/tj/assert v0.0.0-20171129193455-018094318fb0/go.mod h1:mZ9/Rh9oLWpLLDRpvE+3b7gP/C2YyLFYxNmcLnPTMe0=
@@ -1342,6 +1348,8 @@ github.com/vbatts/tar-split v0.11.2 h1:Via6XqJr0hceW4wff3QRzD5gAk/tatMw/4ZA7cTlI
 github.com/vbatts/tar-split v0.11.2/go.mod h1:vV3ZuO2yWSVsz+pfFzDG/upWH1JhjOiEaWq6kXyQ3VI=
 github.com/vmihailenco/msgpack/v5 v5.3.5 h1:5gO0H1iULLWGhs2H5tbAHIZTV8/cYafcFOr9znI5mJU=
 github.com/vmihailenco/tagparser/v2 v2.0.0 h1:y09buUbR+b5aycVFQs/g70pqKVZNBmxwAhO7/IwNM9g=
+github.com/wI2L/jsondiff v0.3.0 h1:iTzQ9u/d86GE9RsBzVHX88f2EA1vQUboHwLhSQFc1s4=
+github.com/wI2L/jsondiff v0.3.0/go.mod h1:y1IMzNNjlSsk3IUoJdRJO7VRBtzMvRgyo4Vu0LdHpTc=
 github.com/xanzy/go-gitlab v0.31.0/go.mod h1:sPLojNBn68fMUWSxIJtdVVIP8uSBYqesTfDUseX11Ug=
 github.com/xanzy/go-gitlab v0.73.1 h1:UMagqUZLJdjss1SovIC+kJCH4k2AZWXl58gJd38Y/hI=
 github.com/xanzy/go-gitlab v0.73.1/go.mod h1:d/a0vswScO7Agg1CZNz15Ic6SSvBG9vfw8egL99t4kA=

integration/events/events_test.go

@@ -0,0 +1,71 @@
+package events
+
+import (
+	"testing"
+
+	"github.com/acorn-io/acorn/integration/helper"
+	apiv1 "github.com/acorn-io/acorn/pkg/apis/api.acorn.io/v1"
+	v1 "github.com/acorn-io/acorn/pkg/apis/internal.acorn.io/v1"
+	"github.com/acorn-io/acorn/pkg/client"
+	"github.com/acorn-io/acorn/pkg/server/registry/apigroups/acorn/apps"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestAppEvents(t *testing.T) {
+	helper.StartController(t)
+
+	ctx := helper.GetCTX(t)
+	c, ns := helper.ClientAndNamespace(t)
+
+	image, err := c.AcornImageBuild(ctx, "./testdata/simple/Acornfile", &client.AcornImageBuildOptions{
+		Cwd: "./testdata/simple",
+	})
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	// Create the app to generate an AppCreateEvent
+	app, err := c.AppRun(ctx, image.ID, nil)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	app = helper.WaitForObject(t, helper.Watcher(t, c), &apiv1.AppList{}, app, func(obj *apiv1.App) bool {
+		return obj.Status.Condition(v1.AppInstanceConditionParsed).Success
+	})
+	assert.NotEmpty(t, app.Status.Namespace)
+
+	// Update the app spec to generate an AppSpecUpdatedEvent
+	kc, err := c.GetClient()
+	require.NoError(t, err)
+
+	stop := true
+	app = helper.WaitForObject(t, helper.Watcher(t, c), &apiv1.AppList{}, app, func(obj *apiv1.App) bool {
+		obj.Spec.Stop = &stop
+		return kc.Update(ctx, obj) == nil
+	})
+
+	// Delete the app to generate an AppDeletedEvent
+	assert.NoError(t, kc.Delete(ctx, app))
+
+	// Ensure an event of each type has been recorded
+	var created, updated, deleted bool
+	helper.Wait(t, helper.Watcher(t, c), &apiv1.EventList{}, func(obj *apiv1.Event) bool {
+		if obj.Namespace != ns.Name || obj.Source.Kind != "app" || obj.Source.Name != app.Name {
+			// This event isn't for our app
+			return false
+		}
+
+		switch obj.Type {
+		case apps.AppCreateEventType:
+			created = true
+		case apps.AppSpecUpdateEventType:
+			updated = true
+		case apps.AppDeleteEventType:
+			deleted = true
+		}
+
+		return created && updated && deleted
+	})
+}

integration/events/testdata/simple/Acornfile

@@ -0,0 +1,5 @@
+containers: {
+	simple: {
+		build: "."
+	}
+}

integration/events/testdata/simple/Dockerfile

@@ -0,0 +1 @@
+FROM ghcr.io/acorn-io/images-mirror/nginx:latest

pkg/apis/api.acorn.io/v1/scheme.go

@@ -1,6 +1,7 @@
 package v1
 
 import (
+	"fmt"
 	"net/url"
 
 	api_acorn_io "github.com/acorn-io/acorn/pkg/apis/api.acorn.io"
@@ -62,6 +63,8 @@ func AddToSchemeWithGV(scheme *runtime.Scheme, schemeGroupVersion schema.GroupVe
 		&RegionList{},
 		&ImageAllowRule{},
 		&ImageAllowRuleList{},
+		&Event{},
+		&EventList{},
 	)
 
 	// Add common types
@@ -77,7 +80,21 @@ func AddToSchemeWithGV(scheme *runtime.Scheme, schemeGroupVersion schema.GroupVe
 		if err := scheme.AddConversionFunc((*url.Values)(nil), (*ContainerReplicaExecOptions)(nil), Convert_url_Values_To__ContainerReplicaExecOptions); err != nil {
 			return err
 		}
-		return scheme.AddConversionFunc((*url.Values)(nil), (*LogOptions)(nil), Convert_url_Values_To__LogOptions)
+		if err := scheme.AddConversionFunc((*url.Values)(nil), (*LogOptions)(nil), Convert_url_Values_To__LogOptions); err != nil {
+			return err
+		}
+
+		gvk := schemeGroupVersion.WithKind("Event")
+		flcf := func(label, value string) (string, string, error) {
+			switch label {
+			case "details":
+				return label, value, nil
+			}
+			return "", "", fmt.Errorf("unsupported field selection [%s]", label)
+		}
+		if err := scheme.AddFieldLabelConversionFunc(gvk, flcf); err != nil {
+			return err
+		}
 	}
 
 	return nil

pkg/apis/api.acorn.io/v1/types.go

@@ -559,3 +559,15 @@ type ImageAllowRuleList struct {
 	metav1.ListMeta `json:"metadata,omitempty"`
 	Items           []ImageAllowRule `json:"items"`
 }
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+type Event v1.EventInstance
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+type EventList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []Event `json:"items"`
+}

pkg/apis/api.acorn.io/v1/zz_generated.deepcopy.go

@@ -0,0 +1,82 @@
+package v1
+
+import (
+	"fmt"
+
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/types"
+)
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+type EventInstanceList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []EventInstance `json:"items"`
+}
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+type EventInstance struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	// Type is a short, machine-readable string that describes the kind of Event that took place.
+	Type string `json:"type"`
+
+	// Severity indicates the severity of the event.
+	// +optional
+	Severity EventSeverity `json:"severity,omitempty"`
+
+	// Actor is the ID of the entity that generated the Event.
+	// This can be the name of a particular user or controller.
+	Actor string `json:"actor"`
+
+	// Source identifies the object the Event is regarding.
+	Source EventSource `json:"source"`
+
+	// Description is a human-readable description of the Event.
+	// +optional
+	Description string `json:"description,omitempty"`
+
+	// Observed represents the time the Event was first observed.
+	Observed metav1.Time `json:"observed"`
+
+	// Details provides additional information about the cluster at the time the Event occurred.
+	//
+	// It's typically used to embed the subject resource, in its entirety, at the time the Event occurred,
+	// but can be used to hold any data related to the event.
+	//
+	// +optional
+	Details GenericMap `json:"details,omitempty"`
+}
+
+const (
+	EventSeverityInfo EventSeverity = "info"
+	EventSeverityWarn EventSeverity = "warn"
+)
+
+// EventSeverity indicates the severity of an event.
+type EventSeverity string
+
+// EventSource identifies an object related to an Event.
+//
+// The referenced object may or may not exist.
+//
+// Note: corev1.ObjectReference was explicitly avoided because its use in new schemas is discouraged.
+// See https://github.com/kubernetes/api/blob/cdff1d4efea5d7ddc52c4085f82748c5f3e5cc8e/core/v1/types.go#L5919
+// for more details.
+type EventSource struct {
+	// Kind is the source object kind.
+	Kind string `json:"kind"`
+
+	// Name is the name of the source object.
+	Name string `json:"name"`
+
+	// UID uniquely identifies the source object.
+	UID types.UID `json:"uuid"`
+}
+
+func (e EventSource) String() string {
+	return fmt.Sprintf("%s/%s", e.Kind, e.Name)
+}