File: core_manager.go

package info (click to toggle)
vagrant 2.3.7%2Bgit20230731.5fc64cde%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 17,616 kB
  • sloc: ruby: 111,820; sh: 462; makefile: 123; ansic: 34; lisp: 1
file content (115 lines) | stat: -rw-r--r-- 2,649 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
package core

import (
	"context"
	"io"
	"sync"

	"github.com/hashicorp/go-argmapper"
	"github.com/hashicorp/go-hclog"
	"github.com/hashicorp/go-plugin"
	sdkcore "github.com/hashicorp/vagrant-plugin-sdk/core"
	"github.com/hashicorp/vagrant-plugin-sdk/internal-shared/cacher"
	"github.com/hashicorp/vagrant-plugin-sdk/internal-shared/cleanup"
	"github.com/hashicorp/vagrant-plugin-sdk/internal-shared/protomappers"
	intplugin "github.com/hashicorp/vagrant/internal/plugin"
	"google.golang.org/protobuf/encoding/protojson"
)

type CoreManager struct {
	cleanup cleanup.Cleanup
	ctx     context.Context
	logger  hclog.Logger // Logger for the manager
	m       sync.Mutex
	srv     []byte // Marshalled proto message for plugin manager
}

func NewCoreManager(ctx context.Context, l hclog.Logger) *CoreManager {
	var logger hclog.Logger
	if l.IsTrace() {
		logger = l.Named("coremanager")
	} else {
		logger = l.ResetNamed("coremanager")
	}

	return &CoreManager{
		cleanup: cleanup.New(),
		ctx:     ctx,
		logger:  logger,
	}
}

func (m *CoreManager) generatePlugin(fn func() (plg interface{})) (plg interface{}, err error) {
	plg = fn()
	if p, ok := plg.(io.Closer); ok {
		m.cleanup.Do(func() error {
			return p.Close()
		})
	}
	return plg, nil
}

// Get a fresh instance of a core plugin
func (m *CoreManager) GetPlugin(pluginType sdkcore.Type) (plg interface{}, err error) {
	switch pluginType {
	case sdkcore.BoxCollectionType:
		return m.generatePlugin(func() (plg interface{}) {
			return &BoxCollection{}
		})
	case sdkcore.BoxMetadataType:
		return m.generatePlugin(func() (plg interface{}) {
			return &BoxMetadata{}
		})
	case sdkcore.BoxType:
		return m.generatePlugin(func() (plg interface{}) {
			return &Box{}
		})
	case sdkcore.StateBagType:
		return m.generatePlugin(func() (plg interface{}) {
			return NewStateBag()
		})
	}
	return
}

func (m *CoreManager) Servinfo(broker *plugin.GRPCBroker) ([]byte, error) {
	if m.srv != nil {
		return m.srv, nil
	}

	i := intplugin.NewInternal(
		broker,
		cacher.New(),
		m.cleanup,
		m.logger,
		[]*argmapper.Func{},
	)

	p, err := protomappers.CorePluginManagerProto(m, m.logger, i)
	if err != nil {
		m.logger.Warn("failed to create plugin manager grpc server",
			"error", err,
		)

		return nil, err
	}

	m.logger.Info("new GRPC server instance started",
		"address", p.Addr,
	)

	m.srv, err = protojson.Marshal(p)

	return m.srv, err
}

// Close the manager (and all managed plugins)
func (m *CoreManager) Close() error {
	m.m.Lock()
	defer m.m.Unlock()

	m.logger.Warn("closing the core plugin manager")
	return m.cleanup.Close()
}

var _ sdkcore.CorePluginManager = (*CoreManager)(nil)