ci(binding/lua): add luarocks package manager support (#2558)

* chore(binding/lua): add luarocks package manager support Signed-off-by: owl <ouyangjun1999@gmail.com> * chore(binding/lua): change readme Signed-off-by: owl <ouyangjun1999@gmail.com> * chore(binding/lua): fix code Signed-off-by: owl <ouyangjun1999@gmail.com> * chore(binding/lua): fix code Signed-off-by: owl <ouyangjun1999@gmail.com> * chore(binding/lua): change lua module name to lopendal Signed-off-by: owl <ouyangjun1999@gmail.com> * chore(binding/lua): fix code Signed-off-by: owl <ouyangjun1999@gmail.com> * chore(binding/lua): fix code Signed-off-by: owl <ouyangjun1999@gmail.com> * chore(binding/lua): fix code Signed-off-by: owl <ouyangjun1999@gmail.com> --------- Signed-off-by: owl <ouyangjun1999@gmail.com>
apache · Jun 30, 2023 · 6d8aa3a · 6d8aa3a
1 parent 1deb087
commit 6d8aa3a
Show file tree

Hide file tree

Showing 6 changed files with 49 additions and 33 deletions.
diff --git a/.github/workflows/bindings_lua.yml b/.github/workflows/bindings_lua.yml
@@ -46,12 +46,11 @@ jobs:
  - name: Setup lua toolchain
  run: |
  sudo apt-get update
- sudo apt-get install -y lua-busted
+ sudo apt-get install -y lua-busted luarocks liblua5.2-dev
  - name: Setup Rust toolchain
  uses: ./.github/actions/setup
  - name: Build & Test
  working-directory: "bindings/lua"
  run: |
- cargo build
- mv ../../target/debug/libopendal_lua.so opendal.so
+ sudo "PATH=$PATH" luarocks make
  busted test/opendal_test.lua
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/bindings/lua/Cargo.toml b/bindings/lua/Cargo.toml
@@ -29,9 +29,15 @@ rust-version.workspace = true
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
+
+[features]
+default = ["mlua/lua52"]
+lua52 = ["mlua", "mlua/lua52"]
+
 [lib]
 crate-type = ["cdylib"]
 
 [dependencies]
-mlua = { version = "0.8", features = ["lua52", "vendored", "module"] }
+mlua = { version = "0.8", features = ["module"], default-features = false, optional = true }
 opendal.workspace = true
+
diff --git a/bindings/lua/README.md b/bindings/lua/README.md
@@ -19,7 +19,7 @@ print("read: ", op:read("test.txt"))
 ## Lua version
 You have to enable one of the features: lua54, lua53, lua52, lua51, luajit(52) or luau in `Cargo.toml`, according to the chosen Lua version. Default Lua version is 5.2.
 
-## Build
+## Build from source
 
 1. Build OpenDAL LUA Interface
 
@@ -35,6 +35,11 @@ $ cargo build --package opendal-lua --release
 $ cp ../../target/release/libopendal_lua.so /usr/lib/lua/5.2/opendal.so
 ```
 
+## Install from luarocks
+```bash
+$ luarocks make
+```
+
 ## Usage
 ```bash
 $ lua5.2 example/fs.lua

diff --git a/bindings/lua/opendal-0.1.0-1.rockspec b/bindings/lua/opendal-0.1.0-1.rockspec
@@ -0,0 +1,28 @@
+package = "opendal"
+version = "0.1.0-1"
+
+source = {
+ url = "git+https://github.com/apache/incubator-opendal/",
+}
+
+description = {
+ summary = "Apache OpenDAL LUA binding: access data freely. ",
+ detailed = [[
+ OpenDAL is a data access layer that allows users to easily and efficiently retrieve data from various storage services in a unified way.
+ ]],
+ homepage = "https://opendal.apache.org/",
+ license = " Apache-2.0"
+}
+
+dependencies = {
+ "lua >= 5.1",
+ "luarocks-build-rust-mlua",
+}
+
+build = {
+ type = "rust-mlua",
+ modules = {
+ ["opendal"] = "opendal_lua",
+ },
+ target_path = "../../target",
+}
diff --git a/bindings/lua/test/opendal_test.lua b/bindings/lua/test/opendal_test.lua
@@ -19,10 +19,11 @@
 
 ]]
 
+local opendal = require("opendal")
+
 describe("opendal unit test", function()
  describe("opendal fs schema", function()
  it("operator function in fs schema", function()
- local opendal = require("opendal")
  local op, err = opendal.operator.new("fs",{root="/tmp"})
  assert.is_nil(err)
  assert.is_nil(op:write("test.txt","hello world"))
@@ -41,7 +42,6 @@ describe("opendal unit test", function()
  assert.equal(op:is_exist("test_1.txt"), false)
  end)
  it("meta function in fs schema", function()
- local opendal = require("opendal")
  local op, err = opendal.operator.new("fs",{root="/tmp"})
  assert.is_nil(err)
  assert.is_nil(op:write("test.txt","hello world"))
@@ -60,7 +60,6 @@ describe("opendal unit test", function()
  end)
  describe("opendal memory schema", function()
  it("operator function in memory schema", function()
- local opendal = require("opendal")
  local op, err = opendal.operator.new("memory",{root="/tmp"})
  assert.is_nil(err)
  assert.is_nil(op:write("test.txt","hello world"))
@@ -75,7 +74,6 @@ describe("opendal unit test", function()
  assert.equal(op:is_exist("test_1.txt"), false)
  end)
  it("meta function in memory schema", function()
- local opendal = require("opendal")
  local op, err = opendal.operator.new("memory",{root="/tmp"})
  assert.is_nil(err)
  assert.is_nil(op:write("test.txt","hello world"))