helm/internal/plugin/installer/plugin_structure_test.go

/*
Copyright The Helm Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package installer

import (
	"os"
	"path/filepath"
	"testing"

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

func TestDetectPluginRoot(t *testing.T) {
	tests := []struct {
		name        string
		setup       func(dir string) error
		expectRoot  string
		expectError bool
	}{
		{
			name: "plugin.yaml at root",
			setup: func(dir string) error {
				return os.WriteFile(filepath.Join(dir, "plugin.yaml"), []byte("name: test"), 0o644)
			},
			expectRoot:  ".",
			expectError: false,
		},
		{
			name: "plugin.yaml in subdirectory",
			setup: func(dir string) error {
				subdir := filepath.Join(dir, "my-plugin")
				if err := os.MkdirAll(subdir, 0o755); err != nil {
					return err
				}
				return os.WriteFile(filepath.Join(subdir, "plugin.yaml"), []byte("name: test"), 0o644)
			},
			expectRoot:  "my-plugin",
			expectError: false,
		},
		{
			name: "no plugin.yaml",
			setup: func(dir string) error {
				return os.WriteFile(filepath.Join(dir, "README.md"), []byte("test"), 0o644)
			},
			expectRoot:  "",
			expectError: true,
		},
		{
			name: "plugin.yaml in nested subdirectory (should not find)",
			setup: func(dir string) error {
				subdir := filepath.Join(dir, "outer", "inner")
				if err := os.MkdirAll(subdir, 0o755); err != nil {
					return err
				}
				return os.WriteFile(filepath.Join(subdir, "plugin.yaml"), []byte("name: test"), 0o644)
			},
			expectRoot:  "",
			expectError: true,
		},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			dir := t.TempDir()
			require.NoErrorf(t, tt.setup(dir), "Setup failed")

			root, err := detectPluginRoot(dir)
			if tt.expectError {
				assert.Error(t, err)
			} else {
				require.NoError(t, err)
				expectedPath := dir
				if tt.expectRoot != "." {
					expectedPath = filepath.Join(dir, tt.expectRoot)
				}
				assert.Equal(t, expectedPath, root, "Expected root %s but got %s", expectedPath, root)
			}
		})
	}
}

func TestValidatePluginName(t *testing.T) {
	tests := []struct {
		name         string
		setup        func(dir string) error
		pluginRoot   string
		expectedName string
		expectError  bool
	}{
		{
			name: "matching directory and plugin name",
			setup: func(dir string) error {
				subdir := filepath.Join(dir, "my-plugin")
				if err := os.MkdirAll(subdir, 0o755); err != nil {
					return err
				}
				yaml := `name: my-plugin
version: 1.0.0
usage: test
description: test`
				return os.WriteFile(filepath.Join(subdir, "plugin.yaml"), []byte(yaml), 0o644)
			},
			pluginRoot:   "my-plugin",
			expectedName: "my-plugin",
			expectError:  false,
		},
		{
			name: "different directory and plugin name",
			setup: func(dir string) error {
				subdir := filepath.Join(dir, "wrong-name")
				if err := os.MkdirAll(subdir, 0o755); err != nil {
					return err
				}
				yaml := `name: my-plugin
version: 1.0.0
usage: test
description: test`
				return os.WriteFile(filepath.Join(subdir, "plugin.yaml"), []byte(yaml), 0o644)
			},
			pluginRoot:   "wrong-name",
			expectedName: "wrong-name",
			expectError:  false, // Currently we don't error on mismatch
		},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			dir := t.TempDir()
			require.NoErrorf(t, tt.setup(dir), "Setup failed")

			pluginRoot := filepath.Join(dir, tt.pluginRoot)
			err := validatePluginName(pluginRoot, tt.expectedName)
			if tt.expectError {
				assert.Error(t, err)
			} else {
				assert.NoError(t, err)
			}
		})
	}
}