feat: Adapting tests and scripts to work on cross platform OS

Author: purvavasudeo

Google.Api.Generator.Tests/Invoker.cs

@@ -24,6 +24,10 @@ namespace Google.Api.Generator.Tests
 {
     internal static class Invoker
     {
+        const string ProtocFileStr = "ProtocFile";
+        const string RuntimeStr = "Runtime";
+        const string PluginFileStr = "PluginFile";
+
         public class WithPath : IDisposable
         {
             public WithPath(Action action, string path) => (_action, Path) = (action, path);
@@ -38,11 +42,13 @@ static Invoker()
             RootDir = PathUtils.GetRepoRoot();
             GeneratorDir = Path.Combine(RootDir, "Google.Api.Generator");
             GeneratorTestsDir = Path.Combine(RootDir, "Google.Api.Generator.Tests");
-            var isWindows = RuntimeInformation.IsOSPlatform(OSPlatform.Windows);
-            ProtocFile = Path.Combine(RootDir, "tools", isWindows ? "protoc.exe" : "protoc");
-            Runtime = isWindows ? "win-x64" : "linux-x64";
-            PluginFile = Path.Combine(GeneratorDir, "bin", "Debug", "net6.0", Runtime, "publish",
-                isWindows ? "Google.Api.Generator.exe" : "Google.Api.Generator");
+
+            // Fetch OS dependent executable paths and other configs
+            var OSConfigs = GetOSSpecificConfigs(RootDir);
+            ProtocFile = OSConfigs["ProtocFile"];
+            Runtime = OSConfigs["Runtime"];
+            PluginFile = OSConfigs["PluginFile"];
+
             CommonProtosDir = Path.Combine(RootDir, "googleapis");
             ProtobufDir = Path.Combine(RootDir, "tools", "protos");
             var now = DateTime.UtcNow;
@@ -92,7 +98,7 @@ private static void Execute(string executable, string args, string workingDirect
                 process.OutputDataReceived += handler;
                 process.BeginErrorReadLine();
                 process.BeginOutputReadLine();
-                var exited = process.WaitForExit((int) timeout.TotalMilliseconds);
+                var exited = process.WaitForExit((int)timeout.TotalMilliseconds);
 
                 // Avoid any extra data being added to our output while we're processing assertions.
                 process.ErrorDataReceived -= handler;
@@ -128,5 +134,35 @@ public static WithPath TempDir()
             Directory.CreateDirectory(dirPath);
             return new WithPath(() => Directory.Delete(dirPath, recursive: true), dirPath);
         }
+
+        private static Dictionary<string, string> GetOSSpecificConfigs(string rootDir)
+        {
+            Dictionary<string, string> configs = new Dictionary<string, string>();
+
+
+            if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
+            {
+                //  Linux configs
+                configs[ProtocFileStr] = Path.Combine(RootDir, "tools", "protoc");
+                configs[RuntimeStr] = "linux-x64";
+                configs[PluginFileStr] = Path.Combine(GeneratorDir, "bin", "Debug", "net6.0", configs[RuntimeStr], "publish", "Google.Api.Generator");
+            }
+            else if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
+            {
+                // MacOS configs
+                configs[ProtocFileStr] = Path.Combine(RootDir, "tools", "protoc_macosx_x64");
+                configs[RuntimeStr] = "osx-x64";
+                configs[PluginFileStr] = Path.Combine(GeneratorDir, "bin", "Debug", "net6.0", configs[RuntimeStr], "publish", "Google.Api.Generator");
+            }
+            else
+            {
+                // Default to Windows configs
+                configs[ProtocFileStr] = Path.Combine(RootDir, "tools", "protoc.exe");
+                configs[RuntimeStr] = "win-x64";
+                configs[PluginFileStr] = Path.Combine(GeneratorDir, "bin", "Debug", "net6.0", configs[RuntimeStr], "publish", "Google.Api.Generator.exe");
+            }
+
+            return configs;
+        }
     }
 }

generateprotos.sh

@@ -6,14 +6,29 @@
 # - protoc compiler plugin
 # - Generator config protos (e.g. service config, snippets)
 # - GAPIC ShowCase
-#
-# Currently this script is hard-coded to use protoc.exe,
-# so it only runs on Windows; we can use platform detection
-# if that ever becomes an issue.
+
+# Cross-platform tools
+protoc_executable="tools/protoc.exe" # default to Windows
+grpc_csharp_executable="tools/grpc_csharp_plugin.exe" # default to Windows
+case "$OSTYPE" in
+  linux*)
+    protoc_executable="tools/protoc"
+    grpc_csharp_executable="tools/grpc_csharp_plugin"
+    ;;
+  darwin*)
+    protoc_executable="tools/protoc_macosx_x64"
+    grpc_csharp_executable="tools/grpc_csharp_plugin_macosx_x64"
+    chmod +x tools/protoc_macosx_x64
+    chmod +x tools/grpc_csharp_plugin_macosx_x64
+    ;;
+  *)
+    echo "Unknown OSTYPE: $OSTYPE"
+    exit 1
+esac
 
 # Generator config protos
 echo "Generating generator config protos"
-tools/protoc.exe \
+"$protoc_executable" \
   --csharp_out=Google.Api.Generator/ConfigProtos \
   -Itools/protos \
   -Igoogleapis \
@@ -22,10 +37,10 @@ tools/protoc.exe \
 
 # GAPIC Showcase
 echo "Generating GAPIC Showcase"
-tools/protoc.exe \
+"$protoc_executable" \
   --csharp_out=Google.Api.Generator.Tests/ProtoTests/Showcase \
   --csharp_opt=file_extension=.g.cs \
-  --plugin=protoc-gen-grpc=tools/grpc_csharp_plugin.exe \
+  --plugin=protoc-gen-grpc="$grpc_csharp_executable" \
   --grpc_out=Google.Api.Generator.Tests/ProtoTests/Showcase \
   --grpc_opt=file_suffix=Grpc.g.cs \
   -Itools/protos \

tools/grpc_csharp_plugin_macosx_x64

@@ -23,6 +23,7 @@ unzip -q tmp.zip
 
 mv tools/windows_x64/grpc_csharp_plugin.exe ..
 mv tools/linux_x64/grpc_csharp_plugin ..
+mv tools/macosx_x64/grpc_csharp_plugin ../grpc_csharp_plugin_macosx_x64
 
 cd ..
 rm -rf tmp

tools/protoc_macosx_x64

@@ -23,6 +23,7 @@ unzip -q tmp.zip
 
 mv tools/windows_x64/protoc.exe ..
 mv tools/linux_x64/protoc ..
+mv tools/macosx_x64/protoc ../protoc_macosx_x64
 cp tools/google/protobuf/* ../protos/google/protobuf
 
 cd ..