jenkins

package
v0.0.0-...-353f62c Latest Latest
Warning

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

 Go to latest Published: Mar 18, 2026 License: Apache-2.0 Imports: 31 Imported by: 0

README

Jenkins API Client for Go

About

Jenkins is the most popular Open Source Continuous Integration system. This Library will help you interact with Jenkins in a more developer-friendly way.

Fork From https://github.com/bndr/gojenkins

These are some of the features that are currently implemented:

  • Get information on test-results of completed/failed build
  • Ability to query Nodes, and manipulate them. Start, Stop, set Offline.
  • Ability to query Jobs, and manipulate them.
  • Get Plugins, Builds, Artifacts, Fingerprints
  • Validate Fingerprints of Artifacts
  • Get Current Queue, Cancel Tasks
  • etc. For all methods go to GoDoc Reference.

Add some features:

  • Credentials Management
  • Pipeline Model Converter
  • RBAC control

Documentation

Overview

Gojenkins is a Jenkins Client in Go, that exposes the jenkins REST api in a more developer friendly way.

Index

Constants

View Source 
const (
	Git = "git"
	Hg  = "hg"
	Svn = "svc"
)
View Source 
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/([^/]*)/?"
)
View Source 
const (
	GLOBAL_ROLE  = "globalRoles"
	PROJECT_ROLE = "projectRoles"
)
View Source 
const (
	StringNull = ""

	FlowTag                 = "flow-definition"
	PropertiesTag           = "properties"
	DisableConcurrentJobTag = "org.jenkinsci.plugins.workflow.job.properties.DisableConcurrentBuildsJobProperty"
	BuildDiscarderTag       = "jenkins.model.BuildDiscarderProperty"
	StrategyTag             = "strategy"
	DaysToKeepTag           = "daysToKeep"
	NumToKeepTag            = "numToKeep"
	ArtiDaysToKeepTag       = "artifactDaysToKeep"
	ArtiNumToKeepTag        = "artifactNumToKeep"

	ParamDefiPropTag = "hudson.model.ParametersDefinitionProperty"
	ParamDefiTag     = "parameterDefinitions"

	PipelineTriggersJobTag = "org.jenkinsci.plugins.workflow.job.properties.PipelineTriggersJobProperty"
	TriggersTag            = "triggers"
	TimerTriggerTag        = "hudson.triggers.TimerTrigger"

	DefinitionTag = "definition"
	ClassKey      = "class"
	PluginKey     = "plugin"
	ScriptTag     = "script"
	SandboxTag    = "sandbox"
	AuthTokenTag  = "authToken"
	DisabledTag   = "disabled"
)
View Source 
const (
	GetPipelineUrl         = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/"
	ListPipelinesUrl       = "/blue/rest/search/?"
	GetPipelineRunUrl      = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/runs/%s/"
	ListPipelineRunUrl     = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/runs/?"
	StopPipelineUrl        = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/runs/%s/stop/?"
	ReplayPipelineUrl      = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/runs/%s/replay/"
	RunPipelineUrl         = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/runs/"
	GetArtifactsUrl        = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/runs/%s/artifacts/?"
	GetRunLogUrl           = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/runs/%s/log/?"
	GetStepLogUrl          = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/runs/%s/nodes/%s/steps/%s/log/?"
	GetPipelineRunNodesUrl = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/runs/%s/nodes/?"
	SubmitInputStepUrl     = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/runs/%s/nodes/%s/steps/%s/"
	GetNodeStepsUrl        = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/runs/%s/nodes/%s/steps/?"

	GetBranchPipelineUrl     = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/branches/%s/"
	GetBranchPipelineRunUrl  = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/branches/%s/runs/%s/"
	StopBranchPipelineUrl    = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/branches/%s/runs/%s/stop/?"
	ReplayBranchPipelineUrl  = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/branches/%s/runs/%s/replay/"
	RunBranchPipelineUrl     = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/branches/%s/runs/"
	GetBranchArtifactsUrl    = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/branches/%s/runs/%s/artifacts/?"
	GetBranchRunLogUrl       = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/branches/%s/runs/%s/log/?"
	GetBranchStepLogUrl      = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/branches/%s/runs/%s/nodes/%s/steps/%s/log/?"
	GetBranchNodeStepsUrl    = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/branches/%s/runs/%s/nodes/%s/steps/?"
	GetBranchPipeRunNodesUrl = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/branches/%s/runs/%s/nodes/?"
	CheckBranchPipelineUrl   = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/branches/%s/runs/%s/nodes/%s/steps/%s/"
	GetPipeBranchUrl         = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/branches/?"
	ScanBranchUrl            = "/job/%s/job/%s/build?"
	GetConsoleLogUrl         = "/job/%s/job/%s/indexing/consoleText"
	GetCrumbUrl              = "/crumbIssuer/api/json/"
	GetSCMServersUrl         = "/blue/rest/organizations/jenkins/scm/%s/servers/"
	GetSCMOrgUrl             = "/blue/rest/organizations/jenkins/scm/%s/organizations/?"
	GetOrgRepoUrl            = "/blue/rest/organizations/jenkins/scm/%s/organizations/%s/repositories/?"
	CreateSCMServersUrl      = "/blue/rest/organizations/jenkins/scm/%s/servers/"
	ValidateUrl              = "/blue/rest/organizations/jenkins/scm/%s/validate"

	GetNotifyCommitUrl = "/git/notifyCommit/?"
	GithubWebhookUrl   = "/github-webhook/"
	// GenericWebhookUrl comes from Jenkins plugin, see also https://github.com/jenkinsci/generic-webhook-trigger-plugin
	GenericWebhookUrl     = "/generic-webhook-trigger/invoke?"
	CheckScriptCompileUrl = "/job/%s/job/%s/descriptorByName/org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition/checkScriptCompile"

	CheckPipelienCronUrl = "/job/%s/job/%s/descriptorByName/hudson.triggers.TimerTrigger/checkSpec?%s"
	CheckCronUrl         = "/job/%s/descriptorByName/hudson.triggers.TimerTrigger/checkSpec?%s"

	CheckPipelineName = "/job/%s/checkJobName?"
)

