ooni-probe-cli/pkg/oonimkall/tasksession.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

79 lines
2.1 KiB
Go

package oonimkall
import (
"context"
"github.com/ooni/probe-cli/v3/internal/engine"
"github.com/ooni/probe-cli/v3/internal/kvstore"
"github.com/ooni/probe-cli/v3/internal/model"
)
//
// This file implements taskSession and derived types.
//
// taskKVStoreFSBuilderEngine creates a new KVStore
// using the ./internal/engine package.
type taskKVStoreFSBuilderEngine struct{}
var _ taskKVStoreFSBuilder = &taskKVStoreFSBuilderEngine{}
func (*taskKVStoreFSBuilderEngine) NewFS(path string) (model.KeyValueStore, error) {
return kvstore.NewFS(path)
}
// taskSessionBuilderEngine builds a new session
// using the ./internal/engine package.
type taskSessionBuilderEngine struct{}
var _ taskSessionBuilder = &taskSessionBuilderEngine{}
// NewSession implements taskSessionBuilder.NewSession.
func (b *taskSessionBuilderEngine) NewSession(ctx context.Context,
config engine.SessionConfig) (taskSession, error) {
sess, err := engine.NewSession(ctx, config)
if err != nil {
return nil, err
}
return &taskSessionEngine{sess}, nil
}
// taskSessionEngine wraps ./internal/engine's Session.
type taskSessionEngine struct {
*engine.Session
}
var _ taskSession = &taskSessionEngine{}
// NewExperimentBuilderByName implements
// taskSessionEngine.NewExperimentBuilderByName.
func (sess *taskSessionEngine) NewExperimentBuilderByName(
name string) (taskExperimentBuilder, error) {
builder, err := sess.NewExperimentBuilder(name)
if err != nil {
return nil, err
}
return &taskExperimentBuilderEngine{builder}, err
}
// taskExperimentBuilderEngine wraps ./internal/engine's
// ExperimentBuilder type.
type taskExperimentBuilderEngine struct {
*engine.ExperimentBuilder
}
var _ taskExperimentBuilder = &taskExperimentBuilderEngine{}
// NewExperimentInstance implements
// taskExperimentBuilder.NewExperimentInstance.
func (b *taskExperimentBuilderEngine) NewExperimentInstance() taskExperiment {
return &taskExperimentEngine{b.NewExperiment()}
}
// taskExperimentEngine wraps ./internal/engine's Experiment.
type taskExperimentEngine struct {
*engine.Experiment
}
var _ taskExperiment = &taskExperimentEngine{}