inspec 2.1.0 → 2.1.10

Sign up to get free protection for your applications and to get access to all the features.
Files changed (489) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +101 -101
  3. data/CHANGELOG.md +3024 -3004
  4. data/Gemfile +55 -55
  5. data/LICENSE +14 -14
  6. data/MAINTAINERS.md +33 -33
  7. data/MAINTAINERS.toml +52 -52
  8. data/README.md +447 -446
  9. data/Rakefile +322 -322
  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 +100 -93
  15. data/docs/glossary.md +99 -99
  16. data/docs/habitat.md +191 -191
  17. data/docs/inspec_and_friends.md +114 -114
  18. data/docs/matchers.md +169 -169
  19. data/docs/migration.md +293 -293
  20. data/docs/platforms.md +118 -118
  21. data/docs/plugin_kitchen_inspec.md +50 -50
  22. data/docs/profiles.md +376 -376
  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_config_recorder.md.erb +71 -71
  36. data/docs/resources/aws_ec2_instance.md.erb +106 -106
  37. data/docs/resources/aws_iam_access_key.md.erb +123 -123
  38. data/docs/resources/aws_iam_access_keys.md.erb +198 -198
  39. data/docs/resources/aws_iam_group.md.erb +46 -46
  40. data/docs/resources/aws_iam_groups.md.erb +43 -43
  41. data/docs/resources/aws_iam_password_policy.md.erb +76 -76
  42. data/docs/resources/aws_iam_policies.md.erb +82 -82
  43. data/docs/resources/aws_iam_policy.md.erb +144 -144
  44. data/docs/resources/aws_iam_role.md.erb +63 -63
  45. data/docs/resources/aws_iam_root_user.md.erb +58 -58
  46. data/docs/resources/aws_iam_user.md.erb +64 -64
  47. data/docs/resources/aws_iam_users.md.erb +89 -89
  48. data/docs/resources/aws_kms_keys.md.erb +84 -84
  49. data/docs/resources/aws_route_table.md.erb +47 -47
  50. data/docs/resources/aws_s3_bucket.md.erb +134 -134
  51. data/docs/resources/aws_s3_bucket_object.md.erb +83 -0
  52. data/docs/resources/aws_security_group.md.erb +151 -151
  53. data/docs/resources/aws_security_groups.md.erb +91 -91
  54. data/docs/resources/aws_sns_subscription.md.erb +125 -0
  55. data/docs/resources/aws_sns_topic.md.erb +63 -63
  56. data/docs/resources/aws_sns_topics.md.erb +52 -0
  57. data/docs/resources/aws_subnet.md.erb +134 -134
  58. data/docs/resources/aws_subnets.md.erb +126 -126
  59. data/docs/resources/aws_vpc.md.erb +120 -120
  60. data/docs/resources/aws_vpcs.md.erb +48 -48
  61. data/docs/resources/azure_generic_resource.md.erb +171 -171
  62. data/docs/resources/azure_resource_group.md.erb +284 -284
  63. data/docs/resources/azure_virtual_machine.md.erb +347 -347
  64. data/docs/resources/azure_virtual_machine_data_disk.md.erb +224 -224
  65. data/docs/resources/bash.md.erb +75 -75
  66. data/docs/resources/bond.md.erb +90 -90
  67. data/docs/resources/bridge.md.erb +57 -57
  68. data/docs/resources/bsd_service.md.erb +67 -67
  69. data/docs/resources/command.md.erb +138 -138
  70. data/docs/resources/cpan.md.erb +79 -79
  71. data/docs/resources/cran.md.erb +64 -64
  72. data/docs/resources/crontab.md.erb +89 -89
  73. data/docs/resources/csv.md.erb +54 -54
  74. data/docs/resources/dh_params.md.erb +205 -205
  75. data/docs/resources/directory.md.erb +30 -30
  76. data/docs/resources/docker.md.erb +219 -219
  77. data/docs/resources/docker_container.md.erb +103 -103
  78. data/docs/resources/docker_image.md.erb +94 -94
  79. data/docs/resources/docker_service.md.erb +114 -114
  80. data/docs/resources/elasticsearch.md.erb +242 -242
  81. data/docs/resources/etc_fstab.md.erb +125 -125
  82. data/docs/resources/etc_group.md.erb +75 -75
  83. data/docs/resources/etc_hosts.md.erb +78 -78
  84. data/docs/resources/etc_hosts_allow.md.erb +74 -74
  85. data/docs/resources/etc_hosts_deny.md.erb +74 -74
  86. data/docs/resources/file.md.erb +526 -526
  87. data/docs/resources/filesystem.md.erb +41 -41
  88. data/docs/resources/firewalld.md.erb +107 -107
  89. data/docs/resources/gem.md.erb +79 -79
  90. data/docs/resources/group.md.erb +61 -61
  91. data/docs/resources/grub_conf.md.erb +101 -101
  92. data/docs/resources/host.md.erb +86 -86
  93. data/docs/resources/http.md.erb +196 -196
  94. data/docs/resources/iis_app.md.erb +122 -122
  95. data/docs/resources/iis_site.md.erb +135 -135
  96. data/docs/resources/inetd_conf.md.erb +94 -94
  97. data/docs/resources/ini.md.erb +76 -76
  98. data/docs/resources/interface.md.erb +58 -58
  99. data/docs/resources/iptables.md.erb +64 -64
  100. data/docs/resources/json.md.erb +63 -63
  101. data/docs/resources/kernel_module.md.erb +120 -120
  102. data/docs/resources/kernel_parameter.md.erb +53 -53
  103. data/docs/resources/key_rsa.md.erb +85 -85
  104. data/docs/resources/launchd_service.md.erb +57 -57
  105. data/docs/resources/limits_conf.md.erb +75 -75
  106. data/docs/resources/{login_def.md.erb → login_defs.md.erb} +71 -71
  107. data/docs/resources/mount.md.erb +69 -69
  108. data/docs/resources/mssql_session.md.erb +60 -60
  109. data/docs/resources/mysql_conf.md.erb +99 -99
  110. data/docs/resources/mysql_session.md.erb +74 -74
  111. data/docs/resources/nginx.md.erb +79 -79
  112. data/docs/resources/nginx_conf.md.erb +138 -128
  113. data/docs/resources/npm.md.erb +60 -60
  114. data/docs/resources/ntp_conf.md.erb +60 -60
  115. data/docs/resources/oneget.md.erb +53 -53
  116. data/docs/resources/oracledb_session.md.erb +52 -52
  117. data/docs/resources/os.md.erb +141 -141
  118. data/docs/resources/os_env.md.erb +78 -78
  119. data/docs/resources/package.md.erb +120 -120
  120. data/docs/resources/packages.md.erb +67 -67
  121. data/docs/resources/parse_config.md.erb +103 -103
  122. data/docs/resources/parse_config_file.md.erb +138 -138
  123. data/docs/resources/passwd.md.erb +141 -141
  124. data/docs/resources/pip.md.erb +67 -67
  125. data/docs/resources/port.md.erb +137 -137
  126. data/docs/resources/postgres_conf.md.erb +79 -79
  127. data/docs/resources/postgres_hba_conf.md.erb +93 -93
  128. data/docs/resources/postgres_ident_conf.md.erb +76 -76
  129. data/docs/resources/postgres_session.md.erb +69 -69
  130. data/docs/resources/powershell.md.erb +102 -102
  131. data/docs/resources/processes.md.erb +109 -109
  132. data/docs/resources/rabbitmq_config.md.erb +41 -41
  133. data/docs/resources/registry_key.md.erb +158 -158
  134. data/docs/resources/runit_service.md.erb +57 -57
  135. data/docs/resources/security_policy.md.erb +47 -47
  136. data/docs/resources/service.md.erb +121 -121
  137. data/docs/resources/shadow.md.erb +146 -146
  138. data/docs/resources/ssh_config.md.erb +73 -80
  139. data/docs/resources/sshd_config.md.erb +83 -83
  140. data/docs/resources/ssl.md.erb +119 -119
  141. data/docs/resources/sys_info.md.erb +42 -42
  142. data/docs/resources/systemd_service.md.erb +57 -57
  143. data/docs/resources/sysv_service.md.erb +57 -57
  144. data/docs/resources/upstart_service.md.erb +57 -57
  145. data/docs/resources/user.md.erb +140 -140
  146. data/docs/resources/users.md.erb +127 -127
  147. data/docs/resources/vbscript.md.erb +55 -55
  148. data/docs/resources/virtualization.md.erb +57 -57
  149. data/docs/resources/windows_feature.md.erb +47 -47
  150. data/docs/resources/windows_hotfix.md.erb +53 -53
  151. data/docs/resources/windows_task.md.erb +95 -95
  152. data/docs/resources/wmi.md.erb +81 -81
  153. data/docs/resources/x509_certificate.md.erb +151 -151
  154. data/docs/resources/xinetd_conf.md.erb +156 -156
  155. data/docs/resources/xml.md.erb +85 -85
  156. data/docs/resources/yaml.md.erb +69 -69
  157. data/docs/resources/yum.md.erb +98 -98
  158. data/docs/resources/zfs_dataset.md.erb +53 -53
  159. data/docs/resources/zfs_pool.md.erb +47 -47
  160. data/docs/ruby_usage.md +203 -203
  161. data/docs/shared/matcher_be.md.erb +1 -1
  162. data/docs/shared/matcher_cmp.md.erb +43 -43
  163. data/docs/shared/matcher_eq.md.erb +3 -3
  164. data/docs/shared/matcher_include.md.erb +1 -1
  165. data/docs/shared/matcher_match.md.erb +1 -1
  166. data/docs/shell.md +217 -217
  167. data/examples/README.md +8 -8
  168. data/examples/inheritance/README.md +65 -65
  169. data/examples/inheritance/controls/example.rb +14 -14
  170. data/examples/inheritance/inspec.yml +15 -15
  171. data/examples/kitchen-ansible/.kitchen.yml +25 -25
  172. data/examples/kitchen-ansible/Gemfile +19 -19
  173. data/examples/kitchen-ansible/README.md +53 -53
  174. data/examples/kitchen-ansible/files/nginx.repo +6 -6
  175. data/examples/kitchen-ansible/tasks/main.yml +16 -16
  176. data/examples/kitchen-ansible/test/integration/default/default.yml +5 -5
  177. data/examples/kitchen-ansible/test/integration/default/web_spec.rb +28 -28
  178. data/examples/kitchen-chef/.kitchen.yml +20 -20
  179. data/examples/kitchen-chef/Berksfile +3 -3
  180. data/examples/kitchen-chef/Gemfile +19 -19
  181. data/examples/kitchen-chef/README.md +27 -27
  182. data/examples/kitchen-chef/metadata.rb +7 -7
  183. data/examples/kitchen-chef/recipes/default.rb +6 -6
  184. data/examples/kitchen-chef/recipes/nginx.rb +30 -30
  185. data/examples/kitchen-chef/test/integration/default/web_spec.rb +28 -28
  186. data/examples/kitchen-puppet/.kitchen.yml +22 -22
  187. data/examples/kitchen-puppet/Gemfile +20 -20
  188. data/examples/kitchen-puppet/Puppetfile +25 -25
  189. data/examples/kitchen-puppet/README.md +53 -53
  190. data/examples/kitchen-puppet/manifests/site.pp +33 -33
  191. data/examples/kitchen-puppet/metadata.json +11 -11
  192. data/examples/kitchen-puppet/test/integration/default/web_spec.rb +28 -28
  193. data/examples/meta-profile/README.md +37 -37
  194. data/examples/meta-profile/controls/example.rb +13 -13
  195. data/examples/meta-profile/inspec.yml +13 -13
  196. data/examples/profile-attribute.yml +2 -2
  197. data/examples/profile-attribute/README.md +14 -14
  198. data/examples/profile-attribute/controls/example.rb +11 -11
  199. data/examples/profile-attribute/inspec.yml +8 -8
  200. data/examples/profile-aws/controls/iam_password_policy_expiration.rb +8 -8
  201. data/examples/profile-aws/controls/iam_password_policy_max_age.rb +8 -8
  202. data/examples/profile-aws/controls/iam_root_user_mfa.rb +8 -8
  203. data/examples/profile-aws/controls/iam_users_access_key_age.rb +8 -8
  204. data/examples/profile-aws/controls/iam_users_console_users_mfa.rb +8 -8
  205. data/examples/profile-aws/inspec.yml +11 -11
  206. data/examples/profile-azure/controls/azure_resource_group_example.rb +24 -24
  207. data/examples/profile-azure/controls/azure_vm_example.rb +29 -29
  208. data/examples/profile-azure/inspec.yml +11 -11
  209. data/examples/profile-sensitive/README.md +29 -29
  210. data/examples/profile-sensitive/controls/sensitive-failures.rb +9 -9
  211. data/examples/profile-sensitive/controls/sensitive.rb +9 -9
  212. data/examples/profile-sensitive/inspec.yml +8 -8
  213. data/examples/profile/README.md +48 -48
  214. data/examples/profile/controls/example.rb +23 -23
  215. data/examples/profile/controls/gordon.rb +36 -36
  216. data/examples/profile/controls/meta.rb +34 -34
  217. data/examples/profile/inspec.yml +10 -10
  218. data/examples/profile/libraries/gordon_config.rb +53 -53
  219. data/inspec.gemspec +47 -47
  220. data/lib/bundles/README.md +3 -3
  221. data/lib/bundles/inspec-artifact.rb +7 -7
  222. data/lib/bundles/inspec-artifact/README.md +1 -1
  223. data/lib/bundles/inspec-artifact/cli.rb +277 -277
  224. data/lib/bundles/inspec-compliance.rb +16 -16
  225. data/lib/bundles/inspec-compliance/.kitchen.yml +20 -20
  226. data/lib/bundles/inspec-compliance/README.md +185 -185
  227. data/lib/bundles/inspec-compliance/api.rb +316 -316
  228. data/lib/bundles/inspec-compliance/api/login.rb +152 -152
  229. data/lib/bundles/inspec-compliance/bootstrap.sh +41 -41
  230. data/lib/bundles/inspec-compliance/cli.rb +254 -254
  231. data/lib/bundles/inspec-compliance/configuration.rb +103 -103
  232. data/lib/bundles/inspec-compliance/http.rb +86 -86
  233. data/lib/bundles/inspec-compliance/support.rb +36 -36
  234. data/lib/bundles/inspec-compliance/target.rb +98 -98
  235. data/lib/bundles/inspec-compliance/test/integration/default/cli.rb +93 -93
  236. data/lib/bundles/inspec-habitat.rb +12 -12
  237. data/lib/bundles/inspec-habitat/cli.rb +36 -36
  238. data/lib/bundles/inspec-habitat/log.rb +10 -10
  239. data/lib/bundles/inspec-habitat/profile.rb +390 -390
  240. data/lib/bundles/inspec-init.rb +8 -8
  241. data/lib/bundles/inspec-init/README.md +31 -31
  242. data/lib/bundles/inspec-init/cli.rb +97 -97
  243. data/lib/bundles/inspec-init/templates/profile/README.md +3 -3
  244. data/lib/bundles/inspec-init/templates/profile/controls/example.rb +19 -19
  245. data/lib/bundles/inspec-init/templates/profile/inspec.yml +8 -8
  246. data/lib/bundles/inspec-supermarket.rb +13 -13
  247. data/lib/bundles/inspec-supermarket/README.md +45 -45
  248. data/lib/bundles/inspec-supermarket/api.rb +84 -84
  249. data/lib/bundles/inspec-supermarket/cli.rb +73 -73
  250. data/lib/bundles/inspec-supermarket/target.rb +34 -34
  251. data/lib/fetchers/git.rb +163 -163
  252. data/lib/fetchers/local.rb +74 -74
  253. data/lib/fetchers/mock.rb +35 -35
  254. data/lib/fetchers/url.rb +204 -204
  255. data/lib/inspec.rb +24 -24
  256. data/lib/inspec/archive/tar.rb +29 -29
  257. data/lib/inspec/archive/zip.rb +19 -19
  258. data/lib/inspec/backend.rb +93 -93
  259. data/lib/inspec/base_cli.rb +357 -355
  260. data/lib/inspec/cached_fetcher.rb +66 -66
  261. data/lib/inspec/cli.rb +292 -292
  262. data/lib/inspec/completions/bash.sh.erb +45 -45
  263. data/lib/inspec/completions/fish.sh.erb +34 -34
  264. data/lib/inspec/completions/zsh.sh.erb +61 -61
  265. data/lib/inspec/control_eval_context.rb +179 -179
  266. data/lib/inspec/dependencies/cache.rb +72 -72
  267. data/lib/inspec/dependencies/dependency_set.rb +92 -92
  268. data/lib/inspec/dependencies/lockfile.rb +115 -115
  269. data/lib/inspec/dependencies/requirement.rb +123 -123
  270. data/lib/inspec/dependencies/resolver.rb +86 -86
  271. data/lib/inspec/describe.rb +27 -27
  272. data/lib/inspec/dsl.rb +66 -66
  273. data/lib/inspec/dsl_shared.rb +33 -33
  274. data/lib/inspec/env_printer.rb +157 -157
  275. data/lib/inspec/errors.rb +13 -13
  276. data/lib/inspec/exceptions.rb +12 -12
  277. data/lib/inspec/expect.rb +45 -45
  278. data/lib/inspec/fetcher.rb +45 -45
  279. data/lib/inspec/file_provider.rb +275 -275
  280. data/lib/inspec/formatters.rb +3 -3
  281. data/lib/inspec/formatters/base.rb +250 -250
  282. data/lib/inspec/formatters/json_rspec.rb +20 -20
  283. data/lib/inspec/formatters/show_progress.rb +12 -12
  284. data/lib/inspec/library_eval_context.rb +58 -58
  285. data/lib/inspec/log.rb +11 -11
  286. data/lib/inspec/metadata.rb +247 -247
  287. data/lib/inspec/method_source.rb +24 -24
  288. data/lib/inspec/objects.rb +14 -14
  289. data/lib/inspec/objects/attribute.rb +65 -65
  290. data/lib/inspec/objects/control.rb +61 -61
  291. data/lib/inspec/objects/describe.rb +92 -92
  292. data/lib/inspec/objects/each_loop.rb +36 -36
  293. data/lib/inspec/objects/list.rb +15 -15
  294. data/lib/inspec/objects/or_test.rb +40 -40
  295. data/lib/inspec/objects/ruby_helper.rb +15 -15
  296. data/lib/inspec/objects/tag.rb +27 -27
  297. data/lib/inspec/objects/test.rb +87 -87
  298. data/lib/inspec/objects/value.rb +27 -27
  299. data/lib/inspec/plugins.rb +60 -60
  300. data/lib/inspec/plugins/cli.rb +24 -24
  301. data/lib/inspec/plugins/fetcher.rb +86 -86
  302. data/lib/inspec/plugins/resource.rb +135 -135
  303. data/lib/inspec/plugins/secret.rb +15 -15
  304. data/lib/inspec/plugins/source_reader.rb +40 -40
  305. data/lib/inspec/polyfill.rb +12 -12
  306. data/lib/inspec/profile.rb +510 -510
  307. data/lib/inspec/profile_context.rb +207 -207
  308. data/lib/inspec/profile_vendor.rb +66 -66
  309. data/lib/inspec/reporters.rb +54 -54
  310. data/lib/inspec/reporters/base.rb +24 -24
  311. data/lib/inspec/reporters/cli.rb +356 -356
  312. data/lib/inspec/reporters/json.rb +116 -116
  313. data/lib/inspec/reporters/json_min.rb +48 -48
  314. data/lib/inspec/reporters/junit.rb +77 -77
  315. data/lib/inspec/require_loader.rb +33 -33
  316. data/lib/inspec/resource.rb +186 -186
  317. data/lib/inspec/rule.rb +266 -266
  318. data/lib/inspec/runner.rb +345 -345
  319. data/lib/inspec/runner_mock.rb +41 -41
  320. data/lib/inspec/runner_rspec.rb +175 -175
  321. data/lib/inspec/runtime_profile.rb +26 -26
  322. data/lib/inspec/schema.rb +213 -213
  323. data/lib/inspec/secrets.rb +19 -19
  324. data/lib/inspec/secrets/yaml.rb +30 -30
  325. data/lib/inspec/shell.rb +220 -220
  326. data/lib/inspec/shell_detector.rb +90 -90
  327. data/lib/inspec/source_reader.rb +29 -29
  328. data/lib/inspec/version.rb +8 -8
  329. data/lib/matchers/matchers.rb +339 -339
  330. data/lib/resource_support/aws.rb +44 -41
  331. data/lib/resource_support/aws/aws_backend_base.rb +12 -12
  332. data/lib/resource_support/aws/aws_backend_factory_mixin.rb +12 -12
  333. data/lib/resource_support/aws/aws_plural_resource_mixin.rb +21 -21
  334. data/lib/resource_support/aws/aws_resource_mixin.rb +66 -66
  335. data/lib/resource_support/aws/aws_singular_resource_mixin.rb +24 -24
  336. data/lib/resources/aide_conf.rb +151 -159
  337. data/lib/resources/apache.rb +48 -48
  338. data/lib/resources/apache_conf.rb +149 -156
  339. data/lib/resources/apt.rb +149 -149
  340. data/lib/resources/audit_policy.rb +63 -63
  341. data/lib/resources/auditd.rb +231 -231
  342. data/lib/resources/auditd_conf.rb +46 -55
  343. data/lib/resources/aws/aws_cloudtrail_trail.rb +77 -77
  344. data/lib/resources/aws/aws_cloudtrail_trails.rb +47 -47
  345. data/lib/resources/aws/aws_cloudwatch_alarm.rb +62 -62
  346. data/lib/resources/aws/aws_cloudwatch_log_metric_filter.rb +100 -100
  347. data/lib/resources/aws/aws_config_recorder.rb +98 -98
  348. data/lib/resources/aws/aws_ec2_instance.rb +157 -157
  349. data/lib/resources/aws/aws_iam_access_key.rb +106 -106
  350. data/lib/resources/aws/aws_iam_access_keys.rb +149 -149
  351. data/lib/resources/aws/aws_iam_group.rb +56 -56
  352. data/lib/resources/aws/aws_iam_groups.rb +52 -52
  353. data/lib/resources/aws/aws_iam_password_policy.rb +116 -116
  354. data/lib/resources/aws/aws_iam_policies.rb +53 -53
  355. data/lib/resources/aws/aws_iam_policy.rb +125 -125
  356. data/lib/resources/aws/aws_iam_role.rb +51 -51
  357. data/lib/resources/aws/aws_iam_root_user.rb +60 -60
  358. data/lib/resources/aws/aws_iam_user.rb +111 -111
  359. data/lib/resources/aws/aws_iam_users.rb +108 -108
  360. data/lib/resources/aws/aws_kms_keys.rb +53 -53
  361. data/lib/resources/aws/aws_route_table.rb +61 -61
  362. data/lib/resources/aws/aws_s3_bucket.rb +115 -115
  363. data/lib/resources/aws/aws_s3_bucket_object.rb +82 -0
  364. data/lib/resources/aws/aws_security_group.rb +93 -93
  365. data/lib/resources/aws/aws_security_groups.rb +68 -68
  366. data/lib/resources/aws/aws_sns_subscription.rb +78 -0
  367. data/lib/resources/aws/aws_sns_topic.rb +53 -53
  368. data/lib/resources/aws/aws_sns_topics.rb +56 -0
  369. data/lib/resources/aws/aws_subnet.rb +88 -88
  370. data/lib/resources/aws/aws_subnets.rb +53 -53
  371. data/lib/resources/aws/aws_vpc.rb +69 -69
  372. data/lib/resources/aws/aws_vpcs.rb +45 -45
  373. data/lib/resources/azure/azure_backend.rb +377 -377
  374. data/lib/resources/azure/azure_generic_resource.rb +59 -59
  375. data/lib/resources/azure/azure_resource_group.rb +152 -152
  376. data/lib/resources/azure/azure_virtual_machine.rb +264 -264
  377. data/lib/resources/azure/azure_virtual_machine_data_disk.rb +136 -136
  378. data/lib/resources/bash.rb +35 -35
  379. data/lib/resources/bond.rb +69 -68
  380. data/lib/resources/bridge.rb +122 -122
  381. data/lib/resources/command.rb +73 -73
  382. data/lib/resources/cpan.rb +58 -58
  383. data/lib/resources/cran.rb +64 -64
  384. data/lib/resources/crontab.rb +169 -169
  385. data/lib/resources/csv.rb +56 -60
  386. data/lib/resources/dh_params.rb +77 -82
  387. data/lib/resources/directory.rb +25 -25
  388. data/lib/resources/docker.rb +236 -236
  389. data/lib/resources/docker_container.rb +89 -89
  390. data/lib/resources/docker_image.rb +83 -83
  391. data/lib/resources/docker_object.rb +57 -57
  392. data/lib/resources/docker_service.rb +90 -90
  393. data/lib/resources/elasticsearch.rb +169 -169
  394. data/lib/resources/etc_fstab.rb +94 -101
  395. data/lib/resources/etc_group.rb +152 -152
  396. data/lib/resources/etc_hosts.rb +66 -82
  397. data/lib/resources/etc_hosts_allow_deny.rb +112 -122
  398. data/lib/resources/file.rb +298 -298
  399. data/lib/resources/filesystem.rb +31 -31
  400. data/lib/resources/firewalld.rb +143 -143
  401. data/lib/resources/gem.rb +70 -70
  402. data/lib/resources/groups.rb +215 -215
  403. data/lib/resources/grub_conf.rb +227 -237
  404. data/lib/resources/host.rb +306 -306
  405. data/lib/resources/http.rb +251 -251
  406. data/lib/resources/iis_app.rb +101 -101
  407. data/lib/resources/iis_site.rb +148 -148
  408. data/lib/resources/inetd_conf.rb +54 -62
  409. data/lib/resources/ini.rb +29 -29
  410. data/lib/resources/interface.rb +129 -129
  411. data/lib/resources/iptables.rb +80 -80
  412. data/lib/resources/json.rb +107 -117
  413. data/lib/resources/kernel_module.rb +107 -107
  414. data/lib/resources/kernel_parameter.rb +58 -58
  415. data/lib/resources/key_rsa.rb +61 -67
  416. data/lib/resources/limits_conf.rb +46 -55
  417. data/lib/resources/login_def.rb +57 -66
  418. data/lib/resources/mount.rb +88 -88
  419. data/lib/resources/mssql_session.rb +101 -101
  420. data/lib/resources/mysql.rb +81 -81
  421. data/lib/resources/mysql_conf.rb +127 -134
  422. data/lib/resources/mysql_session.rb +85 -85
  423. data/lib/resources/nginx.rb +96 -96
  424. data/lib/resources/nginx_conf.rb +226 -227
  425. data/lib/resources/npm.rb +48 -48
  426. data/lib/resources/ntp_conf.rb +51 -58
  427. data/lib/resources/oneget.rb +71 -71
  428. data/lib/resources/oracledb_session.rb +139 -139
  429. data/lib/resources/os.rb +36 -36
  430. data/lib/resources/os_env.rb +76 -76
  431. data/lib/resources/package.rb +370 -370
  432. data/lib/resources/packages.rb +111 -111
  433. data/lib/resources/parse_config.rb +112 -116
  434. data/lib/resources/passwd.rb +76 -74
  435. data/lib/resources/pip.rb +89 -89
  436. data/lib/resources/platform.rb +109 -109
  437. data/lib/resources/port.rb +771 -771
  438. data/lib/resources/postgres.rb +130 -130
  439. data/lib/resources/postgres_conf.rb +114 -121
  440. data/lib/resources/postgres_hba_conf.rb +90 -99
  441. data/lib/resources/postgres_ident_conf.rb +79 -76
  442. data/lib/resources/postgres_session.rb +71 -71
  443. data/lib/resources/powershell.rb +53 -53
  444. data/lib/resources/processes.rb +204 -204
  445. data/lib/resources/rabbitmq_conf.rb +51 -52
  446. data/lib/resources/registry_key.rb +296 -296
  447. data/lib/resources/security_policy.rb +180 -180
  448. data/lib/resources/service.rb +790 -789
  449. data/lib/resources/shadow.rb +149 -146
  450. data/lib/resources/ssh_conf.rb +97 -102
  451. data/lib/resources/ssl.rb +99 -99
  452. data/lib/resources/sys_info.rb +28 -28
  453. data/lib/resources/toml.rb +32 -32
  454. data/lib/resources/users.rb +654 -654
  455. data/lib/resources/vbscript.rb +68 -68
  456. data/lib/resources/virtualization.rb +247 -247
  457. data/lib/resources/windows_feature.rb +84 -84
  458. data/lib/resources/windows_hotfix.rb +35 -35
  459. data/lib/resources/windows_task.rb +102 -102
  460. data/lib/resources/wmi.rb +110 -110
  461. data/lib/resources/x509_certificate.rb +137 -143
  462. data/lib/resources/xinetd.rb +106 -111
  463. data/lib/resources/xml.rb +46 -46
  464. data/lib/resources/yaml.rb +43 -47
  465. data/lib/resources/yum.rb +180 -180
  466. data/lib/resources/zfs_dataset.rb +60 -60
  467. data/lib/resources/zfs_pool.rb +49 -49
  468. data/lib/source_readers/flat.rb +39 -39
  469. data/lib/source_readers/inspec.rb +75 -75
  470. data/lib/utils/command_wrapper.rb +27 -27
  471. data/lib/utils/convert.rb +12 -12
  472. data/lib/utils/database_helpers.rb +77 -77
  473. data/lib/utils/erlang_parser.rb +192 -192
  474. data/lib/utils/file_reader.rb +25 -0
  475. data/lib/utils/filter.rb +272 -272
  476. data/lib/utils/filter_array.rb +27 -27
  477. data/lib/utils/find_files.rb +44 -44
  478. data/lib/utils/hash.rb +41 -41
  479. data/lib/utils/json_log.rb +18 -18
  480. data/lib/utils/latest_version.rb +22 -22
  481. data/lib/utils/modulator.rb +12 -12
  482. data/lib/utils/nginx_parser.rb +85 -85
  483. data/lib/utils/object_traversal.rb +49 -49
  484. data/lib/utils/parser.rb +274 -274
  485. data/lib/utils/plugin_registry.rb +93 -93
  486. data/lib/utils/simpleconfig.rb +120 -120
  487. data/lib/utils/spdx.rb +13 -13
  488. data/lib/utils/spdx.txt +343 -343
  489. metadata +12 -5
