Refactor plugins system
This commit is contained in:
Harold Ozouf
GitHub
parent
ffd01fc88a
commit
fed86bd816
9 changed files with 828 additions and 261 deletions
341
pkg/plugins/manager_test.go
Normal file
341
pkg/plugins/manager_test.go
Normal file
|
|
@ -0,0 +1,341 @@
|
|||
package plugins
|
||||
|
||||
import (
|
||||
zipa "archive/zip"
|
||||
"context"
|
||||
"encoding/json"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
"gopkg.in/yaml.v3"
|
||||
)
|
||||
|
||||
// mockDownloader is a test implementation of PluginDownloader
|
||||
type mockDownloader struct {
|
||||
downloadFunc func(ctx context.Context, pName, pVersion string) (string, error)
|
||||
checkFunc func(ctx context.Context, pName, pVersion, hash string) error
|
||||
}
|
||||
|
||||
func (m *mockDownloader) Download(ctx context.Context, pName, pVersion string) (string, error) {
|
||||
if m.downloadFunc != nil {
|
||||
return m.downloadFunc(ctx, pName, pVersion)
|
||||
}
|
||||
return "mockhash", nil
|
||||
}
|
||||
|
||||
func (m *mockDownloader) Check(ctx context.Context, pName, pVersion, hash string) error {
|
||||
if m.checkFunc != nil {
|
||||
return m.checkFunc(ctx, pName, pVersion, hash)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func TestPluginManager_ReadManifest(t *testing.T) {
|
||||
tempDir := t.TempDir()
|
||||
opts := ManagerOptions{Output: tempDir}
|
||||
|
||||
downloader := &mockDownloader{}
|
||||
manager, err := NewManager(downloader, opts)
|
||||
require.NoError(t, err)
|
||||
|
||||
moduleName := "github.com/test/plugin"
|
||||
pluginPath := filepath.Join(manager.goPath, "src", moduleName)
|
||||
err = os.MkdirAll(pluginPath, 0o755)
|
||||
require.NoError(t, err)
|
||||
|
||||
manifest := &Manifest{
|
||||
DisplayName: "Test Plugin",
|
||||
Type: "middleware",
|
||||
Import: "github.com/test/plugin",
|
||||
Summary: "A test plugin",
|
||||
TestData: map[string]interface{}{
|
||||
"test": "data",
|
||||
},
|
||||
}
|
||||
|
||||
manifestPath := filepath.Join(pluginPath, pluginManifest)
|
||||
manifestData, err := yaml.Marshal(manifest)
|
||||
require.NoError(t, err)
|
||||
err = os.WriteFile(manifestPath, manifestData, 0o644)
|
||||
require.NoError(t, err)
|
||||
|
||||
readManifest, err := manager.ReadManifest(moduleName)
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, manifest.DisplayName, readManifest.DisplayName)
|
||||
assert.Equal(t, manifest.Type, readManifest.Type)
|
||||
assert.Equal(t, manifest.Import, readManifest.Import)
|
||||
assert.Equal(t, manifest.Summary, readManifest.Summary)
|
||||
}
|
||||
|
||||
func TestPluginManager_ReadManifest_NotFound(t *testing.T) {
|
||||
tempDir := t.TempDir()
|
||||
opts := ManagerOptions{Output: tempDir}
|
||||
|
||||
downloader := &mockDownloader{}
|
||||
manager, err := NewManager(downloader, opts)
|
||||
require.NoError(t, err)
|
||||
|
||||
_, err = manager.ReadManifest("nonexistent/plugin")
|
||||
assert.Error(t, err)
|
||||
}
|
||||
|
||||
func TestPluginManager_CleanArchives(t *testing.T) {
|
||||
tempDir := t.TempDir()
|
||||
opts := ManagerOptions{Output: tempDir}
|
||||
|
||||
downloader := &mockDownloader{}
|
||||
manager, err := NewManager(downloader, opts)
|
||||
require.NoError(t, err)
|
||||
|
||||
testPlugin1 := "test/plugin1"
|
||||
testPlugin2 := "test/plugin2"
|
||||
|
||||
archive1Dir := filepath.Join(manager.archives, "test", "plugin1")
|
||||
archive2Dir := filepath.Join(manager.archives, "test", "plugin2")
|
||||
err = os.MkdirAll(archive1Dir, 0o755)
|
||||
require.NoError(t, err)
|
||||
err = os.MkdirAll(archive2Dir, 0o755)
|
||||
require.NoError(t, err)
|
||||
|
||||
archive1Old := filepath.Join(archive1Dir, "v1.0.0.zip")
|
||||
archive1New := filepath.Join(archive1Dir, "v2.0.0.zip")
|
||||
archive2 := filepath.Join(archive2Dir, "v1.0.0.zip")
|
||||
|
||||
err = os.WriteFile(archive1Old, []byte("old archive"), 0o644)
|
||||
require.NoError(t, err)
|
||||
err = os.WriteFile(archive1New, []byte("new archive"), 0o644)
|
||||
require.NoError(t, err)
|
||||
err = os.WriteFile(archive2, []byte("archive 2"), 0o644)
|
||||
require.NoError(t, err)
|
||||
|
||||
state := map[string]string{
|
||||
testPlugin1: "v1.0.0",
|
||||
testPlugin2: "v1.0.0",
|
||||
}
|
||||
stateData, err := json.MarshalIndent(state, "", " ")
|
||||
require.NoError(t, err)
|
||||
err = os.WriteFile(manager.stateFile, stateData, 0o600)
|
||||
require.NoError(t, err)
|
||||
|
||||
currentPlugins := map[string]Descriptor{
|
||||
"plugin1": {
|
||||
ModuleName: testPlugin1,
|
||||
Version: "v2.0.0",
|
||||
},
|
||||
"plugin2": {
|
||||
ModuleName: testPlugin2,
|
||||
Version: "v1.0.0",
|
||||
},
|
||||
}
|
||||
|
||||
err = manager.CleanArchives(currentPlugins)
|
||||
require.NoError(t, err)
|
||||
|
||||
assert.NoFileExists(t, archive1Old)
|
||||
assert.FileExists(t, archive1New)
|
||||
assert.FileExists(t, archive2)
|
||||
}
|
||||
|
||||
func TestPluginManager_WriteState(t *testing.T) {
|
||||
tempDir := t.TempDir()
|
||||
opts := ManagerOptions{Output: tempDir}
|
||||
|
||||
downloader := &mockDownloader{}
|
||||
manager, err := NewManager(downloader, opts)
|
||||
require.NoError(t, err)
|
||||
|
||||
plugins := map[string]Descriptor{
|
||||
"plugin1": {
|
||||
ModuleName: "test/plugin1",
|
||||
Version: "v1.0.0",
|
||||
},
|
||||
"plugin2": {
|
||||
ModuleName: "test/plugin2",
|
||||
Version: "v2.0.0",
|
||||
},
|
||||
}
|
||||
|
||||
err = manager.WriteState(plugins)
|
||||
require.NoError(t, err)
|
||||
|
||||
assert.FileExists(t, manager.stateFile)
|
||||
|
||||
data, err := os.ReadFile(manager.stateFile)
|
||||
require.NoError(t, err)
|
||||
|
||||
var state map[string]string
|
||||
err = json.Unmarshal(data, &state)
|
||||
require.NoError(t, err)
|
||||
|
||||
expectedState := map[string]string{
|
||||
"test/plugin1": "v1.0.0",
|
||||
"test/plugin2": "v2.0.0",
|
||||
}
|
||||
assert.Equal(t, expectedState, state)
|
||||
}
|
||||
|
||||
func TestPluginManager_ResetAll(t *testing.T) {
|
||||
tempDir := t.TempDir()
|
||||
opts := ManagerOptions{Output: tempDir}
|
||||
|
||||
downloader := &mockDownloader{}
|
||||
manager, err := NewManager(downloader, opts)
|
||||
require.NoError(t, err)
|
||||
|
||||
testFile := filepath.Join(manager.GoPath(), "test.txt")
|
||||
err = os.WriteFile(testFile, []byte("test"), 0o644)
|
||||
require.NoError(t, err)
|
||||
|
||||
archiveFile := filepath.Join(manager.archives, "test.zip")
|
||||
err = os.WriteFile(archiveFile, []byte("archive"), 0o644)
|
||||
require.NoError(t, err)
|
||||
|
||||
err = manager.ResetAll()
|
||||
require.NoError(t, err)
|
||||
|
||||
assert.DirExists(t, manager.archives)
|
||||
assert.NoFileExists(t, testFile)
|
||||
assert.NoFileExists(t, archiveFile)
|
||||
}
|
||||
|
||||
func TestPluginManager_InstallPlugin(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
plugin Descriptor
|
||||
downloadFunc func(ctx context.Context, pName, pVersion string) (string, error)
|
||||
checkFunc func(ctx context.Context, pName, pVersion, hash string) error
|
||||
setupArchive func(t *testing.T, archivePath string)
|
||||
expectError bool
|
||||
errorMsg string
|
||||
}{
|
||||
{
|
||||
name: "successful installation",
|
||||
plugin: Descriptor{
|
||||
ModuleName: "github.com/test/plugin",
|
||||
Version: "v1.0.0",
|
||||
Hash: "expected-hash",
|
||||
},
|
||||
downloadFunc: func(ctx context.Context, pName, pVersion string) (string, error) {
|
||||
return "expected-hash", nil
|
||||
},
|
||||
checkFunc: func(ctx context.Context, pName, pVersion, hash string) error {
|
||||
return nil
|
||||
},
|
||||
setupArchive: func(t *testing.T, archivePath string) {
|
||||
t.Helper()
|
||||
|
||||
// Create a valid zip archive
|
||||
err := os.MkdirAll(filepath.Dir(archivePath), 0o755)
|
||||
require.NoError(t, err)
|
||||
|
||||
file, err := os.Create(archivePath)
|
||||
require.NoError(t, err)
|
||||
defer file.Close()
|
||||
|
||||
// Write a minimal zip file with a test file
|
||||
writer := zipa.NewWriter(file)
|
||||
defer writer.Close()
|
||||
|
||||
fileWriter, err := writer.Create("test-module-v1.0.0/main.go")
|
||||
require.NoError(t, err)
|
||||
_, err = fileWriter.Write([]byte("package main\n\nfunc main() {}\n"))
|
||||
require.NoError(t, err)
|
||||
},
|
||||
expectError: false,
|
||||
},
|
||||
{
|
||||
name: "download error",
|
||||
plugin: Descriptor{
|
||||
ModuleName: "github.com/test/plugin",
|
||||
Version: "v1.0.0",
|
||||
},
|
||||
downloadFunc: func(ctx context.Context, pName, pVersion string) (string, error) {
|
||||
return "", assert.AnError
|
||||
},
|
||||
expectError: true,
|
||||
errorMsg: "unable to download plugin",
|
||||
},
|
||||
{
|
||||
name: "check error",
|
||||
plugin: Descriptor{
|
||||
ModuleName: "github.com/test/plugin",
|
||||
Version: "v1.0.0",
|
||||
Hash: "expected-hash",
|
||||
},
|
||||
downloadFunc: func(ctx context.Context, pName, pVersion string) (string, error) {
|
||||
return "actual-hash", nil
|
||||
},
|
||||
checkFunc: func(ctx context.Context, pName, pVersion, hash string) error {
|
||||
return assert.AnError
|
||||
},
|
||||
expectError: true,
|
||||
errorMsg: "invalid hash for plugin",
|
||||
},
|
||||
{
|
||||
name: "unzip error - invalid archive",
|
||||
plugin: Descriptor{
|
||||
ModuleName: "github.com/test/plugin",
|
||||
Version: "v1.0.0",
|
||||
},
|
||||
downloadFunc: func(ctx context.Context, pName, pVersion string) (string, error) {
|
||||
return "test-hash", nil
|
||||
},
|
||||
checkFunc: func(ctx context.Context, pName, pVersion, hash string) error {
|
||||
return nil
|
||||
},
|
||||
setupArchive: func(t *testing.T, archivePath string) {
|
||||
t.Helper()
|
||||
|
||||
// Create an invalid zip archive
|
||||
err := os.MkdirAll(filepath.Dir(archivePath), 0o755)
|
||||
require.NoError(t, err)
|
||||
err = os.WriteFile(archivePath, []byte("invalid zip content"), 0o644)
|
||||
require.NoError(t, err)
|
||||
},
|
||||
expectError: true,
|
||||
errorMsg: "unable to unzip plugin",
|
||||
},
|
||||
}
|
||||
|
||||
for _, test := range tests {
|
||||
t.Run(test.name, func(t *testing.T) {
|
||||
tempDir := t.TempDir()
|
||||
opts := ManagerOptions{Output: tempDir}
|
||||
|
||||
downloader := &mockDownloader{
|
||||
downloadFunc: test.downloadFunc,
|
||||
checkFunc: test.checkFunc,
|
||||
}
|
||||
|
||||
manager, err := NewManager(downloader, opts)
|
||||
require.NoError(t, err)
|
||||
|
||||
// Setup archive if needed
|
||||
if test.setupArchive != nil {
|
||||
archivePath := filepath.Join(manager.archives,
|
||||
filepath.FromSlash(test.plugin.ModuleName),
|
||||
test.plugin.Version+".zip")
|
||||
test.setupArchive(t, archivePath)
|
||||
}
|
||||
|
||||
ctx := t.Context()
|
||||
err = manager.InstallPlugin(ctx, test.plugin)
|
||||
|
||||
if test.expectError {
|
||||
assert.Error(t, err)
|
||||
if test.errorMsg != "" {
|
||||
assert.Contains(t, err.Error(), test.errorMsg)
|
||||
}
|
||||
} else {
|
||||
assert.NoError(t, err)
|
||||
|
||||
// Verify that plugin sources were extracted
|
||||
sourcePath := filepath.Join(manager.sources, filepath.FromSlash(test.plugin.ModuleName))
|
||||
assert.DirExists(t, sourcePath)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue