README
¶
Examples for using the api
Coded samples
The cmd directory has examples of using the client code to exercise the chef api end points. The bin directory has commands for invoking the code. The inspec directory has inspec tests to verify the output from invoking the code. The chefapi_examples cookbook creates a chef server instance. Test kitchen can run the sample code and verify the resulting output using inspec tests.
Cookbook and kitchen testing
Run kitchen converge to create a chef server instance in a linux image running under vagrant. Run kitchen verify to run the go examples using the client api and to confirm that the results are as expected.
Looking at the output from an api call
Sometimes you might want to see what output gets created by an api call. Inspec tends to hide and mask the output. You can use kitchen login to access the linux image. Use "cd /go/src/testapi/bin" to access the bin directory and run any of the commands to run the api sample use code and see the results. Running the bin commands by adding the -tags debug option will show more detail.
Creating a client
On the test image /go/src/github.com/go-chef/chef/testapi/testapi.go has code that creates a client for use by other api calls. For the purposes of testing it uses the pivotal user and key for all the tests.
Documentation
¶
Overview ¶
Test the go-chef/chef chef server api ACL endpoints against a live server
Test the go-chef/chef chef server api /organization/:org/user and /organization/:org/association_requests endpoints against a live server
Test the go-chef/chef chef server api /organization/:org/user and /organization/:org/association_requests endpoints against a live server
Test the go-chef/chef chef server api /organization/:org/user and /organization/:org/association_requests endpoints against a live server
Test the go-chef/chef chef authenticate_user api endpoint against a live server
Test the go-chef/chef chef server api /clients/CLIENTNAME/keys endpoints against a live chef server
Test the go-chef/chef chef server api /organizations/*/cookbooks endpoints against a live chef server
Test the go-chef/chef chef server api /databag endpoints against a live server
TODO: add users and then add them to groups. Seems to fail. pivotal is maybe not a good test. adding fails silently
Test the go-chef/chef chef server api /license endpoints against a live server
Test the go-chef/chef chef server api /organizations endpoints against a live server
Test the go-chef/chef chef server api /policies endpoints against a live server
Test the go-chef/chef chef server api /policy_groups endpoints against a live server
Test the go-chef/chef chef server api /required_recipe endpoint against a live server
Test the go-chef/chef chef server api /role endpoints against a live server
Test the go-chef/chef chef server api /stats endpoint against a live server
Test the go-chef/chef chef server api /_status endpoints against a live server
Test the go-chef/chef chef server api /organizations endpoints against a live server
Test the go-chef/chef chef server api /universe endpoints against a live server
Test the go-chef/chef chef server api /users endpoints against a live chef server
Test the go-chef/chef chef server api /users/USERNAME/keys endpoints against a live chef server
Index ¶
- func ACL()
- func ApiClient()
- func Association()
- func AssociationCleanup()
- func AssociationSetup()
- func Authenticate()
- func Client() *chef.Client
- func Clientkey()
- func Container()
- func Cookbook()
- func Databag()
- func Environment()
- func Group()
- func License()
- func Node()
- func Organization()
- func Policy()
- func PolicyGroup()
- func Principals()
- func PrincipalsAdd()
- func PrincipalsDel()
- func RequiredRecipe()
- func Role()
- func Sandbox()
- func Search()
- func SearchPagination()
- func Stats()
- func Status()
- func Universe()
- func User()
- func Userkey()
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AssociationCleanup ¶
func AssociationCleanup()
association_cleanup exercise the chef server api
func RequiredRecipe ¶ added in v0.17.1
func RequiredRecipe()
required_recipe exercise the chef server api
Types ¶
This section is empty.
Source Files
¶
- acl.go
- association.go
- association_cleanup.go
- association_setup.go
- authenticate.go
- client.go
- clientkey.go
- container.go
- cookbook.go
- databag.go
- environment.go
- group.go
- license.go
- node.go
- organization.go
- policy.go
- policygroup.go
- principal.go
- principal_users_add.go
- principal_users_del.go
- required_recipe.go
- role.go
- sandbox.go
- search.go
- search_pagination.go
- stats.go
- status.go
- testapi.go
- universe.go
- user.go
- userkey.go