content: /*
   * Licensed to the Apache Software Foundation (ASF) under one or more
   * contributor license agreements.  See the NOTICE file distributed with
   * this work for additional information regarding copyright ownership.
   * The ASF licenses this file to You 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.
   */
  package org.apache.arrow.flight.integration.tests;
  
  import static java.util.Objects.isNull;
  
  import com.google.protobuf.Any;
  import java.nio.charset.StandardCharsets;
  import java.util.Arrays;
  import java.util.HashMap;
  import java.util.Map;
  import java.util.function.Consumer;
  import org.apache.arrow.flight.CallOption;
  import org.apache.arrow.flight.FlightClient;
  import org.apache.arrow.flight.FlightInfo;
  import org.apache.arrow.flight.FlightProducer;
  import org.apache.arrow.flight.FlightServer;
  import org.apache.arrow.flight.FlightStream;
  import org.apache.arrow.flight.Location;
  import org.apache.arrow.flight.SchemaResult;
  import org.apache.arrow.flight.Ticket;
  import org.apache.arrow.flight.sql.FlightSqlClient;
  import org.apache.arrow.flight.sql.FlightSqlProducer;
  import org.apache.arrow.flight.sql.FlightSqlUtils;
  import org.apache.arrow.flight.sql.impl.FlightSql;
  import org.apache.arrow.flight.sql.util.TableRef;
  import org.apache.arrow.memory.BufferAllocator;
  import org.apache.arrow.util.Preconditions;
  import org.apache.arrow.vector.UInt4Vector;
  import org.apache.arrow.vector.VectorSchemaRoot;
  import org.apache.arrow.vector.complex.DenseUnionVector;
  import org.apache.arrow.vector.types.pojo.Schema;
  
  /**
   * Integration test scenario for validating Flight SQL specs across multiple implementations. This
   * should ensure that RPC objects are being built and parsed correctly for multiple languages and
   * that the Arrow schemas are returned as expected.
   */
  public class FlightSqlScenario implements Scenario {
    public static final long UPDATE_STATEMENT_EXPECTED_ROWS = 10000L;
    public static final long UPDATE_STATEMENT_WITH_TRANSACTION_EXPECTED_ROWS = 15000L;
    public static final long UPDATE_PREPARED_STATEMENT_EXPECTED_ROWS = 20000L;
    public static final long UPDATE_PREPARED_STATEMENT_WITH_TRANSACTION_EXPECTED_ROWS = 25000L;
    public static final byte[] SAVEPOINT_ID = "savepoint_id".getBytes(StandardCharsets.UTF_8);
    public static final String SAVEPOINT_NAME = "savepoint_name";
    public static final byte[] SUBSTRAIT_PLAN_TEXT = "plan".getBytes(StandardCharsets.UTF_8);
    public static final String SUBSTRAIT_VERSION = "version";
    public static final FlightSqlClient.SubstraitPlan SUBSTRAIT_PLAN =
        new FlightSqlClient.SubstraitPlan(SUBSTRAIT_PLAN_TEXT, SUBSTRAIT_VERSION);
    public static final byte[] TRANSACTION_ID = "transaction_id".getBytes(StandardCharsets.UTF_8);
    public static final byte[] BULK_INGEST_TRANSACTION_ID = "123".getBytes(StandardCharsets.UTF_8);
  
    @Override
    public FlightProducer producer(BufferAllocator allocator, Location location) throws Exception {
      return new FlightSqlScenarioProducer(allocator);
    }
  
    @Override
    public void buildServer(FlightServer.Builder builder) throws Exception {}
  
    @Override
    public void client(BufferAllocator allocator, Location location, FlightClient client)
        throws Exception {
      try (final FlightSqlClient sqlClient = new FlightSqlClient(client)) {
        validateMetadataRetrieval(sqlClient);
        validateStatementExecution(sqlClient);
        validatePreparedStatementExecution(allocator, sqlClient);
      }
    }
  
    private void validateMetadataRetrieval(FlightSqlClient sqlClient) throws Exception {
      final CallOption[] options = new CallOption[0];
  
      validate(
          FlightSqlProducer.Schemas.GET_CATALOGS_SCHEMA, sqlClient.getCatalogs(options), sqlClient);
      validateSchema(
          FlightSqlProducer.Schemas.GET_CATALOGS_SCHEMA, sqlClient.getCatalogsSchema(options));
  
      validate(
          FlightSqlProducer.Schemas.GET_SCHEMAS_SCHEMA,
          sqlClient.getSchemas("catalog", "db_schema_filter_pattern", options),
          sqlClient);
      validateSchema(FlightSqlProducer.Schemas.GET_SCHEMAS_SCHEMA, sqlClient.getSchemasSchema());
  
      validate(
          FlightSqlProducer.Schemas.GET_TABLES_SCHEMA,
          sqlClient.getTables(
              "catalog",
              "db_schema_filter_pattern",
              "table_filter_pattern",
              Arrays.asList("table", "view"),
              true,
              options),
          sqlClient);
      validateSchema(
          FlightSqlProducer.Schemas.GET_TABLES_SCHEMA,
          sqlClient.getTablesSchema(/*includeSchema*/ true, options));
      validateSchema(
          FlightSqlProducer.Schemas.GET_TABLES_SCHEMA_NO_SCHEMA,
          sqlClient.getTablesSchema(/*includeSchema*/ false, options));
  
      validate(
          FlightSqlProducer.Schemas.GET_TABLE_TYPES_SCHEMA,
          sqlClient.getTableTypes(options),
          sqlClient);
      validateSchema(
          FlightSqlProducer.Schemas.GET_TABLE_TYPES_SCHEMA, sqlClient.getTableTypesSchema(options));
  
      validate(
          FlightSqlProducer.Schemas.GET_PRIMARY_KEYS_SCHEMA,
          sqlClient.getPrimaryKeys(TableRef.of("catalog", "db_schema", "table"), options),
          sqlClient);
      validateSchema(
          FlightSqlProducer.Schemas.GET_PRIMARY_KEYS_SCHEMA, sqlClient.getPrimaryKeysSchema(options));
  
      validate(
          FlightSqlProducer.Schemas.GET_EXPORTED_KEYS_SCHEMA,
          sqlClient.getExportedKeys(TableRef.of("catalog", "db_schema", "table"), options),
          sqlClient);
      validateSchema(
          FlightSqlProducer.Schemas.GET_EXPORTED_KEYS_SCHEMA,
          sqlClient.getExportedKeysSchema(options));
  
      validate(
          FlightSqlProducer.Schemas.GET_IMPORTED_KEYS_SCHEMA,
          sqlClient.getImportedKeys(TableRef.of("catalog", "db_schema", "table"), options),
          sqlClient);
      validateSchema(
          FlightSqlProducer.Schemas.GET_IMPORTED_KEYS_SCHEMA,
          sqlClient.getImportedKeysSchema(options));
  
      validate(
          FlightSqlProducer.Schemas.GET_CROSS_REFERENCE_SCHEMA,
          sqlClient.getCrossReference(
              TableRef.of("pk_catalog", "pk_db_schema", "pk_table"),
              TableRef.of("fk_catalog", "fk_db_schema", "fk_table"),
              options),
          sqlClient);
      validateSchema(
          FlightSqlProducer.Schemas.GET_CROSS_REFERENCE_SCHEMA,
          sqlClient.getCrossReferenceSchema(options));
  
      validate(
          FlightSqlProducer.Schemas.GET_TYPE_INFO_SCHEMA,
          sqlClient.getXdbcTypeInfo(options),
          sqlClient);
      validateSchema(
          FlightSqlProducer.Schemas.GET_TYPE_INFO_SCHEMA, sqlClient.getXdbcTypeInfoSchema(options));
  
      FlightInfo sqlInfoFlightInfo =
          sqlClient.getSqlInfo(
              new FlightSql.SqlInfo[] {
                FlightSql.SqlInfo.FLIGHT_SQL_SERVER_NAME,
                FlightSql.SqlInfo.FLIGHT_SQL_SERVER_READ_ONLY
              },
              options);
  
      Ticket ticket = sqlInfoFlightInfo.getEndpoints().get(0).getTicket();
      FlightSql.CommandGetSqlInfo requestSqlInfoCommand =
          FlightSqlUtils.unpackOrThrow(
              Any.parseFrom(ticket.getBytes()), FlightSql.CommandGetSqlInfo.class);
      IntegrationAssertions.assertEquals(
          requestSqlInfoCommand.getInfo(0), FlightSql.SqlInfo.FLIGHT_SQL_SERVER_NAME_VALUE);
      IntegrationAssertions.assertEquals(
          requestSqlInfoCommand.getInfo(1), FlightSql.SqlInfo.FLIGHT_SQL_SERVER_READ_ONLY_VALUE);
      validate(FlightSqlProducer.Schemas.GET_SQL_INFO_SCHEMA, sqlInfoFlightInfo, sqlClient);
      validateSchema(
          FlightSqlProducer.Schemas.GET_SQL_INFO_SCHEMA, sqlClient.getSqlInfoSchema(options));
    }
  
    private void validateStatementExecution(FlightSqlClient sqlClient) throws Exception {
      FlightInfo info = sqlClient.execute("SELECT STATEMENT");
      validate(FlightSqlScenarioProducer.getQuerySchema(), info, sqlClient);
      validateSchema(
          FlightSqlScenarioProducer.getQuerySchema(), sqlClient.getExecuteSchema("SELECT STATEMENT"));
  
      IntegrationAssertions.assertEquals(
          sqlClient.executeUpdate("UPDATE STATEMENT"), UPDATE_STATEMENT_EXPECTED_ROWS);
    }
  
    private void validatePreparedStatementExecution(
        BufferAllocator allocator, FlightSqlClient sqlClient) throws Exception {
      try (FlightSqlClient.PreparedStatement preparedStatement =
              sqlClient.prepare("SELECT PREPARED STATEMENT");
          VectorSchemaRoot parameters =
              VectorSchemaRoot.create(FlightSqlScenarioProducer.getQuerySchema(), allocator)) {
        parameters.setRowCount(1);
        preparedStatement.setParameters(parameters);
        validate(FlightSqlScenarioProducer.getQuerySchema(), preparedStatement.execute(), sqlClient);
        validateSchema(FlightSqlScenarioProducer.getQuerySchema(), preparedStatement.fetchSchema());
      }
  
      try (FlightSqlClient.PreparedStatement preparedStatement =
          sqlClient.prepare("UPDATE PREPARED STATEMENT")) {
        IntegrationAssertions.assertEquals(
            preparedStatement.executeUpdate(), UPDATE_PREPARED_STATEMENT_EXPECTED_ROWS);
      }
    }
  
    protected void validate(Schema expectedSchema, FlightInfo flightInfo, FlightSqlClient sqlClient)
        throws Exception {
      validate(expectedSchema, flightInfo, sqlClient, null);
    }
  
    protected void validate(
        Schema expectedSchema,
        FlightInfo flightInfo,
        FlightSqlClient sqlClient,
        Consumer<FlightStream> streamConsumer)
        throws Exception {
      Ticket ticket = flightInfo.getEndpoints().get(0).getTicket();
      try (FlightStream stream = sqlClient.getStream(ticket)) {
        Schema actualSchema = stream.getSchema();
        IntegrationAssertions.assertEquals(expectedSchema, actualSchema);
        if (!isNull(streamConsumer)) {
          streamConsumer.accept(stream);
        }
      }
    }
  
    protected void validateSchema(Schema expected, SchemaResult actual) {
      IntegrationAssertions.assertEquals(expected, actual.getSchema());
    }
  
    protected Map<Integer, Object> readSqlInfoStream(FlightStream stream) {
      Map<Integer, Object> infoValues = new HashMap<>();
      while (stream.next()) {
        UInt4Vector infoName = (UInt4Vector) stream.getRoot().getVector(0);
        DenseUnionVector value = (DenseUnionVector) stream.getRoot().getVector(1);
  
        for (int i = 0; i < stream.getRoot().getRowCount(); i++) {
          final int code = infoName.get(i);
          if (infoValues.containsKey(code)) {
            throw new AssertionError("Duplicate SqlInfo value: " + code);
          }
          Object object;
          byte typeId = value.getTypeId(i);
          switch (typeId) {
            case 0: // string
              object =
                  Preconditions.checkNotNull(
                          value.getVarCharVector(typeId).getObject(value.getOffset(i)))
                      .toString();
              break;
            case 1: // bool
              object = value.getBitVector(typeId).getObject(value.getOffset(i));
              break;
            case 2: // int64
              object = value.getBigIntVector(typeId).getObject(value.getOffset(i));
              break;
            case 3: // int32
              object = value.getIntVector(typeId).getObject(value.getOffset(i));
              break;
            default:
              throw new AssertionError("Decoding SqlInfo of type code " + typeId);
          }
          infoValues.put(code, object);
        }
      }
      return infoValues;
    }
  }
  