使用codeship-go与Codeship API v2交互

codeship-go是一个非官方的Golang客户端库，用于与Codeship API v2进行交互。下面我将介绍如何使用这个库来管理你的Codeship项目、构建和部署。

安装

首先，安装codeship-go库：

go get github.com/codeship/codeship-go

基本用法

1. 初始化客户端

package main

import (
	"context"
	"fmt"
	"log"

	"github.com/codeship/codeship-go"
)

func main() {
	// 使用你的Codeship用户名和API密钥初始化客户端
	auth := codeship.NewBasicAuth("your_username", "your_api_key")
	client, err := codeship.New(auth)
	if err != nil {
		log.Fatal(err)
	}

	ctx := context.Background()

	// 测试连接
	_, _, err = client.Organizations.List(ctx, codeship.NewPagination(1, 10))
	if err != nil {
		log.Fatalf("Failed to connect to Codeship: %v", err)
	}

	fmt.Println("Successfully connected to Codeship API")
}

2. 列出组织和项目

// 列出所有组织
orgs, _, err := client.Organizations.List(ctx, codeship.NewPagination(1, 10))
if err != nil {
	log.Fatal(err)
}

fmt.Println("Organizations:")
for _, org := range orgs.Organizations {
	fmt.Printf("- %s (UUID: %s)\n", org.Name, org.UUID)
	
	// 列出组织下的项目
	projects, _, err := client.Projects.List(ctx, org.UUID, codeship.NewPagination(1, 10))
	if err != nil {
		log.Printf("Failed to get projects for org %s: %v", org.Name, err)
		continue
	}
	
	for _, project := range projects.Projects {
		fmt.Printf("  - %s (UUID: %s)\n", project.Name, project.UUID)
	}
}

3. 触发构建

// 触发新构建
func triggerBuild(client *codeship.Client, orgUUID, projectUUID, branch string) {
	build, _, err := client.Builds.Create(ctx, orgUUID, projectUUID, branch)
	if err != nil {
		log.Fatalf("Failed to trigger build: %v", err)
	}
	
	fmt.Printf("Build triggered! Build ID: %d, Status: %s\n", build.ID, build.Status)
}

4. 获取构建状态

// 获取构建状态
func getBuildStatus(client *codeship.Client, orgUUID, projectUUID string, buildID int) {
	build, _, err := client.Builds.Get(ctx, orgUUID, projectUUID, buildID)
	if err != nil {
		log.Fatalf("Failed to get build status: %v", err)
	}
	
	fmt.Printf("Build %d status: %s\n", build.ID, build.Status)
	fmt.Printf("Commit: %s by %s\n", build.CommitMessage, build.Committer)
	if build.FinishedAt != nil {
		fmt.Printf("Duration: %v\n", build.FinishedAt.Sub(build.StartedAt))
	}
}

5. 处理Webhooks

Codeship可以通过Webhook通知你构建状态的变化。以下是如何验证和处理这些Webhook：

import "github.com/codeship/codeship-go/webhook"

func handleWebhook(secret string, payload []byte) {
	// 验证Webhook签名
	hook, err := webhook.Parse(secret, payload)
	if err != nil {
		log.Printf("Invalid webhook: %v", err)
		return
	}

	switch hook := hook.(type) {
	case *webhook.BuildWebhook:
		fmt.Printf("Build %d status changed to %s\n", hook.Build.ID, hook.Build.Status)
		fmt.Printf("Project: %s, Branch: %s\n", hook.Project.Name, hook.Build.Branch)
	case *webhook.DeployWebhook:
		fmt.Printf("Deploy %d status changed to %s\n", hook.Deploy.ID, hook.Deploy.Status)
	default:
		fmt.Println("Unknown webhook type received")
	}
}

高级用法

1. 分页处理

func listAllProjects(client *codeship.Client, orgUUID string) {
	page := 1
	perPage := 50
	
	for {
		projects, resp, err := client.Projects.List(ctx, orgUUID, codeship.NewPagination(page, perPage))
		if err != nil {
			log.Fatal(err)
		}
		
		for _, project := range projects.Projects {
			fmt.Printf("Project: %s (UUID: %s)\n", project.Name, project.UUID)
		}
		
		if page*perPage >= projects.Total {
			break
		}
		page++
	}
}

2. 错误处理

func safeGetBuild(client *codeship.Client, orgUUID, projectUUID string, buildID int) (*codeship.Build, error) {
	build, resp, err := client.Builds.Get(ctx, orgUUID, projectUUID, buildID)
	if err != nil {
		if resp != nil && resp.StatusCode == 404 {
			return nil, fmt.Errorf("build not found")
		}
		return nil, fmt.Errorf("API error: %v", err)
	}
	return build, nil
}

最佳实践

1. 缓存组织UUID和项目UUID：这些UUID不会改变，可以缓存以减少API调用
2. 处理速率限制：Codeship API有速率限制，实现适当的重试逻辑
3. 上下文超时：为长时间运行的API调用设置合理的超时
4. 日志记录：记录重要的API交互以便调试

完整示例

package main

import (
	"context"
	"fmt"
	"log"
	"time"

	"github.com/codeship/codeship-go"
)

func main() {
	auth := codeship.NewBasicAuth("your_username", "your_api_key")
	client, err := codeship.New(auth)
	if err != nil {
		log.Fatal(err)
	}

	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
	defer cancel()

	// 获取第一个组织
	orgs, _, err := client.Organizations.List(ctx, codeship.NewPagination(1, 1))
	if err != nil {
		log.Fatal(err)
	}
	if len(orgs.Organizations) == 0 {
		log.Fatal("No organizations found")
	}
	org := orgs.Organizations[0]

	// 列出项目
	projects, _, err := client.Projects.List(ctx, org.UUID, codeship.NewPagination(1, 10))
	if err != nil {
		log.Fatal(err)
	}

	// 触发每个项目的master分支构建
	for _, project := range projects.Projects {
		fmt.Printf("Triggering build for project %s...\n", project.Name)
		build, _, err := client.Builds.Create(ctx, org.UUID, project.UUID, "master")
		if err != nil {
			log.Printf("Failed to trigger build for %s: %v", project.Name, err)
			continue
		}
		fmt.Printf("Build %d started for %s\n", build.ID, project.Name)
	}
}

这个库提供了与Codeship API交互的全面功能，包括管理组织、项目、构建和部署。根据你的具体需求，你可以扩展这些基本示例来实现更复杂的CI/CD自动化流程。