feat(embed): use link-php as a feature to link php library with compiled target

Author: joelwurtz

.cargo/config.toml

@@ -8,4 +8,6 @@ linker = "rust-lld"
 linker = "rust-lld"
 
 [alias]
-ci-test = "hack test --workspace --feature-powerset --clean-per-run"
+ci-test = "hack test --package ext-php-rs --package tests --feature-powerset --clean-per-run --exclude-features=link-php"
+ci-test-link = "hack test --package ext-php-rs --feature-powerset --clean-per-run --features=link-php"
+ci-test-other = "hack test --workspace --exclude ext-php-rs --exclude tests --feature-powerset"

.github/workflows/build.yml

@@ -76,8 +76,9 @@ jobs:
         env:
           DOCS_RS: ""
         run: cargo clean && cargo build
-  build:
-    name: Build and Test
+
+  test:
+    name: Build and test
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
@@ -151,8 +152,114 @@ jobs:
         uses: taiki-e/install-action@v2
         with:
           tool: cargo-hack
-      # Test
-      - name: Test features matrix
+      - name: Test
         env:
           EXT_PHP_RS_TEST: ""
         run: cargo ci-test
+
+  test-link:
+    name: Test that requires linking php library
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        php: ["8.2", "8.3", "8.4"]
+        clang: ["15", "17"]
+        phpts: [ts, nts]
+        exclude:
+          # ext-php-rs requires nightly Rust when on Windows.
+          - os: windows-latest
+            rust: stable
+          - os: macos-latest
+            clang: "17"
+          - os: ubuntu-latest
+            clang: "15"
+          - os: windows-latest
+            clang: "15"
+    env:
+      CARGO_TERM_COLOR: always
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+        env:
+          phpts: ${{ matrix.phpts }}
+          debug: true
+      - name: Setup Rust
+        uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: stable
+          components: rustfmt, clippy
+      - run: rustup show
+      - name: Cache cargo dependencies
+        uses: Swatinem/rust-cache@v2
+        # Uncomment the following if statement if caching nightly deps
+        # ends up causing too much cache invalidation.
+        # if: matrix.rust == 'stable'
+        with:
+          # increment this manually to force cache eviction
+          prefix-key: ${{ env.RUST_CACHE_PREFIX }}
+      # LLVM & Clang
+      - name: Cache LLVM and Clang
+        id: cache-llvm
+        uses: actions/cache@v4
+        # Macos build doesn't work with clang < 18. As a build for version 18 is not available, we skip the setup
+        if: "!contains(matrix.os, 'windows') && !contains(matrix.os, 'macos')"
+        with:
+          path: ${{ runner.temp }}/llvm-${{ matrix.clang }}
+          key: ${{ matrix.os }}-llvm-${{ matrix.clang }}
+      - name: Setup LLVM & Clang
+        id: clang
+        uses: KyleMayes/install-llvm-action@v2
+        # Macos build doesn't work with clang < 18. As a build for version 18 is not available, we skip the setup
+        if: "!contains(matrix.os, 'windows') && !contains(matrix.os, 'macos')"
+        with:
+          version: ${{ matrix.clang }}
+          directory: ${{ runner.temp }}/llvm-${{ matrix.clang }}
+          cached: ${{ steps.cache-llvm.outputs.cache-hit }}
+      - name: Configure Clang
+        # Macos build doesn't work with clang < 18. As a build for version 18 is not available, we skip the setup
+        if: "!contains(matrix.os, 'windows') && !contains(matrix.os, 'macos')"
+        run: |
+          echo "LIBCLANG_PATH=${{ runner.temp }}/llvm-${{ matrix.clang }}/lib" >> $GITHUB_ENV
+          echo "LLVM_VERSION=${{ steps.clang.outputs.version }}" >> $GITHUB_ENV
+          echo "LLVM_CONFIG_PATH=${{ runner.temp }}/llvm-${{ matrix.clang }}/bin/llvm-config" >> $GITHUB_ENV
+      - name: Install cargo-hack
+        uses: taiki-e/install-action@v2
+        with:
+          tool: cargo-hack
+      - name: Test
+        env:
+          EXT_PHP_RS_TEST: ""
+        run: cargo ci-test-link
+
+  test-others:
+    name: Test others crates not depen
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        rust: [stable, nightly]
+    env:
+      CARGO_TERM_COLOR: always
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Setup Rust
+        uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: ${{ matrix.rust }}
+          components: rustfmt, clippy
+      - run: rustup show
+      - name: Install cargo-hack
+        uses: taiki-e/install-action@v2
+        with:
+          tool: cargo-hack
+      # Test
+      - name: Test
+        env:
+          EXT_PHP_RS_TEST: ""
+        run: cargo ci-test-other

