Merge branch 'main' into main

brianaj · web-flow · commit a0ae542fe6fc · 2025-12-04T10:59:54.000-08:00
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -22,7 +22,7 @@ jobs:
     runs-on: ${{ matrix.runner-os }}
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           persist-credentials: false
       - uses: extractions/setup-just@v3
@@ -35,7 +35,7 @@ jobs:
           config-file: ./.github/codeql/codeql-config.yml
 
       - name: Setup .NET
-        uses: actions/setup-dotnet@v4
+        uses: actions/setup-dotnet@v5
         with:
           global-json-file: global.json
 
@@ -52,12 +52,12 @@ jobs:
         run: just test-coverage
 
       - name: Copy Coverage To Predictable Location
-        if: always() && matrix.runner-os == 'ubuntu-latest'
+        if: always() && matrix.runner-os == 'ubuntu-latest' && matrix.language == 'csharp'
         run: cp coverage/**/coverage.cobertura.xml coverage/coverage.cobertura.xml
 
       - name: Code Coverage Summary Report
         uses: irongut/CodeCoverageSummary@v1.3.0
-        if: always() && matrix.runner-os == 'ubuntu-latest'
+        if: always() && matrix.runner-os == 'ubuntu-latest' && matrix.language == 'csharp'
         with:
           filename: coverage/coverage.cobertura.xml
           badge: true
@@ -66,15 +66,15 @@ jobs:
 
       # This is used by the subsequent publish-test-results.yml
       - name: Upload Unit Test Results
-        if: always() && matrix.runner-os == 'ubuntu-latest'
+        if: always() && matrix.runner-os == 'ubuntu-latest' && matrix.language == 'csharp'
         uses: actions/upload-artifact@v4
         with:
           name: Unit Test Results
           path: src/OctoshiftCLI.Tests/unit-tests.xml
 
       # This is used by the subsequent publish-test-results.yml
       - name: Upload Code Coverage Report
-        if: always() && matrix.runner-os == 'ubuntu-latest'
+        if: always() && matrix.runner-os == 'ubuntu-latest' && matrix.language == 'csharp'
         uses: actions/upload-artifact@v4
         with:
           name: Code Coverage Report
@@ -102,13 +102,13 @@ jobs:
         target-os: [windows-latest, ubuntu-latest, macos-latest]
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           persist-credentials: false
       - uses: extractions/setup-just@v3
 
       - name: Setup .NET
-        uses: actions/setup-dotnet@v4
+        uses: actions/setup-dotnet@v5
         with:
           global-json-file: global.json
 
@@ -150,12 +150,12 @@ jobs:
     runs-on: ${{ matrix.runner-os }}
     concurrency: integration-test-${{ matrix.source-vcs }}-${{ matrix.runner-os }}
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           persist-credentials: false
 
       - name: Setup .NET
-        uses: actions/setup-dotnet@v4
+        uses: actions/setup-dotnet@v5
         with:
           global-json-file: global.json
 
@@ -282,9 +282,8 @@ jobs:
     environment: PUBLISH_RELEASE
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
-          persist-credentials: false
           token: ${{ secrets.RELEASE_NOTES_PAT }}
           fetch-depth: 0
 
@@ -304,7 +303,7 @@ jobs:
           }
 
       - name: Setup .NET
-        uses: actions/setup-dotnet@v4
+        uses: actions/setup-dotnet@v5
         with:
           global-json-file: global.json
 
@@ -366,7 +365,7 @@ jobs:
           $TAG_NAME | Out-File ./LATEST-VERSION.txt
 
       - name: Commit Release Notes and Version
-        uses: stefanzweifel/git-auto-commit-action@v5
+        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/copilot-setup-steps.yml b/.github/workflows/copilot-setup-steps.yml
@@ -18,7 +18,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Setup .NET
         uses: actions/setup-dotnet@v2
