Sync eng/common directory with azure-sdk-tools repository (Azure#12447)

azure-sdk · web-flow · commit 8bb488e3ca70 · 2020-07-08T18:54:20.000-07:00
diff --git a/eng/common/Update-Change-Log.ps1 b/eng/common/Update-Change-Log.ps1
@@ -27,10 +27,10 @@ function Get-ChangelogPath($Path)
 { 
    # Check if CHANGELOG.md is present in path 
    $ChangeLogPath = Join-Path -Path $Path -ChildPath "CHANGELOG.md"
-   if ((Test-Path -Path $ChangeLogPath) -eq $False){
+   if ((Test-Path -Path $ChangeLogPath) -eq $False) {
       # Check if change log exists with name HISTORY.md
       $ChangeLogPath = Join-Path -Path $Path -ChildPath "HISTORY.md"
-      if ((Test-Path -Path $ChangeLogPath) -eq $False){
+      if ((Test-Path -Path $ChangeLogPath) -eq $False) {
          Write-Host "Change log is not found in path[$Path]"
          exit(1)
       }
@@ -45,7 +45,7 @@ function Get-VersionTitle($Version, $Unreleased)
 {
    # Generate version title
    $newVersionTitle = "## $Version $UNRELEASED_TAG"
-   if ($Unreleased -eq $False){
+   if ($Unreleased -eq $False) {
       $releaseDate = Get-Date -Format "(yyyy-MM-dd)"
       $newVersionTitle = "## $Version $releaseDate"
    }
@@ -67,10 +67,10 @@ function Get-NewChangeLog( [System.Collections.ArrayList]$ChangelogLines, $Versi
    # Version increment tool passes replaceversion as False and Unreleased as True
    $is_version_increment = $ReplaceVersion -eq $False -and $Unreleased -eq $True
 
-   for(; $Index -lt $ChangelogLines.Count; $Index++){
-      if (Version-Matches($ChangelogLines[$Index])){
+   for (; $Index -lt $ChangelogLines.Count; $Index++) {
+      if (Version-Matches($ChangelogLines[$Index])) {
          # Find current title in change log
-         if( -not $CurrentTitle){
+         if( -not $CurrentTitle) {
             $CurrentTitle = $ChangelogLines[$Index]
             $CurrentIndex = $Index
             Write-Host "Current Version title: $CurrentTitle"
@@ -80,7 +80,7 @@ function Get-NewChangeLog( [System.Collections.ArrayList]$ChangelogLines, $Versi
          # update change log script is triggered for all packages with current version for Java ( or any language where version is maintained in common file)
          # and this can cause an issue if someone changes changelog manually to prepare for release without updating actual version in central version file
          # Do not add new line or replace existing title when version is already present and script is triggered to add new line
-         if ($is_version_increment -and $ChangelogLines[$Index].Contains($Version)){
+         if ($is_version_increment -and $ChangelogLines[$Index].Contains($Version)) {
             Write-Host "Version is already present in change log."
             exit(0)
          }
@@ -90,26 +90,24 @@ function Get-NewChangeLog( [System.Collections.ArrayList]$ChangelogLines, $Versi
    # Generate version title
    $newVersionTitle = Get-VersionTitle -Version $Version -Unreleased $Unreleased
 
-   if( $newVersionTitle -eq $CurrentTitle){
+   if( $newVersionTitle -eq $CurrentTitle) {
       Write-Host "No change is required in change log. Version is already present."
       exit(0)
    }
 
-   
-
-   if (($ReplaceVersion -eq $True) -and ($Unreleased -eq $False) -and (-not $CurrentTitle.Contains($UNRELEASED_TAG))){
+   if (($ReplaceVersion -eq $True) -and ($Unreleased -eq $False) -and $CurrentTitle.Contains($version) -and (-not $CurrentTitle.Contains($UNRELEASED_TAG))) {
       Write-Host "Version is already present in change log with a release date."
       exit(0)
    }
 
    # if current version title already has new version then we should replace title to update it
-   if ($CurrentTitle.Contains($Version) -and $ReplaceVersion -eq $False){
+   if ($CurrentTitle.Contains($Version) -and $ReplaceVersion -eq $False) {
       Write-Host "Version is already present in title. Updating version title"
       $ReplaceVersion = $True
    }
 
    # if version is already found and not replacing then nothing to do
-   if ($ReplaceVersion -eq $False){
+   if ($ReplaceVersion -eq $False) {
       Write-Host "Adding version title $newVersionTitle"
       $ChangelogLines.insert($CurrentIndex, "")
       $ChangelogLines.insert($CurrentIndex, "")
@@ -121,24 +119,28 @@ function Get-NewChangeLog( [System.Collections.ArrayList]$ChangelogLines, $Versi
       $ChangelogLines[$CurrentIndex] = $newVersionTitle
    }
 
-   return $ChangelogLines      
+   return $ChangelogLines
 }
 
 
 # Make sure path is valid
-if ((Test-Path -Path $ChangeLogPath) -eq $False){
+if ((Test-Path -Path $ChangeLogPath) -eq $False) {
    Write-Host "Change log path is invalid. [$ChangeLogPath]"
    exit(1)
 }
 
 # probe change log path if path is directory 
-if (Test-Path -Path $ChangeLogPath -PathType Container)
-{   
+if (Test-Path -Path $ChangeLogPath -PathType Container) {
    $ChangeLogPath = Get-ChangelogPath -Path $ChangeLogPath
 }
 
 # Read current change logs and add/update version
 $ChangelogLines = [System.Collections.ArrayList](Get-Content -Path $ChangeLogPath)
+
+if ($null -eq $ChangelogLines) { 
+   $ChangelogLines = @() 
+}
+
 $NewContents = Get-NewChangeLog -ChangelogLines $ChangelogLines -Version $Version -Unreleased $Unreleased -ReplaceVersion $ReplaceVersion
 
 Write-Host "Writing change log to file [$ChangeLogPath]"
diff --git a/eng/common/scripts/Verify-ChangeLog.ps1 b/eng/common/scripts/Verify-ChangeLog.ps1
@@ -15,18 +15,25 @@ $ProgressPreference = "SilentlyContinue"
 . (Join-Path $PSScriptRoot SemVer.ps1)
 Import-Module (Join-Path $PSScriptRoot modules ChangeLog-Operations.psm1)
 
-if ((Test-Path $ChangeLogLocation) -and -not([System.String]::IsNullOrEmpty($VersionString)))
+$validChangeLog = $false
+if ($ChangeLogLocation -and $VersionString)
 {
-    Confirm-ChangeLogEntry -ChangeLogLocation $ChangeLogLocation -VersionString $VersionString -ForRelease $ForRelease
+  $validChangeLog = Confirm-ChangeLogEntry -ChangeLogLocation $ChangeLogLocation -VersionString $VersionString -ForRelease $ForRelease
 }
 else 
 {
-    Import-Module (Join-Path $PSScriptRoot modules Package-Properties.psm1)
-    if ([System.String]::IsNullOrEmpty($Language))
-    {
-        $Language = $RepoName.Substring($RepoName.LastIndexOf('-') + 1)
-    }
+  Import-Module (Join-Path $PSScriptRoot modules Package-Properties.psm1)
+  if ([System.String]::IsNullOrEmpty($Language))
+  {
+    $Language = $RepoName.Substring($RepoName.LastIndexOf('-') + 1)
+  }
 
-    $PackageProp = Get-PkgProperties -PackageName $PackageName -ServiceName $ServiceName -Language $Language -RepoRoot $RepoRoot
-    Confirm-ChangeLogEntry -ChangeLogLocation $PackageProp.pkgChangeLogPath -VersionString $PackageProp.pkgVersion -ForRelease $ForRelease
-}
+  $PackageProp = Get-PkgProperties -PackageName $PackageName -ServiceName $ServiceName -Language $Language -RepoRoot $RepoRoot
+  $validChangeLog = Confirm-ChangeLogEntry -ChangeLogLocation $PackageProp.pkgChangeLogPath -VersionString $PackageProp.pkgVersion -ForRelease $ForRelease
+}
+
+if (!$validChangeLog) {
+  exit 1
+}
+
+exit 0
diff --git a/eng/common/scripts/modules/ChangeLog-Operations.psm1 b/eng/common/scripts/modules/ChangeLog-Operations.psm1
@@ -11,8 +11,8 @@ function Get-ChangeLogEntries {
 
   $changeLogEntries = @{}
   if (!(Test-Path $ChangeLogLocation)) {
-    Write-Host "ChangeLog '{0}' was not found" -f $ChangeLogLocation
-    exit 1
+    Write-Error "ChangeLog[${ChangeLogLocation}] does not exist"
+    return $null
   }
 
   try {
@@ -51,14 +51,12 @@ function Get-ChangeLogEntry {
     [Parameter(Mandatory = $true)]
     [String]$VersionString
   )
-
   $changeLogEntries = Get-ChangeLogEntries -ChangeLogLocation $ChangeLogLocation
 
-  if ($changeLogEntries.ContainsKey($VersionString)) {
+  if ($changeLogEntries -and $changeLogEntries.ContainsKey($VersionString)) {
     return $changeLogEntries[$VersionString]
   }
-  Write-Error "Release Notes for the Specified version ${VersionString} was not found"
-  exit 1
+  return $null
 }
 
 #Returns the changelog for a particular version as string
@@ -70,9 +68,16 @@ function Get-ChangeLogEntryAsString {
     [String]$VersionString
   )
 
-  $changeLogEntries = Get-ChangeLogEntry -ChangeLogLocation $ChangeLogLocation -VersionString $VersionString
-  [string]$releaseTitle = $changeLogEntries.ReleaseTitle
-  [string]$releaseContent = $changeLogEntries.ReleaseContent -Join [Environment]::NewLine
+  $changeLogEntry = Get-ChangeLogEntry -ChangeLogLocation $ChangeLogLocation -VersionString $VersionString
+  return ChangeLogEntryAsString $changeLogEntry
+}
+
+function ChangeLogEntryAsString($changeLogEntry) {
+  if (!$changeLogEntry) {
+    return "[Missing change log entry]"
+  }
+  [string]$releaseTitle = $changeLogEntry.ReleaseTitle
+  [string]$releaseContent = $changeLogEntry.ReleaseContent -Join [Environment]::NewLine
   return $releaseTitle, $releaseContent -Join [Environment]::NewLine
 }
 
@@ -87,27 +92,33 @@ function Confirm-ChangeLogEntry {
 
   $changeLogEntry = Get-ChangeLogEntry -ChangeLogLocation $ChangeLogLocation -VersionString $VersionString
 
+  if (!$changeLogEntry) {
+    Write-Error "ChangeLog[${ChangeLogLocation}] does not have an entry for version ${VersionString}."
+    return $false
+  }
+
+  Write-Host "Found the following change log entry for version '${VersionString}' in [${ChangeLogLocation}]."
+  Write-Host "-----"
+  Write-Host (ChangeLogEntryAsString $changeLogEntry)
+  Write-Host "-----"
+
   if ([System.String]::IsNullOrEmpty($changeLogEntry.ReleaseStatus)) {
-    Write-Host ("##[error]Changelog '{0}' has wrong release note title" -f $ChangeLogLocation)
-    Write-Host "##[info]Ensure the release date is included i.e. (yyyy-MM-dd) or (Unreleased) if not yet released"
-    exit 1
+    Write-Error "Entry does not have a correct release status. Please ensure the status is set to a date '(yyyy-MM-dd)' or '(Unreleased)' if not yet released."
+    return $false
   }
 
   if ($ForRelease -eq $True) {
     if ($changeLogEntry.ReleaseStatus -eq "(Unreleased)") {
-      Write-Host ("##[error]No release date set. Please set a release date with format 'yyyy-MM-dd' in the heading for version '{0}' in the changelog '{1}'." -f $VersionString, $ChangelogLocation)
-      exit 1
+      Write-Error "Entry has no release date set. Please ensure to set a release date with format 'yyyy-MM-dd'."
+      return $false
     }
 
     if ([System.String]::IsNullOrWhiteSpace($changeLogEntry.ReleaseContent)) {
-      Write-Host ("##[error]Empty Release Notes for '{0}' in '{1}'" -f $VersionString, $ChangeLogLocation)
-      Write-Host "##[info]Please ensure there is a release notes entry before releasing the package."
-      exit 1
+      Write-Error "Entry has no content. Please ensure to provide some content of what changed in this version."
+      return $false
     }
   }
-
-  Write-Host $changeLogEntry.ReleaseTitle
-  Write-Host $changeLogEntry.ReleaseContent
+  return $true
 }
  
 Export-ModuleMember -Function 'Get-ChangeLogEntries'
diff --git a/eng/common/scripts/modules/Package-Properties.psm1 b/eng/common/scripts/modules/Package-Properties.psm1
@@ -3,25 +3,32 @@
 class PackageProps
 {
     [string]$pkgName
-    [AzureEngSemanticVersion]$pkgVersion
+    [string]$pkgVersion
     [string]$pkgDirectoryPath
     [string]$pkgServiceName
     [string]$pkgReadMePath
     [string]$pkgChangeLogPath
+    [string]$pkgGroup
 
-    PackageProps(
+    PackageProps([string]$pkgName,[string]$pkgVersion,[string]$pkgDirectoryPath,[string]$pkgServiceName)
+    {
+        $this.Initialize($pkgName, $pkgVersion, $pkgDirectoryPath, $pkgServiceName)
+    }
+
+    PackageProps([string]$pkgName,[string]$pkgVersion,[string]$pkgDirectoryPath,[string]$pkgServiceName,[string]$pkgGroup="")
+    {
+        $this.Initialize($pkgName, $pkgVersion, $pkgDirectoryPath, $pkgServiceName, $pkgGroup)
+    }
+
+    hidden [void]Initialize(
         [string]$pkgName,
         [string]$pkgVersion,
         [string]$pkgDirectoryPath,
         [string]$pkgServiceName
     )
     {
         $this.pkgName = $pkgName
-        $this.pkgVersion = [AzureEngSemanticVersion]::ParseVersionString($pkgVersion)
-        if ($this.pkgVersion -eq $null)
-        {
-            Write-Error "Invalid version in $pkgDirectoryPath"
-        }
+        $this.pkgVersion = $pkgVersion
         $this.pkgDirectoryPath = $pkgDirectoryPath
         $this.pkgServiceName = $pkgServiceName
 
@@ -43,6 +50,18 @@ class PackageProps
             $this.pkgChangeLogPath = $null
         }
     }
+
+    hidden [void]Initialize(
+        [string]$pkgName,
+        [string]$pkgVersion,
+        [string]$pkgDirectoryPath,
+        [string]$pkgServiceName,
+        [string]$pkgGroup
+    )
+    {
+        $this.Initialize($pkgName, $pkgVersion, $pkgDirectoryPath, $pkgServiceName)
+        $this.pkgGroup = $pkgGroup
+    }
 }
 
 $ProgressPreference = "SilentlyContinue"
@@ -127,10 +146,11 @@ function Extract-JavaPkgProps ($pkgPath, $serviceName, $pkgName)
         $projectData.load($projectPath)
         $projectPkgName = $projectData.project.artifactId
         $pkgVersion = $projectData.project.version
+        $pkgGroup = $projectData.project.groupId
 
         if ($projectPkgName -eq $pkgName)
         {
-            return [PackageProps]::new($pkgName, $pkgVersion.ToString(), $pkgPath, $serviceName)
+            return [PackageProps]::new($pkgName, $pkgVersion.ToString(), $pkgPath, $serviceName, $pkgGroup)
         }
     }
     return $null
