api.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"
	"github.com/libp2p/go-libp2p-core/peer"
)

// ControlAPI defines APIs for labd.
type ControlAPI interface {
	// Cluster returns an implementaiton of Cluster API.
	Cluster() ClusterAPI

	// Node returns an implementation of Node API.
	Node() NodeAPI

	// Scenario returns an implementation of Scenario API.
	Scenario() ScenarioAPI

	// Benchmark returns an implementation of Benchmark API.
	Benchmark() BenchmarkAPI

	// Experiment returns an implementation of Experiment API.
	Experiment() ExperimentAPI

	// Build returns an implementation of Build API.
	Build() BuildAPI
}

type AgentAPI interface {
	Healthcheck(ctx context.Context) bool

	Update(ctx context.Context, id, link string, pdef metadata.PeerDefinition) error

	// SSH creates a SSH connection to the node.
	SSH(ctx context.Context, opts ...SSHOption) error
}

type AppAPI interface {
	PeerInfo(ctx context.Context) (peer.AddrInfo, error)

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

	// Run executes an task on the node.
	Run(ctx context.Context, task metadata.Task) error
}