Fix report module to handle italics and multiline processing in policy description

[isab-m]

🗣 Description

HTML reporting shows Markdown notation and extra line breaks. Markdown notation is not rendered and is shown as is which can make the requirement text harder to interpret or at the very least is less visually appealing. Fixes the HTML reporting translation of italic and bold notation from the baseline's policy description markdown notation. Fixes extra line breaks and list breaks in html reports.

💭 Motivation and context

• Added the HTML translation of italics notation from the baseline's policy description markdown
• Added the HTML translation of bold notation from the baseline's policy description markdown
• Fixes extra line breaks and list breaks in reports

Closes #604

🧪 Testing

• Testing italics markdown-to-html translation

1. Edit a baseline doc policy descriptions by adding "_" italics notation to beginning and end of a policy description line
2. Import-Module -Name .\PowerShell\ScubaGear
3. Invoke-SCuBA -ProductNames aad, defender

• Testing bold markdown-to-html translation

1. Edit a baseline doc policy descriptions by adding "**" bold notation to beginning and end of a policy description line
2. Import-Module -Name .\PowerShell\ScubaGear
3. Invoke-SCuBA -ProductNames aad

• Testing both bold and italics markdown-to-html translation

1. Edit a baseline doc policy descriptions by adding "_" italics notation to beginning and end of a policy description line and bold "**"
2. Import-Module -Name .\PowerShell\ScubaGear
3. Invoke-SCuBA -ProductNames aad

📷 Screenshots (if appropriate)

Italics notation added to baseline using "_"

Italics notation rendered correctly in report descriptions

Bold notation added to baseline policy description MS.AAD.2.3v1 using "**"

Bold notation translation rendered correctly in report descriptions

Bold notation added to baseline policy description MS.AAD.2.3v1 using "**" with italics "_" notation added inside

Bold and Italics notation rendered correctly in report descriptions

Italics notation added to baseline policy description MS.AAD.2.2v1 using "_" with bold "**" notation added inside

Italics and bold notation rendered correctly in report descriptions

✅ Pre-approval checklist

• This PR has an informative and human-readable title.
• Changes are limited to a single goal - eschew scope creep!
• All future TODOs are captured in issues, which are referenced
  in code comments.
• All relevant type-of-change labels have been added.
• All relevant repo and/or project documentation has been updated
  to reflect the changes in this PR.
• Tests have been added and/or modified to cover the changes in this PR.
• All new and existing tests pass.

✅ Pre-merge checklist

• Feature branch has been rebased with latest changes from main
• Notified merge coordinator issue is ready for merge

✅ Post-merge checklist

• Verify all tests are passing on main branch after merge

[schrolla]

@isab-m Please update the PR title from the default to a clearer title. Preferably starting with a present tense verb and a short description that explains the purpose of the update. The PR title becomes the merge commit message that lives on in the commit history on the main branch, so title is important as it communicates the actual change to users.

[schrolla]

The italics fix is good, but this PR does not close #604 entirely as it does not address extra line breaks in policy statements rendered in the report. Either split #604 so that a new issue to address line breaks is created outside the scope of this PR or update the PR to address the extra line breaks issue as well.

[crutchfield]

Consider adding a unit test to verify proper transformation.

[isab-m]

The italics fix is good, but this PR does not close #604 entirely as it does not address extra line breaks in policy statements rendered in the report. Either split #604 so that a new issue to address line breaks is created outside the scope of this PR or update the PR to address the extra line breaks issue as well.

@schrolla
Originally thought this was fixed with #528 but realized it looked correct in the report for certain multiline cases like MS.EXO.16.1v1

but cases like MS.TEAMS.6.2v1 still showed newline breaks in report

Updated code to reflect multiline processing split into two use cases shown below:

Multiline Use Case
Multiline case processing utilizing " ". fixes the cases where report renders new lines MS.TEAMS.6.2v1

Visually, can't see much of a difference in this multiline case being present here in MS.DEFENDER.4.6v1

However, upon further investigation into raw text in defender baseline doc, a newline is present in the policy description

Multiline case resolves this newline break in markdown, which visually can be shown using a diff tool on the text.

List Use Cases
List case processing utilizing "`n". lists rendered correctly in report MS.EXO.16.1v1

[schrolla]

See comments below for recommended updates.

[schrolla]

Ran full Invoke-Scuba -p * and reviewed output of all reports. Updated rendering looks much better, especially MS.EXO.16.1 with correct multi-line breaks and properly rendered bolded sub-items. All unit tests ran successfully as well. Great work!

[schrolla]

Minor oversight on my part. The baselines were changed, I'm assuming for testing. I'd recommend reverting/removing those changes so we aren't modifying the baselines for this code update.

[crutchfield]

1. An earlier comment as to consider adding/enhancing unit test to check that this capability works (and does not get broke in the future) -- Tests have been added and/or modified to cover the changes in this PR.
2. Please fix identified linter errors in CreateReport.psm1
3. Need to rebase

[isab-m]

1. An earlier comment as to consider adding/enhancing unit test to check that this capability works (and does not get broke in the future) -- Tests have been added and/or modified to cover the changes in this PR.
2. Please fix identified linter errors in CreateReport.psm1
3. Need to rebase

All 3 items added to code. Can I get a review on my unit tests @crutchfield?

[schrolla]

Ran again successfully, showing correct multiline, italics, and bold processing. Ran PS and rego unit tests successfully. New unit tests for translation function adequately test for bad input and output values and test valid translations. Looks good to me.

[crutchfield]

I think there are a couple comments to look at.

[crutchfield]

Addresses immediate needs. Future enhancement will be addressed by #847

[schrolla]

@nanda-katikaneni PR is ready for merge.