The original compatibility check module was hastily implemented and was quite slow. It also needed CIM/WMI to be available. This meant it didn't work nicely with things like Azure Functions.

I rewrote it as a binary to be faster and to have a simpler, more composable, more semantically definite .NET API.

There are a bunch of breaking changes with the compatibility types here (which are technically exposed by PSSA). There are also huge breaking changes in the PSCompatibilityAnalyzer module (I got rid of most of the commands), but that has never been released and is still below version 1.0, so that seems like less of a concern.

Basically there are no changes that break the PowerShell API of PSScriptAnalyzer unless people have gone hunting for types that are loaded (but aren't used directly by the module).

Also renames the PSCompatibilityAnalyzer module to PSCompatibilityCollector since that's more accurate and less confusing.

List of changes

Renamed PSCompatibilityAnalyzer to PSCompatibilityCollector, since that better describes what the module does. The module is now version 0.2.0.
Got rid of almost all the psm1 module implementation in favour of a binary module. This gets rid of all the command originally in that module in favour of a minimal set of cmdlets with a common noun prefix.
Added explicit JSON configuration to the serialiser. Extra fields in JSON are now explicitly ignored (this is the default, so the behaviour has not changed), and default values are now explicitly omitted from JSON and restored in C# when absent (again, this should not change any behaviours)
Added a JSON schema version, with a default version of 1.0. The current generated schema version is 1.1 (since there are additions but not breaking changes, breaking changes should start at 2.0)
Flattened the Query and Data namespaces. The Query namespace was already mostly like this. It made sense to me to flatten it all from a complexity standpoint.
Change theConstituentProfiles field to be aReadOnlySet<string> instead of aHashSet<string>
Change type dictionaries to be case-sensitive for collection and overriding (like PowerShell) for the query API (this is already done inPrevent .NET members with names differing only by case from crashing the compatibility profiler #1195, but I need it on my machine). WhenPrevent .NET members with names differing only by case from crashing the compatibility profiler #1195 is merged, I'll rebase this on top.
Move things out of theMicrosoft.PowerShell.CrossCompatibility.Utility namespace and into the base namespace,Collection orRetrieval depending on what the class does, since I thinkUtility should be reserved for internal helpers
Omit the pre-existing profiles from the output PSCompatibilityCollector module, since they aren't needed for collection
Add profiles for Azure Functions and Azure Automation

PR Checklist

PR has a meaningful title
- Use the present tense and imperative mood when describing your changes
Summarized changes
Change is not breaking
Make sure all.cs,.ps1 and.psm1 files have the correct copyright header
Make sure you've added a new test if existing tests do not effectively test the code changed and/or updated documentation
This PR is ready to merge and is notWork in Progress.
- If the PR is work in progress, please add the prefixWIP: to the beginning of the title and remove the prefix when the PR is ready.

rjmholt requested review fromJamesWTruher andbergmeister

April 8, 2019 21:10

rjmholt changed the title~~WIP: Convert compatibility module to binary module, fix compatibility with Azure environments~~Convert compatibility module to binary module, fix compatibility with Azure environments

Apr 9, 2019

Copy link

Collaborator

bergmeister commentedApr 15, 2019

@rjmholt I'm overall OK with the changes as they are mainly just in your module. But I think@JamesWTruher would be the better person to review the logic, etc. as he has more experience/knowledge in this area.

bergmeister removed their request for review

April 15, 2019 20:47

rjmholt requested review fromSteveL-MSFT anddaxian-dbw

April 15, 2019 22:08

rjmholtand others added23 commits

April 24, 2019 14:46

Use fallback CIM API

2f93ca2

Add platform data collection type

df10417

Add C# implementations of powershell data collection

9d3c041

Add more .NET pwsh collection APIs

7159b8b

Add preliminary New-PSCompatibilityProfile cmdlet implementation

3fcb48d

Add new cmdlets, change JSON settings, add schema version

85bd373

Add most validation logic

528e47d

Update collectors, add assertion cmdlet

f7b3628

Fix files

8a75c91

Fix enumeration in json cmdlet

ab660e5

Fix service pack

d7c2169

Fix idiocy

9e2d19b

Fix generic parameter types being null

565dce6

Remove MMI, use registry for windows SKU info

42d4453

Convert scrap errors to warnings

c712760

Fix error -> warning usage

28443d4

Fix up sku querying

28bb895

Exclude compat module from own profiles

0399922

Add copyright

40943fb

Add doc comments

6bdbc20

Add missing docs

dd2035d

Rename PSCompatibilityAnalyzer to PSCompatibilityCollector

2ee3c5e

Change MMI version

b41f0eb

rjmholtand others added13 commits

April 24, 2019 14:48

Fix pester test skip

1413c4b

Add proper versioning to schema

a768d76

Fix up namespaces

66f92a7

Fix file ending newlines

758db97

Update schema version of azure profiles

6d10fb0

Fix namespaces in rules

eaf2ede

Rename Az profiles

a76ac6c

Fix type naming namespace change

138737d

Fix syntax in AzF profile

110a3f5

Add macOS profile

dced589

Prevent permissions problem reading bins for version

b700465

Add simple command tests for AzF profile

7f57e61

Add types tests

c9663ce

rjmholt force-pushed theazf-compat branch fromf775136 toc9663ceCompare

April 24, 2019 04:49

rjmholt added9 commits

April 24, 2019 15:03

Remove old compatibility module dir

2ce9992

Add rule enable settings

cf97e0b

Fix grouping logic

234fae4

Add breaks to switch

808a7eb

Make negative group name test more diagnostic

e65d011

Refine empty group test

f04009d

Fix other test

1c78a6b

Remove faulty test component

9f6ef22

Fix encoding of test files

69c483c

JamesWTruher reviewed

Apr 24, 2019

View reviewed changes

Copy link

Contributor

JamesWTruher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

here's the first of my comments

...ollector/Microsoft.PowerShell.CrossCompatibility/Collection/CompatibilityProfileCollector.cs Outdated

		/// Add path prefixes of modules to exclude.
		/// </summary>
		/// <param name="modulePrefixes">Path prefixes of modules to exclude.</param>
		publicBuilderExcludedModulePathPrefixes(IReadOnlyCollection<string>modulePrefixes)

Copy link

Contributor

JamesWTruherApr 24, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

is there a reason why some of these aren't a void return? I see that you don't use the return value where you call it.

Copy link

ContributorAuthor

		/// <returns>An object containing common feature compatibility information.</returns>
		publicCommonPowerShellDataGetCommonPowerShellData()
		{
		CmdletInfogcmInfo=_pwsh.AddCommand(PowerShellDataCollector.GcmInfo)

		_pwsh.Dispose();
		_platformInfoCollector.Dispose();
		_pwshDataCollector.Dispose();
		}

		osData.DistributionId=lsbInfo["DistributionId"];
		osData.DistributionVersion=lsbInfo["DistributionVersion"];
		osData.DistributionPrettyName=lsbInfo["DistributionPrettyName"];
		break;


		try
		{
		functionData.ParameterSets=GetParameterSets(function.ParameterSets);

		/// </summary>
		/// <param name="variables">Variables to collect information on.</param>
		/// <returns>An array of the names of the variables.</returns>
		publicstring[]GetVariablesData(IEnumerable<PSVariable>variables)

		for(inti=0;i<outputTypeData.Length;i++)
		{
		outputTypeData[i]=outputType[i].Type!=null
		?TypeNaming.GetFullTypeName(outputType[i].Type)

		privatestaticReadOnlySet<string>GetPowerShellCommonParameterNames()
		{
		varset=newList<string>();
		foreach(PropertyInfopropertyintypeof(CommonParameters).GetProperties())

		Type[]types=asm.GetTypes();
		JsonDictionary<string,JsonDictionary<string,TypeData>>namespacedTypes=null;
		if(types.Any())
		if(types.Length>0)


		privateconststringTHIS_MODULE_NAME="PSCompatibilityCollector";

		privatestaticreadonlyRegexs_typeDataRegex=newRegex("Error in TypeData\"([A-Za-z.]+)\"",RegexOptions.Compiled);

		// Get default variables and core aliases out of a fresh runspace
		using(SMA.PowerShellfreshPwsh=SMA.PowerShell.Create(RunspaceMode.NewRunspace))
		{
		Collection<PSVariable>defaultVariables=freshPwsh.AddCommand("Get-ChildItem")


		try
		{
		functionData.OutputType=GetOutputType(function.OutputType);


		try
		{
		functionData.OutputType=GetOutputType(function.OutputType);

		/// If set, do not include whitespace like indentation or newlines in the output JSON.
		/// </summary>
		[Parameter]
		[Alias("Compress")]

		return;

		default:
		thrownewArgumentException($"Unsupported type for{nameof(JsonSource)} parameter. Should be a string, FileInfo or TextReader object.");

		/// <summary>
		/// The verison of the profile schema this profile object uses.
		/// </summary>
		[DataMember]

		[Parameter]
		publicDotnetDataDotNet{get;set;}

		protectedoverridevoidEndProcessing()

		}

		// If PassThru is set, just pass the object back and we're done
		if(PassThru)

		usingSystem.Collections;
		usingSystem.Collections.Generic;

		namespaceMicrosoft.PowerShell.CrossCompatibility


		namespaceMicrosoft.PowerShell.CrossCompatibility.Utility
		{
		internalstaticclassPowerShellExtensions

		/// <summary>
		/// Class defining the Assert-PSCompatibilityProfileIsValid cmdlet.
		/// </summary>
		[Cmdlet(VerbsLifecycle.Assert,CommandUtilities.MODULE_PREFIX+"ProfileIsValid")]

Movatterモバイル変換

Convert compatibility module to binary module, fix compatibility with Azure environments#1212

Convert compatibility module to binary module, fix compatibility with Azure environments#1212

Uh oh!

Conversation

rjmholt commentedApr 8, 2019• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

PR Summary

List of changes

PR Checklist

Uh oh!

bergmeister commentedApr 15, 2019

Uh oh!

JamesWTruher left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

rjmholt commentedApr 8, 2019•
edited
Loading

rjmholtApr 25, 2019•
edited
Loading