woodpecker/pipeline/rpc/peer.go

88 lines
2.6 KiB
Go
Raw Normal View History

// Copyright 2021 Woodpecker Authors
// Copyright 2011 Drone.IO 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.
2017-03-05 07:56:08 +00:00
package rpc
import (
"context"
backend "github.com/woodpecker-ci/woodpecker/pipeline/backend/types"
2017-03-05 07:56:08 +00:00
)
type (
// Filter defines filters for fetching items from the queue.
Filter struct {
Labels map[string]string `json:"labels"`
2017-03-05 07:56:08 +00:00
}
// State defines the workflow state.
2017-03-05 07:56:08 +00:00
State struct {
Step string `json:"step"`
2017-03-05 07:56:08 +00:00
Exited bool `json:"exited"`
ExitCode int `json:"exit_code"`
Started int64 `json:"started"`
Finished int64 `json:"finished"`
Error string `json:"error"`
}
// Workflow defines the workflow execution details.
Workflow struct {
2017-03-05 07:56:08 +00:00
ID string `json:"id"`
Config *backend.Config `json:"config"`
Timeout int64 `json:"timeout"`
}
2017-04-01 11:17:04 +00:00
Version struct {
GrpcVersion int32 `json:"grpc_version,omitempty"`
ServerVersion string `json:"server_version,omitempty"`
}
2017-03-05 07:56:08 +00:00
)
// Peer defines a peer-to-peer connection.
type Peer interface {
// Version returns the server- & grpc-version
Version(c context.Context) (*Version, error)
// Next returns the next workflow in the queue
Next(c context.Context, f Filter) (*Workflow, error)
2017-03-05 07:56:08 +00:00
// Wait blocks until the workflow is complete
2017-03-05 11:05:16 +00:00
Wait(c context.Context, id string) error
// Init signals the workflow is initialized
2017-04-01 11:17:04 +00:00
Init(c context.Context, id string, state State) error
// Done signals the workflow is complete
2017-04-01 11:17:04 +00:00
Done(c context.Context, id string, state State) error
2017-03-05 07:56:08 +00:00
// Extend extends the workflow deadline
2017-03-05 07:56:08 +00:00
Extend(c context.Context, id string) error
// Update updates the workflow state
2017-03-05 07:56:08 +00:00
Update(c context.Context, id string, state State) error
// Log writes the workflow log entry
Log(c context.Context, logEntry *LogEntry) error
// RegisterAgent register our agent to the server
RegisterAgent(ctx context.Context, platform, backend, version string, capacity int) (int64, error)
// UnregisterAgent unregister our agent from the server
UnregisterAgent(ctx context.Context) error
// ReportHealth reports health status of the agent to the server
ReportHealth(c context.Context) error
2017-03-05 07:56:08 +00:00
}