interfaces

package
v0.6.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 12, 2023 License: Apache-2.0 Imports: 14 Imported by: 6

Documentation

Index

Constants

View Source 
const (
	ModelIdArtifact = iota
	ModelIdTag
	ModelIdNode
	ModelIdProject
	ModelIdSpider
	ModelIdTask
	ModelIdJob
	ModelIdSchedule
	ModelIdUser
	ModelIdSetting
	ModelIdToken
	ModelIdVariable
	ModelIdTaskQueue
	ModelIdTaskStat
	ModelIdPlugin
	ModelIdSpiderStat
	ModelIdDataSource
	ModelIdDataCollection
	ModelIdResult
	ModelIdPassword
	ModelIdExtraValue
	ModelIdPluginStatus
	ModelIdGit
	ModelIdRole
	ModelIdUserRole
	ModelIdPermission
	ModelIdRolePermission
	ModelIdEnvironment
)
View Source 
const (
	ModelColNameArtifact       = "artifacts"
	ModelColNameTag            = "tags"
	ModelColNameNode           = "nodes"
	ModelColNameProject        = "projects"
	ModelColNameSpider         = "spiders"
	ModelColNameTask           = "tasks"
	ModelColNameJob            = "jobs"
	ModelColNameSchedule       = "schedules"
	ModelColNameUser           = "users"
	ModelColNameSetting        = "settings"
	ModelColNameToken          = "tokens"
	ModelColNameVariable       = "variables"
	ModelColNameTaskQueue      = "task_queue"
	ModelColNameTaskStat       = "task_stats"
	ModelColNamePlugin         = "plugins"
	ModelColNameSpiderStat     = "spider_stats"
	ModelColNameDataSource     = "data_sources"
	ModelColNameDataCollection = "data_collections"
	ModelColNamePasswords      = "passwords"
	ModelColNameExtraValues    = "extra_values"
	ModelColNamePluginStatus   = "plugin_status"
	ModelColNameGit            = "gits"
	ModelColNameRole           = "roles"
	ModelColNameUserRole       = "user_roles"
	ModelColNamePermission     = "permissions"
	ModelColNameRolePermission = "role_permissions"
	ModelColNameEnvironment    = "environments"
)
View Source 
const (
	ModelDelegateMethodAdd         = "add"
	ModelDelegateMethodSave        = "save"
	ModelDelegateMethodDelete      = "delete"
	ModelDelegateMethodGetArtifact = "get-artifact"
	ModelDelegateMethodRefresh     = "refresh"
	ModelDelegateMethodChange      = "change"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Address 

type Address interface {
	Entity
	String() string
	IsEmpty() bool
}

type Color 

type Color interface {
	Entity
	GetHex() string
	GetName() string
}

type ColorService 

type ColorService interface {
	Injectable
	GetByName(name string) (res Color, err error)
	GetRandom() (res Color, err error)
}

type ControllerParams added in v0.6.1 

type ControllerParams interface {
	IsZero() (ok bool)
	IsDefault() (ok bool)
}

type DataSourceService added in v0.6.2 

type DataSourceService interface {
	ChangePassword(id primitive.ObjectID, password string) (err error)
	Monitor()
	CheckStatus(id primitive.ObjectID) (err error)
	SetTimeout(duration time.Duration)
	SetMonitorInterval(duration time.Duration)
}

type Entity 

type Entity interface {
	Value() interface{}
}

type Environment added in v0.6.2 

type Environment interface {
	Model
	GetKey() (key string)
	SetKey(key string)
	GetValue() (value string)
	SetValue(value string)
}

type EventData 

type EventData interface {
	GetEvent() string
	GetData() interface{}
}

type EventFn 

type EventFn func(data ...interface{}) (err error)

type EventService 

type EventService interface {
	Register(key, include, exclude string, ch *chan EventData)
	Unregister(key string)
	SendEvent(eventName string, data ...interface{})
}

type Export added in v0.6.1 

type Export interface {
	GetId() string
	GetType() string
	GetTarget() string
	GetFilter() Filter
	GetStatus() string
	GetStartTs() time.Time
	GetEndTs() time.Time
	GetDownloadPath() string
}

type ExportService added in v0.6.1 

type ExportService interface {
	GenerateId() (exportId string, err error)
	Export(exportType, target string, filter Filter) (exportId string, err error)
	GetExport(exportId string) (export Export, err error)
}

type ExtraValue 

type ExtraValue interface {
	Model
	GetValue() (v interface{})
	SetValue(v interface{})
	GetObjectId() (oid primitive.ObjectID)
	SetObjectId(oid primitive.ObjectID)
	GetModel() (m string)
	SetModel(m string)
	GetType() (t string)
	SetType(t string)
}

type Filter added in v0.6.1 

type Filter interface {
	GetIsOr() (isOr bool)
	SetIsOr(isOr bool)
	GetConditions() (conditions []FilterCondition)
	SetConditions(conditions []FilterCondition)
	IsNil() (ok bool)
}

type FilterCondition added in v0.6.1 

type FilterCondition interface {
	GetKey() (key string)
	SetKey(key string)
	GetOp() (op string)
	SetOp(op string)
	GetValue() (value interface{})
	SetValue(value interface{})
}

type FsFileInfo 

type FsFileInfo interface {
	GetName() string
	GetPath() string
	GetFullPath() string
	GetExtension() string
	GetMd5() string
	GetIsDir() bool
	GetFileSize() int64
	GetChildren() []FsFileInfo
}

type FsService 

type FsService interface {
	WithConfigPath
	List(path string, opts ...ServiceCrudOption) (files []FsFileInfo, err error)
	GetFile(path string, opts ...ServiceCrudOption) (data []byte, err error)
	GetFileInfo(path string, opts ...ServiceCrudOption) (file FsFileInfo, err error)
	Save(path string, data []byte, opts ...ServiceCrudOption) (err error)
	Rename(path, newPath string, opts ...ServiceCrudOption) (err error)
	Delete(path string, opts ...ServiceCrudOption) (err error)
	Copy(path, newPath string, opts ...ServiceCrudOption) (err error)
	Commit(msg string) (err error)
	SyncToFs(opts ...ServiceCrudOption) (err error)
	SyncToWorkspace() (err error)
	GetFsPath() (path string)
	SetFsPath(path string)
	GetWorkspacePath() (path string)
	SetWorkspacePath(path string)
	GetRepoPath() (path string)
	SetRepoPath(path string)
	GetFs() (fs cfs.Manager)
	GetGitClient() (c *vcs.GitClient)
}

type GrpcBase 

type GrpcBase interface {
	WithConfigPath
	Init() (err error)
	Start() (err error)
	Stop() (err error)
	Register() (err error)
}

type GrpcBaseServiceParams 

type GrpcBaseServiceParams interface {
	Entity
}

type GrpcClient 

type GrpcClient interface {
	GrpcBase
	WithConfigPath
	GetModelDelegateClient() grpc.ModelDelegateClient
	GetModelBaseServiceClient() grpc.ModelBaseServiceClient
	GetNodeClient() grpc.NodeServiceClient
	GetTaskClient() grpc.TaskServiceClient
	GetPluginClient() grpc.PluginServiceClient
	GetMessageClient() grpc.MessageServiceClient
	SetAddress(Address)
	SetTimeout(time.Duration)
	SetSubscribeType(string)
	SetHandleMessage(bool)
	Context() (context.Context, context.CancelFunc)
	NewRequest(interface{}) *grpc.Request
	NewPluginRequest(interface{}) *grpc.PluginRequest
	GetMessageChannel() chan *grpc.StreamMessage
	Restart() error
	NewModelBaseServiceRequest(ModelId, GrpcBaseServiceParams) (*grpc.Request, error)
	IsStarted() bool
	IsClosed() bool
	Err() error
	GetStream() grpc.NodeService_SubscribeClient
}

type GrpcClientModelBaseService 

type GrpcClientModelBaseService interface {
	WithModelId
	WithConfigPath
	ModelBaseService
}

type GrpcClientModelDelegate 

type GrpcClientModelDelegate interface {
	ModelDelegate
	WithConfigPath
	Close() error
}

type GrpcClientModelEnvironmentService added in v0.6.2 

type GrpcClientModelEnvironmentService interface {
	ModelBaseService
	GetEnvironmentById(id primitive.ObjectID) (s Environment, err error)
	GetEnvironment(query bson.M, opts *mongo.FindOptions) (s Environment, err error)
	GetEnvironmentList(query bson.M, opts *mongo.FindOptions) (res []Environment, err error)
}

type GrpcClientModelNodeService 

type GrpcClientModelNodeService interface {
	ModelBaseService
	GetNodeById(id primitive.ObjectID) (n Node, err error)
	GetNode(query bson.M, opts *mongo.FindOptions) (n Node, err error)
	GetNodeByKey(key string) (n Node, err error)
	GetNodeList(query bson.M, opts *mongo.FindOptions) (res []Node, err error)
}

type GrpcClientModelPluginService 

type GrpcClientModelPluginService interface {
	ModelBaseService
	GetPluginById(id primitive.ObjectID) (p Plugin, err error)
	GetPlugin(query bson.M, opts *mongo.FindOptions) (p Plugin, err error)
	GetPluginByName(name string) (p Plugin, err error)
	GetPluginList(query bson.M, opts *mongo.FindOptions) (res []Plugin, err error)
}

type GrpcClientModelPluginStatusService 

type GrpcClientModelPluginStatusService interface {
	ModelBaseService
	GetPluginStatusById(id primitive.ObjectID) (ps PluginStatus, err error)
	GetPluginStatus(query bson.M, opts *mongo.FindOptions) (ps PluginStatus, err error)
	GetPluginStatusList(query bson.M, opts *mongo.FindOptions) (res []PluginStatus, err error)
}

type GrpcClientModelService 

type GrpcClientModelService interface {
	WithConfigPath
	NewBaseServiceDelegate(id ModelId) (GrpcClientModelBaseService, error)
}

type GrpcClientModelSpiderService 

type GrpcClientModelSpiderService interface {
	ModelBaseService
	GetSpiderById(id primitive.ObjectID) (s Spider, err error)
	GetSpider(query bson.M, opts *mongo.FindOptions) (s Spider, err error)
	GetSpiderList(query bson.M, opts *mongo.FindOptions) (res []Spider, err error)
}

type GrpcClientModelTaskService 

type GrpcClientModelTaskService interface {
	ModelBaseService
	GetTaskById(id primitive.ObjectID) (s Task, err error)
	GetTask(query bson.M, opts *mongo.FindOptions) (s Task, err error)
	GetTaskList(query bson.M, opts *mongo.FindOptions) (res []Task, err error)
}

type GrpcClientModelTaskStatService 

type GrpcClientModelTaskStatService interface {
	ModelBaseService
	GetTaskStatById(id primitive.ObjectID) (s TaskStat, err error)
	GetTaskStat(query bson.M, opts *mongo.FindOptions) (s TaskStat, err error)
	GetTaskStatList(query bson.M, opts *mongo.FindOptions) (res []TaskStat, err error)
}

type GrpcClientPool 

type GrpcClientPool interface {
	WithConfigPath
	Init() error
	NewClient() error
	GetClient() (GrpcClient, error)
	SetSize(int)
}

type GrpcModelBaseServiceMessage 

type GrpcModelBaseServiceMessage interface {
	GetModelId() ModelId
	GetData() []byte
	ToBytes() (data []byte)
}

type GrpcModelBinder 

type GrpcModelBinder interface {
	ModelBinder
}

type GrpcModelDelegateMessage 

type GrpcModelDelegateMessage interface {
	GetModelId() ModelId
	GetMethod() ModelDelegateMethod
	GetData() []byte
	ToBytes() (data []byte)
}

type GrpcModelListBinder 

type GrpcModelListBinder interface {
	ModelListBinder
}

type GrpcServer 

type GrpcServer interface {
	GrpcBase
	SetAddress(Address)
	GetSubscribe(key string) (sub GrpcSubscribe, err error)
	SetSubscribe(key string, sub GrpcSubscribe)
	DeleteSubscribe(key string)
	SendStreamMessage(key string, code grpc.StreamMessageCode) (err error)
	SendStreamMessageWithData(nodeKey string, code grpc.StreamMessageCode, d interface{}) (err error)
	IsStopped() (res bool)
}

type GrpcStream 

type GrpcStream interface {
	Send(msg *grpc.StreamMessage) (err error)
}

type GrpcStreamBidirectional 

type GrpcStreamBidirectional interface {
	GrpcStream
	Recv() (msg *grpc.StreamMessage, err error)
}

type GrpcSubscribe 

type GrpcSubscribe interface {
	GetStream() GrpcStream
	GetStreamBidirectional() GrpcStreamBidirectional
	GetFinished() chan bool
}

type I18nService 

type I18nService interface {
	AddTranslations(t []Translation)
	GetTranslations() (t []Translation)
}

type Injectable 

type Injectable interface {
	Inject() error
}

type List 

type List interface {
	GetModels() (res []Model)
}

type Model 

type Model interface {
	GetId() (id primitive.ObjectID)
	SetId(id primitive.ObjectID)
}

type ModelArtifact 

type ModelArtifact interface {
	Model
	GetSys() (sys ModelArtifactSys)
	GetTagIds() (ids []primitive.ObjectID)
	SetTagIds(ids []primitive.ObjectID)
	SetObj(obj Model)
	SetDel(del bool)
}

type ModelArtifactSys 

type ModelArtifactSys interface {
	GetCreateTs() time.Time
	SetCreateTs(ts time.Time)
	GetUpdateTs() time.Time
	SetUpdateTs(ts time.Time)
	GetDeleteTs() time.Time
	SetDeleteTs(ts time.Time)
	GetCreateUid() primitive.ObjectID
	SetCreateUid(id primitive.ObjectID)
	GetUpdateUid() primitive.ObjectID
	SetUpdateUid(id primitive.ObjectID)
	GetDeleteUid() primitive.ObjectID
	SetDeleteUid(id primitive.ObjectID)
}

type ModelBaseService 

type ModelBaseService interface {
	GetModelId() (id ModelId)
	SetModelId(id ModelId)
	GetById(id primitive.ObjectID) (res Model, err error)
	Get(query bson.M, opts *mongo.FindOptions) (res Model, err error)
	GetList(query bson.M, opts *mongo.FindOptions) (res List, err error)
	DeleteById(id primitive.ObjectID, args ...interface{}) (err error)
	Delete(query bson.M, args ...interface{}) (err error)
	DeleteList(query bson.M, args ...interface{}) (err error)
	ForceDeleteList(query bson.M, args ...interface{}) (err error)
	UpdateById(id primitive.ObjectID, update bson.M, args ...interface{}) (err error)
	Update(query bson.M, update bson.M, fields []string, args ...interface{}) (err error)
	UpdateDoc(query bson.M, doc Model, fields []string, args ...interface{}) (err error)
	Insert(u User, docs ...interface{}) (err error)
	Count(query bson.M) (total int, err error)
}

type ModelBinder 

type ModelBinder interface {
	Bind() (res Model, err error)
	Process(d Model) (res Model, err error)
}

type ModelDelegate 

type ModelDelegate interface {
	Add() error
	Save() error
	Delete() error
	GetArtifact() (ModelArtifact, error)
	GetModel() Model
	Refresh() error
	ToBytes(interface{}) ([]byte, error)
}

type ModelDelegateMethod 

type ModelDelegateMethod string

type ModelId 

type ModelId int

type ModelListBinder 

type ModelListBinder interface {
	Bind() (l List, err error)
	Process(d interface{}) (l List, err error)
}

type ModelNodeDelegate 

type ModelNodeDelegate interface {
	ModelDelegate
	UpdateStatus(active bool, activeTs *time.Time, status string) (err error)
	UpdateStatusOnline() (err error)
	UpdateStatusOffline() (err error)
}

type ModelService 

type ModelService interface {
	GetBaseService(id ModelId) (svc ModelBaseService)
}

type ModelWithKey added in v0.6.1 

type ModelWithKey interface {
	Model
	GetKey() (key string)
	SetKey(key string)
}

type ModelWithNameDescription added in v0.6.1 

type ModelWithNameDescription interface {
	Model
	GetName() (name string)
	SetName(name string)
	GetDescription() (description string)
	SetDescription(description string)
}

type ModelWithTags 

type ModelWithTags interface {
	Model
	SetTags(tags []Tag)
	GetTags() (tags []Tag)
}

type Module 

type Module interface {
	Init() error
	Start()
	Wait()
	Stop()
}

type ModuleId 

type ModuleId int

type Node 

type Node interface {
	ModelWithNameDescription
	GetKey() (key string)
	GetIsMaster() (ok bool)
	GetActive() (active bool)
	SetActive(active bool)
	SetActiveTs(activeTs time.Time)
	GetStatus() (status string)
	SetStatus(status string)
	GetEnabled() (enabled bool)
	SetEnabled(enabled bool)
	GetAvailableRunners() (runners int)
	SetAvailableRunners(runners int)
	GetMaxRunners() (runners int)
	SetMaxRunners(runners int)
	IncrementAvailableRunners()
	DecrementAvailableRunners()
}

type NodeConfigService 

type NodeConfigService interface {
	WithConfigPath
	Init() error
	Reload() error
	GetBasicNodeInfo() Entity
	GetNodeKey() string
	GetNodeName() string
	IsMaster() bool
	GetAuthKey() string
	GetMaxRunners() int
}

type NodeMasterService 

type NodeMasterService interface {
	NodeService
	Monitor()
	SetMonitorInterval(duration time.Duration)
	Register() error
	StopOnError()
	GetServer() GrpcServer
}

type NodeService 

type NodeService interface {
	Module
	WithConfigPath
	WithAddress
	GetConfigService() NodeConfigService
}

type NodeServiceOption 

type NodeServiceOption interface {
}

type NodeWorkerService 

type NodeWorkerService interface {
	NodeService
	Register()
	Recv()
	ReportStatus()
	SetHeartbeatInterval(duration time.Duration)
}

type Permission added in v0.6.1 

type Permission interface {
	ModelWithKey
	ModelWithNameDescription
	GetType() (t string)
	SetType(t string)
	GetTarget() (target []string)
	SetTarget(target []string)
	GetAllow() (allow []string)
	SetAllow(allow []string)
	GetDeny() (deny []string)
	SetDeny(deny []string)
}

type Plugin 

type Plugin interface {
	ModelWithNameDescription
	GetShortName() (shortName string)
	SetShortName(shortName string)
	GetFullName() (fullName string)
	SetFullName(fullName string)
	GetInstallUrl() (url string)
	SetInstallUrl(url string)
	GetInstallType() (t string)
	SetInstallType(t string)
	GetInstallCmd() (cmd string)
	SetInstallCmd(cmd string)
}

type PluginFsService 

type PluginFsService interface {
	WithConfigPath
	Init() (err error)
	SetId(id primitive.ObjectID)
	GetFsPath() (res string)
	GetWorkspacePath() (res string)
	SetFsPathBase(path string)
	SetWorkspacePathBase(path string)
	GetFsService() (fsSvc FsService)
}

type PluginService 

type PluginService interface {
	Module
	SetFsPathBase(path string)
	SetMonitorInterval(interval time.Duration)
	InstallPlugin(id primitive.ObjectID) (err error)
	UninstallPlugin(id primitive.ObjectID) (err error)
	StartPlugin(id primitive.ObjectID) (err error)
	StopPlugin(id primitive.ObjectID) (err error)
	GetPublicPluginList() (res interface{}, err error)
	GetPublicPluginInfo(fullName string) (res interface{}, err error)
}

type PluginStatus 

type PluginStatus interface {
	Model
	GetPluginId() (id primitive.ObjectID)
	SetPluginId(id primitive.ObjectID)
	GetNodeId() (id primitive.ObjectID)
	SetNodeId(id primitive.ObjectID)
	GetStatus() (status string)
	SetStatus(status string)
	GetPid() (pid int)
	SetPid(pid int)
	GetError() (e string)
	SetError(e string)
}

type ProcessDaemon 

type ProcessDaemon interface {
	Start() (err error)
	Stop()
	GetMaxErrors() (maxErrors int)
	SetMaxErrors(maxErrors int)
	GetExitTimeout() (timeout time.Duration)
	SetExitTimeout(timeout time.Duration)
	GetCmd() (cmd *exec.Cmd)
	GetCh() (ch chan int)
}

type Provide 

type Provide func(env string)

type Result 

type Result interface {
	Value() map[string]interface{}
	SetValue(key string, value interface{})
	GetValue(key string) (value interface{})
	GetTaskId() (id primitive.ObjectID)
	SetTaskId(id primitive.ObjectID)
}

type ResultService 

type ResultService interface {
	Insert(records ...interface{}) (err error)
	List(query generic.ListQuery, opts *generic.ListOptions) (results []interface{}, err error)
	Count(query generic.ListQuery) (n int, err error)
	Index(fields []string)
	SetTime(t time.Time)
	GetTime() (t time.Time)
}

type ResultServiceMongo 

type ResultServiceMongo interface {
	GetId() (id primitive.ObjectID)
	SetId(id primitive.ObjectID)
	List(query bson.M, opts *mongo.FindOptions) (results []Result, err error)
	Count(query bson.M) (total int, err error)
	Insert(docs ...interface{}) (err error)
}

type ResultServiceRegistry 

type ResultServiceRegistry interface {
	Register(key string, fn ResultServiceRegistryFn)
	Unregister(key string)
	Get(key string) (fn ResultServiceRegistryFn)
}

type ResultServiceRegistryFn 

type ResultServiceRegistryFn func(colId primitive.ObjectID, dsId primitive.ObjectID) (ResultService, error)

type Role added in v0.6.1 

type Role interface {
	ModelWithKey
	ModelWithNameDescription
}

type Schedule 

type Schedule interface {
	Model
	GetEnabled() (enabled bool)
	SetEnabled(enabled bool)
	GetEntryId() (id cron.EntryID)
	SetEntryId(id cron.EntryID)
	GetCron() (c string)
	SetCron(c string)
	GetSpiderId() (id primitive.ObjectID)
	SetSpiderId(id primitive.ObjectID)
	GetMode() (mode string)
	SetMode(mode string)
	GetNodeIds() (ids []primitive.ObjectID)
	SetNodeIds(ids []primitive.ObjectID)
	GetCmd() (cmd string)
	SetCmd(cmd string)
	GetParam() (param string)
	SetParam(param string)
	GetPriority() (p int)
	SetPriority(p int)
}

type ScheduleService 

type ScheduleService interface {
	WithConfigPath
	Module
	GetLocation() (loc *time.Location)
	SetLocation(loc *time.Location)
	GetDelay() (delay bool)
	SetDelay(delay bool)
	GetSkip() (skip bool)
	SetSkip(skip bool)
	GetUpdateInterval() (interval time.Duration)
	SetUpdateInterval(interval time.Duration)
	Enable(s Schedule, args ...interface{}) (err error)
	Disable(s Schedule, args ...interface{}) (err error)
	Update()
	GetCron() (c *cron.Cron)
}

type ServiceCrudOption 

type ServiceCrudOption func(o *ServiceCrudOptions)

func WithNotSyncToWorkspace 

func WithNotSyncToWorkspace() ServiceCrudOption

func WithOnlyFromWorkspace 

func WithOnlyFromWorkspace() ServiceCrudOption

type ServiceCrudOptions 

type ServiceCrudOptions struct {
	IsAbsolute         bool // whether the path is absolute
	OnlyFromWorkspace  bool // whether only sync from workspace
	NotSyncToWorkspace bool // whether not sync to workspace
}

type Spider 

type Spider interface {
	ModelWithNameDescription
	GetType() (ty string)
	GetMode() (mode string)
	SetMode(mode string)
	GetNodeIds() (ids []primitive.ObjectID)
	SetNodeIds(ids []primitive.ObjectID)
	GetCmd() (cmd string)
	SetCmd(cmd string)
	GetParam() (param string)
	SetParam(param string)
	GetPriority() (p int)
	SetPriority(p int)
	GetColId() (id primitive.ObjectID)
	SetColId(id primitive.ObjectID)
}

type SpiderAdminService 

type SpiderAdminService interface {
	WithConfigPath
	Start() (err error)
	// Schedule a new task of the spider
	Schedule(id primitive.ObjectID, opts *SpiderRunOptions) (taskIds []primitive.ObjectID, err error)
	// Clone the spider
	Clone(id primitive.ObjectID, opts *SpiderCloneOptions) (err error)
	// Delete the spider
	Delete(id primitive.ObjectID) (err error)
	// SyncGit syncs the git repository of the spider
	SyncGit() (err error)
}

type SpiderCloneOptions 

type SpiderCloneOptions struct {
	Name string
}

type SpiderFsService 

type SpiderFsService interface {
	WithConfigPath
	Init() (err error)
	SetId(id primitive.ObjectID)
	List(path string) (files []FsFileInfo, err error)
	GetFile(path string) (data []byte, err error)
	GetFileInfo(path string) (file FsFileInfo, err error)
	Exists(path string) (ok bool)
	Save(path string, data []byte) (err error)
	Rename(path, newPath string) (err error)
	Delete(path string) (err error)
	Copy(path, newPath string) (err error)
	Commit(msg string) (err error)
	GetFsPath() (res string)
	GetWorkspacePath() (res string)
	GetRepoPath() (res string)
	SetFsPathBase(path string)
	SetWorkspacePathBase(path string)
	SetRepoPathBase(path string)
	GetFsService() (fsSvc FsService)
}

type SpiderRunOptions 

type SpiderRunOptions struct {
	Mode       string               `json:"mode"`
	NodeIds    []primitive.ObjectID `json:"node_ids"`
	Cmd        string               `json:"cmd"`
	Param      string               `json:"param"`
	ScheduleId primitive.ObjectID   `json:"schedule_id"`
	Priority   int                  `json:"priority"`
	UserId     primitive.ObjectID   `json:"-"`
}

type SpiderSyncService 

type SpiderSyncService interface {
	WithConfigPath
	SetFsPathBase(path string)
	SetWorkspacePathBase(path string)
	SetRepoPathBase(path string)
	GetFsService(id primitive.ObjectID) (fsSvc SpiderFsService, err error)
	ForceGetFsService(id primitive.ObjectID) (fsSvc SpiderFsService, err error)
	SyncToFs(id primitive.ObjectID) (err error)
	SyncToWorkspace(id primitive.ObjectID) (err error)
}

type StatsService 

type StatsService interface {
	GetOverviewStats(query bson.M) (data interface{}, err error)
	GetDailyStats(query bson.M) (data interface{}, err error)
	GetTaskStats(query bson.M) (data interface{}, err error)
}

type Tag 

type Tag interface {
	Model
	GetName() string
	GetColor() string
	SetCol(string)
}

type Task 

type Task interface {
	Model
	GetNodeId() (id primitive.ObjectID)
	SetNodeId(id primitive.ObjectID)
	GetNodeIds() (ids []primitive.ObjectID)
	GetStatus() (status string)
	SetStatus(status string)
	GetError() (error string)
	SetError(error string)
	GetPid() (pid int)
	SetPid(pid int)
	GetSpiderId() (id primitive.ObjectID)
	GetType() (ty string)
	GetCmd() (cmd string)
	GetParam() (param string)
	GetPriority() (p int)
	GetUserId() (id primitive.ObjectID)
	SetUserId(id primitive.ObjectID)
}

type TaskBaseService 

type TaskBaseService interface {
	WithConfigPath
	Module
	SaveTask(t Task, status string) (err error)
	IsStopped() (res bool)
	GetQueue(nodeId primitive.ObjectID) (queue string)
}

type TaskFsService added in v0.6.1 

type TaskFsService interface {
	Init() (err error)
	GetFsPath() (res string)
	GetWorkspacePath() (res string)
	GetRepoPath() (res string)
	SetFsPathBase(path string)
	SetWorkspacePathBase(path string)
	SetRepoPathBase(path string)
	GetFsService() (fsSvc FsService)
}

type TaskHandlerService 

type TaskHandlerService interface {
	TaskBaseService
	// Run task and execute locally
	Run(taskId primitive.ObjectID) (err error)
	// Cancel task locally
	Cancel(taskId primitive.ObjectID) (err error)
	// Fetch tasks and run
	Fetch()
	// ReportStatus periodically report handler status to master
	ReportStatus()
	// Reset reset internals to default
	Reset()
	// IsSyncLocked whether the given task is locked for files sync
	IsSyncLocked(path string) (ok bool)
	// LockSync lock files sync for given task
	LockSync(path string)
	// UnlockSync unlock files sync for given task
	UnlockSync(path string)
	// GetExitWatchDuration get max runners
	GetExitWatchDuration() (duration time.Duration)
	// SetExitWatchDuration set max runners
	SetExitWatchDuration(duration time.Duration)
	// GetFetchInterval get report interval
	GetFetchInterval() (interval time.Duration)
	// SetFetchInterval set report interval
	SetFetchInterval(interval time.Duration)
	// GetReportInterval get report interval
	GetReportInterval() (interval time.Duration)
	// SetReportInterval set report interval
	SetReportInterval(interval time.Duration)
	// GetCancelTimeout get report interval
	GetCancelTimeout() (timeout time.Duration)
	// SetCancelTimeout set report interval
	SetCancelTimeout(timeout time.Duration)
	// GetModelService get model service
	GetModelService() (modelSvc GrpcClientModelService)
	// GetModelSpiderService get model spider service
	GetModelSpiderService() (modelSpiderSvc GrpcClientModelSpiderService)
	// GetModelTaskService get model task service
	GetModelTaskService() (modelTaskSvc GrpcClientModelTaskService)
	// GetModelTaskStatService get model task stat service
	GetModelTaskStatService() (modelTaskStatSvc GrpcClientModelTaskStatService)
	// GetModelEnvironmentService get model environment service
	GetModelEnvironmentService() (modelEnvironmentSvc GrpcClientModelEnvironmentService)
	// GetNodeConfigService get node config service
	GetNodeConfigService() (cfgSvc NodeConfigService)
	// GetCurrentNode get node of the handler
	GetCurrentNode() (n Node, err error)
	// GetTaskById get task by id
	GetTaskById(id primitive.ObjectID) (t Task, err error)
	// GetSpiderById get task by id
	GetSpiderById(id primitive.ObjectID) (t Spider, err error)
}

type TaskRunner 

type TaskRunner interface {
	Init() (err error)
	Run() (err error)
	Cancel() (err error)
	Dispose() (err error)
	SetSubscribeTimeout(timeout time.Duration)
	GetTaskId() (id primitive.ObjectID)
	CleanUp() (err error)
}

type TaskSchedulerService 

type TaskSchedulerService interface {
	TaskBaseService
	// Enqueue task into the task queue
	Enqueue(t Task) (t2 Task, err error)
	// Cancel task to corresponding node
	Cancel(id primitive.ObjectID, args ...interface{}) (err error)
	// SetInterval set the interval or duration between two adjacent fetches
	SetInterval(interval time.Duration)
}

type TaskStat 

type TaskStat interface {
	Model
	GetCreateTs() (ts time.Time)
	SetCreateTs(ts time.Time)
	GetStartTs() (ts time.Time)
	SetStartTs(ts time.Time)
	GetEndTs() (ts time.Time)
	SetEndTs(ts time.Time)
	GetWaitDuration() (d int64)
	SetWaitDuration(d int64)
	GetRuntimeDuration() (d int64)
	SetRuntimeDuration(d int64)
	GetTotalDuration() (d int64)
	SetTotalDuration(d int64)
	GetResultCount() (c int64)
	SetResultCount(c int64)
	GetErrorLogCount() (c int64)
	SetErrorLogCount(c int64)
}

type TaskStatsService 

type TaskStatsService interface {
	TaskBaseService
	InsertData(id primitive.ObjectID, records ...interface{}) (err error)
	InsertLogs(id primitive.ObjectID, logs ...string) (err error)
}

type Test 

type Test interface {
	Setup(*testing.T)
	Cleanup()
}

type Translation 

type Translation interface {
	GetLang() (l string)
}

type User 

type User interface {
	Model
	GetUsername() (name string)
	GetPassword() (p string)
	GetRole() (r string)
	GetEmail() (email string)
}

type UserCreateOptions 

type UserCreateOptions struct {
	Username string
	Password string
	Email    string
	Role     string
}

type UserGroup added in v0.6.1 

type UserGroup interface {
	Model
	GetUsers() (users []User, err error)
}

type UserLoginOptions 

type UserLoginOptions struct {
	Username string
	Password string
}

type UserService 

type UserService interface {
	Init() (err error)
	SetJwtSecret(secret string)
	SetJwtSigningMethod(method jwt.SigningMethod)
	Create(opts *UserCreateOptions, args ...interface{}) (err error)
	Login(opts *UserLoginOptions) (token string, u User, err error)
	CheckToken(token string) (u User, err error)
	ChangePassword(id primitive.ObjectID, password string, args ...interface{}) (err error)
	MakeToken(user User) (tokenStr string, err error)
	GetCurrentUser(c *gin.Context) (u User, err error)
}

type WithAddress 

type WithAddress interface {
	GetAddress() (address Address)
	SetAddress(address Address)
}

type WithConfigPath 

type WithConfigPath interface {
	GetConfigPath() (path string)
	SetConfigPath(path string)
}

type WithModelId 

type WithModelId interface {
	GetModelId() (id ModelId)
	SetModelId(id ModelId)
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.