tests: added annotations coverage test

Author: alemidev

Cargo.lock

@@ -62,7 +62,8 @@ pyo3 = { version = "0.28", features = ["multiple-pymethods", "uuid"], optional =
 # extra
 async-trait = { version = "0.1", optional = true }
 serde = { version = "1.0", features = ["derive"], optional = true }
-syn = { version = "2.0.117", features = ["full", "visit"] }
+syn = { version = "2.0.117", features = ["full", "visit"], optional = true }
+regex = { version = "1.12", optional = true }
 
 [build-dependencies]
 # glue (js)
@@ -77,7 +78,7 @@ async-trait = ["dep:async-trait"]
 serialize = ["dep:serde", "uuid/serde"]
 # special tests which require more setup
 test-e2e = []
-test-coverage = []
+test-coverage = ["dep:syn", "dep:regex"]
 # ffi
 java = ["dep:jni", "dep:tracing-subscriber", "dep:jni-toolbox"]
 js = ["dep:napi-build", "dep:tracing-subscriber", "dep:napi", "dep:napi-derive"]

Cargo.toml

@@ -0,0 +1,31 @@
+#[test]
+#[cfg(all(test, feature = "lua"))]
+fn lua_annotations_should_cover_ffi_api_surface() {
+	let annotations = include_str!("../../../dist/lua/annotations.lua");
+
+	let source = concat!(
+		include_str!("../../ffi/lua/client.rs"),
+		include_str!("../../ffi/lua/workspace.rs"),
+		include_str!("../../ffi/lua/buffer.rs"),
+		include_str!("../../ffi/lua/cursor.rs"),
+	);
+
+	let re = regex::Regex::new("add_method\\(\\s+\"(\\w+)\",").expect("failed building regex");
+
+	let mut missing = Vec::new();
+	for (_, [fn_name]) in re.captures_iter(source).map(|c| c.extract()) {
+		if !annotations.contains(fn_name) {
+			#[cfg(feature = "ci")]
+			{
+				println!("::warning title=Coverage::Missing Lua annotations for method: '{fn_name}'");
+			}
+			missing.push(fn_name.to_string());
+		}
+	}
+
+	assert!(
+		missing.is_empty(),
+		"missing lua annotations for methods: '{}'",
+		missing.join("', '"),
+	);
+}

src/tests/coverage/annotations.rs

@@ -181,9 +181,9 @@ fn python_ffi_should_cover_rust_api_surface() {
 	let required = discover_core_surface(files, targets);
 
 	let python_src = concat!(
-		include_str!("../ffi/python/client.rs"),
-		include_str!("../ffi/python/workspace.rs"),
-		include_str!("../ffi/python/controllers.rs"),
+		include_str!("../../ffi/python/client.rs"),
+		include_str!("../../ffi/python/workspace.rs"),
+		include_str!("../../ffi/python/controllers.rs"),
 	);
 
 	let python_ignore = ["Client.connect"];
@@ -224,10 +224,10 @@ fn javascript_ffi_should_cover_rust_api_surface() {
 	let required = discover_core_surface(files, targets);
 
 	let js_src = concat!(
-		include_str!("../ffi/js/client.rs"),
-		include_str!("../ffi/js/workspace.rs"),
-		include_str!("../ffi/js/buffer.rs"),
-		include_str!("../ffi/js/cursor.rs"),
+		include_str!("../../ffi/js/client.rs"),
+		include_str!("../../ffi/js/workspace.rs"),
+		include_str!("../../ffi/js/buffer.rs"),
+		include_str!("../../ffi/js/cursor.rs"),
 	);
 
 	let js_ignore = [];
@@ -268,10 +268,10 @@ fn lua_ffi_should_cover_rust_api_surface() {
 	let required = discover_core_surface(files, targets);
 
 	let lua_src = concat!(
-		include_str!("../ffi/lua/client.rs"),
-		include_str!("../ffi/lua/workspace.rs"),
-		include_str!("../ffi/lua/buffer.rs"),
-		include_str!("../ffi/lua/cursor.rs"),
+		include_str!("../../ffi/lua/client.rs"),
+		include_str!("../../ffi/lua/workspace.rs"),
+		include_str!("../../ffi/lua/buffer.rs"),
+		include_str!("../../ffi/lua/cursor.rs"),
 	);
 
 	let lua_ignore = ["Client.connect"];
@@ -312,10 +312,10 @@ fn java_ffi_should_cover_rust_api_surface() {
 	let required = discover_core_surface(files, targets);
 
 	let java_src = concat!(
-		include_str!("../ffi/java/client.rs"),
-		include_str!("../ffi/java/workspace.rs"),
-		include_str!("../ffi/java/buffer.rs"),
-		include_str!("../ffi/java/cursor.rs"),
+		include_str!("../../ffi/java/client.rs"),
+		include_str!("../../ffi/java/workspace.rs"),
+		include_str!("../../ffi/java/buffer.rs"),
+		include_str!("../../ffi/java/cursor.rs"),
 	);
 
 	let java_ignore = [];

src/tests/coverage.rs src/tests/coverage/ffi.rssrc/tests/coverage.rs renamed to src/tests/coverage/ffi.rs

@@ -0,0 +1,2 @@
+pub mod ffi;
+pub mod annotations;