inspec 1.51.6 → 1.51.15

Sign up to get free protection for your applications and to get access to all the features.
Files changed (404) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +101 -101
  3. data/CHANGELOG.md +2915 -2902
  4. data/Gemfile +53 -53
  5. data/LICENSE +14 -14
  6. data/MAINTAINERS.md +31 -31
  7. data/MAINTAINERS.toml +47 -47
  8. data/README.md +419 -419
  9. data/Rakefile +167 -167
  10. data/bin/inspec +12 -12
  11. data/docs/.gitignore +2 -2
  12. data/docs/README.md +40 -40
  13. data/docs/dsl_inspec.md +258 -258
  14. data/docs/dsl_resource.md +93 -93
  15. data/docs/glossary.md +99 -99
  16. data/docs/habitat.md +191 -191
  17. data/docs/inspec_and_friends.md +107 -107
  18. data/docs/matchers.md +165 -165
  19. data/docs/migration.md +293 -293
  20. data/docs/plugin_kitchen_inspec.md +49 -49
  21. data/docs/profiles.md +370 -370
  22. data/docs/resources/aide_conf.md.erb +78 -78
  23. data/docs/resources/apache.md.erb +66 -66
  24. data/docs/resources/apache_conf.md.erb +67 -67
  25. data/docs/resources/apt.md.erb +70 -70
  26. data/docs/resources/audit_policy.md.erb +46 -46
  27. data/docs/resources/auditd.md.erb +78 -78
  28. data/docs/resources/auditd_conf.md.erb +68 -68
  29. data/docs/resources/auditd_rules.md.erb +116 -116
  30. data/docs/resources/bash.md.erb +74 -74
  31. data/docs/resources/bond.md.erb +89 -89
  32. data/docs/resources/bridge.md.erb +54 -54
  33. data/docs/resources/bsd_service.md.erb +65 -65
  34. data/docs/resources/command.md.erb +137 -137
  35. data/docs/resources/cpan.md.erb +77 -77
  36. data/docs/resources/cran.md.erb +63 -63
  37. data/docs/resources/crontab.md.erb +87 -87
  38. data/docs/resources/csv.md.erb +53 -53
  39. data/docs/resources/dh_params.md.erb +216 -216
  40. data/docs/resources/directory.md.erb +28 -28
  41. data/docs/resources/docker.md.erb +163 -163
  42. data/docs/resources/docker_container.md.erb +99 -99
  43. data/docs/resources/docker_image.md.erb +93 -93
  44. data/docs/resources/docker_service.md.erb +113 -113
  45. data/docs/resources/elasticsearch.md.erb +230 -230
  46. data/docs/resources/etc_fstab.md.erb +124 -124
  47. data/docs/resources/etc_group.md.erb +74 -74
  48. data/docs/resources/etc_hosts.md.erb +75 -75
  49. data/docs/resources/etc_hosts_allow.md.erb +73 -73
  50. data/docs/resources/etc_hosts_deny.md.erb +73 -73
  51. data/docs/resources/file.md.erb +512 -512
  52. data/docs/resources/filesystem.md.erb +40 -40
  53. data/docs/resources/firewalld.md.erb +105 -105
  54. data/docs/resources/gem.md.erb +78 -78
  55. data/docs/resources/group.md.erb +60 -60
  56. data/docs/resources/grub_conf.md.erb +101 -100
  57. data/docs/resources/host.md.erb +77 -77
  58. data/docs/resources/http.md.erb +104 -98
  59. data/docs/resources/iis_app.md.erb +120 -116
  60. data/docs/resources/iis_site.md.erb +132 -128
  61. data/docs/resources/inetd_conf.md.erb +95 -84
  62. data/docs/resources/ini.md.erb +72 -69
  63. data/docs/resources/interface.md.erb +55 -46
  64. data/docs/resources/iptables.md.erb +63 -63
  65. data/docs/resources/json.md.erb +61 -61
  66. data/docs/resources/kernel_module.md.erb +106 -106
  67. data/docs/resources/kernel_parameter.md.erb +58 -58
  68. data/docs/resources/key_rsa.md.erb +73 -73
  69. data/docs/resources/launchd_service.md.erb +56 -56
  70. data/docs/resources/limits_conf.md.erb +66 -66
  71. data/docs/resources/login_def.md.erb +62 -62
  72. data/docs/resources/mount.md.erb +68 -68
  73. data/docs/resources/mssql_session.md.erb +59 -59
  74. data/docs/resources/mysql_conf.md.erb +98 -98
  75. data/docs/resources/mysql_session.md.erb +73 -73
  76. data/docs/resources/nginx.md.erb +78 -78
  77. data/docs/resources/nginx_conf.md.erb +127 -127
  78. data/docs/resources/npm.md.erb +59 -59
  79. data/docs/resources/ntp_conf.md.erb +59 -59
  80. data/docs/resources/oneget.md.erb +52 -52
  81. data/docs/resources/oracledb_session.md.erb +51 -51
  82. data/docs/resources/os.md.erb +140 -140
  83. data/docs/resources/os_env.md.erb +77 -77
  84. data/docs/resources/package.md.erb +119 -119
  85. data/docs/resources/packages.md.erb +66 -66
  86. data/docs/resources/parse_config.md.erb +102 -102
  87. data/docs/resources/parse_config_file.md.erb +137 -137
  88. data/docs/resources/passwd.md.erb +140 -140
  89. data/docs/resources/pip.md.erb +66 -66
  90. data/docs/resources/port.md.erb +136 -136
  91. data/docs/resources/postgres_conf.md.erb +78 -78
  92. data/docs/resources/postgres_hba_conf.md.erb +92 -92
  93. data/docs/resources/postgres_ident_conf.md.erb +75 -75
  94. data/docs/resources/postgres_session.md.erb +68 -68
  95. data/docs/resources/powershell.md.erb +101 -101
  96. data/docs/resources/processes.md.erb +107 -107
  97. data/docs/resources/rabbitmq_config.md.erb +40 -40
  98. data/docs/resources/registry_key.md.erb +157 -157
  99. data/docs/resources/runit_service.md.erb +56 -56
  100. data/docs/resources/security_policy.md.erb +46 -46
  101. data/docs/resources/service.md.erb +120 -120
  102. data/docs/resources/shadow.md.erb +143 -143
  103. data/docs/resources/ssh_config.md.erb +79 -79
  104. data/docs/resources/sshd_config.md.erb +82 -82
  105. data/docs/resources/ssl.md.erb +118 -118
  106. data/docs/resources/sys_info.md.erb +41 -41
  107. data/docs/resources/systemd_service.md.erb +56 -56
  108. data/docs/resources/sysv_service.md.erb +56 -56
  109. data/docs/resources/upstart_service.md.erb +56 -56
  110. data/docs/resources/user.md.erb +139 -139
  111. data/docs/resources/users.md.erb +126 -126
  112. data/docs/resources/vbscript.md.erb +54 -54
  113. data/docs/resources/virtualization.md.erb +56 -56
  114. data/docs/resources/windows_feature.md.erb +46 -46
  115. data/docs/resources/windows_hotfix.md.erb +52 -52
  116. data/docs/resources/windows_task.md.erb +89 -89
  117. data/docs/resources/wmi.md.erb +80 -80
  118. data/docs/resources/x509_certificate.md.erb +150 -150
  119. data/docs/resources/xinetd_conf.md.erb +155 -155
  120. data/docs/resources/xml.md.erb +84 -84
  121. data/docs/resources/yaml.md.erb +68 -68
  122. data/docs/resources/yum.md.erb +97 -97
  123. data/docs/resources/zfs_dataset.md.erb +52 -52
  124. data/docs/resources/zfs_pool.md.erb +46 -46
  125. data/docs/ruby_usage.md +203 -203
  126. data/docs/shared/matcher_be.md.erb +1 -1
  127. data/docs/shared/matcher_cmp.md.erb +43 -43
  128. data/docs/shared/matcher_eq.md.erb +3 -3
  129. data/docs/shared/matcher_include.md.erb +1 -1
  130. data/docs/shared/matcher_match.md.erb +1 -1
  131. data/docs/shell.md +172 -172
  132. data/examples/README.md +8 -8
  133. data/examples/inheritance/README.md +65 -65
  134. data/examples/inheritance/controls/example.rb +14 -14
  135. data/examples/inheritance/inspec.yml +15 -15
  136. data/examples/kitchen-ansible/.kitchen.yml +25 -25
  137. data/examples/kitchen-ansible/Gemfile +19 -19
  138. data/examples/kitchen-ansible/README.md +53 -53
  139. data/examples/kitchen-ansible/files/nginx.repo +6 -6
  140. data/examples/kitchen-ansible/tasks/main.yml +16 -16
  141. data/examples/kitchen-ansible/test/integration/default/default.yml +5 -5
  142. data/examples/kitchen-ansible/test/integration/default/web_spec.rb +28 -28
  143. data/examples/kitchen-chef/.kitchen.yml +20 -20
  144. data/examples/kitchen-chef/Berksfile +3 -3
  145. data/examples/kitchen-chef/Gemfile +19 -19
  146. data/examples/kitchen-chef/README.md +27 -27
  147. data/examples/kitchen-chef/metadata.rb +7 -7
  148. data/examples/kitchen-chef/recipes/default.rb +6 -6
  149. data/examples/kitchen-chef/recipes/nginx.rb +30 -30
  150. data/examples/kitchen-chef/test/integration/default/web_spec.rb +28 -28
  151. data/examples/kitchen-puppet/.kitchen.yml +22 -22
  152. data/examples/kitchen-puppet/Gemfile +20 -20
  153. data/examples/kitchen-puppet/Puppetfile +25 -25
  154. data/examples/kitchen-puppet/README.md +53 -53
  155. data/examples/kitchen-puppet/manifests/site.pp +33 -33
  156. data/examples/kitchen-puppet/metadata.json +11 -11
  157. data/examples/kitchen-puppet/test/integration/default/web_spec.rb +28 -28
  158. data/examples/meta-profile/README.md +37 -37
  159. data/examples/meta-profile/controls/example.rb +13 -13
  160. data/examples/meta-profile/inspec.yml +13 -13
  161. data/examples/profile-attribute.yml +2 -2
  162. data/examples/profile-attribute/README.md +14 -14
  163. data/examples/profile-attribute/controls/example.rb +11 -11
  164. data/examples/profile-attribute/inspec.yml +8 -8
  165. data/examples/profile-sensitive/README.md +29 -29
  166. data/examples/profile-sensitive/controls/sensitive-failures.rb +9 -9
  167. data/examples/profile-sensitive/controls/sensitive.rb +9 -9
  168. data/examples/profile-sensitive/inspec.yml +8 -8
  169. data/examples/profile/README.md +48 -48
  170. data/examples/profile/controls/example.rb +23 -23
  171. data/examples/profile/controls/gordon.rb +36 -36
  172. data/examples/profile/controls/meta.rb +34 -34
  173. data/examples/profile/inspec.yml +10 -10
  174. data/examples/profile/libraries/gordon_config.rb +53 -53
  175. data/inspec.gemspec +47 -47
  176. data/lib/bundles/README.md +3 -3
  177. data/lib/bundles/inspec-artifact.rb +7 -7
  178. data/lib/bundles/inspec-artifact/README.md +1 -1
  179. data/lib/bundles/inspec-artifact/cli.rb +277 -277
  180. data/lib/bundles/inspec-compliance.rb +16 -16
  181. data/lib/bundles/inspec-compliance/.kitchen.yml +20 -20
  182. data/lib/bundles/inspec-compliance/README.md +185 -185
  183. data/lib/bundles/inspec-compliance/api.rb +316 -316
  184. data/lib/bundles/inspec-compliance/api/login.rb +152 -152
  185. data/lib/bundles/inspec-compliance/bootstrap.sh +41 -41
  186. data/lib/bundles/inspec-compliance/cli.rb +277 -277
  187. data/lib/bundles/inspec-compliance/configuration.rb +103 -103
  188. data/lib/bundles/inspec-compliance/http.rb +86 -86
  189. data/lib/bundles/inspec-compliance/support.rb +36 -36
  190. data/lib/bundles/inspec-compliance/target.rb +98 -98
  191. data/lib/bundles/inspec-compliance/test/integration/default/cli.rb +93 -93
  192. data/lib/bundles/inspec-habitat.rb +12 -12
  193. data/lib/bundles/inspec-habitat/cli.rb +36 -36
  194. data/lib/bundles/inspec-habitat/log.rb +10 -10
  195. data/lib/bundles/inspec-habitat/profile.rb +390 -390
  196. data/lib/bundles/inspec-init.rb +8 -8
  197. data/lib/bundles/inspec-init/README.md +31 -31
  198. data/lib/bundles/inspec-init/cli.rb +97 -97
  199. data/lib/bundles/inspec-init/templates/profile/README.md +3 -3
  200. data/lib/bundles/inspec-init/templates/profile/controls/example.rb +19 -19
  201. data/lib/bundles/inspec-init/templates/profile/inspec.yml +8 -8
  202. data/lib/bundles/inspec-supermarket.rb +13 -13
  203. data/lib/bundles/inspec-supermarket/README.md +45 -45
  204. data/lib/bundles/inspec-supermarket/api.rb +84 -84
  205. data/lib/bundles/inspec-supermarket/cli.rb +65 -65
  206. data/lib/bundles/inspec-supermarket/target.rb +34 -34
  207. data/lib/fetchers/git.rb +163 -163
  208. data/lib/fetchers/local.rb +74 -74
  209. data/lib/fetchers/mock.rb +35 -35
  210. data/lib/fetchers/url.rb +204 -204
  211. data/lib/inspec.rb +24 -24
  212. data/lib/inspec/archive/tar.rb +29 -29
  213. data/lib/inspec/archive/zip.rb +19 -19
  214. data/lib/inspec/backend.rb +92 -92
  215. data/lib/inspec/base_cli.rb +324 -322
  216. data/lib/inspec/cached_fetcher.rb +66 -66
  217. data/lib/inspec/cli.rb +298 -298
  218. data/lib/inspec/completions/bash.sh.erb +45 -45
  219. data/lib/inspec/completions/fish.sh.erb +34 -34
  220. data/lib/inspec/completions/zsh.sh.erb +61 -61
  221. data/lib/inspec/control_eval_context.rb +179 -179
  222. data/lib/inspec/dependencies/cache.rb +72 -72
  223. data/lib/inspec/dependencies/dependency_set.rb +92 -92
  224. data/lib/inspec/dependencies/lockfile.rb +115 -115
  225. data/lib/inspec/dependencies/requirement.rb +123 -123
  226. data/lib/inspec/dependencies/resolver.rb +86 -86
  227. data/lib/inspec/describe.rb +27 -27
  228. data/lib/inspec/dsl.rb +66 -66
  229. data/lib/inspec/dsl_shared.rb +33 -33
  230. data/lib/inspec/env_printer.rb +157 -157
  231. data/lib/inspec/errors.rb +13 -13
  232. data/lib/inspec/exceptions.rb +12 -12
  233. data/lib/inspec/expect.rb +45 -45
  234. data/lib/inspec/fetcher.rb +45 -45
  235. data/lib/inspec/file_provider.rb +275 -275
  236. data/lib/inspec/formatters.rb +3 -3
  237. data/lib/inspec/formatters/base.rb +208 -208
  238. data/lib/inspec/formatters/json_rspec.rb +20 -20
  239. data/lib/inspec/formatters/show_progress.rb +12 -12
  240. data/lib/inspec/library_eval_context.rb +58 -58
  241. data/lib/inspec/log.rb +11 -11
  242. data/lib/inspec/metadata.rb +253 -253
  243. data/lib/inspec/method_source.rb +24 -24
  244. data/lib/inspec/objects.rb +14 -14
  245. data/lib/inspec/objects/attribute.rb +65 -65
  246. data/lib/inspec/objects/control.rb +61 -61
  247. data/lib/inspec/objects/describe.rb +92 -92
  248. data/lib/inspec/objects/each_loop.rb +36 -36
  249. data/lib/inspec/objects/list.rb +15 -15
  250. data/lib/inspec/objects/or_test.rb +40 -40
  251. data/lib/inspec/objects/ruby_helper.rb +15 -15
  252. data/lib/inspec/objects/tag.rb +27 -27
  253. data/lib/inspec/objects/test.rb +87 -87
  254. data/lib/inspec/objects/value.rb +27 -27
  255. data/lib/inspec/plugins.rb +60 -60
  256. data/lib/inspec/plugins/cli.rb +24 -24
  257. data/lib/inspec/plugins/fetcher.rb +86 -86
  258. data/lib/inspec/plugins/resource.rb +132 -132
  259. data/lib/inspec/plugins/secret.rb +15 -15
  260. data/lib/inspec/plugins/source_reader.rb +40 -40
  261. data/lib/inspec/polyfill.rb +12 -12
  262. data/lib/inspec/profile.rb +510 -510
  263. data/lib/inspec/profile_context.rb +207 -207
  264. data/lib/inspec/profile_vendor.rb +66 -66
  265. data/lib/inspec/reporters.rb +50 -33
  266. data/lib/inspec/reporters/base.rb +24 -23
  267. data/lib/inspec/reporters/cli.rb +395 -395
  268. data/lib/inspec/reporters/json.rb +134 -132
  269. data/lib/inspec/reporters/json_min.rb +48 -44
  270. data/lib/inspec/reporters/junit.rb +77 -77
  271. data/lib/inspec/require_loader.rb +33 -33
  272. data/lib/inspec/resource.rb +176 -176
  273. data/lib/inspec/rule.rb +266 -266
  274. data/lib/inspec/runner.rb +340 -337
  275. data/lib/inspec/runner_mock.rb +41 -41
  276. data/lib/inspec/runner_rspec.rb +163 -185
  277. data/lib/inspec/runtime_profile.rb +26 -26
  278. data/lib/inspec/schema.rb +186 -186
  279. data/lib/inspec/secrets.rb +19 -19
  280. data/lib/inspec/secrets/yaml.rb +30 -30
  281. data/lib/inspec/shell.rb +223 -223
  282. data/lib/inspec/shell_detector.rb +90 -90
  283. data/lib/inspec/source_reader.rb +29 -29
  284. data/lib/inspec/version.rb +8 -8
  285. data/lib/matchers/matchers.rb +397 -397
  286. data/lib/resources/aide_conf.rb +160 -160
  287. data/lib/resources/apache.rb +49 -49
  288. data/lib/resources/apache_conf.rb +158 -158
  289. data/lib/resources/apt.rb +150 -150
  290. data/lib/resources/audit_policy.rb +64 -64
  291. data/lib/resources/auditd.rb +233 -233
  292. data/lib/resources/auditd_conf.rb +56 -56
  293. data/lib/resources/auditd_rules.rb +205 -205
  294. data/lib/resources/bash.rb +36 -36
  295. data/lib/resources/bond.rb +69 -69
  296. data/lib/resources/bridge.rb +123 -123
  297. data/lib/resources/command.rb +69 -69
  298. data/lib/resources/cpan.rb +60 -60
  299. data/lib/resources/cran.rb +66 -66
  300. data/lib/resources/crontab.rb +169 -169
  301. data/lib/resources/csv.rb +58 -58
  302. data/lib/resources/dh_params.rb +83 -83
  303. data/lib/resources/directory.rb +25 -25
  304. data/lib/resources/docker.rb +239 -239
  305. data/lib/resources/docker_container.rb +92 -92
  306. data/lib/resources/docker_image.rb +86 -86
  307. data/lib/resources/docker_object.rb +57 -57
  308. data/lib/resources/docker_service.rb +94 -94
  309. data/lib/resources/elasticsearch.rb +168 -168
  310. data/lib/resources/etc_fstab.rb +102 -102
  311. data/lib/resources/etc_group.rb +157 -157
  312. data/lib/resources/etc_hosts.rb +81 -81
  313. data/lib/resources/etc_hosts_allow_deny.rb +122 -122
  314. data/lib/resources/file.rb +298 -298
  315. data/lib/resources/filesystem.rb +31 -31
  316. data/lib/resources/firewalld.rb +144 -144
  317. data/lib/resources/gem.rb +71 -71
  318. data/lib/resources/groups.rb +213 -213
  319. data/lib/resources/grub_conf.rb +237 -237
  320. data/lib/resources/host.rb +300 -300
  321. data/lib/resources/http.rb +252 -252
  322. data/lib/resources/iis_app.rb +103 -103
  323. data/lib/resources/iis_site.rb +147 -147
  324. data/lib/resources/inetd_conf.rb +63 -63
  325. data/lib/resources/ini.rb +29 -29
  326. data/lib/resources/interface.rb +130 -130
  327. data/lib/resources/iptables.rb +70 -70
  328. data/lib/resources/json.rb +115 -115
  329. data/lib/resources/kernel_module.rb +110 -110
  330. data/lib/resources/kernel_parameter.rb +58 -58
  331. data/lib/resources/key_rsa.rb +67 -67
  332. data/lib/resources/limits_conf.rb +56 -56
  333. data/lib/resources/login_def.rb +67 -67
  334. data/lib/resources/mount.rb +90 -90
  335. data/lib/resources/mssql_session.rb +103 -103
  336. data/lib/resources/mysql.rb +82 -82
  337. data/lib/resources/mysql_conf.rb +133 -133
  338. data/lib/resources/mysql_session.rb +72 -72
  339. data/lib/resources/nginx.rb +97 -97
  340. data/lib/resources/nginx_conf.rb +228 -228
  341. data/lib/resources/npm.rb +48 -48
  342. data/lib/resources/ntp_conf.rb +59 -59
  343. data/lib/resources/oneget.rb +72 -72
  344. data/lib/resources/oracledb_session.rb +140 -140
  345. data/lib/resources/os.rb +46 -46
  346. data/lib/resources/os_env.rb +76 -76
  347. data/lib/resources/package.rb +357 -357
  348. data/lib/resources/packages.rb +112 -112
  349. data/lib/resources/parse_config.rb +116 -116
  350. data/lib/resources/passwd.rb +96 -96
  351. data/lib/resources/pip.rb +89 -89
  352. data/lib/resources/platform.rb +112 -112
  353. data/lib/resources/port.rb +771 -771
  354. data/lib/resources/postgres.rb +132 -132
  355. data/lib/resources/postgres_conf.rb +122 -122
  356. data/lib/resources/postgres_hba_conf.rb +101 -101
  357. data/lib/resources/postgres_ident_conf.rb +79 -79
  358. data/lib/resources/postgres_session.rb +72 -72
  359. data/lib/resources/powershell.rb +58 -58
  360. data/lib/resources/processes.rb +204 -204
  361. data/lib/resources/rabbitmq_conf.rb +53 -53
  362. data/lib/resources/registry_key.rb +296 -296
  363. data/lib/resources/security_policy.rb +181 -181
  364. data/lib/resources/service.rb +784 -784
  365. data/lib/resources/shadow.rb +141 -141
  366. data/lib/resources/ssh_conf.rb +102 -102
  367. data/lib/resources/ssl.rb +99 -99
  368. data/lib/resources/sys_info.rb +26 -26
  369. data/lib/resources/toml.rb +32 -32
  370. data/lib/resources/users.rb +652 -652
  371. data/lib/resources/vbscript.rb +70 -70
  372. data/lib/resources/virtualization.rb +251 -251
  373. data/lib/resources/windows_feature.rb +85 -85
  374. data/lib/resources/windows_hotfix.rb +35 -35
  375. data/lib/resources/windows_task.rb +106 -106
  376. data/lib/resources/wmi.rb +114 -114
  377. data/lib/resources/x509_certificate.rb +143 -143
  378. data/lib/resources/xinetd.rb +112 -112
  379. data/lib/resources/xml.rb +45 -45
  380. data/lib/resources/yaml.rb +45 -45
  381. data/lib/resources/yum.rb +181 -181
  382. data/lib/resources/zfs_dataset.rb +60 -60
  383. data/lib/resources/zfs_pool.rb +49 -49
  384. data/lib/source_readers/flat.rb +39 -39
  385. data/lib/source_readers/inspec.rb +75 -75
  386. data/lib/utils/command_wrapper.rb +27 -27
  387. data/lib/utils/convert.rb +12 -12
  388. data/lib/utils/database_helpers.rb +77 -77
  389. data/lib/utils/erlang_parser.rb +192 -192
  390. data/lib/utils/filter.rb +272 -272
  391. data/lib/utils/filter_array.rb +27 -27
  392. data/lib/utils/find_files.rb +44 -44
  393. data/lib/utils/hash.rb +41 -41
  394. data/lib/utils/json_log.rb +18 -18
  395. data/lib/utils/latest_version.rb +22 -22
  396. data/lib/utils/modulator.rb +12 -12
  397. data/lib/utils/nginx_parser.rb +85 -85
  398. data/lib/utils/object_traversal.rb +49 -49
  399. data/lib/utils/parser.rb +274 -274
  400. data/lib/utils/plugin_registry.rb +93 -93
  401. data/lib/utils/simpleconfig.rb +132 -132
  402. data/lib/utils/spdx.rb +13 -13
  403. data/lib/utils/spdx.txt +343 -343
  404. metadata +2 -2
