feat: standing up the GRPC service and running conformance tests with kokoro and Github actions

Author: cy-yun

.github/workflows/bigtable-conformance.yml

@@ -0,0 +1,42 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# Github action job to test core java library features on
+# downstream client libraries before they are released.
+on:
+  push:
+    branches:
+    - main
+  pull_request:
+name: bigtable-conformance
+jobs:
+  conformance:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: true
+    - uses: actions/checkout@v4
+      with:
+        repository: googleapis/cloud-bigtable-clients-test
+        ref: main
+        path: cloud-bigtable-clients-test
+    - uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: 6.0.x
+    - uses: actions/setup-go@v5
+      with:
+        go-version: '>=1.20.2'
+    - run: dotnet --version
+    - run: go version
+    - run: .kokoro/bigtable-conformance.sh

.kokoro/bigtable-conformance.sh

@@ -0,0 +1,67 @@
+#!/bin/bash
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -eo pipefail
+
+## Get the directory of the build script
+scriptDir=$(realpath $(dirname "${BASH_SOURCE[0]}"))
+## cd to the parent directory, i.e. the root of the git repo
+cd ${scriptDir}/..
+
+set +e
+
+# Build the proxy
+pushd .
+cd apis/Google.Cloud.Bigtable.V2/Google.Cloud.Bigtable.V2ConformanceTest
+dotnet build
+popd
+
+declare -a configs=("default" "enable_all")
+for config in "${configs[@]}"
+do
+  # Start the proxy in a separate process
+  dotnet run
+
+  # Run the conformance test
+  if [[ ${config} = "enable_all" ]]
+  then
+    echo "Testing the client with all optional features enabled..."
+    configFlag="--enable_features_all"
+  else
+    echo "Testing the client with default settings for optional features..."
+    # skipping routing cookie and retry info tests. When the feature is disabled, these
+    # tests are expected to fail
+    configFlag="-skip _Retry_WithRoutingCookie\|_Retry_WithRetryInfo"
+  fi
+
+  pushd .
+  cd cloud-bigtable-clients-test/tests
+  eval "go test -v -proxy_addr=:7238 ${configFlag} -skip '`cat ../../apis/Google.Cloud.Bigtable.V2/Google.Cloud.Bigtable.V2ConformanceTest/known_failures.txt`'"
+  returnCode=$?
+  popd
+
+  # Stop the proxy
+  kill ${proxyPID}
+
+  if [[ ${returnCode} -gt 0 ]]
+  then
+    echo "Conformance test failed for config: ${config}"
+    RETURN_CODE=${returnCode}
+  else
+    echo "Conformance test passed for config: ${config}"
+  fi
+done
+
+exit ${RETURN_CODE}

apis/Google.Cloud.Bigtable.V2/Google.Cloud.Bigtable.V2.ConformanceTests/Google.Cloud.Bigtable.V2.ConformanceTests.csproj

@@ -1,12 +1,22 @@
-<?xml version="1.0" encoding="utf-8"?>
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
   <PropertyGroup>
-    <TargetFrameworks>net6.0;net462</TargetFrameworks>
-    <TargetFrameworks Condition=" '$(OS)' != 'Windows_NT' ">net6.0</TargetFrameworks>
-    <IsPackable>false</IsPackable>
-    <NoWarn>1701;1702;1705;xUnit2004;xUnit2013</NoWarn>
+    <TargetFramework>net6.0</TargetFramework>
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
   </PropertyGroup>
+
   <ItemGroup>
     <ProjectReference Include="..\Google.Cloud.Bigtable.V2\Google.Cloud.Bigtable.V2.csproj" />
   </ItemGroup>
+
+  <ItemGroup>
+    <Protobuf Include="Protos\test_proxy.proto" GrpcServices="Server" AdditionalImportDirs="..\..\..\googleapis;.\googleapis" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Grpc.AspNetCore" VersionOverride="2.40.0" />
+    <PackageReference Include="Microsoft.AspNetCore.Server.Kestrel.Core" VersionOverride="2.3.0" />
+  </ItemGroup>
+
 </Project>