Variables

View Source 
var (
	Info    *log.Logger
	Warning *log.Logger
	Error   *log.Logger
)

Loggers

View Source 
var ParameterTypeMap = map[string]string{
	"hudson.model.StringParameterDefinition":   "string",
	"hudson.model.ChoiceParameterDefinition":   "choice",
	"hudson.model.TextParameterDefinition":     "text",
	"hudson.model.BooleanParameterDefinition":  "boolean",
	"hudson.model.FileParameterDefinition":     "file",
	"hudson.model.PasswordParameterDefinition": "password",
}

ParameterTypeMap aims for simplifying representation of parameter definition type.

Functions

func CheckResponse 

func CheckResponse(r *http.Response) error

func ParseJenkinsQuery 

func ParseJenkinsQuery(query string) (result url.Values, err error)

ParseJenkinsQuery Parse the special query of jenkins. ParseQuery in the standard library makes the query not re-encode

func Reverse 

func Reverse(s string) string

func UploadFunc 

func UploadFunc(fileName string, writer *multipart.Writer) error

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 BasicAuth 

type BasicAuth struct {
	Username string
	Password string
}

Basic Authentication

type Branch 

type Branch struct {
	SHA1 string `json:",omitempty"`
	Name string `json:",omitempty"`
}

type Build 

type Build struct {
	Raw     *devops.Build
	Job     *Job
	Jenkins *Jenkins
	Base    string
	Depth   int
}

func (*Build) GetBuildNumber 

func (b *Build) GetBuildNumber() int64

func (*Build) GetCauses 

func (b *Build) GetCauses() ([]map[string]interface{}, error)

func (*Build) GetConsoleOutput 

func (b *Build) GetConsoleOutput() string

func (*Build) GetDuration 

func (b *Build) GetDuration() int64

func (*Build) GetInjectedEnvVars 

func (b *Build) GetInjectedEnvVars() (map[string]string, error)

func (*Build) GetResult 

func (b *Build) GetResult() string

func (*Build) GetResultSet 

func (b *Build) GetResultSet() (*TestResult, error)

func (*Build) GetRevisionBranch 

func (b *Build) GetRevisionBranch() string

func (*Build) GetTimestamp 

func (b *Build) GetTimestamp() time.Time

func (*Build) GetUrl 

func (b *Build) GetUrl() string

func (*Build) Info 

func (b *Build) Info() *devops.Build

Builds

func (*Build) IsGood 

func (b *Build) IsGood() bool

func (*Build) IsRunning 

func (b *Build) IsRunning() bool

func (*Build) PauseToggle 

func (b *Build) PauseToggle() error

func (*Build) Poll 

func (b *Build) Poll(options ...interface{}) (int, error)

Poll for current data. Optional Parameter - depth. More about depth here: https://wiki.jenkins-ci.org/display/JENKINS/Remote+access+API

func (*Build) SetDescription 

func (b *Build) SetDescription(description string) error

func (*Build) Stop 

func (b *Build) Stop() (bool, error)

type BuildResponse 