diff --git a/.github/workflows/integration-tests.yml b/.github/workflows/integration-tests.yml
@@ -23,7 +23,7 @@ jobs:
         target-os: [windows-latest, ubuntu-latest, macos-latest]
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
       with:
         ref: 'refs/pull/${{ github.event.inputs.pr_number }}/merge'
         fetch-depth: 0
@@ -95,7 +95,7 @@ jobs:
     runs-on: ${{ matrix.runner-os }}
     concurrency: integration-test-${{ matrix.source-vcs }}-${{ matrix.runner-os }}
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
       with:
         ref: 'refs/pull/${{ github.event.inputs.pr_number }}/merge'
         fetch-depth: 0
diff --git a/RELEASENOTES.md b/RELEASENOTES.md
@@ -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
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/bbs2gh/Commands/MigrateRepo/MigrateRepoCommandHandlerTests.cs b/src/OctoshiftCLI.Tests/bbs2gh/Commands/MigrateRepo/MigrateRepoCommandHandlerTests.cs
@@ -71,6 +71,10 @@ public MigrateRepoCommandHandlerTests()
                 _mockFileSystemProvider.Object,
                 _warningsCountLogger
             );
+
+            // Default setup for file system operations
+            _mockFileSystemProvider.Setup(m => m.FileExists(It.IsAny<string>())).Returns(true);
+            _mockFileSystemProvider.Setup(m => m.DirectoryExists(It.IsAny<string>())).Returns(true);
         }
 
         [Fact]
@@ -960,5 +964,116 @@ public async Task Sets_Target_Repo_Visibility()
                 targetRepoVisibility
             ));
         }
