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
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
extern crate proc_macro;

use proc_macro2::{Span, TokenStream};
use quote::quote;

#[derive(Copy, Clone, Debug)]
enum RenamingMode {
    Append,
    Prefix
}

/// Can be used like `#[test_double]` to use `Mock____` in tests or
/// `#[test_double(ObjectDummy)]` to use `ObjectDummy`.
#[proc_macro_attribute]
pub fn test_double(metadata: proc_macro::TokenStream, input: proc_macro::TokenStream) -> proc_macro::TokenStream {
    let mut output = TokenStream::new();
    attribute_internal(metadata.into(), &input.to_string(), &mut output, RenamingMode::Append);
    output.into()
}

/// Can be used like `#[test_double_prefixed]` to use `____Mock` in tests or
/// `#[test_double_prefixed(ObjectDummy)]` to use `ObjectDummy`.
#[proc_macro_attribute]
pub fn test_double_prefixed(metadata: proc_macro::TokenStream, input: proc_macro::TokenStream) -> proc_macro::TokenStream {
    let mut output = TokenStream::new();
    attribute_internal(metadata.into(), &input.to_string(), &mut output, RenamingMode::Prefix);
    output.into()
}

fn attribute_internal(metadata: TokenStream, input: &str, output: &mut TokenStream, renaming_mode: RenamingMode) {
    let mut alternate_ident = None;

    if !metadata.is_empty() {
        let error_message =
            "Invalid input to #[test_double] - use it like #[test_double(AlternateName)].";
        alternate_ident = Some(syn::parse2::<syn::Ident>(metadata).expect(error_message));
    }

    // Generate the AST from the token stream we were given
    let item: syn::Item = syn::parse_str(input).expect("Failed to parse input");

    process_single_item(item, alternate_ident, output, renaming_mode);
}

#[proc_macro]
pub fn test_doubles(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
    let mut output = TokenStream::new();
    functionlike_internal(&input.to_string(), &mut output, RenamingMode::Append);
    output.into()
}

#[proc_macro]
pub fn test_doubles_prefixed(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
    let mut output = TokenStream::new();
    functionlike_internal(&input.to_string(), &mut output, RenamingMode::Prefix);
    output.into()
}

fn functionlike_internal(input: &str, output: &mut TokenStream, renaming_mode: RenamingMode) {
    // Generate the AST from the token stream we were given
    let file: syn::File = syn::parse_str(input).expect("Failed to parse input");

    for item in file.items {
        process_single_item(item, None, output, renaming_mode);
    }
}

fn process_single_item(item: syn::Item, alternate_ident: Option<syn::Ident>, output: &mut TokenStream, renaming_mode: RenamingMode) {
    match item {
        syn::Item::Use(mut use_original) => {
            // Make a copy of the original use statement
            let mut use_double = use_original.clone();

            modify_use_for_original(&mut use_original);
            modify_use_for_double(&mut use_double, alternate_ident, renaming_mode);

            // Add the result to the back of our list of output tokens
            output.extend::<TokenStream>(quote!{
                #use_original
                #use_double
            }.into());
        }
        _ => panic!("Only use statements can be in the test_double! macro"),
    }
}

fn modify_use_for_original(use_original: &mut syn::ItemUse) {
    // Add `#[cfg(not(test))]` to our original use statement
    let not_test = quote! { (not(test)) };
    let cfg_not_test = syn::Attribute {
        pound_token: Default::default(),
        style: syn::AttrStyle::Outer,
        bracket_token: Default::default(),
        path: create_cfg_path(),
        tokens: not_test.into(),
    };
    use_original.attrs.push(cfg_not_test);
}

fn modify_use_for_double(use_double: &mut syn::ItemUse, alternate_ident: Option<syn::Ident>, renaming_mode: RenamingMode) {
    // Add `#[cfg(test)]` to our test double use statement
    let test = quote! { (test) };
    let cfg_not_test = syn::Attribute {
        pound_token: Default::default(),
        style: syn::AttrStyle::Outer,
        bracket_token: Default::default(),
        path: create_cfg_path(),
        tokens: test.into(),
    };
    use_double.attrs.push(cfg_not_test);

    modify_tree_for_double(&mut use_double.tree, alternate_ident, renaming_mode);
}

