ooni-probe-cli/internal/model/logger.go
Simone Basso 273b70bacc
refactor: interfaces and data types into the model package (#642)
## Checklist

- [x] I have read the [contribution guidelines](https://github.com/ooni/probe-cli/blob/master/CONTRIBUTING.md)
- [x] reference issue for this pull request: https://github.com/ooni/probe/issues/1885
- [x] related ooni/spec pull request: N/A

Location of the issue tracker: https://github.com/ooni/probe

## Description

This PR contains a set of changes to move important interfaces and data types into the `./internal/model` package.

The criteria for including an interface or data type in here is roughly that the type should be important and used by several packages. We are especially interested to move more interfaces here to increase modularity.

An additional side effect is that, by reading this package, one should be able to understand more quickly how different parts of the codebase interact with each other.

This is what I want to move in `internal/model`:

- [x] most important interfaces from `internal/netxlite`
- [x] everything that was previously part of `internal/engine/model`
- [x] mocks from `internal/netxlite/mocks` should also be moved in here as a subpackage
2022-01-03 13:53:23 +01:00

64 lines
1.6 KiB
Go

package model
//
// Logger
//
// DebugLogger is a logger emitting only debug messages.
type DebugLogger interface {
// Debug emits a debug message.
Debug(msg string)
// Debugf formats and emits a debug message.
Debugf(format string, v ...interface{})
}
// InfoLogger is a logger emitting debug and infor messages.
type InfoLogger interface {
// An InfoLogger is also a DebugLogger.
DebugLogger
// Info emits an informational message.
Info(msg string)
// Infof formats and emits an informational message.
Infof(format string, v ...interface{})
}
// Logger defines the common interface that a logger should have. It is
// out of the box compatible with `log.Log` in `apex/log`.
type Logger interface {
// A Logger is also an InfoLogger.
InfoLogger
// Warn emits a warning message.
Warn(msg string)
// Warnf formats and emits a warning message.
Warnf(format string, v ...interface{})
}
// DiscardLogger is the default logger that discards its input
var DiscardLogger Logger = logDiscarder{}
// logDiscarder is a logger that discards its input
type logDiscarder struct{}
// Debug implements DebugLogger.Debug
func (logDiscarder) Debug(msg string) {}
// Debugf implements DebugLogger.Debugf
func (logDiscarder) Debugf(format string, v ...interface{}) {}
// Info implements InfoLogger.Info
func (logDiscarder) Info(msg string) {}
// Infov implements InfoLogger.Infov
func (logDiscarder) Infof(format string, v ...interface{}) {}
// Warn implements Logger.Warn
func (logDiscarder) Warn(msg string) {}
// Warnf implements Logger.Warnf
func (logDiscarder) Warnf(format string, v ...interface{}) {}