Write php integration tests.

jmjoy · jmjoy · commit d618bf3ca96f · 2020-11-16T00:04:41.000+08:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -8,8 +8,8 @@ on:
 
 env:
   CARGO_TERM_COLOR: always
-#  RUST_BACKTRACE: 1
-#  RUST_LOG: debug
+  #  RUST_BACKTRACE: 1
+  #  RUST_LOG: debug
   RUSTFLAGS: "-D warnings"
 
 jobs:
@@ -35,7 +35,7 @@ jobs:
           php-version: ${{ matrix.php-version }}
           tools: php-config
 
-      - name: PHP Config
+      - name: PHP version
         run: php-config --version && php-config --phpapi && php --version
 
       - name: Checkout
@@ -44,20 +44,40 @@ jobs:
       - name: Install Rust
         uses: actions-rs/toolchain@v1
         with:
-            toolchain: nightly-2020-11-09
-            override: true
-            components: rustfmt, clippy
+          toolchain: nightly-2020-11-09
+          override: true
+          components: rustfmt, clippy
 
-      - uses: actions-rs/cargo@v1
+      - name: Install Cargo make
+        uses: actions-rs/cargo@v1
+        with:
+          command: install
+          args: cargo-make
+
+      - name: Cargo fmt
+        uses: actions-rs/cargo@v1
         with:
           command: fmt
           args: --all -- --check
-          
-      - uses: actions-rs/cargo@v1
+
+      - name: Cargo build
+        uses: actions-rs/cargo@v1
+        with:
+          command: build
+
+      - name: Cargo test
+        uses: actions-rs/cargo@v1
         with:
           command: test
           args: -- --nocapture
 
-      - uses: actions-rs/cargo@v1
+      - name: Cargo doc
+        uses: actions-rs/cargo@v1
         with:
           command: doc
