File: fakemonitoring.go

package info (click to toggle)
golang-github-tink-crypto-tink-go 2.4.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 12,952 kB
  • sloc: sh: 864; makefile: 6
file content (106 lines) | stat: -rw-r--r-- 2,542 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
// Copyright 2022 Google 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 fakemonitoring provides a fake implementation of monitoring clients and loggers.
package fakemonitoring

import (
	"sync"

	"github.com/tink-crypto/tink-go/v2/monitoring"
)

// Logger implements a fake monitoring.Logger
type Logger struct {
	Context *monitoring.Context
	client  *Client
}

var _ monitoring.Logger = (*Logger)(nil)

// Log logs the use of a primitive with a key with `keyID` operating over `numBytes`.
func (l *Logger) Log(keyID uint32, numBytes int) {
	l.client.addEvent(&LogEvent{
		Context:  l.Context,
		KeyID:    keyID,
		NumBytes: numBytes,
	})
}

// LogFailure captures a failure.
func (l *Logger) LogFailure() {
	l.client.addFailure(&LogFailure{Context: l.Context})
}

// LogEvent stored on each 'Log' operation.
type LogEvent struct {
	Context  *monitoring.Context
	KeyID    uint32
	NumBytes int
}

// LogFailure stored on each 'LogFailure' operation.
type LogFailure struct {
	Context *monitoring.Context
}

// Client implements a fake monitoring.Client
type Client struct {
	Name string

	eventsMu   sync.Mutex
	events     []*LogEvent
	failuresMu sync.Mutex
	failures   []*LogFailure
}

var _ monitoring.Client = (*Client)(nil)

// NewClient creates a new fake monitoring client.
func NewClient(name string) *Client {
	return &Client{
		Name: name,
	}
}

// NewLogger creates a new fake Logger.
func (c *Client) NewLogger(context *monitoring.Context) (monitoring.Logger, error) {
	return &Logger{
		Context: context,
		client:  c,
	}, nil
}

// Events returns logged events.
func (c *Client) Events() []*LogEvent {
	return c.events
}

// Failures returns logged failures.
func (c *Client) Failures() []*LogFailure {
	return c.failures
}

func (c *Client) addEvent(event *LogEvent) {
	c.eventsMu.Lock()
	defer c.eventsMu.Unlock()
	c.events = append(c.events, event)
}

func (c *Client) addFailure(failure *LogFailure) {
	defer c.failuresMu.Unlock()
	c.failuresMu.Lock()
	c.failures = append(c.failures, failure)

}