Cargo.toml

@@ -38,6 +38,7 @@ zip = "2.2"
 
 [features]
 closure = []
+link-php = []
 
 [workspace]
 members = [

build.rs

@@ -50,7 +50,7 @@ pub trait PHPProvider<'a>: Sized {
     }
 
     /// Prints any extra link arguments.
-    fn print_extra_link_args(&self, _has_embed: bool) -> Result<()> {
+    fn print_extra_link_args(&self) -> Result<()> {
         Ok(())
     }
 }
@@ -347,7 +347,7 @@ fn main() -> Result<()> {
     if info.thread_safety()? {
         println!("cargo:rustc-cfg=php_zts");
     }
-    provider.print_extra_link_args(has_embed)?;
+    provider.print_extra_link_args()?;
 
     // Generate guide tests
     let test_md = skeptic::markdown_files_of_directory("guide");

src/embed/mod.rs

@@ -59,7 +59,7 @@ impl Embed {
     ///
     /// # Example
     ///
-    /// ```
+    /// ```no_run
     /// use ext_php_rs::embed::Embed;
     ///
     /// Embed::run(|| {
@@ -123,7 +123,7 @@ impl Embed {
     ///
     /// # Example
     ///
-    /// ```
+    /// ```no_run
     /// use ext_php_rs::embed::Embed;
     ///
     /// Embed::run(|| {
@@ -179,7 +179,7 @@ impl Embed {
     ///
     /// # Example
     ///
-    /// ```
+    /// ```no_run
     /// use ext_php_rs::embed::Embed;
     ///
     /// Embed::run(|| {
@@ -211,7 +211,7 @@ impl Embed {
     }
 }
 
-#[cfg(test)]
+#[cfg(all(test, feature = "link-php"))]
 mod tests {
     use super::Embed;
 

src/types/iterator.rs

@@ -182,8 +182,7 @@ impl<'a> FromZvalMut<'a> for &'a mut ZendIterator {
     }
 }
 
-#[cfg(test)]
-#[cfg(php_embed)]
+#[cfg(all(test, php_embed, feature = "link-php"))]
 mod tests {
     use crate::embed::Embed;
 

src/types/string.rs

@@ -455,8 +455,7 @@ impl<'a> FromZval<'a> for &'a str {
     }
 }
 
-#[cfg(test)]
-#[cfg(php_embed)]
+#[cfg(all(test, php_embed, feature = "link-php"))]
 mod tests {
     use crate::embed::Embed;
 

src/zend/try_catch.rs

@@ -102,8 +102,7 @@ pub unsafe fn bailout() -> ! {
     ext_php_rs_zend_bailout();
 }
 
-#[cfg(php_embed)]
-#[cfg(test)]
+#[cfg(all(test, php_embed, feature = "link-php"))]
 mod tests {
     use crate::embed::Embed;
     use crate::zend::{bailout, try_catch};

tests/module.rs

@@ -1,5 +1,5 @@
 #![cfg_attr(windows, feature(abi_vectorcall))]
-#![cfg(php_embed)]
+#![cfg(all(php_embed, feature = "link-php"))]
 
 extern crate ext_php_rs;
 

tests/sapi.rs

@@ -1,5 +1,5 @@
 #![cfg_attr(windows, feature(abi_vectorcall))]
-#![cfg(php_embed)]
+#![cfg(all(php_embed, feature = "link-php"))]
 
 extern crate ext_php_rs;