Function TestAPI

agent/agentcontainers/api_test.go:516–4118

(t *testing.T)

}

func TestAPI(t *testing.T) {
	t.Parallel()

	t.Run("NoUpdaterLoopLogspam", func(t *testing.T) {
		t.Parallel()

		var (
			ctx        = testutil.Context(t, testutil.WaitShort)
			logbuf     strings.Builder
			logger     = slogtest.Make(t, &slogtest.Options{IgnoreErrors: true}).Leveled(slog.LevelDebug).AppendSinks(sloghuman.Sink(&logbuf))
			mClock     = quartz.NewMock(t)
			tickerTrap = mClock.Trap().TickerFunc("updaterLoop")
			firstErr   = xerrors.New("first error")
			secondErr  = xerrors.New("second error")
			fakeCLI    = &fakeContainerCLI{
				listErr: firstErr,
			}
			fWatcher = newFakeWatcher(t)
		)

		api := agentcontainers.NewAPI(logger,
			agentcontainers.WithWatcher(fWatcher),
			agentcontainers.WithClock(mClock),
			agentcontainers.WithContainerCLI(fakeCLI),
		)
		api.Start()
		defer api.Close()

		// The watcherLoop writes a log when it is initialized.
		// We want to ensure this has happened before we start
		// the test so that it does not intefere.
		fWatcher.waitNext(ctx)

		// Make sure the ticker function has been registered
		// before advancing the clock.
		tickerTrap.MustWait(ctx).MustRelease(ctx)
		tickerTrap.Close()

		logbuf.Reset()

		// First tick should handle the error.
		_, aw := mClock.AdvanceNext()
		aw.MustWait(ctx)

		// Verify first error is logged.
		got := logbuf.String()
		t.Logf("got log: %q", got)
		require.Contains(t, got, "updater loop ticker failed", "first error should be logged")
		require.Contains(t, got, "first error", "should contain first error message")
		logbuf.Reset()

		// Second tick should handle the same error without logging it again.
		_, aw = mClock.AdvanceNext()
		aw.MustWait(ctx)

		// Verify same error is not logged again.
		got = logbuf.String()
		t.Logf("got log: %q", got)