benchmark.go

// Copyright 2019 Netflix, 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 p2plab

import (
	"context"

	"github.com/Netflix/p2plab/metadata"
)

// BenchmarkAPI defines API for benchmark operations.
type BenchmarkAPI interface {
	// Create creates a benchmark of a scenario on a cluster.
	Create(ctx context.Context, cluster, scenario string, opts ...StartBenchmarkOption) (id string, err error)

	// Get returns a benchmark.
	Get(ctx context.Context, id string) (Benchmark, error)

	Label(ctx context.Context, ids, adds, removes []string) ([]Benchmark, error)

	// List returns available benchmarks.
	List(ctx context.Context, opts ...ListOption) ([]Benchmark, error)

	Remove(ctx context.Context, ids ...string) error
}

// Benchmark is an execution of a scenario on a cluster.
type Benchmark interface {
	Labeled

	Metadata() metadata.Benchmark

	Report(ctx context.Context) (metadata.Report, error)
}

type StartBenchmarkOption func(*StartBenchmarkSettings) error

type StartBenchmarkSettings struct {
	NoReset bool
}

func WithBenchmarkNoReset() StartBenchmarkOption {
	return func(s *StartBenchmarkSettings) error {
		s.NoReset = true
		return nil
	}
}