type BuildResponse struct {
	Actions   []devops.GeneralAction
	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          []devops.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"`
	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 Culprit 

type Culprit struct {
	AbsoluteUrl string
	FullName    string
}

type Folder 

type Folder struct {
	Raw     *FolderResponse
	Jenkins *Jenkins
	Base    string
}

func (*Folder) Create 

func (f *Folder) Create(name, description string) (*Folder, error)

func (*Folder) GetName 

func (f *Folder) GetName() string

func (*Folder) Poll 

func (f *Folder) Poll() (int, error)

type FolderResponse 

type FolderResponse struct {
	Actions     []GeneralObj
	Description string     `json:"description"`
	DisplayName string     `json:"displayName"`
	Name        string     `json:"name"`
	URL         string     `json:"url"`
	Jobs        []InnerJob `json:"jobs"`
}

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 History 

type History struct {
	BuildNumber    int
	BuildStatus    string
	BuildTimestamp int64
}

type InnerJob 

type InnerJob struct {
	Name  string `json:"name"`
	Url   string `json:"url"`
	Color string `json:"color"`
}

type Jenkins 

type Jenkins struct {
	Server    string
	Version   string
	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 NewDevopsClient 

func NewDevopsClient(options *Options) (*Jenkins, error)

func (*Jenkins) BuildJob 

func (j *Jenkins) BuildJob(name string, options ...interface{}) (int64, error)

Invoke a job. First Parameter job name, second Parameter is optional Build parameters.

func (*Jenkins) CheckCron 

func (j *Jenkins) CheckCron(projectName string, httpParameters *devops.HttpParameters) (*devops.CheckCronRes, error)

func (*Jenkins) CheckPipelineName 

func (j *Jenkins) CheckPipelineName(projectName, pipelineName string, httpParameters *devops.HttpParameters) (map[string]interface{}, error)

func (*Jenkins) CheckScriptCompile 

func (j *Jenkins) CheckScriptCompile(projectName, pipelineName string, httpParameters *devops.HttpParameters) (*devops.CheckScript, error)

func (*Jenkins) CopyJob 

func (j *Jenkins) CopyJob(copyFrom string, newName string) (*Job, error)

Create a copy of a job. First Parameter Name of the job to copy from, Second Parameter new job name.

func (*Jenkins) CreateCredentialInProject 

func (j *Jenkins) CreateCredentialInProject(projectId string, credential *v1.Secret) (string, error)

func (*Jenkins) CreateDevOpsProject 

func (j *Jenkins) CreateDevOpsProject(projectId string) (string, error)

func (*Jenkins) CreateFolder 

func (j *Jenkins) CreateFolder(name, description string, parents ...string) (*Folder, error)

Create a new folder This folder can be nested in other parent folders Example: jenkins.CreateFolder("newFolder", "grandparentFolder", "parentFolder")

func (*Jenkins) CreateJob 

func (j *Jenkins) CreateJob(config string, options ...interface{}) (*Job, error)

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) CreateProjectPipeline 

func (j *Jenkins) CreateProjectPipeline(projectId string, pipeline *devopsv1alpha3.Pipeline) (string, error)

func (*Jenkins) CreateSCMServers 

func (j *Jenkins) CreateSCMServers(scmId string, httpParameters *devops.HttpParameters) (*devops.SCMServer, error)

func (*Jenkins) DeleteCredentialInProject 

func (j *Jenkins) DeleteCredentialInProject(projectId, id string) (string, error)

DeleteCredentialInProject deletes credential

Deprecated

func (*Jenkins) DeleteDevOpsProject 

func (j *Jenkins) DeleteDevOpsProject(projectId string) (err error)

func (*Jenkins) DeleteJob 

func (j *Jenkins) DeleteJob(name string, parentIDs ...string) (bool, error)

Delete a job.

func (*Jenkins) DeleteProjectPipeline 

func (j *Jenkins) DeleteProjectPipeline(projectId string, pipelineId string) (string, error)

func (*Jenkins) GenericWebhook 

func (j *Jenkins) GenericWebhook(httpParameters *devops.HttpParameters) ([]byte, error)

func (*Jenkins) GetArtifacts 

func (j *Jenkins) GetArtifacts(projectName, pipelineName, runId string, httpParameters *devops.HttpParameters) ([]devops.Artifacts, error)

func (*Jenkins) GetBranchArtifacts 

func (j *Jenkins) GetBranchArtifacts(projectName, pipelineName, branchName, runId string, httpParameters *devops.HttpParameters) ([]devops.Artifacts, error)

func (*Jenkins) GetBranchNodeSteps 

func (j *Jenkins) GetBranchNodeSteps(projectName, pipelineName, branchName, runId, nodeId string, httpParameters *devops.HttpParameters) ([]devops.NodeSteps, error)

func (*Jenkins) GetBranchPipeline 

func (j *Jenkins) GetBranchPipeline(projectName, pipelineName, branchName string, httpParameters *devops.HttpParameters) (*devops.BranchPipeline, error)

func (*Jenkins) GetBranchPipelineRun 

func (j *Jenkins) GetBranchPipelineRun(projectName, pipelineName, branchName, runId string, httpParameters *devops.HttpParameters) (*devops.PipelineRun, error)

func (*Jenkins) GetBranchPipelineRunNodes 

func (j *Jenkins) GetBranchPipelineRunNodes(projectName, pipelineName, branchName, runId string, httpParameters *devops.HttpParameters) ([]devops.BranchPipelineRunNodes, error)

func (*Jenkins) GetBranchRunLog 

func (j *Jenkins) GetBranchRunLog(projectName, pipelineName, branchName, runId string, httpParameters *devops.HttpParameters) ([]byte, error)

func (*Jenkins) GetBranchStepLog 

func (j *Jenkins) GetBranchStepLog(projectName, pipelineName, branchName, runId, nodeId, stepId string, httpParameters *devops.HttpParameters) ([]byte, http.Header, error)

func (*Jenkins) GetBuild 

func (j *Jenkins) GetBuild(jobName string, number int64) (*Build, error)

func (*Jenkins) GetConsoleLog 

func (j *Jenkins) GetConsoleLog(projectName, pipelineName string, httpParameters *devops.HttpParameters) ([]byte, error)

func (*Jenkins) GetCredentialInProject 

func (j *Jenkins) GetCredentialInProject(projectId, id string) (*devops.Credential, error)

func (*Jenkins) GetCrumb 

func (j *Jenkins) GetCrumb(httpParameters *devops.HttpParameters) (*devops.Crumb, error)

func (*Jenkins) GetDevOpsProject 

func (j *Jenkins) GetDevOpsProject(projectId string) (string, error)

func (*Jenkins) GetFolder 

func (j *Jenkins) GetFolder(id string, parents ...string) (*Folder, error)

func (*Jenkins) GetJob 

func (j *Jenkins) GetJob(id string, parentIDs ...string) (*Job, error)

func (*Jenkins) GetMultiBranchPipelineBuildByType 

func (j *Jenkins) GetMultiBranchPipelineBuildByType(projectId, pipelineId, branch string, status string) (build *devops.Build, err error)

func (*Jenkins) GetNodeSteps 

func (j *Jenkins) GetNodeSteps(projectName, pipelineName, runId, nodeId string, httpParameters *devops.HttpParameters) ([]devops.NodeSteps, error)

func (*Jenkins) GetNotifyCommit 

func (j *Jenkins) GetNotifyCommit(httpParameters *devops.HttpParameters) ([]byte, error)

func (*Jenkins) GetOrgRepo 

func (j *Jenkins) GetOrgRepo(scmId, organizationId string, httpParameters *devops.HttpParameters) (devops.OrgRepo, error)

func (*Jenkins) GetPipeline 

func (j *Jenkins) GetPipeline(projectName, pipelineName string, httpParameters *devops.HttpParameters) (*devops.Pipeline, error)

func (*Jenkins) GetPipelineBranch 

func (j *Jenkins) GetPipelineBranch(projectName, pipelineName string, httpParameters *devops.HttpParameters) (*devops.PipelineBranch, error)

func (*Jenkins) GetPipelineRun 

func (j *Jenkins) GetPipelineRun(projectName, pipelineName, runId string, httpParameters *devops.HttpParameters) (*devops.PipelineRun, error)

func (*Jenkins) GetPipelineRunNodes 

func (j *Jenkins) GetPipelineRunNodes(projectName, pipelineName, runId string, httpParameters *devops.HttpParameters) ([]devops.PipelineRunNodes, error)

func (*Jenkins) GetProjectPipelineBuildByType 

func (j *Jenkins) GetProjectPipelineBuildByType(projectId, pipelineId string, status string) (build *devops.Build, err error)

func (*Jenkins) GetProjectPipelineConfig 

func (j *Jenkins) GetProjectPipelineConfig(projectId, pipelineId string) (*devopsv1alpha3.Pipeline, error)

func (*Jenkins) GetRunLog 

func (j *Jenkins) GetRunLog(projectName, pipelineName, runId string, httpParameters *devops.HttpParameters) ([]byte, error)

func (*Jenkins) GetSCMOrg 

func (j *Jenkins) GetSCMOrg(scmId string, httpParameters *devops.HttpParameters) ([]devops.SCMOrg, error)

func (*Jenkins) GetSCMServers 

func (j *Jenkins) GetSCMServers(scmId string, httpParameters *devops.HttpParameters) ([]devops.SCMServer, error)

func (*Jenkins) GetStepLog 

func (j *Jenkins) GetStepLog(projectName, pipelineName, runId, nodeId, stepId string, httpParameters *devops.HttpParameters) ([]byte, http.Header, error)

func (*Jenkins) GithubWebhook 

func (j *Jenkins) GithubWebhook(httpParameters *devops.HttpParameters) ([]byte, error)

func (*Jenkins) Init 

func (j *Jenkins) Init() (*Jenkins, error)

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) ListPipelineRuns 

