proxmox-mirrors/proxmox
1
0
Fork 1
mirror of https://git.proxmox.com/git/proxmox synced 2025-05-01 00:51:26 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
488 Commits 3 Branches 0 Tags 17 MiB
076501e17e
Commit Graph

66 Commits

Author SHA1 Message Date
Dietmar Maurer
076501e17e proxmox-api-macro/tests/api1.rs: fix test case 2020-04-16 08:42:05 +02:00
Wolfgang Bumiller
973e7ccef0 rename some permission/access items 
router.permissions(...) -> router.access(...)
    to be more consistent with the other builder methods and
    struct member names

ApiAccessPermissions -> ApiAccess
    shorter, not necessarily with defined permissions, and
    gets rid of a singular/plural confusion

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2020-04-15 09:19:25 +02:00
Wolfgang Bumiller
510d410b7a api-macro: support 'access' specification for methods 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2020-04-14 14:28:12 +02:00
Wolfgang Bumiller
f5d15872f4 api-macro: add api_get_default!() macro 
When writing an #[api] function, one can now access default
values by parameter name (see test_default_option in
tests/options.rs):

    #[api(...)]
    pub fn func(value: Option<isize>) {
        println!(
            "value: {}",
            value.unwrap_or(api_get_default!("value")),
        );
    }

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2020-03-19 15:49:34 +01:00
Wolfgang Bumiller
8beec0d6e6 api-macro: tests for optional non-Option parameters 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2020-03-19 12:08:38 +01:00
Wolfgang Bumiller
2edd8da965 api-macro: add integer limit test cases 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2020-03-06 12:02:32 +01:00
Wolfgang Bumiller
723500dbfc api-macro: include default minimum/maximum for integer types 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2020-03-06 11:59:08 +01:00
Wolfgang Bumiller
edebbf920a fix property sorting 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2020-01-23 13:15:59 +01:00
Wolfgang Bumiller
f22b693800 macro: silence some warnings in tests 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2020-01-15 14:10:58 +01:00
Wolfgang Bumiller
0f630a4cb8 api-macro: more documentation 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2020-01-08 11:23:48 +01:00
Wolfgang Bumiller
5b652dbad8 api-macro: schema tests for async fns 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2020-01-08 11:01:55 +01:00
Wolfgang Bumiller
943bc4de52 api-macro: more tests 
Note that this one tests the fact that we do not do output
schema validation!

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2020-01-08 10:58:27 +01:00
Wolfgang Bumiller
58158b495e api-macro: more invocation tests for api methods 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2020-01-08 10:56:45 +01:00
Wolfgang Bumiller
679ad01c03 api-macro: add expanded data to tests for verification 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2020-01-08 10:51:00 +01:00
Wolfgang Bumiller
08e1cf3c2f api-macro: support empty api macro on structs 
The description comes from the doc comment, the field types
and description from field doc comments and types.
Previously we needed to add at least the hint that the
schema is an object schema. Now we support an empty #[api]
attribute as well.

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2020-01-08 10:09:42 +01:00
Wolfgang Bumiller
2e63bf8422 api-macro: support rename_all in enums 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2020-01-07 15:29:56 +01:00
Wolfgang Bumiller
3626f57d2c api-macro: more option type handling 
infer_type now also returns whether it was encapsualted in
an Option<>. So `type: String, optional: true` is now
inferred propertly from `Option<String>`.

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2020-01-07 13:37:34 +01:00
Wolfgang Bumiller
860a4fd0ad api-macro: add basic struct handling 
- handle doc comments for descriptions
- infer fields from structs when possible
- perform some basic error checking

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2020-01-07 13:09:20 +01:00
Wolfgang Bumiller
4c77a7fece api-macro: derive descriptions for structs 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2020-01-07 12:00:17 +01:00
Wolfgang Bumiller
3e5927a1b4 api-macro: generalized '{ schema: PATH }' schemas 
allow 'schema: PATH' outside object property context

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-12-16 12:11:52 +01:00
Wolfgang Bumiller
808035f524 api-macro: support 'async fn' with new async api method 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-12-16 11:13:26 +01:00
Wolfgang Bumiller
b81beb4dfb api-macro: allow methods without return types 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-12-04 14:27:57 +01:00
Wolfgang Bumiller
c282c8ce23 api-macro: don't return Null without return schema 
serde_json turns () into Null anyway, so there's no need to
check this!

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-12-04 14:25:12 +01:00
Wolfgang Bumiller
f9d775924d api-macro: get enum description from doc comments 
instead of:
    #[api(description: "Some description.")]
    pub enum { ... }

