packer-cn/packer-plugin-sdk/rpc/build.go

174 lines
3.8 KiB
Go
Raw Normal View History

package rpc
import (
"context"
"log"
packersdk "github.com/hashicorp/packer/packer-plugin-sdk/packer"
)
// An implementation of packersdk.Build where the build is actually executed
// over an RPC connection.
2013-05-22 01:38:41 -04:00
type build struct {
build using HCL2 (#8423) This follows #8232 which added the code to generate the code required to parse HCL files for each packer component. All old config files of packer will keep on working the same. Packer takes one argument. When a directory is passed, all files in the folder with a name ending with “.pkr.hcl” or “.pkr.json” will be parsed using the HCL2 format. When a file ending with “.pkr.hcl” or “.pkr.json” is passed it will be parsed using the HCL2 format. For every other case; the old packer style will be used. ## 1. the hcl2template pkg can create a packer.Build from a set of HCL (v2) files I had to make the packer.coreBuild (which is our one and only packer.Build ) a public struct with public fields ## 2. Components interfaces get a new ConfigSpec Method to read a file from an HCL file. This is a breaking change for packer plugins. a packer component can be a: builder/provisioner/post-processor each component interface now gets a `ConfigSpec() hcldec.ObjectSpec` which allows packer to tell what is the layout of the hcl2 config meant to configure that specific component. This ObjectSpec is sent through the wire (RPC) and a cty.Value is now sent through the already existing configuration entrypoints: Provisioner.Prepare(raws ...interface{}) error Builder.Prepare(raws ...interface{}) ([]string, error) PostProcessor.Configure(raws ...interface{}) error close #1768 Example hcl files: ```hcl // file amazon-ebs-kms-key/run.pkr.hcl build { sources = [ "source.amazon-ebs.first", ] provisioner "shell" { inline = [ "sleep 5" ] } post-processor "shell-local" { inline = [ "sleep 5" ] } } // amazon-ebs-kms-key/source.pkr.hcl source "amazon-ebs" "first" { ami_name = "hcl2-test" region = "us-east-1" instance_type = "t2.micro" kms_key_id = "c729958f-c6ba-44cd-ab39-35ab68ce0a6c" encrypt_boot = true source_ami_filter { filters { virtualization-type = "hvm" name = "amzn-ami-hvm-????.??.?.????????-x86_64-gp2" root-device-type = "ebs" } most_recent = true owners = ["amazon"] } launch_block_device_mappings { device_name = "/dev/xvda" volume_size = 20 volume_type = "gp2" delete_on_termination = "true" } launch_block_device_mappings { device_name = "/dev/xvdf" volume_size = 500 volume_type = "gp2" delete_on_termination = true encrypted = true } ami_regions = ["eu-central-1"] run_tags { Name = "packer-solr-something" stack-name = "DevOps Tools" } communicator = "ssh" ssh_pty = true ssh_username = "ec2-user" associate_public_ip_address = true } ```
2019-12-17 05:25:56 -05:00
commonClient
}
// BuildServer wraps a packersdk.Build implementation and makes it exportable
// as part of a Golang RPC server.
type BuildServer struct {
context context.Context
contextCancel func()
build packersdk.Build
2014-09-02 17:23:06 -04:00
mux *muxBroker
}
type BuildPrepareResponse struct {
Warnings []string
Error *BasicError
}
2013-05-22 01:38:41 -04:00
func (b *build) Name() (result string) {
b.client.Call("Build.Name", new(interface{}), &result)
2013-05-09 14:32:03 -04:00
return
}
func (b *build) Prepare() ([]string, error) {
var resp BuildPrepareResponse
if cerr := b.client.Call("Build.Prepare", new(interface{}), &resp); cerr != nil {
return nil, cerr
2013-05-22 19:20:40 -04:00
}
var err error = nil
if resp.Error != nil {
err = resp.Error
}
2013-05-22 19:20:40 -04:00
return resp.Warnings, err
}
func (b *build) Run(ctx context.Context, ui packersdk.Ui) ([]packersdk.Artifact, error) {
2013-12-10 16:18:48 -05:00
nextId := b.mux.NextId()
server := newServerWithMux(b.mux, nextId)
2013-12-10 16:18:48 -05:00
server.RegisterUi(ui)
go server.Serve()
done := make(chan interface{})
defer close(done)
go func() {
select {
case <-ctx.Done():
log.Printf("Cancelling build after context cancellation %v", ctx.Err())
if err := b.client.Call("Build.Cancel", new(interface{}), new(interface{})); err != nil {
log.Printf("Error cancelling builder: %s", err)
}
case <-done:
}
}()
2013-12-10 16:18:48 -05:00
var result []uint32
if err := b.client.Call("Build.Run", nextId, &result); err != nil {
return nil, err
2013-05-22 01:38:41 -04:00
}
artifacts := make([]packersdk.Artifact, len(result))
2013-12-10 16:18:48 -05:00
for i, streamId := range result {
client, err := newClientWithMux(b.mux, streamId)
if err != nil {
return nil, err
}
2013-12-10 16:18:48 -05:00
artifacts[i] = client.Artifact()
2013-05-22 01:38:41 -04:00
}
return artifacts, nil
}
2013-06-14 15:22:19 -04:00
func (b *build) SetDebug(val bool) {
if err := b.client.Call("Build.SetDebug", val, new(interface{})); err != nil {
2013-06-14 15:22:19 -04:00
panic(err)
}
}
func (b *build) SetForce(val bool) {
if err := b.client.Call("Build.SetForce", val, new(interface{})); err != nil {
panic(err)
}
}
func (b *build) SetOnError(val string) {
if err := b.client.Call("Build.SetOnError", val, new(interface{})); err != nil {
panic(err)
}
}
func (b *build) Cancel() {
if err := b.client.Call("Build.Cancel", new(interface{}), new(interface{})); err != nil {
2013-06-03 19:03:08 -04:00
panic(err)
}
}
2013-05-10 20:01:24 -04:00
func (b *BuildServer) Name(args *interface{}, reply *string) error {
2013-05-09 14:32:03 -04:00
*reply = b.build.Name()
return nil
}
func (b *BuildServer) Prepare(args *interface{}, resp *BuildPrepareResponse) error {
warnings, err := b.build.Prepare()
*resp = BuildPrepareResponse{
Warnings: warnings,
Error: NewBasicError(err),
}
return nil
}
func (b *BuildServer) Run(streamId uint32, reply *[]uint32) error {
if b.context == nil {
b.context, b.contextCancel = context.WithCancel(context.Background())
}
client, err := newClientWithMux(b.mux, streamId)
if err != nil {
2013-12-10 16:18:48 -05:00
return NewBasicError(err)
}
2013-12-10 16:18:48 -05:00
defer client.Close()
artifacts, err := b.build.Run(b.context, client.Ui())
if err != nil {
return NewBasicError(err)
}
2013-05-22 01:38:41 -04:00
2013-12-10 16:18:48 -05:00
*reply = make([]uint32, len(artifacts))
for i, artifact := range artifacts {
2013-12-10 16:18:48 -05:00
streamId := b.mux.NextId()
server := newServerWithMux(b.mux, streamId)
2013-12-10 16:18:48 -05:00
server.RegisterArtifact(artifact)
go server.Serve()
(*reply)[i] = streamId
}
return nil
}
2013-06-03 19:03:08 -04:00
2013-06-14 15:22:19 -04:00
func (b *BuildServer) SetDebug(val *bool, reply *interface{}) error {
b.build.SetDebug(*val)
return nil
}
func (b *BuildServer) SetForce(val *bool, reply *interface{}) error {
b.build.SetForce(*val)
return nil
}
func (b *BuildServer) SetOnError(val *string, reply *interface{}) error {
b.build.SetOnError(*val)
return nil
}
2013-06-03 19:03:08 -04:00
func (b *BuildServer) Cancel(args *interface{}, reply *interface{}) error {
if b.contextCancel != nil {
b.contextCancel()
}
2013-06-03 19:03:08 -04:00
return nil
}