Merge pull request #1485 from github/brianaj/external-pr-1464

Add URL validation for organization, repository, and enterprise arguments

Author: brianaj

RELEASENOTES.md

@@ -1 +1,2 @@
+- Added validation to detect and return clear error messages when a URL is provided instead of a name for organization, repository, or enterprise arguments (e.g., `--github-org`, `--github-target-org`, `--source-repo`, `--github-target-enterprise`)
 - Added `--target-api-url` as an optional arg to the `add-team-to-repo` command

src/Octoshift/Commands/CreateTeam/CreateTeamCommandArgs.cs

@@ -1,4 +1,7 @@
-namespace OctoshiftCLI.Commands.CreateTeam;
+using OctoshiftCLI.Extensions;
+using OctoshiftCLI.Services;
+
+namespace OctoshiftCLI.Commands.CreateTeam;
 
 public class CreateTeamCommandArgs : CommandArgs
 {
@@ -8,4 +11,12 @@ public class CreateTeamCommandArgs : CommandArgs
     [Secret]
     public string GithubPat { get; set; }
     public string TargetApiUrl { get; set; }
+
+    public override void Validate(OctoLogger log)
+    {
+        if (GithubOrg.IsUrl())
+        {
+            throw new OctoshiftCliException($"The --github-org option expects an organization name, not a URL. Please provide just the organization name (e.g., 'my-org' instead of 'https://github.com/my-org').");
+        }
+    }
 }

src/Octoshift/Commands/DownloadLogs/DownloadLogsCommandArgs.cs

@@ -1,4 +1,6 @@
-
+using OctoshiftCLI.Extensions;
+using OctoshiftCLI.Services;
+
 namespace OctoshiftCLI.Commands.DownloadLogs;
 
 public class DownloadLogsCommandArgs : CommandArgs
@@ -11,4 +13,17 @@ public class DownloadLogsCommandArgs : CommandArgs
     public string GithubPat { get; set; }
     public string MigrationLogFile { get; set; }
     public bool Overwrite { get; set; }
+
+    public override void Validate(OctoLogger log)
+    {
+        if (GithubOrg.IsUrl())
+        {
+            throw new OctoshiftCliException("The --github-org option expects an organization name, not a URL. Please provide just the organization name (e.g., 'my-org' instead of 'https://github.com/my-org').");
+        }
+
+        if (GithubRepo.IsUrl())
+        {
+            throw new OctoshiftCliException("The --github-repo option expects a repository name, not a URL. Please provide just the repository name (e.g., 'my-repo' instead of 'https://github.com/my-org/my-repo').");
+        }
+    }
 }

src/Octoshift/Commands/GenerateMannequinCsv/GenerateMannequinCsvCommandArgs.cs

@@ -1,4 +1,6 @@
 using System.IO;
+using OctoshiftCLI.Extensions;
+using OctoshiftCLI.Services;
 
 namespace OctoshiftCLI.Commands.GenerateMannequinCsv;
 
@@ -10,4 +12,12 @@ public class GenerateMannequinCsvCommandArgs : CommandArgs
     [Secret]
     public string GithubPat { get; set; }
     public string TargetApiUrl { get; set; }
+
+    public override void Validate(OctoLogger log)
+    {
+        if (GithubOrg.IsUrl())
+        {
+            throw new OctoshiftCliException("The --github-org option expects an organization name, not a URL. Please provide just the organization name (e.g., 'my-org' instead of 'https://github.com/my-org').");
+        }
+    }
 }

src/Octoshift/Commands/GrantMigratorRole/GrantMigratorRoleCommandArgs.cs

