tech story: [M3-8423] - Resolve "Incomplete string escape or encoding" in generate-ansibleConfig.test.ts

[coliu-akamai]

Description 📝

• Resolve codeQL alert due to not escaping backslashes by updating regex
• Added test case for the special characters not yet tested for

Target release date 🗓️

n/a

Preview 📷

Before	After

How to test 🧪

Prerequisites

Here are the steps I took to setup codeQL on vscode. Not sure if this is the most straightforward way, but it (seems to have) worked 😅

• download the codeQL extension on vscode
• follow along to this guide
  • I used the most up to date version (2.18.3) when downloading codeQL CLI this time around, but I remember using the version listed in the guide for a prior ticket, and that had worked too. (I believe VS code also automatically updates the CLI to v2.18.3 for you if you use the guide's version - ty @mjac0bs!)
  • You don't actually need the vscode extension if you follow this guide to completion. I stopped after the creating a database portion and just used the extension from there. Run the create database command in the manager/src/utilities/codesnippets package - I had trouble when trying to create a database with the entirety of manager
• Open up codeql-repo (naming conventions from the guide ^) in vscode, click on the QL tab in the sidebar, and select the database you just created
  

Verification steps

• run the IncompleteSanitization.ql query and confirm warning is gone (codeql-repo >> javascript >> ql >> src >> Security >> CWE-116 >> IncompleteSanitization.ql)
  

• NOTE if you want to run this query on both develop (to see the warning) and this branch (to confirm it's gone), you will need to create DBs for both develop and this branch...the DB does not automatically update

As an Author I have considered 🤔

Check all that apply

• 👀 Doing a self review
• ❔ Our contribution guidelines
• 🤏 Splitting feature into small PRs
• ➕ Adding a changeset
• 🧪 Providing/Improving test coverage
• 🔐 Removing all sensitive information from the code and PR description
• 🚩 Using a feature flag to protect the release
• 👣 Providing comprehensive reproduction steps
• 📑 Providing or updating our documentation
• 🕛 Scheduling a pair reviewing session
• 📱 Providing mobile support
• ♿ Providing accessibility support

[coliu-akamai]

note: Originally I'd had \] and \} in this label, but eslint corrected them to just ] and { 🥲... They still resulted in \\] and \\}, same as the current expected output (which is good/what we'd want, I think!).

[github-actions]

Coverage Report: ✅
Base Coverage: 86.2%
Current Coverage: 86.21%

[mjac0bs]

Thank you for the thorough instructions! (The need to create a second db thing was a great call out too.) Confirmed the error is resolved on this branch - and thank you for the test. 🚀

develop	this branch

[hkhalil-akamai]

Thanks for linking the setup instructions. Verified the code scanning error is gone.

Edit: failing test seems unrelated -- retrying.