add demo addon

12 files changed, 109 insertions, 0 deletions

diff --git a/tests/actions/addon/demo-addon/README.md b/tests/actions/addon/demo-addon/README.md
new file mode 100644
index 000000000..8ee255f64
--- /dev/null
+++ b/tests/actions/addon/demo-addon/README.md
@@ -0,0 +1,5 @@
+# demo-addon
+
+A complete addon used by the addon tests, it provides all the payload kinds
+and uses the optional `src` layout: only `src/` is installed, this README and
+the `tests` directory are ours and must not be installed.
diff --git a/tests/actions/addon/demo-addon/src/includes/check/xmake.lua b/tests/actions/addon/demo-addon/src/includes/check/xmake.lua
new file mode 100644
index 000000000..3ba656e64
--- /dev/null
+++ b/tests/actions/addon/demo-addon/src/includes/check/xmake.lua
@@ -0,0 +1,7 @@
+print("demo-addon: includes check is loaded")
+
+option("demo_addon_option")
+    set_default(true)
+    set_showmenu(true)
+    set_description("An option provided by the demo addon.")
+option_end()
diff --git a/tests/actions/addon/demo-addon/src/modules/greeting.lua b/tests/actions/addon/demo-addon/src/modules/greeting.lua
new file mode 100644
index 000000000..9adbc01ce
--- /dev/null
+++ b/tests/actions/addon/demo-addon/src/modules/greeting.lua
@@ -0,0 +1,3 @@
+function main(who)
+    return "hello from demo-addon: " .. (who or "world")
+end
diff --git a/tests/actions/addon/demo-addon/src/plugins/demo_hello/main.lua b/tests/actions/addon/demo-addon/src/plugins/demo_hello/main.lua
new file mode 100644
index 000000000..c4bf7951c
--- /dev/null
+++ b/tests/actions/addon/demo-addon/src/plugins/demo_hello/main.lua
@@ -0,0 +1,6 @@
+import("core.base.option")
+import("@self.greeting")
+
+function main()
+    print(greeting(option.get("name")))
+end
diff --git a/tests/actions/addon/demo-addon/src/plugins/demo_hello/xmake.lua b/tests/actions/addon/demo-addon/src/plugins/demo_hello/xmake.lua
new file mode 100644
index 000000000..8908b23a1
--- /dev/null
+++ b/tests/actions/addon/demo-addon/src/plugins/demo_hello/xmake.lua
@@ -0,0 +1,10 @@
+task("demo_hello")
+    set_category("plugin")
+    on_run("main")
+    set_menu {
+        usage = "xmake demo_hello [options]",
+        description = "Say hello from the demo addon.",
+        options = {
+            {'n', "name", "kv", nil, "Set the name to say hello to."}
+        }
+    }
diff --git a/tests/actions/addon/demo-addon/src/rules/app/xmake.lua b/tests/actions/addon/demo-addon/src/rules/app/xmake.lua
new file mode 100644
index 000000000..ff54eb85a
--- /dev/null
+++ b/tests/actions/addon/demo-addon/src/rules/app/xmake.lua
@@ -0,0 +1,6 @@
+rule("app")
+    add_deps("@self/base")
+    on_load(function (target)
+        import("@self.greeting")
+        print("demo-addon: rule app is loaded, " .. greeting(target:name()))
+    end)
diff --git a/tests/actions/addon/demo-addon/src/rules/base/xmake.lua b/tests/actions/addon/demo-addon/src/rules/base/xmake.lua
new file mode 100644
index 000000000..0417c2361
--- /dev/null
+++ b/tests/actions/addon/demo-addon/src/rules/base/xmake.lua
@@ -0,0 +1,4 @@
+rule("base")
+    on_load(function (target)
+        print("demo-addon: rule base is loaded")
+    end)
diff --git a/tests/actions/addon/demo-addon/src/templates/c/demoaddon/hello/src/main.c b/tests/actions/addon/demo-addon/src/templates/c/demoaddon/hello/src/main.c
new file mode 100644
index 000000000..e5a9ccbdf
--- /dev/null
+++ b/tests/actions/addon/demo-addon/src/templates/c/demoaddon/hello/src/main.c
@@ -0,0 +1,4 @@
+int main(int argc, char** argv)
+{
+    return 0;
+}
diff --git a/tests/actions/addon/demo-addon/src/templates/c/demoaddon/hello/xmake.lua b/tests/actions/addon/demo-addon/src/templates/c/demoaddon/hello/xmake.lua
new file mode 100644
index 000000000..f9ea6e8d2
--- /dev/null
+++ b/tests/actions/addon/demo-addon/src/templates/c/demoaddon/hello/xmake.lua
@@ -0,0 +1,3 @@
+target("${TARGET_NAME}")
+    set_kind("binary")
+    add_files("src/*.c")
diff --git a/tests/actions/addon/demo-addon/src/toolchains/demo/xmake.lua b/tests/actions/addon/demo-addon/src/toolchains/demo/xmake.lua
new file mode 100644
index 000000000..701a72e29
--- /dev/null
+++ b/tests/actions/addon/demo-addon/src/toolchains/demo/xmake.lua
@@ -0,0 +1,6 @@
+toolchain("demo")
+    set_kind("standalone")
+    set_description("the demo toolchain of the demo addon")
+    on_load(function (toolchain)
+        toolchain:set("toolset", "cc", "gcc")
+    end)
diff --git a/tests/actions/addon/demo-addon/tests/hello_test.lua b/tests/actions/addon/demo-addon/tests/hello_test.lua
new file mode 100644
index 000000000..1fcb312de
--- /dev/null
+++ b/tests/actions/addon/demo-addon/tests/hello_test.lua
@@ -0,0 +1 @@
+-- our own test file, it should not be installed
diff --git a/tests/actions/addon/test.lua b/tests/actions/addon/test.lua
index 2be6acf94..1ead7acac 100644
--- a/tests/actions/addon/test.lua
+++ b/tests/actions/addon/test.lua
@@ -406,6 +406,60 @@ function test_install_conflicts(t)
     end)
 end
 
