Merge branch 'test/afl'

close #26

Cargo.toml

@@ -4,9 +4,10 @@ members = [
   "sailfish-compiler",
   "sailfish-macros",
   "examples",
-  "integration-tests"
+  "sailfish-tests/integration-tests"
 ]
 exclude = [
+  "sailfish-tests/fuzzing-tests",
   "benches"
 ]
 

sailfish-compiler/src/compiler.rs

@@ -3,6 +3,7 @@ use std::fs;
 use std::io::Write;
 use std::path::{Path, PathBuf};
 use std::sync::Arc;
+use syn::Block;
 
 use crate::config::Config;
 use crate::error::*;
@@ -91,4 +92,38 @@ impl Compiler {
                 e
             })
     }
+
+    pub fn compile_str(&self, input: &str) -> Result<String, Error> {
+        let dummy_path = Path::new(env!("CARGO_MANIFEST_DIR"));
+
+        let include_handler = Arc::new(|_: &Path| -> Result<Block, Error> {
+            Err(make_error!(
+                ErrorKind::AnalyzeError(
+                    "include! macro is not allowed in inline template".to_owned()
+                ),
+                source = input.to_owned()
+            ))
+        });
+
+        let parser = Parser::new().delimiter(self.config.delimiter);
+        let translator = Translator::new().escape(self.config.escape);
+        let resolver = Resolver::new().include_handler(include_handler);
+        let optimizer = Optimizer::new().rm_whitespace(self.config.rm_whitespace);
+
+        let compile = || -> Result<String, Error> {
+            let stream = parser.parse(input);
+            let mut tsource = translator.translate(stream)?;
+            resolver.resolve(dummy_path, &mut tsource.ast)?;
+
+            optimizer.optimize(&mut tsource.ast);
+            Ok(tsource.ast.into_token_stream().to_string())
+        };
+
+        compile()
+            .chain_err(|| "Failed to compile template.")
+            .map_err(|mut e| {
+                e.source = Some(input.to_owned());
+                e
+            })
+    }
 }

sailfish-compiler/src/procmacro.rs

@@ -200,6 +200,7 @@ fn derive_template_impl(tokens: TokenStream) -> Result<TokenStream, syn::Error>
             .ancestors()
             .find(|p| p.join("LICENSE").exists())
             .unwrap()
+            .join("sailfish-tests")
             .join("integration-tests")
             .join("tests")
             .join("fails")

sailfish-tests/fuzzing-tests/.gitignore

@@ -0,0 +1 @@
+/out/

sailfish-tests/fuzzing-tests/Cargo.lock

