PowerShell/tools/findMissingNotices.ps1
Travis Plunk f41b6b415e
Add GitHub Workflow to keep notices up to date (#16284)
Co-authored-by: Robert Holt <rjmholt_msft@outlook.com>
2021-10-28 11:44:06 -07:00

221 lines
6.8 KiB
PowerShell

# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# This script is used to completely rebuild the cgmanifgest.json file,
# which is used to generate the notice file.
# Requires the module dotnet.project.assets from the PowerShell Gallery authored by @TravisEz13
Import-Module dotnet.project.assets
. "$PSScriptRoot\..\tools\buildCommon\startNativeExecution.ps1"
$existingRegistrationTable = @{}
$existingRegistrationsJson = Get-Content $PSScriptRoot\..\cgmanifest.json | ConvertFrom-Json -AsHashtable
$existingRegistrationsJson.Registrations | ForEach-Object {
$registration = [Registration]$_
if($registration.Component) {
$name = $registration.Component.Name()
$existingRegistrationTable.Add($name, $registration)
}
}
Class Registration {
[Component]$Component
[bool]$DevelopmentDependency
}
Class Component {
[ValidateSet("nuget")]
[String] $Type
[Nuget]$Nuget
[string]ToString() {
$message = "Type: $($this.Type)"
if ($this.Type -eq "nuget") {
$message += "; $($this.Nuget)"
}
return $message
}
[string]Name() {
switch ($this.Type) {
"nuget" {
return $($this.Nuget.Name)
}
default {
throw "Unknown component type: $($this.Type)"
}
}
throw "How did we get here?!?"
}
[string]Version() {
switch ($this.Type) {
"nuget" {
return $($this.Nuget.Version)
}
default {
throw "Unknown component type: $($this.Type)"
}
}
throw "How did we get here?!?"
}
}
Class Nuget {
[string]$Name
[string]$Version
[string]ToString() {
return "$($this.Name) - $($this.Version)"
}
}
function New-NugetComponent {
param(
[string]$name,
[string]$version
)
$nuget = [Nuget]@{
Name = $name
Version = $version
}
$Component = [Component]@{
Type = "nuget"
Nuget = $nuget
}
$registration = [Registration]@{
Component = $Component
DevelopmentDependency = $false
}
return $registration
}
$winDesktopSdk = 'Microsoft.NET.Sdk.WindowsDesktop'
if (!$IsWindows) {
$winDesktopSdk = 'Microsoft.NET.Sdk'
Write-Warning "Always using $winDesktopSdk since this is not windows!!!"
}
Function Get-CGRegistrations {
param(
[Parameter(Mandatory)]
[ValidateSet(
"alpine-x64",
"linux-arm",
"linux-arm64",
"linux-x64",
"osx-arm64",
"osx-x64",
"win-arm",
"win-arm64",
"win7-x64",
"win7-x86",
"modules")]
[string]$Runtime,
[Parameter(Mandatory)]
[System.Collections.Generic.Dictionary[string, Registration]] $RegistrationTable
)
$newRegistrations = $Registrations
$dotnetTargetName = 'net6.0'
$dotnetTargetNameWin7 = 'net6.0-windows7.0'
$unixProjectName = 'powershell-unix'
$windowsProjectName = 'powershell-win-core'
$actualRuntime = $Runtime
switch -regex ($Runtime) {
"alpine-.*" {
$folder = $unixProjectName
$target = "$dotnetTargetName|$Runtime"
}
"linux-.*" {
$folder = $unixProjectName
$target = "$dotnetTargetName|$Runtime"
}
"osx-.*" {
$folder = $unixProjectName
$target = "$dotnetTargetName|$Runtime"
}
"win7-.*" {
$sdkToUse = $winDesktopSdk
$folder = $windowsProjectName
$target = "$dotnetTargetNameWin7|$Runtime"
}
"win-.*" {
$folder = $windowsProjectName
$target = "$dotnetTargetNameWin7|$Runtime"
}
"modules" {
$folder = "modules"
$actualRuntime = 'linux-x64'
$target = "$dotnetTargetName|$actualRuntime"
}
Default {
throw "Invalid runtime name: $Runtime"
}
}
Write-Verbose "Getting registrations for $folder - $actualRuntime ..." -Verbose
Get-PSDrive -Name $folder -ErrorAction Ignore | Remove-PSDrive
Push-Location $PSScriptRoot\..\src\$folder
try {
Start-NativeExecution -VerboseOutputOnError -sb {
dotnet restore --runtime $actualRuntime "/property:SDKToUse=$sdkToUse"
}
$null = New-PADrive -Path $PSScriptRoot\..\src\$folder\obj\project.assets.json -Name $folder
try {
$targets = Get-ChildItem -Path "${folder}:/targets/$target" -ErrorAction Stop | Where-Object {
$_.Type -eq 'package' -and
$_.Name -notlike 'DotNetAnalyzers.DocumentationAnalyzers*' -and
$_.Name -notlike 'StyleCop*' -and
$_.Name -notlike 'Microsoft.CodeAnalysis.Analyzers*' -and
$_.Name -notlike 'Microsoft.CodeAnalysis.NetAnalyzers*'
} | select-object -ExpandProperty name
} catch {
Get-ChildItem -Path "${folder}:/targets" | Out-String | Write-Verbose -Verbose
throw
}
} finally {
Pop-Location
Get-PSDrive -Name $folder -ErrorAction Ignore | Remove-PSDrive
}
$targets | ForEach-Object {
$target = $_
$parts = ($target -split '\|')
$name = $parts[0]
$targetVersion = $parts[1]
$pattern = [regex]::Escape($name) + " "
$tpnMatch = Select-String -Path $PSScriptRoot\..\ThirdPartyNotices.txt -Pattern $pattern
# Add the registration to the cgmanifest if the TPN does not contain the name of the target OR
# the exisitng CG contains the registration, because if the existing CG contains the registration,
# that might be the only reason it is in the TPN.
if ((!$tpnMatch -or $existingRegistrationTable.ContainsKey($name)) -and !$RegistrationTable.ContainsKey($target)) {
$registration = New-NugetComponent -Name $name -Version $targetVersion
$RegistrationTable.Add($target, $registration)
}
}
}
$registrations = [System.Collections.Generic.Dictionary[string, Registration]]::new()
$lastCount = 0
foreach ($runtime in "win7-x64", "linux-x64", "osx-x64", "alpine-x64", "win-arm", "linux-arm", "linux-arm64", "osx-arm64", "win-arm64", "win7-x86") {
Get-CGRegistrations -Runtime $runtime -RegistrationTable $registrations
$count = $registrations.Count
$newCount = $count - $lastCount
$lastCount = $count
Write-Verbose "$newCount new registrations, $count total..." -Verbose
}
$newRegistrations = $registrations.Keys | Sort-Object | ForEach-Object { $registrations[$_] }
$count = $newRegistrations.Count
@{Registrations = $newRegistrations } | ConvertTo-Json -depth 99 | Set-Content $PSScriptRoot\..\cgmanifest.json
Write-Verbose "$count registrations created!" -Verbose