test(plugin): add test for missing required hook in Lua plugin

Add a new test case to verify that the Lua plugin correctly handles the absence of a required hook. This ensures that the plugin validation logic works as expected and provides meaningful error messages.

Author: bytemain

internal/plugin/plugin_test.go

@@ -143,6 +143,19 @@ func TestInvalidPluginName(t *testing.T) {
 	}
 }
 
+func TestMissingRequiredHook(t *testing.T) {
+	teardownSuite := setupSuite(t)
+	defer teardownSuite(t)
+	_, err := plugin.NewLuaPlugin("testdata/plugins/missing_required_hook", internal.NewSdkManager().Config, internal.RuntimeVersion)
+	if err == nil {
+		t.Fatal("expected error, got nil")
+	}
+	t.Logf("error: %s", err.Error())
+	if !strings.Contains(err.Error(), "[EnvKeys] function not found") {
+		t.Errorf("expected error to contain '[EnvKeys] function not found', got '%s'", err.Error())
+	}
+}
+
 func testHookFunc(t *testing.T, factory func() (*internal.Manager, *plugin.PluginWrapper, error)) {
 	t.Helper()
 

internal/plugin/testdata/plugins/missing_required_hook/main.lua

@@ -0,0 +1,185 @@
+--- Common libraries provided by VersionFox (optional)
+local http = require("http")
+local json = require("json")
+local html = require("html")
+
+--- The following two parameters are injected by VersionFox at runtime
+--- Operating system type at runtime (Windows, Linux, Darwin)
+RUNTIME = {
+    --- Operating system type at runtime (Windows, Linux, Darwin)
+    osType = "",
+    --- Operating system architecture at runtime (amd64, arm64, etc.)
+    archType = "",
+    --- vfox runtime version
+    version = "",
+}
+
+PLUGIN = {
+    --- Plugin name
+    name = "missing_required_hook",
+    --- Plugin author
+    author = "Lihan",
+    --- Plugin version
+    version = "0.0.1",
+    --- Plugin description
+    description = "xxx",
+    -- Update URL
+    updateUrl = "{URL}/sdk.lua",
+    -- minimum compatible vfox version
+    minRuntimeVersion = "0.2.2",
+    legacyFilenames = {
+        ".node-version",
+        ".nvmrc"
+    }
+}
+
+--- Returns some pre-installed information, such as version number, download address, local files, etc.
+--- If checksum is provided, vfox will automatically check it for you.
+--- @param ctx table
+--- @field ctx.version string User-input version
+--- @return table Version information
+function PLUGIN:PreInstall(ctx)
+    print(json.encode(RUNTIME))
+    local version = ctx.version
+    return {
+        --- Version number
+        version = "version",
+        --- remote URL or local file path [optional]
+        url = "xxx",
+        --- SHA256 checksum [optional]
+        sha256 = "xxx",
+        --- md5 checksum [optional]
+        md5 = "xxx",
+        --- sha1 checksum [optional]
+        sha1 = "xxx",
+        --- sha512 checksum [optional]
+        sha512 = "xx",
+        --- additional need files [optional]
+        addition = {
+            {
+                --- additional file name !
+                name = "xxx",
+                --- remote URL or local file path [optional]
+                url = "xxx",
+                --- SHA256 checksum [optional]
+                sha256 = "xxx",
+                --- md5 checksum [optional]
+                md5 = "xxx",
+                --- sha1 checksum [optional]
+                sha1 = "xxx",
+                --- sha512 checksum [optional]
+                sha512 = "xx",
+            }
+        }
+    }
+end
+
+--- Extension point, called after PreInstall, can perform additional operations,
+--- such as file operations for the SDK installation directory or compile source code
+--- Currently can be left unimplemented!
+function PLUGIN:PostInstall(ctx)
+    --- ctx.rootPath SDK installation directory
+    local rootPath = ctx.rootPath
+    local sdkInfo = ctx.sdkInfo['sdk-name']
+    local path = sdkInfo.path
+    local version = sdkInfo.version
+    local name = sdkInfo.name
+end
+
+--- Return all available versions provided by this plugin
+--- @param ctx table Empty table used as context, for future extension
+--- @return table Descriptions of available versions and accompanying tool descriptions
+function PLUGIN:Available(ctx)
+    printTable(ctx.args)
+
+    return {
+        {
+            version = "xxxx",
+            note = os.time(),
+            addition = {
+                {
+                    name = "npm",
+                    version = "8.8.8",
+                }
+            }
+        }
+    }
+end
+
+--- When user invoke `use` command, this function will be called to get the
+--- valid version information.
+--- @param ctx table Context information
+function PLUGIN:PreUse(ctx)
+    --- user input version
+    local version = ctx.version
+    --- installed sdks
+    local sdkInfo = ctx.installedSdks['xxxx']
+    local path = sdkInfo.path
+    local name = sdkInfo.name
+    local sdkVersion = sdkInfo.version
+
+    --- working directory
+    local cwd = ctx.cwd
+
+    printTable(ctx)
+
+    --- user input scope
+    local scope = ctx.scope
+
+    if (scope == "global") then
+        print("return 9.9.9")
+        return {
+            version = "9.9.9",
+        }
+    end
+
+    if (scope == "project") then
+        print("return 10.0.0")
+        return {
+            version = "10.0.0",
+        }
+    end
+
+    print("return 1.0.0")
+
+    return {
+        version = "1.0.0"
+    }
+end
+
+function PLUGIN:ParseLegacyFile(ctx)
+    printTable(ctx)
+    local filename = ctx.filename
+    local filepath = ctx.filepath
+
+    installed = ctx.getInstalledVersions()
+    if #installed > 0 then
+        print("Installed: " .. installed[1])
+        return {
+            version = "check-installed"
+        }
+    end
+
+    if filename == ".node-version" then
+        return {
+            version = "14.17.0"
+        }
+    else
+        return {
+            version = "0.0.1"
+        }
+    end
+
+end
+
+function PLUGIN:PreUninstall(ctx)
+    printTable(ctx)
+    local mainSdkInfo = ctx.main
+    local mpath = mainSdkInfo.path
+    local mversion = mainSdkInfo.version
+    local mname = mainSdkInfo.name
+    local sdkInfo = ctx.sdkInfo['sdk-name']
+    local path = sdkInfo.path
+    local version = sdkInfo.version
+    local name = sdkInfo.name
+end