@@ -0,0 +1,258 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+[[package]]
+name = "afl"
+version = "0.8.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2797f92fb146a37560af914b5d5328f8330d6a39b6eaf00f5b184ac73c0c81e7"
+dependencies = [
+ "cc",
+ "clap",
+ "libc",
+ "rustc_version",
+ "xdg",
+]
+
+[[package]]
+name = "ansi_term"
+version = "0.11.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ee49baf6cb617b853aa8d93bf420db2383fab46d314482ca2803b40d5fde979b"
+dependencies = [
+ "winapi",
+]
+
+[[package]]
+name = "atty"
+version = "0.2.14"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d9b39be18770d11421cdb1b9947a45dd3f37e93092cbf377614828a319d5fee8"
+dependencies = [
+ "hermit-abi",
+ "libc",
+ "winapi",
+]
+
+[[package]]
+name = "bitflags"
+version = "1.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "cf1de2fe8c75bc145a2f577add951f8134889b4795d47466a54a5c846d691693"
+
+[[package]]
+name = "cc"
+version = "1.0.58"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f9a06fb2e53271d7c279ec1efea6ab691c35a2ae67ec0d91d7acec0caf13b518"
+
+[[package]]
+name = "clap"
+version = "2.33.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "bdfa80d47f954d53a35a64987ca1422f495b8d6483c0fe9f7117b36c2a792129"
+dependencies = [
+ "ansi_term",
+ "atty",
+ "bitflags",
+ "strsim",
+ "textwrap",
+ "unicode-width",
+ "vec_map",
+]
+
+[[package]]
+name = "fuzzing-tests"
+version = "0.1.3"
+dependencies = [
+ "afl",
+ "sailfish",
+ "sailfish-compiler",
+]
+
+[[package]]
+name = "hermit-abi"
+version = "0.1.15"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3deed196b6e7f9e44a2ae8d94225d80302d81208b1bb673fd21fe634645c85a9"
+dependencies = [
+ "libc",
+]
+
+[[package]]
+name = "itoap"
+version = "0.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8e804a5759b475f44377998918a7e3be9da3767056f5e77751ef7803893db0e9"
+
+[[package]]
+name = "libc"
+version = "0.2.72"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a9f8082297d534141b30c8d39e9b1773713ab50fdbe4ff30f750d063b3bfd701"
+
+[[package]]
+name = "linked-hash-map"
+version = "0.5.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8dd5a6d5999d9907cda8ed67bbd137d3af8085216c2ac62de5be860bd41f304a"
+
+[[package]]
+name = "memchr"
+version = "2.3.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3728d817d99e5ac407411fa471ff9800a778d88a24685968b36824eaf4bee400"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "beae6331a816b1f65d04c45b078fd8e6c93e8071771f41b8163255bbd8d7c8fa"
+dependencies = [
+ "unicode-xid",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "aa563d17ecb180e500da1cfd2b028310ac758de548efdd203e18f283af693f37"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "rustc_version"
+version = "0.2.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "138e3e0acb6c9fb258b19b67cb8abd63c00679d2851805ea151465464fe9030a"
+dependencies = [
+ "semver",
+]
+
+[[package]]
+name = "ryu"
+version = "1.0.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "71d301d4193d031abdd79ff7e3dd721168a9572ef3fe51a1517aba235bd8f86e"
+
+[[package]]
+name = "sailfish"
+version = "0.1.3"
+dependencies = [
+ "itoap",
+ "ryu",
+ "version_check",
+]
+
+[[package]]
+name = "sailfish-compiler"
+version = "0.1.3"
+dependencies = [
+ "memchr",
+ "proc-macro2",
+ "quote",
+ "syn",
+ "yaml-rust",
+]
+
+[[package]]
+name = "semver"
+version = "0.9.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1d7eb9ef2c18661902cc47e535f9bc51b78acd254da71d375c2f6720d9a40403"
+dependencies = [
+ "semver-parser",
+]
+
+[[package]]
+name = "semver-parser"
+version = "0.7.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "388a1df253eca08550bef6c72392cfe7c30914bf41df5269b68cbd6ff8f570a3"
+
+[[package]]
+name = "strsim"
+version = "0.8.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8ea5119cdb4c55b55d432abb513a0429384878c15dde60cc77b1c99de1a95a6a"
+
+[[package]]
+name = "syn"
+version = "1.0.34"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "936cae2873c940d92e697597c5eee105fb570cd5689c695806f672883653349b"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-xid",
+]
+
+[[package]]
+name = "textwrap"
+version = "0.11.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d326610f408c7a4eb6f51c37c330e496b08506c9457c9d34287ecc38809fb060"
+dependencies = [
+ "unicode-width",
+]
+
+[[package]]
+name = "unicode-width"
+version = "0.1.8"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9337591893a19b88d8d87f2cec1e73fad5cdfd10e5a6f349f498ad6ea2ffb1e3"
+
+[[package]]
+name = "unicode-xid"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f7fe0bb3479651439c9112f72b6c505038574c9fbb575ed1bf3b797fa39dd564"
+
+[[package]]
+name = "vec_map"
+version = "0.8.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f1bddf1187be692e79c5ffeab891132dfb0f236ed36a43c7ed39f1165ee20191"
+
+[[package]]
+name = "version_check"
+version = "0.9.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b5a972e5669d67ba988ce3dc826706fb0a8b01471c088cb0b6110b805cc36aed"
+
+[[package]]
+name = "winapi"
+version = "0.3.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419"
+dependencies = [
+ "winapi-i686-pc-windows-gnu",
+ "winapi-x86_64-pc-windows-gnu",
+]
+
+[[package]]
+name = "winapi-i686-pc-windows-gnu"
+version = "0.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6"
+
+[[package]]
+name = "winapi-x86_64-pc-windows-gnu"
+version = "0.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f"
+
+[[package]]
+name = "xdg"
+version = "2.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d089681aa106a86fade1b0128fb5daf07d5867a509ab036d99988dec80429a57"
+
+[[package]]
+name = "yaml-rust"
+version = "0.4.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "39f0c922f1a334134dc2f7a8b67dc5d25f0735263feec974345ff706bcf20b0d"
+dependencies = [
+ "linked-hash-map",
+]

