inspec 2.0.16 → 2.0.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (480) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +101 -101
  3. data/CHANGELOG.md +2949 -2944
  4. data/Gemfile +55 -55
  5. data/LICENSE +14 -14
  6. data/MAINTAINERS.md +31 -31
  7. data/MAINTAINERS.toml +47 -47
  8. data/README.md +438 -438
  9. data/Rakefile +284 -284
  10. data/bin/inspec +12 -12
  11. data/docs/.gitignore +2 -2
  12. data/docs/README.md +40 -40
  13. data/docs/dsl_inspec.md +258 -258
  14. data/docs/dsl_resource.md +93 -93
  15. data/docs/glossary.md +99 -99
  16. data/docs/habitat.md +191 -191
  17. data/docs/inspec_and_friends.md +107 -107
  18. data/docs/matchers.md +165 -165
  19. data/docs/migration.md +293 -293
  20. data/docs/platforms.md +118 -118
  21. data/docs/plugin_kitchen_inspec.md +49 -49
  22. data/docs/profiles.md +370 -370
  23. data/docs/reporters.md +105 -105
  24. data/docs/resources/aide_conf.md.erb +75 -75
  25. data/docs/resources/apache.md.erb +67 -67
  26. data/docs/resources/apache_conf.md.erb +68 -68
  27. data/docs/resources/apt.md.erb +71 -71
  28. data/docs/resources/audit_policy.md.erb +47 -47
  29. data/docs/resources/auditd.md.erb +79 -79
  30. data/docs/resources/auditd_conf.md.erb +68 -68
  31. data/docs/resources/aws_cloudtrail_trail.md.erb +140 -140
  32. data/docs/resources/aws_cloudtrail_trails.md.erb +81 -81
  33. data/docs/resources/aws_cloudwatch_alarm.md.erb +86 -86
  34. data/docs/resources/aws_cloudwatch_log_metric_filter.md.erb +151 -151
  35. data/docs/resources/aws_ec2_instance.md.erb +106 -106
  36. data/docs/resources/aws_iam_access_key.md.erb +123 -123
  37. data/docs/resources/aws_iam_access_keys.md.erb +198 -198
  38. data/docs/resources/aws_iam_group.md.erb +46 -46
  39. data/docs/resources/aws_iam_groups.md.erb +43 -43
  40. data/docs/resources/aws_iam_password_policy.md.erb +76 -76
  41. data/docs/resources/aws_iam_policies.md.erb +82 -82
  42. data/docs/resources/aws_iam_policy.md.erb +146 -146
  43. data/docs/resources/aws_iam_role.md.erb +65 -65
  44. data/docs/resources/aws_iam_root_user.md.erb +58 -58
  45. data/docs/resources/aws_iam_user.md.erb +64 -64
  46. data/docs/resources/aws_iam_users.md.erb +89 -89
  47. data/docs/resources/aws_kms_keys.md.erb +84 -84
  48. data/docs/resources/aws_route_table.md.erb +47 -47
  49. data/docs/resources/aws_s3_bucket.md.erb +134 -134
  50. data/docs/resources/aws_security_group.md.erb +152 -152
  51. data/docs/resources/aws_security_groups.md.erb +92 -92
  52. data/docs/resources/aws_sns_topic.md.erb +62 -62
  53. data/docs/resources/aws_subnet.md.erb +133 -133
  54. data/docs/resources/aws_subnets.md.erb +126 -126
  55. data/docs/resources/aws_vpc.md.erb +120 -120
  56. data/docs/resources/aws_vpcs.md.erb +48 -48
  57. data/docs/resources/azure_generic_resource.md.erb +170 -139
  58. data/docs/resources/azure_resource_group.md.erb +284 -284
  59. data/docs/resources/azure_virtual_machine.md.erb +347 -314
  60. data/docs/resources/azure_virtual_machine_data_disk.md.erb +224 -182
  61. data/docs/resources/bash.md.erb +75 -75
  62. data/docs/resources/bond.md.erb +90 -90
  63. data/docs/resources/bridge.md.erb +57 -57
  64. data/docs/resources/bsd_service.md.erb +67 -67
  65. data/docs/resources/command.md.erb +138 -138
  66. data/docs/resources/cpan.md.erb +79 -79
  67. data/docs/resources/cran.md.erb +64 -64
  68. data/docs/resources/crontab.md.erb +88 -88
  69. data/docs/resources/csv.md.erb +54 -54
  70. data/docs/resources/dh_params.md.erb +217 -217
  71. data/docs/resources/directory.md.erb +30 -30
  72. data/docs/resources/docker.md.erb +164 -164
  73. data/docs/resources/docker_container.md.erb +104 -104
  74. data/docs/resources/docker_image.md.erb +94 -94
  75. data/docs/resources/docker_service.md.erb +114 -114
  76. data/docs/resources/elasticsearch.md.erb +242 -242
  77. data/docs/resources/etc_fstab.md.erb +125 -125
  78. data/docs/resources/etc_group.md.erb +75 -75
  79. data/docs/resources/etc_hosts.md.erb +78 -78
  80. data/docs/resources/etc_hosts_allow.md.erb +74 -74
  81. data/docs/resources/etc_hosts_deny.md.erb +74 -74
  82. data/docs/resources/file.md.erb +515 -515
  83. data/docs/resources/filesystem.md.erb +41 -41
  84. data/docs/resources/firewalld.md.erb +107 -107
  85. data/docs/resources/gem.md.erb +79 -79
  86. data/docs/resources/group.md.erb +61 -61
  87. data/docs/resources/grub_conf.md.erb +101 -101
  88. data/docs/resources/host.md.erb +78 -78
  89. data/docs/resources/http.md.erb +101 -101
  90. data/docs/resources/iis_app.md.erb +122 -122
  91. data/docs/resources/iis_site.md.erb +135 -135
  92. data/docs/resources/inetd_conf.md.erb +94 -94
  93. data/docs/resources/ini.md.erb +76 -76
  94. data/docs/resources/interface.md.erb +58 -58
  95. data/docs/resources/iptables.md.erb +64 -64
  96. data/docs/resources/json.md.erb +62 -62
  97. data/docs/resources/kernel_module.md.erb +107 -107
  98. data/docs/resources/kernel_parameter.md.erb +53 -53
  99. data/docs/resources/key_rsa.md.erb +85 -85
  100. data/docs/resources/launchd_service.md.erb +57 -57
  101. data/docs/resources/limits_conf.md.erb +75 -75
  102. data/docs/resources/login_def.md.erb +71 -71
  103. data/docs/resources/mount.md.erb +69 -69
  104. data/docs/resources/mssql_session.md.erb +60 -60
  105. data/docs/resources/mysql_conf.md.erb +99 -99
  106. data/docs/resources/mysql_session.md.erb +74 -74
  107. data/docs/resources/nginx.md.erb +79 -79
  108. data/docs/resources/nginx_conf.md.erb +128 -128
  109. data/docs/resources/npm.md.erb +60 -60
  110. data/docs/resources/ntp_conf.md.erb +60 -60
  111. data/docs/resources/oneget.md.erb +53 -53
  112. data/docs/resources/oracledb_session.md.erb +52 -52
  113. data/docs/resources/os.md.erb +141 -141
  114. data/docs/resources/os_env.md.erb +78 -78
  115. data/docs/resources/package.md.erb +120 -120
  116. data/docs/resources/packages.md.erb +67 -67
  117. data/docs/resources/parse_config.md.erb +103 -103
  118. data/docs/resources/parse_config_file.md.erb +138 -138
  119. data/docs/resources/passwd.md.erb +141 -141
  120. data/docs/resources/pip.md.erb +67 -67
  121. data/docs/resources/port.md.erb +137 -137
  122. data/docs/resources/postgres_conf.md.erb +79 -79
  123. data/docs/resources/postgres_hba_conf.md.erb +93 -93
  124. data/docs/resources/postgres_ident_conf.md.erb +76 -76
  125. data/docs/resources/postgres_session.md.erb +69 -69
  126. data/docs/resources/powershell.md.erb +102 -102
  127. data/docs/resources/processes.md.erb +109 -109
  128. data/docs/resources/rabbitmq_config.md.erb +41 -41
  129. data/docs/resources/registry_key.md.erb +158 -158
  130. data/docs/resources/runit_service.md.erb +57 -57
  131. data/docs/resources/security_policy.md.erb +47 -47
  132. data/docs/resources/service.md.erb +121 -121
  133. data/docs/resources/shadow.md.erb +144 -144
  134. data/docs/resources/ssh_config.md.erb +80 -80
  135. data/docs/resources/sshd_config.md.erb +83 -83
  136. data/docs/resources/ssl.md.erb +119 -119
  137. data/docs/resources/sys_info.md.erb +42 -42
  138. data/docs/resources/systemd_service.md.erb +57 -57
  139. data/docs/resources/sysv_service.md.erb +57 -57
  140. data/docs/resources/upstart_service.md.erb +57 -57
  141. data/docs/resources/user.md.erb +140 -140
  142. data/docs/resources/users.md.erb +127 -127
  143. data/docs/resources/vbscript.md.erb +55 -55
  144. data/docs/resources/virtualization.md.erb +57 -57
  145. data/docs/resources/windows_feature.md.erb +47 -47
  146. data/docs/resources/windows_hotfix.md.erb +53 -53
  147. data/docs/resources/windows_task.md.erb +95 -95
  148. data/docs/resources/wmi.md.erb +81 -81
  149. data/docs/resources/x509_certificate.md.erb +151 -151
  150. data/docs/resources/xinetd_conf.md.erb +156 -156
  151. data/docs/resources/xml.md.erb +85 -85
  152. data/docs/resources/yaml.md.erb +69 -69
  153. data/docs/resources/yum.md.erb +98 -98
  154. data/docs/resources/zfs_dataset.md.erb +53 -53
  155. data/docs/resources/zfs_pool.md.erb +47 -47
  156. data/docs/ruby_usage.md +203 -203
  157. data/docs/shared/matcher_be.md.erb +1 -1
  158. data/docs/shared/matcher_cmp.md.erb +43 -43
  159. data/docs/shared/matcher_eq.md.erb +3 -3
  160. data/docs/shared/matcher_include.md.erb +1 -1
  161. data/docs/shared/matcher_match.md.erb +1 -1
  162. data/docs/shell.md +172 -172
  163. data/examples/README.md +8 -8
  164. data/examples/inheritance/README.md +65 -65
  165. data/examples/inheritance/controls/example.rb +14 -14
  166. data/examples/inheritance/inspec.yml +15 -15
  167. data/examples/kitchen-ansible/.kitchen.yml +25 -25
  168. data/examples/kitchen-ansible/Gemfile +19 -19
  169. data/examples/kitchen-ansible/README.md +53 -53
  170. data/examples/kitchen-ansible/files/nginx.repo +6 -6
  171. data/examples/kitchen-ansible/tasks/main.yml +16 -16
  172. data/examples/kitchen-ansible/test/integration/default/default.yml +5 -5
  173. data/examples/kitchen-ansible/test/integration/default/web_spec.rb +28 -28
  174. data/examples/kitchen-chef/.kitchen.yml +20 -20
  175. data/examples/kitchen-chef/Berksfile +3 -3
  176. data/examples/kitchen-chef/Gemfile +19 -19
  177. data/examples/kitchen-chef/README.md +27 -27
  178. data/examples/kitchen-chef/metadata.rb +7 -7
  179. data/examples/kitchen-chef/recipes/default.rb +6 -6
  180. data/examples/kitchen-chef/recipes/nginx.rb +30 -30
  181. data/examples/kitchen-chef/test/integration/default/web_spec.rb +28 -28
  182. data/examples/kitchen-puppet/.kitchen.yml +22 -22
  183. data/examples/kitchen-puppet/Gemfile +20 -20
  184. data/examples/kitchen-puppet/Puppetfile +25 -25
  185. data/examples/kitchen-puppet/README.md +53 -53
  186. data/examples/kitchen-puppet/manifests/site.pp +33 -33
  187. data/examples/kitchen-puppet/metadata.json +11 -11
  188. data/examples/kitchen-puppet/test/integration/default/web_spec.rb +28 -28
  189. data/examples/meta-profile/README.md +37 -37
  190. data/examples/meta-profile/controls/example.rb +13 -13
  191. data/examples/meta-profile/inspec.yml +13 -13
  192. data/examples/profile-attribute.yml +2 -2
  193. data/examples/profile-attribute/README.md +14 -14
  194. data/examples/profile-attribute/controls/example.rb +11 -11
  195. data/examples/profile-attribute/inspec.yml +8 -8
  196. data/examples/profile-aws/controls/iam_password_policy_expiration.rb +8 -8
  197. data/examples/profile-aws/controls/iam_password_policy_max_age.rb +8 -8
  198. data/examples/profile-aws/controls/iam_root_user_mfa.rb +8 -8
  199. data/examples/profile-aws/controls/iam_users_access_key_age.rb +8 -8
  200. data/examples/profile-aws/controls/iam_users_console_users_mfa.rb +8 -8
  201. data/examples/profile-aws/inspec.yml +11 -11
  202. data/examples/profile-azure/controls/azure_resource_group_example.rb +24 -24
  203. data/examples/profile-azure/controls/azure_vm_example.rb +29 -29
  204. data/examples/profile-azure/inspec.yml +11 -11
  205. data/examples/profile-sensitive/README.md +29 -29
  206. data/examples/profile-sensitive/controls/sensitive-failures.rb +9 -9
  207. data/examples/profile-sensitive/controls/sensitive.rb +9 -9
  208. data/examples/profile-sensitive/inspec.yml +8 -8
  209. data/examples/profile/README.md +48 -48
  210. data/examples/profile/controls/example.rb +23 -23
  211. data/examples/profile/controls/gordon.rb +36 -36
  212. data/examples/profile/controls/meta.rb +34 -34
  213. data/examples/profile/inspec.yml +10 -10
  214. data/examples/profile/libraries/gordon_config.rb +53 -53
  215. data/inspec.gemspec +47 -47
  216. data/lib/bundles/README.md +3 -3
  217. data/lib/bundles/inspec-artifact.rb +7 -7
  218. data/lib/bundles/inspec-artifact/README.md +1 -1
  219. data/lib/bundles/inspec-artifact/cli.rb +277 -277
  220. data/lib/bundles/inspec-compliance.rb +16 -16
  221. data/lib/bundles/inspec-compliance/.kitchen.yml +20 -20
  222. data/lib/bundles/inspec-compliance/README.md +185 -185
  223. data/lib/bundles/inspec-compliance/api.rb +316 -316
  224. data/lib/bundles/inspec-compliance/api/login.rb +152 -152
  225. data/lib/bundles/inspec-compliance/bootstrap.sh +41 -41
  226. data/lib/bundles/inspec-compliance/cli.rb +254 -254
  227. data/lib/bundles/inspec-compliance/configuration.rb +103 -103
  228. data/lib/bundles/inspec-compliance/http.rb +86 -86
  229. data/lib/bundles/inspec-compliance/support.rb +36 -36
  230. data/lib/bundles/inspec-compliance/target.rb +98 -98
  231. data/lib/bundles/inspec-compliance/test/integration/default/cli.rb +93 -93
  232. data/lib/bundles/inspec-habitat.rb +12 -12
  233. data/lib/bundles/inspec-habitat/cli.rb +36 -36
  234. data/lib/bundles/inspec-habitat/log.rb +10 -10
  235. data/lib/bundles/inspec-habitat/profile.rb +390 -390
  236. data/lib/bundles/inspec-init.rb +8 -8
  237. data/lib/bundles/inspec-init/README.md +31 -31
  238. data/lib/bundles/inspec-init/cli.rb +97 -97
  239. data/lib/bundles/inspec-init/templates/profile/README.md +3 -3
  240. data/lib/bundles/inspec-init/templates/profile/controls/example.rb +19 -19
  241. data/lib/bundles/inspec-init/templates/profile/inspec.yml +8 -8
  242. data/lib/bundles/inspec-supermarket.rb +13 -13
  243. data/lib/bundles/inspec-supermarket/README.md +45 -45
  244. data/lib/bundles/inspec-supermarket/api.rb +84 -84
  245. data/lib/bundles/inspec-supermarket/cli.rb +73 -73
  246. data/lib/bundles/inspec-supermarket/target.rb +34 -34
  247. data/lib/fetchers/git.rb +163 -163
  248. data/lib/fetchers/local.rb +74 -74
  249. data/lib/fetchers/mock.rb +35 -35
  250. data/lib/fetchers/url.rb +204 -204
  251. data/lib/inspec.rb +24 -24
  252. data/lib/inspec/archive/tar.rb +29 -29
  253. data/lib/inspec/archive/zip.rb +19 -19
  254. data/lib/inspec/backend.rb +92 -92
  255. data/lib/inspec/base_cli.rb +350 -333
  256. data/lib/inspec/cached_fetcher.rb +66 -66
  257. data/lib/inspec/cli.rb +292 -302
  258. data/lib/inspec/completions/bash.sh.erb +45 -45
  259. data/lib/inspec/completions/fish.sh.erb +34 -34
  260. data/lib/inspec/completions/zsh.sh.erb +61 -61
  261. data/lib/inspec/control_eval_context.rb +179 -179
  262. data/lib/inspec/dependencies/cache.rb +72 -72
  263. data/lib/inspec/dependencies/dependency_set.rb +92 -92
  264. data/lib/inspec/dependencies/lockfile.rb +115 -115
  265. data/lib/inspec/dependencies/requirement.rb +123 -123
  266. data/lib/inspec/dependencies/resolver.rb +86 -86
  267. data/lib/inspec/describe.rb +27 -27
  268. data/lib/inspec/dsl.rb +66 -66
  269. data/lib/inspec/dsl_shared.rb +33 -33
  270. data/lib/inspec/env_printer.rb +157 -157
  271. data/lib/inspec/errors.rb +13 -13
  272. data/lib/inspec/exceptions.rb +12 -12
  273. data/lib/inspec/expect.rb +45 -45
  274. data/lib/inspec/fetcher.rb +45 -45
  275. data/lib/inspec/file_provider.rb +275 -275
  276. data/lib/inspec/formatters.rb +3 -3
  277. data/lib/inspec/formatters/base.rb +250 -250
  278. data/lib/inspec/formatters/json_rspec.rb +20 -20
  279. data/lib/inspec/formatters/show_progress.rb +12 -12
  280. data/lib/inspec/library_eval_context.rb +58 -58
  281. data/lib/inspec/log.rb +11 -11
  282. data/lib/inspec/metadata.rb +247 -247
  283. data/lib/inspec/method_source.rb +24 -24
  284. data/lib/inspec/objects.rb +14 -14
  285. data/lib/inspec/objects/attribute.rb +65 -65
  286. data/lib/inspec/objects/control.rb +61 -61
  287. data/lib/inspec/objects/describe.rb +92 -92
  288. data/lib/inspec/objects/each_loop.rb +36 -36
  289. data/lib/inspec/objects/list.rb +15 -15
  290. data/lib/inspec/objects/or_test.rb +40 -40
  291. data/lib/inspec/objects/ruby_helper.rb +15 -15
  292. data/lib/inspec/objects/tag.rb +27 -27
  293. data/lib/inspec/objects/test.rb +87 -87
  294. data/lib/inspec/objects/value.rb +27 -27
  295. data/lib/inspec/plugins.rb +60 -60
  296. data/lib/inspec/plugins/cli.rb +24 -24
  297. data/lib/inspec/plugins/fetcher.rb +86 -86
  298. data/lib/inspec/plugins/resource.rb +133 -133
  299. data/lib/inspec/plugins/secret.rb +15 -15
  300. data/lib/inspec/plugins/source_reader.rb +40 -40
  301. data/lib/inspec/polyfill.rb +12 -12
  302. data/lib/inspec/profile.rb +510 -510
  303. data/lib/inspec/profile_context.rb +207 -207
  304. data/lib/inspec/profile_vendor.rb +66 -66
  305. data/lib/inspec/reporters.rb +50 -50
  306. data/lib/inspec/reporters/base.rb +24 -24
  307. data/lib/inspec/reporters/cli.rb +356 -356
  308. data/lib/inspec/reporters/json.rb +116 -116
  309. data/lib/inspec/reporters/json_min.rb +48 -48
  310. data/lib/inspec/reporters/junit.rb +77 -77
  311. data/lib/inspec/require_loader.rb +33 -33
  312. data/lib/inspec/resource.rb +186 -186
  313. data/lib/inspec/rule.rb +266 -266
  314. data/lib/inspec/runner.rb +344 -344
  315. data/lib/inspec/runner_mock.rb +41 -41
  316. data/lib/inspec/runner_rspec.rb +174 -174
  317. data/lib/inspec/runtime_profile.rb +26 -26
  318. data/lib/inspec/schema.rb +213 -213
  319. data/lib/inspec/secrets.rb +19 -19
  320. data/lib/inspec/secrets/yaml.rb +30 -30
  321. data/lib/inspec/shell.rb +220 -223
  322. data/lib/inspec/shell_detector.rb +90 -90
  323. data/lib/inspec/source_reader.rb +29 -29
  324. data/lib/inspec/version.rb +8 -8
  325. data/lib/matchers/matchers.rb +339 -339
  326. data/lib/resource_support/aws.rb +40 -40
  327. data/lib/resource_support/aws/aws_backend_base.rb +12 -12
  328. data/lib/resource_support/aws/aws_backend_factory_mixin.rb +12 -12
  329. data/lib/resource_support/aws/aws_plural_resource_mixin.rb +21 -21
  330. data/lib/resource_support/aws/aws_resource_mixin.rb +66 -66
  331. data/lib/resource_support/aws/aws_singular_resource_mixin.rb +24 -24
  332. data/lib/resources/aide_conf.rb +160 -160
  333. data/lib/resources/apache.rb +48 -48
  334. data/lib/resources/apache_conf.rb +156 -156
  335. data/lib/resources/apt.rb +149 -149
  336. data/lib/resources/audit_policy.rb +63 -63
  337. data/lib/resources/auditd.rb +231 -231
  338. data/lib/resources/auditd_conf.rb +55 -55
  339. data/lib/resources/aws/aws_cloudtrail_trail.rb +77 -77
  340. data/lib/resources/aws/aws_cloudtrail_trails.rb +47 -47
  341. data/lib/resources/aws/aws_cloudwatch_alarm.rb +62 -62
  342. data/lib/resources/aws/aws_cloudwatch_log_metric_filter.rb +100 -100
  343. data/lib/resources/aws/aws_ec2_instance.rb +157 -157
  344. data/lib/resources/aws/aws_iam_access_key.rb +106 -106
  345. data/lib/resources/aws/aws_iam_access_keys.rb +144 -144
  346. data/lib/resources/aws/aws_iam_group.rb +56 -56
  347. data/lib/resources/aws/aws_iam_groups.rb +45 -45
  348. data/lib/resources/aws/aws_iam_password_policy.rb +116 -116
  349. data/lib/resources/aws/aws_iam_policies.rb +46 -46
  350. data/lib/resources/aws/aws_iam_policy.rb +119 -119
  351. data/lib/resources/aws/aws_iam_role.rb +51 -51
  352. data/lib/resources/aws/aws_iam_root_user.rb +60 -60
  353. data/lib/resources/aws/aws_iam_user.rb +111 -111
  354. data/lib/resources/aws/aws_iam_users.rb +96 -96
  355. data/lib/resources/aws/aws_kms_keys.rb +46 -46
  356. data/lib/resources/aws/aws_route_table.rb +61 -61
  357. data/lib/resources/aws/aws_s3_bucket.rb +115 -115
  358. data/lib/resources/aws/aws_security_group.rb +93 -93
  359. data/lib/resources/aws/aws_security_groups.rb +68 -68
  360. data/lib/resources/aws/aws_sns_topic.rb +53 -53
  361. data/lib/resources/aws/aws_subnet.rb +88 -88
  362. data/lib/resources/aws/aws_subnets.rb +53 -53
  363. data/lib/resources/aws/aws_vpc.rb +69 -69
  364. data/lib/resources/aws/aws_vpcs.rb +45 -45
  365. data/lib/resources/azure/azure_backend.rb +377 -377
  366. data/lib/resources/azure/azure_generic_resource.rb +59 -59
  367. data/lib/resources/azure/azure_resource_group.rb +152 -152
  368. data/lib/resources/azure/azure_virtual_machine.rb +264 -264
  369. data/lib/resources/azure/azure_virtual_machine_data_disk.rb +136 -136
  370. data/lib/resources/bash.rb +35 -35
  371. data/lib/resources/bond.rb +68 -68
  372. data/lib/resources/bridge.rb +122 -122
  373. data/lib/resources/command.rb +69 -69
  374. data/lib/resources/cpan.rb +58 -58
  375. data/lib/resources/cran.rb +64 -64
  376. data/lib/resources/crontab.rb +170 -170
  377. data/lib/resources/csv.rb +60 -60
  378. data/lib/resources/dh_params.rb +82 -82
  379. data/lib/resources/directory.rb +25 -25
  380. data/lib/resources/docker.rb +236 -236
  381. data/lib/resources/docker_container.rb +89 -89
  382. data/lib/resources/docker_image.rb +83 -83
  383. data/lib/resources/docker_object.rb +57 -57
  384. data/lib/resources/docker_service.rb +90 -90
  385. data/lib/resources/elasticsearch.rb +169 -169
  386. data/lib/resources/etc_fstab.rb +102 -102
  387. data/lib/resources/etc_group.rb +156 -156
  388. data/lib/resources/etc_hosts.rb +81 -81
  389. data/lib/resources/etc_hosts_allow_deny.rb +123 -123
  390. data/lib/resources/file.rb +298 -298
  391. data/lib/resources/filesystem.rb +31 -31
  392. data/lib/resources/firewalld.rb +144 -144
  393. data/lib/resources/gem.rb +70 -70
  394. data/lib/resources/groups.rb +215 -215
  395. data/lib/resources/grub_conf.rb +237 -237
  396. data/lib/resources/host.rb +300 -300
  397. data/lib/resources/http.rb +250 -250
  398. data/lib/resources/iis_app.rb +104 -104
  399. data/lib/resources/iis_site.rb +148 -148
  400. data/lib/resources/inetd_conf.rb +62 -62
  401. data/lib/resources/ini.rb +29 -29
  402. data/lib/resources/interface.rb +129 -129
  403. data/lib/resources/iptables.rb +69 -69
  404. data/lib/resources/json.rb +117 -117
  405. data/lib/resources/kernel_module.rb +107 -107
  406. data/lib/resources/kernel_parameter.rb +58 -58
  407. data/lib/resources/key_rsa.rb +67 -67
  408. data/lib/resources/limits_conf.rb +55 -55
  409. data/lib/resources/login_def.rb +66 -66
  410. data/lib/resources/mount.rb +88 -88
  411. data/lib/resources/mssql_session.rb +101 -101
  412. data/lib/resources/mysql.rb +81 -81
  413. data/lib/resources/mysql_conf.rb +134 -134
  414. data/lib/resources/mysql_session.rb +71 -71
  415. data/lib/resources/nginx.rb +96 -96
  416. data/lib/resources/nginx_conf.rb +227 -227
  417. data/lib/resources/npm.rb +48 -48
  418. data/lib/resources/ntp_conf.rb +58 -58
  419. data/lib/resources/oneget.rb +71 -71
  420. data/lib/resources/oracledb_session.rb +139 -139
  421. data/lib/resources/os.rb +36 -36
  422. data/lib/resources/os_env.rb +76 -76
  423. data/lib/resources/package.rb +363 -363
  424. data/lib/resources/packages.rb +111 -111
  425. data/lib/resources/parse_config.rb +116 -116
  426. data/lib/resources/passwd.rb +74 -74
  427. data/lib/resources/pip.rb +89 -89
  428. data/lib/resources/platform.rb +109 -109
  429. data/lib/resources/port.rb +771 -771
  430. data/lib/resources/postgres.rb +130 -130
  431. data/lib/resources/postgres_conf.rb +121 -121
  432. data/lib/resources/postgres_hba_conf.rb +100 -100
  433. data/lib/resources/postgres_ident_conf.rb +78 -78
  434. data/lib/resources/postgres_session.rb +71 -71
  435. data/lib/resources/powershell.rb +57 -57
  436. data/lib/resources/processes.rb +204 -204
  437. data/lib/resources/rabbitmq_conf.rb +52 -52
  438. data/lib/resources/registry_key.rb +296 -296
  439. data/lib/resources/security_policy.rb +180 -180
  440. data/lib/resources/service.rb +789 -789
  441. data/lib/resources/shadow.rb +140 -140
  442. data/lib/resources/ssh_conf.rb +102 -102
  443. data/lib/resources/ssl.rb +99 -99
  444. data/lib/resources/sys_info.rb +28 -28
  445. data/lib/resources/toml.rb +32 -32
  446. data/lib/resources/users.rb +654 -654
  447. data/lib/resources/vbscript.rb +69 -69
  448. data/lib/resources/virtualization.rb +251 -251
  449. data/lib/resources/windows_feature.rb +84 -84
  450. data/lib/resources/windows_hotfix.rb +35 -35
  451. data/lib/resources/windows_task.rb +105 -105
  452. data/lib/resources/wmi.rb +113 -113
  453. data/lib/resources/x509_certificate.rb +143 -143
  454. data/lib/resources/xinetd.rb +111 -111
  455. data/lib/resources/xml.rb +46 -46
  456. data/lib/resources/yaml.rb +47 -47
  457. data/lib/resources/yum.rb +180 -180
  458. data/lib/resources/zfs_dataset.rb +60 -60
  459. data/lib/resources/zfs_pool.rb +49 -49
  460. data/lib/source_readers/flat.rb +39 -39
  461. data/lib/source_readers/inspec.rb +75 -75
  462. data/lib/utils/command_wrapper.rb +27 -27
  463. data/lib/utils/convert.rb +12 -12
  464. data/lib/utils/database_helpers.rb +77 -77
  465. data/lib/utils/erlang_parser.rb +192 -192
  466. data/lib/utils/filter.rb +272 -272
  467. data/lib/utils/filter_array.rb +27 -27
  468. data/lib/utils/find_files.rb +44 -44
  469. data/lib/utils/hash.rb +41 -41
  470. data/lib/utils/json_log.rb +18 -18
  471. data/lib/utils/latest_version.rb +22 -22
  472. data/lib/utils/modulator.rb +12 -12
  473. data/lib/utils/nginx_parser.rb +85 -85
  474. data/lib/utils/object_traversal.rb +49 -49
  475. data/lib/utils/parser.rb +274 -274
  476. data/lib/utils/plugin_registry.rb +93 -93
  477. data/lib/utils/simpleconfig.rb +120 -120
  478. data/lib/utils/spdx.rb +13 -13
  479. data/lib/utils/spdx.txt +343 -343
  480. metadata +1 -1