apis/Google.Cloud.Bigtable.V2/Google.Cloud.Bigtable.V2.ConformanceTests/Program.cs

@@ -0,0 +1,24 @@
+using Google.Cloud.Bigtable.V2.ConformanceTests.Services;
+using Microsoft.AspNetCore.Server.Kestrel.Core;
+
+var builder = WebApplication.CreateBuilder(args);
+
+builder.WebHost.ConfigureKestrel(options =>
+{
+  // Setup a HTTP/2 endpoint without TLS.
+  options.ListenLocalhost(7238, o => o.Protocols =
+      HttpProtocols.Http2);
+});
+// Additional configuration is required to successfully run gRPC on macOS.
+// For instructions on how to configure Kestrel and gRPC clients on macOS, visit https://go.microsoft.com/fwlink/?linkid=2099682
+
+// Add services to the container.
+builder.Services.AddGrpc();
+
+var app = builder.Build();
+
+// Configure the HTTP request pipeline.
+app.MapGrpcService<CloudBigtableV2TestProxyImpl>();
+app.MapGet("/", () => "Communication with gRPC endpoints must be made through a gRPC client. To learn how to create a client, visit: https://go.microsoft.com/fwlink/?linkid=2086909");
+
+app.Run();

apis/Google.Cloud.Bigtable.V2/Google.Cloud.Bigtable.V2.ConformanceTests/Protos/test_proxy.proto

@@ -14,7 +14,7 @@
 
 syntax = "proto3";
 
-package google.cloud.bigtable.v2.conformanceTests;
+package google.cloud.bigtable.v2.ConformanceTests;
 
 import "google/api/client.proto";
 import "google/bigtable/v2/bigtable.proto";

apis/Google.Cloud.Bigtable.V2/Google.Cloud.Bigtable.V2.ConformanceTests/CloudBigtableV2TestProxyImpl.cs renamed to apis/Google.Cloud.Bigtable.V2/Google.Cloud.Bigtable.V2.ConformanceTests/Services/CloudBigtableV2TestProxyImpl.cs

@@ -18,20 +18,23 @@
 using Google.Cloud.Bigtable.Common.V2;
 using Grpc.Auth;
 using Grpc.Core;
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Threading.Tasks;
 