// Change the name of the item used for the double use statement.
fn modify_tree_for_double(use_tree: &mut syn::UseTree, alternate_ident: Option<syn::Ident>, renaming_mode: RenamingMode) {
    match use_tree {
        syn::UseTree::Path(use_path) => {
            modify_tree_for_double(&mut use_path.tree, alternate_ident, renaming_mode)
        },
        syn::UseTree::Group(use_group) => {
            if alternate_ident.is_some() {
                panic!("test_double macros do not support using alternate substituted types with grouped imports")
            }

            for tree in use_group.items.iter_mut() {
                modify_tree_for_double(tree, None, renaming_mode)
            }
        },
        syn::UseTree::Name(use_name) => {
            // Change the imported name and add an "as" also
            // `use blah::Bar` => `use blah::BarMock as Bar`
            let original_ident = use_name.ident.clone();
            let default_ident = create_default_ident_for_double(&original_ident, renaming_mode);
            let modified_ident = alternate_ident.unwrap_or(default_ident);

            let rename = syn::UseRename {
                ident: modified_ident,
                as_token: syn::token::As(Span::call_site()),
                rename: original_ident
            };
            *use_tree = syn::UseTree::Rename(rename);
        },
        syn::UseTree::Rename(use_rename) => {
            // Change the imported name
            // `use blah::Blah as Foo` => `use blah::BlahMock as Foo`
            let default_ident = create_default_ident_for_double(&use_rename.ident, renaming_mode);
            use_rename.ident = alternate_ident.unwrap_or(default_ident);
        },
        syn::UseTree::Glob(_) => {
            panic!("test_double macros do not support * imports")
        },
    }
}