func (j *Jenkins) ListPipelineRuns(projectName, pipelineName string, httpParameters *devops.HttpParameters) (*devops.PipelineRunList, error)

func (*Jenkins) ListPipelines 

func (j *Jenkins) ListPipelines(httpParameters *devops.HttpParameters) (*devops.PipelineList, error)

func (*Jenkins) Poll 

func (j *Jenkins) Poll() (int, error)

func (*Jenkins) RenameJob 

func (j *Jenkins) RenameJob(job string, name string) *Job

Rename a job. First Parameter job old name, Second Parameter job new name.

func (*Jenkins) ReplayBranchPipeline 

func (j *Jenkins) ReplayBranchPipeline(projectName, pipelineName, branchName, runId string, httpParameters *devops.HttpParameters) (*devops.ReplayPipeline, error)

func (*Jenkins) ReplayPipeline 

func (j *Jenkins) ReplayPipeline(projectName, pipelineName, runId string, httpParameters *devops.HttpParameters) (*devops.ReplayPipeline, error)

func (*Jenkins) RunBranchPipeline 

func (j *Jenkins) RunBranchPipeline(projectName, pipelineName, branchName string, httpParameters *devops.HttpParameters) (*devops.RunPipeline, error)

func (*Jenkins) RunPipeline 

