Merge branch 'main' into fix-url-input-error-1180

Author: AakashSuresh2003

LATEST-VERSION.txt

@@ -1 +1 @@
-v1.15.1
+v1.16.0

RELEASENOTES.md

@@ -1,3 +1 @@
-- Fixed `ado2gh integrate-boards` command to properly report errors when GitHub PAT permissions are incorrect, instead of incorrectly reporting success.
-- Added `--target-api-url` option to `gh ado2gh rewire-pipeline` command to support customers migrating to [GitHub Enterprise Cloud with data residency](https://docs.github.com/en/enterprise-cloud@latest/admin/data-residency/about-github-enterprise-cloud-with-data-residency)
-- Updated `ado2gh generate-script` to no longer include ADO Boards integration commands in the generated script. This is a temporary change to fix broken functionality until we can ship a longer term fix. More details can be found [here](https://github.com/github/gh-gei/issues/1357)
+- Fixed `gh gei migrate-secret-alerts` command to handle long resolution comments by truncating them to fit within GitHub's 270 character limit while preserving the resolver name prefix.

releasenotes/v1.16.0.md

@@ -0,0 +1,3 @@
+- Fixed `ado2gh integrate-boards` command to properly report errors when GitHub PAT permissions are incorrect, instead of incorrectly reporting success.
+- Added `--target-api-url` option to `gh ado2gh rewire-pipeline` command to support customers migrating to [GitHub Enterprise Cloud with data residency](https://docs.github.com/en/enterprise-cloud@latest/admin/data-residency/about-github-enterprise-cloud-with-data-residency)
+- Updated `ado2gh generate-script` to no longer include ADO Boards integration commands in the generated script. This is a temporary change to fix broken functionality until we can ship a longer term fix. More details can be found [here](https://github.com/github/gh-gei/issues/1357)

src/Octoshift/Services/SecretScanningAlertService.cs

@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;
@@ -74,7 +75,13 @@ public virtual async Task MigrateSecretScanningAlerts(string sourceOrg, string s
 
                         _log.LogInformation($"  updating target alert:{targetAlert.Alert.Number} to state:{sourceAlert.Alert.State} and resolution:{sourceAlert.Alert.Resolution}");
 
-                        var targetResolutionComment = $"[@{sourceAlert.Alert.ResolverName}] {sourceAlert.Alert.ResolutionComment}";
+                        var prefix = $"[@{sourceAlert.Alert.ResolverName}] ";
+                        var originalComment = sourceAlert.Alert.ResolutionComment ?? string.Empty;
+                        var prefixedComment = prefix + originalComment;
+
+                        var targetResolutionComment = prefixedComment.Length <= 270
+                            ? prefixedComment
+                            : prefix + originalComment[..Math.Max(0, 270 - prefix.Length)];
 
                         await _targetGithubApi.UpdateSecretScanningAlert(targetOrg, targetRepo, targetAlert.Alert.Number, sourceAlert.Alert.State,
                             sourceAlert.Alert.Resolution, targetResolutionComment);

src/OctoshiftCLI.Tests/Octoshift/Services/SecretScanningAlertServiceTests.cs

@@ -1277,4 +1277,89 @@ public async Task Update_When_No_ResolutionComment_Still_Includes_ResolverName_P
         "[@actor] ")  // even though comment was null
         );
     }
+
+    [Fact]
+    public async Task Update_With_Long_Comment_Truncates_Comment_To_Preserve_Actor_Name()
+    {
+        // Arrange - Create a comment that when combined with [@resolverName] would exceed 270 characters
+        var longComment = new string('x', 262); // 262 chars, so [@actor] would make it 271 (prefix is 9 chars)
+        var source = new GithubSecretScanningAlert
+        {
+            Number = 1,
+            State = SecretScanningAlert.AlertStateResolved,
+            SecretType = "foo",
+            Secret = "bar",
+            Resolution = SecretScanningAlert.ResolutionRevoked,
+            ResolverName = "actor",
+            ResolutionComment = longComment
+        };
+        var srcLoc = new GithubSecretScanningAlertLocation { LocationType = "commit", Path = "f", StartLine = 1, EndLine = 1, StartColumn = 1, EndColumn = 1, BlobSha = "x" };
+        _mockSourceGithubApi
+        .Setup(x => x.GetSecretScanningAlertsForRepository(SOURCE_ORG, SOURCE_REPO)).ReturnsAsync(new[] { source });
+        _mockSourceGithubApi
+        .Setup(x => x.GetSecretScanningAlertsLocations(SOURCE_ORG, SOURCE_REPO, 1)).ReturnsAsync(new[] { srcLoc });
+
+        var tgt = new GithubSecretScanningAlert { Number = 42, State = SecretScanningAlert.AlertStateOpen, SecretType = "foo", Secret = "bar" };
+        _mockTargetGithubApi
+        .Setup(x => x.GetSecretScanningAlertsForRepository(TARGET_ORG, TARGET_REPO)).ReturnsAsync(new[] { tgt });
+        _mockTargetGithubApi
+        .Setup(x => x.GetSecretScanningAlertsLocations(TARGET_ORG, TARGET_REPO, 42)).ReturnsAsync(new[] { srcLoc });
+
+        // Act
+        await _service.MigrateSecretScanningAlerts(SOURCE_ORG, SOURCE_REPO, TARGET_ORG, TARGET_REPO, false);
+
+        // Expected: [@actor] + truncated comment (261 chars) = 270 chars total
+        var expectedComment = "[@actor] " + new string('x', 261);
+
+        // Assert - Should truncate comment but preserve actor name
+        _mockTargetGithubApi.Verify(m => m.UpdateSecretScanningAlert(
+        TARGET_ORG,
+        TARGET_REPO,
+        42,
+        SecretScanningAlert.AlertStateResolved,
+        SecretScanningAlert.ResolutionRevoked,
+        expectedComment)  // Truncated comment that preserves actor name and fits 270 char limit
+        );
+    }
+
+    [Fact]
+    public async Task Update_With_Short_Comment_Uses_Prefixed_Comment()
+    {
+        // Arrange - Create a comment that when combined with [@resolverName] would be under 270 characters
+        var shortComment = "This is a short comment";
+        var source = new GithubSecretScanningAlert
+        {
+            Number = 1,
+            State = SecretScanningAlert.AlertStateResolved,
+            SecretType = "foo",
+            Secret = "bar",
+            Resolution = SecretScanningAlert.ResolutionRevoked,
+            ResolverName = "actor",
+            ResolutionComment = shortComment
+        };
+        var srcLoc = new GithubSecretScanningAlertLocation { LocationType = "commit", Path = "f", StartLine = 1, EndLine = 1, StartColumn = 1, EndColumn = 1, BlobSha = "x" };
+        _mockSourceGithubApi
+        .Setup(x => x.GetSecretScanningAlertsForRepository(SOURCE_ORG, SOURCE_REPO)).ReturnsAsync(new[] { source });
+        _mockSourceGithubApi
+        .Setup(x => x.GetSecretScanningAlertsLocations(SOURCE_ORG, SOURCE_REPO, 1)).ReturnsAsync(new[] { srcLoc });
+
+        var tgt = new GithubSecretScanningAlert { Number = 42, State = SecretScanningAlert.AlertStateOpen, SecretType = "foo", Secret = "bar" };
+        _mockTargetGithubApi
+        .Setup(x => x.GetSecretScanningAlertsForRepository(TARGET_ORG, TARGET_REPO)).ReturnsAsync(new[] { tgt });
+        _mockTargetGithubApi
+        .Setup(x => x.GetSecretScanningAlertsLocations(TARGET_ORG, TARGET_REPO, 42)).ReturnsAsync(new[] { srcLoc });
+
+        // Act
+        await _service.MigrateSecretScanningAlerts(SOURCE_ORG, SOURCE_REPO, TARGET_ORG, TARGET_REPO, false);
+
+        // Assert - Should use prefixed comment since length is ok
+        _mockTargetGithubApi.Verify(m => m.UpdateSecretScanningAlert(
+        TARGET_ORG,
+        TARGET_REPO,
+        42,
+        SecretScanningAlert.AlertStateResolved,
+        SecretScanningAlert.ResolutionRevoked,
+        $"[@actor] {shortComment}")  // Prefixed comment when combined length is ok
+        );
+    }
 }