@@ -1,48 +1,48 @@
1
- ---
2
- title: About the aws_vpcs Resource
3
- platform: aws
4
- ---
5
-
6
- # aws\_vpcs
7
-
8
- Use the `aws_vpcs` InSpec audit resource to test properties of some or all AWS Virtual Private Clouds (VPCs).
9
-
10
- A VPC is a networking construct that provides an isolated environment. A VPC is contained in a geographic region, but spans availability zones in that region. A VPC may have multiple subnets, internet gateways, and other networking resources. Computing resources--such as EC2 instances--reside on subnets within the VPC.
11
-
12
- Each VPC is uniquely identified by its VPC ID. In addition, each VPC has a non-unique CIDR IP Address range (such as 10.0.0.0/16) which it manages.
13
-
14
- Every AWS account has at least one VPC, the "default" VPC, in every region.
15
-
16
- <br>
17
-
18
- ## Syntax
19
-
20
- An `aws_vpcs` resource block uses an optional filter to select a group of VPCs and then tests that group.
21
-
22
- # The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches.
23
- describe aws_vpcs do
24
- it { should exist }
25
- end
26
-
27
- <br>
28
-
29
- ## Examples
30
-
31
- The following examples show how to use this InSpec audit resource.
32
-
33
- As this is the initial release of `aws_vpcs`, its limited functionality precludes examples.
34
-
35
- <br>
36
-
37
- ## Matchers
38
-
39
- This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
40
-
41
- ### exists
42
-
43
- The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches.
44
-
45
- # You will always have at least one VPC
46
- describe aws_vpcs
47
- it { should exist }
48
- end
1
+ ---
2
+ title: About the aws_vpcs Resource
3
+ platform: aws
4
+ ---
5
+
6
+ # aws\_vpcs
7
+
8
+ Use the `aws_vpcs` InSpec audit resource to test properties of some or all AWS Virtual Private Clouds (VPCs).
9
+
10
+ A VPC is a networking construct that provides an isolated environment. A VPC is contained in a geographic region, but spans availability zones in that region. A VPC may have multiple subnets, internet gateways, and other networking resources. Computing resources--such as EC2 instances--reside on subnets within the VPC.
11
+
12
+ Each VPC is uniquely identified by its VPC ID. In addition, each VPC has a non-unique CIDR IP Address range (such as 10.0.0.0/16) which it manages.
13
+
14
+ Every AWS account has at least one VPC, the "default" VPC, in every region.
15
+
16
+ <br>
17
+
18
+ ## Syntax
19
+
20
+ An `aws_vpcs` resource block uses an optional filter to select a group of VPCs and then tests that group.
21
+
22
+ # The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches.
23
+ describe aws_vpcs do
24
+ it { should exist }
25
+ end
26
+
27
+ <br>
28
+
29
+ ## Examples
30
+
31
+ The following examples show how to use this InSpec audit resource.
32
+
33
+ As this is the initial release of `aws_vpcs`, its limited functionality precludes examples.
34
+
35
+ <br>
36
+
37
+ ## Matchers
38
+
39
+ This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
40
+
41
+ ### exists
42
+
43
+ The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches.
44
+
45
+ # You will always have at least one VPC
46
+ describe aws_vpcs
47
+ it { should exist }
48
+ end
@@ -1,171 +1,171 @@
1
- ---
2
- title: About the azure_generic_resource Resource
3
- ---
4
-
5
- # azure\_generic\_resource
6
-
7
- Use the `azure_generic_resource` InSpec audit resource to test any valid Azure Resource. This is very useful if you need to test something that we do not yet have a specific Inspec resource for.
8
-
9
- ## Syntax
10
-
11
- describe azure_generic_resource(group_name: 'MyResourceGroup', name: 'MyResource') do
12
- its('property') { should eq 'value' }
13
- end
14
-
15
- where
16
-
17
- * `MyResourceGroup` is the name of the resource group that contains the Azure Resource to be validated
18
- * `MyResource` is the name of the resource that needs to be checked
19
- * `property` This generic resource dynamically creates the properties on the fly based on the type of resource that has been targetted.
20
- * `value` is the expected output from the chosen property
21
-
22
- <br>
23
-
24
- ## Parameters
25
-
26
- * `group_name`, `name`, `apiversion`, `type`
27
-
28
- <br>
29
-
30
- ## Parameter Examples
31
-
32
- The options that can be passed to the resource are as follows.
33
-
34
- ### group_name (required)
35
-
36
- Use this parameter to define the Azure Resource Group to be tested.
37
-
38
- describe azure_virtual_machine_data_disk(group_name: 'InSpec-Azure') do
39
- ...
40
- end
41
-
42
- ### name
43
-
44
- Use this parameter to define the name of the Azure resource to test.
45
-
46
- describe azure_virtual_machine_data_disk(group_name: 'InSpec-Azure', name: 'Windows-Internal-VM') do
47
- ...
48
- end
49
-
50
- ### apiversion
51
-
52
- The API Version to use when querying the resource. Defaults to the latest version for the resource.
53
-
54
- describe azure_virtual_machine_data_disk(group_name: 'InSpec-Azure', name: 'Windows-Internal-VM', apiversion: '2.0') do
55
- ...
56
- end
57
-
58
- ### type
59
-
60
- Use this parameter to define the type of resources to test.
61
-
62
- describe azure_virtual_machine_data_disk(group_name: 'InSpec-Azure', name: 'Windows-Internal-VM', apiversion: '2.0', type: 'Microsoft.Compute/virtualMachines') do
63
- ...
64
- end
65
-
66
- These options can also be set using the environment variables:
67
-
68
- * `AZURE_RESOURCE_GROUP_NAME`
69
- * `AZURE_RESOURCE_NAME`
70
- * `AZURE_RESOURCE_TYPE`
71
- * `AZURE_RESOURCE_API_VERSION`
72
-
73
- When the options have been set as well as the environment variables, the environment variables take priority.
74
-
75
- <br>
76
-
77
- ## Parameter Example
78
-
79
- describe azure_generic_resource(group_name: 'Inspec-Azure', name: 'Linux-Internal-VM', apiversion: '2.0') do
80
- its('location') { should eq 'westeurope' }
81
- end
82
-
83
- <br>
84
-
85
- ## Properties
86
-
87
- The properties that can be tested are entirely dependent on the Azure Resource that is under scrutiny. That means the properties vary. The best way to see what is available please use the [Azure Resources Portal](https://resources.azure.com) to select the resource you are interested in and see what can be tested.
88
-
89
- This resource allows you to test _any_ valid Azure Resource. The trade off for this is that the language to check each item is not as natural as it would be for a native Inspec resource.
90
-
91
- <br>
92
-
93
- ## Property Examples
94
-
95
- The following examples show how to use some of the InSpec audit properties:
96
-
97
- ### Tests the virtual machine's location
98
-
99
- its('location') { should cmp 'westeurope' }
100
-
101
- ### Tests for the presence of a specified address prefix
102
-
103
- its('properties.addressSpace.addressPrefixes') { should include '10.1.1.0/24' }
104
-
105
- ### Tests that virtual machine was created from the correct disk
106
-
107
- its('properties.creationData.createOption') { should eq 'FromImage' }
108
-
109
- ### Tests that the image is Ubuntu
110
-
111
- its('properties.creationData.imageReference.id') { should match 'Canonical' }
112
- its('properties.creationData.imageReference.id') { should match 'UbuntuServer' }
113
- its('properties.creationData.imageReference.id') { should match '16.04.0-LTS' }
114
-
115
- ### Tests the disk size
116
-
117
- its('properties.diskSizeGB') { should be > 25 }
118
-
119
- ### Tests the disk state
120
-
121
- its('properties.diskState') { should cmp 'Attached' }
122
-
123
- ### Tests that there are no custom DNS settings
124
-
125
- its('properties.dnsSettings.dnsServers.count') { should eq 0 }
126
- its('properties.dnsSettings.appliedDnsServers.count') { should eq 0 }
127
-
128
- ### Tests that the NIC is connected to the correct machine
129
-
130
- its('properties.virtualMachine.id') { should match 'Linux-External-VM' }
131
-
132
- ### Tests that the blob and file services are enabled
133
-
134
- its('properties.encryption.services.blob.enabled') { should be true }
135
- its('properties.encryption.services.file.enabled') { should be true }
136
- its('properties.encryption.keySource') { should cmp 'Microsoft.Storage' }
137
-
138
- ### Test the hardware profile
139
-
140
- its('properties.hardwareProfile.vmSize') { should cmp 'Standard_DS2_v2' }
141
-
142
- ### Test the network interfaces
143
-
144
- its('properties.networkProfile.networkInterfaces.count') { should eq 1 }
145
-
146
- ### Test the authentication and OS type
147
-
148
- its('properties.osProfile.computerName') { should eq 'linux-external-1' }
149
- its('properties.osProfile.adminUsername') { should eq 'azure' }
150
- its('properties.osProfile.linuxConfiguration.disablePasswordAuthentication') { should be true }
151
-
152
- ### Test that the tags are properly set
153
-
154
- it { should have_tags }
155
- its('tag_count') { should be 1 }
156
- its('tags') { should include 'Description' }
157
- its('Description_tag') { should match 'Externally facing' }
158
-
159
- <br>
160
-
161
- ## Matchers
162
-
163
- This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
164
-
165
- <br>
166
-
167
- ## References
168
-
169
- Please see the integration tests for in depth examples of how this resource can be used.
170
-
171
- [Inspec Integration Tests for Azure Generic Resources](https://github.com/chef/inspec/tree/master/test/azure/verify/controls)
1
+ ---
2
+ title: About the azure_generic_resource Resource
3
+ ---
4
+
5
+ # azure\_generic\_resource
6
+
7
+ Use the `azure_generic_resource` InSpec audit resource to test any valid Azure Resource. This is very useful if you need to test something that we do not yet have a specific Inspec resource for.
8
+
9
+ ## Syntax
10
+
11
+ describe azure_generic_resource(group_name: 'MyResourceGroup', name: 'MyResource') do
12
+ its('property') { should eq 'value' }
13
+ end
14
+
15
+ where
16
+
17
+ * `MyResourceGroup` is the name of the resource group that contains the Azure Resource to be validated
18
+ * `MyResource` is the name of the resource that needs to be checked
19
+ * `property` This generic resource dynamically creates the properties on the fly based on the type of resource that has been targeted.
20
+ * `value` is the expected output from the chosen property
21
+
22
+ <br>
23
+
24
+ ## Parameters
25
+
26
+ * `group_name`, `name`, `apiversion`, `type`
27
+
28
+ <br>
29
+
30
+ ## Parameter Examples
31
+
32
+ The options that can be passed to the resource are as follows.
33
+
34
+ ### group_name (required)
35
+
36
+ Use this parameter to define the Azure Resource Group to be tested.
37
+
38
+ describe azure_virtual_machine_data_disk(group_name: 'InSpec-Azure') do
39
+ ...
40
+ end
41
+
42
+ ### name
43
+
44
+ Use this parameter to define the name of the Azure resource to test.
45
+
46
+ describe azure_virtual_machine_data_disk(group_name: 'InSpec-Azure', name: 'Windows-Internal-VM') do
47
+ ...
48
+ end
49
+
50
+ ### apiversion
51
+
52
+ The API Version to use when querying the resource. Defaults to the latest version for the resource.
53
+
54
+ describe azure_virtual_machine_data_disk(group_name: 'InSpec-Azure', name: 'Windows-Internal-VM', apiversion: '2.0') do
55
+ ...
56
+ end
57
+
58
+ ### type
59
+
60
+ Use this parameter to define the type of resources to test.
61
+
62
+ describe azure_virtual_machine_data_disk(group_name: 'InSpec-Azure', name: 'Windows-Internal-VM', apiversion: '2.0', type: 'Microsoft.Compute/virtualMachines') do
63
+ ...
64
+ end
65
+
66
+ These options can also be set using the environment variables:
67
+
68
+ * `AZURE_RESOURCE_GROUP_NAME`
69
+ * `AZURE_RESOURCE_NAME`
70
+ * `AZURE_RESOURCE_TYPE`
71
+ * `AZURE_RESOURCE_API_VERSION`
72
+
73
+ When the options have been set as well as the environment variables, the environment variables take priority.
74
+
75
+ <br>
76
+
77
+ ## Parameter Example
78
+
79
+ describe azure_generic_resource(group_name: 'Inspec-Azure', name: 'Linux-Internal-VM', apiversion: '2.0') do
80
+ its('location') { should eq 'westeurope' }
81
+ end
82
+
83
+ <br>
84
+
85
+ ## Properties
86
+
87
+ The properties that can be tested are entirely dependent on the Azure Resource that is under scrutiny. That means the properties vary. The best way to see what is available please use the [Azure Resources Portal](https://resources.azure.com) to select the resource you are interested in and see what can be tested.
88
+
89
+ This resource allows you to test _any_ valid Azure Resource. The trade off for this is that the language to check each item is not as natural as it would be for a native Inspec resource.
90
+
91
+ <br>
92
+
93
+ ## Property Examples
94
+
95
+ The following examples show how to use some of the InSpec audit properties:
96
+
97
+ ### Tests the virtual machine's location
98
+
99
+ its('location') { should cmp 'westeurope' }
100
+
101
+ ### Tests for the presence of a specified address prefix
102
+
103
+ its('properties.addressSpace.addressPrefixes') { should include '10.1.1.0/24' }
104
+
105
+ ### Tests that virtual machine was created from the correct disk
106
+
107
+ its('properties.creationData.createOption') { should eq 'FromImage' }
108
+
109
+ ### Tests that the image is Ubuntu
110
+
111
+ its('properties.creationData.imageReference.id') { should match 'Canonical' }
112
+ its('properties.creationData.imageReference.id') { should match 'UbuntuServer' }
113
+ its('properties.creationData.imageReference.id') { should match '16.04.0-LTS' }
114
+
115
+ ### Tests the disk size
116
+
117
+ its('properties.diskSizeGB') { should be > 25 }
118
+
119
+ ### Tests the disk state
120
+
121
+ its('properties.diskState') { should cmp 'Attached' }
122
+
123
+ ### Tests that there are no custom DNS settings
124
+
125
+ its('properties.dnsSettings.dnsServers.count') { should eq 0 }
126
+ its('properties.dnsSettings.appliedDnsServers.count') { should eq 0 }
127
+
128
+ ### Tests that the NIC is connected to the correct machine
129
+
130
+ its('properties.virtualMachine.id') { should match 'Linux-External-VM' }
131
+
132
+ ### Tests that the blob and file services are enabled
133
+
134
+ its('properties.encryption.services.blob.enabled') { should be true }
135
+ its('properties.encryption.services.file.enabled') { should be true }
136
+ its('properties.encryption.keySource') { should cmp 'Microsoft.Storage' }
137
+
138
+ ### Test the hardware profile
139
+
140
+ its('properties.hardwareProfile.vmSize') { should cmp 'Standard_DS2_v2' }
141
+
142
+ ### Test the network interfaces
143
+
144
+ its('properties.networkProfile.networkInterfaces.count') { should eq 1 }
145
+
146
+ ### Test the authentication and OS type
147
+
148
+ its('properties.osProfile.computerName') { should eq 'linux-external-1' }
149
+ its('properties.osProfile.adminUsername') { should eq 'azure' }
150
+ its('properties.osProfile.linuxConfiguration.disablePasswordAuthentication') { should be true }
151
+
152
+ ### Test that the tags are properly set
153
+
154
+ it { should have_tags }
155
+ its('tag_count') { should be 1 }
156
+ its('tags') { should include 'Description' }
157
+ its('Description_tag') { should match 'Externally facing' }
158
+
159
+ <br>
160
+
161
+ ## Matchers
162
+
163
+ This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
164
+
165
+ <br>
166
+
167
+ ## References
168
+
169
+ Please see the integration tests for in depth examples of how this resource can be used.
170
+
171
+ [Inspec Integration Tests for Azure Generic Resources](https://github.com/chef/inspec/tree/master/test/azure/verify/controls)
@@ -1,284 +1,284 @@
1
- ---
2
- title: About the azure_resource_group_resource_counts Resource
3
- platform: azure
4
- ---
5
-
6
- # azure\_resource\_group\_resource\_counts
7
-
8
- Use the `azure_resource_group_resource_counts` InSpec audit resource to check the number of Azure resources in a resource group.
9
-
10
- ## Syntax
11
-
12
- The name of the resource group is specified as a parameter on the resource:
13
-
14
- describe azure_resource_group(name: 'MyResourceGroup') do
15
- its('property') { should eq 'value' }
16
- end
17
-
18
- where
19
-
20
- * `MyResourceGroup` is the name of the resource group being interrogated
21
- * `property` is one a resource property
22
- * `value` is the expected output from the matcher
23
-
24
- ## Examples
25
-
26
- The following examples show how to use this InSpec audit resource:
27
-
28
- ### Ensure the Resource Group has the correct number of resources
29
-
30
- describe azure_resource_group_resource_counts(name: 'Inspec-Azure') do
31
- its('total') { should eq 7}
32
- end
33
-
34
- ### Ensure that the Resource Group contains the correct resources
35
-
36
- describe azure_resource_group_resource_counts(name: 'Inspec-Azure') do
37
- its('total') { should eq 7 }
38
- its('vm_count') { should eq 2 }
39
- its('nic_count') { should eq 2 }
40
- its('public_ip_count') { should eq 1 }
41
- its('sa_count') { should eq 1 }
42
- its('vnet_count') { should eq 1 }
43
- end
44
-
45
- <br>
46
-
47
- ## Parameters
48
-
49
- * `group_name`, `name`
50
-
51
- ## Parameter Examples
52
-
53
- The options that can be passed to the resource are as follows.
54
-
55
- ### group_name (required)
56
-
57
- Use this parameter to define the Azure Resource Group to be tested.
58
-
59
- describe azure_virtual_machine_data_disk(group_name: 'InSpec-Azure') do
60
- ...
61
- end
62
-
63
- ### name
64
-
65
- Use this parameter to define the name of the Azure resource to test.
66
-
67
- describe azure_virtual_machine_data_disk(group_name: 'InSpec-Azure', name: 'Windows-Internal-VM') do
68
- ...
69
- end
70
-
71
- If both `group_name` and `name` is set then `name` takes priority
72
-
73
- These options can also be set using the environment variables:
74
-
75
- * `AZURE_RESOURCE_GROUP_NAME`
76
- * `AZURE_RESOURCE_NAME`
77
-
78
- When the options have been set as well as the environment variables, the environment variables take priority.
79
-
80
- <br>
81
-
82
- ## Parameter Example
83
-
84
- describe azure_generic_resource(group_name: 'Inspec-Azure', name: 'Linux-Internal-VM') do
85
- its('location') { should eq 'westeurope' }
86
- end
87
-
88
- <br>
89
-
90
- ## Properties
91
-
92
- * `name`, `location` ,`id`, `provisioning_state`, `subscription_id`, `total`, `nic_count`, `vm_count`, `extension_count`, `vnet_count`, `sa_count`, `public_ip_count`,`managed_disk_image_count`, `managed_disk_count`, `tag_count`
93
-
94
- <br>
95
-
96
- ## Property Examples
97
-
98
- This InSpec audit resource has the following properties:
99
-
100
- ### name
101
-
102
- Tests the name of the resource group.
103
-
104
- its('name') { should cmp 'Inspec-Azure' }
105
-
106
- ### location
107
-
108
- Tests where in Azure the resource group is located.
109
-
110
- its('location') { should cmp 'westeurope' }
111
-
112
- ### id
113
-
114
- Tests the full qualified ID of the resource group.
115
-
116
- This takes the format: `/subscriptions/<SUBSCRIPTION_ID>/resourceGroups/<RESOURCE_GROUP_NAME>`.
117
-
118
- its('id') { should cmp 'FQDN' }
119
-
120
- ### provisioning_state
121
-
122
- Tests thehe provisioning state of the resource group.
123
-
124
- its('provisioning_state') { should cmp 'Succeeded' }
125
-
126
- ### total
127
-
128
- Tests the total number of resources in the resource group.
129
-
130
- its('total') { should eq 13 }
131
-
132
- ### nic_count
133
-
134
- Tests the number of network interface cards in the resource group.
135
-
136
- it { should have_nics }
137
- its('nic_count') { should eq 3 }
138
-
139
- ### vm_count
140
-
141
- Tests the number of virtual machines in the resource group.
142
-
143
- its('vm_count') { should eq 5 }
144
-
145
- ### vnet_count
146
-
147
- Tests the number of virtual networks in the resource group.
148
-
149
- its('vnet_count') { should eq 5 }
150
-
151
- ### sa_count
152
-
153
- Tests the number of storage accounts in the resource group.
154
-
155
- its('sa_count') { should eq 5 }
156
-
157
- ### public\_ip\_count
158
-
159
- Tests the number of Public IP Addresses in the resource group.
160
-
161
- its('public_ip_count') { should eq 5 }
162
-
163
- ### managed\_disk\_image\_count
164
-
165
- Tests the number of managed disk images that are in the resource group.
166
-
167
- Managed disks are created from disk images and then attached to the machines. Generally, the images are created from a base image or a custom image (e.g., Packer)
168
-
169
- its('managed_disk_image_count') { should eq 5 }
170
-
171
- ### managed\_disk\_count
172
-
173
- Tests the number of managed disks in the resource group.
174
-
175
- If a resource group contains one virtual machine with an OS disk and 2 data disks that are all Managed Disks, then the count would be 3.
176
-
177
- its('managed_disk_count') { should eq 3 }
178
-
179
- <br>
180
-
181
- ## Matchers
182
-
183
- This resource has a number of special matchers that provide a simple way to test if a specific Azure Resource type exists in the resource group.
184
-
185
- For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
186
-
187
- ### have_nics
188
-
189
- Use this matcher to test if network interfaces exist.
190
-
191
- it { should have_ncis }
192
-
193
- ### have_vms
194
-
195
- Use this matcher to test that virtual machines exist.
196
-
197
- it { should have_vms }
198
-
199
- ### have_extensions
200
-
201
- Use this matcher to test for virtual machine extensions.
202
-
203
- it { should have_extensions }
204
-
205
- ### have_nsgs
206
-
207
- Use this matcher to test that network security groups exist.
208
-
209
- it { should have_nsgs }
210
-
211
- ### have_vnets
212
-
213
- Use this matcher to test that virtual networks exist.
214
-
215
- it { should have_vnets }
216
-
217
- ### have\_managed\_disks
218
-
219
- Use this matcher to test that managed disks exist.
220
-
221
- it { should have_managed_disks }
222
-
223
- ### have\_managed\_disk\_images
224
-
225
- Use this matcher to test that managed disk images exist.
226
-
227
- it { should have_managed_disk_images }
228
-
229
- ### have_sas
230
-
231
- Use this matcher to test that storage accounts exist.
232
-
233
- it { should have_sas }
234
-
235
- ### have\_public\_ips
236
-
237
- Use this matcher to test that public ips exist.
238
-
239
- it { should have_public_ips }
240
-
241
- ## Tags
242
-
243
- It is possible to test the tags that have been assigned to the resource. There are some properties for checking that a resource has tags, that it has the correct number of tags, and that the correct tags are assigned.
244
-
245
- ### have\_tags
246
-
247
- This is a simple test to see if the machine has tags assigned to it or not.
248
-
249
- it { should have_tags }
250
-
251
- ### tag\_count
252
-
253
- Returns the number of tags that are assigned to the resource
254
-
255
- its ('tag_count') { should eq 2 }
256
-
257
- ### tags
258
-
259
- It is possible to check if a specific tag has been set on the resource.
260
-
261
- its('tags') { should include 'owner' }
262
-
263
- ### xxx\_tag
264
-
265
- To get the value of the tag, some properties are created from the tags themselves.
266
-
267
- For example, if the following tag is set on a resource:
268
-
269
- * owner: JG Jinglehimerschmidt
270
-
271
- Then a property is available called `Owner_tag`.
272
-
273
- its('owner_tag') { should cmp 'JG Jinglehimerschmidt' }
274
-
275
- Note: The tag name is case sensitive which makes the test case sensitive. E.g. `owner_tag` does not equal `Owner_tag`.
276
-
277
- <br>
278
-
279
- ## References
280
-
281
- For more information on Azure Ruby SDK resources, see:
282
-
283
- * [Azure Ruby SDK - Resources](https://github.com/Azure/azure-sdk-for-ruby/tree/master/management/azure_mgmt_resources)
284
- * [Resource Group](https://github.com/chef/inspec/blob/fc990346f2438690f0ac36a9f6606e61574a79b8/test/azure/verify/controls/resource_group.rb)
1
+ ---
2
+ title: About the azure_resource_group_resource_counts Resource
3
+ platform: azure
4
+ ---
5
+
6
+ # azure\_resource\_group\_resource\_counts
7
+
8
+ Use the `azure_resource_group_resource_counts` InSpec audit resource to check the number of Azure resources in a resource group.
9
+
10
+ ## Syntax
11
+
12
+ The name of the resource group is specified as a parameter on the resource:
13
+
14
+ describe azure_resource_group(name: 'MyResourceGroup') do
15
+ its('property') { should eq 'value' }
16
+ end
17
+
18
+ where
19
+
20
+ * `MyResourceGroup` is the name of the resource group being interrogated
21
+ * `property` is one a resource property
22
+ * `value` is the expected output from the matcher
23
+
24
+ ## Examples
25
+
26
+ The following examples show how to use this InSpec audit resource:
27
+
28
+ ### Ensure the Resource Group has the correct number of resources
29
+
30
+ describe azure_resource_group_resource_counts(name: 'Inspec-Azure') do
31
+ its('total') { should eq 7}
32
+ end
33
+
34
+ ### Ensure that the Resource Group contains the correct resources
35
+
36
+ describe azure_resource_group_resource_counts(name: 'Inspec-Azure') do
37
+ its('total') { should eq 7 }
38
+ its('vm_count') { should eq 2 }
39
+ its('nic_count') { should eq 2 }
40
+ its('public_ip_count') { should eq 1 }
41
+ its('sa_count') { should eq 1 }
42
+ its('vnet_count') { should eq 1 }
43
+ end
44
+
45
+ <br>
46
+
47
+ ## Parameters
48
+
49
+ * `group_name`, `name`
50
+
51
+ ## Parameter Examples
52
+
53
+ The options that can be passed to the resource are as follows.
54
+
55
+ ### group_name (required)
56
+
57
+ Use this parameter to define the Azure Resource Group to be tested.
58
+
59
+ describe azure_virtual_machine_data_disk(group_name: 'InSpec-Azure') do
60
+ ...
61
+ end
62
+
63
+ ### name
64
+
65
+ Use this parameter to define the name of the Azure resource to test.
66
+
67
+ describe azure_virtual_machine_data_disk(group_name: 'InSpec-Azure', name: 'Windows-Internal-VM') do
68
+ ...
69
+ end
70
+
71
+ If both `group_name` and `name` is set then `name` takes priority
72
+
73
+ These options can also be set using the environment variables:
74
+
75
+ * `AZURE_RESOURCE_GROUP_NAME`
76
+ * `AZURE_RESOURCE_NAME`
77
+
78
+ When the options have been set as well as the environment variables, the environment variables take priority.
79
+
80
+ <br>
81
+
82
+ ## Parameter Example
83
+
84
+ describe azure_generic_resource(group_name: 'Inspec-Azure', name: 'Linux-Internal-VM') do
85
+ its('location') { should eq 'westeurope' }
86
+ end
87
+
88
+ <br>
89
+
90
+ ## Properties
91
+
92
+ * `name`, `location` ,`id`, `provisioning_state`, `subscription_id`, `total`, `nic_count`, `vm_count`, `extension_count`, `vnet_count`, `sa_count`, `public_ip_count`,`managed_disk_image_count`, `managed_disk_count`, `tag_count`
93
+
94
+ <br>
95
+
96
+ ## Property Examples
97
+
98
+ This InSpec audit resource has the following properties:
99
+
100
+ ### name
101
+
102
+ Tests the name of the resource group.
103
+
104
+ its('name') { should cmp 'Inspec-Azure' }
105
+
106
+ ### location
107
+
108
+ Tests where in Azure the resource group is located.
109
+
110
+ its('location') { should cmp 'westeurope' }
111
+
112
+ ### id
113
+
114
+ Tests the full qualified ID of the resource group.
115
+
116
+ This takes the format: `/subscriptions/<SUBSCRIPTION_ID>/resourceGroups/<RESOURCE_GROUP_NAME>`.
117
+
118
+ its('id') { should cmp 'FQDN' }
119
+
120
+ ### provisioning_state
121
+
122
+ Tests the provisioning state of the resource group.
123
+
124
+ its('provisioning_state') { should cmp 'Succeeded' }
125
+
126
+ ### total
127
+
128
+ Tests the total number of resources in the resource group.
129
+
130
+ its('total') { should eq 13 }
131
+
132
+ ### nic_count
133
+
134
+ Tests the number of network interface cards in the resource group.
135
+
136
+ it { should have_nics }
137
+ its('nic_count') { should eq 3 }
138
+
139
+ ### vm_count
140
+
141
+ Tests the number of virtual machines in the resource group.
142
+
143
+ its('vm_count') { should eq 5 }
144
+
145
+ ### vnet_count
146
+
147
+ Tests the number of virtual networks in the resource group.
148
+
149
+ its('vnet_count') { should eq 5 }
150
+
151
+ ### sa_count
152
+
153
+ Tests the number of storage accounts in the resource group.
154
+
155
+ its('sa_count') { should eq 5 }
156
+
157
+ ### public\_ip\_count
158
+
159
+ Tests the number of Public IP Addresses in the resource group.
160
+
161
+ its('public_ip_count') { should eq 5 }
162
+
163
+ ### managed\_disk\_image\_count
164
+
165
+ Tests the number of managed disk images that are in the resource group.
166
+
167
+ Managed disks are created from disk images and then attached to the machines. Generally, the images are created from a base image or a custom image (e.g., Packer)
168
+
169
+ its('managed_disk_image_count') { should eq 5 }
170
+
171
+ ### managed\_disk\_count
172
+
173
+ Tests the number of managed disks in the resource group.
174
+
175
+ If a resource group contains one virtual machine with an OS disk and 2 data disks that are all Managed Disks, then the count would be 3.
176
+
177
+ its('managed_disk_count') { should eq 3 }
178
+
179
+ <br>
180
+
181
+ ## Matchers
182
+
183
+ This resource has a number of special matchers that provide a simple way to test if a specific Azure Resource type exists in the resource group.
184
+
185
+ For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
186
+
187
+ ### have_nics
188
+
189
+ Use this matcher to test if network interfaces exist.
190
+
191
+ it { should have_nics }
192
+
193
+ ### have_vms
194
+
195
+ Use this matcher to test that virtual machines exist.
196
+
197
+ it { should have_vms }
198
+
199
+ ### have_extensions
200
+
201
+ Use this matcher to test for virtual machine extensions.
202
+
203
+ it { should have_extensions }
204
+
205
+ ### have_nsgs
206
+
207
+ Use this matcher to test that network security groups exist.
208
+
209
+ it { should have_nsgs }
210
+
211
+ ### have_vnets
212
+
213
+ Use this matcher to test that virtual networks exist.
214
+
215
+ it { should have_vnets }
216
+
217
+ ### have\_managed\_disks
218
+
219
+ Use this matcher to test that managed disks exist.
220
+
221
+ it { should have_managed_disks }
222
+
223
+ ### have\_managed\_disk\_images
224
+
225
+ Use this matcher to test that managed disk images exist.
226
+
227
+ it { should have_managed_disk_images }
228
+
229
+ ### have_sas
230
+
231
+ Use this matcher to test that storage accounts exist.
232
+
233
+ it { should have_sas }
234
+
235
+ ### have\_public\_ips
236
+
237
+ Use this matcher to test that public ips exist.
238
+
239
+ it { should have_public_ips }
240
+
241
+ ## Tags
242
+
243
+ It is possible to test the tags that have been assigned to the resource. There are some properties for checking that a resource has tags, that it has the correct number of tags, and that the correct tags are assigned.
244
+
245
+ ### have\_tags
246
+
247
+ This is a simple test to see if the machine has tags assigned to it or not.
248
+
249
+ it { should have_tags }
250
+
251
+ ### tag\_count
252
+
253
+ Returns the number of tags that are assigned to the resource
254
+
255
+ its ('tag_count') { should eq 2 }
256
+
257
+ ### tags
258
+
259
+ It is possible to check if a specific tag has been set on the resource.
260
+
261
+ its('tags') { should include 'owner' }
262
+
263
+ ### xxx\_tag
264
+
265
+ To get the value of the tag, some properties are created from the tags themselves.
266
+
267
+ For example, if the following tag is set on a resource:
268
+
269
+ * owner: JG Jinglehimerschmidt
270
+
271
+ Then a property is available called `Owner_tag`.
272
+
273
+ its('owner_tag') { should cmp 'JG Jinglehimerschmidt' }
274
+
275
+ Note: The tag name is case sensitive which makes the test case sensitive. E.g. `owner_tag` does not equal `Owner_tag`.
276
+
277
+ <br>
278
+
279
+ ## References
280
+
281
+ For more information on Azure Ruby SDK resources, see:
282
+
283
+ * [Azure Ruby SDK - Resources](https://github.com/Azure/azure-sdk-for-ruby/tree/master/management/azure_mgmt_resources)
284
+ * [Resource Group](https://github.com/chef/inspec/blob/fc990346f2438690f0ac36a9f6606e61574a79b8/test/azure/verify/controls/resource_group.rb)