sailfish-tests/fuzzing-tests/Cargo.toml

@@ -0,0 +1,13 @@
+[package]
+name = "fuzzing-tests"
+version = "0.1.3"
+authors = ["Ryohei Machida <orcinus4627@gmail.com>"]
+edition = "2018"
+publish = false
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+afl = "0.8.0"
+sailfish = { path = "../../sailfish" }
+sailfish-compiler = { path = "../../sailfish-compiler" }

sailfish-tests/fuzzing-tests/in/compiler/compiler1

@@ -0,0 +1 @@
+<h1><%= message %></h1>

sailfish-tests/fuzzing-tests/in/compiler/compiler2

@@ -0,0 +1,9 @@
+<table>
+<% for i in 1..=9 %>
+  <tr>
+  <% for j in 1..=9 %>
+    <td><%= i * j %></td>
+  <% } %>
+  </td>
+<% } %>
+</table>

sailfish-tests/fuzzing-tests/in/escape/escape1

@@ -0,0 +1 @@
+<a href="http://example.com/">

sailfish-tests/fuzzing-tests/in/escape/escape2

@@ -0,0 +1,5 @@
+for row in &table {
+    for col in row {
+        println!("{}", *col);
+    }
+}

sailfish-tests/fuzzing-tests/src/bin/compiler.rs

@@ -0,0 +1,14 @@
+#[macro_use]
+extern crate afl;
+
+use sailfish_compiler::Compiler;
+
+fn main() {
+    fuzz!(|data: &[u8]| {
+        // HTML escaping
+        if let Ok(feed) = std::str::from_utf8(data) {
+            let compiler = Compiler::default();
+            let _ = compiler.compile_str(feed);
+        }
+    });
+}

sailfish-tests/fuzzing-tests/src/bin/escape.rs

@@ -0,0 +1,15 @@
+#[macro_use]
+extern crate afl;
+
+use sailfish::runtime as sf;
+use sf::Render;
+
+fn main() {
+    fuzz!(|data: &[u8]| {
+        // HTML escaping
+        if let Ok(feed) = std::str::from_utf8(data) {
+            let mut buf = sf::Buffer::new();
+            let _ = feed.render_escaped(&mut buf);
+        }
+    });
+}

sailfish-tests/integration-tests/Cargo.toml

@@ -6,9 +6,9 @@ edition = "2018"
 publish = false
 
 [dependencies]
-sailfish = { path = "../sailfish" }
-sailfish-macros = { path = "../sailfish-macros" }
-sailfish-compiler = { path = "../sailfish-compiler" }
+sailfish = { path = "../../sailfish" }
+sailfish-macros = { path = "../../sailfish-macros" }
+sailfish-compiler = { path = "../../sailfish-compiler" }
 
 [dev-dependencies]
 trybuild = "1.0.28"