Documentation ¶
Overview ¶
Gojenkins is a Jenkins Client in Go, that exposes the jenkins REST api in a more developer friendly way.
Index ¶
- Constants
- Variables
- func CheckResponse(r *http.Response) error
- func Reverse(s string) string
- type APIRequest
- type Artifact
- type BasicAuth
- type Build
- func (b *Build) GetActions() []GeneralObj
- func (b *Build) GetAllFingerPrints() []*FingerPrint
- func (b *Build) GetArtifacts() []Artifact
- func (b *Build) GetBuildNumber() int64
- func (b *Build) GetCauses() ([]map[string]interface{}, error)
- func (b *Build) GetConsoleOutput() string
- func (b *Build) GetCulprits() []Culprit
- func (b *Build) GetDownstreamBuilds() ([]*Build, error)
- func (b *Build) GetDownstreamJobNames() []string
- func (b *Build) GetDuration() int64
- func (b *Build) GetInjectedEnvVars() (map[string]string, error)
- func (b *Build) GetMatrixRuns() ([]*Build, error)
- func (b *Build) GetParameters() []parameter
- func (b *Build) GetResult() string
- func (b *Build) GetResultSet() (*TestResult, error)
- func (b *Build) GetRevision() string
- func (b *Build) GetRevisionBranch() string
- func (b *Build) GetTimestamp() time.Time
- func (b *Build) GetUpstreamBuild() (*Build, error)
- func (b *Build) GetUpstreamBuildNumber() (int64, error)
- func (b *Build) GetUpstreamJob() (*Job, error)
- func (b *Build) GetUrl() string
- func (b *Build) Info() *BuildResponse
- func (b *Build) IsGood() bool
- func (b *Build) IsRunning() bool
- func (b *Build) PauseToggle() error
- func (b *Build) Poll(options ...interface{}) (int, error)
- func (b *Build) SetDescription(description string) error
- func (b *Build) Stop() (bool, error)
- type BuildResponse
- type BuildRevision
- type Builds
- type Computers
- type CreateKubeconfigCredentialRequest
- type CreateSecretTextCredentialRequest
- type CreateSshCredentialRequest
- type CreateUsernamePasswordCredentialRequest
- type CredentialResponse
- type Culprit
- type ErrorResponse
- type Executor
- type ExecutorResponse
- type FingerPrint
- type FingerPrintResponse
- type Folder
- type FolderResponse
- type GeneralObj
- type GlobalPermissionIds
- type GlobalRole
- type GlobalRoleResponse
- type History
- type InnerJob
- type Jenkins
- func (j *Jenkins) AddGlobalRole(roleName string, ids GlobalPermissionIds, overwrite bool) (*GlobalRole, error)
- func (j *Jenkins) AddProjectRole(roleName string, pattern string, ids ProjectPermissionIds, overwrite bool) (*ProjectRole, error)
- func (j *Jenkins) BuildJob(name string, options ...interface{}) (int64, error)
- func (j *Jenkins) CopyJob(copyFrom string, newName string) (*Job, error)
- func (j *Jenkins) CreateFolder(name, description string, parents ...string) (*Folder, error)
- func (j *Jenkins) CreateJob(config string, options ...interface{}) (*Job, error)
- func (j *Jenkins) CreateJobInFolder(config string, jobName string, parentIDs ...string) (*Job, error)
- func (j *Jenkins) CreateKubeconfigCredentialInFolder(domain, id, content, description string, folders ...string) (*string, error)
- func (j *Jenkins) CreateNode(name string, numExecutors int, description string, remoteFS string, ...) (*Node, error)
- func (j *Jenkins) CreateSecretTextCredentialInFolder(domain, id, secret, description string, folders ...string) (*string, error)
- func (j *Jenkins) CreateSshCredential(id, username, passphrase, privateKey, description string) (*string, error)
- func (j *Jenkins) CreateSshCredentialInFolder(domain, id, username, passphrase, privateKey, description string, ...) (*string, error)
- func (j *Jenkins) CreateUsernamePasswordCredential(id, username, password, description string) (*string, error)
- func (j *Jenkins) CreateUsernamePasswordCredentialInFolder(domain, id, username, password, description string, folders ...string) (*string, error)
- func (j *Jenkins) CreateView(name string, viewType string) (*View, error)
- func (j *Jenkins) DeleteCredentialInFolder(domain, id string, folders ...string) (*string, error)
- func (j *Jenkins) DeleteJob(name string, parentIDs ...string) (bool, error)
- func (j *Jenkins) DeleteNode(name string) (bool, error)
- func (j *Jenkins) DeleteProjectRoles(roleName ...string) error
- func (j *Jenkins) GetAllBuildIds(job string) ([]JobBuild, error)
- func (j *Jenkins) GetAllBuildStatus(jobId string) ([]JobBuildStatus, error)
- func (j *Jenkins) GetAllJobNames() ([]InnerJob, error)
- func (j *Jenkins) GetAllJobs() ([]*Job, error)
- func (j *Jenkins) GetAllNodes() ([]*Node, error)
- func (j *Jenkins) GetAllViews() ([]*View, error)
- func (j *Jenkins) GetArtifactData(id string) (*FingerPrintResponse, error)
- func (j *Jenkins) GetBuild(jobName string, number int64) (*Build, error)
- func (j *Jenkins) GetCredentialContentInFolder(domain, id string, folders ...string) (string, error)
- func (j *Jenkins) GetCredentialInFolder(domain, id string, folders ...string) (*CredentialResponse, error)
- func (j *Jenkins) GetCredentialsInFolder(domain string, folders ...string) ([]*CredentialResponse, error)
- func (j *Jenkins) GetFolder(id string, parents ...string) (*Folder, error)
- func (j *Jenkins) GetGlobalRole(roleName string) (*GlobalRole, error)
- func (j *Jenkins) GetJob(id string, parentIDs ...string) (*Job, error)
- func (j *Jenkins) GetLabel(name string) (*Label, error)
- func (j *Jenkins) GetNode(name string) (*Node, error)
- func (j *Jenkins) GetPlugins(depth int) (*Plugins, error)
- func (j *Jenkins) GetProjectRole(roleName string) (*ProjectRole, error)
- func (j *Jenkins) GetQueue() (*Queue, error)
- func (j *Jenkins) GetQueueItem(number int64) (*QueueItemResponse, error)
- func (j *Jenkins) GetQueueUrl() string
- func (j *Jenkins) GetSubJob(parentId string, childId string) (*Job, error)
- func (j *Jenkins) GetView(name string) (*View, error)
- func (j *Jenkins) HasPlugin(name string) (*Plugin, error)
- func (j *Jenkins) Info() (*ExecutorResponse, error)
- func (j *Jenkins) Init() (*Jenkins, error)
- func (j *Jenkins) JenkinsfileToPipelineJson(jenkinsfile string) (*JenkinsfileToPipelineJsonResponse, error)
- func (j *Jenkins) PipelineJsonToJenkinsfile(json string) (*PipelineJsonToJenkinsfileResponse, error)
- func (j *Jenkins) Poll() (int, error)
- func (j *Jenkins) RenameJob(job string, name string) *Job
- func (j *Jenkins) StepsJenkinsfileToJson(jenkinsfile string) (*StepsJenkinsfileToJsonResponse, error)
- func (j *Jenkins) StepsJsonToJenkinsfile(json string) (*StepJsonToJenkinsfileResponse, error)
- func (j *Jenkins) UpdateKubeconfigCredentialInFolder(domain, id, content, description string, folders ...string) (*string, error)
- func (j *Jenkins) UpdateSecretTextCredentialInFolder(domain, id, secret, description string, folders ...string) (*string, error)
- func (j *Jenkins) UpdateSshCredentialInFolder(domain, id, username, passphrase, privateKey, description string, ...) (*string, error)
- func (j *Jenkins) UpdateUsernamePasswordCredentialInFolder(domain, id, username, password, description string, folders ...string) (*string, error)
- func (j *Jenkins) ValidateFingerPrint(id string) (bool, error)
- func (j *Jenkins) ValidateJenkinsfile(jenkinsfile string) (*ValidateJenkinsfileResponse, error)
- func (j *Jenkins) ValidatePipelineJson(json string) (*ValidatePipelineJsonResponse, error)
- type JenkinsBlueTime
- type JenkinsfileToPipelineJsonResponse
- type Job
- func (j *Job) Copy(destinationName string) (*Job, error)
- func (j *Job) Create(config string, qr ...interface{}) (*Job, error)
- func (j *Job) Delete() (bool, error)
- func (j *Job) Disable() (bool, error)
- func (j *Job) Enable() (bool, error)
- func (j *Job) GetAllBuildIds() ([]JobBuild, error)
- func (j *Job) GetAllBuildStatus() ([]JobBuildStatus, error)
- func (j *Job) GetBuild(id int64) (*Build, error)
- func (j *Job) GetConfig() (string, error)
- func (j *Job) GetDescription() string
- func (j *Job) GetDetails() *JobResponse
- func (j *Job) GetDownstreamJobs() ([]*Job, error)
- func (j *Job) GetDownstreamJobsMetadata() []InnerJob
- func (j *Job) GetFirstBuild() (*Build, error)
- func (j *Job) GetInnerJob(id string) (*Job, error)
- func (j *Job) GetInnerJobs() ([]*Job, error)
- func (j *Job) GetInnerJobsMetadata() []InnerJob
- func (j *Job) GetLastBuild() (*Build, error)
- func (j *Job) GetLastCompletedBuild() (*Build, error)
- func (j *Job) GetLastFailedBuild() (*Build, error)
- func (j *Job) GetLastStableBuild() (*Build, error)
- func (j *Job) GetLastSuccessfulBuild() (*Build, error)
- func (j *Job) GetName() string
- func (j *Job) GetParameters() ([]ParameterDefinition, error)
- func (j *Job) GetSubJobs() ([]*Job, error)
- func (j *Job) GetSubJobsMetadata() []InnerJob
- func (j *Job) GetUpstreamJobs() ([]*Job, error)
- func (j *Job) GetUpstreamJobsMetadata() []InnerJob
- func (j *Job) HasQueuedBuild()
- func (j *Job) History() ([]*History, error)
- func (j *Job) Invoke(files []string, skipIfRunning bool, params map[string]string, cause string, ...) (bool, error)
- func (j *Job) InvokeSimple(params map[string]string) (int64, error)
- func (j *Job) IsEnabled() (bool, error)
- func (j *Job) IsQueued() (bool, error)
- func (j *Job) IsRunning() (bool, error)
- func (j *Job) Poll() (int, error)
- func (j *Job) Rename(name string) (bool, error)
- func (j *Job) UpdateConfig(config string) error
- type JobBuild
- type JobBuildStatus
- type JobResponse
- type KubeconfigCredential
- type KubeconfigSource
- type Label
- type LabelNode
- type LabelResponse
- type MODE
- type Node
- func (n *Node) Delete() (bool, error)
- func (n *Node) Disconnect() (int, error)
- func (n *Node) GetLogText() (string, error)
- func (n *Node) GetName() string
- func (n *Node) Info() (*NodeResponse, error)
- func (n *Node) IsIdle() (bool, error)
- func (n *Node) IsJnlpAgent() (bool, error)
- func (n *Node) IsOnline() (bool, error)
- func (n *Node) IsTemporarilyOffline() (bool, error)
- func (n *Node) LaunchNodeBySSH() (int, error)
- func (n *Node) Poll() (int, error)
- func (n *Node) SetOffline(options ...interface{}) (bool, error)
- func (n *Node) SetOnline() (bool, error)
- func (n *Node) ToggleTemporarilyOffline(options ...interface{}) (bool, error)
- type NodeResponse
- type ParameterDefinition
- type PipelineJsonToJenkinsfileResponse
- type Plugin
- type PluginResponse
- type Plugins
- type PrivateKeySource
- type ProjectPermissionIds
- type ProjectRole
- type ProjectRoleResponse
- type Queue
- type QueueItemResponse
- type Requester
- func (r *Requester) Do(ar *APIRequest, responseStruct interface{}, options ...interface{}) (*http.Response, error)
- func (r *Requester) DoGet(ar *APIRequest, responseStruct interface{}, options ...interface{}) (*http.Response, error)
- func (r *Requester) DoPostForm(ar *APIRequest, responseStruct interface{}, form map[string]string) (*http.Response, error)
- func (r *Requester) Get(endpoint string, responseStruct interface{}, querystring map[string]string) (*http.Response, error)
- func (r *Requester) GetHtml(endpoint string, responseStruct interface{}, querystring map[string]string) (*http.Response, error)
- func (r *Requester) GetJSON(endpoint string, responseStruct interface{}, query map[string]string) (*http.Response, error)
- func (r *Requester) GetXML(endpoint string, responseStruct interface{}, query map[string]string) (*http.Response, error)
- func (r *Requester) Post(endpoint string, payload io.Reader, responseStruct interface{}, ...) (*http.Response, error)
- func (r *Requester) PostFiles(endpoint string, payload io.Reader, responseStruct interface{}, ...) (*http.Response, error)
- func (r *Requester) PostForm(endpoint string, payload io.Reader, responseStruct interface{}, ...) (*http.Response, error)
- func (r *Requester) PostJSON(endpoint string, payload io.Reader, responseStruct interface{}, ...) (*http.Response, error)
- func (r *Requester) PostXML(endpoint string, xml string, responseStruct interface{}, ...) (*http.Response, error)
- func (r *Requester) ReadJSONResponse(response *http.Response, responseStruct interface{}) (*http.Response, error)
- func (r *Requester) ReadRawResponse(response *http.Response, responseStruct interface{}) (*http.Response, error)
- func (r *Requester) SetClient(client *http.Client) *Requester
- func (r *Requester) SetCrumb(ar *APIRequest) error
- type SecretTextCredential
- type SshCredential
- type StepJsonToJenkinsfileResponse
- type StepsJenkinsfileToJsonResponse
- type Task
- type TestResult
- type UsernamePasswordCredential
- type ValidateJenkinsfileResponse
- type ValidatePipelineJsonResponse
- type View
- type ViewData
- type ViewResponse
Constants ¶
const ( STATUS_FAIL = "FAIL" STATUS_ERROR = "ERROR" STATUS_ABORTED = "ABORTED" STATUS_REGRESSION = "REGRESSION" STATUS_SUCCESS = "SUCCESS" STATUS_FIXED = "FIXED" STATUS_PASSED = "PASSED" RESULT_STATUS_FAILURE = "FAILURE" RESULT_STATUS_FAILED = "FAILED" RESULT_STATUS_SKIPPED = "SKIPPED" STR_RE_SPLIT_VIEW = "(.*)/view/([^/]*)/?" )
const ( GLOBAL_ROLE = "globalRoles" PROJECT_ROLE = "projectRoles" )
const DirectKubeconfigCredentialStaperClass = "com.microsoft.jenkins.kubernetes.credentials.KubeconfigCredentials$DirectEntryKubeconfigSource"
const DirectSSHCrenditalStaplerClass = "com.cloudbees.jenkins.plugins.sshcredentials.impl.BasicSSHUserPrivateKey$DirectEntryPrivateKeySource"
const GLOBALScope = "GLOBAL"
const KubeconfigCredentialStaplerClass = "com.microsoft.jenkins.kubernetes.credentials.KubeconfigCredentials"
const SSHCrenditalStaplerClass = "com.cloudbees.jenkins.plugins.sshcredentials.impl.BasicSSHUserPrivateKey"
const SecretTextCredentialStaplerClass = "org.jenkinsci.plugins.plaincredentials.impl.StringCredentialsImpl"
const UsernamePassswordCredentialStaplerClass = "com.cloudbees.plugins.credentials.impl.UsernamePasswordCredentialsImpl"
Variables ¶
Loggers
var ( LIST_VIEW = "hudson.model.ListView" NESTED_VIEW = "hudson.plugins.nested_view.NestedView" MY_VIEW = "hudson.model.MyView" DASHBOARD_VIEW = "hudson.plugins.view.dashboard.Dashboard" PIPELINE_VIEW = "au.com.centrumsystems.hudson.plugin.buildpipeline.BuildPipelineView" )
Functions ¶
func CheckResponse ¶
Types ¶
type APIRequest ¶
type APIRequest struct { Method string Endpoint string Payload io.Reader Headers http.Header Suffix string }
func NewAPIRequest ¶
func NewAPIRequest(method string, endpoint string, payload io.Reader) *APIRequest
func (*APIRequest) SetHeader ¶
func (ar *APIRequest) SetHeader(key string, value string) *APIRequest
type Artifact ¶
Represents an Artifact
type Build ¶
type Build struct { Raw *BuildResponse Job *Job Jenkins *Jenkins Base string Depth int }
func (*Build) GetActions ¶
func (b *Build) GetActions() []GeneralObj
func (*Build) GetAllFingerPrints ¶
func (b *Build) GetAllFingerPrints() []*FingerPrint
func (*Build) GetArtifacts ¶
func (*Build) GetBuildNumber ¶
func (*Build) GetConsoleOutput ¶
func (*Build) GetCulprits ¶
func (*Build) GetDownstreamBuilds ¶
func (*Build) GetDownstreamJobNames ¶
func (*Build) GetDuration ¶
func (*Build) GetMatrixRuns ¶
func (*Build) GetParameters ¶
func (b *Build) GetParameters() []parameter
func (*Build) GetResultSet ¶
func (b *Build) GetResultSet() (*TestResult, error)
func (*Build) GetRevision ¶
func (*Build) GetRevisionBranch ¶
func (*Build) GetTimestamp ¶
func (*Build) GetUpstreamBuild ¶
func (*Build) GetUpstreamBuildNumber ¶
func (*Build) GetUpstreamJob ¶
func (*Build) PauseToggle ¶
func (*Build) Poll ¶
Poll for current data. Optional parameter - depth. More about depth here: https://wiki.jenkins-ci.org/display/JENKINS/Remote+access+API
func (*Build) SetDescription ¶
type BuildResponse ¶
type BuildResponse struct { Actions []GeneralObj Artifacts []struct { DisplayPath string `json:"displayPath"` FileName string `json:"fileName"` RelativePath string `json:"relativePath"` } `json:"artifacts"` Building bool `json:"building"` BuiltOn string `json:"builtOn"` ChangeSet struct { Items []struct { AffectedPaths []string `json:"affectedPaths"` Author struct { AbsoluteUrl string `json:"absoluteUrl"` FullName string `json:"fullName"` } `json:"author"` Comment string `json:"comment"` CommitID string `json:"commitId"` Date string `json:"date"` ID string `json:"id"` Msg string `json:"msg"` Paths []struct { EditType string `json:"editType"` File string `json:"file"` } `json:"paths"` Timestamp int64 `json:"timestamp"` } `json:"items"` Kind string `json:"kind"` Revisions []struct { Module string Revision int } `json:"revision"` } `json:"changeSet"` Culprits []Culprit `json:"culprits"` Description interface{} `json:"description"` Duration int64 `json:"duration"` EstimatedDuration int64 `json:"estimatedDuration"` Executor interface{} `json:"executor"` FullDisplayName string `json:"fullDisplayName"` ID string `json:"id"` KeepLog bool `json:"keepLog"` Number int64 `json:"number"` QueueID int64 `json:"queueId"` Result string `json:"result"` Timestamp int64 `json:"timestamp"` URL string `json:"url"` MavenArtifacts interface{} `json:"mavenArtifacts"` MavenVersionUsed string `json:"mavenVersionUsed"` FingerPrint []FingerPrintResponse Runs []struct { Number int64 URL string } `json:"runs"` }
type BuildRevision ¶
type BuildRevision struct { SHA1 string `json:"SHA1,omitempty"` Branch []branch `json:"branch,omitempty"` }
type Builds ¶
type Builds struct { BuildNumber int64 `json:"buildNumber"` BuildResult interface{} `json:"buildResult"` Marked BuildRevision `json:"marked"` Revision BuildRevision `json:"revision"` }
type Computers ¶
type Computers struct { BusyExecutors int `json:"busyExecutors"` Computers []*NodeResponse `json:"computer"` DisplayName string `json:"displayName"` TotalExecutors int `json:"totalExecutors"` }
type CreateKubeconfigCredentialRequest ¶
type CreateKubeconfigCredentialRequest struct {
Credentials KubeconfigCredential `json:"credentials"`
}
func NewCreateKubeconfigCredentialRequest ¶
func NewCreateKubeconfigCredentialRequest(id, content, description string) *CreateKubeconfigCredentialRequest
type CreateSecretTextCredentialRequest ¶
type CreateSecretTextCredentialRequest struct {
Credentials SecretTextCredential `json:"credentials"`
}
func NewCreateSecretTextCredentialRequest ¶
func NewCreateSecretTextCredentialRequest(id, secret, description string) *CreateSecretTextCredentialRequest
type CreateSshCredentialRequest ¶
type CreateSshCredentialRequest struct {
Credentials SshCredential `json:"credentials"`
}
func NewCreateSshCredentialRequest ¶
func NewCreateSshCredentialRequest(id, username, passphrase, privateKey, description string) *CreateSshCredentialRequest
type CreateUsernamePasswordCredentialRequest ¶
type CreateUsernamePasswordCredentialRequest struct {
Credentials UsernamePasswordCredential `json:"credentials"`
}
func NewCreateUsernamePasswordRequest ¶
func NewCreateUsernamePasswordRequest(id, username, password, description string) *CreateUsernamePasswordCredentialRequest
type CredentialResponse ¶
type CredentialResponse struct { Id string `json:"id"` TypeName string `json:"typeName"` DisplayName string `json:"displayName"` Fingerprint *struct { FileName string `json:"fileName,omitempty"` Hash string `json:"hash,omitempty"` Usage []*struct { Name string `json:"name,omitempty"` Ranges struct { Ranges []*struct { Start int `json:"start"` End int `json:"end"` } `json:"ranges"` } `json:"ranges"` } `json:"usage,omitempty"` } `json:"fingerprint,omitempty"` Description string `json:"description"` Domain string `json:"domain"` }
type ErrorResponse ¶
func (*ErrorResponse) Error ¶
func (e *ErrorResponse) Error() string
type Executor ¶
type Executor struct { Raw *ExecutorResponse Jenkins *Jenkins }
type ExecutorResponse ¶
type ExecutorResponse struct { AssignedLabels []struct{} `json:"assignedLabels"` Description interface{} `json:"description"` Jobs []InnerJob `json:"jobs"` Mode string `json:"mode"` NodeDescription string `json:"nodeDescription"` NodeName string `json:"nodeName"` NumExecutors int64 `json:"numExecutors"` OverallLoad struct{} `json:"overallLoad"` PrimaryView struct { Name string `json:"name"` URL string `json:"url"` } `json:"primaryView"` QuietingDown bool `json:"quietingDown"` SlaveAgentPort int64 `json:"slaveAgentPort"` UnlabeledLoad struct{} `json:"unlabeledLoad"` UseCrumbs bool `json:"useCrumbs"` UseSecurity bool `json:"useSecurity"` Views []ViewData `json:"views"` }
type FingerPrint ¶
type FingerPrint struct { Jenkins *Jenkins Base string Id string Raw *FingerPrintResponse }
func (FingerPrint) GetInfo ¶
func (f FingerPrint) GetInfo() (*FingerPrintResponse, error)
func (FingerPrint) Poll ¶
func (f FingerPrint) Poll() (int, error)
func (FingerPrint) Valid ¶
func (f FingerPrint) Valid() (bool, error)
func (FingerPrint) ValidateForBuild ¶
func (f FingerPrint) ValidateForBuild(filename string, build *Build) (bool, error)
type FingerPrintResponse ¶
type FingerPrintResponse struct { FileName string `json:"fileName"` Hash string `json:"hash"` Original struct { Name string Number int64 } `json:"original"` Timestamp int64 `json:"timestamp"` Usage []struct { Name string `json:"name"` Ranges struct { Ranges []struct { End int64 `json:"end"` Start int64 `json:"start"` } `json:"ranges"` } `json:"ranges"` } `json:"usage"` }
type Folder ¶
type Folder struct { Raw *FolderResponse Jenkins *Jenkins Base string }
type FolderResponse ¶
type GeneralObj ¶
type GeneralObj struct { Parameters []parameter `json:"parameters,omitempty"` Causes []map[string]interface{} `json:"causes,omitempty"` BuildsByBranchName map[string]Builds `json:"buildsByBranchName,omitempty"` LastBuiltRevision *BuildRevision `json:"lastBuiltRevision,omitempty"` RemoteUrls []string `json:"remoteUrls,omitempty"` ScmName string `json:"scmName,omitempty"` MercurialNodeName string `json:"mercurialNodeName,omitempty"` MercurialRevisionNumber string `json:"mercurialRevisionNumber,omitempty"` Subdir interface{} `json:"subdir,omitempty"` ClassName string `json:"_class,omitempty"` SonarTaskId string `json:"ceTaskId,omitempty"` SonarServerUrl string `json:"serverUrl,omitempty"` SonarDashboardUrl string `json:"sonarqubeDashboardUrl,omitempty"` TotalCount int64 `json:",omitempty"` UrlName string `json:",omitempty"` }
type GlobalPermissionIds ¶
type GlobalPermissionIds struct { Administer bool `json:"hudson.model.Hudson.Administer"` GlobalRead bool `json:"hudson.model.Hudson.Read"` CredentialCreate bool `json:"com.cloudbees.plugins.credentials.CredentialsProvider.Create"` CredentialUpdate bool `json:"com.cloudbees.plugins.credentials.CredentialsProvider.Update"` CredentialView bool `json:"com.cloudbees.plugins.credentials.CredentialsProvider.View"` CredentialDelete bool `json:"com.cloudbees.plugins.credentials.CredentialsProvider.Delete"` CredentialManageDomains bool `json:"com.cloudbees.plugins.credentials.CredentialsProvider.ManageDomains"` SlaveCreate bool `json:"hudson.model.Computer.Create"` SlaveConfigure bool `json:"hudson.model.Computer.Configure"` SlaveDelete bool `json:"hudson.model.Computer.Delete"` SlaveBuild bool `json:"hudson.model.Computer.Build"` SlaveConnect bool `json:"hudson.model.Computer.Connect"` SlaveDisconnect bool `json:"hudson.model.Computer.Disconnect"` ItemBuild bool `json:"hudson.model.Item.Build"` ItemCreate bool `json:"hudson.model.Item.Create"` ItemRead bool `json:"hudson.model.Item.Read"` ItemConfigure bool `json:"hudson.model.Item.Configure"` ItemCancel bool `json:"hudson.model.Item.Cancel"` ItemMove bool `json:"hudson.model.Item.Move"` ItemDiscover bool `json:"hudson.model.Item.Discover"` ItemWorkspace bool `json:"hudson.model.Item.Workspace"` ItemDelete bool `json:"hudson.model.Item.Delete"` RunUpdate bool `json:"hudson.model.Run.Update"` RunDelete bool `json:"hudson.model.Run.Delete"` ViewCreate bool `json:"hudson.model.View.Create"` ViewConfigure bool `json:"hudson.model.View.Configure"` ViewRead bool `json:"hudson.model.View.Read"` ViewDelete bool `json:"hudson.model.View.Delete"` SCMTag bool `json:"hudson.scm.SCM.Tag"` }
type GlobalRole ¶
type GlobalRole struct { Jenkins *Jenkins Raw GlobalRoleResponse }
func (*GlobalRole) AssignRole ¶
func (j *GlobalRole) AssignRole(sid string) error
func (*GlobalRole) UnAssignRole ¶
func (j *GlobalRole) UnAssignRole(sid string) error
func (*GlobalRole) Update ¶
func (j *GlobalRole) Update(ids GlobalPermissionIds) error
type GlobalRoleResponse ¶
type GlobalRoleResponse struct { RoleName string `json:"roleName"` PermissionIds GlobalPermissionIds `json:"permissionIds"` }
type Jenkins ¶
type Jenkins struct { Server string Version string Raw *ExecutorResponse Requester *Requester }
func CreateJenkins ¶
func CreateJenkins(client *http.Client, base string, maxConnection int, auth ...interface{}) *Jenkins
Creates a new Jenkins Instance Optional parameters are: client, username, password After creating an instance call init method.
func (*Jenkins) AddGlobalRole ¶
func (j *Jenkins) AddGlobalRole(roleName string, ids GlobalPermissionIds, overwrite bool) (*GlobalRole, error)
func (*Jenkins) AddProjectRole ¶
func (j *Jenkins) AddProjectRole(roleName string, pattern string, ids ProjectPermissionIds, overwrite bool) (*ProjectRole, error)
func (*Jenkins) BuildJob ¶
Invoke a job. First parameter job name, second parameter is optional Build parameters.
func (*Jenkins) CopyJob ¶
Create a copy of a job. First parameter Name of the job to copy from, Second parameter new job name.
func (*Jenkins) CreateFolder ¶
Create a new folder This folder can be nested in other parent folders Example: jenkins.CreateFolder("newFolder", "grandparentFolder", "parentFolder")
func (*Jenkins) CreateJob ¶
Create a new job from config File Method takes XML string as first parameter, and if the name is not specified in the config file takes name as string as second parameter e.g jenkins.CreateJob("<config></config>","newJobName")
func (*Jenkins) CreateJobInFolder ¶
func (j *Jenkins) CreateJobInFolder(config string, jobName string, parentIDs ...string) (*Job, error)
Create a new job in the folder Example: jenkins.CreateJobInFolder("<config></config>", "newJobName", "myFolder", "parentFolder")
func (*Jenkins) CreateKubeconfigCredentialInFolder ¶
func (*Jenkins) CreateNode ¶
func (j *Jenkins) CreateNode(name string, numExecutors int, description string, remoteFS string, label string, options ...interface{}) (*Node, error)
Create a new Node Can be JNLPLauncher or SSHLauncher Example : jenkins.CreateNode("nodeName", 1, "Description", "/var/lib/jenkins", "jdk8 docker", map[string]string{"method": "JNLPLauncher"}) By Default JNLPLauncher is created Multiple labels should be separated by blanks
func (*Jenkins) CreateSecretTextCredentialInFolder ¶
func (*Jenkins) CreateSshCredential ¶
func (j *Jenkins) CreateSshCredential(id, username, passphrase, privateKey, description string) (*string, error)
Create a ssh credentials return credentials id
func (*Jenkins) CreateSshCredentialInFolder ¶
func (*Jenkins) CreateUsernamePasswordCredential ¶
func (*Jenkins) CreateUsernamePasswordCredentialInFolder ¶
func (*Jenkins) CreateView ¶
Create View First Parameter - name of the View Second parameter - Type Possible Types:
gojenkins.LIST_VIEW gojenkins.NESTED_VIEW gojenkins.MY_VIEW gojenkins.DASHBOARD_VIEW gojenkins.PIPELINE_VIEW
Example: jenkins.CreateView("newView",gojenkins.LIST_VIEW)
func (*Jenkins) DeleteCredentialInFolder ¶
func (*Jenkins) DeleteNode ¶
Delete a Jenkins slave node
func (*Jenkins) DeleteProjectRoles ¶
func (*Jenkins) GetAllBuildIds ¶
Get all builds Numbers and URLS for a specific job. There are only build IDs here, To get all the other info of the build use jenkins.GetBuild(job,buildNumber) or job.GetBuild(buildNumber)
func (*Jenkins) GetAllBuildStatus ¶
func (j *Jenkins) GetAllBuildStatus(jobId string) ([]JobBuildStatus, error)
func (*Jenkins) GetAllJobNames ¶
Get Only Array of Job Names, Color, URL Does not query each single Job.
func (*Jenkins) GetAllJobs ¶
Get All Possible Job Objects. Each job will be queried.
func (*Jenkins) GetAllNodes ¶
func (*Jenkins) GetAllViews ¶
func (*Jenkins) GetArtifactData ¶
func (j *Jenkins) GetArtifactData(id string) (*FingerPrintResponse, error)
Get Artifact data by Hash
func (*Jenkins) GetCredentialContentInFolder ¶
func (*Jenkins) GetCredentialInFolder ¶
func (j *Jenkins) GetCredentialInFolder(domain, id string, folders ...string) (*CredentialResponse, error)
func (*Jenkins) GetCredentialsInFolder ¶
func (j *Jenkins) GetCredentialsInFolder(domain string, folders ...string) ([]*CredentialResponse, error)
func (*Jenkins) GetGlobalRole ¶
func (j *Jenkins) GetGlobalRole(roleName string) (*GlobalRole, error)
func (*Jenkins) GetPlugins ¶
Returns the list of all plugins installed on the Jenkins server. You can supply depth parameter, to limit how much data is returned.
func (*Jenkins) GetProjectRole ¶
func (j *Jenkins) GetProjectRole(roleName string) (*ProjectRole, error)
func (*Jenkins) GetQueueItem ¶
func (j *Jenkins) GetQueueItem(number int64) (*QueueItemResponse, error)
func (*Jenkins) GetQueueUrl ¶
func (*Jenkins) HasPlugin ¶
Check if the plugin is installed on the server. Depth level 1 is used. If you need to go deeper, you can use GetPlugins, and iterate through them.
func (*Jenkins) Info ¶
func (j *Jenkins) Info() (*ExecutorResponse, error)
Get Basic Information About Jenkins
func (*Jenkins) Init ¶
Init Method. Should be called after creating a Jenkins Instance. e.g jenkins := CreateJenkins("url").Init() HTTP Client is set here, Connection to jenkins is tested here.
func (*Jenkins) JenkinsfileToPipelineJson ¶
func (j *Jenkins) JenkinsfileToPipelineJson(jenkinsfile string) (*JenkinsfileToPipelineJsonResponse, error)
func (*Jenkins) PipelineJsonToJenkinsfile ¶
func (j *Jenkins) PipelineJsonToJenkinsfile(json string) (*PipelineJsonToJenkinsfileResponse, error)
func (*Jenkins) RenameJob ¶
Rename a job. First parameter job old name, Second parameter job new name.
func (*Jenkins) StepsJenkinsfileToJson ¶
func (j *Jenkins) StepsJenkinsfileToJson(jenkinsfile string) (*StepsJenkinsfileToJsonResponse, error)
func (*Jenkins) StepsJsonToJenkinsfile ¶
func (j *Jenkins) StepsJsonToJenkinsfile(json string) (*StepJsonToJenkinsfileResponse, error)
func (*Jenkins) UpdateKubeconfigCredentialInFolder ¶
func (*Jenkins) UpdateSecretTextCredentialInFolder ¶
func (*Jenkins) UpdateSshCredentialInFolder ¶
func (*Jenkins) UpdateUsernamePasswordCredentialInFolder ¶
func (*Jenkins) ValidateFingerPrint ¶
Verify FingerPrint
func (*Jenkins) ValidateJenkinsfile ¶
func (j *Jenkins) ValidateJenkinsfile(jenkinsfile string) (*ValidateJenkinsfileResponse, error)
func (*Jenkins) ValidatePipelineJson ¶
func (j *Jenkins) ValidatePipelineJson(json string) (*ValidatePipelineJsonResponse, error)
type JenkinsBlueTime ¶
func (JenkinsBlueTime) MarshalJSON ¶
func (t JenkinsBlueTime) MarshalJSON() ([]byte, error)
func (*JenkinsBlueTime) UnmarshalJSON ¶
func (t *JenkinsBlueTime) UnmarshalJSON(b []byte) error
type Job ¶
type Job struct { Raw *JobResponse Jenkins *Jenkins Base string }
func (*Job) GetAllBuildIds ¶
Returns All Builds with Number and URL
func (*Job) GetAllBuildStatus ¶
func (j *Job) GetAllBuildStatus() ([]JobBuildStatus, error)
func (*Job) GetDescription ¶
func (*Job) GetDetails ¶
func (j *Job) GetDetails() *JobResponse
func (*Job) GetDownstreamJobs ¶
func (*Job) GetDownstreamJobsMetadata ¶
func (*Job) GetFirstBuild ¶
func (*Job) GetInnerJobs ¶
func (*Job) GetInnerJobsMetadata ¶
func (*Job) GetLastBuild ¶
func (*Job) GetLastCompletedBuild ¶
func (*Job) GetLastFailedBuild ¶
func (*Job) GetLastStableBuild ¶
func (*Job) GetLastSuccessfulBuild ¶
func (*Job) GetParameters ¶
func (j *Job) GetParameters() ([]ParameterDefinition, error)
func (*Job) GetSubJobs ¶
func (*Job) GetSubJobsMetadata ¶
func (*Job) GetUpstreamJobs ¶
func (*Job) GetUpstreamJobsMetadata ¶
func (*Job) HasQueuedBuild ¶
func (j *Job) HasQueuedBuild()
func (*Job) UpdateConfig ¶
type JobBuildStatus ¶
type JobResponse ¶
type JobResponse struct { Class string `json:"_class"` Actions []GeneralObj Buildable bool `json:"buildable"` Builds []JobBuild Color string `json:"color"` ConcurrentBuild bool `json:"concurrentBuild"` Description string `json:"description"` DisplayName string `json:"displayName"` DisplayNameOrNull interface{} `json:"displayNameOrNull"` DownstreamProjects []InnerJob `json:"downstreamProjects"` FirstBuild JobBuild HealthReport []struct { Description string `json:"description"` IconClassName string `json:"iconClassName"` IconUrl string `json:"iconUrl"` Score int64 `json:"score"` } `json:"healthReport"` InQueue bool `json:"inQueue"` KeepDependencies bool `json:"keepDependencies"` LastBuild JobBuild `json:"lastBuild"` LastCompletedBuild JobBuild `json:"lastCompletedBuild"` LastFailedBuild JobBuild `json:"lastFailedBuild"` LastStableBuild JobBuild `json:"lastStableBuild"` LastSuccessfulBuild JobBuild `json:"lastSuccessfulBuild"` LastUnstableBuild JobBuild `json:"lastUnstableBuild"` LastUnsuccessfulBuild JobBuild `json:"lastUnsuccessfulBuild"` Name string `json:"name"` SubJobs []InnerJob `json:"jobs"` NextBuildNumber int64 `json:"nextBuildNumber"` Property []struct { ParameterDefinitions []ParameterDefinition `json:"parameterDefinitions"` } `json:"property"` QueueItem interface{} `json:"queueItem"` Scm struct{} `json:"scm"` UpstreamProjects []InnerJob `json:"upstreamProjects"` URL string `json:"url"` Jobs []InnerJob `json:"jobs"` PrimaryView *ViewData `json:"primaryView"` Views []ViewData `json:"views"` }
type KubeconfigCredential ¶
type KubeconfigCredential struct { Scope string `json:"scope"` Id string `json:"id"` Description string `json:"description"` KubeconfigSource KubeconfigSource `json:"kubeconfigSource"` StaplerClass string `json:"stapler-class"` }
func NewKubeconfigCredential ¶
func NewKubeconfigCredential(id, content, description string) *KubeconfigCredential
type KubeconfigSource ¶
type Label ¶
type Label struct { Raw *LabelResponse Jenkins *Jenkins Base string }
type LabelResponse ¶
type Node ¶
type Node struct { Raw *NodeResponse Jenkins *Jenkins Base string }
func (*Node) Disconnect ¶
func (*Node) GetLogText ¶
func (*Node) Info ¶
func (n *Node) Info() (*NodeResponse, error)
func (*Node) IsJnlpAgent ¶
func (*Node) IsTemporarilyOffline ¶
func (*Node) LaunchNodeBySSH ¶
func (*Node) SetOffline ¶
func (*Node) ToggleTemporarilyOffline ¶
type NodeResponse ¶
type NodeResponse struct { Actions []interface{} `json:"actions"` DisplayName string `json:"displayName"` Executors []struct { CurrentExecutable struct { Number int `json:"number"` URL string `json:"url"` SubBuilds []struct { Abort bool `json:"abort"` Build interface{} `json:"build"` BuildNumber int `json:"buildNumber"` Duration string `json:"duration"` Icon string `json:"icon"` JobName string `json:"jobName"` ParentBuildNumber int `json:"parentBuildNumber"` ParentJobName string `json:"parentJobName"` PhaseName string `json:"phaseName"` Result string `json:"result"` Retry bool `json:"retry"` URL string `json:"url"` } `json:"subBuilds"` } `json:"currentExecutable"` } `json:"executors"` Icon string `json:"icon"` IconClassName string `json:"iconClassName"` Idle bool `json:"idle"` JnlpAgent bool `json:"jnlpAgent"` LaunchSupported bool `json:"launchSupported"` LoadStatistics struct{} `json:"loadStatistics"` ManualLaunchAllowed bool `json:"manualLaunchAllowed"` MonitorData struct { Hudson_NodeMonitors_ArchitectureMonitor interface{} `json:"hudson.node_monitors.ArchitectureMonitor"` Hudson_NodeMonitors_ClockMonitor interface{} `json:"hudson.node_monitors.ClockMonitor"` Hudson_NodeMonitors_DiskSpaceMonitor interface{} `json:"hudson.node_monitors.DiskSpaceMonitor"` Hudson_NodeMonitors_ResponseTimeMonitor struct { Average int64 `json:"average"` } `json:"hudson.node_monitors.ResponseTimeMonitor"` Hudson_NodeMonitors_SwapSpaceMonitor interface{} `json:"hudson.node_monitors.SwapSpaceMonitor"` Hudson_NodeMonitors_TemporarySpaceMonitor interface{} `json:"hudson.node_monitors.TemporarySpaceMonitor"` } `json:"monitorData"` NumExecutors int64 `json:"numExecutors"` Offline bool `json:"offline"` OfflineCause struct{} `json:"offlineCause"` OfflineCauseReason string `json:"offlineCauseReason"` OneOffExecutors []interface{} `json:"oneOffExecutors"` TemporarilyOffline bool `json:"temporarilyOffline"` }
type ParameterDefinition ¶
type Plugin ¶
type Plugin struct { Active bool `json:"active"` BackupVersion interface{} `json:"backupVersion"` Bundled bool `json:"bundled"` Deleted bool `json:"deleted"` Dependencies []struct { Optional string `json:"optional"` ShortName string `json:"shortname"` Version string `json:"version"` } `json:"dependencies"` Downgradable bool `json:"downgradable"` Enabled bool `json:"enabled"` HasUpdate bool `json:"hasUpdate"` LongName string `json:"longName"` Pinned bool `json:"pinned"` ShortName string `json:"shortName"` SupportsDynamicLoad string `json:"supportsDynamicLoad"` URL string `json:"url"` Version string `json:"version"` }
type PluginResponse ¶
type PluginResponse struct {
Plugins []Plugin `json:"plugins"`
}
type PrivateKeySource ¶
type ProjectPermissionIds ¶
type ProjectPermissionIds struct { CredentialCreate bool `json:"com.cloudbees.plugins.credentials.CredentialsProvider.Create"` CredentialUpdate bool `json:"com.cloudbees.plugins.credentials.CredentialsProvider.Update"` CredentialView bool `json:"com.cloudbees.plugins.credentials.CredentialsProvider.View"` CredentialDelete bool `json:"com.cloudbees.plugins.credentials.CredentialsProvider.Delete"` CredentialManageDomains bool `json:"com.cloudbees.plugins.credentials.CredentialsProvider.ManageDomains"` ItemBuild bool `json:"hudson.model.Item.Build"` ItemCreate bool `json:"hudson.model.Item.Create"` ItemRead bool `json:"hudson.model.Item.Read"` ItemConfigure bool `json:"hudson.model.Item.Configure"` ItemCancel bool `json:"hudson.model.Item.Cancel"` ItemMove bool `json:"hudson.model.Item.Move"` ItemDiscover bool `json:"hudson.model.Item.Discover"` ItemWorkspace bool `json:"hudson.model.Item.Workspace"` ItemDelete bool `json:"hudson.model.Item.Delete"` RunUpdate bool `json:"hudson.model.Run.Update"` RunDelete bool `json:"hudson.model.Run.Delete"` RunReplay bool `json:"hudson.model.Run.Replay"` SCMTag bool `json:"hudson.scm.SCM.Tag"` }
type ProjectRole ¶
type ProjectRole struct { Jenkins *Jenkins Raw ProjectRoleResponse }
func (*ProjectRole) AssignRole ¶
func (j *ProjectRole) AssignRole(sid string) error
func (*ProjectRole) UnAssignRole ¶
func (j *ProjectRole) UnAssignRole(sid string) error
func (*ProjectRole) Update ¶
func (j *ProjectRole) Update(pattern string, ids ProjectPermissionIds) error
type ProjectRoleResponse ¶
type ProjectRoleResponse struct { RoleName string `json:"roleName"` PermissionIds ProjectPermissionIds `json:"permissionIds"` Pattern string `json:"pattern"` }
type QueueItemResponse ¶
type QueueItemResponse struct { Actions []generalAction `json:"actions"` Blocked bool `json:"blocked"` Buildable bool `json:"buildable"` ID int64 `json:"id"` InQueueSince int64 `json:"inQueueSince"` Params string `json:"params"` Stuck bool `json:"stuck"` Task struct { Color string `json:"color"` Name string `json:"name"` URL string `json:"url"` } `json:"task"` URL string `json:"url"` Cancelled bool `json:"cancelled"` Why string `json:"why"` Executable struct { Number int64 `json:"number"` Url string `json:"url"` } `json:"executable"` }
type Requester ¶
type Requester struct { Base string BasicAuth *BasicAuth Client *http.Client CACert []byte SslVerify bool // contains filtered or unexported fields }
func (*Requester) Do ¶
func (r *Requester) Do(ar *APIRequest, responseStruct interface{}, options ...interface{}) (*http.Response, error)
func (*Requester) DoGet ¶
func (r *Requester) DoGet(ar *APIRequest, responseStruct interface{}, options ...interface{}) (*http.Response, error)
func (*Requester) DoPostForm ¶
func (*Requester) ReadJSONResponse ¶
func (*Requester) ReadRawResponse ¶
func (*Requester) SetCrumb ¶
func (r *Requester) SetCrumb(ar *APIRequest) error
type SecretTextCredential ¶
type SecretTextCredential struct { Scope string `json:"scope"` Id string `json:"id"` Secret string `json:"secret"` Description string `json:"description"` StaplerClass string `json:"stapler-class"` }
func NewSecretTextCredential ¶
func NewSecretTextCredential(id, secret, description string) *SecretTextCredential
type SshCredential ¶
type SshCredential struct { Scope string `json:"scope"` Id string `json:"id"` Username string `json:"username"` Passphrase string `json:"passphrase"` KeySource PrivateKeySource `json:"privateKeySource"` Description string `json:"description"` StaplerClass string `json:"stapler-class"` }
func NewSshCredential ¶
func NewSshCredential(id, username, passphrase, privateKey, description string) *SshCredential
type Task ¶
func (*Task) GetParameters ¶
func (t *Task) GetParameters() []parameter
type TestResult ¶
type TestResult struct { Duration int64 `json:"duration"` Empty bool `json:"empty"` FailCount int64 `json:"failCount"` PassCount int64 `json:"passCount"` SkipCount int64 `json:"skipCount"` Suites []struct { Cases []struct { Age int64 `json:"age"` ClassName string `json:"className"` Duration int64 `json:"duration"` ErrorDetails interface{} `json:"errorDetails"` ErrorStackTrace interface{} `json:"errorStackTrace"` FailedSince int64 `json:"failedSince"` Name string `json:"name"` Skipped bool `json:"skipped"` SkippedMessage interface{} `json:"skippedMessage"` Status string `json:"status"` Stderr interface{} `json:"stderr"` Stdout interface{} `json:"stdout"` } `json:"cases"` Duration int64 `json:"duration"` ID interface{} `json:"id"` Name string `json:"name"` Stderr interface{} `json:"stderr"` Stdout interface{} `json:"stdout"` Timestamp interface{} `json:"timestamp"` } `json:"suites"` }
type UsernamePasswordCredential ¶
type UsernamePasswordCredential struct { Scope string `json:"scope"` Id string `json:"id"` Username string `json:"username"` Password string `json:"password"` Description string `json:"description"` StaplerClass string `json:"stapler-class"` }
func NewUsernamePasswordCredential ¶
func NewUsernamePasswordCredential(id, username, password, description string) *UsernamePasswordCredential