inspec 2.1.80 → 2.1.81

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 (510) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +101 -101
  3. data/CHANGELOG.md +3177 -3172
  4. data/Gemfile +56 -56
  5. data/LICENSE +14 -14
  6. data/MAINTAINERS.md +33 -33
  7. data/MAINTAINERS.toml +52 -52
  8. data/README.md +453 -453
  9. data/Rakefile +349 -349
  10. data/bin/inspec +12 -12
  11. data/docs/.gitignore +2 -2
  12. data/docs/README.md +40 -40
  13. data/docs/dev/control-eval.md +61 -61
  14. data/docs/dsl_inspec.md +258 -258
  15. data/docs/dsl_resource.md +100 -100
  16. data/docs/glossary.md +99 -99
  17. data/docs/habitat.md +191 -191
  18. data/docs/inspec_and_friends.md +114 -114
  19. data/docs/matchers.md +169 -169
  20. data/docs/migration.md +293 -293
  21. data/docs/platforms.md +118 -118
  22. data/docs/plugin_kitchen_inspec.md +50 -50
  23. data/docs/profiles.md +378 -378
  24. data/docs/reporters.md +105 -105
  25. data/docs/resources/aide_conf.md.erb +75 -75
  26. data/docs/resources/apache.md.erb +67 -67
  27. data/docs/resources/apache_conf.md.erb +68 -68
  28. data/docs/resources/apt.md.erb +71 -71
  29. data/docs/resources/audit_policy.md.erb +47 -47
  30. data/docs/resources/auditd.md.erb +79 -79
  31. data/docs/resources/auditd_conf.md.erb +68 -68
  32. data/docs/resources/aws_cloudtrail_trail.md.erb +155 -155
  33. data/docs/resources/aws_cloudtrail_trails.md.erb +86 -86
  34. data/docs/resources/aws_cloudwatch_alarm.md.erb +91 -91
  35. data/docs/resources/aws_cloudwatch_log_metric_filter.md.erb +154 -154
  36. data/docs/resources/aws_config_delivery_channel.md.erb +101 -101
  37. data/docs/resources/aws_config_recorder.md.erb +86 -86
  38. data/docs/resources/aws_ec2_instance.md.erb +112 -112
  39. data/docs/resources/aws_ec2_instances.md.erb +79 -79
  40. data/docs/resources/aws_iam_access_key.md.erb +129 -129
  41. data/docs/resources/aws_iam_access_keys.md.erb +204 -204
  42. data/docs/resources/aws_iam_group.md.erb +64 -64
  43. data/docs/resources/aws_iam_groups.md.erb +49 -49
  44. data/docs/resources/aws_iam_password_policy.md.erb +82 -82
  45. data/docs/resources/aws_iam_policies.md.erb +87 -87
  46. data/docs/resources/aws_iam_policy.md.erb +245 -245
  47. data/docs/resources/aws_iam_role.md.erb +69 -69
  48. data/docs/resources/aws_iam_root_user.md.erb +76 -76
  49. data/docs/resources/aws_iam_user.md.erb +120 -120
  50. data/docs/resources/aws_iam_users.md.erb +279 -279
  51. data/docs/resources/aws_kms_key.md.erb +177 -177
  52. data/docs/resources/aws_kms_keys.md.erb +89 -89
  53. data/docs/resources/aws_rds_instance.md.erb +66 -66
  54. data/docs/resources/aws_route_table.md.erb +53 -53
  55. data/docs/resources/aws_route_tables.md.erb +55 -55
  56. data/docs/resources/aws_s3_bucket.md.erb +146 -146
  57. data/docs/resources/aws_s3_bucket_object.md.erb +89 -89
  58. data/docs/resources/aws_s3_buckets.md.erb +59 -59
  59. data/docs/resources/aws_security_group.md.erb +296 -296
  60. data/docs/resources/aws_security_groups.md.erb +97 -97
  61. data/docs/resources/aws_sns_subscription.md.erb +130 -130
  62. data/docs/resources/aws_sns_topic.md.erb +69 -69
  63. data/docs/resources/aws_sns_topics.md.erb +58 -58
  64. data/docs/resources/aws_subnet.md.erb +140 -140
  65. data/docs/resources/aws_subnets.md.erb +132 -132
  66. data/docs/resources/aws_vpc.md.erb +125 -125
  67. data/docs/resources/aws_vpcs.md.erb +125 -125
  68. data/docs/resources/azure_generic_resource.md.erb +171 -171
  69. data/docs/resources/azure_resource_group.md.erb +284 -284
  70. data/docs/resources/azure_virtual_machine.md.erb +347 -347
  71. data/docs/resources/azure_virtual_machine_data_disk.md.erb +224 -224
  72. data/docs/resources/bash.md.erb +75 -75
  73. data/docs/resources/bond.md.erb +90 -90
  74. data/docs/resources/bridge.md.erb +57 -57
  75. data/docs/resources/bsd_service.md.erb +67 -67
  76. data/docs/resources/chocolatey_package.md.erb +58 -58
  77. data/docs/resources/command.md.erb +138 -138
  78. data/docs/resources/cpan.md.erb +79 -79
  79. data/docs/resources/cran.md.erb +64 -64
  80. data/docs/resources/crontab.md.erb +89 -89
  81. data/docs/resources/csv.md.erb +54 -54
  82. data/docs/resources/dh_params.md.erb +205 -205
  83. data/docs/resources/directory.md.erb +30 -30
  84. data/docs/resources/docker.md.erb +219 -219
  85. data/docs/resources/docker_container.md.erb +103 -103
  86. data/docs/resources/docker_image.md.erb +94 -94
  87. data/docs/resources/docker_service.md.erb +114 -114
  88. data/docs/resources/elasticsearch.md.erb +242 -242
  89. data/docs/resources/etc_fstab.md.erb +125 -125
  90. data/docs/resources/etc_group.md.erb +75 -75
  91. data/docs/resources/etc_hosts.md.erb +78 -78
  92. data/docs/resources/etc_hosts_allow.md.erb +74 -74
  93. data/docs/resources/etc_hosts_deny.md.erb +74 -74
  94. data/docs/resources/file.md.erb +526 -526
  95. data/docs/resources/filesystem.md.erb +41 -41
  96. data/docs/resources/firewalld.md.erb +107 -107
  97. data/docs/resources/gem.md.erb +79 -79
  98. data/docs/resources/group.md.erb +61 -61
  99. data/docs/resources/grub_conf.md.erb +101 -101
  100. data/docs/resources/host.md.erb +86 -86
  101. data/docs/resources/http.md.erb +197 -197
  102. data/docs/resources/iis_app.md.erb +122 -122
  103. data/docs/resources/iis_site.md.erb +135 -135
  104. data/docs/resources/inetd_conf.md.erb +94 -94
  105. data/docs/resources/ini.md.erb +76 -76
  106. data/docs/resources/interface.md.erb +58 -58
  107. data/docs/resources/iptables.md.erb +64 -64
  108. data/docs/resources/json.md.erb +63 -63
  109. data/docs/resources/kernel_module.md.erb +120 -120
  110. data/docs/resources/kernel_parameter.md.erb +53 -53
  111. data/docs/resources/key_rsa.md.erb +85 -85
  112. data/docs/resources/launchd_service.md.erb +57 -57
  113. data/docs/resources/limits_conf.md.erb +75 -75
  114. data/docs/resources/login_defs.md.erb +71 -71
  115. data/docs/resources/mount.md.erb +69 -69
  116. data/docs/resources/mssql_session.md.erb +60 -60
  117. data/docs/resources/mysql_conf.md.erb +99 -99
  118. data/docs/resources/mysql_session.md.erb +74 -74
  119. data/docs/resources/nginx.md.erb +79 -79
  120. data/docs/resources/nginx_conf.md.erb +138 -138
  121. data/docs/resources/npm.md.erb +60 -60
  122. data/docs/resources/ntp_conf.md.erb +60 -60
  123. data/docs/resources/oneget.md.erb +53 -53
  124. data/docs/resources/oracledb_session.md.erb +52 -52
  125. data/docs/resources/os.md.erb +141 -141
  126. data/docs/resources/os_env.md.erb +91 -91
  127. data/docs/resources/package.md.erb +120 -120
  128. data/docs/resources/packages.md.erb +67 -67
  129. data/docs/resources/parse_config.md.erb +103 -103
  130. data/docs/resources/parse_config_file.md.erb +138 -138
  131. data/docs/resources/passwd.md.erb +141 -141
  132. data/docs/resources/pip.md.erb +67 -67
  133. data/docs/resources/port.md.erb +137 -137
  134. data/docs/resources/postgres_conf.md.erb +79 -79
  135. data/docs/resources/postgres_hba_conf.md.erb +93 -93
  136. data/docs/resources/postgres_ident_conf.md.erb +76 -76
  137. data/docs/resources/postgres_session.md.erb +69 -69
  138. data/docs/resources/powershell.md.erb +102 -102
  139. data/docs/resources/processes.md.erb +109 -109
  140. data/docs/resources/rabbitmq_config.md.erb +41 -41
  141. data/docs/resources/registry_key.md.erb +158 -158
  142. data/docs/resources/runit_service.md.erb +57 -57
  143. data/docs/resources/security_policy.md.erb +47 -47
  144. data/docs/resources/service.md.erb +121 -121
  145. data/docs/resources/shadow.md.erb +146 -146
  146. data/docs/resources/ssh_config.md.erb +73 -73
  147. data/docs/resources/sshd_config.md.erb +83 -83
  148. data/docs/resources/ssl.md.erb +119 -119
  149. data/docs/resources/sys_info.md.erb +42 -42
  150. data/docs/resources/systemd_service.md.erb +57 -57
  151. data/docs/resources/sysv_service.md.erb +57 -57
  152. data/docs/resources/upstart_service.md.erb +57 -57
  153. data/docs/resources/user.md.erb +140 -140
  154. data/docs/resources/users.md.erb +127 -127
  155. data/docs/resources/vbscript.md.erb +55 -55
  156. data/docs/resources/virtualization.md.erb +57 -57
  157. data/docs/resources/windows_feature.md.erb +47 -47
  158. data/docs/resources/windows_hotfix.md.erb +53 -53
  159. data/docs/resources/windows_task.md.erb +95 -95
  160. data/docs/resources/wmi.md.erb +81 -81
  161. data/docs/resources/x509_certificate.md.erb +151 -151
  162. data/docs/resources/xinetd_conf.md.erb +156 -156
  163. data/docs/resources/xml.md.erb +85 -85
  164. data/docs/resources/yaml.md.erb +69 -69
  165. data/docs/resources/yum.md.erb +98 -98
  166. data/docs/resources/zfs_dataset.md.erb +53 -53
  167. data/docs/resources/zfs_pool.md.erb +47 -47
  168. data/docs/ruby_usage.md +203 -203
  169. data/docs/shared/matcher_be.md.erb +1 -1
  170. data/docs/shared/matcher_cmp.md.erb +43 -43
  171. data/docs/shared/matcher_eq.md.erb +3 -3
  172. data/docs/shared/matcher_include.md.erb +1 -1
  173. data/docs/shared/matcher_match.md.erb +1 -1
  174. data/docs/shell.md +217 -217
  175. data/examples/README.md +8 -8
  176. data/examples/inheritance/README.md +65 -65
  177. data/examples/inheritance/controls/example.rb +14 -14
  178. data/examples/inheritance/inspec.yml +15 -15
  179. data/examples/kitchen-ansible/.kitchen.yml +25 -25
  180. data/examples/kitchen-ansible/Gemfile +19 -19
  181. data/examples/kitchen-ansible/README.md +53 -53
  182. data/examples/kitchen-ansible/files/nginx.repo +6 -6
  183. data/examples/kitchen-ansible/tasks/main.yml +16 -16
  184. data/examples/kitchen-ansible/test/integration/default/default.yml +5 -5
  185. data/examples/kitchen-ansible/test/integration/default/web_spec.rb +28 -28
  186. data/examples/kitchen-chef/.kitchen.yml +20 -20
  187. data/examples/kitchen-chef/Berksfile +3 -3
  188. data/examples/kitchen-chef/Gemfile +19 -19
  189. data/examples/kitchen-chef/README.md +27 -27
  190. data/examples/kitchen-chef/metadata.rb +7 -7
  191. data/examples/kitchen-chef/recipes/default.rb +6 -6
  192. data/examples/kitchen-chef/recipes/nginx.rb +30 -30
  193. data/examples/kitchen-chef/test/integration/default/web_spec.rb +28 -28
  194. data/examples/kitchen-puppet/.kitchen.yml +23 -23
  195. data/examples/kitchen-puppet/Gemfile +20 -20
  196. data/examples/kitchen-puppet/Puppetfile +25 -25
  197. data/examples/kitchen-puppet/README.md +53 -53
  198. data/examples/kitchen-puppet/manifests/site.pp +33 -33
  199. data/examples/kitchen-puppet/metadata.json +11 -11
  200. data/examples/kitchen-puppet/modules/.gitkeep +0 -0
  201. data/examples/kitchen-puppet/test/integration/default/web_spec.rb +28 -28
  202. data/examples/meta-profile/README.md +37 -37
  203. data/examples/meta-profile/controls/example.rb +13 -13
  204. data/examples/meta-profile/inspec.yml +13 -13
  205. data/examples/profile-attribute.yml +2 -2
  206. data/examples/profile-attribute/README.md +14 -14
  207. data/examples/profile-attribute/controls/example.rb +11 -11
  208. data/examples/profile-attribute/inspec.yml +8 -8
  209. data/examples/profile-aws/controls/iam_password_policy_expiration.rb +8 -8
  210. data/examples/profile-aws/controls/iam_password_policy_max_age.rb +8 -8
  211. data/examples/profile-aws/controls/iam_root_user_mfa.rb +8 -8
  212. data/examples/profile-aws/controls/iam_users_access_key_age.rb +8 -8
  213. data/examples/profile-aws/controls/iam_users_console_users_mfa.rb +8 -8
  214. data/examples/profile-aws/inspec.yml +11 -11
  215. data/examples/profile-azure/controls/azure_resource_group_example.rb +24 -24
  216. data/examples/profile-azure/controls/azure_vm_example.rb +29 -29
  217. data/examples/profile-azure/inspec.yml +11 -11
  218. data/examples/profile-sensitive/README.md +29 -29
  219. data/examples/profile-sensitive/controls/sensitive-failures.rb +9 -9
  220. data/examples/profile-sensitive/controls/sensitive.rb +9 -9
  221. data/examples/profile-sensitive/inspec.yml +8 -8
  222. data/examples/profile/README.md +48 -48
  223. data/examples/profile/controls/example.rb +23 -23
  224. data/examples/profile/controls/gordon.rb +36 -36
  225. data/examples/profile/controls/meta.rb +34 -34
  226. data/examples/profile/inspec.yml +10 -10
  227. data/examples/profile/libraries/gordon_config.rb +59 -59
  228. data/inspec.gemspec +49 -49
  229. data/lib/bundles/README.md +3 -3
  230. data/lib/bundles/inspec-artifact.rb +7 -7
  231. data/lib/bundles/inspec-artifact/README.md +1 -1
  232. data/lib/bundles/inspec-artifact/cli.rb +277 -277
  233. data/lib/bundles/inspec-compliance.rb +16 -16
  234. data/lib/bundles/inspec-compliance/.kitchen.yml +20 -20
  235. data/lib/bundles/inspec-compliance/README.md +193 -193
  236. data/lib/bundles/inspec-compliance/api.rb +360 -360
  237. data/lib/bundles/inspec-compliance/api/login.rb +193 -193
  238. data/lib/bundles/inspec-compliance/bootstrap.sh +41 -41
  239. data/lib/bundles/inspec-compliance/cli.rb +260 -260
  240. data/lib/bundles/inspec-compliance/configuration.rb +103 -103
  241. data/lib/bundles/inspec-compliance/http.rb +125 -125
  242. data/lib/bundles/inspec-compliance/images/cc-token.png +0 -0
  243. data/lib/bundles/inspec-compliance/support.rb +36 -36
  244. data/lib/bundles/inspec-compliance/target.rb +112 -112
  245. data/lib/bundles/inspec-compliance/test/integration/default/cli.rb +93 -93
  246. data/lib/bundles/inspec-habitat.rb +12 -12
  247. data/lib/bundles/inspec-habitat/cli.rb +36 -36
  248. data/lib/bundles/inspec-habitat/log.rb +10 -10
  249. data/lib/bundles/inspec-habitat/profile.rb +391 -391
  250. data/lib/bundles/inspec-init.rb +8 -8
  251. data/lib/bundles/inspec-init/README.md +31 -31
  252. data/lib/bundles/inspec-init/cli.rb +97 -97
  253. data/lib/bundles/inspec-init/templates/profile/README.md +3 -3
  254. data/lib/bundles/inspec-init/templates/profile/controls/example.rb +19 -19
  255. data/lib/bundles/inspec-init/templates/profile/inspec.yml +8 -8
  256. data/lib/bundles/inspec-init/templates/profile/libraries/.gitkeep +0 -0
  257. data/lib/bundles/inspec-supermarket.rb +13 -13
  258. data/lib/bundles/inspec-supermarket/README.md +45 -45
  259. data/lib/bundles/inspec-supermarket/api.rb +84 -84
  260. data/lib/bundles/inspec-supermarket/cli.rb +73 -73
  261. data/lib/bundles/inspec-supermarket/target.rb +34 -34
  262. data/lib/fetchers/git.rb +163 -163
  263. data/lib/fetchers/local.rb +74 -74
  264. data/lib/fetchers/mock.rb +35 -35
  265. data/lib/fetchers/url.rb +247 -247
  266. data/lib/inspec.rb +24 -24
  267. data/lib/inspec/archive/tar.rb +29 -29
  268. data/lib/inspec/archive/zip.rb +19 -19
  269. data/lib/inspec/backend.rb +93 -93
  270. data/lib/inspec/base_cli.rb +368 -368
  271. data/lib/inspec/cached_fetcher.rb +66 -66
  272. data/lib/inspec/cli.rb +292 -292
  273. data/lib/inspec/completions/bash.sh.erb +45 -45
  274. data/lib/inspec/completions/fish.sh.erb +34 -34
  275. data/lib/inspec/completions/zsh.sh.erb +61 -61
  276. data/lib/inspec/control_eval_context.rb +179 -179
  277. data/lib/inspec/dependencies/cache.rb +72 -72
  278. data/lib/inspec/dependencies/dependency_set.rb +92 -92
  279. data/lib/inspec/dependencies/lockfile.rb +115 -115
  280. data/lib/inspec/dependencies/requirement.rb +123 -123
  281. data/lib/inspec/dependencies/resolver.rb +86 -86
  282. data/lib/inspec/describe.rb +27 -27
  283. data/lib/inspec/dsl.rb +66 -66
  284. data/lib/inspec/dsl_shared.rb +33 -33
  285. data/lib/inspec/env_printer.rb +157 -157
  286. data/lib/inspec/errors.rb +14 -14
  287. data/lib/inspec/exceptions.rb +12 -12
  288. data/lib/inspec/expect.rb +45 -45
  289. data/lib/inspec/fetcher.rb +45 -45
  290. data/lib/inspec/file_provider.rb +275 -275
  291. data/lib/inspec/formatters.rb +3 -3
  292. data/lib/inspec/formatters/base.rb +259 -259
  293. data/lib/inspec/formatters/json_rspec.rb +20 -20
  294. data/lib/inspec/formatters/show_progress.rb +12 -12
  295. data/lib/inspec/library_eval_context.rb +58 -58
  296. data/lib/inspec/log.rb +11 -11
  297. data/lib/inspec/metadata.rb +247 -247
  298. data/lib/inspec/method_source.rb +24 -24
  299. data/lib/inspec/objects.rb +14 -14
  300. data/lib/inspec/objects/attribute.rb +75 -75
  301. data/lib/inspec/objects/control.rb +61 -61
  302. data/lib/inspec/objects/describe.rb +92 -92
  303. data/lib/inspec/objects/each_loop.rb +36 -36
  304. data/lib/inspec/objects/list.rb +15 -15
  305. data/lib/inspec/objects/or_test.rb +40 -40
  306. data/lib/inspec/objects/ruby_helper.rb +15 -15
  307. data/lib/inspec/objects/tag.rb +27 -27
  308. data/lib/inspec/objects/test.rb +87 -87
  309. data/lib/inspec/objects/value.rb +27 -27
  310. data/lib/inspec/plugins.rb +60 -60
  311. data/lib/inspec/plugins/cli.rb +24 -24
  312. data/lib/inspec/plugins/fetcher.rb +86 -86
  313. data/lib/inspec/plugins/resource.rb +135 -135
  314. data/lib/inspec/plugins/secret.rb +15 -15
  315. data/lib/inspec/plugins/source_reader.rb +40 -40
  316. data/lib/inspec/polyfill.rb +12 -12
  317. data/lib/inspec/profile.rb +513 -513
  318. data/lib/inspec/profile_context.rb +208 -208
  319. data/lib/inspec/profile_vendor.rb +66 -66
  320. data/lib/inspec/reporters.rb +60 -60
  321. data/lib/inspec/reporters/automate.rb +76 -76
  322. data/lib/inspec/reporters/base.rb +25 -25
  323. data/lib/inspec/reporters/cli.rb +356 -356
  324. data/lib/inspec/reporters/json.rb +117 -117
  325. data/lib/inspec/reporters/json_min.rb +48 -48
  326. data/lib/inspec/reporters/junit.rb +78 -78
  327. data/lib/inspec/require_loader.rb +33 -33
  328. data/lib/inspec/resource.rb +190 -190
  329. data/lib/inspec/rule.rb +280 -280
  330. data/lib/inspec/runner.rb +345 -345
  331. data/lib/inspec/runner_mock.rb +41 -41
  332. data/lib/inspec/runner_rspec.rb +175 -175
  333. data/lib/inspec/runtime_profile.rb +26 -26
  334. data/lib/inspec/schema.rb +213 -213
  335. data/lib/inspec/secrets.rb +19 -19
  336. data/lib/inspec/secrets/yaml.rb +30 -30
  337. data/lib/inspec/shell.rb +220 -220
  338. data/lib/inspec/shell_detector.rb +90 -90
  339. data/lib/inspec/source_reader.rb +29 -29
  340. data/lib/inspec/version.rb +8 -8
  341. data/lib/matchers/matchers.rb +339 -339
  342. data/lib/resource_support/aws.rb +50 -50
  343. data/lib/resource_support/aws/aws_backend_base.rb +12 -12
  344. data/lib/resource_support/aws/aws_backend_factory_mixin.rb +12 -12
  345. data/lib/resource_support/aws/aws_plural_resource_mixin.rb +21 -21
  346. data/lib/resource_support/aws/aws_resource_mixin.rb +66 -66
  347. data/lib/resource_support/aws/aws_singular_resource_mixin.rb +24 -24
  348. data/lib/resources/aide_conf.rb +151 -151
  349. data/lib/resources/apache.rb +48 -48
  350. data/lib/resources/apache_conf.rb +149 -149
  351. data/lib/resources/apt.rb +149 -149
  352. data/lib/resources/audit_policy.rb +63 -63
  353. data/lib/resources/auditd.rb +231 -231
  354. data/lib/resources/auditd_conf.rb +46 -46
  355. data/lib/resources/aws/aws_cloudtrail_trail.rb +93 -93
  356. data/lib/resources/aws/aws_cloudtrail_trails.rb +47 -47
  357. data/lib/resources/aws/aws_cloudwatch_alarm.rb +62 -62
  358. data/lib/resources/aws/aws_cloudwatch_log_metric_filter.rb +100 -100
  359. data/lib/resources/aws/aws_config_delivery_channel.rb +70 -70
  360. data/lib/resources/aws/aws_config_recorder.rb +93 -93
  361. data/lib/resources/aws/aws_ec2_instance.rb +157 -157
  362. data/lib/resources/aws/aws_ec2_instances.rb +64 -64
  363. data/lib/resources/aws/aws_iam_access_key.rb +106 -106
  364. data/lib/resources/aws/aws_iam_access_keys.rb +149 -149
  365. data/lib/resources/aws/aws_iam_group.rb +58 -58
  366. data/lib/resources/aws/aws_iam_groups.rb +52 -52
  367. data/lib/resources/aws/aws_iam_password_policy.rb +116 -116
  368. data/lib/resources/aws/aws_iam_policies.rb +53 -53
  369. data/lib/resources/aws/aws_iam_policy.rb +291 -291
  370. data/lib/resources/aws/aws_iam_role.rb +55 -55
  371. data/lib/resources/aws/aws_iam_root_user.rb +78 -78
  372. data/lib/resources/aws/aws_iam_user.rb +142 -142
  373. data/lib/resources/aws/aws_iam_users.rb +146 -146
  374. data/lib/resources/aws/aws_kms_key.rb +96 -96
  375. data/lib/resources/aws/aws_kms_keys.rb +53 -53
  376. data/lib/resources/aws/aws_rds_instance.rb +71 -71
  377. data/lib/resources/aws/aws_route_table.rb +63 -63
  378. data/lib/resources/aws/aws_route_tables.rb +60 -60
  379. data/lib/resources/aws/aws_s3_bucket.rb +137 -137
  380. data/lib/resources/aws/aws_s3_bucket_object.rb +82 -82
  381. data/lib/resources/aws/aws_s3_buckets.rb +51 -51
  382. data/lib/resources/aws/aws_security_group.rb +249 -249
  383. data/lib/resources/aws/aws_security_groups.rb +68 -68
  384. data/lib/resources/aws/aws_sns_subscription.rb +78 -78
  385. data/lib/resources/aws/aws_sns_topic.rb +53 -53
  386. data/lib/resources/aws/aws_sns_topics.rb +56 -56
  387. data/lib/resources/aws/aws_subnet.rb +88 -88
  388. data/lib/resources/aws/aws_subnets.rb +53 -53
  389. data/lib/resources/aws/aws_vpc.rb +73 -73
  390. data/lib/resources/aws/aws_vpcs.rb +52 -52
  391. data/lib/resources/azure/azure_backend.rb +377 -377
  392. data/lib/resources/azure/azure_generic_resource.rb +59 -59
  393. data/lib/resources/azure/azure_resource_group.rb +152 -152
  394. data/lib/resources/azure/azure_virtual_machine.rb +264 -264
  395. data/lib/resources/azure/azure_virtual_machine_data_disk.rb +134 -134
  396. data/lib/resources/bash.rb +35 -35
  397. data/lib/resources/bond.rb +69 -69
  398. data/lib/resources/bridge.rb +122 -122
  399. data/lib/resources/chocolatey_package.rb +78 -78
  400. data/lib/resources/command.rb +73 -73
  401. data/lib/resources/cpan.rb +58 -58
  402. data/lib/resources/cran.rb +64 -64
  403. data/lib/resources/crontab.rb +169 -169
  404. data/lib/resources/csv.rb +56 -56
  405. data/lib/resources/dh_params.rb +77 -77
  406. data/lib/resources/directory.rb +25 -25
  407. data/lib/resources/docker.rb +236 -236
  408. data/lib/resources/docker_container.rb +89 -89
  409. data/lib/resources/docker_image.rb +83 -83
  410. data/lib/resources/docker_object.rb +57 -57
  411. data/lib/resources/docker_service.rb +90 -90
  412. data/lib/resources/elasticsearch.rb +169 -169
  413. data/lib/resources/etc_fstab.rb +94 -94
  414. data/lib/resources/etc_group.rb +154 -154
  415. data/lib/resources/etc_hosts.rb +66 -66
  416. data/lib/resources/etc_hosts_allow_deny.rb +112 -112
  417. data/lib/resources/file.rb +298 -298
  418. data/lib/resources/filesystem.rb +31 -31
  419. data/lib/resources/firewalld.rb +143 -143
  420. data/lib/resources/gem.rb +70 -70
  421. data/lib/resources/groups.rb +215 -215
  422. data/lib/resources/grub_conf.rb +227 -227
  423. data/lib/resources/host.rb +306 -306
  424. data/lib/resources/http.rb +253 -253
  425. data/lib/resources/iis_app.rb +101 -101
  426. data/lib/resources/iis_site.rb +148 -148
  427. data/lib/resources/inetd_conf.rb +54 -54
  428. data/lib/resources/ini.rb +29 -29
  429. data/lib/resources/interface.rb +129 -129
  430. data/lib/resources/iptables.rb +80 -80
  431. data/lib/resources/json.rb +111 -111
  432. data/lib/resources/kernel_module.rb +107 -107
  433. data/lib/resources/kernel_parameter.rb +58 -58
  434. data/lib/resources/key_rsa.rb +63 -63
  435. data/lib/resources/limits_conf.rb +46 -46
  436. data/lib/resources/login_def.rb +57 -57
  437. data/lib/resources/mount.rb +88 -88
  438. data/lib/resources/mssql_session.rb +101 -101
  439. data/lib/resources/mysql.rb +82 -82
  440. data/lib/resources/mysql_conf.rb +127 -127
  441. data/lib/resources/mysql_session.rb +85 -85
  442. data/lib/resources/nginx.rb +96 -96
  443. data/lib/resources/nginx_conf.rb +226 -226
  444. data/lib/resources/npm.rb +48 -48
  445. data/lib/resources/ntp_conf.rb +51 -51
  446. data/lib/resources/oneget.rb +71 -71
  447. data/lib/resources/oracledb_session.rb +139 -139
  448. data/lib/resources/os.rb +36 -36
  449. data/lib/resources/os_env.rb +86 -86
  450. data/lib/resources/package.rb +370 -370
  451. data/lib/resources/packages.rb +111 -111
  452. data/lib/resources/parse_config.rb +112 -112
  453. data/lib/resources/passwd.rb +76 -76
  454. data/lib/resources/pip.rb +130 -130
  455. data/lib/resources/platform.rb +109 -109
  456. data/lib/resources/port.rb +771 -771
  457. data/lib/resources/postgres.rb +131 -131
  458. data/lib/resources/postgres_conf.rb +114 -114
  459. data/lib/resources/postgres_hba_conf.rb +90 -90
  460. data/lib/resources/postgres_ident_conf.rb +79 -79
  461. data/lib/resources/postgres_session.rb +71 -71
  462. data/lib/resources/powershell.rb +67 -67
  463. data/lib/resources/processes.rb +204 -204
  464. data/lib/resources/rabbitmq_conf.rb +51 -51
  465. data/lib/resources/registry_key.rb +297 -297
  466. data/lib/resources/security_policy.rb +180 -180
  467. data/lib/resources/service.rb +794 -794
  468. data/lib/resources/shadow.rb +159 -159
  469. data/lib/resources/ssh_conf.rb +97 -97
  470. data/lib/resources/ssl.rb +99 -99
  471. data/lib/resources/sys_info.rb +28 -28
  472. data/lib/resources/toml.rb +32 -32
  473. data/lib/resources/users.rb +654 -654
  474. data/lib/resources/vbscript.rb +68 -68
  475. data/lib/resources/virtualization.rb +247 -247
  476. data/lib/resources/windows_feature.rb +84 -84
  477. data/lib/resources/windows_hotfix.rb +35 -35
  478. data/lib/resources/windows_task.rb +102 -102
  479. data/lib/resources/wmi.rb +110 -110
  480. data/lib/resources/x509_certificate.rb +137 -137
  481. data/lib/resources/xinetd.rb +106 -106
  482. data/lib/resources/xml.rb +46 -46
  483. data/lib/resources/yaml.rb +43 -43
  484. data/lib/resources/yum.rb +180 -180
  485. data/lib/resources/zfs_dataset.rb +60 -60
  486. data/lib/resources/zfs_pool.rb +49 -49
  487. data/lib/source_readers/flat.rb +39 -39
  488. data/lib/source_readers/inspec.rb +75 -75
  489. data/lib/utils/command_wrapper.rb +27 -27
  490. data/lib/utils/convert.rb +12 -12
  491. data/lib/utils/database_helpers.rb +77 -77
  492. data/lib/utils/enumerable_delegation.rb +9 -9
  493. data/lib/utils/erlang_parser.rb +192 -192
  494. data/lib/utils/file_reader.rb +25 -25
  495. data/lib/utils/filter.rb +273 -273
  496. data/lib/utils/filter_array.rb +27 -27
  497. data/lib/utils/find_files.rb +47 -47
  498. data/lib/utils/hash.rb +41 -41
  499. data/lib/utils/json_log.rb +18 -18
  500. data/lib/utils/latest_version.rb +22 -22
  501. data/lib/utils/modulator.rb +12 -12
  502. data/lib/utils/nginx_parser.rb +105 -105
  503. data/lib/utils/object_traversal.rb +49 -49
  504. data/lib/utils/parser.rb +274 -274
  505. data/lib/utils/pkey_reader.rb +15 -15
  506. data/lib/utils/plugin_registry.rb +93 -93
  507. data/lib/utils/simpleconfig.rb +120 -120
  508. data/lib/utils/spdx.rb +13 -13
  509. data/lib/utils/spdx.txt +343 -343
  510. metadata +3 -3