support:
    #[api]
    /// Some description.
    pub enum { ... }

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-12-04 11:52:03 +01:00
Wolfgang Bumiller
4de409c526 api-macro: support hyphenated parameter names 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-12-03 13:34:37 +01:00
Wolfgang Bumiller
d3ec63f26d api-macro: allow referencing external schemas in properties 
Reference a predefined BACKUP_ARCHIVE_NAME StringSchema like
this:
    #[api(
        input: {
            properties: {
                archive: {
                    optional: true,
                    schema: BACKUP_ARCHIVE_NAME,
                },
            }
        }
    )]
    fn get_archive(archive: String) -> Result<(), Error> {
        ...
    }

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-12-03 11:11:46 +01:00
Wolfgang Bumiller
d78659a2c0 api-macro: allow inferring some types automatically 
non-optional boolean, string and integer types can be
inferred from the function

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-12-02 11:46:15 +01:00
Wolfgang Bumiller
7fd69f8b12 api-macro: test optional value invocation 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-12-02 11:12:36 +01:00
Wolfgang Bumiller
263b943287 api-macro: allow skipping input schema 
when there are no parameters

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-12-02 11:00:04 +01:00
Wolfgang Bumiller
bead1e6b13 api-macro: add test with no parameters 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-12-02 10:55:28 +01:00
Wolfgang Bumiller
a997502ab1 api-macro: make return schema optional 
and support returning () from methods

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-12-02 10:43:10 +01:00
Wolfgang Bumiller
6afad53466 api-macro: some more test code 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-11-28 13:49:14 +01:00
Wolfgang Bumiller
22581b382c api-macro: fixup 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-11-28 13:47:42 +01:00
Wolfgang Bumiller
5690e5e6a2 api-macro: cleanup 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-11-28 13:43:25 +01:00
Wolfgang Bumiller
7d6fac0fa5 api-macro: parse serde(rename) on enums 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-11-28 13:42:46 +01:00
Wolfgang Bumiller
30a1c0b9ae api-macro: experimental enum support 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-11-28 12:21:46 +01:00
Wolfgang Bumiller
6818cf76c9 api-macro: support defining schemas for structs 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-11-28 11:15:37 +01:00
Wolfgang Bumiller
4f042f8133 api-macro: support external types 
See the test example:

assuming a `pub struct Foo` which implements `Serialize` and
`Deserialize`, we also expect it to provide a
`pub const Foo::API_SCHEMA: &Schema` like so:

    #[derive(Deserialize, Serialize)]
    pub struct StrongString(String);
    impl StrongString {
        pub const API_SCHEMA: &'static Schema =
            &StringSchema::new("Some generic string")
                .format(&ApiStringFormat::Enum(&["a", "b"]))
                .schema();
    }

Then we can use:

    #[api(
        input: {
            properties: {
                arg: { type: StrongString },
            }
        },
        ...
    )]
    fn my_api_func(arg: StrongString) -> Result<...> {
        ...
    }

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-11-28 10:42:35 +01:00
Wolfgang Bumiller
2fc2df9a78 api-macro: tests: remove #![allow(dead_code)] 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-11-28 09:29:45 +01:00
Wolfgang Bumiller
993eb7d168 api-macro: update tests, cleanup some macro generated paths 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-11-27 14:46:20 +01:00
Wolfgang Bumiller
881df81976 api-macro: start actually extracting parameters 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-11-27 14:00:41 +01:00
Wolfgang Bumiller
d02a8f4e42 api-macro: begin and explain the parameter mapping strategy 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-11-27 12:29:50 +01:00
Wolfgang Bumiller
ebda5a3c5c api-macro: parse properties as attributes to #[api] 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-11-27 11:01:40 +01:00
Wolfgang Bumiller
044af76286 api-macro: test: add 'protected' attribute 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-11-27 10:06:15 +01:00
Wolfgang Bumiller
366b50dee7 api-macro: understand a 'Returns:' section in function doc comments 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-11-26 13:39:20 +01:00
Wolfgang Bumiller
7f7a9fe92f api-macro: make type optional in some cases 
Objects and arrays are now optionally identified by their
'properties' or 'items' property if their 'type' is left
out.

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-11-26 13:27:54 +01:00
Wolfgang Bumiller
5a2fe67cd8 api-macro: rename elements to properties 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-11-26 12:16:05 +01:00
Wolfgang Bumiller
a646146f75 replace builder-pattern api macro parser with json 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-11-26 12:12:49 +01:00
Wolfgang Bumiller
5721d21a5e import a first draft of api macros 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-11-22 15:23:24 +01:00
Wolfgang Bumiller
068d56ed3d delete the old api macro stuff 
to be replaced by a new set of macros for the current api
schema in proxmox-backup

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2019-11-21 13:13:18 +01:00