@@ -1,33 +1,50 @@
1
- require 'inspec/reporters/base'
2
- require 'inspec/reporters/cli'
3
- require 'inspec/reporters/json'
4
- require 'inspec/reporters/json_min'
5
- require 'inspec/reporters/junit'
6
-
7
- module Inspec::Reporters
8
- def self.render(reporter, run_data)
9
- name, config = reporter
10
- config[:run_data] = run_data
11
- case name
12
- when 'cli'
13
- reporter = Inspec::Reporters::CLI.new(config)
14
- when 'json'
15
- reporter = Inspec::Reporters::Json.new(config)
16
- when 'json-min'
17
- reporter = Inspec::Reporters::JsonMin.new(config)
18
- when 'junit'
19
- reporter = Inspec::Reporters::Junit.new(config)
20
- else
21
- raise NotImplementedError, "'#{name}' is not a valid reporter type."
22
- end
23
-
24
- reporter.render
25
- output = reporter.rendered_output
26
-
27
- if config['file']
28
- File.write(config['file'], output)
29
- elsif config['stdout'] == true
30
- puts output
31
- end
32
- end
33
- end
1
+ require 'inspec/reporters/base'
2
+ require 'inspec/reporters/cli'
3
+ require 'inspec/reporters/json'
4
+ require 'inspec/reporters/json_min'
5
+ require 'inspec/reporters/junit'
6
+
7
+ module Inspec::Reporters
8
+ def self.render(reporter, run_data)
9
+ name, config = reporter.dup
10
+ config[:run_data] = run_data
11
+ case name
12
+ when 'cli'
13
+ reporter = Inspec::Reporters::CLI.new(config)
14
+ when 'json'
15
+ reporter = Inspec::Reporters::Json.new(config)
16
+ when 'json-min'
17
+ reporter = Inspec::Reporters::JsonMin.new(config)
18
+ when 'junit'
19
+ reporter = Inspec::Reporters::Junit.new(config)
20
+ else
21
+ raise NotImplementedError, "'#{name}' is not a valid reporter type."
22
+ end
23
+
24
+ reporter.render
25
+ output = reporter.rendered_output
26
+
27
+ if config['file']
28
+ File.write(config['file'], output)
29
+ elsif config['stdout'] == true
30
+ print output
31
+ STDOUT.flush
32
+ end
33
+ end
34
+
35
+ def self.report(reporter, run_data)
36
+ name, config = reporter.dup
37
+ config[:run_data] = run_data
38
+ case name
39
+ when 'json'
40
+ reporter = Inspec::Reporters::Json.new(config)
41
+ when 'json-min'
42
+ reporter = Inspec::Reporters::JsonMin.new(config)
43
+ else
44
+ # use base run_data hash for any other report
45
+ return run_data
46
+ end
47
+
48
+ reporter.report
49
+ end
50
+ end
@@ -1,23 +1,24 @@
1
- module Inspec::Reporters
2
- class Base
3
- attr_reader :run_data
4
-
5
- def initialize(config)
6
- @run_data = config[:run_data]
7
- @output = ''
8
- end
9
-
10
- def output(str)
11
- @output << "#{str}\n"
12
- end
13
-
14
- def rendered_output
15
- @output
16
- end
17
-
18
- # each reporter must implement #render
19
- def render
20
- raise NotImplementedError, "#{self.class} must implement a `#render` method to format its output."
21
- end
22
- end
23
- end
1
+ module Inspec::Reporters
2
+ class Base
3
+ attr_reader :run_data
4
+
5
+ def initialize(config)
6
+ @run_data = config[:run_data]
7
+ @output = ''
8
+ end
9
+
10
+ def output(str, newline = true)
11
+ @output << str
12
+ @output << "\n" if newline
13
+ end
14
+
15
+ def rendered_output
16
+ @output
17
+ end
18
+
19
+ # each reporter must implement #render
20
+ def render
21
+ raise NotImplementedError, "#{self.class} must implement a `#render` method to format its output."
22
+ end
23
+ end
24
+ end
@@ -1,395 +1,395 @@
1
- # encoding: utf-8
2
-
3
- module Inspec::Reporters
4
- class CLI < Base
5
- case RUBY_PLATFORM
6
- when /windows|mswin|msys|mingw|cygwin/
7
- # Most currently available Windows terminals have poor support
8
- # for ANSI extended colors
9
- COLORS = {
10
- 'critical' => "\033[0;1;31m",
11
- 'major' => "\033[0;1;31m",
12
- 'minor' => "\033[0;36m",
13
- 'failed' => "\033[0;1;31m",
14
- 'passed' => "\033[0;1;32m",
15
- 'skipped' => "\033[0;37m",
16
- 'reset' => "\033[0m",
17
- }.freeze
18
-
19
- # Most currently available Windows terminals have poor support
20
- # for UTF-8 characters so use these boring indicators
21
- INDICATORS = {
22
- 'critical' => '[CRIT]',
23
- 'major' => '[MAJR]',
24
- 'minor' => '[MINR]',
25
- 'failed' => '[FAIL]',
26
- 'skipped' => '[SKIP]',
27
- 'passed' => '[PASS]',
28
- 'unknown' => '[UNKN]',
29
- }.freeze
30
- else
31
- # Extended colors for everyone else
32
- COLORS = {
33
- 'critical' => "\033[38;5;9m",
34
- 'major' => "\033[38;5;208m",
35
- 'minor' => "\033[0;36m",
36
- 'failed' => "\033[38;5;9m",
37
- 'passed' => "\033[38;5;41m",
38
- 'skipped' => "\033[38;5;247m",
39
- 'reset' => "\033[0m",
40
- }.freeze
41
-
42
- # Groovy UTF-8 characters for everyone else...
43
- # ...even though they probably only work on Mac
44
- INDICATORS = {
45
- 'critical' => '×',
46
- 'major' => '∅',
47
- 'minor' => '⊚',
48
- 'failed' => '×',
49
- 'skipped' => '↺',
50
- 'passed' => '✔',
51
- 'unknown' => '?',
52
- }.freeze
53
- end
54
-
55
- MULTI_TEST_CONTROL_SUMMARY_MAX_LEN = 60
56
-
57
- def render
58
- run_data[:profiles].each do |profile|
59
- @control_count = 0
60
- output('')
61
- print_profile_header(profile)
62
- print_standard_control_results(profile)
63
- print_anonymous_control_results(profile)
64
- output(format_message(
65
- indentation: 5,
66
- message: 'No tests executed.',
67
- )) if @control_count == 0
68
- end
69
-
70
- output('')
71
- print_profile_summary
72
- print_tests_summary
73
- end
74
-
75
- private
76
-
77
- def print_profile_header(profile)
78
- output("Profile: #{format_profile_name(profile)}")
79
- output("Version: #{profile[:version] || '(not specified)'}")
80
- output("Target: #{run_data[:platform][:target]}") unless run_data[:platform][:target].nil?
81
- output('')
82
- end
83
-
84
- def print_standard_control_results(profile)
85
- standard_controls_from_profile(profile).each do |control_from_profile|
86
- control = Control.new(control_from_profile)
87
- next if control.results.nil?
88
- output(format_control_header(control))
89
- control.results.each do |result|
90
- output(format_result(control, result, :standard))
91
- @control_count += 1
92
- end
93
- end
94
- output('') if @control_count > 0
95
- end
96
-
97
- def print_anonymous_control_results(profile)
98
- anonymous_controls_from_profile(profile).each do |control_from_profile|
99
- control = Control.new(control_from_profile)
100
- next if control.results.nil?
101
- output(format_control_header(control))
102
- control.results.each do |result|
103
- output(format_result(control, result, :anonymous))
104
- @control_count += 1
105
- end
106
- end
107
- end
108
-
109
- def format_profile_name(profile)
110
- if profile[:title].nil?
111
- (profile[:name] || 'unknown').to_s
112
- else
113
- "#{profile[:title]} (#{profile[:name] || 'unknown'})"
114
- end
115
- end
116
-
117
- def format_control_header(control)
118
- impact = control.impact_string
119
- format_message(
120
- color: impact,
121
- indicator: impact,
122
- message: control.title_for_report,
123
- )
124
- end
125
-
126
- def format_result(control, result, type)
127
- impact = control.impact_string_for_result(result)
128
-
129
- message = if result[:status] == 'skipped'
130
- result[:skip_message]
131
- elsif type == :anonymous
132
- result[:expectation_message]
133
- else
134
- result[:code_desc]
135
- end
136
-
137
- # append any failure details to the message if they exist
138
- message += "\n#{result[:message]}" if result[:message]
139
-
140
- format_message(
141
- color: impact,
142
- indicator: impact,
143
- indentation: 5,
144
- message: message,
145
- )
146
- end
147
-
148
- def format_message(message_info)
149
- indicator = message_info[:indicator]
150
- color = message_info[:color]
151
- indentation = message_info.fetch(:indentation, 2)
152
- message = message_info[:message]
153
-
154
- message_to_format = ''
155
- message_to_format += "#{INDICATORS[indicator]} " unless indicator.nil?
156
- message_to_format += message.to_s.lstrip
157
-
158
- format_with_color(color, indent_lines(message_to_format, indentation))
159
- end
160
-
161
- def format_with_color(color_name, text)
162
- return text if defined?(RSpec.configuration) && !RSpec.configuration.color
163
- return text unless COLORS.key?(color_name)
164
-
165
- "#{COLORS[color_name]}#{text}#{COLORS['reset']}"
166
- end
167
-
168
- def all_unique_controls
169
- return @unique_controls unless @unique_controls.nil?
170
-
171
- @unique_controls = Set.new
172
- run_data[:profiles].each do |profile|
173
- profile[:controls].map { |control| @unique_controls.add(control) }
174
- end
175
-
176
- @unique_controls
177
- end
178
-
179
- def profile_summary
180
- return @profile_summary unless @profile_summary.nil?
181
-
182
- failed = 0
183
- skipped = 0
184
- passed = 0
185
- critical = 0
186
- major = 0
187
- minor = 0
188
-
189
- all_unique_controls.each do |control|
190
- next if control[:id].start_with? '(generated from '
191
- next unless control[:results]
192
- if control[:results].any? { |r| r[:status] == 'failed' }
193
- failed += 1
194
- if control[:impact] >= 0.7
195
- critical += 1
196
- elsif control[:impact] >= 0.4
197
- major += 1
198
- else
199
- minor += 1
200
- end
201
- elsif control[:results].any? { |r| r[:status] == 'skipped' }
202
- skipped += 1
203
- else
204
- passed += 1
205
- end
206
- end
207
-
208
- total = failed + passed + skipped
209
-
210
- @profile_summary = {
211
- 'total' => total,
212
- 'failed' => {
213
- 'total' => failed,
214
- 'critical' => critical,
215
- 'major' => major,
216
- 'minor' => minor,
217
- },
218
- 'skipped' => skipped,
219
- 'passed' => passed,
220
- }
221
- end
222
-
223
- def tests_summary
224
- return @tests_summary unless @tests_summary.nil?
225
-
226
- total = 0
227
- failed = 0
228
- skipped = 0
229
- passed = 0
230
-
231
- all_unique_controls.each do |control|
232
- next unless control[:results]
233
- control[:results].each do |result|
234
- if result[:status] == 'failed'
235
- failed += 1
236
- elsif result[:status] == 'skipped'
237
- skipped += 1
238
- else
239
- passed += 1
240
- end
241
- end
242
- end
243
-
244
- @tests_summary = { 'total' => total, 'failed' => failed, 'skipped' => skipped, 'passed' => passed }
245
- end
246
-
247
- def print_profile_summary
248
- summary = profile_summary
249
- return unless summary['total'] > 0
250
-
251
- success_str = summary['passed'] == 1 ? '1 successful control' : "#{summary['passed']} successful controls"
252
- failed_str = summary['failed']['total'] == 1 ? '1 control failure' : "#{summary['failed']['total']} control failures"
253
- skipped_str = summary['skipped'] == 1 ? '1 control skipped' : "#{summary['skipped']} controls skipped"
254
-
255
- success_color = summary['passed'] > 0 ? 'passed' : 'no_color'
256
- failed_color = summary['failed']['total'] > 0 ? 'failed' : 'no_color'
257
- skipped_color = summary['skipped'] > 0 ? 'skipped' : 'no_color'
258
-
259
- s = format(
260
- 'Profile Summary: %s, %s, %s',
261
- format_with_color(success_color, success_str),
262
- format_with_color(failed_color, failed_str),
263
- format_with_color(skipped_color, skipped_str),
264
- )
265
- output(s) if summary['total'] > 0
266
- end
267
-
268
- def print_tests_summary
269
- summary = tests_summary
270
-
271
- failed_str = summary['failed'] == 1 ? '1 failure' : "#{summary['failed']} failures"
272
-
273
- success_color = summary['passed'] > 0 ? 'passed' : 'no_color'
274
- failed_color = summary['failed'] > 0 ? 'failed' : 'no_color'
275
- skipped_color = summary['skipped'] > 0 ? 'skipped' : 'no_color'
276
-
277
- s = format(
278
- 'Test Summary: %s, %s, %s',
279
- format_with_color(success_color, "#{summary['passed']} successful"),
280
- format_with_color(failed_color, failed_str),
281
- format_with_color(skipped_color, "#{summary['skipped']} skipped"),
282
- )
283
-
284
- output(s)
285
- end
286
-
287
- def standard_controls_from_profile(profile)
288
- profile[:controls].reject { |c| is_anonymous_control?(c) }
289
- end
290
-
291
- def anonymous_controls_from_profile(profile)
292
- profile[:controls].select { |c| is_anonymous_control?(c) && !c[:results].nil? }
293
- end
294
-
295
- def is_anonymous_control?(control)
296
- control[:id].start_with?('(generated from ')
297
- end
298
-
299
- def indent_lines(message, indentation)
300
- message.lines.map { |line| ' ' * indentation + line }.join
301
- end
302
-
303
- class Control
304
- IMPACT_SCORES = {
305
- critical: 0.7,
306
- major: 0.4,
307
- }.freeze
308
-
309
- attr_reader :data
310
-
311
- def initialize(control_hash)
312
- @data = control_hash
313
- end
314
-
315
- def id
316
- data[:id]
317
- end
318
-
319
- def title
320
- data[:title]
321
- end
322
-
323
- def results
324
- data[:results]
325
- end
326
-
327
- def impact
328
- data[:impact]
329
- end
330
-
331
- def anonymous?
332
- id.start_with?('(generated from ')
333
- end
334
-
335
- def title_for_report
336
- # if this is an anonymous control, just grab the resource title from any result entry
337
- return results.first[:resource_title] if anonymous?
338
-
339
- title_for_report = "#{id}: #{title || results.first[:resource_title]}"
340
-
341
- # we will not add any additional data to the title if there's only
342
- # zero or one test for this control.
343
- return title_for_report if results.nil? || results.size <= 1
344
-
345
- # append a failure summary if appropriate.
346
- title_for_report += " (#{failure_count} failed)" if failure_count > 0
347
- title_for_report += " (#{skipped_count} skipped)" if skipped_count > 0
348
-
349
- title_for_report
350
- end
351
-
352
- def impact_string
353
- if anonymous?
354
- nil
355
- elsif impact.nil?
356
- 'unknown'
357
- elsif results&.find { |r| r[:status] == 'skipped' }
358
- 'skipped'
359
- elsif results.nil? || results.empty? || results.all? { |r| r[:status] == 'passed' }
360
- 'passed'
361
- elsif impact >= IMPACT_SCORES[:critical]
362
- 'critical'
363
- elsif impact >= IMPACT_SCORES[:major]
364
- 'major'
365
- else
366
- 'minor'
367
- end
368
- end
369
-
370
- def impact_string_for_result(result)
371
- if result[:status] == 'skipped'
372
- 'skipped'
373
- elsif result[:status] == 'passed'
374
- 'passed'
375
- elsif impact.nil?
376
- 'unknown'
377
- elsif impact >= IMPACT_SCORES[:critical]
378
- 'critical'
379
- elsif impact >= IMPACT_SCORES[:major]
380
- 'major'
381
- else
382
- 'minor'
383
- end
384
- end
385
-
386
- def failure_count
387
- results.select { |r| r[:status] == 'failed' }.size
388
- end
389
-
390
- def skipped_count
391
- results.select { |r| r[:status] == 'skipped' }.size
392
- end
393
- end
394
- end
395
- end
1
+ # encoding: utf-8
2
+
3
+ module Inspec::Reporters
4
+ class CLI < Base
5
+ case RUBY_PLATFORM
6
+ when /windows|mswin|msys|mingw|cygwin/
7
+ # Most currently available Windows terminals have poor support
8
+ # for ANSI extended colors
9
+ COLORS = {
10
+ 'critical' => "\033[0;1;31m",
11
+ 'major' => "\033[0;1;31m",
12
+ 'minor' => "\033[0;36m",
13
+ 'failed' => "\033[0;1;31m",
14
+ 'passed' => "\033[0;1;32m",
15
+ 'skipped' => "\033[0;37m",
16
+ 'reset' => "\033[0m",
17
+ }.freeze
18
+
19
+ # Most currently available Windows terminals have poor support
20
+ # for UTF-8 characters so use these boring indicators
21
+ INDICATORS = {
22
+ 'critical' => '[CRIT]',
23
+ 'major' => '[MAJR]',
24
+ 'minor' => '[MINR]',
25
+ 'failed' => '[FAIL]',
26
+ 'skipped' => '[SKIP]',
27
+ 'passed' => '[PASS]',
28
+ 'unknown' => '[UNKN]',
29
+ }.freeze
30
+ else
31
+ # Extended colors for everyone else
32
+ COLORS = {
33
+ 'critical' => "\033[38;5;9m",
34
+ 'major' => "\033[38;5;208m",
35
+ 'minor' => "\033[0;36m",
36
+ 'failed' => "\033[38;5;9m",
37
+ 'passed' => "\033[38;5;41m",
38
+ 'skipped' => "\033[38;5;247m",
39
+ 'reset' => "\033[0m",
40
+ }.freeze
41
+
42
+ # Groovy UTF-8 characters for everyone else...
43
+ # ...even though they probably only work on Mac
44
+ INDICATORS = {
45
+ 'critical' => '×',
46
+ 'major' => '∅',
47
+ 'minor' => '⊚',
48
+ 'failed' => '×',
49
+ 'skipped' => '↺',
50
+ 'passed' => '✔',
51
+ 'unknown' => '?',
52
+ }.freeze
53
+ end
54
+
55
+ MULTI_TEST_CONTROL_SUMMARY_MAX_LEN = 60
56
+
57
+ def render
58
+ run_data[:profiles].each do |profile|
59
+ @control_count = 0
60
+ output('')
61
+ print_profile_header(profile)
62
+ print_standard_control_results(profile)
63
+ print_anonymous_control_results(profile)
64
+ output(format_message(
65
+ indentation: 5,
66
+ message: 'No tests executed.',
67
+ )) if @control_count == 0
68
+ end
69
+
70
+ output('')
71
+ print_profile_summary
72
+ print_tests_summary
73
+ end
74
+
75
+ private
76
+
77
+ def print_profile_header(profile)
78
+ output("Profile: #{format_profile_name(profile)}")
79
+ output("Version: #{profile[:version] || '(not specified)'}")
80
+ output("Target: #{run_data[:platform][:target]}") unless run_data[:platform][:target].nil?
81
+ output('')
82
+ end
83
+
84
+ def print_standard_control_results(profile)
85
+ standard_controls_from_profile(profile).each do |control_from_profile|
86
+ control = Control.new(control_from_profile)
87
+ next if control.results.nil?
88
+ output(format_control_header(control))
89
+ control.results.each do |result|
90
+ output(format_result(control, result, :standard))
91
+ @control_count += 1
92
+ end
93
+ end
94
+ output('') if @control_count > 0
95
+ end
96
+
97
+ def print_anonymous_control_results(profile)
98
+ anonymous_controls_from_profile(profile).each do |control_from_profile|
99
+ control = Control.new(control_from_profile)
100
+ next if control.results.nil?
101
+ output(format_control_header(control))
102
+ control.results.each do |result|
103
+ output(format_result(control, result, :anonymous))
104
+ @control_count += 1
105
+ end
106
+ end
107
+ end
108
+
109
+ def format_profile_name(profile)
110
+ if profile[:title].nil?
111
+ (profile[:name] || 'unknown').to_s
112
+ else
113
+ "#{profile[:title]} (#{profile[:name] || 'unknown'})"
114
+ end
115
+ end
116
+
117
+ def format_control_header(control)
118
+ impact = control.impact_string
119
+ format_message(
120
+ color: impact,
121
+ indicator: impact,
122
+ message: control.title_for_report,
123
+ )
124
+ end
125
+
126
+ def format_result(control, result, type)
127
+ impact = control.impact_string_for_result(result)
128
+
129
+ message = if result[:status] == 'skipped'
130
+ result[:skip_message]
131
+ elsif type == :anonymous
132
+ result[:expectation_message]
133
+ else
134
+ result[:code_desc]
135
+ end
136
+
137
+ # append any failure details to the message if they exist
138
+ message += "\n#{result[:message]}" if result[:message]
139
+
140
+ format_message(
141
+ color: impact,
142
+ indicator: impact,
143
+ indentation: 5,
144
+ message: message,
145
+ )
146
+ end
147
+
148
+ def format_message(message_info)
149
+ indicator = message_info[:indicator]
150
+ color = message_info[:color]
151
+ indentation = message_info.fetch(:indentation, 2)
152
+ message = message_info[:message]
153
+
154
+ message_to_format = ''
155
+ message_to_format += "#{INDICATORS[indicator]} " unless indicator.nil?
156
+ message_to_format += message.to_s.lstrip
157
+
158
+ format_with_color(color, indent_lines(message_to_format, indentation))
159
+ end
160
+
161
+ def format_with_color(color_name, text)
162
+ return text if defined?(RSpec.configuration) && !RSpec.configuration.color
163
+ return text unless COLORS.key?(color_name)
164
+
165
+ "#{COLORS[color_name]}#{text}#{COLORS['reset']}"
166
+ end
167
+
168
+ def all_unique_controls
169
+ return @unique_controls unless @unique_controls.nil?
170
+
171
+ @unique_controls = Set.new
172
+ run_data[:profiles].each do |profile|
173
+ profile[:controls].map { |control| @unique_controls.add(control) }
174
+ end
175
+
176
+ @unique_controls
177
+ end
178
+
179
+ def profile_summary
180
+ return @profile_summary unless @profile_summary.nil?
181
+
182
+ failed = 0
183
+ skipped = 0
184
+ passed = 0
185
+ critical = 0
186
+ major = 0
187
+ minor = 0
188
+
189
+ all_unique_controls.each do |control|
190
+ next if control[:id].start_with? '(generated from '
191
+ next unless control[:results]
192
+ if control[:results].any? { |r| r[:status] == 'failed' }
193
+ failed += 1
194
+ if control[:impact] >= 0.7
195
+ critical += 1
196
+ elsif control[:impact] >= 0.4
197
+ major += 1
198
+ else
199
+ minor += 1
200
+ end
201
+ elsif control[:results].any? { |r| r[:status] == 'skipped' }
202
+ skipped += 1
203
+ else
204
+ passed += 1
205
+ end
206
+ end
207
+
208
+ total = failed + passed + skipped
209
+
210
+ @profile_summary = {
211
+ 'total' => total,
212
+ 'failed' => {
213
+ 'total' => failed,
214
+ 'critical' => critical,
215
+ 'major' => major,
216
+ 'minor' => minor,
217
+ },
218
+ 'skipped' => skipped,
219
+ 'passed' => passed,
220
+ }
221
+ end
222
+
223
+ def tests_summary
224
+ return @tests_summary unless @tests_summary.nil?
225
+
226
+ total = 0
227
+ failed = 0
228
+ skipped = 0
229
+ passed = 0
230
+
231
+ all_unique_controls.each do |control|
232
+ next unless control[:results]
233
+ control[:results].each do |result|
234
+ if result[:status] == 'failed'
235
+ failed += 1
236
+ elsif result[:status] == 'skipped'
237
+ skipped += 1
238
+ else
239
+ passed += 1
240
+ end
241
+ end
242
+ end
243
+
244
+ @tests_summary = { 'total' => total, 'failed' => failed, 'skipped' => skipped, 'passed' => passed }
245
+ end
246
+
247
+ def print_profile_summary
248
+ summary = profile_summary
249
+ return unless summary['total'] > 0
250
+
251
+ success_str = summary['passed'] == 1 ? '1 successful control' : "#{summary['passed']} successful controls"
252
+ failed_str = summary['failed']['total'] == 1 ? '1 control failure' : "#{summary['failed']['total']} control failures"
253
+ skipped_str = summary['skipped'] == 1 ? '1 control skipped' : "#{summary['skipped']} controls skipped"
254
+
255
+ success_color = summary['passed'] > 0 ? 'passed' : 'no_color'
256
+ failed_color = summary['failed']['total'] > 0 ? 'failed' : 'no_color'
257
+ skipped_color = summary['skipped'] > 0 ? 'skipped' : 'no_color'
258
+
259
+ s = format(
260
+ 'Profile Summary: %s, %s, %s',
261
+ format_with_color(success_color, success_str),
262
+ format_with_color(failed_color, failed_str),
263
+ format_with_color(skipped_color, skipped_str),
264
+ )
265
+ output(s) if summary['total'] > 0
266
+ end
267
+
268
+ def print_tests_summary
269
+ summary = tests_summary
270
+
271
+ failed_str = summary['failed'] == 1 ? '1 failure' : "#{summary['failed']} failures"
272
+
273
+ success_color = summary['passed'] > 0 ? 'passed' : 'no_color'
274
+ failed_color = summary['failed'] > 0 ? 'failed' : 'no_color'
275
+ skipped_color = summary['skipped'] > 0 ? 'skipped' : 'no_color'
276
+
277
+ s = format(
278
+ 'Test Summary: %s, %s, %s',
279
+ format_with_color(success_color, "#{summary['passed']} successful"),
280
+ format_with_color(failed_color, failed_str),
281
+ format_with_color(skipped_color, "#{summary['skipped']} skipped"),
282
+ )
283
+
284
+ output(s)
285
+ end
286
+
287
+ def standard_controls_from_profile(profile)
288
+ profile[:controls].reject { |c| is_anonymous_control?(c) }
289
+ end
290
+
291
+ def anonymous_controls_from_profile(profile)
292
+ profile[:controls].select { |c| is_anonymous_control?(c) && !c[:results].nil? }
293
+ end
294
+
295
+ def is_anonymous_control?(control)
296
+ control[:id].start_with?('(generated from ')
297
+ end
298
+
299
+ def indent_lines(message, indentation)
300
+ message.lines.map { |line| ' ' * indentation + line }.join
301
+ end
302
+
303
+ class Control
304
+ IMPACT_SCORES = {
305
+ critical: 0.7,
306
+ major: 0.4,
307
+ }.freeze
308
+
309
+ attr_reader :data
310
+
311
+ def initialize(control_hash)
312
+ @data = control_hash
313
+ end
314
+
315
+ def id
316
+ data[:id]
317
+ end
318
+
319
+ def title
320
+ data[:title]
321
+ end
322
+
323
+ def results
324
+ data[:results]
325
+ end
326
+
327
+ def impact
328
+ data[:impact]
329
+ end
330
+
331
+ def anonymous?
332
+ id.start_with?('(generated from ')
333
+ end
334
+
335
+ def title_for_report
336
+ # if this is an anonymous control, just grab the resource title from any result entry
337
+ return results.first[:resource_title] if anonymous?
338
+
339
+ title_for_report = "#{id}: #{title || results.first[:resource_title]}"
340
+
341
+ # we will not add any additional data to the title if there's only
342
+ # zero or one test for this control.
343
+ return title_for_report if results.nil? || results.size <= 1
344
+
345
+ # append a failure summary if appropriate.
346
+ title_for_report += " (#{failure_count} failed)" if failure_count > 0
347
+ title_for_report += " (#{skipped_count} skipped)" if skipped_count > 0
348
+
349
+ title_for_report
350
+ end
351
+
352
+ def impact_string
353
+ if anonymous?
354
+ nil
355
+ elsif impact.nil?
356
+ 'unknown'
357
+ elsif results&.find { |r| r[:status] == 'skipped' }
358
+ 'skipped'
359
+ elsif results.nil? || results.empty? || results.all? { |r| r[:status] == 'passed' }
360
+ 'passed'
361
+ elsif impact >= IMPACT_SCORES[:critical]
362
+ 'critical'
363
+ elsif impact >= IMPACT_SCORES[:major]
364
+ 'major'
365
+ else
366
+ 'minor'
367
+ end
368
+ end
369
+
370
+ def impact_string_for_result(result)
371
+ if result[:status] == 'skipped'
372
+ 'skipped'
373
+ elsif result[:status] == 'passed'
374
+ 'passed'
375
+ elsif impact.nil?
376
+ 'unknown'
377
+ elsif impact >= IMPACT_SCORES[:critical]
378
+ 'critical'
379
+ elsif impact >= IMPACT_SCORES[:major]
380
+ 'major'
381
+ else
382
+ 'minor'
383
+ end
384
+ end
385
+
386
+ def failure_count
387
+ results.select { |r| r[:status] == 'failed' }.size
388
+ end
389
+
390
+ def skipped_count
391
+ results.select { |r| r[:status] == 'skipped' }.size
392
+ end
393
+ end
394
+ end
395
+ end