fn create_default_ident_for_double(original_ident: &syn::Ident, renaming_mode: RenamingMode) -> syn::Ident {
    let name = quote! { #original_ident };

    match renaming_mode {
        RenamingMode::Append => syn::Ident::new(&format!("{}Mock", name), Span::call_site()),
        RenamingMode::Prefix => syn::Ident::new(&format!("Mock{}", name), Span::call_site()),
    }
}

fn create_cfg_path() -> syn::Path {
    syn::Ident::new("cfg", Span::call_site()).into()
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_functionlike_basic() {
        let input = quote! {
            use quote::Tokens;
            use syn::Item;
        };

        let expected = quote! {
            #[cfg(not(test))]
            use quote::Tokens;
            #[cfg(test)]
            use quote::TokensMock as Tokens;

            #[cfg(not(test))]
            use syn::Item;
            #[cfg(test)]
            use syn::ItemMock as Item;
        };

        let mut output = TokenStream::new();
        functionlike_internal(&input.to_string(), &mut output, RenamingMode::Append);

        assert_eq!(expected.to_string(), output.to_string());
    }

    #[test]
    fn test_functionlike_basic_prefixed() {
        let input = quote! {
            use quote::Tokens;
            use syn::Item;
        };

        let expected = quote! {
            #[cfg(not(test))]
            use quote::Tokens;
            #[cfg(test)]
            use quote::MockTokens as Tokens;

            #[cfg(not(test))]
            use syn::Item;
            #[cfg(test)]
            use syn::MockItem as Item;
        };

        let mut output = TokenStream::new();
        functionlike_internal(&input.to_string(), &mut output, RenamingMode::Prefix);

        assert_eq!(expected.to_string(), output.to_string());
    }

    #[test]
    fn test_functionlike_group() {
        let input = quote! {
            use quote::{Tokens, TokenStream};
        };

        let expected = quote! {
            #[cfg(not(test))]
            use quote::{Tokens, TokenStream};
            #[cfg(test)]
            use quote::{TokensMock as Tokens, TokenStreamMock as TokenStream};
        };

        let mut output = TokenStream::new();
        functionlike_internal(&input.to_string(), &mut output, RenamingMode::Append);

        assert_eq!(expected.to_string(), output.to_string());
    }

    #[test]
    fn test_functionlike_group_prefixed() {
        let input = quote! {
            use quote::{Tokens, TokenStream};
        };

        let expected = quote! {
            #[cfg(not(test))]
            use quote::{Tokens, TokenStream};
            #[cfg(test)]
            use quote::{MockTokens as Tokens, MockTokenStream as TokenStream};
        };
       
        let mut output = TokenStream::new();
        functionlike_internal(&input.to_string(), &mut output, RenamingMode::Prefix);

        assert_eq!(expected.to_string(), output.to_string());
    }

    #[test]
    fn test_attribute_rename() {
        let input = quote! {
            use quote::Tokens as SomethingElse;
        };

        let expected = quote! {
            #[cfg(not(test))]
            use quote::Tokens as SomethingElse;
            #[cfg(test)]
            use quote::TokensMock as SomethingElse;
        };

        let mut output = TokenStream::new();
        attribute_internal(TokenStream::new(), &input.to_string(), &mut output, RenamingMode::Append);

        assert_eq!(expected.to_string(), output.to_string());
    }

    #[test]
    fn test_attribute_rename_prefixed() {
        let input = quote! {
            use quote::Tokens as SomethingElse;
        };

        let expected = quote! {
            #[cfg(not(test))]
            use quote::Tokens as SomethingElse;
            #[cfg(test)]
            use quote::MockTokens as SomethingElse;
        };

        let mut output = TokenStream::new();
        attribute_internal(TokenStream::new(), &input.to_string(), &mut output, RenamingMode::Prefix);

        assert_eq!(expected.to_string(), output.to_string());
    }

    #[test]
    fn test_attribute_group() {
        let input = quote! {
            use quote::{Tokens, TokenStream};
        };

        let expected = quote! {
            #[cfg(not(test))]
            use quote::{Tokens, TokenStream};
            #[cfg(test)]
            use quote::{TokensMock as Tokens, TokenStreamMock as TokenStream};
        };

        let mut output = TokenStream::new();
        attribute_internal(TokenStream::new(), &input.to_string(), &mut output, RenamingMode::Append);

        assert_eq!(expected.to_string(), output.to_string());
    }

    #[test]
    fn test_attribute_group_prefixed() {
        let input = quote! {
            use quote::{Tokens, TokenStream};
        };

        let expected = quote! {
            #[cfg(not(test))]
            use quote::{Tokens, TokenStream};
            #[cfg(test)]
            use quote::{MockTokens as Tokens, MockTokenStream as TokenStream};
        };

        let mut output = TokenStream::new();
        attribute_internal(TokenStream::new(), &input.to_string(), &mut output, RenamingMode::Prefix);

        assert_eq!(expected.to_string(), output.to_string());
    }

    #[test]
    fn test_attribute_nested() {
        let input = quote! {
            use std::{fs::File, io::Read, path::{Path, PathBuf}};
        };

        let expected = quote! {
            #[cfg(not(test))]
            use std::{fs::File, io::Read, path::{Path, PathBuf}};
            #[cfg(test)]
            use std::{fs::FileMock as File, io::ReadMock as Read, path::{PathMock as Path, PathBufMock as PathBuf}};
        };

        let mut output = TokenStream::new();
        attribute_internal(TokenStream::new(), &input.to_string(), &mut output, RenamingMode::Append);

        assert_eq!(expected.to_string(), output.to_string());
    }

    #[test]
    fn test_attribute_nested_prefixed() {
        let input = quote! {
            use std::{fs::File, io::Read, path::{Path, PathBuf}};
        };

        let expected = quote! {
            #[cfg(not(test))]
            use std::{fs::File, io::Read, path::{Path, PathBuf}};
            #[cfg(test)]
            use std::{fs::MockFile as File, io::MockRead as Read, path::{MockPath as Path, MockPathBuf as PathBuf}};
        };

        let mut output = TokenStream::new();
        attribute_internal(TokenStream::new(), &input.to_string(), &mut output, RenamingMode::Prefix);

        assert_eq!(expected.to_string(), output.to_string());
    }

    #[test]
    fn test_attribute_alternate_name() {
        let meta = quote!{TokensAlternate};

        let input = quote! {
            use quote::Tokens;
        };

        let expected = quote! {
            #[cfg(not(test))]
            use quote::Tokens;
            #[cfg(test)]
            use quote::TokensAlternate as Tokens;
        };

        let mut output = TokenStream::new();
        attribute_internal(meta, &input.to_string(), &mut output, RenamingMode::Append);

        assert_eq!(expected.to_string(), output.to_string());
    }

    #[test]
    fn test_attribute_alternate_name_prefixed() {
        let meta = quote!{TokensAlternate};

        let input = quote! {
            use quote::Tokens;
        };

        let expected = quote! {
            #[cfg(not(test))]
            use quote::Tokens;
            #[cfg(test)]
            use quote::TokensAlternate as Tokens;
        };

        let mut output = TokenStream::new();
        attribute_internal(meta, &input.to_string(), &mut output, RenamingMode::Prefix);

        assert_eq!(expected.to_string(), output.to_string());
    }

    #[test]
    #[should_panic]
    fn test_attribute_group_alternate_name() {
        let meta = quote!{TokensAlternate};

        let input = quote! {
            use quote::{Tokens, TokenStream};
        };

        let mut output = TokenStream::new();
        attribute_internal(meta, &input.to_string(), &mut output, RenamingMode::Append);
        // Panic: alternate names can't be used with import groups
    }
}