+
+        [Fact]
+        public async Task It_Throws_When_Archive_Path_Does_Not_Exist()
+        {
+            const string nonExistentArchivePath = "/path/to/nonexistent/archive.tar";
+            _mockFileSystemProvider.Setup(m => m.FileExists(nonExistentArchivePath)).Returns(false);
+
+            await _handler.Invoking(async x => await x.Handle(new MigrateRepoCommandArgs
+            {
+                ArchivePath = nonExistentArchivePath,
+                GithubOrg = GITHUB_ORG,
+                GithubRepo = GITHUB_REPO,
+                AzureStorageConnectionString = AZURE_STORAGE_CONNECTION_STRING
+            }))
+                .Should()
+                .ThrowAsync<OctoshiftCliException>()
+                .WithMessage($"*--archive-path*{nonExistentArchivePath}*");
+        }
+
+        [Fact]
+        public async Task It_Throws_When_Bbs_Shared_Home_Does_Not_Exist_When_Running_On_Bitbucket_Instance()
+        {
+            const string nonExistentBbsSharedHome = "/nonexistent/shared/home";
+            _mockBbsApi.Setup(x => x.StartExport(BBS_PROJECT, BBS_REPO)).ReturnsAsync(BBS_EXPORT_ID);
+            _mockBbsApi.Setup(x => x.GetExport(BBS_EXPORT_ID)).ReturnsAsync(("COMPLETED", "The export is complete", 100));
+            _mockFileSystemProvider.Setup(m => m.DirectoryExists(nonExistentBbsSharedHome)).Returns(false);
+
+            await _handler.Invoking(async x => await x.Handle(new MigrateRepoCommandArgs
+            {
+                BbsServerUrl = BBS_SERVER_URL,
+                BbsUsername = BBS_USERNAME,
+                BbsPassword = BBS_PASSWORD,
+                BbsProject = BBS_PROJECT,
+                BbsRepo = BBS_REPO,
+                BbsSharedHome = nonExistentBbsSharedHome
+            }))
+                .Should()
+                .ThrowAsync<OctoshiftCliException>()
+                .WithMessage($"*--bbs-shared-home*{nonExistentBbsSharedHome}*");
+        }
+
+        [Fact]
+        public async Task It_Does_Not_Validate_Bbs_Shared_Home_When_Using_Ssh()
+        {
+            const string nonExistentBbsSharedHome = "/nonexistent/shared/home";
+            _mockBbsApi.Setup(x => x.StartExport(BBS_PROJECT, BBS_REPO)).ReturnsAsync(BBS_EXPORT_ID);
+            _mockBbsApi.Setup(x => x.GetExport(BBS_EXPORT_ID)).ReturnsAsync(("COMPLETED", "The export is complete", 100));
+            _mockBbsArchiveDownloader.Setup(x => x.Download(BBS_EXPORT_ID, It.IsAny<string>())).ReturnsAsync(ARCHIVE_PATH);
+            _mockFileSystemProvider.Setup(m => m.DirectoryExists(nonExistentBbsSharedHome)).Returns(false);
+
+            var args = new MigrateRepoCommandArgs
+            {
+                BbsServerUrl = BBS_SERVER_URL,
+                BbsUsername = BBS_USERNAME,
+                BbsPassword = BBS_PASSWORD,
+                BbsProject = BBS_PROJECT,
+                BbsRepo = BBS_REPO,
+                BbsSharedHome = nonExistentBbsSharedHome,
+                SshUser = SSH_USER,
+                SshPrivateKey = PRIVATE_KEY
+            };
+
+            await _handler.Invoking(x => x.Handle(args))
+                .Should()
+                .NotThrowAsync();
+        }
+
+        [Fact]
+        public async Task It_Does_Not_Validate_Bbs_Shared_Home_When_Using_Smb()
+        {
+            const string nonExistentBbsSharedHome = "/nonexistent/shared/home";
+            _mockBbsApi.Setup(x => x.StartExport(BBS_PROJECT, BBS_REPO)).ReturnsAsync(BBS_EXPORT_ID);
+            _mockBbsApi.Setup(x => x.GetExport(BBS_EXPORT_ID)).ReturnsAsync(("COMPLETED", "The export is complete", 100));
+            _mockBbsArchiveDownloader.Setup(x => x.Download(BBS_EXPORT_ID, It.IsAny<string>())).ReturnsAsync(ARCHIVE_PATH);
+            _mockFileSystemProvider.Setup(m => m.DirectoryExists(nonExistentBbsSharedHome)).Returns(false);
+            _mockEnvironmentVariableProvider.Setup(m => m.SmbPassword(It.IsAny<bool>())).Returns(SMB_PASSWORD);
+
+            var args = new MigrateRepoCommandArgs
+            {
+                BbsServerUrl = BBS_SERVER_URL,
+                BbsUsername = BBS_USERNAME,
+                BbsPassword = BBS_PASSWORD,
+                BbsProject = BBS_PROJECT,
+                BbsRepo = BBS_REPO,
+                BbsSharedHome = nonExistentBbsSharedHome,
+                SmbUser = SMB_USER
+            };
+
+            await _handler.Invoking(x => x.Handle(args))
+                .Should()
+                .NotThrowAsync();
+        }
+
+        [Fact]
+        public async Task It_Logs_Archive_Path_Before_Upload()
+        {
+            _mockFileSystemProvider.Setup(m => m.FileExists(ARCHIVE_PATH)).Returns(true);
+            _mockAzureApi.Setup(x => x.UploadToBlob(It.IsAny<string>(), It.IsAny<FileStream>())).ReturnsAsync(new Uri(ARCHIVE_URL));
+
+            var args = new MigrateRepoCommandArgs
+            {
+                ArchivePath = ARCHIVE_PATH,
+                AzureStorageConnectionString = AZURE_STORAGE_CONNECTION_STRING,
+                GithubOrg = GITHUB_ORG,
+                GithubRepo = GITHUB_REPO,
+                QueueOnly = true,
+            };
+
+            await _handler.Handle(args);
+            _mockOctoLogger.Verify(m => m.LogInformation($"Archive path: {ARCHIVE_PATH}"), Times.Once);
+        }
     }
 }
diff --git a/src/bbs2gh/Commands/MigrateRepo/MigrateRepoCommandHandler.cs b/src/bbs2gh/Commands/MigrateRepo/MigrateRepoCommandHandler.cs
@@ -91,6 +91,8 @@ public async Task Handle(MigrateRepoCommandArgs args)
                 args.ArchivePath = GetSourceExportArchiveAbsolutePath(args.BbsSharedHome, exportId);
             }
 
