test_mocks_test.go

// Copyright 2019 Aporeto Inc.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//     http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package bahamut

import (
	"net/http"
	"sync"
	"time"

	opentracing "github.com/opentracing/opentracing-go"
	"github.com/opentracing/opentracing-go/log"
	"go.aporeto.io/elemental"
)

// A counter is a concurency safe count holder.
type counter struct {
	sync.Mutex
	count int
}

func (c *counter) Add(i int) {

	c.Lock()
	defer c.Unlock()

	c.count += i
}

func (c *counter) Value() int {

	c.Lock()
	defer c.Unlock()

	return c.count
}

// A mockAuditer is a mockable auditer
type mockAuditer struct {
	sync.Mutex
	nbCalls int
}

func (p *mockAuditer) Audit(Context, error) {

	p.Lock()
	p.nbCalls++
	p.Unlock()
}

func (p *mockAuditer) GetCallCount() int {

	<-time.After(300 * time.Millisecond) // wait for the go routine running the auditer to be done.

	p.Lock()
	defer p.Unlock()

	return p.nbCalls
}

// A mockAuth is a mockable Authorizer or Authenticator.
type mockAuth struct {
	err     error
	action  AuthAction
	errored bool
}

func (a *mockAuth) AuthenticateRequest(ctx Context) (AuthAction, error) {

	if a.errored {
		if a.err == nil {
			a.err = elemental.NewError("Error", "This is an error.", "bahamut-test", http.StatusInternalServerError)
		}
		return AuthActionKO, a.err
	}

	return a.action, nil
}

func (a *mockAuth) IsAuthorized(ctx Context) (AuthAction, error) {

	if a.errored {
		if a.err == nil {
			a.err = elemental.NewError("Error", "This is an error.", "bahamut-test", http.StatusInternalServerError)
		}
		return AuthActionKO, a.err
	}

	return a.action, nil
}

// A mockEmptyProcessor is an empty process implementation.
type mockEmptyProcessor struct{}

// A mockProcessor is an mockable Processor.
type mockProcessor struct {
	err    error
	output any
	events []*elemental.Event
}

func (p *mockProcessor) ProcessRetrieveMany(ctx Context) error {

	ctx.SetOutputData(p.output)
	ctx.EnqueueEvents(p.events...)

	return p.err
}

func (p *mockProcessor) ProcessRetrieve(ctx Context) error {

	ctx.SetOutputData(p.output)
	ctx.EnqueueEvents(p.events...)

	return p.err
}

func (p *mockProcessor) ProcessCreate(ctx Context) error {

	ctx.SetOutputData(p.output)
	ctx.EnqueueEvents(p.events...)

	return p.err
}

func (p *mockProcessor) ProcessUpdate(ctx Context) error {

	ctx.SetOutputData(p.output)
	ctx.EnqueueEvents(p.events...)

	return p.err
}

func (p *mockProcessor) ProcessDelete(ctx Context) error {

	ctx.SetOutputData(p.output)
	ctx.EnqueueEvents(p.events...)

	return p.err
}

func (p *mockProcessor) ProcessPatch(ctx Context) error {

	ctx.SetOutputData(p.output)
	ctx.EnqueueEvents(p.events...)

	return p.err
}

func (p *mockProcessor) ProcessInfo(ctx Context) error {

	ctx.SetOutputData(p.output)
	ctx.EnqueueEvents(p.events...)

	return p.err
}

// A mockPusher is a mockable implementation of a Pusher.
type mockPusher struct {
	sync.Mutex
	events []*elemental.Event
}

func (f *mockPusher) Push(evt ...*elemental.Event) {

	f.Lock()
	defer f.Unlock()

	f.events = append(f.events, evt...)
}

// A mockSpanContext is a mockable opentracing.SpanContext
type mockSpanContext struct {
}

func (t *mockSpanContext) ForeachBaggageItem(handler func(k, v string) bool) {}

// A mockTracer is a mockable opentracing.Tracer
type mockTracer struct {
	currentSpan *mockSpan
	injected    any
}

func (t *mockTracer) StartSpan(string, ...opentracing.StartSpanOption) opentracing.Span {

	if t.currentSpan == nil {
		t.currentSpan = newMockSpan(t)
	}

	return t.currentSpan
}

func (t *mockTracer) Inject(span opentracing.SpanContext, format any, carrier any) error {
	t.injected = carrier
	return nil
}

func (t *mockTracer) Extract(any, any) (opentracing.SpanContext, error) {

	return &mockSpanContext{}, nil
}

// A mockSpan is a mockable opentracing.Span
type mockSpan struct {
	tracer   opentracing.Tracer
	tags     map[string]any
	fields   []log.Field
	finished bool
}

func newMockSpan(tracer opentracing.Tracer) *mockSpan {
	return &mockSpan{
		tracer: tracer,
		tags:   map[string]any{},
		fields: []log.Field{},
	}
}

func (s *mockSpan) Finish() {

	s.finished = true
}

func (s *mockSpan) FinishWithOptions(opts opentracing.FinishOptions) {
	s.finished = true
}

func (s *mockSpan) Context() opentracing.SpanContext {
	return &mockSpanContext{}
}

func (s *mockSpan) SetOperationName(operationName string) opentracing.Span {
	return s
}

func (s *mockSpan) SetTag(key string, value any) opentracing.Span {

	s.tags[key] = value

	return s
}

func (s *mockSpan) LogFields(fields ...log.Field) {

	s.fields = append(s.fields, fields...)
}

func (s *mockSpan) LogKV(alternatingKeyValues ...any) {

}

func (s *mockSpan) SetBaggageItem(restrictedKey, value string) opentracing.Span {
	return s
}

func (s *mockSpan) BaggageItem(restrictedKey string) string {
	return ""

}
func (s *mockSpan) Tracer() opentracing.Tracer {
	return s.tracer
}

func (s *mockSpan) String() string {
	return "1234567890"
}

func (s *mockSpan) LogEvent(event string)                         {}
func (s *mockSpan) LogEventWithPayload(event string, payload any) {}
func (s *mockSpan) Log(data opentracing.LogData)                  {}