plugin.go

package main

import (
	"path/filepath"
	"strings"

	"github.com/dronestock/drone"
	"github.com/goexl/gox"
	"github.com/goexl/gox/field"
)

type plugin struct {
	drone.Base

	// 执行程序
	Binary binary `default:"${BINARY}"`
	// 源文件目录
	Source string `default:"${SOURCE=.}"`
	// 目标
	Target *target `default:"${TARGET}" validate:"omitempty,required_without=Targets"`
	// 目标列表
	Targets []*target `default:"${TARGETS}" validate:"omitempty,required_without=Target"`

	// 第三方库列表
	Includes []string `default:"${INCLUDES}"`
	// 标签列表
	Tags []string `default:"${TAGS}"`
	// 插件列表
	Plugins []string `json:"plugins"`
	// 有警告时不允许编译通过
	FatalWarnings bool `default:"${FATAL_WARNINGS=true}"`

	// 额外特性
	// 静态检查
	Lint lint `default:"${LINT}"`
	// 生成描述信息文件
	Descriptor *descriptor `default:"${DESCRIPTOR}" validate:"omitempty,required_without=Descriptors"`
	// 生成描述信息文件列表
	Descriptors []*descriptor `default:"${DESCRIPTORS}" validate:"omitempty,required_without=Descriptor"`
	// 文件复制列表，在执行完所有操作后，将输入目录的文件或者目录复制到输出目录
	Copies []string `default:"${COPIES}"`
}

func newPlugin() drone.Plugin {
	return new(plugin)
}

func (p *plugin) Config() drone.Config {
	return p
}

func (p *plugin) Setup() (err error) {
	if nil != p.Target {
		if nil == p.Targets {
			p.Targets = make([]*target, 0, 1)
		}
		p.Targets = append(p.Targets, p.Target)
	}

	if nil != p.Descriptor {
		if nil == p.Descriptors {
			p.Descriptors = make([]*descriptor, 0, 1)
		}
		p.Descriptors = append(p.Descriptors, p.Descriptor)
	}

	return
}

func (p *plugin) Steps() drone.Steps {
	return drone.Steps{
		// 纯静态检查，不需要重试
		drone.NewStep(newLintStep(p)).Name("检查").Interrupt().Build(),
		// 编译，不依赖网络环境，不需要重试
		drone.NewStep(newBuildStep(p)).Name("编译").Interrupt().Build(),
		// 注入，不依赖网络环境，不需要重试
		drone.NewStep(newInjectStep(p)).Name("注入").Interrupt().Build(),
		// 描述文件，不依赖网络环境，不需要重试
		drone.NewStep(newDescriptorStep(p)).Name("描述").Interrupt().Build(),
		// 复制，不依赖网络环境，不需要重试
		drone.NewStep(newCopyStep(p)).Name("复制").Interrupt().Build(),
	}
}

func (p *plugin) Fields() gox.Fields[any] {
	return gox.Fields[any]{
		field.New("input", p.Source),
		field.New("targets", p.Targets),

		field.New("includes", p.Includes),
		field.New("tags", p.Tags),

		field.New("copies", p.Copies),
	}
}

func (p *plugin) tags() (tags []string) {
	tags = p.Tags
	if *p.Defaults {
		tags = append(tags, "experimental_allow_proto3_optional")
	}

	return
}

func (p *plugin) buildable(path string) (buildable bool, err error) {
	if buildable, err = filepath.Match(protoFilePattern, filepath.Base(path)); nil != err || !buildable {
		return
	}

	buildable = true
	for _, include := range p.Includes {
		if strings.HasPrefix(filepath.Dir(path), include) {
			buildable = false
		}
		if !buildable {
			break
		}
	}

	return
}