polyplug 0.1.1

Universal high-performance zero-overhead cross-language plugin runtime
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

#![allow(clippy::expect_used)]

//! Library-lifetime correctness test.
//!
//! Regression test for Epic 9.6: NativeBundleLoader must NOT drop the
//! libloading::Library handle at the end of load_bundle(). If it did,
//! dlclose() would unmap plugin code pages while interface fn pointers
//! into those pages are still stored in the Registry (use-after-free / SIGBUS).

use polyplug::loader::ManifestData;
use polyplug::loader::parse_manifest;
use polyplug::runtime::Runtime;
use polyplug_utils::bundle_id;
use std::sync::Arc;

mod common;

use common::TestNativeLoader;

/// Path to the compiled test_plugin shared library — set by build.rs.
const TEST_PLUGIN_DIR: &str = env!("TEST_PLUGIN_DIR");

// ─── Tests ────────────────────────────────────────────────────────────────────

/// Verify that loading a bundle through the Runtime keeps the Library handle alive.
///
/// The Runtime::load_bundle() method properly manages library lifetime through
/// the BundleLoader trait - the loader keeps the Library alive in its internal state.
///
/// Skipped under Miri: Miri does not support dlopen.
#[test]
#[cfg(not(miri))]
fn library_handle_outlives_load_call() {
    let plugin_dir: &std::path::Path = std::path::Path::new(TEST_PLUGIN_DIR);
    let mut manifest: ManifestData =
        parse_manifest(plugin_dir).expect("parse_manifest for test_plugin_dir");
    manifest.id = bundle_id(&manifest.name);

    // Create a runtime with a native loader registered (the core crate is
    // loader-agnostic, so loading native bundles requires registering one).
    let runtime: Arc<Runtime> = Runtime::builder()
        .loader(TestNativeLoader::new())
        .build()
        .expect("runtime build should succeed");

    // Use Runtime::load_bundle which properly manages library lifetime
    let so_path: std::path::PathBuf = plugin_dir.join(&manifest.file);
    runtime
        .load_bundle(&so_path)
        .expect("load_bundle must succeed for test_plugin");

    // The Runtime keeps the library alive internally
    // Dropping the runtime will properly cleanup
    drop(runtime);
    // Reaching here without SIGBUS or panic confirms clean cleanup.
}

/// Verify `Runtime::load_bundle_from_source` loads a native bundle end-to-end from a
/// caller-supplied manifest plus a `BundleSource::Path`.
///
/// Skipped under Miri: Miri does not support dlopen.
#[test]
#[cfg(not(miri))]
fn load_bundle_from_source_path_loads_native_bundle() {
    let plugin_dir: &std::path::Path = std::path::Path::new(TEST_PLUGIN_DIR);
    let mut manifest: ManifestData =
        parse_manifest(plugin_dir).expect("parse_manifest for test_plugin_dir");
    manifest.id = bundle_id(&manifest.name);

    let runtime: Arc<Runtime> = Runtime::builder()
        .loader(TestNativeLoader::new())
        .build()
        .expect("runtime build should succeed");

    // parse_manifest sets manifest.path to the bundle directory; the Path source
    // carries the same directory, so loading proceeds exactly as the path-based path.
    let source: polyplug::loader::BundleSource =
        polyplug::loader::BundleSource::Path(manifest.path.clone());

    runtime
        .load_bundle_from_source(manifest, source)
        .expect("load_bundle_from_source must succeed for test_plugin");

    drop(runtime);
    // Reaching here without SIGBUS or panic confirms a clean end-to-end load.
}

/// Miri-compatible structural assertion.
///
/// Under Miri, dlopen is not supported so the above test is excluded.
/// This test verifies that the structural ownership invariant compiles correctly.
#[test]
#[cfg(miri)]
fn push_library_ownership_enforced_at_compile_time() {
    // This is a documentation test. The ownership invariant is a type-system guarantee.
    assert!(
        true,
        "ownership invariant is statically verified by the compiler"
    );
}