+            _log.LogInformation($"Archive path: {args.ArchivePath}");
+
             try
             {
                 if (args.UseGithubStorage)
@@ -339,6 +341,18 @@ private void ValidateOptions(MigrateRepoCommandArgs args)
             {
                 throw new OctoshiftCliException("Both --smb-user and --smb-password (or SMB_PASSWORD env. variable) must be specified for SMB download.");
             }
+
+            // Validate --bbs-shared-home if running on Bitbucket instance (not using SSH/SMB)
+            if (!args.ShouldDownloadArchive() && args.BbsSharedHome.HasValue() && !_fileSystemProvider.DirectoryExists(args.BbsSharedHome))
+            {
+                throw new OctoshiftCliException($"The path provided for --bbs-shared-home does not exist or is not accessible: {args.BbsSharedHome}");
+            }
+        }
+
+        // Validate --archive-path if provided
+        if (args.ArchivePath.HasValue() && !_fileSystemProvider.FileExists(args.ArchivePath))
+        {
+            throw new OctoshiftCliException($"The archive file provided with --archive-path does not exist or is not accessible: {args.ArchivePath}");
         }
 
         if (args.ShouldUploadArchive())

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`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
`@@ -9,6 +9,8 @@ public class FileSystemProvider`
`9`	`9`	`{`
`10`	`10`	`public virtual bool FileExists(string path) => File.Exists(path);`
`11`	`11`
	`12`	`+ public virtual bool DirectoryExists(string path) => Directory.Exists(path);`
	`13`	`+`
`12`	`14`	`public virtual Task<byte[]> ReadAllBytesAsync(string path) => File.ReadAllBytesAsync(path);`
`13`	`15`
`14`	`16`	`public virtual DirectoryInfo CreateDirectory(string path) => Directory.CreateDirectory(path);`
Original file line number	Diff line number	Diff line change
`@@ -91,6 +91,8 @@ public async Task Handle(MigrateRepoCommandArgs args)`
`91`	`91`	`args.ArchivePath = GetSourceExportArchiveAbsolutePath(args.BbsSharedHome, exportId);`
`92`	`92`	`}`
`93`	`93`
	`94`	`+ _log.LogInformation($"Archive path: {args.ArchivePath}");`
	`95`	`+`
`94`	`96`	`try`
`95`	`97`	`{`
`96`	`98`	`if (args.UseGithubStorage)`
`@@ -339,6 +341,18 @@ private void ValidateOptions(MigrateRepoCommandArgs args)`
`339`	`341`	`{`
`340`	`342`	`throw new OctoshiftCliException("Both --smb-user and --smb-password (or SMB_PASSWORD env. variable) must be specified for SMB download.");`
`341`	`343`	`}`
	`344`	`+`
	`345`	`+ // Validate --bbs-shared-home if running on Bitbucket instance (not using SSH/SMB)`
	`346`	`+ if (!args.ShouldDownloadArchive() && args.BbsSharedHome.HasValue() && !_fileSystemProvider.DirectoryExists(args.BbsSharedHome))`
	`347`	`+ {`
	`348`	`+ throw new OctoshiftCliException($"The path provided for --bbs-shared-home does not exist or is not accessible: {args.BbsSharedHome}");`
	`349`	`+ }`
	`350`	`+ }`
	`351`	`+`
	`352`	`+ // Validate --archive-path if provided`
	`353`	`+ if (args.ArchivePath.HasValue() && !_fileSystemProvider.FileExists(args.ArchivePath))`
	`354`	`+ {`
	`355`	`+ throw new OctoshiftCliException($"The archive file provided with --archive-path does not exist or is not accessible: {args.ArchivePath}");`
`342`	`356`	`}`
`343`	`357`
`344`	`358`	`if (args.ShouldUploadArchive())`