func (j *Jenkins) RunPipeline(projectName, pipelineName string, httpParameters *devops.HttpParameters) (*devops.RunPipeline, error)

func (*Jenkins) ScanBranch 

func (j *Jenkins) ScanBranch(projectName, pipelineName string, httpParameters *devops.HttpParameters) ([]byte, error)

func (*Jenkins) SendPureRequest 

func (j *Jenkins) SendPureRequest(path string, httpParameters *devops.HttpParameters) ([]byte, error)

TODO: deprecated, use SendJenkinsRequestWithHeaderResp() instead

func (*Jenkins) SendPureRequestWithHeaderResp 

func (j *Jenkins) SendPureRequestWithHeaderResp(path string, httpParameters *devops.HttpParameters) ([]byte, http.Header, error)

SendPureRequestWithHeaderResp provider request header to call jenkins api. transfer bearer token to basic token for inner Oauth and Jenkins

func (*Jenkins) StopBranchPipeline 

func (j *Jenkins) StopBranchPipeline(projectName, pipelineName, branchName, runId string, httpParameters *devops.HttpParameters) (*devops.StopPipeline, error)

func (*Jenkins) StopPipeline 

func (j *Jenkins) StopPipeline(projectName, pipelineName, runId string, httpParameters *devops.HttpParameters) (*devops.StopPipeline, error)

func (*Jenkins) SubmitBranchInputStep 

func (j *Jenkins) SubmitBranchInputStep(projectName, pipelineName, branchName, runId, nodeId, stepId string, httpParameters *devops.HttpParameters) ([]byte, error)

func (*Jenkins) SubmitInputStep 

func (j *Jenkins) SubmitInputStep(projectName, pipelineName, runId, nodeId, stepId string, httpParameters *devops.HttpParameters) ([]byte, error)

func (*Jenkins) UpdateCredentialInProject 

func (j *Jenkins) UpdateCredentialInProject(projectId string, credential *v1.Secret) (string, error)

func (*Jenkins) UpdateProjectPipeline 

func (j *Jenkins) UpdateProjectPipeline(projectId string, pipeline *devopsv1alpha3.Pipeline) (string, error)

func (*Jenkins) Validate 

func (j *Jenkins) Validate(scmId string, httpParameters *devops.HttpParameters) (*devops.Validates, error)

func (*Jenkins) ValidateJenkinsfile 

func (j *Jenkins) ValidateJenkinsfile(jenkinsfile string) (*ValidateJenkinsfileResponse, error)

func (*Jenkins) ValidatePipelineJson 

func (j *Jenkins) ValidatePipelineJson(json string) (*ValidatePipelineJsonResponse, error)

type JenkinsBlueTime 

