Add a recursive parameter to the add-files command

Kronicaler · Kronicaler · commit 0daf78350ad1 · 2023-07-21T12:24:16.000+02:00
Add a recursive parameter to the dotnet-grpc add-files CLI command.
The new parameter will add files in the requested folder recursively.
A unit test which verifies the functionality has been added.
diff --git a/src/dotnet-grpc/Commands/AddFileCommand.cs b/src/dotnet-grpc/Commands/AddFileCommand.cs
@@ -1,4 +1,4 @@
-﻿#region Copyright notice and license
+#region Copyright notice and license
 
 // Copyright 2019 The gRPC Authors
 //
@@ -41,6 +41,7 @@ public static Command Create(HttpClient httpClient)
         var serviceOption = CommonOptions.ServiceOption();
         var additionalImportDirsOption = CommonOptions.AdditionalImportDirsOption();
         var accessOption = CommonOptions.AccessOption();
+        var recursiveOption = CommonOptions.RecursiveOption();
         var filesArgument = new Argument<string[]>
         {
             Name = "files",
@@ -52,6 +53,7 @@ public static Command Create(HttpClient httpClient)
         command.AddOption(serviceOption);
         command.AddOption(accessOption);
         command.AddOption(additionalImportDirsOption);
+        command.AddOption(recursiveOption);
         command.AddArgument(filesArgument);
 
         command.SetHandler(
@@ -61,12 +63,13 @@ public static Command Create(HttpClient httpClient)
                 var services = context.ParseResult.GetValueForOption(serviceOption);
                 var access = context.ParseResult.GetValueForOption(accessOption);
                 var additionalImportDirs = context.ParseResult.GetValueForOption(additionalImportDirsOption);
+                var searchOption = context.ParseResult.GetValueForOption(recursiveOption) ? SearchOption.TopDirectoryOnly : SearchOption.TopDirectoryOnly;
                 var files = context.ParseResult.GetValueForArgument(filesArgument);
 
                 try
                 {
                     var command = new AddFileCommand(context.Console, project, httpClient);
-                    await command.AddFileAsync(services, access, additionalImportDirs, files);
+                    await command.AddFileAsync(services, access, additionalImportDirs, files, searchOption);
 
                     context.ExitCode = 0;
                 }
@@ -81,11 +84,11 @@ public static Command Create(HttpClient httpClient)
         return command;
     }
 
-    public async Task AddFileAsync(Services services, Access access, string? additionalImportDirs, string[] files)
+    public async Task AddFileAsync(Services services, Access access, string? additionalImportDirs, string[] files, SearchOption searchOption)
     {
         var resolvedServices = ResolveServices(services);
         await EnsureNugetPackagesAsync(resolvedServices);
-        files = GlobReferences(files);
+        files = GlobReferences(files, searchOption);
 
         foreach (var file in files)
         {
diff --git a/src/dotnet-grpc/Commands/CommandBase.cs b/src/dotnet-grpc/Commands/CommandBase.cs
@@ -1,4 +1,4 @@
-﻿#region Copyright notice and license
+#region Copyright notice and license
 
 // Copyright 2019 The gRPC Authors
 //
@@ -174,7 +174,7 @@ public void AddProtobufReference(Services services, string? additionalImportDirs
         }
 
         var normalizedFile = NormalizePath(file);
-        
+
         var normalizedAdditionalImportDirs = string.Empty;
 
         if (!string.IsNullOrWhiteSpace(additionalImportDirs))
@@ -298,7 +298,7 @@ public IEnumerable<ProjectItem> ResolveReferences(string[] references)
         return resolvedReferences;
     }
 
-    internal string[] GlobReferences(string[] references)
+    internal string[] GlobReferences(string[] references, SearchOption searchOption = SearchOption.TopDirectoryOnly)
     {
         var expandedReferences = new List<string>();
 
@@ -315,7 +315,7 @@ internal string[] GlobReferences(string[] references)
                 var directoryToSearch = Path.GetPathRoot(reference)!;
                 var searchPattern = reference.Substring(directoryToSearch.Length);
 
-                var resolvedFiles = Directory.GetFiles(directoryToSearch, searchPattern);
+                var resolvedFiles = Directory.GetFiles(directoryToSearch, searchPattern, searchOption);
 
                 if (resolvedFiles.Length == 0)
                 {
@@ -328,7 +328,7 @@ internal string[] GlobReferences(string[] references)
 
             if (Directory.Exists(Path.Combine(Project.DirectoryPath, Path.GetDirectoryName(reference)!)))
             {
-                var resolvedFiles = Directory.GetFiles(Project.DirectoryPath, reference);
+                var resolvedFiles = Directory.GetFiles(Project.DirectoryPath, reference, searchOption);
 
                 if (resolvedFiles.Length == 0)
                 {
diff --git a/src/dotnet-grpc/Options/CommonOptions.cs b/src/dotnet-grpc/Options/CommonOptions.cs
@@ -1,4 +1,4 @@
-﻿#region Copyright notice and license
+#region Copyright notice and license
 
 // Copyright 2019 The gRPC Authors
 //
@@ -54,4 +54,13 @@ public static Option<string> AdditionalImportDirsOption()
             description: CoreStrings.AdditionalImportDirsOption);
         return o;
     }
+
+    public static Option<bool> RecursiveOption()
+    {
+        var o = new Option<bool>(
+            aliases: new[] { "-r", "--recursive" },
+            description: CoreStrings.RecursiveOptionDescription
+            );
+        return o;
+    }
 }
diff --git a/src/dotnet-grpc/Properties/CoreStrings.Designer.cs b/src/dotnet-grpc/Properties/CoreStrings.Designer.cs
diff --git a/src/dotnet-grpc/Properties/CoreStrings.resx b/src/dotnet-grpc/Properties/CoreStrings.resx
@@ -231,4 +231,7 @@
   <data name="LogNoReferences" xml:space="preserve">
     <value>No protobuf references in the gRPC project.</value>
   </data>
+  <data name="RecursiveOptionDescription" xml:space="preserve">
+    <value>Whether to add the protobuf file references recursively. Default value is false.</value>
+  </data>
 </root>
diff --git a/test/dotnet-grpc.Tests/AddFileCommandTests.cs b/test/dotnet-grpc.Tests/AddFileCommandTests.cs
@@ -1,4 +1,4 @@
-﻿#region Copyright notice and license
+#region Copyright notice and license
 
 // Copyright 2019 The gRPC Authors
 //
@@ -81,19 +81,56 @@ public async Task AddFileCommand_AddsPackagesAndReferences()
         // Act
         Directory.SetCurrentDirectory(tempDir);
         var command = new AddFileCommand(new TestConsole(), projectPath: null, CreateClient());
-        await command.AddFileAsync(Services.Server, Access.Internal, "ImportDir", new[] { Path.Combine("Proto", "*.proto") });
+        await command.AddFileAsync(Services.Server, Access.Internal, "ImportDir", new[] { Path.Combine("Proto", "*.proto") }, SearchOption.TopDirectoryOnly);
         command.Project.ReevaluateIfNecessary();
 
         // Assert
         var packageRefs = command.Project.GetItems(CommandBase.PackageReferenceElement);
         Assert.AreEqual(1, packageRefs.Count);
         Assert.NotNull(packageRefs.SingleOrDefault(r => r.UnevaluatedInclude == "Grpc.AspNetCore" && !r.HasMetadata(CommandBase.PrivateAssetsElement)));
 
-
         var protoRefs = command.Project.GetItems(CommandBase.ProtobufElement);
         Assert.AreEqual(2, protoRefs.Count);
         Assert.NotNull(protoRefs.SingleOrDefault(r => r.UnevaluatedInclude == "Proto\\a.proto"));
         Assert.NotNull(protoRefs.SingleOrDefault(r => r.UnevaluatedInclude == "Proto\\b.proto"));
+        Assert.Null(protoRefs.SingleOrDefault(r => r.UnevaluatedInclude == "Proto\\Subfolder\\c.proto"));
+        foreach (var protoRef in protoRefs)
+        {
+            Assert.AreEqual("Server", protoRef.GetMetadataValue(CommandBase.GrpcServicesElement));
+            Assert.AreEqual("ImportDir", protoRef.GetMetadataValue(CommandBase.AdditionalImportDirsElement));
+            Assert.AreEqual("Internal", protoRef.GetMetadataValue(CommandBase.AccessElement));
+        }
+
+        // Cleanup
+        Directory.SetCurrentDirectory(currentDir);
+        Directory.Delete(tempDir, true);
+    }
+
+    [Test]
+    [NonParallelizable]
+    public async Task AddFileCommand_AddsPackagesAndReferencesRecursively()
+    {
+        // Arrange
+        var currentDir = Directory.GetCurrentDirectory();
+        var tempDir = Path.Combine(Path.GetTempPath(), Guid.NewGuid().ToString());
+        new DirectoryInfo(Path.Combine(currentDir, "TestAssets", "EmptyProject")).CopyTo(tempDir);
+
+        // Act
+        Directory.SetCurrentDirectory(tempDir);
+        var command = new AddFileCommand(new TestConsole(), projectPath: null, CreateClient());
+        await command.AddFileAsync(Services.Server, Access.Internal, "ImportDir", new[] { Path.Combine("Proto", "*.proto") }, SearchOption.AllDirectories);
+        command.Project.ReevaluateIfNecessary();
+
+        // Assert
+        var packageRefs = command.Project.GetItems(CommandBase.PackageReferenceElement);
+        Assert.AreEqual(1, packageRefs.Count);
+        Assert.NotNull(packageRefs.SingleOrDefault(r => r.UnevaluatedInclude == "Grpc.AspNetCore" && !r.HasMetadata(CommandBase.PrivateAssetsElement)));
+
+        var protoRefs = command.Project.GetItems(CommandBase.ProtobufElement);
+        Assert.AreEqual(3, protoRefs.Count);
+        Assert.NotNull(protoRefs.SingleOrDefault(r => r.UnevaluatedInclude == "Proto\\a.proto"));
+        Assert.NotNull(protoRefs.SingleOrDefault(r => r.UnevaluatedInclude == "Proto\\b.proto"));
+        Assert.NotNull(protoRefs.SingleOrDefault(r => r.UnevaluatedInclude == "Proto\\Subfolder\\c.proto"));
         foreach (var protoRef in protoRefs)
         {
             Assert.AreEqual("Server", protoRef.GetMetadataValue(CommandBase.GrpcServicesElement));
diff --git a/test/dotnet-grpc.Tests/TestAssets/EmptyProject/Proto/Subfolder/c.proto b/test/dotnet-grpc.Tests/TestAssets/EmptyProject/Proto/Subfolder/c.proto
diff --git a/test/dotnet-grpc.Tests/dotnet-grpc.Tests.csproj b/test/dotnet-grpc.Tests/dotnet-grpc.Tests.csproj
@@ -59,5 +59,8 @@
     </AssemblyAttribute>
 
   </ItemGroup>
+  <ItemGroup>
+    <Folder Include="TestAssets\EmptyProject\Proto\Subfolder\" />
+  </ItemGroup>
 
 </Project>

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-#region Copyright notice and license`
	`1`	`+#region Copyright notice and license`
`2`	`2`
`3`	`3`	`// Copyright 2019 The gRPC Authors`
`4`	`4`	`//`
`@@ -174,7 +174,7 @@ public void AddProtobufReference(Services services, string? additionalImportDirs`
`174`	`174`	`}`
`175`	`175`
`176`	`176`	`var normalizedFile = NormalizePath(file);`
`177`		`-`
	`177`	`+`
`178`	`178`	`var normalizedAdditionalImportDirs = string.Empty;`
`179`	`179`
`180`	`180`	`if (!string.IsNullOrWhiteSpace(additionalImportDirs))`
`@@ -298,7 +298,7 @@ public IEnumerable<ProjectItem> ResolveReferences(string[] references)`
`298`	`298`	`return resolvedReferences;`
`299`	`299`	`}`
`300`	`300`
`301`		`- internal string[] GlobReferences(string[] references)`
	`301`	`+ internal string[] GlobReferences(string[] references, SearchOption searchOption = SearchOption.TopDirectoryOnly)`
`302`	`302`	`{`
`303`	`303`	`var expandedReferences = new List<string>();`
`304`	`304`
`@@ -315,7 +315,7 @@ internal string[] GlobReferences(string[] references)`
`315`	`315`	`var directoryToSearch = Path.GetPathRoot(reference)!;`
`316`	`316`	`var searchPattern = reference.Substring(directoryToSearch.Length);`
`317`	`317`
`318`		`- var resolvedFiles = Directory.GetFiles(directoryToSearch, searchPattern);`
	`318`	`+ var resolvedFiles = Directory.GetFiles(directoryToSearch, searchPattern, searchOption);`
`319`	`319`
`320`	`320`	`if (resolvedFiles.Length == 0)`
`321`	`321`	`{`
`@@ -328,7 +328,7 @@ internal string[] GlobReferences(string[] references)`
`328`	`328`
`329`	`329`	`if (Directory.Exists(Path.Combine(Project.DirectoryPath, Path.GetDirectoryName(reference)!)))`
`330`	`330`	`{`
`331`		`- var resolvedFiles = Directory.GetFiles(Project.DirectoryPath, reference);`
	`331`	`+ var resolvedFiles = Directory.GetFiles(Project.DirectoryPath, reference, searchOption);`
`332`	`332`
`333`	`333`	`if (resolvedFiles.Length == 0)`
`334`	`334`	`{`