github.com/go-chef/chef@v0.30.1/testapi/ExampleGoals.md (about)

     1  # Chef API testing
     2  
     3  For each class of chef api object class (organizations, users, cookbooks, etc and each rest end point)
     4  * Documentation updated
     5  * Exercise the defined functions - mostly crud
     6  * Define input structs for the calls to the api
     7  * Create an example of the code to call each function
     8  * Define the expected output in a struct
     9  * Verify the output structs are populated as expected
    10  
    11  |Name| New | Doc update | Function tests | input structs | out struct |
    12  |----|-----|------------|----------------|---------------|------------|
    13  |GLOBAL LEVEL|
    14  |authenticate_user |x|x||||
    15  |license |x|x||||
    16  |organizations|x|x||||
    17  |status |x|x||||
    18  |users|x|x||||
    19  |ORGANIZATION LEVEL|||||||
    20  |association_request |x|x||||
    21  |clients|x|x||||
    22  |containers ||||||
    23  |cookbook|x|||||
    24  |cookbook_download||||||
    25  |databag|x|||||
    26  |environments|x|||||
    27  |groups|x|x||||
    28  |nodes|x|||||
    29  |policyx|x|||||
    30  |policy_group |x|||||
    31  |principal|U|x|x|x|x|
    32  |roles|x|x||||
    33  |run_list||||||
    34  |sandboxes||x||||
    35  |search|x|||||
    36  |universe |x|x||||
    37  |updated_since |x|||||
    38  |users(in associations)|x|||||
    39  |organization/users||||||
    40  |acl||||||