summaryrefslogtreecommitdiffstats
path: root/plugin/rpcplugin/rpcplugintest/supervisor.go
diff options
context:
space:
mode:
Diffstat (limited to 'plugin/rpcplugin/rpcplugintest/supervisor.go')
-rw-r--r--plugin/rpcplugin/rpcplugintest/supervisor.go312
1 files changed, 0 insertions, 312 deletions
diff --git a/plugin/rpcplugin/rpcplugintest/supervisor.go b/plugin/rpcplugin/rpcplugintest/supervisor.go
deleted file mode 100644
index f3ff847a2..000000000
--- a/plugin/rpcplugin/rpcplugintest/supervisor.go
+++ /dev/null
@@ -1,312 +0,0 @@
-// Copyright (c) 2017-present Mattermost, Inc. All Rights Reserved.
-// See License.txt for license information.
-
-package rpcplugintest
-
-import (
- "encoding/json"
- "fmt"
- "io/ioutil"
- "net/http"
- "net/http/httptest"
- "os"
- "path/filepath"
- "testing"
- "time"
-
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/mock"
- "github.com/stretchr/testify/require"
-
- "github.com/mattermost/mattermost-server/model"
- "github.com/mattermost/mattermost-server/plugin"
- "github.com/mattermost/mattermost-server/plugin/plugintest"
-)
-
-type SupervisorProviderFunc = func(*model.BundleInfo) (plugin.Supervisor, error)
-
-func TestSupervisorProvider(t *testing.T, sp SupervisorProviderFunc) {
- for name, f := range map[string]func(*testing.T, SupervisorProviderFunc){
- "Supervisor": testSupervisor,
- "Supervisor_InvalidExecutablePath": testSupervisor_InvalidExecutablePath,
- "Supervisor_NonExistentExecutablePath": testSupervisor_NonExistentExecutablePath,
- "Supervisor_StartTimeout": testSupervisor_StartTimeout,
- // "Supervisor_PluginCrash": testSupervisor_PluginCrash,
- // "Supervisor_PluginRepeatedlyCrash": testSupervisor_PluginRepeatedlyCrash,
- } {
- t.Run(name, func(t *testing.T) { f(t, sp) })
- }
-}
-
-func testSupervisor(t *testing.T, sp SupervisorProviderFunc) {
- 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/mattermost-server/plugin/rpcplugin"
- )
-
- type MyPlugin struct {}
-
- func main() {
- rpcplugin.Main(&MyPlugin{})
- }
- `, backend)
-
- ioutil.WriteFile(filepath.Join(dir, "plugin.json"), []byte(`{"id": "foo", "backend": {"executable": "backend.exe"}}`), 0600)
-
- bundle := model.BundleInfoForPath(dir)
- supervisor, err := sp(bundle)
- require.NoError(t, err)
- require.NoError(t, supervisor.Start(nil))
- require.NoError(t, supervisor.Stop())
-}
-
-func testSupervisor_InvalidExecutablePath(t *testing.T, sp SupervisorProviderFunc) {
- dir, err := ioutil.TempDir("", "")
- require.NoError(t, err)
- defer os.RemoveAll(dir)
-
- ioutil.WriteFile(filepath.Join(dir, "plugin.json"), []byte(`{"id": "foo", "backend": {"executable": "/foo/../../backend.exe"}}`), 0600)
-
- bundle := model.BundleInfoForPath(dir)
- supervisor, err := sp(bundle)
- assert.Nil(t, supervisor)
- assert.Error(t, err)
-}
-
-func testSupervisor_NonExistentExecutablePath(t *testing.T, sp SupervisorProviderFunc) {
- dir, err := ioutil.TempDir("", "")
- require.NoError(t, err)
- defer os.RemoveAll(dir)
-
- ioutil.WriteFile(filepath.Join(dir, "plugin.json"), []byte(`{"id": "foo", "backend": {"executable": "thisfileshouldnotexist"}}`), 0600)
-
- bundle := model.BundleInfoForPath(dir)
- supervisor, err := sp(bundle)
- require.NotNil(t, supervisor)
- require.NoError(t, err)
-
- require.Error(t, supervisor.Start(nil))
-}
-
-// If plugin development goes really wrong, let's make sure plugin activation won't block forever.
-func testSupervisor_StartTimeout(t *testing.T, sp SupervisorProviderFunc) {
- 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 := model.BundleInfoForPath(dir)
- supervisor, err := sp(bundle)
- require.NoError(t, err)
- require.Error(t, supervisor.Start(nil))
-}
-
-// Crashed plugins should be relaunched.
-func testSupervisor_PluginCrash(t *testing.T, sp SupervisorProviderFunc) {
- 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/mattermost-server/plugin"
- "github.com/mattermost/mattermost-server/plugin/rpcplugin"
- )
-
- type Configuration struct {
- ShouldExit bool
- }
-
- type MyPlugin struct {
- config Configuration
- }
-
- func (p *MyPlugin) OnActivate(api plugin.API) error {
- api.LoadPluginConfiguration(&p.config)
- return nil
- }
-
- func (p *MyPlugin) OnDeactivate() error {
- if p.config.ShouldExit {
- os.Exit(1)
- }
- return nil
- }
-
- func main() {
- rpcplugin.Main(&MyPlugin{})
- }
- `, backend)
-
- ioutil.WriteFile(filepath.Join(dir, "plugin.json"), []byte(`{"id": "foo", "backend": {"executable": "backend.exe"}}`), 0600)
-
- var api plugintest.API
- shouldExit := true
- api.On("LoadPluginConfiguration", mock.MatchedBy(func(x interface{}) bool { return true })).Return(func(dest interface{}) error {
- err := json.Unmarshal([]byte(fmt.Sprintf(`{"ShouldExit": %v}`, shouldExit)), dest)
- shouldExit = false
- return err
- })
-
- bundle := model.BundleInfoForPath(dir)
- supervisor, err := sp(bundle)
- require.NoError(t, err)
-
- var supervisorWaitErr error
- supervisorWaitDone := make(chan bool, 1)
- go func() {
- supervisorWaitErr = supervisor.Wait()
- close(supervisorWaitDone)
- }()
-
- require.NoError(t, supervisor.Start(&api))
-
- failed := false
- recovered := false
- for i := 0; i < 30; i++ {
- if supervisor.Hooks().OnDeactivate() == nil {
- require.True(t, failed)
- recovered = true
- break
- } else {
- failed = true
- }
- time.Sleep(time.Millisecond * 100)
- }
- assert.True(t, recovered)
-
- select {
- case <-supervisorWaitDone:
- require.Fail(t, "supervisor.Wait() unexpectedly returned")
- case <-time.After(500 * time.Millisecond):
- }
-
- require.NoError(t, supervisor.Stop())
-
- select {
- case <-supervisorWaitDone:
- require.Nil(t, supervisorWaitErr)
- case <-time.After(5000 * time.Millisecond):
- require.Fail(t, "supervisor.Wait() failed to return")
- }
-}
-
-// Crashed plugins should be relaunched at most three times.
-func testSupervisor_PluginRepeatedlyCrash(t *testing.T, sp SupervisorProviderFunc) {
- dir, err := ioutil.TempDir("", "")
- require.NoError(t, err)
- defer os.RemoveAll(dir)
-
- backend := filepath.Join(dir, "backend.exe")
- CompileGo(t, `
- package main
-
- import (
- "net/http"
- "os"
-
- "github.com/mattermost/mattermost-server/plugin/rpcplugin"
- )
-
- type MyPlugin struct {
- crashing bool
- }
-
- func (p *MyPlugin) ServeHTTP(w http.ResponseWriter, r *http.Request) {
- if r.Method == http.MethodPost {
- p.crashing = true
- go func() {
- os.Exit(1)
- }()
- }
-
- if p.crashing {
- w.WriteHeader(http.StatusInternalServerError)
- } else {
- w.WriteHeader(http.StatusOK)
- }
- }
-
- func main() {
- rpcplugin.Main(&MyPlugin{})
- }
- `, backend)
-
- ioutil.WriteFile(filepath.Join(dir, "plugin.json"), []byte(`{"id": "foo", "backend": {"executable": "backend.exe"}}`), 0600)
-
- var api plugintest.API
- bundle := model.BundleInfoForPath(dir)
- supervisor, err := sp(bundle)
- require.NoError(t, err)
-
- var supervisorWaitErr error
- supervisorWaitDone := make(chan bool, 1)
- go func() {
- supervisorWaitErr = supervisor.Wait()
- close(supervisorWaitDone)
- }()
-
- require.NoError(t, supervisor.Start(&api))
-
- for attempt := 1; attempt <= 4; attempt++ {
- // Verify that the plugin is operational
- response := httptest.NewRecorder()
- supervisor.Hooks().ServeHTTP(response, httptest.NewRequest(http.MethodGet, "/plugins/id", nil))
- require.Equal(t, http.StatusOK, response.Result().StatusCode)
-
- // Crash the plugin
- supervisor.Hooks().ServeHTTP(httptest.NewRecorder(), httptest.NewRequest(http.MethodPost, "/plugins/id", nil))
-
- // Wait for it to potentially recover
- recovered := false
- for i := 0; i < 125; i++ {
- response := httptest.NewRecorder()
- supervisor.Hooks().ServeHTTP(response, httptest.NewRequest(http.MethodGet, "/plugins/id", nil))
- if response.Result().StatusCode == http.StatusOK {
- recovered = true
- break
- }
-
- time.Sleep(time.Millisecond * 100)
- }
-
- if attempt < 4 {
- require.Nil(t, supervisorWaitErr)
- require.True(t, recovered, "failed to recover after attempt %d", attempt)
- } else {
- require.False(t, recovered, "unexpectedly recovered after attempt %d", attempt)
- }
- }
-
- select {
- case <-supervisorWaitDone:
- require.NotNil(t, supervisorWaitErr)
- case <-time.After(500 * time.Millisecond):
- require.Fail(t, "supervisor.Wait() failed to return after plugin crashed")
- }
-
- require.NoError(t, supervisor.Stop())
-}
generated by cgit v1.2.3-1-g7c22 (git 2.25.1) at 2024-06-13 11:46:38 +0000