Merge branch 'main' into brianaj/external-pr-1450

brianaj · web-flow · commit 7070effa9771 · 2025-12-03T17:27:22.000-08:00
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -365,7 +365,7 @@ jobs:
           $TAG_NAME | Out-File ./LATEST-VERSION.txt
 
       - name: Commit Release Notes and Version
-        uses: stefanzweifel/git-auto-commit-action@v7
+        uses: stefanzweifel/git-auto-commit-action@28e16e81777b558cc906c8750092100bbb34c5e3
         with:
           commit_message: Automated commit of archived release notes and version file [skip ci]
           file_pattern: RELEASENOTES.md releasenotes/*.md LATEST-VERSION.txt
diff --git a/.github/workflows/publish-test-results.yml b/.github/workflows/publish-test-results.yml
@@ -37,7 +37,7 @@ jobs:
         run: |
           eventjson=`cat 'artifacts/Event File/event.json'`
           prnumber=`echo $(jq -r '.pull_request.number' <<< "$eventjson")`
-          echo "PR_NUMBER=$(echo $prnumber | tr -cd '[0-9]')" >> $GITHUB_ENV
+          echo "PR_NUMBER=$(echo $prnumber | tr -cd '0-9')" >> $GITHUB_ENV
       
       - name: Publish Unit Test Results
         uses: EnricoMi/publish-unit-test-result-action@v2
diff --git a/LATEST-VERSION.txt b/LATEST-VERSION.txt
@@ -1 +1 @@
-v1.20.0
+v1.22.0
diff --git a/RELEASENOTES.md b/RELEASENOTES.md
@@ -0,0 +1 @@
+- bbs2gh : Added validation for `--archive-path` and `--bbs-shared-home` options to fail fast with clear error messages if the provided paths do not exist or are not accessible. Archive path is now logged before upload operations to help with troubleshooting
diff --git a/releasenotes/v1.21.0.md b/releasenotes/v1.21.0.md
@@ -0,0 +1 @@
+- **ado2gh**: Added support for GitHub Enterprise cloud with data residency app service connections when using `--rewire-pipelines`. The tool now recognizes both `GitHub` and `GitHubProximaPipelines` service connection types.
diff --git a/releasenotes/v1.22.0.md b/releasenotes/v1.22.0.md
@@ -0,0 +1 @@
+- Added `--migration-id` option to `download-logs` command to allow downloading logs directly by migration ID without requiring org/repo lookup
diff --git a/src/Octoshift/Commands/DownloadLogs/DownloadLogsCommandArgs.cs b/src/Octoshift/Commands/DownloadLogs/DownloadLogsCommandArgs.cs
@@ -5,6 +5,7 @@ public class DownloadLogsCommandArgs : CommandArgs
 {
     public string GithubOrg { get; set; }
     public string GithubRepo { get; set; }
+    public string MigrationId { get; set; }
     public string GithubApiUrl { get; set; }
     [Secret]
     public string GithubPat { get; set; }
diff --git a/src/Octoshift/Commands/DownloadLogs/DownloadLogsCommandBase.cs b/src/Octoshift/Commands/DownloadLogs/DownloadLogsCommandBase.cs
@@ -18,16 +18,19 @@ public class DownloadLogsCommandBase : CommandBase<DownloadLogsCommandArgs, Down
 
     public virtual Option<string> GithubOrg { get; } = new("--github-org")
     {
-        IsRequired = true,
         Description = "GitHub organization to download logs from."
     };
 
     public virtual Option<string> GithubRepo { get; } = new("--github-repo")
     {
-        IsRequired = true,
         Description = "Target repository to download latest log for."
     };
 
+    public virtual Option<string> MigrationId { get; } = new("--migration-id")
+    {
+        Description = "Migration ID to download logs for. If specified, --github-org and --github-repo are not required."
+    };
+
     public virtual Option<string> GithubApiUrl { get; } = new("--github-api-url")
     {
         Description = "Target GitHub API URL if not targeting github.com (default: https://api.github.com)."
@@ -79,6 +82,7 @@ protected void AddOptions()
     {
         AddOption(GithubOrg);
         AddOption(GithubRepo);
+        AddOption(MigrationId);
         AddOption(GithubApiUrl);
         AddOption(GithubPat);
         AddOption(MigrationLogFile);
diff --git a/src/Octoshift/Commands/DownloadLogs/DownloadLogsCommandHandler.cs b/src/Octoshift/Commands/DownloadLogs/DownloadLogsCommandHandler.cs
@@ -38,6 +38,21 @@ public async Task Handle(DownloadLogsCommandArgs args)
             throw new ArgumentNullException(nameof(args));
         }
 
+        if (args.MigrationId.HasValue())
+        {
+            if (args.GithubOrg.HasValue() || args.GithubRepo.HasValue())
+            {
+                _log.LogWarning("--github-org and --github-repo are ignored when --migration-id is specified.");
+            }
+        }
+        else
+        {
+            if (!args.GithubOrg.HasValue() || !args.GithubRepo.HasValue())
+            {
+                throw new OctoshiftCliException("Either --migration-id (GraphQL migration ID) or both --github-org and --github-repo must be specified.");
+            }
+        }
+
         _log.LogWarning("Migration logs are only available for 24 hours after a migration finishes!");
 
         _log.LogInformation("Downloading migration logs...");
@@ -49,22 +64,52 @@ public async Task Handle(DownloadLogsCommandArgs args)
             throw new OctoshiftCliException($"File {args.MigrationLogFile} already exists! Use --overwrite to overwrite this file.");
         }
 
-        var result = await _retryPolicy.RetryOnResult(async () => await _githubApi.GetMigrationLogUrl(args.GithubOrg, args.GithubRepo), r => r?.MigrationLogUrl.IsNullOrWhiteSpace() ?? false,
-            "Waiting for migration log to populate...");
+        string logUrl;
+        string migrationId;
+        string repositoryName;
 
-        if (result.Outcome == OutcomeType.Successful && result.Result is null)
+        if (args.MigrationId.HasValue())
         {
-            throw new OctoshiftCliException($"Migration for repository {args.GithubRepo} not found!");
-        }
+            // Use migration ID directly
+            migrationId = args.MigrationId;
+            var migrationResult = await _retryPolicy.RetryOnResult(
+                async () => await _githubApi.GetMigration(migrationId),
+                r => string.IsNullOrWhiteSpace(r.MigrationLogUrl),
+                "Waiting for migration log to populate...");
+
+            if (migrationResult.Outcome == OutcomeType.Failure)
+            {
+                throw new OctoshiftCliException($"Migration log for migration {migrationId} is currently unavailable. Migration logs are only available for 24 hours after a migration finishes. Please ensure the migration ID is correct and the migration has completed recently.");
+            }
 
-        if (result.Outcome == OutcomeType.Failure)
-        {
-            throw new OctoshiftCliException($"Migration log for repository {args.GithubRepo} unavailable!");
+            var (_, RepositoryName, _, _, MigrationLogUrl) = migrationResult.Result;
+            logUrl = MigrationLogUrl;
+            repositoryName = RepositoryName;
         }
+        else
+        {
+            // Use org/repo to find migration
+            var result = await _retryPolicy.RetryOnResult(async () => await _githubApi.GetMigrationLogUrl(args.GithubOrg, args.GithubRepo), r => r?.MigrationLogUrl.IsNullOrWhiteSpace() ?? false,
+                "Waiting for migration log to populate...");
+
+            if (result.Outcome == OutcomeType.Successful && result.Result is null)
+            {
+                throw new OctoshiftCliException($"Migration for repository {args.GithubRepo} not found!");
+            }
 
-        var (logUrl, migrationId) = result.Result.Value;
+            if (result.Outcome == OutcomeType.Failure)
+            {
+                throw new OctoshiftCliException($"Migration log for repository {args.GithubRepo} unavailable!");
+            }
+
+            (logUrl, migrationId) = result.Result.Value;
+            repositoryName = args.GithubRepo;
+        }
 
-        args.MigrationLogFile ??= $"migration-log-{args.GithubOrg}-{args.GithubRepo}-{migrationId}.log";
+        var defaultFileName = args.MigrationId.HasValue()
+            ? $"migration-log-{repositoryName}-{migrationId}.log"
+            : $"migration-log-{args.GithubOrg}-{repositoryName}-{migrationId}.log";
+        args.MigrationLogFile ??= defaultFileName;
 
         if (FileExists(args.MigrationLogFile))
         {
@@ -76,9 +121,9 @@ public async Task Handle(DownloadLogsCommandArgs args)
             _log.LogWarning($"Overwriting {args.MigrationLogFile} due to --overwrite option.");
         }
 
-        _log.LogInformation($"Downloading log for repository {args.GithubRepo} to {args.MigrationLogFile}...");
+        _log.LogInformation($"Downloading log for repository {repositoryName} to {args.MigrationLogFile}...");
         await _httpDownloadService.DownloadToFile(logUrl, args.MigrationLogFile);
 
-        _log.LogSuccess($"Downloaded {args.GithubRepo} log to {args.MigrationLogFile}.");
+        _log.LogSuccess($"Downloaded {repositoryName} log to {args.MigrationLogFile}.");
     }
 }
diff --git a/src/Octoshift/Services/AdoApi.cs b/src/Octoshift/Services/AdoApi.cs
@@ -202,7 +202,10 @@ private async Task<string> GetTeamProjectGithubAppId(string org, string githubOr
         var url = $"{_adoBaseUrl}/{org.EscapeDataString()}/{teamProject.EscapeDataString()}/_apis/serviceendpoint/endpoints?api-version=6.0-preview.4";
         var response = await _client.GetWithPagingAsync(url);
 
-        var endpoint = response.FirstOrDefault(x => ((string)x["type"]).Equals("GitHub", StringComparison.OrdinalIgnoreCase) && ((string)x["name"]).Equals(githubOrg, StringComparison.OrdinalIgnoreCase));
+        var endpoint = response.FirstOrDefault(x =>
+            (((string)x["type"]).Equals("GitHub", StringComparison.OrdinalIgnoreCase) ||
+             ((string)x["type"]).Equals("GitHubProximaPipelines", StringComparison.OrdinalIgnoreCase)) &&
+            ((string)x["name"]).Equals(githubOrg, StringComparison.OrdinalIgnoreCase));
 
         return endpoint != null ? (string)endpoint["id"] : null;
     }
diff --git a/src/Octoshift/Services/FileSystemProvider.cs b/src/Octoshift/Services/FileSystemProvider.cs
@@ -9,6 +9,8 @@ public class FileSystemProvider
 {
     public virtual bool FileExists(string path) => File.Exists(path);
 
+    public virtual bool DirectoryExists(string path) => Directory.Exists(path);
+
     public virtual Task<byte[]> ReadAllBytesAsync(string path) => File.ReadAllBytesAsync(path);
 
     public virtual DirectoryInfo CreateDirectory(string path) => Directory.CreateDirectory(path);
diff --git a/src/OctoshiftCLI.Tests/Octoshift/Commands/DownloadLogs/DownloadLogsCommandHandlerTests.cs b/src/OctoshiftCLI.Tests/Octoshift/Commands/DownloadLogs/DownloadLogsCommandHandlerTests.cs
@@ -299,4 +299,126 @@ await FluentActions
         _mockGithubApi.Verify(m => m.GetMigrationLogUrl(githubOrg, repo), Times.Exactly(6));
         _mockHttpDownloadService.Verify(m => m.DownloadToFile(It.IsAny<string>(), It.IsAny<string>()), Times.Never());
     }
+
+    [Fact]
+    public async Task Should_Throw_When_Neither_MigrationId_Nor_OrgRepo_Provided()
+    {
+        // Act & Assert
+        var args = new DownloadLogsCommandArgs();
+        await FluentAssertions.FluentActions
+            .Invoking(async () => await _handler.Handle(args))
+            .Should().ThrowAsync<OctoshiftCliException>()
+            .WithMessage("Either --migration-id (GraphQL migration ID) or both --github-org and --github-repo must be specified.");
+    }
+
+    [Fact]
+    public async Task Should_Throw_When_Only_GithubOrg_Provided()
+    {
+        // Act & Assert
+        var args = new DownloadLogsCommandArgs
+        {
+            GithubOrg = "test-org"
+        };
+        await FluentAssertions.FluentActions
+            .Invoking(async () => await _handler.Handle(args))
+            .Should().ThrowAsync<OctoshiftCliException>()
+            .WithMessage("Either --migration-id (GraphQL migration ID) or both --github-org and --github-repo must be specified.");
+    }
+
+    [Fact]
+    public async Task Should_Throw_When_Only_GithubRepo_Provided()
+    {
+        // Act & Assert
+        var args = new DownloadLogsCommandArgs
+        {
+            GithubRepo = "test-repo"
+        };
+        await FluentAssertions.FluentActions
+            .Invoking(async () => await _handler.Handle(args))
+            .Should().ThrowAsync<OctoshiftCliException>()
+            .WithMessage("Either --migration-id (GraphQL migration ID) or both --github-org and --github-repo must be specified.");
+    }
+
+    [Fact]
+    public async Task Should_Log_Warning_When_MigrationId_And_OrgRepo_Both_Provided()
+    {
+        // Arrange
+        const string migrationId = "RM_test123";
+        const string githubOrg = "test-org";
+        const string githubRepo = "test-repo";
+        const string logUrl = "some-url";
+        const string repoName = "test-repo-name";
+
+        _mockGithubApi.Setup(m => m.GetMigration(migrationId))
+            .ReturnsAsync((State: "SUCCEEDED", RepositoryName: repoName, WarningsCount: 0, FailureReason: "", MigrationLogUrl: logUrl));
+        _mockHttpDownloadService.Setup(m => m.DownloadToFile(It.IsAny<string>(), It.IsAny<string>()));
+
+        // Act
+        var args = new DownloadLogsCommandArgs
+        {
+            MigrationId = migrationId,
+            GithubOrg = githubOrg,
+            GithubRepo = githubRepo
+        };
+        await _handler.Handle(args);
+
+        // Assert
+        _mockLogger.Verify(m => m.LogWarning("--github-org and --github-repo are ignored when --migration-id is specified."), Times.Once);
+        _mockGithubApi.Verify(m => m.GetMigration(migrationId), Times.Once);
+        _mockGithubApi.Verify(m => m.GetMigrationLogUrl(It.IsAny<string>(), It.IsAny<string>()), Times.Never);
+    }
+
+    [Fact]
+    public async Task Should_Succeed_When_Only_MigrationId_Provided()
+    {
+        // Arrange
+        const string migrationId = "RM_test123";
+        const string logUrl = "some-url";
+        const string repoName = "test-repo-name";
+        const string expectedFileName = $"migration-log-{repoName}-{migrationId}.log";
+
+        _mockGithubApi.Setup(m => m.GetMigration(migrationId))
+            .ReturnsAsync((State: "SUCCEEDED", RepositoryName: repoName, WarningsCount: 0, FailureReason: "", MigrationLogUrl: logUrl));
+        _mockHttpDownloadService.Setup(m => m.DownloadToFile(It.IsAny<string>(), It.IsAny<string>()));
+
+        // Act
+        var args = new DownloadLogsCommandArgs
+        {
+            MigrationId = migrationId
+        };
+        await _handler.Handle(args);
+
+        // Assert
+        _mockGithubApi.Verify(m => m.GetMigration(migrationId), Times.Once);
+        _mockHttpDownloadService.Verify(m => m.DownloadToFile(logUrl, expectedFileName), Times.Once);
+        _mockGithubApi.Verify(m => m.GetMigrationLogUrl(It.IsAny<string>(), It.IsAny<string>()), Times.Never);
+    }
+
+    [Fact]
+    public async Task Should_Succeed_When_Only_OrgRepo_Provided()
+    {
+        // Arrange
+        const string githubOrg = "test-org";
+        const string githubRepo = "test-repo";
+        const string logUrl = "some-url";
+        const string migrationId = "RM_test123";
+        const string expectedFileName = $"migration-log-{githubOrg}-{githubRepo}-{migrationId}.log";
+
+        _mockGithubApi.Setup(m => m.GetMigrationLogUrl(githubOrg, githubRepo))
+            .ReturnsAsync((logUrl, migrationId));
+        _mockHttpDownloadService.Setup(m => m.DownloadToFile(It.IsAny<string>(), It.IsAny<string>()));
+
+        // Act
+        var args = new DownloadLogsCommandArgs
+        {
+            GithubOrg = githubOrg,
+            GithubRepo = githubRepo
+        };
+        await _handler.Handle(args);
+
+        // Assert
+        _mockGithubApi.Verify(m => m.GetMigrationLogUrl(githubOrg, githubRepo), Times.Once);
+        _mockHttpDownloadService.Verify(m => m.DownloadToFile(logUrl, expectedFileName), Times.Once);
+        _mockGithubApi.Verify(m => m.GetMigration(It.IsAny<string>()), Times.Never);
+    }
 }
diff --git a/src/OctoshiftCLI.Tests/Octoshift/Services/AdoApiTests.cs b/src/OctoshiftCLI.Tests/Octoshift/Services/AdoApiTests.cs
@@ -251,6 +251,30 @@ public async Task GetGithubAppId_Should_Return_Null_When_No_Team_Projects_Have_E
         result.Should().BeNull();
     }
 
+    [Fact]
+    public async Task GetGithubAppId_Should_Recognize_GitHubProximaPipelines_Service_Connection()
+    {
+        var teamProjects = new List<string>() { ADO_TEAM_PROJECT };
+        var appId = Guid.NewGuid().ToString();
+
+        var json = new object[]
+        {
+            new
+            {
+                type = "GitHubProximaPipelines",
+                name = GITHUB_ORG,
+                id = appId
+            }
+        };
+        var response = JArray.Parse(json.ToJson());
+
+        _mockAdoClient.Setup(x => x.GetWithPagingAsync($"https://dev.azure.com/{ADO_ORG.EscapeDataString()}/{ADO_TEAM_PROJECT.EscapeDataString()}/_apis/serviceendpoint/endpoints?api-version=6.0-preview.4").Result).Returns(response);
+
+        var result = await sut.GetGithubAppId(ADO_ORG, GITHUB_ORG, teamProjects);
+
+        result.Should().Be(appId);
+    }
+
     [Fact]
     public async Task GetGithubHandle_Should_Return_Handle()
     {
diff --git a/src/OctoshiftCLI.Tests/ado2gh/Commands/DownloadLogs/DownloadLogsCommandTests.cs b/src/OctoshiftCLI.Tests/ado2gh/Commands/DownloadLogs/DownloadLogsCommandTests.cs
@@ -11,10 +11,11 @@ public void Should_Have_Options()
         var command = new DownloadLogsCommand();
         Assert.NotNull(command);
         Assert.Equal("download-logs", command.Name);
-        Assert.Equal(7, command.Options.Count);
+        Assert.Equal(8, command.Options.Count);
 
-        TestHelpers.VerifyCommandOption(command.Options, "github-org", true);
-        TestHelpers.VerifyCommandOption(command.Options, "github-repo", true);
+        TestHelpers.VerifyCommandOption(command.Options, "github-org", false);
+        TestHelpers.VerifyCommandOption(command.Options, "github-repo", false);
+        TestHelpers.VerifyCommandOption(command.Options, "migration-id", false);
         TestHelpers.VerifyCommandOption(command.Options, "github-api-url", false);
         TestHelpers.VerifyCommandOption(command.Options, "github-pat", false);
         TestHelpers.VerifyCommandOption(command.Options, "migration-log-file", false);
diff --git a/src/OctoshiftCLI.Tests/bbs2gh/Commands/DownloadLogs/DownloadLogsCommandTests.cs b/src/OctoshiftCLI.Tests/bbs2gh/Commands/DownloadLogs/DownloadLogsCommandTests.cs
@@ -11,10 +11,11 @@ public void Should_Have_Options()
         var command = new DownloadLogsCommand();
         Assert.NotNull(command);
         Assert.Equal("download-logs", command.Name);
-        Assert.Equal(7, command.Options.Count);
+        Assert.Equal(8, command.Options.Count);
 
-        TestHelpers.VerifyCommandOption(command.Options, "github-org", true);
-        TestHelpers.VerifyCommandOption(command.Options, "github-repo", true);
+        TestHelpers.VerifyCommandOption(command.Options, "github-org", false);
+        TestHelpers.VerifyCommandOption(command.Options, "github-repo", false);
+        TestHelpers.VerifyCommandOption(command.Options, "migration-id", false);
         TestHelpers.VerifyCommandOption(command.Options, "github-api-url", false);
         TestHelpers.VerifyCommandOption(command.Options, "github-pat", false);
         TestHelpers.VerifyCommandOption(command.Options, "migration-log-file", false);
diff --git a/src/OctoshiftCLI.Tests/bbs2gh/Commands/MigrateRepo/MigrateRepoCommandHandlerTests.cs b/src/OctoshiftCLI.Tests/bbs2gh/Commands/MigrateRepo/MigrateRepoCommandHandlerTests.cs
diff --git a/src/OctoshiftCLI.Tests/gei/Commands/DownloadLogs/DownloadLogsCommandTests.cs b/src/OctoshiftCLI.Tests/gei/Commands/DownloadLogs/DownloadLogsCommandTests.cs
diff --git a/src/bbs2gh/Commands/MigrateRepo/MigrateRepoCommandHandler.cs b/src/bbs2gh/Commands/MigrateRepo/MigrateRepoCommandHandler.cs
diff --git a/src/gei/Commands/DownloadLogs/DownloadLogsCommand.cs b/src/gei/Commands/DownloadLogs/DownloadLogsCommand.cs

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+- bbs2gh : Added validation for `--archive-path` and `--bbs-shared-home` options to fail fast with clear error messages if the provided paths do not exist or are not accessible. Archive path is now logged before upload operations to help with troubleshooting
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+- ado2gh: Added support for GitHub Enterprise cloud with data residency app service connections when using `--rewire-pipelines`. The tool now recognizes both `GitHub` and `GitHubProximaPipelines` service connection types.
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+- Added `--migration-id` option to `download-logs` command to allow downloading logs directly by migration ID without requiring org/repo lookup
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@ public class DownloadLogsCommandArgs : CommandArgs`
`5`	`5`	`{`
`6`	`6`	`public string GithubOrg { get; set; }`
`7`	`7`	`public string GithubRepo { get; set; }`
	`8`	`+ public string MigrationId { get; set; }`
`8`	`9`	`public string GithubApiUrl { get; set; }`
`9`	`10`	`[Secret]`
`10`	`11`	`public string GithubPat { get; set; }`