@@ -15,6 +15,11 @@ public class GrantMigratorRoleCommandArgs : CommandArgs
 
     public override void Validate(OctoLogger log)
     {
+        if (GithubOrg.IsUrl())
+        {
+            throw new OctoshiftCliException($"The --github-org option expects an organization name, not a URL. Please provide just the organization name (e.g., 'my-org' instead of 'https://github.com/my-org').");
+        }
+
         ActorType = ActorType?.ToUpper();
 
         if (ActorType is "TEAM" or "USER")

src/Octoshift/Commands/ReclaimMannequin/ReclaimMannequinCommandArgs.cs

@@ -1,4 +1,5 @@
-using OctoshiftCLI.Services;
+using OctoshiftCLI.Extensions;
+using OctoshiftCLI.Services;
 
 namespace OctoshiftCLI.Commands.ReclaimMannequin;
 
@@ -17,6 +18,11 @@ public class ReclaimMannequinCommandArgs : CommandArgs
     public string TargetApiUrl { get; set; }
     public override void Validate(OctoLogger log)
     {
+        if (GithubOrg.IsUrl())
+        {
+            throw new OctoshiftCliException("The --github-org option expects an organization name, not a URL. Please provide just the organization name (e.g., 'my-org' instead of 'https://github.com/my-org').");
+        }
+
         if (string.IsNullOrEmpty(Csv) && (string.IsNullOrEmpty(MannequinUser) || string.IsNullOrEmpty(TargetUser)))
         {
             throw new OctoshiftCliException($"Either --csv or --mannequin-user and --target-user must be specified");

src/Octoshift/Commands/RevokeMigratorRole/RevokeMigratorRoleCommandArgs.cs

@@ -15,6 +15,11 @@ public class RevokeMigratorRoleCommandArgs : CommandArgs
 
     public override void Validate(OctoLogger log)
     {
+        if (GithubOrg.IsUrl())
+        {
+            throw new OctoshiftCliException($"The --github-org option expects an organization name, not a URL. Please provide just the organization name (e.g., 'my-org' instead of 'https://github.com/my-org').");
+        }
+
         ActorType = ActorType?.ToUpper();
 
         if (ActorType is "TEAM" or "USER")

src/Octoshift/Extensions/StringExtensions.cs

@@ -26,5 +26,12 @@ public static class StringExtensions
         public static string EscapeDataString(this string value) => Uri.EscapeDataString(value);
 
         public static byte[] ToBytes(this string s) => Encoding.UTF8.GetBytes(s);
+
+        public static bool IsUrl(this string s)
+        {
+            return !s.IsNullOrWhiteSpace()
+                && Uri.TryCreate(s, UriKind.Absolute, out var uri)
+                && (uri.Scheme == Uri.UriSchemeHttp || uri.Scheme == Uri.UriSchemeHttps);
+        }
     }
 }

src/OctoshiftCLI.Tests/Octoshift/Commands/CreateTeam/CreateTeamCommandArgsTests.cs

@@ -0,0 +1,44 @@
+using FluentAssertions;
+using Moq;
+using OctoshiftCLI.Commands.CreateTeam;
+using OctoshiftCLI.Services;
+using Xunit;
+
+namespace OctoshiftCLI.Tests.Octoshift.Commands.CreateTeam;
+
+public class CreateTeamCommandArgsTests
+{
+    private readonly Mock<OctoLogger> _mockOctoLogger = TestHelpers.CreateMock<OctoLogger>();
+
+    private const string GITHUB_ORG = "foo-org";
+    private const string TEAM_NAME = "my-team";
+
+    [Fact]
+    public void Validate_Throws_When_GithubOrg_Is_Url()
+    {
+        var args = new CreateTeamCommandArgs
+        {
+            GithubOrg = "http://github.com/my-org",
+            TeamName = TEAM_NAME
+        };
+
+        FluentActions.Invoking(() => args.Validate(_mockOctoLogger.Object))
+            .Should()
+            .ThrowExactly<OctoshiftCliException>()
+            .WithMessage("The --github-org option expects an organization name, not a URL. Please provide just the organization name (e.g., 'my-org' instead of 'https://github.com/my-org').");
+    }
+
+    [Fact]
+    public void Validate_Succeeds_With_Valid_Name()
+    {
+        var args = new CreateTeamCommandArgs
+        {
+            GithubOrg = GITHUB_ORG,
+            TeamName = TEAM_NAME
+        };
+
+        args.Validate(_mockOctoLogger.Object);
+
+        args.GithubOrg.Should().Be(GITHUB_ORG);
+    }
+}

src/OctoshiftCLI.Tests/Octoshift/Commands/DownloadLogs/DownloadLogsCommandArgsTests.cs

@@ -0,0 +1,60 @@
+using FluentAssertions;
+using Moq;
+using OctoshiftCLI.Commands.DownloadLogs;
+using OctoshiftCLI.Services;
+using Xunit;
+
+namespace OctoshiftCLI.Tests.Octoshift.Commands.DownloadLogs;
+
+public class DownloadLogsCommandArgsTests
+{
+    private readonly Mock<OctoLogger> _mockOctoLogger = TestHelpers.CreateMock<OctoLogger>();
+
+    private const string GITHUB_ORG = "foo-org";
+    private const string GITHUB_REPO = "foo-repo";
+
+    [Fact]
+    public void Validate_Throws_When_GithubOrg_Is_Url()
+    {
+        var args = new DownloadLogsCommandArgs
+        {
+            GithubOrg = "https://github.com/my-org",
+            GithubRepo = GITHUB_REPO
+        };
+
+        FluentActions.Invoking(() => args.Validate(_mockOctoLogger.Object))
+            .Should()
+            .ThrowExactly<OctoshiftCliException>()
+            .WithMessage("The --github-org option expects an organization name, not a URL. Please provide just the organization name (e.g., 'my-org' instead of 'https://github.com/my-org').");
+    }
+
+    [Fact]
+    public void Validate_Throws_When_GithubRepo_Is_Url()
+    {
+        var args = new DownloadLogsCommandArgs
+        {
+            GithubOrg = GITHUB_ORG,
+            GithubRepo = "http://github.com/org/repo"
+        };
+
+        FluentActions.Invoking(() => args.Validate(_mockOctoLogger.Object))
+            .Should()
+            .ThrowExactly<OctoshiftCliException>()
+            .WithMessage("The --github-repo option expects a repository name, not a URL. Please provide just the repository name (e.g., 'my-repo' instead of 'https://github.com/my-org/my-repo').");
+    }
+
+    [Fact]
+    public void Validate_Succeeds_With_Valid_Names()
+    {
+        var args = new DownloadLogsCommandArgs
+        {
+            GithubOrg = GITHUB_ORG,
+            GithubRepo = GITHUB_REPO
+        };
+
+        args.Validate(_mockOctoLogger.Object);
+
+        args.GithubOrg.Should().Be(GITHUB_ORG);
+        args.GithubRepo.Should().Be(GITHUB_REPO);
+    }
+}