-namespace Google.Cloud.Bigtable.V2.ConformanceTests;
+namespace Google.Cloud.Bigtable.V2.ConformanceTests.Services;
 
 public sealed class CloudBigtableV2TestProxyImpl : CloudBigtableV2TestProxy.CloudBigtableV2TestProxyBase
 {
     private class CbtClient
     {
-        public BigtableClient Client { get; set; }
-        public ChannelBase LastCreatedChannel { get; set; }
-        public InstanceName InstanceName { get; set; }
+        public BigtableClient Client { get; private set; }
+        public ChannelBase LastCreatedChannel { get; private set; }
+        public InstanceName InstanceName { get; private set; }
+
+        public CbtClient(BigtableClient bigtableClient, ChannelBase channelBase, InstanceName instanceName)
+        {
+            Client = bigtableClient;
+            LastCreatedChannel = channelBase;
+            InstanceName = instanceName;
+        }
     }
 
     private readonly Dictionary<string, CbtClient> _idClientMap;
@@ -52,11 +55,13 @@ public override async Task<CreateClientResponse> CreateClient(CreateClientReques
             || (securityOptions.SslRootCertsPem is not ("" or null)), "SecurityOptions",
             "security_options.ssl_root_certs_pem must be provided if security_options.use_ssl is true");
 
+#pragma warning disable CS8604 // Possible null reference argument.
         if (_idClientMap.ContainsKey(clientId))
         {
             context.Status = new Status(StatusCode.AlreadyExists, $"Client {clientId} already exists");
             throw new RpcException(context.Status);
         }
+#pragma warning restore CS8604 // Possible null reference argument.
 
         try
         {
@@ -77,7 +82,9 @@ public override async Task<CreateClientResponse> CreateClient(CreateClientReques
             if (dataTarget != "emulator")
             {
                 builder.Endpoint = dataTarget;
+#pragma warning disable CS8604 // Possible null reference argument.
                 builder.ChannelCredentials = GetChannelCredentials(securityOptions.UseSsl, securityOptions.SslRootCertsPem, securityOptions.AccessToken);
+#pragma warning restore CS8604 // Possible null reference argument.
                 builder.GrpcChannelOptions = (securityOptions.UseSsl && securityOptions.SslEndpointOverride is not null)
                     ? GrpcChannelOptions.Empty.WithCustomOption("grpc.ssl_target_name_override", securityOptions.SslEndpointOverride)
                     : GrpcChannelOptions.Empty;
@@ -89,12 +96,7 @@ public override async Task<CreateClientResponse> CreateClient(CreateClientReques
             InstanceName instanceName = new InstanceName(projectId, instanceId);
             BigtableServiceApiClient apiClient = await builder.BuildAsync();
 
-            CbtClient cbtClient = new CbtClient
-            {
-                Client = BigtableClient.Create(apiClient),
-                LastCreatedChannel = builder.LastCreatedChannel,
-                InstanceName = instanceName
-            };
+            CbtClient cbtClient = new CbtClient(BigtableClient.Create(apiClient), builder.LastCreatedChannel, instanceName);
             _idClientMap[clientId] = cbtClient;
         }
         catch (Exception e)
@@ -126,7 +128,9 @@ public override Task<RemoveClientResponse> RemoveClient(RemoveClientRequest requ
     {
         string clientId = request.ClientId;
         GaxPreconditions.CheckArgument(clientId is not ("" or null), "ClientId", "client id must be provided", context);
+#pragma warning disable CS8604 // Possible null reference argument.
         bool removed = _idClientMap.Remove(clientId);
+#pragma warning restore CS8604 // Possible null reference argument.
         if (!removed)
         {
             context.Status = new Status(StatusCode.NotFound, $"Client {clientId} not found.");
@@ -147,7 +151,7 @@ public override async Task<RowResult> ReadRow(ReadRowRequest request, ServerCall
             {
                 Status = new Rpc.Status()
                 {
-                    Code = (int) Rpc.Code.InvalidArgument,
+                    Code = (int)Rpc.Code.InvalidArgument,
                     Message = "Invalid TableName"
                 }
             };
@@ -355,17 +359,19 @@ public override async Task<ExecuteQueryResult> ExecuteQuery(ExecuteQueryRequest
 
     public static CloudBigtableV2TestProxyImpl Create() => new();
 
-    private CloudBigtableV2TestProxyImpl() => _idClientMap = new();
+    public CloudBigtableV2TestProxyImpl() => _idClientMap = new();
 
     private CbtClient GetClient(string clientId, ServerCallContext context)
     {
         GaxPreconditions.CheckArgument(clientId is not ("" or null), "ClientId", "client id must be provided", context);
 
+#pragma warning disable CS8604 // Possible null reference argument.
         if (!_idClientMap.ContainsKey(clientId))
         {
             context.Status = new Status(StatusCode.NotFound, $"Client {clientId} not found.");
             throw new RpcException(context.Status);
         }
+#pragma warning restore CS8604 // Possible null reference argument.
         return _idClientMap[clientId];
     }
 
@@ -399,7 +405,7 @@ private static Rpc.Status SetExceptionStatus(Exception e, ServerCallContext cont
         context.Status = new Status(StatusCode.Internal, e.Message, e);
         return new Rpc.Status()
         {
-            Code = (int) Rpc.Code.Internal,
+            Code = (int)Rpc.Code.Internal,
             Message = e.Message
         };
     }
@@ -409,7 +415,7 @@ private static Rpc.Status SetSuccessStatus(string message, ServerCallContext con
         context.Status = new Status(StatusCode.OK, message);
         return new Rpc.Status()
         {
-            Code = (int) Rpc.Code.Ok,
+            Code = (int)Rpc.Code.Ok,
             Message = message
         };
     }