job_context.go

// Copyright Project Harbor Authors
//
// 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 env

import (
	"context"

	"github.com/goharbor/harbor/src/jobservice/logger"
	"github.com/goharbor/harbor/src/jobservice/models"
)

// JobContext is combination of BaseContext and other job specified resources.
// JobContext will be the real execution context for one job.
// 真正将会的执行的 context
type JobContext interface {
	// Build the context based on the parent context
	//
	// dep JobData : Dependencies for building the context, just in case that the build
	// function need some external info
	//
	// Returns:
	// new JobContext based on the parent one
	// error if meet any problems
	// 使用依赖数据来构建新的 context，
	Build(dep JobData) (JobContext, error)

	// Get property from the context
	//
	// prop string : key of the context property
	//
	// Returns:
	//  The data of the specified context property if have
	//  bool to indicate if the property existing
	// 从 context 获取指定参数的值
	Get(prop string) (interface{}, bool)

	// SystemContext returns the system context
	//
	// Returns:
	//  context.Context
	SystemContext() context.Context

	// Checkin is bridge func for reporting detailed status
	//
	// status string : detailed status
	//
	// Returns:
	//  error if meet any problems
	Checkin(status string) error

	// OPCommand return the control operational command like stop/cancel if have
	//
	// Returns:
	//  op command if have
	//  flag to indicate if have command
	// 返回控制操作 stop/cancel
	OPCommand() (string, bool)

	// Return the logger
	GetLogger() logger.Interface

	// Launch sub jobs
	// 启动子 job
	LaunchJob(req models.JobRequest) (models.JobStats, error)
}

// JobData defines job context dependencies.
type JobData struct {
	ID        string
	Name      string
	Args      map[string]interface{}
	ExtraData map[string]interface{}
}

// JobContextInitializer is a func to initialize the concrete job context
type JobContextInitializer func(ctx *Context) (JobContext, error)