summaryrefslogtreecommitdiffstats
path: root/third_party/rust/uniffi_testing/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
commit36d22d82aa202bb199967e9512281e9a53db42c9 (patch)
tree105e8c98ddea1c1e4784a60a5a6410fa416be2de /third_party/rust/uniffi_testing/README.md
parentInitial commit. (diff)
downloadfirefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.tar.xz
firefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.zip
Adding upstream version 115.7.0esr.upstream/115.7.0esrupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'third_party/rust/uniffi_testing/README.md')
-rw-r--r--third_party/rust/uniffi_testing/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/third_party/rust/uniffi_testing/README.md b/third_party/rust/uniffi_testing/README.md
new file mode 100644
index 0000000000..c171b26373
--- /dev/null
+++ b/third_party/rust/uniffi_testing/README.md
@@ -0,0 +1,18 @@
+This crate contains helper code for testing bindings. Our general system is to
+generate bindings for the libraries from the examples and fixtures
+directories, then execute a script that tests the bindings.
+
+Each bindings crate can do this in a different way, but the typical system is:
+
+ - Construct a `UniFFITestHelper` struct to assist the process
+ - Call `UniFFITestHelper.create_out_dir()` to create a temp directory to
+ store testing files
+ - Call `UniFFITestHelper.copy_cdylibs_to_out_dir()` to copy the dylib
+ artifacts for the example/fixture library to the `out_dir`. This is needed
+ because the bindings code dynamically links to or loads from this library.
+ - Call `UniFFITestHelper.get_compile_sources()` to iterate over (`udl_path`,
+ `uniffi_config_path`) pairs and generate the bindings from them. This step
+ is specific to the bindings language, it may mean creating a .jar file,
+ compiling a binary, or just copying script files over.
+ - Execute the test script and check if it succeeds. This step is also
+ specific to the bindings language.