chore: add .NET specification tests

Author: olavloite

checksum_row_iterator.go

@@ -23,6 +23,7 @@ import (
 
 	"cloud.google.com/go/spanner"
 	sppb "cloud.google.com/go/spanner/apiv1/spannerpb"
+	"github.com/googleapis/go-sql-spanner/parser"
 	"google.golang.org/api/iterator"
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
@@ -51,10 +52,11 @@ type checksumRowIterator struct {
 	*spanner.RowIterator
 	metadata *sppb.ResultSetMetadata
 
-	ctx     context.Context
-	tx      *readWriteTransaction
-	stmt    spanner.Statement
-	options spanner.QueryOptions
+	ctx      context.Context
+	tx       *readWriteTransaction
+	stmt     spanner.Statement
+	stmtType parser.StatementType
+	options  spanner.QueryOptions
 	// nc (nextCount) indicates the number of times that next has been called
 	// on the iterator. Next() will be called the same number of times during
 	// a retry.
@@ -255,8 +257,11 @@ func (it *checksumRowIterator) Metadata() (*sppb.ResultSetMetadata, error) {
 func (it *checksumRowIterator) ResultSetStats() *sppb.ResultSetStats {
 	// TODO: The Spanner client library should offer an option to get the full
 	//       ResultSetStats, instead of only the RowCount and QueryPlan.
-	return &sppb.ResultSetStats{
-		RowCount:  &sppb.ResultSetStats_RowCountExact{RowCountExact: it.RowIterator.RowCount},
+	stats := &sppb.ResultSetStats{
 		QueryPlan: it.RowIterator.QueryPlan,
 	}
+	if it.stmtType == parser.StatementTypeDml {
+		stats.RowCount = &sppb.ResultSetStats_RowCountExact{RowCountExact: it.RowIterator.RowCount}
+	}
+	return stats
 }

conn.go

@@ -888,13 +888,13 @@ func (c *conn) queryContext(ctx context.Context, query string, execOptions *Exec
 			// The statement was either detected as being a query, or potentially not recognized at all.
 			// In that case, just default to using a single-use read-only transaction and let Spanner
 			// return an error if the statement is not suited for that type of transaction.
-			iter = &readOnlyRowIterator{c.execSingleQuery(ctx, c.client, stmt, c.ReadOnlyStaleness(), execOptions)}
+			iter = &readOnlyRowIterator{c.execSingleQuery(ctx, c.client, stmt, c.ReadOnlyStaleness(), execOptions), statementType.StatementType}
 		}
 	} else {
 		if execOptions.PartitionedQueryOptions.PartitionQuery {
 			return c.tx.partitionQuery(ctx, stmt, execOptions)
 		}
-		iter, err = c.tx.Query(ctx, stmt, execOptions)
+		iter, err = c.tx.Query(ctx, stmt, statementType.StatementType, execOptions)
 		if err != nil {
 			return nil, err
 		}

partitioned_query.go

@@ -22,6 +22,7 @@ import (
 	"io"
 
 	"cloud.google.com/go/spanner"
+	"github.com/googleapis/go-sql-spanner/parser"
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
 )
@@ -231,7 +232,7 @@ func (pq *PartitionedQuery) execute(ctx context.Context, index int) (*rows, erro
 		return nil, spanner.ToSpannerError(status.Errorf(codes.InvalidArgument, "invalid partition index: %d", index))
 	}
 	spannerIter := pq.tx.Execute(ctx, pq.Partitions[index])
-	iter := &readOnlyRowIterator{spannerIter}
+	iter := &readOnlyRowIterator{spannerIter, parser.StatementTypeQuery}
 	return &rows{it: iter, decodeOption: pq.execOptions.DecodeOption}, nil
 }
 

spannerlib/api/rows.go

@@ -88,6 +88,7 @@ type rows struct {
 	backend  *sql.Rows
 	metadata *spannerpb.ResultSetMetadata
 	stats    *spannerpb.ResultSetStats
+	done     bool
 
 	buffer        []any
 	values        *structpb.ListValue
@@ -135,15 +136,16 @@ func (gv *genericValue) Scan(src any) error {
 
 func (rows *rows) Next() (*structpb.ListValue, error) {
 	// No columns means no rows, so just return nil to indicate that there are no (more) rows.
-	if len(rows.metadata.RowType.Fields) == 0 {
+	if len(rows.metadata.RowType.Fields) == 0 || rows.done {
 		return nil, nil
 	}
 	if rows.stats != nil {
 		return nil, spanner.ToSpannerError(status.Error(codes.FailedPrecondition, "cannot read more data after returning stats"))
 	}
 	ok := rows.backend.Next()
 	if !ok {
-		// No more rows. Read stats and nil.
+		rows.done = true
+		// No more rows. Read stats and return nil.
 		rows.readStats()
 		// nil indicates no more rows.
 		return nil, nil

spannerlib/dotnet-spannerlib/Google.Cloud.SpannerLib/GrpcLibSpanner.cs

@@ -97,7 +97,7 @@ await stream.RequestStream.WriteAsync(new ConnectionStreamRequest
     public Rows ExecuteTransaction(Transaction transaction, ExecuteSqlRequest statement)
     {
         var rows = _lib.ExecuteTransaction(ToProto(transaction), statement);
-        return new Rows(transaction.Connection, rows.Id);
+        return new Rows(transaction.SpannerConnection, rows.Id);
     }
 
     public long[] ExecuteBatch(Connection connection, ExecuteBatchDmlRequest statements)
@@ -123,7 +123,7 @@ public Task<long[]> ExecuteBatchAsync(Connection connection, ExecuteBatchDmlRequ
 
     public async Task<ResultSetMetadata?> MetadataAsync(Rows rows)
     {
-        if (_streams.TryGetValue(rows.Connection.Id, out var stream))
+        if (_streams.TryGetValue(rows.SpannerConnection.Id, out var stream))
         {
             return await MetadataStreaming(stream, rows);
         }
@@ -161,7 +161,7 @@ await stream.RequestStream.WriteAsync(new ConnectionStreamRequest
 
     public async Task<ListValue?> NextAsync(Rows rows, int numRows, ISpanner.RowEncoding encoding)
     {
-        if (_streams.TryGetValue(rows.Connection.Id, out var stream))
+        if (_streams.TryGetValue(rows.SpannerConnection.Id, out var stream))
         {
             return await NextStreaming(stream, rows);
         }
@@ -213,7 +213,7 @@ public void Rollback(Connection connection)
 
     private static V1.Connection ToProto(Connection connection) => new() {Pool = ToProto(connection.Pool), Id = connection.Id};
 
-    private static V1.Transaction ToProto(Transaction transaction) => new() {Connection = ToProto(transaction.Connection), Id = transaction.Id};
+    private static V1.Transaction ToProto(Transaction transaction) => new() {Connection = ToProto(transaction.SpannerConnection), Id = transaction.Id};
 
-    private static V1.Rows ToProto(Rows rows) => new() {Connection = ToProto(rows.Connection), Id = rows.Id};
+    private static V1.Rows ToProto(Rows rows) => new() {Connection = ToProto(rows.SpannerConnection), Id = rows.Id};
 }

spannerlib/dotnet-spannerlib/Google.Cloud.SpannerLib/Rows.cs

@@ -8,9 +8,9 @@ namespace Google.Cloud.SpannerLib;
 
 public class Rows : AbstractLibObject
 {
-    private Lazy<ResultSetStats?> _stats;
+    private readonly Lazy<ResultSetStats?> _stats;
 
-    internal Connection Connection { get; private set; }
+    internal Connection SpannerConnection { get; private set; }
 
     private readonly AsyncServerStreamingCall<ResultSet>? _stream;
 
@@ -39,13 +39,9 @@ public long UpdateCount
         }
     }
 
-    internal Rows(Connection connection, long id) : this(connection, id, true)
+    internal Rows(Connection connection, long id, bool initMetadata = true) : base(connection.Spanner, id)
     {
-    }
-
-    internal Rows(Connection connection, long id, bool initMetadata) : base(connection.Spanner, id)
-    {
-        Connection = connection;
+        SpannerConnection = connection;
         if (initMetadata)
         {
             Metadata = Spanner.Metadata(this);
@@ -56,7 +52,7 @@ internal Rows(Connection connection, long id, bool initMetadata) : base(connecti
 
     internal Rows(Connection connection, AsyncServerStreamingCall<ResultSet> stream) : base(connection.Spanner, -1)
     {
-        Connection = connection;
+        SpannerConnection = connection;
         _stats = new(() => Spanner.Stats(this));
         _stream = stream;
     }

spannerlib/dotnet-spannerlib/Google.Cloud.SpannerLib/SharedLibSpanner.cs

@@ -119,7 +119,7 @@ public Task<long[]> ExecuteBatchAsync(Connection connection, ExecuteBatchDmlRequ
 
     public ResultSetMetadata? Metadata(Rows rows)
     {
-        using var handler = ExecuteLibraryFunction(() => Native.SpannerLib.Metadata(rows.Connection.Pool.Id, rows.Connection.Id, rows.Id));
+        using var handler = ExecuteLibraryFunction(() => Native.SpannerLib.Metadata(rows.SpannerConnection.Pool.Id, rows.SpannerConnection.Id, rows.Id));
         return handler.Length == 0 ? null : ResultSetMetadata.Parser.ParseFrom(handler.Value());
     }
 
@@ -130,13 +130,13 @@ public Task<long[]> ExecuteBatchAsync(Connection connection, ExecuteBatchDmlRequ
 
     public ResultSetStats? Stats(Rows rows)
     {
-        using var handler = ExecuteLibraryFunction(() => Native.SpannerLib.ResultSetStats(rows.Connection.Pool.Id, rows.Connection.Id, rows.Id));
+        using var handler = ExecuteLibraryFunction(() => Native.SpannerLib.ResultSetStats(rows.SpannerConnection.Pool.Id, rows.SpannerConnection.Id, rows.Id));
         return handler.Length == 0 ? null : ResultSetStats.Parser.ParseFrom(handler.Value());
     }
 
     public ListValue? Next(Rows rows, int numRows, ISpanner.RowEncoding encoding)
     {
-        using var handler = ExecuteLibraryFunction(() => Native.SpannerLib.Next(rows.Connection.Pool.Id, rows.Connection.Id, rows.Id, numRows, (int) encoding));
+        using var handler = ExecuteLibraryFunction(() => Native.SpannerLib.Next(rows.SpannerConnection.Pool.Id, rows.SpannerConnection.Id, rows.Id, numRows, (int) encoding));
         return handler.Length == 0 ? null : ListValue.Parser.ParseFrom(handler.Value());
     }
 
@@ -147,7 +147,7 @@ public Task<long[]> ExecuteBatchAsync(Connection connection, ExecuteBatchDmlRequ
 
     public void CloseRows(Rows rows)
     {
-        ExecuteAndReleaseLibraryFunction(() => Native.SpannerLib.CloseRows(rows.Connection.Pool.Id, rows.Connection.Id, rows.Id));
+        ExecuteAndReleaseLibraryFunction(() => Native.SpannerLib.CloseRows(rows.SpannerConnection.Pool.Id, rows.SpannerConnection.Id, rows.Id));
     }
 
     public Transaction BeginTransaction(Connection connection, TransactionOptions transactionOptions)

spannerlib/dotnet-spannerlib/Google.Cloud.SpannerLib/SpannerException.cs

@@ -1,9 +1,10 @@
 using System.Data;
+using System.Data.Common;
 
 namespace Google.Cloud.SpannerLib
 {
 
-    public class SpannerException : DataException
+    public class SpannerException : DbException
     {
         /// <summary>
         /// An error code that indicates the general class of problem.

spannerlib/dotnet-spannerlib/Google.Cloud.SpannerLib/Transaction.cs

@@ -5,35 +5,35 @@ namespace Google.Cloud.SpannerLib;
 
 public class Transaction : AbstractLibObject
 {
-    internal Connection Connection { get; private set; }
+    internal Connection SpannerConnection { get; private set; }
 
     internal Transaction(Connection connection, long id) : base(connection.Spanner, id)
     {
-        Connection = connection;
+        SpannerConnection = connection;
     }
 
     public Rows Execute(ExecuteSqlRequest statement)
     {
-        return Spanner.Execute(Connection, statement);
+        return Spanner.Execute(SpannerConnection, statement);
     }
 
     public CommitResponse Commit()
     {
         MarkDisposed();
-        return Spanner.Commit(Connection);
+        return Spanner.Commit(SpannerConnection);
     }
 
     public void Rollback()
     {
         MarkDisposed();
-        Spanner.Rollback(Connection);
+        Spanner.Rollback(SpannerConnection);
     }
 
     protected override void CloseLibObject()
     {
         try
         {
-            Spanner.Rollback(Connection);
+            Spanner.Rollback(SpannerConnection);
         }
         catch (Exception)
         {

transaction.go

@@ -44,7 +44,7 @@ type contextTransaction interface {
 	Commit() error
 	Rollback() error
 	resetForRetry(ctx context.Context) error
-	Query(ctx context.Context, stmt spanner.Statement, execOptions *ExecOptions) (rowIterator, error)
+	Query(ctx context.Context, stmt spanner.Statement, stmtType parser.StatementType, execOptions *ExecOptions) (rowIterator, error)
 	partitionQuery(ctx context.Context, stmt spanner.Statement, execOptions *ExecOptions) (driver.Rows, error)
 	ExecContext(ctx context.Context, stmt spanner.Statement, statementInfo *parser.StatementInfo, options spanner.QueryOptions) (*result, error)
 
@@ -67,6 +67,7 @@ var _ rowIterator = &readOnlyRowIterator{}
 
 type readOnlyRowIterator struct {
 	*spanner.RowIterator
+	stmtType parser.StatementType
 }
 
 func (ri *readOnlyRowIterator) Next() (*spanner.Row, error) {
@@ -84,10 +85,13 @@ func (ri *readOnlyRowIterator) Metadata() (*sppb.ResultSetMetadata, error) {
 func (ri *readOnlyRowIterator) ResultSetStats() *sppb.ResultSetStats {
 	// TODO: The Spanner client library should offer an option to get the full
 	//       ResultSetStats, instead of only the RowCount and QueryPlan.
-	return &sppb.ResultSetStats{
-		RowCount:  &sppb.ResultSetStats_RowCountExact{RowCountExact: ri.RowIterator.RowCount},
+	stats := &sppb.ResultSetStats{
 		QueryPlan: ri.RowIterator.QueryPlan,
 	}
+	if ri.stmtType == parser.StatementTypeDml {
+		stats.RowCount = &sppb.ResultSetStats_RowCountExact{RowCountExact: ri.RowIterator.RowCount}
+	}
+	return stats
 }
 
 type txResult int
@@ -135,7 +139,7 @@ func (tx *readOnlyTransaction) resetForRetry(ctx context.Context) error {
 	return nil
 }
 
-func (tx *readOnlyTransaction) Query(ctx context.Context, stmt spanner.Statement, execOptions *ExecOptions) (rowIterator, error) {
+func (tx *readOnlyTransaction) Query(ctx context.Context, stmt spanner.Statement, stmtType parser.StatementType, execOptions *ExecOptions) (rowIterator, error) {
 	tx.logger.DebugContext(ctx, "Query", "stmt", stmt.SQL)
 	if execOptions.PartitionedQueryOptions.AutoPartitionQuery {
 		if tx.boTx == nil {
@@ -152,7 +156,7 @@ func (tx *readOnlyTransaction) Query(ctx context.Context, stmt spanner.Statement
 		}
 		return mi, nil
 	}
-	return &readOnlyRowIterator{tx.roTx.QueryWithOptions(ctx, stmt, execOptions.QueryOptions)}, nil
+	return &readOnlyRowIterator{tx.roTx.QueryWithOptions(ctx, stmt, execOptions.QueryOptions), stmtType}, nil
 }
 
 func (tx *readOnlyTransaction) partitionQuery(ctx context.Context, stmt spanner.Statement, execOptions *ExecOptions) (driver.Rows, error) {
@@ -456,7 +460,7 @@ func (tx *readWriteTransaction) resetForRetry(ctx context.Context) error {
 // Query executes a query using the read/write transaction and returns a
 // rowIterator that will automatically retry the read/write transaction if the
 // transaction is aborted during the query or while iterating the returned rows.
-func (tx *readWriteTransaction) Query(ctx context.Context, stmt spanner.Statement, execOptions *ExecOptions) (rowIterator, error) {
+func (tx *readWriteTransaction) Query(ctx context.Context, stmt spanner.Statement, stmtType parser.StatementType, execOptions *ExecOptions) (rowIterator, error) {
 	tx.logger.Debug("Query", "stmt", stmt.SQL)
 	tx.active = true
 	if err := tx.maybeRunAutoDmlBatch(ctx); err != nil {
@@ -465,7 +469,7 @@ func (tx *readWriteTransaction) Query(ctx context.Context, stmt spanner.Statemen
 	// If internal retries have been disabled, we don't need to keep track of a
 	// running checksum for all results that we have seen.
 	if !tx.retryAborts() {
-		return &readOnlyRowIterator{tx.rwTx.QueryWithOptions(ctx, stmt, execOptions.QueryOptions)}, nil
+		return &readOnlyRowIterator{tx.rwTx.QueryWithOptions(ctx, stmt, execOptions.QueryOptions), stmtType}, nil
 	}
 
 	// If retries are enabled, we need to use a row iterator that will keep
@@ -476,6 +480,7 @@ func (tx *readWriteTransaction) Query(ctx context.Context, stmt spanner.Statemen
 		ctx:         ctx,
 		tx:          tx,
 		stmt:        stmt,
+		stmtType:    stmtType,
 		options:     execOptions.QueryOptions,
 		buffer:      buffer,
 		enc:         gob.NewEncoder(buffer),