@@ -1,293 +1,293 @@
1
- ---
2
- title: InSpec Migration Guide
3
- ---
4
-
5
- # Migrate from Serverspec to InSpec
6
-
7
- ## How is InSpec different from Serverspec
8
-
9
- We've written a complete blog post about that topic: [The Road to InSpec](https://blog.chef.io/2015/11/04/the-road-to-inspec/)
10
-
11
- ## Is InSpec suitable for infrastructure testing?
12
-
13
- InSpec is a framework that allows you to run infrastructure testing as well as compliance testing. The compliance features are always optional and provide customers a way to use InSpec for both use-cases. To ensure we build the best infrastructure testing, we migrate our cookbooks [chef-cookbooks](https://github.com/chef-cookbooks) to InSpec.
14
-
15
- ## Which Serverspec resources are available in InSpec?
16
-
17
- The following resources are available in InSpec:
18
-
19
- | Serverspec | InSpec |
20
- |:------------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------:|
21
- | [`bond`](http://serverspec.org/resource_types.html#bond) | [`bond`](https://www.inspec.io/docs/reference/resources/bond/) |
22
- | [`bridge`](http://serverspec.org/resource_types.html#bridge) | [`bridge`](https://www.inspec.io/docs/reference/resources/bridge/) |
23
- | [`command`](http://serverspec.org/resource_types.html#command) | [`command`](https://www.inspec.io/docs/reference/resources/command/) |
24
- | [`cron`](http://serverspec.org/resource_types.html#cron) | [`crontab`](https://www.inspec.io/docs/reference/resources/crontab/) |
25
- | [`docker_container`](http://serverspec.org/resource_types.html#docker_container) | [`docker_container`](https://www.inspec.io/docs/reference/resources/docker_container/) |
26
- | [`docker_image`](http://serverspec.org/resource_types.html#docker_image) | [`docker_image`](https://www.inspec.io/docs/reference/resources/docker_image/) |
27
- | [`file`](http://serverspec.org/resource_types.html#file) | [`file`](https://www.inspec.io/docs/reference/resources/file/) |
28
- | [`group`](http://serverspec.org/resource_types.html#group) | [`group`](https://www.inspec.io/docs/reference/resources/group/) |
29
- | [`host`](http://serverspec.org/resource_types.html#host) | [`host`](https://www.inspec.io/docs/reference/resources/host/) |
30
- | [`interface`](http://serverspec.org/resource_types.html#interface) | [`interface`](https://www.inspec.io/docs/reference/resources/interface/) |
31
- | [`iis_website`](http://serverspec.org/resource_types.html#iis_website) | [`iis_website`](https://www.inspec.io/docs/reference/resources/iis_website/) |
32
- | [`iis_app_pool`](http://serverspec.org/resource_types.html#iis_app_pool) | [`iis_website`](https://www.inspec.io/docs/reference/resources/iis_website/) |
33
- | [`iptables`](http://serverspec.org/resource_types.html#iptables) | [`iptables`](https://www.inspec.io/docs/reference/resources/iptables/) |
34
- | [`kernel_module`](http://serverspec.org/resource_types.html#kernel_module) | [`kernel_module`](https://www.inspec.io/docs/reference/resources/kernel_module/) |
35
- | [`linux_kernel_parameter`](http://serverspec.org/resource_types.html#linux_kernel_parameter) | [`kernel_parameter`](https://www.inspec.io/docs/reference/resources/kernel_parameter/) |
36
- | [`mysql_config`](http://serverspec.org/resource_types.html#mysql_config) | [`mysql_conf`](https://www.inspec.io/docs/reference/resources/mysql_conf/) |
37
- | [`package`](http://serverspec.org/resource_types.html#package) | [`package`](https://www.inspec.io/docs/reference/resources/package/) |
38
- | [`port`](http://serverspec.org/resource_types.html#port) | [`port`](https://www.inspec.io/docs/reference/resources/port/) |
39
- | [`ppa`](http://serverspec.org/resource_types.html#ppa) | [`apt`](https://www.inspec.io/docs/reference/resources/apt/) |
40
- | [`process`](http://serverspec.org/resource_types.html#process) | [`processes`](https://www.inspec.io/docs/reference/resources/processes/) |
41
- | [`service`](http://serverspec.org/resource_types.html#service) | [`service`](https://www.inspec.io/docs/reference/resources/service/) |
42
- | [`user`](http://serverspec.org/resource_types.html#user) | [`user`](https://www.inspec.io/docs/reference/resources/user/) |
43
- | [`windows_feature`](http://serverspec.org/resource_types.html#windows_feature) | [`windows_feature`](https://www.inspec.io/docs/reference/resources/windows_feature/) |
44
- | [`windows_registry_key`](http://serverspec.org/resource_types.html#windows_registry_key) | [`registry_key`](https://www.inspec.io/docs/reference/resources/registry_key/) |
45
- | [`x509_certificate`](http://serverspec.org/resource_types.html#x509_certificate) | [`x509_certificate`](https://www.inspec.io/docs/reference/resources/x509_certificate/) |
46
- | [`yumrepo`](http://serverspec.org/resource_types.html#yumrepo) | [`yum`](https://www.inspec.io/docs/reference/resources/yum/) |
47
- | [`zfs`](http://serverspec.org/resource_types.html#zfs) | [`zfs_pool`](https://www.inspec.io/docs/reference/resources/zfs_pool/) |
48
-
49
- Some Serverspec resources are not available yet. We will implement those resources based on user feedback. If you need a resource that is not available in InSpec, please open an [Github issue](https://github.com/chef/inspec/issues). The list of resources that are not available in InSpec:
50
-
51
- * [`cgroup`](http://serverspec.org/resource_types.html#cgroup)
52
- * [`default_gateway`](http://serverspec.org/resource_types.html#default_gateway)
53
- * [`ip6tables`](http://serverspec.org/resource_types.html#ip6tables)
54
- * [`ipfilter`](http://serverspec.org/resource_types.html#ipfilter)
55
- * [`ipnat`](http://serverspec.org/resource_types.html#ipnat)
56
- * [`linux_audit_system`](http://serverspec.org/resource_types.html#linux_audit_system)
57
- * [`lxc`](http://serverspec.org/resource_types.html#lxc)
58
- * [`mail_alias`](http://serverspec.org/resource_types.html#mail_alias)
59
- * [`php_config`](http://serverspec.org/resource_types.html#php_config)
60
- * [`routing_table`](http://serverspec.org/resource_types.html#routing_table)
61
- * [`selinux`](http://serverspec.org/resource_types.html#selinux)
62
- * [`selinux_module`](http://serverspec.org/resource_types.html#selinux_module)
63
- * [`x509_private_key`](http://serverspec.org/resource_types.html#x509_private_key)
64
-
65
- In addition InSpec provides additional [resources](https://www.inspec.io/docs/reference/resources/) that are not available in Serverspec:
66
-
67
- * [`apache_conf`](https://www.inspec.io/docs/reference/resources/apache_conf/)
68
- * [`apt`](https://www.inspec.io/docs/reference/resources/apt/)
69
- * [`audit_policy`](https://www.inspec.io/docs/reference/resources/audit_policy/)
70
- * [`auditd_conf`](https://www.inspec.io/docs/reference/resources/auditd_conf/)
71
- * [`bash`](https://www.inspec.io/docs/reference/resources/bash/)
72
- * [`csv`](https://www.inspec.io/docs/reference/resources/csv/)
73
- * [`etc_shadow`](https://www.inspec.io/docs/reference/resources/etc_shadow/)
74
- * [`gem`](https://www.inspec.io/docs/reference/resources/gem/)
75
- * [`grub_conf`](https://www.inspec.io/docs/reference/resources/grub_conf/)
76
- * [`inetd_conf`](https://www.inspec.io/docs/reference/resources/inetd_conf/)
77
- * [`ini`](https://www.inspec.io/docs/reference/resources/ini/)
78
- * [`json`](https://www.inspec.io/docs/reference/resources/json/)
79
- * [`npm`](https://www.inspec.io/docs/reference/resources/npm/)
80
- * [`ntp_conf`](https://www.inspec.io/docs/reference/resources/ntp_conf/)
81
- * [`oneget`](https://www.inspec.io/docs/reference/resources/oneget/)
82
- * [`pip`](https://www.inspec.io/docs/reference/resources/pip/)
83
- * [`powershell`](https://www.inspec.io/docs/reference/resources/powershell/)
84
- * [`security_policy`](https://www.inspec.io/docs/reference/resources/security_policy/)
85
- * [`ssh_config`](https://www.inspec.io/docs/reference/resources/ssh_config/)
86
- * [`sshd_config`](https://www.inspec.io/docs/reference/resources/sshd_config/)
87
- * [`sys_info`](https://www.inspec.io/docs/reference/resources/sys_info/)
88
-
89
- ## How do I migrate my Serverspec tests to InSpec
90
-
91
- For most cases, the migration to InSpec is pretty straight forward. First, replace the current verifier in `kitchen.yml` configuration with:
92
-
93
- ```
94
- verifier:
95
- name: inspec
96
- ```
97
-
98
- Second, rename the directory `test/integration/default/serverspec` to
99
- `test/integration/default/inspec`
100
-
101
- Third, remove the Serverspec-specific code from the test files.
102
-
103
- ```
104
- require 'serverspec'
105
-
106
- # Required by serverspec
107
- set :backend, :exec
108
- ```
109
-
110
- InSpec is now configured with Test-Kitchen:
111
-
112
- ```
113
- kitchen verify package-install-centos-72
114
- -----> Starting Kitchen (v1.14.2)
115
- -----> Verifying <package-install-centos-72>...
116
- Detected alternative framework tests for `inspec`
117
- Loaded
118
-
119
- Target: ssh://vagrant@127.0.0.1:2200
120
-
121
-
122
- PHP has
123
- ✔ php
124
- ✔ the pear.php.net channel
125
- ✔ the pecl.php.net channel
126
-
127
- Test Summary: 3 successful, 0 failures, 0 skipped
128
- Finished verifying <package-install-centos-72> (0m0.40s).
129
- -----> Kitchen is finished. (0m3.31s)
130
- ```
131
-
132
- Some real-world migrations are available:
133
-
134
- * [docker](https://github.com/chef-cookbooks/docker)
135
- * [nginx](https://github.com/chef-cookbooks/chef_nginx/pull/5/files)
136
- * [mysql](https://github.com/chef-cookbooks/mysql/pull/430/files)
137
- * [php](https://github.com/chef-cookbooks/php/pull/189/files)
138
-
139
- Some general recommendations:
140
-
141
- * use test-kitchen 1.14+
142
- * in case of errors, increase the log level `kitchen verify package-install-centos-72 -l debug`
143
-
144
- ## Do I still need the backend configuration?
145
-
146
- InSpec does not attach backend information to test files. All tests are defined independently of any backend. Therefore a Serverspec test file:
147
-
148
- ```
149
- require 'serverspec'
150
-
151
- # Required by serverspec
152
- set :backend, :exec
153
-
154
- describe 'PHP' do
155
- it 'has php' do
156
- expect(command('php -v').exit_status).to eq(0)
157
- end
158
-
159
- it 'has the pear.php.net channel' do
160
- expect(command('pear list-channels').stdout).to include('pear.php.net')
161
- end
162
-
163
- it 'has the pecl.php.net channel' do
164
- expect(command('pear list-channels').stdout).to include('pecl.php.net')
165
- end
166
- end
167
- ```
168
-
169
- will become the following InSpec test file:
170
-
171
- ```
172
- describe 'PHP' do
173
- it 'has php' do
174
- expect(command('php -v').exit_status).to eq(0)
175
- end
176
-
177
- it 'has the pear.php.net channel' do
178
- expect(command('pear list-channels').stdout).to include('pear.php.net')
179
- end
180
-
181
- it 'has the pecl.php.net channel' do
182
- expect(command('pear list-channels').stdout).to include('pecl.php.net')
183
- end
184
- end
185
- ```
186
-
187
- As you can see, the InSpec test files just focuses on tests and tries to avoid all clutter.
188
-
189
- ## Nested describe blocks
190
-
191
- Serverspec and RSpec allow you to define nested describe blocks. We did a survey and found out that most users use nested describe blocks only to improve their output report. We believe the code structure should not change to improve the output of a report. Nevertheless we understand that nested describe blocks help you to structure test code. A sample code block looks like:
192
-
193
- ```
194
- describe 'chef-server-directories' do
195
- describe file('/etc/opscode') do
196
- it { should be_directory }
197
- it { should be_owned_by 'root' }
198
- end
199
-
200
- describe file('/etc/opscode-analytics') do
201
- it { should be_directory }
202
- it { should be_owned_by 'opscode' }
203
- it { should be_grouped_into 'opscode' }
204
- end
205
-
206
- describe file('/var/log/opscode') do
207
- it { should be_directory }
208
- it { should be_owned_by 'opscode' }
209
- it { should be_grouped_into 'opscode' }
210
- end
211
-
212
- describe file('/var/opt/opscode') do
213
- it { should be_directory }
214
- it { should be_owned_by 'root' }
215
- end
216
- end
217
- ```
218
-
219
- In InSpec you would split up groups into files.
220
-
221
- ```
222
- tests
223
- ├── server-directories.rb
224
- ├── other-tests.rb
225
- └── further-tests.rb
226
- ```
227
-
228
- Each file can have a top-level description of its content:
229
-
230
- ```
231
- title "Chef Server Directories"
232
-
233
- describe file('/etc/opscode') do
234
- it { should be_directory }
235
- it { should be_owned_by 'root' }
236
- end
237
-
238
- describe file('/etc/opscode-analytics') do
239
- it { should be_directory }
240
- it { should be_owned_by 'opscode' }
241
- it { should be_grouped_into 'opscode' }
242
- end
243
-
244
- describe file('/var/log/opscode') do
245
- it { should be_directory }
246
- it { should be_owned_by 'opscode' }
247
- it { should be_grouped_into 'opscode' }
248
- end
249
-
250
- describe file('/var/opt/opscode') do
251
- it { should be_directory }
252
- it { should be_owned_by 'root' }
253
- end
254
-
255
- ```
256
-
257
- ## Are you supporting the `expect` syntax?
258
-
259
- Of course. We still prefer the `should` syntax for UX reasons. We did surveys with various types of customers like devops engineers, auditors, managers. All participants who prefered the `expect` syntax have been Ruby experts. All non-Ruby developers found it easier to understand the `should` syntax.
260
-
261
- ### `should` syntax with InSpec
262
-
263
- ```
264
- describe command('php -v') do
265
- its('exit_status') { should eq 0 }
266
- end
267
-
268
- describe command('pear list-channels') do
269
- its('stdout') { should include('pear.php.net')}
270
- end
271
-
272
- describe command('pear list-channels') do
273
- its('stdout') { should include('pecl.php.net')}
274
- end
275
- ```
276
-
277
- ### `expect` syntax with InSpec
278
-
279
- ```
280
- describe 'PHP' do
281
- it 'has php' do
282
- expect(command('php -v').exit_status).to eq(0)
283
- end
284
-
285
- it 'has the pear.php.net channel' do
286
- expect(command('pear list-channels').stdout).to include('pear.php.net')
287
- end
288
-
289
- it 'has the pecl.php.net channel' do
290
- expect(command('pear list-channels').stdout).to include('pecl.php.net')
291
- end
292
- end
293
- ```
1
+ ---
2
+ title: InSpec Migration Guide
3
+ ---
4
+
5
+ # Migrate from Serverspec to InSpec
6
+
7
+ ## How is InSpec different from Serverspec
8
+
9
+ We've written a complete blog post about that topic: [The Road to InSpec](https://blog.chef.io/2015/11/04/the-road-to-inspec/)
10
+
11
+ ## Is InSpec suitable for infrastructure testing?
12
+
13
+ InSpec is a framework that allows you to run infrastructure testing as well as compliance testing. The compliance features are always optional and provide customers a way to use InSpec for both use-cases. To ensure we build the best infrastructure testing, we migrate our cookbooks [chef-cookbooks](https://github.com/chef-cookbooks) to InSpec.
14
+
15
+ ## Which Serverspec resources are available in InSpec?
16
+
17
+ The following resources are available in InSpec:
18
+
19
+ | Serverspec | InSpec |
20
+ |:------------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------:|
21
+ | [`bond`](http://serverspec.org/resource_types.html#bond) | [`bond`](https://www.inspec.io/docs/reference/resources/bond/) |
22
+ | [`bridge`](http://serverspec.org/resource_types.html#bridge) | [`bridge`](https://www.inspec.io/docs/reference/resources/bridge/) |
23
+ | [`command`](http://serverspec.org/resource_types.html#command) | [`command`](https://www.inspec.io/docs/reference/resources/command/) |
24
+ | [`cron`](http://serverspec.org/resource_types.html#cron) | [`crontab`](https://www.inspec.io/docs/reference/resources/crontab/) |
25
+ | [`docker_container`](http://serverspec.org/resource_types.html#docker_container) | [`docker_container`](https://www.inspec.io/docs/reference/resources/docker_container/) |
26
+ | [`docker_image`](http://serverspec.org/resource_types.html#docker_image) | [`docker_image`](https://www.inspec.io/docs/reference/resources/docker_image/) |
27
+ | [`file`](http://serverspec.org/resource_types.html#file) | [`file`](https://www.inspec.io/docs/reference/resources/file/) |
28
+ | [`group`](http://serverspec.org/resource_types.html#group) | [`group`](https://www.inspec.io/docs/reference/resources/group/) |
29
+ | [`host`](http://serverspec.org/resource_types.html#host) | [`host`](https://www.inspec.io/docs/reference/resources/host/) |
30
+ | [`interface`](http://serverspec.org/resource_types.html#interface) | [`interface`](https://www.inspec.io/docs/reference/resources/interface/) |
31
+ | [`iis_website`](http://serverspec.org/resource_types.html#iis_website) | [`iis_website`](https://www.inspec.io/docs/reference/resources/iis_website/) |
32
+ | [`iis_app_pool`](http://serverspec.org/resource_types.html#iis_app_pool) | [`iis_website`](https://www.inspec.io/docs/reference/resources/iis_website/) |
33
+ | [`iptables`](http://serverspec.org/resource_types.html#iptables) | [`iptables`](https://www.inspec.io/docs/reference/resources/iptables/) |
34
+ | [`kernel_module`](http://serverspec.org/resource_types.html#kernel_module) | [`kernel_module`](https://www.inspec.io/docs/reference/resources/kernel_module/) |
35
+ | [`linux_kernel_parameter`](http://serverspec.org/resource_types.html#linux_kernel_parameter) | [`kernel_parameter`](https://www.inspec.io/docs/reference/resources/kernel_parameter/) |
36
+ | [`mysql_config`](http://serverspec.org/resource_types.html#mysql_config) | [`mysql_conf`](https://www.inspec.io/docs/reference/resources/mysql_conf/) |
37
+ | [`package`](http://serverspec.org/resource_types.html#package) | [`package`](https://www.inspec.io/docs/reference/resources/package/) |
38
+ | [`port`](http://serverspec.org/resource_types.html#port) | [`port`](https://www.inspec.io/docs/reference/resources/port/) |
39
+ | [`ppa`](http://serverspec.org/resource_types.html#ppa) | [`apt`](https://www.inspec.io/docs/reference/resources/apt/) |
40
+ | [`process`](http://serverspec.org/resource_types.html#process) | [`processes`](https://www.inspec.io/docs/reference/resources/processes/) |
41
+ | [`service`](http://serverspec.org/resource_types.html#service) | [`service`](https://www.inspec.io/docs/reference/resources/service/) |
42
+ | [`user`](http://serverspec.org/resource_types.html#user) | [`user`](https://www.inspec.io/docs/reference/resources/user/) |
43
+ | [`windows_feature`](http://serverspec.org/resource_types.html#windows_feature) | [`windows_feature`](https://www.inspec.io/docs/reference/resources/windows_feature/) |
44
+ | [`windows_registry_key`](http://serverspec.org/resource_types.html#windows_registry_key) | [`registry_key`](https://www.inspec.io/docs/reference/resources/registry_key/) |
45
+ | [`x509_certificate`](http://serverspec.org/resource_types.html#x509_certificate) | [`x509_certificate`](https://www.inspec.io/docs/reference/resources/x509_certificate/) |
46
+ | [`yumrepo`](http://serverspec.org/resource_types.html#yumrepo) | [`yum`](https://www.inspec.io/docs/reference/resources/yum/) |
47
+ | [`zfs`](http://serverspec.org/resource_types.html#zfs) | [`zfs_pool`](https://www.inspec.io/docs/reference/resources/zfs_pool/) |
48
+
49
+ Some Serverspec resources are not available yet. We will implement those resources based on user feedback. If you need a resource that is not available in InSpec, please open an [Github issue](https://github.com/chef/inspec/issues). The list of resources that are not available in InSpec:
50
+
51
+ * [`cgroup`](http://serverspec.org/resource_types.html#cgroup)
52
+ * [`default_gateway`](http://serverspec.org/resource_types.html#default_gateway)
53
+ * [`ip6tables`](http://serverspec.org/resource_types.html#ip6tables)
54
+ * [`ipfilter`](http://serverspec.org/resource_types.html#ipfilter)
55
+ * [`ipnat`](http://serverspec.org/resource_types.html#ipnat)
56
+ * [`linux_audit_system`](http://serverspec.org/resource_types.html#linux_audit_system)
57
+ * [`lxc`](http://serverspec.org/resource_types.html#lxc)
58
+ * [`mail_alias`](http://serverspec.org/resource_types.html#mail_alias)
59
+ * [`php_config`](http://serverspec.org/resource_types.html#php_config)
60
+ * [`routing_table`](http://serverspec.org/resource_types.html#routing_table)
61
+ * [`selinux`](http://serverspec.org/resource_types.html#selinux)
62
+ * [`selinux_module`](http://serverspec.org/resource_types.html#selinux_module)
63
+ * [`x509_private_key`](http://serverspec.org/resource_types.html#x509_private_key)
64
+
65
+ In addition InSpec provides additional [resources](https://www.inspec.io/docs/reference/resources/) that are not available in Serverspec:
66
+
67
+ * [`apache_conf`](https://www.inspec.io/docs/reference/resources/apache_conf/)
68
+ * [`apt`](https://www.inspec.io/docs/reference/resources/apt/)
69
+ * [`audit_policy`](https://www.inspec.io/docs/reference/resources/audit_policy/)
70
+ * [`auditd_conf`](https://www.inspec.io/docs/reference/resources/auditd_conf/)
71
+ * [`bash`](https://www.inspec.io/docs/reference/resources/bash/)
72
+ * [`csv`](https://www.inspec.io/docs/reference/resources/csv/)
73
+ * [`etc_shadow`](https://www.inspec.io/docs/reference/resources/etc_shadow/)
74
+ * [`gem`](https://www.inspec.io/docs/reference/resources/gem/)
75
+ * [`grub_conf`](https://www.inspec.io/docs/reference/resources/grub_conf/)
76
+ * [`inetd_conf`](https://www.inspec.io/docs/reference/resources/inetd_conf/)
77
+ * [`ini`](https://www.inspec.io/docs/reference/resources/ini/)
78
+ * [`json`](https://www.inspec.io/docs/reference/resources/json/)
79
+ * [`npm`](https://www.inspec.io/docs/reference/resources/npm/)
80
+ * [`ntp_conf`](https://www.inspec.io/docs/reference/resources/ntp_conf/)
81
+ * [`oneget`](https://www.inspec.io/docs/reference/resources/oneget/)
82
+ * [`pip`](https://www.inspec.io/docs/reference/resources/pip/)
83
+ * [`powershell`](https://www.inspec.io/docs/reference/resources/powershell/)
84
+ * [`security_policy`](https://www.inspec.io/docs/reference/resources/security_policy/)
85
+ * [`ssh_config`](https://www.inspec.io/docs/reference/resources/ssh_config/)
86
+ * [`sshd_config`](https://www.inspec.io/docs/reference/resources/sshd_config/)
87
+ * [`sys_info`](https://www.inspec.io/docs/reference/resources/sys_info/)
88
+
89
+ ## How do I migrate my Serverspec tests to InSpec
90
+
91
+ For most cases, the migration to InSpec is pretty straight forward. First, replace the current verifier in `kitchen.yml` configuration with:
92
+
93
+ ```
94
+ verifier:
95
+ name: inspec
96
+ ```
97
+
98
+ Second, rename the directory `test/integration/default/serverspec` to
99
+ `test/integration/default/inspec`
100
+
101
+ Third, remove the Serverspec-specific code from the test files.
102
+
103
+ ```
104
+ require 'serverspec'
105
+
106
+ # Required by serverspec
107
+ set :backend, :exec
108
+ ```
109
+
110
+ InSpec is now configured with Test-Kitchen:
111
+
112
+ ```
113
+ kitchen verify package-install-centos-72
114
+ -----> Starting Kitchen (v1.14.2)
115
+ -----> Verifying <package-install-centos-72>...
116
+ Detected alternative framework tests for `inspec`
117
+ Loaded
118
+
119
+ Target: ssh://vagrant@127.0.0.1:2200
120
+
121
+
122
+ PHP has
123
+ ✔ php
124
+ ✔ the pear.php.net channel
125
+ ✔ the pecl.php.net channel
126
+
127
+ Test Summary: 3 successful, 0 failures, 0 skipped
128
+ Finished verifying <package-install-centos-72> (0m0.40s).
129
+ -----> Kitchen is finished. (0m3.31s)
130
+ ```
131
+
132
+ Some real-world migrations are available:
133
+
134
+ * [docker](https://github.com/chef-cookbooks/docker)
135
+ * [nginx](https://github.com/chef-cookbooks/chef_nginx/pull/5/files)
136
+ * [mysql](https://github.com/chef-cookbooks/mysql/pull/430/files)
137
+ * [php](https://github.com/chef-cookbooks/php/pull/189/files)
138
+
139
+ Some general recommendations:
140
+
141
+ * use test-kitchen 1.14+
142
+ * in case of errors, increase the log level `kitchen verify package-install-centos-72 -l debug`
143
+
144
+ ## Do I still need the backend configuration?
145
+
146
+ InSpec does not attach backend information to test files. All tests are defined independently of any backend. Therefore a Serverspec test file:
147
+
148
+ ```
149
+ require 'serverspec'
150
+
151
+ # Required by serverspec
152
+ set :backend, :exec
153
+
154
+ describe 'PHP' do
155
+ it 'has php' do
156
+ expect(command('php -v').exit_status).to eq(0)
157
+ end
158
+
159
+ it 'has the pear.php.net channel' do
160
+ expect(command('pear list-channels').stdout).to include('pear.php.net')
161
+ end
162
+
163
+ it 'has the pecl.php.net channel' do
164
+ expect(command('pear list-channels').stdout).to include('pecl.php.net')
165
+ end
166
+ end
167
+ ```
168
+
169
+ will become the following InSpec test file:
170
+
171
+ ```
172
+ describe 'PHP' do
173
+ it 'has php' do
174
+ expect(command('php -v').exit_status).to eq(0)
175
+ end
176
+
177
+ it 'has the pear.php.net channel' do
178
+ expect(command('pear list-channels').stdout).to include('pear.php.net')
179
+ end
180
+
181
+ it 'has the pecl.php.net channel' do
182
+ expect(command('pear list-channels').stdout).to include('pecl.php.net')
183
+ end
184
+ end
185
+ ```
186
+
187
+ As you can see, the InSpec test files just focuses on tests and tries to avoid all clutter.
188
+
189
+ ## Nested describe blocks
190
+
191
+ Serverspec and RSpec allow you to define nested describe blocks. We did a survey and found out that most users use nested describe blocks only to improve their output report. We believe the code structure should not change to improve the output of a report. Nevertheless we understand that nested describe blocks help you to structure test code. A sample code block looks like:
192
+
193
+ ```
194
+ describe 'chef-server-directories' do
195
+ describe file('/etc/opscode') do
196
+ it { should be_directory }
197
+ it { should be_owned_by 'root' }
198
+ end
199
+
200
+ describe file('/etc/opscode-analytics') do
201
+ it { should be_directory }
202
+ it { should be_owned_by 'opscode' }
203
+ it { should be_grouped_into 'opscode' }
204
+ end
205
+
206
+ describe file('/var/log/opscode') do
207
+ it { should be_directory }
208
+ it { should be_owned_by 'opscode' }
209
+ it { should be_grouped_into 'opscode' }
210
+ end
211
+
212
+ describe file('/var/opt/opscode') do
213
+ it { should be_directory }
214
+ it { should be_owned_by 'root' }
215
+ end
216
+ end
217
+ ```
218
+
219
+ In InSpec you would split up groups into files.
220
+
221
+ ```
222
+ tests
223
+ ├── server-directories.rb
224
+ ├── other-tests.rb
225
+ └── further-tests.rb
226
+ ```
227
+
228
+ Each file can have a top-level description of its content:
229
+
230
+ ```
231
+ title "Chef Server Directories"
232
+
233
+ describe file('/etc/opscode') do
234
+ it { should be_directory }
235
+ it { should be_owned_by 'root' }
236
+ end
237
+
238
+ describe file('/etc/opscode-analytics') do
239
+ it { should be_directory }
240
+ it { should be_owned_by 'opscode' }
241
+ it { should be_grouped_into 'opscode' }
242
+ end
243
+
244
+ describe file('/var/log/opscode') do
245
+ it { should be_directory }
246
+ it { should be_owned_by 'opscode' }
247
+ it { should be_grouped_into 'opscode' }
248
+ end
249
+
250
+ describe file('/var/opt/opscode') do
251
+ it { should be_directory }
252
+ it { should be_owned_by 'root' }
253
+ end
254
+
255
+ ```
256
+
257
+ ## Are you supporting the `expect` syntax?
258
+
259
+ Of course. We still prefer the `should` syntax for UX reasons. We did surveys with various types of customers like devops engineers, auditors, managers. All participants who prefered the `expect` syntax have been Ruby experts. All non-Ruby developers found it easier to understand the `should` syntax.
260
+
261
+ ### `should` syntax with InSpec
262
+
263
+ ```
264
+ describe command('php -v') do
265
+ its('exit_status') { should eq 0 }
266
+ end
267
+
268
+ describe command('pear list-channels') do
269
+ its('stdout') { should include('pear.php.net')}
270
+ end
271
+
272
+ describe command('pear list-channels') do
273
+ its('stdout') { should include('pecl.php.net')}
274
+ end
275
+ ```
276
+
277
+ ### `expect` syntax with InSpec
278
+
279
+ ```
280
+ describe 'PHP' do
281
+ it 'has php' do
282
+ expect(command('php -v').exit_status).to eq(0)
283
+ end
284
+
285
+ it 'has the pear.php.net channel' do
286
+ expect(command('pear list-channels').stdout).to include('pear.php.net')
287
+ end
288
+
289
+ it 'has the pecl.php.net channel' do
290
+ expect(command('pear list-channels').stdout).to include('pecl.php.net')
291
+ end
292
+ end
293
+ ```