Files
zot/pkg/extensions/events/http_sink_test.go
T
Piaras Hoban bc5fd1a357 feat(events): add events extension (#3045)
* feat: add events config

Signed-off-by: Piaras Hoban <phoban01@gmail.com>

* feat: implement event support with log sink

Signed-off-by: Piaras Hoban <phoban01@gmail.com>

* feat: integrate events and update tests

Signed-off-by: Piaras Hoban <phoban01@gmail.com>

* refactor: update event config

Signed-off-by: Piaras Hoban <phoban01@gmail.com>

* feat: implement http and nats sinks. remove log sink

Signed-off-by: Piaras Hoban <phoban01@gmail.com>

* refactor: events extension setup

Signed-off-by: Piaras Hoban <phoban01@gmail.com>

* chore: cleanup tests to use nil event recorder

Signed-off-by: Piaras Hoban <phoban01@gmail.com>

* chore: update events config example and add more logging

Signed-off-by: Piaras Hoban <phoban01@gmail.com>

* refactor: better use of build tags for minimal binary

Signed-off-by: Piaras Hoban <phoban01@gmail.com>

* fix: missing store param in evelated privileges tests

Signed-off-by: Piaras Hoban <phoban01@gmail.com>

* fix: regression in config decoding

Signed-off-by: Piaras Hoban <phoban01@gmail.com>

* chore: update check logs script to enable cross-platform usage via GREP_BIN_PATH envvar

Signed-off-by: Piaras Hoban <phoban01@gmail.com>

* chore: fix log lint issue for events

Signed-off-by: Piaras Hoban <phoban01@gmail.com>

* chore: fix failing events disabled test

Signed-off-by: Piaras Hoban <phoban01@gmail.com>

* test: add blackbox tests for events

Signed-off-by: Piaras Hoban <phoban01@gmail.com>

* chore: specify architecture when downloading binaries in Makefile

Signed-off-by: Piaras Hoban <phoban01@gmail.com>

* chore: improve failure handling when no valid sinks are provided

Signed-off-by: Piaras Hoban <phoban01@gmail.com>

* test: fix data race in events test

Signed-off-by: Piaras Hoban <phoban01@gmail.com>

* chore: cleanup event decoding

Signed-off-by: Piaras Hoban <phoban01@gmail.com>

* test: fix logging tests

Signed-off-by: Piaras Hoban <phoban01@gmail.com>

* test: make nats server test more reliable

Signed-off-by: Piaras Hoban <phoban01@gmail.com>

* chore: go mod cleanup

Signed-off-by: Piaras Hoban <phoban01@gmail.com>

* test: add sleep when setting up nats client

Signed-off-by: Piaras Hoban <phoban01@gmail.com>

* fix: ensure event sink errors do not propogate

Signed-off-by: Piaras Hoban <phoban01@gmail.com>

* test: increase coverage for events

Signed-off-by: Piaras Hoban <phoban01@gmail.com>

* feat(events): Refactor events to be non-blocking from caller.

Signed-off-by: Asgeir Nilsen <asgeir.nilsen@bouvet.no>
Signed-off-by: Piaras Hoban <phoban01@gmail.com>

* chore: remove harded-coded linux

Co-authored-by: Andrei Aaron <andreifdaaron@gmail.com>
Signed-off-by: Piaras Hoban <phoban01@gmail.com>

* feat(events): fail to start if incorrect event sink is configured

Signed-off-by: Piaras Hoban <phoban01@gmail.com>

* test: allow cli tests to return errors instead of panic

Signed-off-by: Piaras Hoban <phoban01@gmail.com>

* chore: bump nats server to v2.11.3

Signed-off-by: Piaras Hoban <phoban01@gmail.com>

---------

Signed-off-by: Piaras Hoban <phoban01@gmail.com>
Signed-off-by: Asgeir Nilsen <asgeir.nilsen@bouvet.no>
Co-authored-by: Asgeir Nilsen <asgeir.nilsen@bouvet.no>
Co-authored-by: Andrei Aaron <andreifdaaron@gmail.com>
2025-05-02 12:30:06 -07:00

141 lines
3.2 KiB
Go

//go:build events
// +build events
package events_test
import (
"testing"
"time"
cloudevents "github.com/cloudevents/sdk-go/v2"
. "github.com/smartystreets/goconvey/convey"
zerr "zotregistry.dev/zot/errors"
eventsconf "zotregistry.dev/zot/pkg/extensions/config/events"
"zotregistry.dev/zot/pkg/extensions/events"
)
func TestHTTPSink(t *testing.T) {
Convey("NewHTTPSink returns error for invalid type", t, func() {
cfg := eventsconf.SinkConfig{
Type: "invalid",
Address: "http://localhost",
}
sink, err := events.NewHTTPSink(cfg)
So(sink, ShouldBeNil)
So(err, ShouldEqual, zerr.ErrInvalidEventSinkType)
})
Convey("NewHTTPSink returns error for empty address", t, func() {
cfg := eventsconf.SinkConfig{
Type: eventsconf.HTTP,
}
sink, err := events.NewHTTPSink(cfg)
So(sink, ShouldBeNil)
So(err, ShouldEqual, zerr.ErrEventSinkAddressEmpty)
})
Convey("NewHTTPSink returns sink for valid config", t, func() {
cfg := eventsconf.SinkConfig{
Type: eventsconf.HTTP,
Address: "http://localhost",
}
sink, err := events.NewHTTPSink(cfg)
So(err, ShouldBeNil)
So(sink, ShouldNotBeNil)
})
Convey("NewHTTPSink handles basic auth config", t, func() {
cfg := eventsconf.SinkConfig{
Type: eventsconf.HTTP,
Address: "http://localhost",
Credentials: &eventsconf.Credentials{
Username: "user",
Password: "pass",
},
}
sink, err := events.NewHTTPSink(cfg)
So(err, ShouldBeNil)
So(sink, ShouldNotBeNil)
})
Convey("GetHTTPClientForConfig returns error for invalid proxy", t, func() {
badProxy := "://bad-url"
cfg := eventsconf.SinkConfig{
Proxy: &badProxy,
}
client, err := events.GetHTTPClientForConfig(cfg)
So(client, ShouldBeNil)
So(err, ShouldNotBeNil)
})
Convey("GetHTTPClientForConfig returns client with default transport", t, func() {
cfg := eventsconf.SinkConfig{
Timeout: 2 * time.Second,
}
client, err := events.GetHTTPClientForConfig(cfg)
So(err, ShouldBeNil)
So(client, ShouldNotBeNil)
})
Convey("BasicAuth encodes credentials", t, func() {
auth := events.BasicAuth("foo", "bar")
So(auth, ShouldEqual, "Zm9vOmJhcg==")
})
Convey("HTTPSink emits event and sets channel extension", t, func() {
event := cloudevents.NewEvent()
event.SetID("1234")
event.SetType("test.event")
event.SetSource("unit.test")
cfg := eventsconf.SinkConfig{
Type: eventsconf.HTTP,
Address: "http://localhost",
Timeout: 1 * time.Second,
Channel: "test-channel",
}
sink, err := events.NewHTTPSink(cfg)
So(err, ShouldBeNil)
_ = sink.Emit(&event)
So(event.Extensions()["channel"], ShouldEqual, "test-channel")
})
Convey("HTTPSink.Emit returns error for invalid event", t, func() {
event := cloudevents.NewEvent() // invalid
cfg := eventsconf.SinkConfig{
Type: eventsconf.HTTP,
Address: "http://localhost",
Timeout: 1 * time.Second,
}
sink, err := events.NewHTTPSink(cfg)
So(err, ShouldBeNil)
err = sink.Emit(&event)
So(err, ShouldNotBeNil)
})
Convey("HTTPSink.Close completes successfully", t, func() {
cfg := eventsconf.SinkConfig{
Type: eventsconf.HTTP,
Address: "http://localhost",
}
sink, err := events.NewHTTPSink(cfg)
So(err, ShouldBeNil)
err = sink.Close()
So(err, ShouldBeNil)
})
}