Add regenerate option to generate scripts (#1517)

* Add regenerate option to generate scripts

* Embed logic within functions

* Tweaks to avoid BOM issues on various pwsh versions

Author: MichaelSimons

README.md

@@ -205,11 +205,10 @@ See the workflow documented in the servicing branch readmes for additional requi
 #### Regenerating all Reference Packages
 
 As bugs are fixed or enhancements are made to the generate tooling, it may be desirable or necessary to
-regenerate the existing packages. The following commands can be used to generate all of the reference packages.
+regenerate the existing packages. The following command will regenerate all of the reference packages.
 
 ``` bash
-find src/referencePackages/src -mindepth 2 -maxdepth 2 -type d | awk -F'/' '{print $(NF-1)","$NF}' > packages.csv
-./generate.sh -x -c packages.csv
+./generate.sh -a
 ```
 
 ### Targeting

eng/generate.ps1

@@ -3,8 +3,9 @@ Param(
   [string[]][Alias('p')]$package,
   [string][Alias('c')]$csv,
   [string][Alias('d')]$destination,
-  [ValidateSet('ref','text')][string][Alias('t')]$type,
+  [ValidateSet('ref','text')][string][Alias('t')]$type = 'ref',
   [switch][Alias('x')]$excludeDependencies,
+  [switch][Alias('a')]$regenerateAll,
   [string][Alias('f')]$feeds,
   [switch][Alias('h')]$help,
   [Parameter(ValueFromRemainingArguments=$true)][String[]]$properties
@@ -33,10 +34,41 @@ function Get-Help() {
   Write-Host "  -d|-destination                              A path to the root of the repo to copy source into."
   Write-Host "  -t|-type                                     Type of the package to generate. Accepted values: ref (default) | text."
   Write-Host "  -x|-excludeDependencies                      Determines if package dependencies should be excluded. Default is false."
+  Write-Host "  -a|-regenerateAll                            Regenerate all packages of the specified type."
   Write-Host "  -f|-feeds                                    A semicolon-separated list of additional NuGet feeds to use during restore."
   Write-Host "  -h|-help                                     Print help and exit."
 }
 
+function Initialize-PackageRegeneration {
+  Write-Host "Discovering packages for regeneration..."
+
+  $script:tempCsv = [System.IO.Path]::GetTempFileName()
+  $packages = @()
+
+  if ($type -eq "ref") {
+    $packagesDir = Join-Path $PSScriptRoot "..\src\referencePackages\src"
+  } elseif ($type -eq "text") {
+    $packagesDir = Join-Path $PSScriptRoot "..\src\textOnlyPackages\src"
+  }
+
+  if (Test-Path $packagesDir) {
+    $packages = Get-ChildItem $packagesDir -Directory | ForEach-Object {
+      $pkg = $_.Name
+      Get-ChildItem $_.FullName -Directory | ForEach-Object { "$pkg,$($_.Name)" }
+    }
+  }
+
+  [System.IO.File]::WriteAllLines($script:tempCsv, $packages)
+  if ($packages.Count -eq 0) {
+    Write-Error "No packages found to regenerate"
+    exit -1
+  }
+
+  Write-Host "Found $($packages.Count) package(s) to regenerate"
+
+  $script:arguments += " /p:PackageCSV=`"$script:tempCsv`" /p:ExcludePackageDependencies=true"
+}
+
 if ($help -or $($PSBoundParameters.Count) -eq 0) {
   Get-Help
   exit 0
@@ -62,10 +94,25 @@ foreach ($argument in $PSBoundParameters.Keys)
     "destination"                { $arguments += " /p:PackagesSrcDirectory=`"$($PSBoundParameters[$argument])`"" }
     "type"                       { $arguments += " /p:PackageType=$($PSBoundParameters[$argument])" }
     "excludeDependencies"        { $arguments += " /p:ExcludePackageDependencies=true" }
+    "regenerateAll"              { } # Handled separately below
     "feeds"                      { $arguments += " /p:RestoreAdditionalProjectSources=`"$($PSBoundParameters[$argument])`"" }
     default                      { $arguments += " $($PSBoundParameters[$argument])" }
   }
 }
 
-Invoke-Expression "& `"$PSScriptRoot\common\build.ps1`" -restore -build -warnaserror 0 /p:GeneratePackageSource=true $arguments"
+$tempCsv = $null
+
+try {
+  if ($regenerateAll) {
+    Initialize-PackageRegeneration
+  }
+
+  Invoke-Expression "& `"$PSScriptRoot\common\build.ps1`" -restore -build -warnaserror 0 /p:GeneratePackageSource=true $arguments"
+}
+finally {
+  if ($tempCsv) {
+    Remove-Item $tempCsv -ErrorAction SilentlyContinue
+  }
+}
+
 exit 0

generate.sh

@@ -33,17 +33,49 @@ usage() {
     echo "  -d|--destination                              A path to the root of the repo to copy source into."
     echo "  -t|--type                                     Type of the package to generate. Accepted values: ref (default) | text."
     echo "  -x|--excludeDependencies                      Determines if package dependencies should be excluded. Default is false."
+    echo "  -a|--regenerate-all                           Regenerate all packages of the specified type."
     echo "  -f|--feeds                                    A semicolon-separated list of additional NuGet feeds to use during restore."
     echo "  -h|--help                                     Print help and exit."
 }
 
+setup_package_regeneration() {
+    echo "Discovering packages for regeneration..."
+
+    tempCsv=$(mktemp "${TMPDIR:-/tmp}/packages.XXXXXX.csv")
+
+    trap "rm -f '$tempCsv'" EXIT INT TERM
+
+    if [ "$type" = "ref" ]; then
+        packagesDir="$scriptroot/src/referencePackages/src"
+    elif [ "$type" = "text" ]; then
+        packagesDir="$scriptroot/src/textOnlyPackages/src"
+    fi
+
+    if [ -d "$packagesDir" ]; then
+        find "$packagesDir" -mindepth 2 -maxdepth 2 -type d | \
+            awk -F'/' '{print $(NF-1)","$NF}' >> "$tempCsv"
+    fi
+
+    packageCount=$(wc -l < "$tempCsv")
+    if [ "$packageCount" -eq 0 ]; then
+        echo -e "${RED}ERROR: No packages found to regenerate${NC}"
+        exit 1
+    fi
+
+    echo "Found $packageCount package(s) to regenerate"
+
+    arguments="$arguments /p:PackageCSV=\"$tempCsv\" /p:ExcludePackageDependencies=true"
+}
+
 if [[ $# -le 0 ]]; then
-	usage
-	exit 0
+    usage
+    exit 0
 fi
 
 arguments=''
 extraArgs=''
+regenerateAll=false
+type='ref'
 
 while [[ $# > 0 ]]; do
     opt="$(echo "${1/#--/-}" | tr "[:upper:]" "[:lower:]")"
@@ -97,6 +129,10 @@ while [[ $# > 0 ]]; do
             arguments="$arguments /p:ExcludePackageDependencies=true"
             shift 1
             ;;
+        -a|-regenerate-all)
+            regenerateAll=true
+            shift 1
+            ;;
         -f|-feeds)
             if [ -z ${2+x} ]; then
                 echo -e "${RED}ERROR: No feed supplied.${NC}"
@@ -117,5 +153,9 @@ while [[ $# > 0 ]]; do
     esac
 done
 
+if [ "$regenerateAll" = true ]; then
+    setup_package_regeneration
+fi
+
 # Build the projects to generate text only or reference package source
 "$scriptroot/eng/common/build.sh" --restore --build --warnaserror false /p:GeneratePackageSource=true $arguments $extraArgs