Add Licensing Information to AAD Report

[dagarwal-mitre]

🗣 Description

This PR concludes adding licensing information to ScubaGear.

💭 Motivation and context

The licensing information has been added to the bottom part of the AAD report for users to be able to review. This will conclude the larger epic for adding licensing information to ScubaGear (#466)

Closes #778

🧪 Testing

This was tested using the different tenants and checking to make sure that the report will still generate without issues even if the AAD report isn't run.

✅ Pre-approval checklist

• This PR has an informative and human-readable title.
• PR targets the correct parent branch (e.g., main or release-name) for merge.
• Changes are limited to a single goal - eschew scope creep!
• Changes are sized such that they do not touch excessive number of files.
• All future TODOs are captured in issues, which are referenced in code comments.
• These code changes follow the ScubaGear content style guide.
• Related issues these changes resolve are linked preferably via closing keywords.
• All relevant type-of-change labels added.
• All relevant project fields are set.
• All relevant repo and/or project documentation updated to reflect these changes.
• Unit tests added/updated to cover PowerShell and Rego changes.
• Functional tests added/updated to cover PowerShell and Rego changes.
• All relevant functional tests passed.
• All automated checks (e.g., linting, static analysis, unit/smoke tests) passed.

✅ Pre-merge checklist

• PR passed smoke test check.

• Feature branch has been rebased against changes from parent branch, as needed

  Use Rebase branch button below or use this reference to rebase from the command line.

• Resolved all merge conflicts on branch

• Notified merge coordinator that PR is ready for merge via comment mention

✅ Post-merge checklist

• Feature branch deleted after merge to clean up repository.
• Verified that all checks pass on parent branch (e.g., main or release-name) after merge.

[gdasher]

In addition to these 2 minor comments, can you also:

1. Update the stub in the unit test (c.f. New-Report.Tests.ps1) to populate SKU related info so that these code paths get minimally tested for not crashing?

2. Make sure the smoke test (esp. SmokeTest002.Tests.ps1) still passes and update it to ensure that the existence of the license table is checked?

[mitchelbaker-cisa]

Something to capture as either a future todo or if you think it falls within the scope of this PR -- the colorRows() function in main.js assumes tables have a size of 3, resulting in an out of bounds error with the license table. Should be a tiny fix either way.

[gdasher]

Something to capture as either a future todo or if you think it falls within the scope of this PR -- the colorRows() function in main.js assumes tables have a size of 3, resulting in an out of bounds error with the license table. Should be a tiny fix either way.

Good flag. I would like us to fix this so we don't ship JS errors.

[schrolla]

Adding feedback based on running and reviewing the results of the report. Overall, looks good and no errors. I did provide feedback on possible grammatical changes and added capability, possibly as future TODO.

[tkol2022]

@dagarwal-mitre Just letting you know that I tested this as well and it worked fine for me. Nice work!

I'd like you to change the title of the new table from "Licensing Information" to "Tenant Licensing Information".

[tkol2022]

The Cmdlet Get-MgBetaSubscribedSku is being called twice in the AAD provider resulting in two calls to the REST API. Please modify the code so that it is only called once. Once the REST API is called, you can save the API results to a new local variable and then still perform the local filtering with Where-Object and Select-Object against the new local variable.

Also move the LicenseInfo variable further up into the code so that it is right after the line containing the ServicePlans variable. This way all licensing related code is grouped in the same block.

[dagarwal-mitre]

The Cmdlet Get-MgBetaSubscribedSku is being called twice in the AAD provider resulting in two calls to the REST API. Please modify the code so that it is only called once. Once the REST API is called, you can save the API results to a new local variable and then still perform the local filtering with Where-Object and Select-Object against the new local variable.

Also move the LicenseInfo variable further up into the code so that it is right after the line containing the ServicePlans variable. This way all licensing related code is grouped in the same block.

I have updated this to utilize a variable rather than calling the same cmdlet multiple times and grouped the code together now. Please take a look at it when you get a chance.

[dagarwal-mitre]

@dagarwal-mitre Just letting you know that I tested this as well and it worked fine for me. Nice work!

I'd like you to change the title of the new table from "Licensing Information" to "Tenant Licensing Information".

Updated.

[tkol2022]

@dagarwal-mitre @nanda-katikaneni FYI - I'd like to ensure that this PR works on the G3 tenant before merging. In particular we need to ensure that the license message for policies not available in G3 tenants shows up in the report since we have changed the foundational code for handling the G3 license.

Also I'd like to run the functional test orchestrator against the G3.

[tkol2022]

Screenshots of the new capability

This is just to show what the new reporting feature looks like across four different tenants. The G3 tenant is in a suspended license state and this is why the total licenses shows zero.

[tkol2022]

Testing update

Tested the most recent code updates where Devesh grouped processing of the licenses into the same code block against the G5, GCC High and E5 tenants. The code did not break any existing functionality that relies on the AAD license info. Once the G3 tenant is backup up we need to test there to ensure that the licensing report works with G3 and do a regression to ensure the existing Rego policies that check for the AAD premium license still work since the related provider code was modified.

[schrolla]

Results of the current PR are consistent with the direction the group has decided on for licensing information. All of my comments have been addressed and the TODO issue has been filed. Looks good to me.

[schrolla]

Setting status to blocked until the G3 test tenant expired license is resolved so this PR can be tested against that level prior to merge.

[schrolla]

Work here moved to new PR #1011 to better handle branch conflicts. Closing.