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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
extern crate proc_macro;

use {
    proc_macro2::{Span, TokenStream},
    quote::{quote, quote_spanned},
    std::{
        env,
        fs::File,
        io::prelude::*,
        path::{Path, PathBuf},
    },
    syn::parse::Parse,
};

fn compile_error(s: &str, span: Span) -> TokenStream {
    quote_spanned!(span=> compile_error! { #s })
}

struct AttrArgs {
    ser: syn::ExprPath,
    de: syn::ExprPath,
    value: Option<syn::Type>,
    file: syn::LitStr,
}

impl Parse for AttrArgs {
    fn parse(input: &syn::parse::ParseBuffer<'_>) -> syn::parse::Result<Self> {
        mod kw {
            syn::custom_keyword!(exact);
            syn::custom_keyword!(file);
            syn::custom_keyword!(ser);
            syn::custom_keyword!(de);
            syn::custom_keyword!(value);
            syn::custom_keyword!(serde);
        }

        // TODO: add `superset` mode where actual is "at least" expected
        let _: kw::exact = input.parse()?;
        let _: syn::Token![,] = input.parse()?;

        let la = input.lookahead1();
        let (ser, de, value) = if la.peek(kw::serde) {
            let _: kw::serde = input.parse()?;
            let _: syn::Token![=] = input.parse()?;
            let format: syn::ExprPath = input.parse()?;
            let _: syn::Token![,] = input.parse()?;

            // FUTURE(rust-lang/rust#64797): use #[cfg(accessible)] to prefer `to_string_pretty`
            // as well as fall back to the `::ser::to_string`/`::de::from_str`/`::value::Value`

            // for errors
            let la = input.lookahead1();
            if !(la.peek(kw::ser) || la.peek(kw::de) || la.peek(kw::value) | la.peek(kw::file)) {
                return Err(la.error())?;
            }

            let ser: syn::ExprPath = if input.peek(kw::ser) {
                let _: kw::ser = input.parse()?;
                let _: syn::Token![=] = input.parse()?;
                let ser: syn::ExprPath = input.parse()?;
                let _: syn::Token![,] = input.parse()?;

                // for errors
                let la = input.lookahead1();
                if !(la.peek(kw::de) || la.peek(kw::value) | la.peek(kw::file)) {
                    return Err(la.error())?;
                }

                ser
            } else {
                syn::parse_quote!(#format::to_string)
            };

            let de: syn::ExprPath = if input.peek(kw::de) {
                let _: kw::de = input.parse()?;
                let _: syn::Token![=] = input.parse()?;
                let de: syn::ExprPath = input.parse()?;
                let _: syn::Token![,] = input.parse()?;

                // for errors
                let la = input.lookahead1();
                if !(la.peek(kw::value) | la.peek(kw::file)) {
                    return Err(la.error())?;
                }

                de
            } else {
                syn::parse_quote!(#format::from_str)
            };

            let value: syn::Type = if input.peek(kw::value) {
                let _: kw::value = input.parse()?;
                let _: syn::Token![=] = input.parse()?;
                let value: syn::Type = input.parse()?;
                let _: syn::Token![,] = input.parse()?;
                value
            } else {
                syn::parse_quote!(#format::Value)
            };

            (ser, de, Some(value))
        } else if la.peek(kw::ser) {
            let _: kw::ser = input.parse()?;
            let _: syn::Token![=] = input.parse()?;
            let ser: syn::ExprPath = input.parse()?;
            let _: syn::Token![,] = input.parse()?;

            let _: kw::de = input.parse()?;
            let _: syn::Token![=] = input.parse()?;
            let de: syn::ExprPath = input.parse()?;
            let _: syn::Token![,] = input.parse()?;

            let value = if input.peek(kw::value) {
                let _: kw::value = input.parse()?;
                let _: syn::Token![=] = input.parse()?;
                let value: syn::Type = input.parse()?;
                let _: syn::Token![,] = input.parse()?;
                Some(value)
            } else {
                None
            };

            (ser, de, value)
        } else {
            return Err(la.error())?;
        };

        let _: kw::file = input.parse()?;
        let _: syn::Token![=] = input.parse()?;
        let file: syn::LitStr = input.parse()?;

        Ok(AttrArgs {
            ser,
            de,
            value,
            file,
        })
    }
}

struct Test {
    name: syn::Ident,
    input: String,
    output: String,
}

fn read_tests(file_path: &Path, span: Span) -> Result<Vec<Test>, TokenStream> {
    let source = {
        let mut f = File::open(file_path)
            .map_err(|e| compile_error(&format!("failed to open file: {}", e), span))?;
        let mut s = String::with_capacity(f.metadata().map(|m| m.len() as usize + 1).unwrap_or(0));
        f.read_to_string(&mut s)
            .map_err(|e| compile_error(&format!("failed to read file: {}", e), span))?;
        s
    };

    if !source.ends_with('\n') {
        return Err(compile_error("file needs to have trailing newline", span));
    }

    let (s, trailing) = source.split_at(source.rfind("\n...\n").map_or(0, |i| i + 5));
    if !trailing.trim().is_empty() {
        return Err(compile_error(
            "file has disallowed content after final `...`",
            span,
        ));
    }

    let mut tests = Vec::new();
    let mut errs = TokenStream::new();

    for (i, test) in s.split_terminator("\n...\n").enumerate() {
        let i: usize = i;
        let test: &str = test;

        let (name, rest) = match test.find("\n===\n") {
            Some(ix) => (&test[0..ix], &test[ix + 5..]),
            None => {
                errs.extend(compile_error(
                    &format!("test {} does not have `===` after name", i),
                    span,
                ));
                continue;
            }
        };
        let name = name.trim().replace(' ', "_");

        let (input, output) = match rest.rfind("\n---\n") {
            Some(ix) => (&rest[0..ix], &rest[ix + 5..]),
            None => {
                errs.extend(compile_error(
                    &format!("test `{}` does not have `---` after input", name),
                    span,
                ));
                continue;
            }
        };
        let input = input.trim().to_string();
        let output = output.trim().to_string();

        let name = match syn::parse_str::<syn::Ident>(&format!("_{}", name)) {
            Ok(name) => name,
            Err(_) => {
                errs.extend(compile_error(
                    &format!("`{}` is not a valid test name identifier", name),
                    span,
                ));
                continue;
            }
        };

        tests.push(Test {
            name,
            input,
            output,
        })
    }

    if errs.is_empty() {
        Ok(tests)
    } else {
        Err(errs)
    }
}

#[proc_macro_attribute]
pub fn tests(
    attr: proc_macro::TokenStream,
    item: proc_macro::TokenStream,
) -> proc_macro::TokenStream {
    // we want to re-emit the notated item in all cases
    let mut tts: TokenStream = item.clone().into();

    // emit as many environment compile errors as possible in one place
    let manifest_dir = env::var("CARGO_MANIFEST_DIR")
        .map(PathBuf::from)
        .map_err(|e| {
            let e = format!("expected $CARGO_MANIFEST_DIR; {}", e);
            compile_error(&e, Span::call_site())
        });
    let args = syn::parse::<AttrArgs>(attr).map_err(|e| e.to_compile_error());
    let fun = syn::parse::<syn::ItemFn>(item).map_err(|e| e.to_compile_error());

    match (args, fun, manifest_dir) {
        (Ok(args), Ok(fun), Ok(manifest_dir)) => tts.extend(build_tests(args, fun, manifest_dir)),
        (Err(a), Err(b), Err(c)) => tts.extend(vec![a, b, c]),
        (Err(a), Err(b), _) | (Err(a), _, Err(b)) | (_, Err(a), Err(b)) => tts.extend(vec![a, b]),
        (Err(a), _, _) | (_, Err(a), _) | (_, _, Err(a)) => tts.extend(vec![a]),
    }

    tts.into()
}

fn build_tests(args: AttrArgs, fun: syn::ItemFn, manifest_dir: PathBuf) -> TokenStream {
    let AttrArgs {
        ser,
        de,
        value,
        file,
    } = args;
    let fn_name = &fun.sig.ident;
    let tested_type = match &fun.sig.output {
        syn::ReturnType::Type(_, r#type) => (**r#type).clone(),
        syn::ReturnType::Default => syn::parse_str("()").unwrap(),
    };
    let de_type = value.unwrap_or(tested_type);

    let tests_path = manifest_dir.join(file.value());
    let tests = match read_tests(&tests_path, file.span()) {
        Ok(it) => it,
        Err(e) => return e,
    };

    let filepath = tests_path.to_string_lossy().to_string();
    let filename = tests_path
        .file_stem()
        .unwrap()
        .to_string_lossy()
        .replace('.', "_");
    let testing_fn = syn::Ident::new(&filename, Span::call_site());

    let mut tts = quote! {
        fn #testing_fn(expected: &str, actual: &str) -> Result<(), Box<dyn ::std::error::Error>> {
            const _: &str = include_str!(#filepath);
            let actual = #ser(&#fn_name(actual))?;
            let expected = #ser(&#de::<#de_type>(expected)?)?; // normalize
            assert_eq!(actual, expected);
            Ok(())
        }
    };

    for test in tests {
        let Test {
            name,
            input,
            output,
        } = test;
        let test_name = quote::format_ident!("{}{}", filename, name);
        tts.extend(quote! {
            #[test]
            fn #test_name() -> Result<(), Box<dyn ::std::error::Error>> {
                #testing_fn(#output, #input)
            }
        })
    }

    tts.into()
}