mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-05-20 17:28:51 +00:00
2d66cfcce2
All the client functions were in a single file, which was already very long, and the test file gets even longer as more tests are added. I split it into separate files representing the API path and started adding some tests.
276 lines
9.6 KiB
Go
276 lines
9.6 KiB
Go
// Copyright 2022 Woodpecker 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 woodpecker
|
|
|
|
type (
|
|
// User represents a user account.
|
|
User struct {
|
|
ID int64 `json:"id"`
|
|
Login string `json:"login"`
|
|
Email string `json:"email"`
|
|
Avatar string `json:"avatar_url"`
|
|
Active bool `json:"active"`
|
|
Admin bool `json:"admin"`
|
|
}
|
|
|
|
// Repo represents a repository.
|
|
Repo struct {
|
|
ID int64 `json:"id,omitempty"`
|
|
ForgeRemoteID string `json:"forge_remote_id"`
|
|
Owner string `json:"owner"`
|
|
Name string `json:"name"`
|
|
FullName string `json:"full_name"`
|
|
Avatar string `json:"avatar_url,omitempty"`
|
|
ForgeURL string `json:"forge_url,omitempty"`
|
|
Clone string `json:"clone_url,omitempty"`
|
|
DefaultBranch string `json:"default_branch,omitempty"`
|
|
SCMKind string `json:"scm,omitempty"`
|
|
Timeout int64 `json:"timeout,omitempty"`
|
|
Visibility string `json:"visibility"`
|
|
IsSCMPrivate bool `json:"private"`
|
|
IsTrusted bool `json:"trusted"`
|
|
IsGated bool `json:"gated"`
|
|
IsActive bool `json:"active"`
|
|
AllowPullRequests bool `json:"allow_pr"`
|
|
Config string `json:"config_file"`
|
|
CancelPreviousPipelineEvents []string `json:"cancel_previous_pipeline_events"`
|
|
NetrcOnlyTrusted bool `json:"netrc_only_trusted"`
|
|
}
|
|
|
|
// RepoPatch defines a repository patch request.
|
|
RepoPatch struct {
|
|
Config *string `json:"config_file,omitempty"`
|
|
IsTrusted *bool `json:"trusted,omitempty"`
|
|
IsGated *bool `json:"gated,omitempty"`
|
|
Timeout *int64 `json:"timeout,omitempty"`
|
|
Visibility *string `json:"visibility"`
|
|
AllowPull *bool `json:"allow_pr,omitempty"`
|
|
PipelineCounter *int `json:"pipeline_counter,omitempty"`
|
|
}
|
|
|
|
PipelineError struct {
|
|
Type string `json:"type"`
|
|
Message string `json:"message"`
|
|
IsWarning bool `json:"is_warning"`
|
|
Data any `json:"data"`
|
|
}
|
|
|
|
// Pipeline defines a pipeline object.
|
|
Pipeline struct {
|
|
ID int64 `json:"id"`
|
|
Number int64 `json:"number"`
|
|
Parent int64 `json:"parent"`
|
|
Event string `json:"event"`
|
|
Status string `json:"status"`
|
|
Errors []*PipelineError `json:"errors"`
|
|
// Deprecated TODO remove in 3.x
|
|
Enqueued int64 `json:"enqueued_at"`
|
|
Created int64 `json:"created_at"`
|
|
Updated int64 `json:"updated_at"`
|
|
Started int64 `json:"started_at"`
|
|
Finished int64 `json:"finished_at"`
|
|
Deploy string `json:"deploy_to"`
|
|
Commit string `json:"commit"`
|
|
Branch string `json:"branch"`
|
|
Ref string `json:"ref"`
|
|
Refspec string `json:"refspec"`
|
|
CloneURL string `json:"clone_url"`
|
|
Title string `json:"title"`
|
|
Message string `json:"message"`
|
|
Timestamp int64 `json:"timestamp"`
|
|
Sender string `json:"sender"`
|
|
Author string `json:"author"`
|
|
Avatar string `json:"author_avatar"`
|
|
Email string `json:"author_email"`
|
|
ForgeURL string `json:"forge_url"`
|
|
Reviewer string `json:"reviewed_by"`
|
|
Reviewed int64 `json:"reviewed_at"`
|
|
Workflows []*Workflow `json:"workflows,omitempty"`
|
|
}
|
|
|
|
// Workflow represents a workflow in the pipeline.
|
|
Workflow struct {
|
|
ID int64 `json:"id"`
|
|
PID int `json:"pid"`
|
|
Name string `json:"name"`
|
|
State string `json:"state"`
|
|
Error string `json:"error,omitempty"`
|
|
Started int64 `json:"start_time,omitempty"`
|
|
Stopped int64 `json:"end_time,omitempty"`
|
|
AgentID int64 `json:"agent_id,omitempty"`
|
|
Platform string `json:"platform,omitempty"`
|
|
Environ map[string]string `json:"environ,omitempty"`
|
|
Children []*Step `json:"children,omitempty"`
|
|
}
|
|
|
|
// Step represents a process in the pipeline.
|
|
Step struct {
|
|
ID int64 `json:"id"`
|
|
PID int `json:"pid"`
|
|
PPID int `json:"ppid"`
|
|
Name string `json:"name"`
|
|
State string `json:"state"`
|
|
Error string `json:"error,omitempty"`
|
|
ExitCode int `json:"exit_code"`
|
|
Started int64 `json:"start_time,omitempty"`
|
|
Stopped int64 `json:"end_time,omitempty"`
|
|
Type StepType `json:"type,omitempty"`
|
|
}
|
|
|
|
// Registry represents a docker registry with credentials.
|
|
Registry struct {
|
|
ID int64 `json:"id"`
|
|
Address string `json:"address"`
|
|
Username string `json:"username"`
|
|
Password string `json:"password,omitempty"`
|
|
// Deprecated
|
|
Email string `json:"email"` // TODO remove in 3.x
|
|
// Deprecated
|
|
Token string `json:"token"` // TODO remove in 3.x
|
|
}
|
|
|
|
// Secret represents a secret variable, such as a password or token.
|
|
Secret struct {
|
|
ID int64 `json:"id"`
|
|
OrgID int64 `json:"org_id"`
|
|
RepoID int64 `json:"repo_id"`
|
|
Name string `json:"name"`
|
|
Value string `json:"value,omitempty"`
|
|
Images []string `json:"images"`
|
|
Events []string `json:"events"`
|
|
}
|
|
|
|
// Feed represents an item in the user's feed or timeline.
|
|
Feed struct {
|
|
RepoID int64 `json:"repo_id"`
|
|
ID int64 `json:"id,omitempty"`
|
|
Number int64 `json:"number,omitempty"`
|
|
Event string `json:"event,omitempty"`
|
|
Status string `json:"status,omitempty"`
|
|
Created int64 `json:"created_at,omitempty"`
|
|
Started int64 `json:"started_at,omitempty"`
|
|
Finished int64 `json:"finished_at,omitempty"`
|
|
Commit string `json:"commit,omitempty"`
|
|
Branch string `json:"branch,omitempty"`
|
|
Ref string `json:"ref,omitempty"`
|
|
Refspec string `json:"refspec,omitempty"`
|
|
Remote string `json:"remote,omitempty"`
|
|
Title string `json:"title,omitempty"`
|
|
Message string `json:"message,omitempty"`
|
|
Author string `json:"author,omitempty"`
|
|
Avatar string `json:"author_avatar,omitempty"`
|
|
Email string `json:"author_email,omitempty"`
|
|
}
|
|
|
|
// Version provides system version details.
|
|
Version struct {
|
|
Source string `json:"source,omitempty"`
|
|
Version string `json:"version,omitempty"`
|
|
Commit string `json:"commit,omitempty"`
|
|
}
|
|
|
|
// QueueStats struct {
|
|
// Workers int `json:"worker_count"`
|
|
// Pending int `json:"pending_count"`
|
|
// WaitingOnDeps int `json:"waiting_on_deps_count"`
|
|
// Running int `json:"running_count"`
|
|
// Complete int `json:"completed_count"`
|
|
// }
|
|
|
|
// Info provides queue stats.
|
|
Info struct {
|
|
Pending []Task `json:"pending"`
|
|
WaitingOnDeps []Task `json:"waiting_on_deps"`
|
|
Running []Task `json:"running"`
|
|
// TODO use dedicated struct in 3.x
|
|
// Stats QueueStats `json:"stats"`
|
|
Stats struct {
|
|
Workers int `json:"worker_count"`
|
|
Pending int `json:"pending_count"`
|
|
WaitingOnDeps int `json:"waiting_on_deps_count"`
|
|
Running int `json:"running_count"`
|
|
Complete int `json:"completed_count"`
|
|
} `json:"stats"`
|
|
Paused bool `json:"paused,omitempty"`
|
|
}
|
|
|
|
// LogLevel is for checking/setting logging level.
|
|
LogLevel struct {
|
|
Level string `json:"log-level"`
|
|
}
|
|
|
|
// LogEntry is a single log entry
|
|
LogEntry struct {
|
|
ID int64 `json:"id"`
|
|
StepID int64 `json:"step_id"`
|
|
Time int64 `json:"time"`
|
|
Line int `json:"line"`
|
|
Data []byte `json:"data"`
|
|
Type LogEntryType `json:"type"`
|
|
}
|
|
|
|
// Cron is the JSON data of a cron job.
|
|
Cron struct {
|
|
ID int64 `json:"id"`
|
|
Name string `json:"name"`
|
|
RepoID int64 `json:"repo_id"`
|
|
CreatorID int64 `json:"creator_id"`
|
|
NextExec int64 `json:"next_exec"`
|
|
Schedule string `json:"schedule"`
|
|
Created int64 `json:"created_at"`
|
|
Branch string `json:"branch"`
|
|
}
|
|
|
|
// PipelineOptions is the JSON data for creating a new pipeline.
|
|
PipelineOptions struct {
|
|
Branch string `json:"branch"`
|
|
Variables map[string]string `json:"variables"`
|
|
}
|
|
|
|
// Agent is the JSON data for an agent.
|
|
Agent struct {
|
|
ID int64 `json:"id"`
|
|
Created int64 `json:"created"`
|
|
Updated int64 `json:"updated"`
|
|
Name string `json:"name"`
|
|
OwnerID int64 `json:"owner_id"`
|
|
Token string `json:"token"`
|
|
LastContact int64 `json:"last_contact"`
|
|
Platform string `json:"platform"`
|
|
Backend string `json:"backend"`
|
|
Capacity int32 `json:"capacity"`
|
|
Version string `json:"version"`
|
|
NoSchedule bool `json:"no_schedule"`
|
|
}
|
|
|
|
// Task is the JSON data for a task.
|
|
Task struct {
|
|
ID string `json:"id"`
|
|
Data []byte `json:"data"`
|
|
Labels map[string]string `json:"labels"`
|
|
Dependencies []string `json:"dependencies"`
|
|
RunOn []string `json:"run_on"`
|
|
DepStatus map[string]string `json:"dep_status"`
|
|
AgentID int64 `json:"agent_id"`
|
|
}
|
|
|
|
// Org is the JSON data for an organization.
|
|
Org struct {
|
|
ID int64 `json:"id"`
|
|
Name string `json:"name"`
|
|
IsUser bool `json:"is_user"`
|
|
}
|
|
)
|