+-- a complete addon with the optional `src` layout, @see tests/actions/addon/demo-addon
+--
+-- it provides all the payload kinds and has its own files (README, tests) which must not be installed
+function test_demo_addon(t)
+    local name = "demo-addon"
+    local addondir = path.join(os.scriptdir(), name)
+    try
+    {
+        function ()
+            os.runv("xmake", {"addon", "--install", addondir})
+
+            -- only the payloads of the `src` directory should be installed
+            local installdir = path.join(global.directory(), "addons", name, "latest")
+            for _, payloaddir in ipairs({"plugins", "rules", "toolchains", "modules", "includes", "templates"}) do
+                t:require(os.isdir(path.join(installdir, payloaddir)))
+            end
+            for _, ourfile in ipairs({"src", "tests", "README.md"}) do
+                t:require_not(os.exists(path.join(installdir, ourfile)))
+            end
+
+            -- the plugin imports a module of its own addon with `@self`
+            t:require(os.iorunv("xmake", {"demo_hello", "-n", "xmake"}):find("hello from demo-addon: xmake", 1, true))
+
+            -- the module can be imported with the addon name
+            local script = "import(\"@addon.demo-addon.greeting\"); print(greeting(\"module\"))"
+            t:require(os.iorunv("xmake", {"lua", "-c", script}):find("hello from demo-addon: module", 1, true))
+
+            -- the toolchain can be loaded with the addon name
+            local script2 = "import(\"core.tool.toolchain\"); print(toolchain.load(\"@addon/demo-addon/demo\"):get(\"description\"))"
+            t:require(os.iorunv("xmake", {"lua", "-c", script2}):find("the demo toolchain", 1, true))
+
+            -- the template should be listed
+            t:require(os.iorunv("xmake", {"create", "--list", "-l", "c"}):find("demoaddon.hello", 1, true))
+
+            -- the includes and the rules should work in a real project
+            local out = _config_project([[
+includes("@addon/demo-addon/check")
+target("test")
+    set_kind("phony")
+    add_rules("@addon/demo-addon/app")
+]])
+            t:require(out:find("demo-addon: includes check is loaded", 1, true))
+            t:require(out:find("demo-addon: rule base is loaded", 1, true))
+            t:require(out:find("demo-addon: rule app is loaded, hello from demo-addon: test", 1, true))
+        end,
+        finally
+        {
+            function ()
+                try { function () os.runv("xmake", {"addon", "--remove", "--force", name}) end }
+            end
+        }
+    }
+end
+
 -- install an addon from a local directory, then remove it
 function test_install_from_local(t)
     local suffix = path.filename(os.tmpfile()):gsub("[^%w]", "")