summaryrefslogtreecommitdiffstats
path: root/plugin/rpcplugin/supervisor_test.go
blob: 438ebe02ac15187eab84c25540fbdecf4a91a262 (plain)
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
package rpcplugin

import (
	"io/ioutil"
	"os"
	"path/filepath"
	"testing"
	"time"

	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"

	"github.com/mattermost/platform/plugin"
)

func TestSupervisor(t *testing.T) {
	dir, err := ioutil.TempDir("", "")
	require.NoError(t, err)
	defer os.RemoveAll(dir)

	backend := filepath.Join(dir, "backend.exe")
	compileGo(t, `
		package main

		import (
			"github.com/mattermost/platform/plugin"
			"github.com/mattermost/platform/plugin/rpcplugin"
		)

		type MyPlugin struct {}

		func (p *MyPlugin) OnActivate(api plugin.API) error {
			return nil
		}

		func (p *MyPlugin) OnDeactivate() error {
			return nil
		}

		func main() {
			rpcplugin.Main(&MyPlugin{})
		}
	`, backend)

	ioutil.WriteFile(filepath.Join(dir, "plugin.json"), []byte(`{"id": "foo", "backend": {"executable": "backend.exe"}}`), 0600)

	bundle := plugin.BundleInfoForPath(dir)
	supervisor, err := SupervisorProvider(bundle)
	require.NoError(t, err)
	require.NoError(t, supervisor.Start())
	require.NoError(t, supervisor.Hooks().OnActivate(nil))
	require.NoError(t, supervisor.Stop())
}

// If plugin development goes really wrong, let's make sure plugin activation won't block forever.
func TestSupervisor_StartTimeout(t *testing.T) {
	dir, err := ioutil.TempDir("", "")
	require.NoError(t, err)
	defer os.RemoveAll(dir)

	backend := filepath.Join(dir, "backend.exe")
	compileGo(t, `
		package main

		func main() {
			for {
			}
		}
	`, backend)

	ioutil.WriteFile(filepath.Join(dir, "plugin.json"), []byte(`{"id": "foo", "backend": {"executable": "backend.exe"}}`), 0600)

	bundle := plugin.BundleInfoForPath(dir)
	supervisor, err := SupervisorProvider(bundle)
	require.NoError(t, err)
	require.Error(t, supervisor.Start())
}

// Crashed plugins should be relaunched.
func TestSupervisor_PluginCrash(t *testing.T) {
	dir, err := ioutil.TempDir("", "")
	require.NoError(t, err)
	defer os.RemoveAll(dir)

	backend := filepath.Join(dir, "backend.exe")
	compileGo(t, `
		package main

		import (
			"os"

			"github.com/mattermost/platform/plugin"
			"github.com/mattermost/platform/plugin/rpcplugin"
		)

		type MyPlugin struct {}

		func (p *MyPlugin) OnActivate(api plugin.API) error {
			os.Exit(1)
			return nil
		}

		func (p *MyPlugin) OnDeactivate() error {
			return nil
		}

		func main() {
			rpcplugin.Main(&MyPlugin{})
		}
	`, backend)

	ioutil.WriteFile(filepath.Join(dir, "plugin.json"), []byte(`{"id": "foo", "backend": {"executable": "backend.exe"}}`), 0600)

	bundle := plugin.BundleInfoForPath(dir)
	supervisor, err := SupervisorProvider(bundle)
	require.NoError(t, err)
	require.NoError(t, supervisor.Start())
	require.Error(t, supervisor.Hooks().OnActivate(nil))

	recovered := false
	for i := 0; i < 30; i++ {
		if supervisor.Hooks().OnDeactivate() == nil {
			recovered = true
			break
		}
		time.Sleep(time.Millisecond * 100)
	}
	assert.True(t, recovered)
	require.NoError(t, supervisor.Stop())
}