westonpace commented on code in PR #14174: URL: https://github.com/apache/arrow/pull/14174#discussion_r1084061351
########## cpp/src/arrow/engine/substrait/test_util.cc: ########## @@ -0,0 +1,129 @@ +// 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. + +// These utilities are for internal / unit test use only. +// They allow for the construction of simple Substrait plans +// programmatically without first requiring the construction +// of an ExecPlan + +// These utilities have to be here, and not in a test_util.cc +// file (or in a unit test) because only one .so is allowed +// to include each .pb.h file or else protobuf will encounter +// global namespace conflicts. + +#include "arrow/engine/substrait/test_util.h" + +#include "arrow/compute/exec/test_util.h" +#include "arrow/engine/substrait/extension_set.h" +#include "arrow/engine/substrait/serde.h" +#include "arrow/ipc/writer.h" + +namespace arrow { + +namespace engine { + +std::shared_ptr<DataType> StripFieldNames(std::shared_ptr<DataType> type) { + if (type->id() == Type::STRUCT) { + FieldVector fields(type->num_fields()); + for (int i = 0; i < type->num_fields(); ++i) { + fields[i] = type->field(i)->WithName(""); + } + return struct_(std::move(fields)); + } + + if (type->id() == Type::LIST) { + return list(type->field(0)->WithName("")); + } + + return type; +} + +void WriteIpcData(const std::string& path, + const std::shared_ptr<fs::FileSystem> file_system, + const std::shared_ptr<Table> input) { + EXPECT_OK_AND_ASSIGN(auto mmap, file_system->OpenOutputStream(path)); + ASSERT_OK_AND_ASSIGN( + auto file_writer, + MakeFileWriter(mmap, input->schema(), ipc::IpcWriteOptions::Defaults())); + TableBatchReader reader(input); + std::shared_ptr<RecordBatch> batch; + while (true) { + ASSERT_OK(reader.ReadNext(&batch)); + if (batch == nullptr) { + break; + } + ASSERT_OK(file_writer->WriteRecordBatch(*batch)); + } + ASSERT_OK(file_writer->Close()); +} + +Result<std::shared_ptr<Table>> GetTableFromPlan( + compute::Declaration& other_declrs, compute::ExecContext& exec_context, + const std::shared_ptr<Schema>& output_schema) { + ARROW_ASSIGN_OR_RAISE(auto plan, compute::ExecPlan::Make(&exec_context)); + + arrow::AsyncGenerator<std::optional<compute::ExecBatch>> sink_gen; + auto sink_node_options = compute::SinkNodeOptions{&sink_gen}; + auto sink_declaration = compute::Declaration({"sink", sink_node_options, "e"}); + auto declarations = compute::Declaration::Sequence({other_declrs, sink_declaration}); + + ARROW_ASSIGN_OR_RAISE(auto decl, declarations.AddToPlan(plan.get())); + + RETURN_NOT_OK(decl->Validate()); + + std::shared_ptr<arrow::RecordBatchReader> sink_reader = compute::MakeGeneratorReader( + output_schema, std::move(sink_gen), exec_context.memory_pool()); + + RETURN_NOT_OK(plan->Validate()); + RETURN_NOT_OK(plan->StartProducing()); + return arrow::Table::FromRecordBatchReader(sink_reader.get()); +} + +void CheckRoundTripResult(const std::shared_ptr<Table> expected_table, + std::shared_ptr<Buffer>& buf, + const std::vector<int>& include_columns, + const ConversionOptions& conversion_options, + const compute::SortOptions* sort_options) { + std::shared_ptr<ExtensionIdRegistry> sp_ext_id_reg = MakeExtensionIdRegistry(); + ExtensionIdRegistry* ext_id_reg = sp_ext_id_reg.get(); + ExtensionSet ext_set(ext_id_reg); + ASSERT_OK_AND_ASSIGN(auto sink_decls, DeserializePlans( + *buf, [] { return kNullConsumer; }, + ext_id_reg, &ext_set, conversion_options)); + auto& other_declrs = std::get<compute::Declaration>(sink_decls[0].inputs[0]); Review Comment: There is now a `DeserializePlan` method that returns a single declaration. ########## cpp/src/arrow/engine/substrait/test_util.cc: ########## @@ -0,0 +1,129 @@ +// 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. + +// These utilities are for internal / unit test use only. +// They allow for the construction of simple Substrait plans +// programmatically without first requiring the construction +// of an ExecPlan + +// These utilities have to be here, and not in a test_util.cc +// file (or in a unit test) because only one .so is allowed +// to include each .pb.h file or else protobuf will encounter +// global namespace conflicts. + +#include "arrow/engine/substrait/test_util.h" + +#include "arrow/compute/exec/test_util.h" +#include "arrow/engine/substrait/extension_set.h" +#include "arrow/engine/substrait/serde.h" +#include "arrow/ipc/writer.h" + +namespace arrow { + +namespace engine { + +std::shared_ptr<DataType> StripFieldNames(std::shared_ptr<DataType> type) { + if (type->id() == Type::STRUCT) { + FieldVector fields(type->num_fields()); + for (int i = 0; i < type->num_fields(); ++i) { + fields[i] = type->field(i)->WithName(""); + } + return struct_(std::move(fields)); + } + + if (type->id() == Type::LIST) { + return list(type->field(0)->WithName("")); + } + + return type; +} + +void WriteIpcData(const std::string& path, + const std::shared_ptr<fs::FileSystem> file_system, + const std::shared_ptr<Table> input) { + EXPECT_OK_AND_ASSIGN(auto mmap, file_system->OpenOutputStream(path)); + ASSERT_OK_AND_ASSIGN( + auto file_writer, + MakeFileWriter(mmap, input->schema(), ipc::IpcWriteOptions::Defaults())); + TableBatchReader reader(input); + std::shared_ptr<RecordBatch> batch; + while (true) { + ASSERT_OK(reader.ReadNext(&batch)); + if (batch == nullptr) { + break; + } + ASSERT_OK(file_writer->WriteRecordBatch(*batch)); + } Review Comment: ```suggestion EXPECT_OK_AND_ASSIGN(auto out_stream, file_system->OpenOutputStream(path)); ASSERT_OK_AND_ASSIGN( auto file_writer, MakeFileWriter(out_stream, input->schema(), ipc::IpcWriteOptions::Defaults())); EXPECT_OK(file_writer->WriteTable(*input)); ``` There is a `WriteTable` method that will simplify this. ########## cpp/src/arrow/engine/substrait/test_util.h: ########## @@ -0,0 +1,59 @@ +// 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. + +// These utilities are for internal / unit test use only. +// They allow for the construction of simple Substrait plans +// programmatically without first requiring the construction +// of an ExecPlan + +// These utilities have to be here, and not in a test_util.cc +// file (or in a unit test) because only one .so is allowed +// to include each .pb.h file or else protobuf will encounter +// global namespace conflicts. + +#include "arrow/compute/exec/exec_plan.h" +#include "arrow/compute/exec/util.h" +#include "arrow/dataset/file_base.h" +#include "arrow/engine/substrait/util.h" +#include "arrow/table.h" +#include "arrow/testing/gtest_util.h" + +namespace arrow { + +namespace engine { + +const auto kNullConsumer = std::make_shared<compute::NullSinkNodeConsumer>(); + +ARROW_ENGINE_EXPORT std::shared_ptr<DataType> StripFieldNames( + std::shared_ptr<DataType> type); Review Comment: Is this used anymore? ########## cpp/src/arrow/engine/substrait/test_util.cc: ########## @@ -0,0 +1,129 @@ +// 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. + +// These utilities are for internal / unit test use only. +// They allow for the construction of simple Substrait plans +// programmatically without first requiring the construction +// of an ExecPlan + +// These utilities have to be here, and not in a test_util.cc +// file (or in a unit test) because only one .so is allowed +// to include each .pb.h file or else protobuf will encounter +// global namespace conflicts. + +#include "arrow/engine/substrait/test_util.h" + +#include "arrow/compute/exec/test_util.h" +#include "arrow/engine/substrait/extension_set.h" +#include "arrow/engine/substrait/serde.h" +#include "arrow/ipc/writer.h" + +namespace arrow { + +namespace engine { + +std::shared_ptr<DataType> StripFieldNames(std::shared_ptr<DataType> type) { + if (type->id() == Type::STRUCT) { + FieldVector fields(type->num_fields()); + for (int i = 0; i < type->num_fields(); ++i) { + fields[i] = type->field(i)->WithName(""); + } + return struct_(std::move(fields)); + } + + if (type->id() == Type::LIST) { + return list(type->field(0)->WithName("")); + } + + return type; +} + +void WriteIpcData(const std::string& path, + const std::shared_ptr<fs::FileSystem> file_system, + const std::shared_ptr<Table> input) { + EXPECT_OK_AND_ASSIGN(auto mmap, file_system->OpenOutputStream(path)); + ASSERT_OK_AND_ASSIGN( + auto file_writer, + MakeFileWriter(mmap, input->schema(), ipc::IpcWriteOptions::Defaults())); + TableBatchReader reader(input); + std::shared_ptr<RecordBatch> batch; + while (true) { + ASSERT_OK(reader.ReadNext(&batch)); + if (batch == nullptr) { + break; + } + ASSERT_OK(file_writer->WriteRecordBatch(*batch)); + } + ASSERT_OK(file_writer->Close()); +} + +Result<std::shared_ptr<Table>> GetTableFromPlan( Review Comment: This method is no longer needed now that we have `DeclarationToTable`. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
