audit
audit copied to clipboard
chef-boneyard
[DO NOT MERGE] Rename InSpec Attributes to Inputs
Description
As one of the last remaining parts of the renaming of InSpec Attributes to Inputs, this PR renames the default['audit']['attributes'] chef infra attribute to default['audit']['inputs'].
default['audit']['attributes'] is retained, but any values set there are merged into default['audit']['inputs'] and a warning is emitted.
Additionally, the attributes
node['audit']['attributes_save'] has been renamed to node['audit']['inputs_save'] and
node['audit']['chef_node_attribute_enabled'] to node['audit']['chef_node_input_enabled']. At this time no backwards compatibility is in place for these two features, but that could be added if desired.
Should this be on a major release?
Issues Resolved
Fixes #360
Also gets the attributes test suite passing, which had been failing.
Check List
- [x] All tests pass. See https://github.com/chef-cookbooks/community_cookbook_documentation/blob/master/TESTING.MD
- [x] New functionality includes testing.
- [x] New functionality has been documented in the README if applicable
- [x] All commits have been signed for the Developer Certificate of Origin. See https://github.com/chef-cookbooks/community_cookbook_documentation/blob/master/CONTRIBUTING.MD
we'll need to do some work in automate to ensure we're looking for that inputs field: https://github.com/chef/automate/issues/194
Let's find out the extent of any possible breakage risk to existing customers before this one progresses - should hold for now
This PR exists to look for feedback and alert stakeholders to possible disruption. It's not a particularly urgent change. We'll hold until the change and its impact is better understood, and until there are any downstream changes needed in other products have been implemented.
That said, technical reviewers, please do give feedback: is this sufficiently backwards compatible? will this impact Automate on node save? Can that be avoided? Do we want a major version bump for this change?
At least a couple of concerns:
- Supporting profiles that we ship that still refer to attributes
- Supporting profiles that users own that still refer to attributes
- Supporting users that upgrade their audit cookbook version
