test/integration/api/README.md

   1 # InSpec Profile: `api`
   2
   3 This shows the implementation of the `api` InSpec [profile](https://github.com/inspec/inspec/blob/master/docs/profiles.md).
   4
   5 ## Verify a profile
   6
   7 InSpec ships with built-in features to verify a profile structure.
   8
   9 ```bash
  10 $ inspec check api
  11 Summary
  12 -------
  13 Location: api
  14 Profile: profile
  15 Controls: 4
  16 Timestamp: 2019-06-24T23:09:01+00:00
  17 Valid: true
  18
  19 Errors
  20 ------
  21
  22 Warnings
  23 --------
  24 ```
  25
  26 ## Execute a profile
  27
  28 To run all **supported** controls on a local machine use `inspec exec /path/to/profile`.
  29
  30 ```bash
  31 $ inspec exec api
  32 ..
  33
  34 Finished in 0.0025 seconds (files took 0.12449 seconds to load)
  35 8 examples, 0 failures
  36 ```
  37
  38 ## Execute a specific control from a profile
  39
  40 To run one control from the profile use `inspec exec /path/to/profile --controls name`.
  41
  42 ```bash
  43 $ inspec exec api --controls package
  44 .
  45
  46 Finished in 0.0025 seconds (files took 0.12449 seconds to load)
  47 1 examples, 0 failures
  48 ```
  49
  50 See an [example control here](https://github.com/inspec/inspec/blob/master/examples/profile/controls/example.rb).