Split Azure.Iot.Sdk.Test into a versioned module with checks

[Ewerton Scaboro da Silva (ewertons)]

scripts/Azure.Iot.Sdk.Test.psm1 was a single 3984-line, 170 KB file holding nine unrelated concerns, with no manifest, no version and no tests, imported by pipelines in other repositories.

Move it to scripts/AzIotSdkTest/:

Path	Contents
AzIotSdkTest.psd1	ModuleVersion 1.0.0, exported surface, PowerShellVersion 5.1
AzIotSdkTest.psm1	root module
Import-Parts.ps1	load order and Export-ModuleMember
parts/*.ps1	Common, AzureCommon, Conversion, Crypto, Models, Dps, ResourceGroups, Provisioning, TestConfig, SubmoduleGraph

No code changed. Concatenating the header, the parts in load order and the export list reproduces the previous file byte for byte.

The load order is explicit rather than a directory listing: PowerShell resolves a class used as a parameter type when the file declaring the consumer is parsed, so Models.ps1 must load before anything taking a [TestEnvironmentInfo].

The loader is a .ps1 so the deprecated path can dot-source it — the dot-source operator accepts only .ps1. scripts/Azure.Iot.Sdk.Test.psm1 stays as a shim that dot-sources the loader from its checkout, and downloads the repository when it was itself downloaded standalone, which is how consumers fetching that single file keep working unchanged. Its default ref is master, matching what those consumers get today. The shim goes away once they move to a pinned checkout.

The two Azure Pipelines templates and docs/horton-architecture.md now import the manifest.

Verification

Run locally, all passing:

• Header + parts + export list reproduces the original file byte for byte.
• Exported surface vs master: 16 = 16, identical name by name and parameter by parameter including parameter types, for both the manifest and the shim.
• Behavioural spot-check across part boundaries (Get-AzureResourceGroupNamePrefix, New-AzureResourceGroupName, a class + crypto path, and the module-scope $DefaultCertificateExpiration): all match master.
• tests/Validate-Module.ps1: OK: 10 parts, 16 exported commands, shim intact.
• Negative tests confirm the guards fire on an orphan part file and on a part listed but missing.

CI runs the checks on ubuntu with pwsh and on windows with Windows PowerShell 5.1, which is what AzureCLI@2 scriptType: ps gives the Azure Pipelines templates.

Not verified: an actual provisioning run, which needs an Azure subscription and a service principal.

Follow-ups (not in this PR)

• Tag a release so consumers can pin a version.
• Data-drive the six near-duplicate config emitters in TestConfig.ps1, which build the same variable list twice (once as export X=, once as $env:X =).
• Consider splitting SubmoduleGraph.ps1 (791 lines) into its own module; it shares only two helpers with the rest.

[Copilot]

🟡 Changes recommended

Unresolved moderate findings affect shim cleanup and validation of exported command signatures and surfaces.

Get a fresh assessment by requesting another Copilot review.

Pull request overview

Splits the Azure IoT SDK test framework into a versioned PowerShell module while preserving the legacy import path.

Changes:

• Adds an explicit manifest, loader, exports, and implementation parts.
• Updates pipelines and documentation to use the new module.
• Adds validation CI and retains standalone shim compatibility.

File summaries

File	Reviewed changes
vsts/templates/steps-create-azure-resources.yaml	Imports the new manifest.
vsts/templates/steps-cleanup-leftover-resources.yaml	Imports the new manifest.
tests/Validate-Module.ps1	Validates module structure, exports, and shim behavior.
scripts/AzIotSdkTest/README.md	Documents module usage and layout.
scripts/AzIotSdkTest/parts/TestConfig.ps1	Split framework implementation.
scripts/AzIotSdkTest/parts/SubmoduleGraph.ps1	Split framework implementation.
scripts/AzIotSdkTest/parts/ResourceGroups.ps1	Split framework implementation.
scripts/AzIotSdkTest/parts/Provisioning.ps1	Split framework implementation.
scripts/AzIotSdkTest/parts/Models.ps1	Split framework implementation.
scripts/AzIotSdkTest/parts/Dps.ps1	Split framework implementation.
scripts/AzIotSdkTest/parts/Crypto.ps1	Split framework implementation.
scripts/AzIotSdkTest/parts/Conversion.ps1	Split framework implementation.
scripts/AzIotSdkTest/parts/Common.ps1	Split framework implementation.
scripts/AzIotSdkTest/parts/AzureCommon.ps1	Split framework implementation.
scripts/AzIotSdkTest/Import-Parts.ps1	Defines load order and exports.
scripts/AzIotSdkTest/AzIotSdkTest.psm1	Root module loader.
scripts/AzIotSdkTest/AzIotSdkTest.psd1	Defines version and exported surface.
docs/horton-architecture.md	Documents the new module path.
.gitignore	Ignores validation dependencies.
.github/workflows/validate-module.yml	Runs cross-platform module validation.

Review details

Suppressed comments (5)

scripts/AzIotSdkTest/Import-Parts.ps1:23

• This comment has an article agreement error: “an provisioned” should be “a provisioned.”

    'Models.ps1'             # Classes describing an provisioned test environment

scripts/AzIotSdkTest/README.md:38

• This example points to an action path that does not exist in this repository (there is no actions/ directory), so following it cannot provide the checkout or import the module. Show a checkout of this repository at the pinned tag instead.

* GitHub Actions: `uses: Azure/iot-sdks-e2e-fx/actions/<action>@<tag>`

tests/Validate-Module.ps1:134

• The shim validation is asymmetric: it reports missing expected commands but never rejects an unexpected exported function. A shim that adds a public command would therefore pass even though this change promises the exact 16-command surface; add the reverse comparison as is already done for the manifest.

$ShimExports = Get-ExportedNames -Path $ShimPath
foreach ($Name in @($ExpectedExports | Where-Object { $ShimExports -notcontains $_ })) {
    $Problems.Add("The scripts/Azure.Iot.Sdk.Test.psm1 shim no longer yields '$Name'.")
}

tests/Validate-Module.ps1:97

• These branches only inspect the current checkout; the script never creates an orphan-part or missing-listed-part fixture. Consequently the verification description's claimed negative tests are not actually exercised in CI. Add isolated fixture-based checks or remove that claim from the verification description.

    foreach ($Missing in @($PartFiles.Name | Where-Object { $Listed -notcontains $_ })) {
        $Problems.Add("parts/$Missing exists but is not listed in `$ModuleParts, so it is never loaded.")
    }
    foreach ($Extra in @($Listed | Where-Object { $PartFiles.Name -notcontains $_ })) {
        $Problems.Add("`$ModuleParts lists '$Extra', which does not exist under parts/.")
    }

tests/Validate-Module.ps1:106

• This validation only collects ExportedFunctions.Keys, so it checks command names but never compares parameter metadata (including parameter types) or verifies that the shim and manifest have identical signatures. A future split could change a public parameter while this check still passes, despite the PR's stated name-and-parameter compatibility guarantee. Add a signature comparison for each exported command, including the shim.

    $Module = Import-Module $Path -Force -PassThru
    try {
        return @($Module.ExportedFunctions.Keys | Sort-Object)

• Files reviewed: 19/21 changed files
• Comments generated: 1
• Review effort level: Lite

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

[Copilot]

🟢 Approval recommended

The split preserves the original implementation byte-for-byte and validates module loading, exports, and PowerShell 5.1 compatibility.

Review details

• Files reviewed: 19/21 changed files
• Comments generated: 0 new
• Review effort level: Balanced

[Ewerton Scaboro da Silva (ewertons)]

Updated for #449, now merged.

• Merged master in; no conflicts, branch is 0 behind.
• The actions landed on master importing scripts/Azure.Iot.Sdk.Test.psm1, which this PR turns into a deprecated shim. In-repo callers now import scripts/AzIotSdkTest/AzIotSdkTest.psd1 instead, leaving the shim to the external raw-URL consumers it exists for, matching what the Azure Pipelines templates here already do.
• The config-cmdlet guard now matches ModuleName AzIotSdkTest: importing by manifest names the module after the manifest, so the previous string would have rejected every renderer.
• tests/Validate-ActionScripts.ps1 loads the manifest; the validate-actions workflow triggers on scripts/** rather than only the shim file.

Verified on the merged tree: both validators pass; all 6 config renderers accepted and New-AzureResourceGroupName, New-AzIotTestEnvironment and a wildcard rejected; Test-SubmoduleConsistency resolves; misspelled-cmdlet, splat-drift and script-body-expression checks all still fire.

[Copilot]

🟢 Approval recommended

The module split and consumer migrations are coherent, with only minor test-exactness and wording comments remaining.

Review details

• Files reviewed: 25/26 changed files
• Comments generated: 2
• Review effort level: Balanced