type JenkinsBlueTime time.Time

func (JenkinsBlueTime) MarshalJSON 

func (t JenkinsBlueTime) MarshalJSON() ([]byte, error)

func (*JenkinsBlueTime) UnmarshalJSON 

func (t *JenkinsBlueTime) UnmarshalJSON(b []byte) error

type JkError 

type JkError struct {
	Message string `json:"message"`
	Code    int    `json:"code"`
}

func (*JkError) Error 

func (err *JkError) Error() string

type Job 

type Job struct {
	Raw     *JobResponse
	Jenkins *Jenkins
	Base    string
}

func (*Job) Copy 

func (j *Job) Copy(destinationName string) (*Job, error)

func (*Job) Create 

func (j *Job) Create(config string, qr ...interface{}) (*Job, error)

func (*Job) Delete 

func (j *Job) Delete() (bool, error)

func (*Job) GetAllBuildIds 

func (j *Job) GetAllBuildIds() ([]JobBuild, error)

Returns All Builds with Number and URL

func (*Job) GetAllBuildStatus 

func (j *Job) GetAllBuildStatus() ([]JobBuildStatus, error)

func (*Job) GetBuild 

func (j *Job) GetBuild(id int64) (*Build, error)

func (*Job) GetConfig 

func (j *Job) GetConfig() (string, error)

func (*Job) GetDescription 

func (j *Job) GetDescription() string

func (*Job) GetDetails 

func (j *Job) GetDetails() *JobResponse

func (*Job) GetFirstBuild 

func (j *Job) GetFirstBuild() (*Build, error)

func (*Job) GetLastBuild 

func (j *Job) GetLastBuild() (*Build, error)

func (*Job) GetLastCompletedBuild 

func (j *Job) GetLastCompletedBuild() (*Build, error)

func (*Job) GetLastFailedBuild 

func (j *Job) GetLastFailedBuild() (*Build, error)

func (*Job) GetLastStableBuild 

func (j *Job) GetLastStableBuild() (*Build, error)

func (*Job) GetLastSuccessfulBuild 

func (j *Job) GetLastSuccessfulBuild() (*Build, error)

func (*Job) GetName 

func (j *Job) GetName() string

func (*Job) GetParameters 

func (j *Job) GetParameters() ([]ParameterDefinition, error)

func (*Job) HasQueuedBuild 

func (j *Job) HasQueuedBuild()

func (*Job) Invoke 

func (j *Job) Invoke(files []string, skipIfRunning bool, params map[string]string, cause string, securityToken string) (bool, error)

func (*Job) InvokeSimple 

func (j *Job) InvokeSimple(params map[string]string) (int64, error)

func (*Job) IsEnabled 

func (j *Job) IsEnabled() (bool, error)

func (*Job) IsRunning 

func (j *Job) IsRunning() (bool, error)

func (*Job) Poll 

func (j *Job) Poll() (int, error)

func (*Job) Rename 

func (j *Job) Rename(name string) (bool, error)

func (*Job) UpdateConfig 

func (j *Job) UpdateConfig(config string) error

type JobBuild 

type JobBuild struct {
	Number int64
	URL    string
}

type JobBuildStatus 

type JobBuildStatus struct {
	Number   int64
	Building bool
	Result   string
}

type JobResponse 

type JobResponse struct {
	Class              string `json:"_class"`
	Actions            []devops.GeneralAction
	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:"subJobs"`
	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"`
}

type Options 

type Options struct {
	Host             string        `json:",omitempty" yaml:"host" description:"Jenkins service host address"`
	Username         string        `json:",omitempty" yaml:"username" description:"Jenkins admin username"`
	Password         string        `json:",omitempty" yaml:"password" description:"Jenkins admin password"`
	ApiToken         string        `json:"apiToken,omitempty" yaml:"apiToken" description:"Jenkins admin apiToken"`
	MaxConnections   int           `json:"maxConnections,omitempty" yaml:"maxConnections" description:"Maximum connections allowed to connect to Jenkins"`
	Namespace        string        `json:"namespace,omitempty" yaml:"namespace"`
	WorkerNamespace  string        `json:"workerNamespace,omitempty" yaml:"workerNamespace"`
	ReloadCasCDelay  time.Duration `json:"reloadCasCDelay,omitempty" yaml:"reloadCasCDelay"`
	SkipVerify       bool
	SaveKubeConfigAs string `json:"saveKubeConfigAs,omitempty" yaml:"saveKubeConfigAs"` // values: [secret-text, kubeconfig]. default is kubeconfig
}

func NewJenkinsOptions 

func NewJenkinsOptions() *Options

