fix tags so that they are rendered to string directly from struct #5483

rickmarry · 2021-08-12T23:06:32Z

Signed-off-by: Rick Marry rick.marry@gmail.com

🔩 Description: What code changed, and why?

this fixes bug #5399
This PR fixes a bug where control tags are not making in with the profile as it's stored in elasticsearch
In order for this bug fix to work, the profiles that are currently in elasticsearch need to be removed and compliance-service needs to be restarted. The removal and restart will cause the profiles to be re-ingested into elastic and the control tags will now be present. From that point forward, any inspec reports that are sent up to automate will carry with them, the control tags for each respective profile.

*N.B. already ingested reports will not ever have the tags for the controls as they are decorated with them upon ingestion which has already happened prior to this fix

⛓️ Related Resources

👍 Definition of Done

👟 How to Build and Test the Change

From within hab studio:
rebuild components/compliance-service
Get a profile that has some tags like CIS Docker Benchmark Profile
Create a scan job and select this CIS Docker Benchmark Profile profile
Run your newly created scan job in automate
Once it completes its run, whenever you export the node or call reporting/reports/id/:id for the job that you have just run and navigate to profiles->controls section of the json output, in each control you should now see its respective control tags.

You can also add these newly present control tags to your filter when using compliance.. in the filter text entry box, filter on Control Tag, you should see some of the available tags appear, which you may now select. Prior to this bug fix, nothing would be suggested for Control-Tag and we were not able to use them to filter as they did not exist in reports prior to this.

✅ Checklist

All PRs must tick these:

I have read the CONTRIBUTING document.
All commits signed-off for the Developer Certification of Origin.

With occasional exceptions, all PRs from Progress employees must tick these:

Is the code clear? (complicated code or lots of comments--subdivide and use well-named methods, meaningful variable names, etc.)
Consistency checked? (user notifications, user prompts, visual patterns, code patterns, variable names)
Repeated code blocks eliminated? (adapt and reuse existing components, blocks, functions, etc.)
Spelling, grammar, typos checked? (at a minimum use make spell in any component directory)
Code well-formatted? (indents, line breaks, etc. improve rather than hinder readability)