+
+      - name: Cargo test example simple
+        uses: actions-rs/cargo@v1
+        with:
+          command: make
+          args: test-php --cwd examples/simple --profile production
diff --git a/.gitignore b/.gitignore
@@ -1,9 +1,5 @@
 /target
 **/*.rs.bk
 Cargo.lock
-/.idea
-.vscode
 /.cargo
 /vendor
-/trail-extension
-*.test.sh
diff --git a/Cargo.toml b/Cargo.toml
@@ -5,6 +5,7 @@ members = [
     "phper-build",
     "phper-macros",
     "phper-sys",
+    "phper-test",
 
     # internal
     "examples/simple",
diff --git a/examples/simple/Cargo.toml b/examples/simple/Cargo.toml
@@ -13,5 +13,8 @@ crate-type = ["cdylib"]
 [dependencies]
 phper = { version = "0.2", path = "../../phper" }
 
+[dev-dependencies]
+phper-test = { version = "0.2", path = "../../phper-test" }
+
 [build-dependencies]
 phper-build = { version = "0.2", path = "../../phper-build" }
diff --git a/examples/simple/Makefile.toml b/examples/simple/Makefile.toml
@@ -4,9 +4,22 @@ TARGET_DIR = "${CARGO_MAKE_WORKING_DIRECTORY}/../../target"
 
 [env.development]
 TARGET_BUILD_DIR = "${TARGET_DIR}/debug"
+BUILD_ARGS = ""
+TEST_ARGS = ""
 
 [env.production]
 TARGET_BUILD_DIR = "${TARGET_DIR}/release"
+BUILD_ARGS = "--release"
+TEST_ARGS = "--release"
+
+[tasks.build]
+command = "cargo"
+args = ["build", "${BUILD_ARGS}"]
+
+[tasks.test]
+command = "cargo"
+args = ["test", "${TEST_ARGS}", "--", "--nocapture"]
+env = { "LIB_SO" = "${TARGET_BUILD_DIR}/lib${CARGO_MAKE_CRATE_NAME}.so" }
 
 [tasks.install]
 dependencies = ["build"]
@@ -16,15 +29,3 @@ script = [
     echo Installing shared extensions:     `${PHP_CONFIG} --extension-dir`
     """
 ]
-
-[tasks.test-php]
-script = [
-    "`${PHP_CONFIG} --php-binary` tests/confirm_compiled.php"
-]
-
-[tasks.test-all]
-dependencies = [
-    "install",
-    "test",
-    "test-php",
-]
diff --git a/examples/simple/src/lib.rs b/examples/simple/src/lib.rs
@@ -129,9 +129,11 @@ pub fn my_class_foo(execute_data: ExecuteData) -> impl SetVal {
         let foo = unsafe {
             zend_read_property(MY_CLASS_CE.get(), this, c_str_ptr!("foo"), 3, 1, null_mut())
         };
-        let foo = Val::from_raw(foo);
-        let foo = foo.as_c_str().unwrap().to_str().unwrap();
-        format!("{}{}", prefix, foo)
+        // let foo = Val::from_raw(foo);
+        // let foo = foo.as_c_str().unwrap().to_str().unwrap();
+        // format!("{}{}", prefix, foo)
+
+        ""
     })
 }
 
diff --git a/examples/simple/tests/integration.rs b/examples/simple/tests/integration.rs
@@ -0,0 +1,17 @@
+use phper_test::test_php_scripts;
+use std::{env, ffi::OsStr, fmt::Debug, path::Path, process::Command, sync::Once};
+
+#[test]
+fn test_php() {
+    test_php_scripts(
+        Path::new(env!("CARGO_MANIFEST_DIR"))
+            .join("..")
+            .join("..")
+            .join("target"),
+        env!("CARGO_PKG_NAME"),
+        &[Path::new(env!("CARGO_MANIFEST_DIR"))
+            .join("tests")
+            .join("php")
+            .join("test.php")],
+    );
+}
diff --git a/examples/simple/tests/php/test.php b/examples/simple/tests/php/test.php
diff --git a/phper-test/Cargo.toml b/phper-test/Cargo.toml
@@ -0,0 +1,16 @@
+[package]
+name = "phper-test"
+version = "0.2.0"
+authors = ["jmjoy <918734043@qq.com>"]
+edition = "2018"
+description = "PHPer testing utilities."
+repository = "https://github.com/jmjoy/phper.git"
+license = "Unlicense"
+keywords = ["php", "binding"]
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+once_cell = "1.5.2"
+serde_json = "1.0.59"
+tempfile = "3.1.0"
diff --git a/phper-test/LICENSE b/phper-test/LICENSE
@@ -0,0 +1 @@
+../LICENSE
diff --git a/phper-test/README.md b/phper-test/README.md
@@ -0,0 +1,3 @@
+# phper-test
+
+PHPer testing utilities.
diff --git a/phper-test/src/lib.rs b/phper-test/src/lib.rs
@@ -0,0 +1,103 @@
+use once_cell::sync::OnceCell;
+use serde_json::Value;
+use std::{
+    env, ffi::OsStr, fmt::Debug, fs::read_to_string, io, io::Write, path::Path, process::Command,
+};
+use tempfile::{tempfile, NamedTempFile};
+
+pub fn test_php_scripts(
+    target_dir: impl AsRef<Path>,
+    lib_name: &str,
+    scripts: &[impl AsRef<Path>],
+) {
+    let context = php_context();
+
+    let mut lib_path = target_dir
+        .as_ref()
+        .join(if cfg!(debug_assertions) {
+            "debug"
+        } else {
+            "release"
+        })
+        .join(format!("lib{}.so", lib_name));
+
+    let mut out_ini_temp_file = NamedTempFile::new().unwrap();
+    let out_ini_file = out_ini_temp_file.as_file_mut();
+
+    out_ini_file
+        .write_all(context.ini_content.as_bytes())
+        .unwrap();
+    out_ini_file
+        .write_fmt(format_args!("extension={}\n", lib_path.to_str().unwrap()))
+        .unwrap();
+
+    for script in scripts {
+        let script = script.as_ref();
+        let mut cmd = Command::new(&context.php_bin);
+        cmd.arg("-n")
+            .arg("-c")
+            .arg(out_ini_temp_file.path())
+            .arg(script);
+        let output = cmd.output().unwrap();
+        if !output.status.success() {
+            eprintln!(
+                "stdout: {}\nstderr: {}",
+                String::from_utf8(output.stdout).unwrap(),
+                String::from_utf8(output.stderr).unwrap()
+            );
+            panic!("test php file `{}` failed", script.to_str().unwrap());
+        }
+    }
+}
+
+struct Context {
+    php_config: String,
+    php_bin: String,
+    ini_content: String,
+}
+
+fn php_context() -> &'static Context {
+    static CONTEXT: OnceCell<Context> = OnceCell::new();
+    &CONTEXT.get_or_init(|| {
+        let mut ini_content = String::new();
+
+        let php_config = env::var("PHP_CONFIG").unwrap_or("php-config".to_string());
+        let php_bin = execute_command(&[php_config.as_str(), "--php-binary"]);
+        let ini_file = execute_command(&[
+            php_bin.as_str(),
+            "-d",
+            "display_errors=stderr",
+            "-r",
+            "echo php_ini_loaded_file();",
+        ]);
+        let ini_files = execute_command(&[
+            php_bin.as_str(),
+            "-d",
+            "display_errors=stderr",
+            "-r",
+            "echo php_ini_scanned_files();",
+        ]);
+
+        ini_content.push_str(&read_to_string(ini_file).unwrap());
+        for file in ini_files.split(',') {
+            let file = file.trim();
+            ini_content.push_str(&read_to_string(file).unwrap());
+        }
+
+        Context {
+            php_config,
+            php_bin,
+            ini_content,
+        }
+    })
+}
+
+fn execute_command<S: AsRef<OsStr> + Debug>(argv: &[S]) -> String {
+    let mut command = Command::new(&argv[0]);
+    command.args(&argv[1..]);
+    let output = command
+        .output()
+        .expect(&format!("Execute command {:?} failed", &argv))
+        .stdout;
+    String::from_utf8(output).unwrap().trim().to_owned()
+}
