使用Go语言管理Jenkins CLI工具(jcli)

jcli是一个用于管理Jenkins的命令行工具，它提供了丰富的功能来与Jenkins服务器交互。下面我将介绍如何使用Go语言来操作jcli工具。

安装jcli

首先需要安装jcli工具，可以通过以下命令安装：

go get -u github.com/jenkins-zh/jenkins-cli

或者从GitHub Releases页面下载预编译的二进制文件。

基本用法

1. 配置Jenkins服务器

在使用jcli前，需要先配置Jenkins服务器连接信息：

jcli config add -n my-jenkins -u http://jenkins.example.com -u admin -t your-api-token

2. Go代码中调用jcli

以下是一个简单的Go程序，演示如何通过exec包调用jcli：

package main

import (
	"bytes"
	"fmt"
	"log"
	"os/exec"
)

func main() {
	// 获取Jenkins版本
	version, err := runJcliCommand("version")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println("Jenkins Version:", version)

	// 列出所有插件
	plugins, err := runJcliCommand("plugin list")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println("Installed Plugins:\n", plugins)
}

func runJcliCommand(args string) (string, error) {
	cmd := exec.Command("jcli", args)
	var out bytes.Buffer
	cmd.Stdout = &out
	err := cmd.Run()
	if err != nil {
		return "", err
	}
	return out.String(), nil
}

高级用法

1. 插件管理

// 安装插件
func installPlugin(pluginName string) error {
	cmd := exec.Command("jcli", "plugin", "install", pluginName)
	return cmd.Run()
}

// 卸载插件
func uninstallPlugin(pluginName string) error {
	cmd := exec.Command("jcli", "plugin", "uninstall", pluginName)
	return cmd.Run()
}

// 更新插件
func updatePlugin(pluginName string) error {
	cmd := exec.Command("jcli", "plugin", "update", pluginName)
	return cmd.Run()
}

2. 作业管理

// 获取作业列表
func getJobList() (string, error) {
	cmd := exec.Command("jcli", "job", "list")
	var out bytes.Buffer
	cmd.Stdout = &out
	err := cmd.Run()
	if err != nil {
		return "", err
	}
	return out.String(), nil
}

// 触发构建
func buildJob(jobName string) error {
	cmd := exec.Command("jcli", "job", "build", jobName)
	return cmd.Run()
}

// 获取构建日志
func getBuildLog(jobName string, buildNumber int) (string, error) {
	cmd := exec.Command("jcli", "job", "log", jobName, fmt.Sprintf("%d", buildNumber))
	var out bytes.Buffer
	cmd.Stdout = &out
	err := cmd.Run()
	if err != nil {
		return "", err
	}
	return out.String(), nil
}

3. 使用REST API直接交互

jcli底层也是调用Jenkins的REST API，你也可以直接使用Go的HTTP客户端与Jenkins交互：

package main

import (
	"encoding/json"
	"fmt"
	"io/ioutil"
	"net/http"
)

type JenkinsPlugin struct {
	Name    string `json:"name"`
	Version string `json:"version"`
	Active  bool   `json:"active"`
}

func main() {
	jenkinsURL := "http://jenkins.example.com"
	username := "admin"
	apiToken := "your-api-token"

	// 获取插件列表
	plugins, err := getPlugins(jenkinsURL, username, apiToken)
	if err != nil {
		fmt.Println("Error:", err)
		return
	}

	for _, plugin := range plugins {
		fmt.Printf("%s (%s) - Active: %v\n", plugin.Name, plugin.Version, plugin.Active)
	}
}

func getPlugins(url, username, token string) ([]JenkinsPlugin, error) {
	client := &http.Client{}
	req, err := http.NewRequest("GET", url+"/pluginManager/api/json?depth=1", nil)
	if err != nil {
		return nil, err
	}

	req.SetBasicAuth(username, token)
	resp, err := client.Do(req)
	if err != nil {
		return nil, err
	}
	defer resp.Body.Close()

	body, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		return nil, err
	}

	var result struct {
		Plugins []JenkinsPlugin `json:"plugins"`
	}
	err = json.Unmarshal(body, &result)
	if err != nil {
		return nil, err
	}

	return result.Plugins, nil
}

最佳实践

1. 错误处理：确保正确处理所有可能的错误
2. 并发控制：如果需要批量操作，考虑使用goroutine和channel
3. 配置管理：将Jenkins配置存储在配置文件中，而不是硬编码
4. 日志记录：记录重要操作和错误信息
5. 超时控制：为长时间运行的操作设置超时

总结

通过jcli工具，我们可以方便地在Go程序中管理Jenkins实例。无论是简单的命令行调用还是直接使用REST API，Go都提供了强大的工具来构建Jenkins自动化管理工具。

希望这些示例能帮助你开始使用Go语言管理Jenkins。根据你的具体需求，可以进一步扩展这些基础功能。