data/Rakefile CHANGED
@@ -1,349 +1,349 @@
1
- #!/usr/bin/env rake
2
- # encoding: utf-8
3
-
4
- require 'bundler'
5
- require 'bundler/gem_helper'
6
- require 'rake/testtask'
7
- require 'passgen'
8
- require 'train'
9
- require_relative 'tasks/maintainers'
10
- require_relative 'tasks/spdx'
11
-
12
- Bundler::GemHelper.install_tasks name: 'inspec'
13
-
14
- def prompt(message)
15
- print(message)
16
- STDIN.gets.chomp
17
- end
18
-
19
- # The docs tasks rely on ruby-progressbar. If we can't load it, then don't
20
- # load the docs tasks. This is necessary to allow this Rakefile to work
21
- # when the "tests" gem group in the Gemfile has been excluded, such as
22
- # during an appbundle-updater run.
23
- begin
24
- require 'ruby-progressbar'
25
- require_relative 'tasks/docs'
26
- rescue LoadError
27
- puts 'docs tasks are unavailable because the ruby-progressbar gem is not available.'
28
- end
29
-
30
- # Rubocop
31
- begin
32
- require 'rubocop/rake_task'
33
- RuboCop::RakeTask.new(:lint)
34
- rescue LoadError
35
- puts 'rubocop is not available. Install the rubocop gem to run the lint tests.'
36
- end
37
-
38
- # update command output for demo
39
- desc 'Run inspec commands and save results to www/app/responses'
40
- task :update_demo do
41
- ruby 'www/tutorial/scripts/build_simulator_runtime.rb'
42
- ruby 'www/tutorial/scripts/run_simulator_recording.rb'
43
- end
44
-
45
- # run tests
46
- task default: [:lint, :test]
47
-
48
- Rake::TestTask.new do |t|
49
- t.libs << 'test'
50
- t.pattern = 'test/unit/**/*_test.rb'
51
- t.warning = true
52
- t.verbose = true
53
- t.ruby_opts = ['--dev'] if defined?(JRUBY_VERSION)
54
- end
55
-
56
- namespace :test do
57
- task :isolated do
58
- Dir.glob('test/unit/*_test.rb').all? do |file|
59
- sh(Gem.ruby, '-w', '-Ilib:test', file)
60
- end or fail 'Failures'
61
- end
62
-
63
- Rake::TestTask.new(:functional) do |t|
64
- t.libs << 'test'
65
- t.pattern = 'test/functional/**/*_test.rb'
66
- t.warning = true
67
- t.verbose = true
68
- t.ruby_opts = ['--dev'] if defined?(JRUBY_VERSION)
69
- end
70
-
71
- task :resources do
72
- tests = Dir['test/resource/*_test.rb']
73
- return if tests.empty?
74
- sh(Gem.ruby, 'test/docker_test.rb', *tests)
75
- end
76
-
77
- task :integration do
78
- concurrency = ENV['CONCURRENCY'] || 1
79
- os = ENV['OS'] || ''
80
- sh("bundle exec kitchen test -c #{concurrency} #{os}")
81
- end
82
-
83
- task :ssh, [:target] do |_t, args|
84
- tests_path = File.join(File.dirname(__FILE__), 'test', 'integration', 'test', 'integration', 'default')
85
- key_files = ENV['key_files'] || File.join(ENV['HOME'], '.ssh', 'id_rsa')
86
-
87
- sh_cmd = "bin/inspec exec #{tests_path}/"
88
- sh_cmd += ENV['test'] ? "#{ENV['test']}_spec.rb" : '*'
89
- sh_cmd += " --sudo" unless args[:target].split('@')[0] == 'root'
90
- sh_cmd += " -t ssh://#{args[:target]}"
91
- sh_cmd += " --key_files=#{key_files}"
92
- sh_cmd += " --format=#{ENV['format']}" if ENV['format']
93
-
94
- sh('sh', '-c', sh_cmd)
95
- end
96
-
97
- project_dir = File.dirname(__FILE__)
98
- namespace :aws do
99
- ['default', 'minimal'].each do |account|
100
- integration_dir = File.join(project_dir, 'test', 'integration', 'aws', account)
101
- attribute_file = File.join(integration_dir, '.attribute.yml')
102
-
103
- task :"setup:#{account}", :tf_workspace do |t, args|
104
- tf_workspace = args[:tf_workspace] || ENV['INSPEC_TERRAFORM_ENV']
105
- abort("You must either call the top-level test:aws:#{account} task, or set the INSPEC_TERRAFORM_ENV variable.") unless tf_workspace
106
- puts "----> Setup"
107
- abort("You must set the environment variable AWS_REGION") unless ENV['AWS_REGION']
108
- puts "----> Checking for required AWS profile..."
109
- sh("aws configure get aws_access_key_id --profile inspec-aws-test-#{account} > /dev/null")
110
- sh("cd #{integration_dir}/build/ && terraform init -upgrade")
111
- sh("cd #{integration_dir}/build/ && terraform workspace new #{tf_workspace}")
112
- sh("cd #{integration_dir}/build/ && AWS_PROFILE=inspec-aws-test-#{account} terraform plan -out inspec-aws-#{account}.plan")
113
- sh("cd #{integration_dir}/build/ && AWS_PROFILE=inspec-aws-test-#{account} terraform apply -auto-approve inspec-aws-#{account}.plan")
114
- Rake::Task["test:aws:dump_attrs:#{account}"].execute
115
- end
116
-
117
- task :"dump_attrs:#{account}" do
118
- sh("cd #{integration_dir}/build/ && AWS_PROFILE=inspec-aws-test-#{account} terraform output > #{attribute_file}")
119
- raw_output = File.read(attribute_file)
120
- yaml_output = raw_output.gsub(" = ", " : ")
121
- File.open(attribute_file, "w") {|file| file.puts yaml_output}
122
- end
123
-
124
- task :"run:#{account}" do
125
- puts "----> Run"
126
- sh("bundle exec inspec exec #{integration_dir}/verify -t aws://${AWS_REGION}/inspec-aws-test-#{account} --attrs #{attribute_file}")
127
- end
128
-
129
- task :"cleanup:#{account}", :tf_workspace do |t, args|
130
- tf_workspace = args[:tf_workspace] || ENV['INSPEC_TERRAFORM_ENV']
131
- abort("You must either call the top-level test:aws:#{account} task, or set the INSPEC_TERRAFORM_ENV variable.") unless tf_workspace
132
- puts "----> Cleanup"
133
- sh("cd #{integration_dir}/build/ && AWS_PROFILE=inspec-aws-test-#{account} terraform destroy -force")
134
- sh("cd #{integration_dir}/build/ && terraform workspace select default")
135
- sh("cd #{integration_dir}/build && terraform workspace delete #{tf_workspace}")
136
- end
137
-
138
- task :"#{account}" do
139
- tf_workspace = ENV['INSPEC_TERRAFORM_ENV'] || prompt("Please enter a workspace for your integration tests to run in: ")
140
- begin
141
- Rake::Task["test:aws:setup:#{account}"].execute({:tf_workspace => tf_workspace})
142
- Rake::Task["test:aws:run:#{account}"].execute
143
- rescue
144
- abort("Integration testing has failed for the #{account} account")
145
- ensure
146
- Rake::Task["test:aws:cleanup:#{account}"].execute({:tf_workspace => tf_workspace})
147
- end
148
- end
149
- end
150
- end
151
- desc "Perform AWS Integration Tests"
152
- task aws: [:'aws:default', :'aws:minimal']
153
-
154
- namespace :azure do
155
- # Specify the directory for the integration tests
156
- integration_dir = File.join(project_dir, 'test', 'integration', 'azure')
157
- tf_vars_file = File.join(integration_dir, 'build', 'terraform.tfvars')
158
- attribute_file = File.join(integration_dir, '.attribute.yml')
159
-
160
- task :setup, :tf_workspace do |t, args|
161
- tf_workspace = args[:tf_workspace] || ENV['INSPEC_TERRAFORM_ENV']
162
- abort("You must either call the top-level test:azure task, or set the INSPEC_TERRAFORM_ENV variable.") unless tf_workspace
163
-
164
- puts '----> Setup Terraform Workspace'
165
-
166
- sh("cd #{integration_dir}/build/ && terraform init -upgrade")
167
- sh("cd #{integration_dir}/build/ && terraform workspace new #{tf_workspace}")
168
-
169
- Rake::Task["test:azure:vars"].execute
170
- Rake::Task["test:azure:plan"].execute
171
- Rake::Task["test:azure:apply"].execute
172
- end
173
-
174
- desc "Generate terraform.tfvars file"
175
- task :vars do |t, args|
176
-
177
- next if File.exist?(tf_vars_file)
178
-
179
- puts '----> Generating Vars'
180
-
181
- # Generate Azure crendentials
182
- connection = Train.create('azure').connection
183
- creds = connection.options
184
-
185
- # Determine the storage account name and the admin password
186
- sa_name = (0...15).map { (65 + rand(26)).chr }.join.downcase
187
- admin_password = Passgen::generate(length: 12, uppercase: true, lowercase: true, symbols: true, digits: true)
188
-
189
- # Use the first 4 characters of the storage account to create a suffix
190
- suffix = sa_name[0..3]
191
-
192
- content = <<~VARS
193
- subscription_id = "#{creds[:subscription_id]}"
194
- client_id = "#{creds[:client_id]}"
195
- client_secret = "#{creds[:client_secret]}"
196
- tenant_id = "#{creds[:tenant_id]}"
197
- storage_account_name = "#{sa_name}"
198
- admin_password = "#{admin_password}"
199
- suffix = "#{suffix}"
200
- VARS
201
-
202
- content << "location = \"#{ENV['AZURE_LOCATION']}\"\n" if ENV['AZURE_LOCATION']
203
-
204
- File.write(tf_vars_file, content)
205
- end
206
-
207
- desc "generate plan from state using terraform.tfvars file"
208
- task :plan, [:tf_workspace] => [:vars] do |t, args|
209
- tf_workspace = args[:tf_workspace] || ENV['INSPEC_TERRAFORM_ENV']
210
- abort("You must set the INSPEC_TERRAFORM_ENV variable.") unless tf_workspace
211
-
212
- puts '----> Generating Plan'
213
-
214
- result = sh("cd #{integration_dir}/build/ && terraform workspace select #{tf_workspace}")
215
-
216
- sh("cd #{integration_dir}/build/ && terraform plan -out inspec-azure.plan")
217
- end
218
-
219
- desc "apply terraform plan"
220
- task :apply, [:tf_workspace] => [:plan] do |t, args|
221
- tf_workspace = args[:tf_workspace] || ENV['INSPEC_TERRAFORM_ENV']
222
- abort("You must set the INSPEC_TERRAFORM_ENV variable.") unless tf_workspace
223
- puts '----> Applying Plan'
224
-
225
- sh("cd #{integration_dir}/build/ && terraform workspace select #{tf_workspace}")
226
-
227
- sh("cd #{integration_dir}/build/ && terraform apply inspec-azure.plan")
228
-
229
- Rake::Task["test:azure:dump_attrs"].execute
230
- end
231
-
232
- task :"dump_attrs" do
233
- sh("cd #{integration_dir}/build/ && terraform output > #{attribute_file}")
234
- raw_output = File.read(attribute_file)
235
- yaml_output = raw_output.gsub(" = ", " : ")
236
- File.open(attribute_file, "w") {|file| file.puts yaml_output}
237
- end
238
-
239
- task :run do
240
- puts '----> Run'
241
- sh("bundle exec inspec exec #{integration_dir}/verify -t azure://1e0b427a-d58b-494e-ae4f-ee558463ebbf")
242
- end
243
-
244
- task :cleanup, :tf_workspace do |t, args|
245
- tf_workspace = args[:tf_workspace] || ENV['INSPEC_TERRAFORM_ENV']
246
- abort("You must either call the top-level test:azure task, or set the INSPEC_TERRAFORM_ENV variable.") unless tf_workspace
247
- puts '----> Cleanup'
248
-
249
- sh("cd #{integration_dir}/build/ && terraform destroy -force ")
250
-
251
- sh("cd #{integration_dir}/build/ && terraform workspace select default")
252
- sh("cd #{integration_dir}/build && terraform workspace delete #{tf_workspace}")
253
- File.delete(tf_vars_file)
254
- end
255
- end
256
-
257
- desc "Perform Azure Integration Tests"
258
- task :azure do
259
- tf_workspace = ENV['INSPEC_TERRAFORM_ENV'] || prompt("Please enter a workspace for your integration tests to run in: ")
260
- begin
261
- Rake::Task["test:azure:setup"].execute({:tf_workspace => tf_workspace})
262
- Rake::Task["test:azure:run"].execute
263
- rescue
264
- abort("Integration testing has failed")
265
- ensure
266
- Rake::Task["test:azure:cleanup"].execute({:tf_workspace => tf_workspace})
267
- end
268
- end
269
- end
270
-
271
- # Print the current version of this gem or update it.
272
- #
273
- # @param [Type] target the new version you want to set, or nil if you only want to show
274
- def inspec_version(target = nil)
275
- path = 'lib/inspec/version.rb'
276
- require_relative path.sub(/.rb$/, '')
277
-
278
- nu_version = target.nil? ? '' : " -> #{target}"
279
- puts "Inspec: #{Inspec::VERSION}#{nu_version}"
280
-
281
- unless target.nil?
282
- raw = File.read(path)
283
- nu = raw.sub(/VERSION.*/, "VERSION = '#{target}'.freeze")
284
- File.write(path, nu)
285
- load(path)
286
- end
287
- end
288
-
289
- # Check if a command is available
290
- #
291
- # @param [Type] x the command you are interested in
292
- # @param [Type] msg the message to display if the command is missing
293
- def require_command(x, msg = nil)
294
- return if system("command -v #{x} || exit 1")
295
- msg ||= 'Please install it first!'
296
- puts "\033[31;1mCan't find command #{x.inspect}. #{msg}\033[0m"
297
- exit 1
298
- end
299
-
300
- # Check if a required environment variable has been set
301
- #
302
- # @param [String] x the variable you are interested in
303
- # @param [String] msg the message you want to display if the variable is missing
304
- def require_env(x, msg = nil)
305
- exists = `env | grep "^#{x}="`
306
- return unless exists.empty?
307
- puts "\033[31;1mCan't find environment variable #{x.inspect}. #{msg}\033[0m"
308
- exit 1
309
- end
310
-
311
- # Check the requirements for running an update of this repository.
312
- def check_update_requirements
313
- require_command 'git'
314
- end
315
-
316
- # Show the current version of this gem.
317
- desc 'Show the version of this gem'
318
- task :version do
319
- inspec_version
320
- end
321
-
322
- desc 'Release a new docker image'
323
- task :release_docker do
324
- version = Inspec::VERSION
325
- cmd = "rm *.gem; gem build *gemspec && "\
326
- "mv *.gem inspec.gem && "\
327
- "docker build -t chef/inspec:#{version} . && "\
328
- "docker push chef/inspec:#{version} && "\
329
- "docker tag chef/inspec:#{version} chef/inspec:latest &&"\
330
- "docker push chef/inspec:latest"
331
- puts "--> #{cmd}"
332
- sh('sh', '-c', cmd)
333
- end
334
-
335
- desc 'Release the website [deprecated]'
336
- task :www do
337
- puts 'The Rake tasks for releasing the website are now in the www/ directory.'
338
- puts 'Run `cd www` and then `rake --tasks` for a list of the www-related tasks available.'
339
- exit(1)
340
- end
341
-
342
- namespace :www do
343
- desc 'Release the website [deprecated]'
344
- task :release do
345
- puts 'The Rake tasks for releasing the website are now in the www/ directory.'
346
- puts 'Run `cd www` and then `rake --tasks` for a list of the www-related tasks available.'
347
- exit(1)
348
- end
349
- end
1
+ #!/usr/bin/env rake
2
+ # encoding: utf-8
3
+
4
+ require 'bundler'
5
+ require 'bundler/gem_helper'
6
+ require 'rake/testtask'
7
+ require 'passgen'
8
+ require 'train'
9
+ require_relative 'tasks/maintainers'
10
+ require_relative 'tasks/spdx'
11
+
12
+ Bundler::GemHelper.install_tasks name: 'inspec'
13
+
14
+ def prompt(message)
15
+ print(message)
16
+ STDIN.gets.chomp
17
+ end
18
+
19
+ # The docs tasks rely on ruby-progressbar. If we can't load it, then don't
20
+ # load the docs tasks. This is necessary to allow this Rakefile to work
21
+ # when the "tests" gem group in the Gemfile has been excluded, such as
22
+ # during an appbundle-updater run.
23
+ begin
24
+ require 'ruby-progressbar'
25
+ require_relative 'tasks/docs'
26
+ rescue LoadError
27
+ puts 'docs tasks are unavailable because the ruby-progressbar gem is not available.'
28
+ end
29
+
30
+ # Rubocop
31
+ begin
32
+ require 'rubocop/rake_task'
33
+ RuboCop::RakeTask.new(:lint)
34
+ rescue LoadError
35
+ puts 'rubocop is not available. Install the rubocop gem to run the lint tests.'
36
+ end
37
+
38
+ # update command output for demo
39
+ desc 'Run inspec commands and save results to www/app/responses'
40
+ task :update_demo do
41
+ ruby 'www/tutorial/scripts/build_simulator_runtime.rb'
42
+ ruby 'www/tutorial/scripts/run_simulator_recording.rb'
43
+ end
44
+
45
+ # run tests
46
+ task default: [:lint, :test]
47
+
48
+ Rake::TestTask.new do |t|
49
+ t.libs << 'test'
50
+ t.pattern = 'test/unit/**/*_test.rb'
51
+ t.warning = true
52
+ t.verbose = true
53
+ t.ruby_opts = ['--dev'] if defined?(JRUBY_VERSION)
54
+ end
55
+
56
+ namespace :test do
57
+ task :isolated do
58
+ Dir.glob('test/unit/*_test.rb').all? do |file|
59
+ sh(Gem.ruby, '-w', '-Ilib:test', file)
60
+ end or fail 'Failures'
61
+ end
62
+
63
+ Rake::TestTask.new(:functional) do |t|
64
+ t.libs << 'test'
65
+ t.pattern = 'test/functional/**/*_test.rb'
66
+ t.warning = true
67
+ t.verbose = true
68
+ t.ruby_opts = ['--dev'] if defined?(JRUBY_VERSION)
69
+ end
70
+
71
+ task :resources do
72
+ tests = Dir['test/resource/*_test.rb']
73
+ return if tests.empty?
74
+ sh(Gem.ruby, 'test/docker_test.rb', *tests)
75
+ end
76
+
77
+ task :integration do
78
+ concurrency = ENV['CONCURRENCY'] || 1
79
+ os = ENV['OS'] || ''
80
+ sh("bundle exec kitchen test -c #{concurrency} #{os}")
81
+ end
82
+
83
+ task :ssh, [:target] do |_t, args|
84
+ tests_path = File.join(File.dirname(__FILE__), 'test', 'integration', 'test', 'integration', 'default')
85
+ key_files = ENV['key_files'] || File.join(ENV['HOME'], '.ssh', 'id_rsa')
86
+
87
+ sh_cmd = "bin/inspec exec #{tests_path}/"
88
+ sh_cmd += ENV['test'] ? "#{ENV['test']}_spec.rb" : '*'
89
+ sh_cmd += " --sudo" unless args[:target].split('@')[0] == 'root'
90
+ sh_cmd += " -t ssh://#{args[:target]}"
91
+ sh_cmd += " --key_files=#{key_files}"
92
+ sh_cmd += " --format=#{ENV['format']}" if ENV['format']
93
+
94
+ sh('sh', '-c', sh_cmd)
95
+ end
96
+
97
+ project_dir = File.dirname(__FILE__)
98
+ namespace :aws do
99
+ ['default', 'minimal'].each do |account|
100
+ integration_dir = File.join(project_dir, 'test', 'integration', 'aws', account)
101
+ attribute_file = File.join(integration_dir, '.attribute.yml')
102
+
103
+ task :"setup:#{account}", :tf_workspace do |t, args|
104
+ tf_workspace = args[:tf_workspace] || ENV['INSPEC_TERRAFORM_ENV']
105
+ abort("You must either call the top-level test:aws:#{account} task, or set the INSPEC_TERRAFORM_ENV variable.") unless tf_workspace
106
+ puts "----> Setup"
107
+ abort("You must set the environment variable AWS_REGION") unless ENV['AWS_REGION']
108
+ puts "----> Checking for required AWS profile..."
109
+ sh("aws configure get aws_access_key_id --profile inspec-aws-test-#{account} > /dev/null")
110
+ sh("cd #{integration_dir}/build/ && terraform init -upgrade")
111
+ sh("cd #{integration_dir}/build/ && terraform workspace new #{tf_workspace}")
112
+ sh("cd #{integration_dir}/build/ && AWS_PROFILE=inspec-aws-test-#{account} terraform plan -out inspec-aws-#{account}.plan")
113
+ sh("cd #{integration_dir}/build/ && AWS_PROFILE=inspec-aws-test-#{account} terraform apply -auto-approve inspec-aws-#{account}.plan")
114
+ Rake::Task["test:aws:dump_attrs:#{account}"].execute
115
+ end
116
+
117
+ task :"dump_attrs:#{account}" do
118
+ sh("cd #{integration_dir}/build/ && AWS_PROFILE=inspec-aws-test-#{account} terraform output > #{attribute_file}")
119
+ raw_output = File.read(attribute_file)
120
+ yaml_output = raw_output.gsub(" = ", " : ")
121
+ File.open(attribute_file, "w") {|file| file.puts yaml_output}
122
+ end
123
+
124
+ task :"run:#{account}" do
125
+ puts "----> Run"
126
+ sh("bundle exec inspec exec #{integration_dir}/verify -t aws://${AWS_REGION}/inspec-aws-test-#{account} --attrs #{attribute_file}")
127
+ end
128
+
129
+ task :"cleanup:#{account}", :tf_workspace do |t, args|
130
+ tf_workspace = args[:tf_workspace] || ENV['INSPEC_TERRAFORM_ENV']
131
+ abort("You must either call the top-level test:aws:#{account} task, or set the INSPEC_TERRAFORM_ENV variable.") unless tf_workspace
132
+ puts "----> Cleanup"
133
+ sh("cd #{integration_dir}/build/ && AWS_PROFILE=inspec-aws-test-#{account} terraform destroy -force")
134
+ sh("cd #{integration_dir}/build/ && terraform workspace select default")
135
+ sh("cd #{integration_dir}/build && terraform workspace delete #{tf_workspace}")
136
+ end
137
+
138
+ task :"#{account}" do
139
+ tf_workspace = ENV['INSPEC_TERRAFORM_ENV'] || prompt("Please enter a workspace for your integration tests to run in: ")
140
+ begin
141
+ Rake::Task["test:aws:setup:#{account}"].execute({:tf_workspace => tf_workspace})
142
+ Rake::Task["test:aws:run:#{account}"].execute
143
+ rescue
144
+ abort("Integration testing has failed for the #{account} account")
145
+ ensure
146
+ Rake::Task["test:aws:cleanup:#{account}"].execute({:tf_workspace => tf_workspace})
147
+ end
148
+ end
149
+ end
150
+ end
151
+ desc "Perform AWS Integration Tests"
152
+ task aws: [:'aws:default', :'aws:minimal']
153
+
154
+ namespace :azure do
155
+ # Specify the directory for the integration tests
156
+ integration_dir = File.join(project_dir, 'test', 'integration', 'azure')
157
+ tf_vars_file = File.join(integration_dir, 'build', 'terraform.tfvars')
158
+ attribute_file = File.join(integration_dir, '.attribute.yml')
159
+
160
+ task :setup, :tf_workspace do |t, args|
161
+ tf_workspace = args[:tf_workspace] || ENV['INSPEC_TERRAFORM_ENV']
162
+ abort("You must either call the top-level test:azure task, or set the INSPEC_TERRAFORM_ENV variable.") unless tf_workspace
163
+
164
+ puts '----> Setup Terraform Workspace'
165
+
166
+ sh("cd #{integration_dir}/build/ && terraform init -upgrade")
167
+ sh("cd #{integration_dir}/build/ && terraform workspace new #{tf_workspace}")
168
+
169
+ Rake::Task["test:azure:vars"].execute
170
+ Rake::Task["test:azure:plan"].execute
171
+ Rake::Task["test:azure:apply"].execute
172
+ end
173
+
174
+ desc "Generate terraform.tfvars file"
175
+ task :vars do |t, args|
176
+
177
+ next if File.exist?(tf_vars_file)
178
+
179
+ puts '----> Generating Vars'
180
+
181
+ # Generate Azure crendentials
182
+ connection = Train.create('azure').connection
183
+ creds = connection.options
184
+
185
+ # Determine the storage account name and the admin password
186
+ sa_name = (0...15).map { (65 + rand(26)).chr }.join.downcase
187
+ admin_password = Passgen::generate(length: 12, uppercase: true, lowercase: true, symbols: true, digits: true)
188
+
189
+ # Use the first 4 characters of the storage account to create a suffix
190
+ suffix = sa_name[0..3]
191
+
192
+ content = <<~VARS
193
+ subscription_id = "#{creds[:subscription_id]}"
194
+ client_id = "#{creds[:client_id]}"
195
+ client_secret = "#{creds[:client_secret]}"
196
+ tenant_id = "#{creds[:tenant_id]}"
197
+ storage_account_name = "#{sa_name}"
198
+ admin_password = "#{admin_password}"
199
+ suffix = "#{suffix}"
200
+ VARS
201
+
202
+ content << "location = \"#{ENV['AZURE_LOCATION']}\"\n" if ENV['AZURE_LOCATION']
203
+
204
+ File.write(tf_vars_file, content)
205
+ end
206
+
207
+ desc "generate plan from state using terraform.tfvars file"
208
+ task :plan, [:tf_workspace] => [:vars] do |t, args|
209
+ tf_workspace = args[:tf_workspace] || ENV['INSPEC_TERRAFORM_ENV']
210
+ abort("You must set the INSPEC_TERRAFORM_ENV variable.") unless tf_workspace
211
+
212
+ puts '----> Generating Plan'
213
+
214
+ result = sh("cd #{integration_dir}/build/ && terraform workspace select #{tf_workspace}")
215
+
216
+ sh("cd #{integration_dir}/build/ && terraform plan -out inspec-azure.plan")
217
+ end
218
+
219
+ desc "apply terraform plan"
220
+ task :apply, [:tf_workspace] => [:plan] do |t, args|
221
+ tf_workspace = args[:tf_workspace] || ENV['INSPEC_TERRAFORM_ENV']
222
+ abort("You must set the INSPEC_TERRAFORM_ENV variable.") unless tf_workspace
223
+ puts '----> Applying Plan'
224
+
225
+ sh("cd #{integration_dir}/build/ && terraform workspace select #{tf_workspace}")
226
+
227
+ sh("cd #{integration_dir}/build/ && terraform apply inspec-azure.plan")
228
+
229
+ Rake::Task["test:azure:dump_attrs"].execute
230
+ end
231
+
232
+ task :"dump_attrs" do
233
+ sh("cd #{integration_dir}/build/ && terraform output > #{attribute_file}")
234
+ raw_output = File.read(attribute_file)
235
+ yaml_output = raw_output.gsub(" = ", " : ")
236
+ File.open(attribute_file, "w") {|file| file.puts yaml_output}
237
+ end
238
+
239
+ task :run do
240
+ puts '----> Run'
241
+ sh("bundle exec inspec exec #{integration_dir}/verify -t azure://1e0b427a-d58b-494e-ae4f-ee558463ebbf")
242
+ end
243
+
244
+ task :cleanup, :tf_workspace do |t, args|
245
+ tf_workspace = args[:tf_workspace] || ENV['INSPEC_TERRAFORM_ENV']
246
+ abort("You must either call the top-level test:azure task, or set the INSPEC_TERRAFORM_ENV variable.") unless tf_workspace
247
+ puts '----> Cleanup'
248
+
249
+ sh("cd #{integration_dir}/build/ && terraform destroy -force ")
250
+
251
+ sh("cd #{integration_dir}/build/ && terraform workspace select default")
252
+ sh("cd #{integration_dir}/build && terraform workspace delete #{tf_workspace}")
253
+ File.delete(tf_vars_file)
254
+ end
255
+ end
256
+
257
+ desc "Perform Azure Integration Tests"
258
+ task :azure do
259
+ tf_workspace = ENV['INSPEC_TERRAFORM_ENV'] || prompt("Please enter a workspace for your integration tests to run in: ")
260
+ begin
261
+ Rake::Task["test:azure:setup"].execute({:tf_workspace => tf_workspace})
262
+ Rake::Task["test:azure:run"].execute
263
+ rescue
264
+ abort("Integration testing has failed")
265
+ ensure
266
+ Rake::Task["test:azure:cleanup"].execute({:tf_workspace => tf_workspace})
267
+ end
268
+ end
269
+ end
270
+
271
+ # Print the current version of this gem or update it.
272
+ #
273
+ # @param [Type] target the new version you want to set, or nil if you only want to show
274
+ def inspec_version(target = nil)
275
+ path = 'lib/inspec/version.rb'
276
+ require_relative path.sub(/.rb$/, '')
277
+
278
+ nu_version = target.nil? ? '' : " -> #{target}"
279
+ puts "Inspec: #{Inspec::VERSION}#{nu_version}"
280
+
281
+ unless target.nil?
282
+ raw = File.read(path)
283
+ nu = raw.sub(/VERSION.*/, "VERSION = '#{target}'.freeze")
284
+ File.write(path, nu)
285
+ load(path)
286
+ end
287
+ end
288
+
289
+ # Check if a command is available
290
+ #
291
+ # @param [Type] x the command you are interested in
292
+ # @param [Type] msg the message to display if the command is missing
293
+ def require_command(x, msg = nil)
294
+ return if system("command -v #{x} || exit 1")
295
+ msg ||= 'Please install it first!'
296
+ puts "\033[31;1mCan't find command #{x.inspect}. #{msg}\033[0m"
297
+ exit 1
298
+ end
299
+
300
+ # Check if a required environment variable has been set
301
+ #
302
+ # @param [String] x the variable you are interested in
303
+ # @param [String] msg the message you want to display if the variable is missing
304
+ def require_env(x, msg = nil)
305
+ exists = `env | grep "^#{x}="`
306
+ return unless exists.empty?
307
+ puts "\033[31;1mCan't find environment variable #{x.inspect}. #{msg}\033[0m"
308
+ exit 1
309
+ end
310
+
311
+ # Check the requirements for running an update of this repository.
312
+ def check_update_requirements
313
+ require_command 'git'
314
+ end
315
+
316
+ # Show the current version of this gem.
317
+ desc 'Show the version of this gem'
318
+ task :version do
319
+ inspec_version
320
+ end
321
+
322
+ desc 'Release a new docker image'
323
+ task :release_docker do
324
+ version = Inspec::VERSION
325
+ cmd = "rm *.gem; gem build *gemspec && "\
326
+ "mv *.gem inspec.gem && "\
327
+ "docker build -t chef/inspec:#{version} . && "\
328
+ "docker push chef/inspec:#{version} && "\
329
+ "docker tag chef/inspec:#{version} chef/inspec:latest &&"\
330
+ "docker push chef/inspec:latest"
331
+ puts "--> #{cmd}"
332
+ sh('sh', '-c', cmd)
333
+ end
334
+
335
+ desc 'Release the website [deprecated]'
336
+ task :www do
337
+ puts 'The Rake tasks for releasing the website are now in the www/ directory.'
338
+ puts 'Run `cd www` and then `rake --tasks` for a list of the www-related tasks available.'
339
+ exit(1)
340
+ end
341
+
342
+ namespace :www do
343
+ desc 'Release the website [deprecated]'
344
+ task :release do
345
+ puts 'The Rake tasks for releasing the website are now in the www/ directory.'
346
+ puts 'Run `cd www` and then `rake --tasks` for a list of the www-related tasks available.'
347
+ exit(1)
348
+ end
349
+ end