NewJenkinsOptions returns a `zero` instance

func (*Options) AddFlags 

func (s *Options) AddFlags(fs *pflag.FlagSet, c *Options)

func (*Options) ApplyTo 

func (s *Options) ApplyTo(options *Options)

ApplyTo apply configuration to another options

func (*Options) Validate 

func (s *Options) Validate() []error

Validate check if there is misconfiguration in options

type Parameter 

type Parameter struct {
	Name  string
	Value string
}

type ParameterDefinition 

type ParameterDefinition struct {
	DefaultParameterValue struct {
		Name  string      `json:"name"`
		Value interface{} `json:"value"`
	} `json:"defaultParameterValue"`
	Description string `json:"description"`
	Name        string `json:"name"`
	Type        string `json:"type"`
}

type Pipeline 

type Pipeline struct {
	HttpParameters *devops.HttpParameters
	Jenkins        *Jenkins
	Path           string
}

func (*Pipeline) CheckCron 

func (p *Pipeline) CheckCron() (*devops.CheckCronRes, error)

func (*Pipeline) CheckPipelineName 

func (p *Pipeline) CheckPipelineName() (map[string]interface{}, error)

func (*Pipeline) CheckScriptCompile 

func (p *Pipeline) CheckScriptCompile() (*devops.CheckScript, error)

func (*Pipeline) CreateSCMServers 

func (p *Pipeline) CreateSCMServers() (*devops.SCMServer, error)

func (*Pipeline) GenericWebhook 

func (p *Pipeline) GenericWebhook() ([]byte, error)

func (*Pipeline) GetArtifacts 

func (p *Pipeline) GetArtifacts() ([]devops.Artifacts, error)

func (*Pipeline) GetBranchArtifacts 

func (p *Pipeline) GetBranchArtifacts() ([]devops.Artifacts, error)

func (*Pipeline) GetBranchNodeSteps 

func (p *Pipeline) GetBranchNodeSteps() ([]devops.NodeSteps, error)

func (*Pipeline) GetBranchPipeline 

func (p *Pipeline) GetBranchPipeline() (*devops.BranchPipeline, error)

func (*Pipeline) GetBranchPipelineRun 

func (p *Pipeline) GetBranchPipelineRun() (*devops.PipelineRun, error)

func (*Pipeline) GetBranchPipelineRunNodes 

func (p *Pipeline) GetBranchPipelineRunNodes() ([]devops.BranchPipelineRunNodes, error)

func (*Pipeline) GetBranchRunLog 

func (p *Pipeline) GetBranchRunLog() ([]byte, error)

func (*Pipeline) GetBranchStepLog 

func (p *Pipeline) GetBranchStepLog() ([]byte, http.Header, error)

func (*Pipeline) GetConsoleLog 

func (p *Pipeline) GetConsoleLog() ([]byte, error)

func (*Pipeline) GetCrumb 

func (p *Pipeline) GetCrumb() (*devops.Crumb, error)

func (*Pipeline) GetNodeSteps 

func (p *Pipeline) GetNodeSteps() ([]devops.NodeSteps, error)

func (*Pipeline) GetNotifyCommit 

func (p *Pipeline) GetNotifyCommit() ([]byte, error)

func (*Pipeline) GetOrgRepo 

func (p *Pipeline) GetOrgRepo() (devops.OrgRepo, error)

func (*Pipeline) GetPipeline 

func (p *Pipeline) GetPipeline() (*devops.Pipeline, error)

func (*Pipeline) GetPipelineBranch 

func (p *Pipeline) GetPipelineBranch() (*devops.PipelineBranch, error)

func (*Pipeline) GetPipelineRun 

func (p *Pipeline) GetPipelineRun() (*devops.PipelineRun, error)

func (*Pipeline) GetPipelineRunNodes 

func (p *Pipeline) GetPipelineRunNodes() ([]devops.PipelineRunNodes, error)

func (*Pipeline) GetRunLog 

func (p *Pipeline) GetRunLog() ([]byte, error)

func (*Pipeline) GetSCMOrg 

func (p *Pipeline) GetSCMOrg() ([]devops.SCMOrg, error)

func (*Pipeline) GetSCMServers 

func (p *Pipeline) GetSCMServers() ([]devops.SCMServer, error)

func (*Pipeline) GetStepLog 

func (p *Pipeline) GetStepLog() ([]byte, http.Header, error)

func (*Pipeline) GithubWebhook 

func (p *Pipeline) GithubWebhook() ([]byte, error)

func (*Pipeline) ListPipelineRuns 

func (p *Pipeline) ListPipelineRuns() (*devops.PipelineRunList, error)

func (*Pipeline) ListPipelines 

