apivolve_generator_api 0.1.1

Api for creating generators for Apivolve, an API evolution tool that helps keep your APIs backwards compatible yet clean.
Documentation 
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

#![allow(unused)] // linter gets very confused by macros and flags most code as unused, so supporess.

use ::async_trait::async_trait;
use ::semver::Version;
use ::tempdir::TempDir;

use crate::gen1::connect::layout::GenFeatures;
use crate::gen1::GenResult;
use crate::gen1::{
    AcceptsConfig, AcceptsCustomizations, Evolution, GenerateInputFormat, GenerationPreferences,
    Generator,
};

use super::generate::make_gen_test;
use super::generate_core_features;
use super::generate_no_versions;
use super::generate_with_pending;
use super::*;

fn noop_generator() {}

fn accept_all(_output_dir: TempDir) -> GenResult {
    Ok(())
}

#[macro_export]
macro_rules! testsuite_basic {
    ($accepts_config_expr: expr, $make_generator_expr: expr, $verify_func_ident: ident) => {
        make_gen_test!(
            test_no_versions,
            generate_no_versions,
            $accepts_config_expr,
            $make_generator_expr,
            $verify_func_ident
        );
        make_gen_test!(
            test_core_features,
            generate_core_features,
            $accepts_config_expr,
            $make_generator_expr,
            $verify_func_ident
        );
        make_gen_test!(
            test_with_pending,
            generate_with_pending,
            $accepts_config_expr,
            $make_generator_expr,
            $verify_func_ident
        );
        //TODO @mark: more tests
    };
    ($accepts_config_expr: expr, $make_generator_expr: expr) => {
        testsuite_full!(
            $accepts_config_expr: expr,
            $make_generator_expr: expr,
            accept_all
        );
    };
}

#[macro_export]
macro_rules! testsuite_full {
    ($accepts_config_expr: expr, $make_generator_expr: expr, $verify_func_ident: ident) => {
        testsuite_basic!(
            $accepts_config_expr,
            $make_generator_expr,
            $verify_func_ident
        );
        //TODO @mark: more tests
    };
    ($accepts_config_expr: expr, $make_generator_expr: expr) => {
        testsuite_basic!($accepts_config_expr, $make_generator_expr, accept_all);
    };
}

pub use testsuite_basic;
pub use testsuite_full;

struct NoopGenerator();

#[async_trait]
impl Generator for NoopGenerator {
    async fn generate_pending(&mut self, _evolution: Evolution) -> GenResult {
        Ok(())
    }

    async fn generate_version(&mut self, _version: Version, _evolution: Evolution) -> GenResult {
        Ok(())
    }

    async fn finalize(self) -> Result<(), ErrMsg> {
        Ok(())
    }
}

fn noop_generator_factory(_: GenerationPreferences) -> Result<NoopGenerator, String> {
    Ok(NoopGenerator())
}

testsuite_full!(
    AcceptsCustomizations {
        features: GenFeatures::default(),
    },
    noop_generator_factory
);