func (p *Pipeline) ListPipelines() (*devops.PipelineList, error)

func (*Pipeline) ReplayBranchPipeline 

func (p *Pipeline) ReplayBranchPipeline() (*devops.ReplayPipeline, error)

func (*Pipeline) ReplayPipeline 

func (p *Pipeline) ReplayPipeline() (*devops.ReplayPipeline, error)

func (*Pipeline) RunBranchPipeline 

func (p *Pipeline) RunBranchPipeline() (*devops.RunPipeline, error)

func (*Pipeline) RunPipeline 

func (p *Pipeline) RunPipeline() (*devops.RunPipeline, error)

func (*Pipeline) ScanBranch 

func (p *Pipeline) ScanBranch() ([]byte, error)

func (*Pipeline) StopBranchPipeline 

func (p *Pipeline) StopBranchPipeline() (*devops.StopPipeline, error)

func (*Pipeline) StopPipeline 

func (p *Pipeline) StopPipeline() (*devops.StopPipeline, error)

func (*Pipeline) SubmitBranchInputStep 

func (p *Pipeline) SubmitBranchInputStep() ([]byte, error)

func (*Pipeline) SubmitInputStep 

func (p *Pipeline) SubmitInputStep() ([]byte, error)

func (*Pipeline) ToJSON 

func (p *Pipeline) ToJSON() (result map[string]interface{}, err error)

func (*Pipeline) ToJenkinsfile 

func (p *Pipeline) ToJenkinsfile() (*devops.ResJenkinsfile, error)

func (*Pipeline) Validate 

func (p *Pipeline) Validate() (*devops.Validates, error)

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 (r *Requester) DoPostForm(ar *APIRequest, responseStruct interface{}, form map[string]string) (*http.Response, error)

func (*Requester) Get 

func (r *Requester) Get(endpoint string, responseStruct interface{}, querystring map[string]string) (*http.Response, error)

func (*Requester) GetHtml 

func (r *Requester) GetHtml(endpoint string, responseStruct interface{}, querystring map[string]string) (*http.Response, error)

func (*Requester) GetJSON 

func (r *Requester) GetJSON(endpoint string, responseStruct interface{}, query map[string]string) (*http.Response, error)

func (*Requester) GetXML 

func (r *Requester) GetXML(endpoint string, responseStruct interface{}, query map[string]string) (*http.Response, error)

func (*Requester) Post 

func (r *Requester) Post(endpoint string, payload io.Reader, responseStruct interface{}, querystring map[string]string) (*http.Response, error)

func (*Requester) PostFiles 

func (r *Requester) PostFiles(endpoint string, payload io.Reader, responseStruct interface{}, querystring map[string]string, files []string) (*http.Response, error)

func (*Requester) PostForm 

func (r *Requester) PostForm(endpoint string, payload io.Reader, responseStruct interface{}, formString map[string]string) (*http.Response, error)

func (*Requester) PostJSON 

func (r *Requester) PostJSON(endpoint string, payload io.Reader, responseStruct interface{}, querystring map[string]string) (*http.Response, error)

func (*Requester) PostXML 

func (r *Requester) PostXML(endpoint string, xml string, responseStruct interface{}, querystring map[string]string) (*http.Response, error)

func (*Requester) ReadJSONResponse 

func (r *Requester) ReadJSONResponse(response *http.Response, responseStruct interface{}) (*http.Response, error)

func (*Requester) ReadRawResponse 

func (r *Requester) ReadRawResponse(response *http.Response, responseStruct interface{}) (*http.Response, error)

func (*Requester) SetClient 

func (r *Requester) SetClient(client *http.Client) *Requester

func (*Requester) SetCrumb 

func (r *Requester) SetCrumb(ar *APIRequest) error

func (*Requester) SetCrumbForConsumer 

func (r *Requester) SetCrumbForConsumer(crumbConsumer func(crumbRequestField, crumb string)) error

SetCrumbForConsumer makes crumb consumer set the crumb. Crumb consumer accepts crumb request field and crumb parameters and can handle the crumb whatever it likes.

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 ValidateJenkinsfileResponse 

type ValidateJenkinsfileResponse struct {
	Status string `json:"status"`
	Data   struct {
		Result string                   `json:"result"`
		Errors []map[string]interface{} `json:"errors"`
	} `json:"data"`
}

type ValidatePipelineJsonResponse 

type ValidatePipelineJsonResponse struct {
	Status string `json:"status"`
	Data   struct {
		Result string                   `json:"result"`
		Errors []map[string]interface{} `json:"errors"`
	}
}

Source Files

View all Source files

Directories

Path Synopsis

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.