Skip to content

Extract postgres container from sqllogictest, update datafusion-testing pin #13971

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion datafusion-testing
Submodule datafusion-testing updated 49 files
+0 −4 data/sqlite/random/aggregates/slt_good_0.slt
+0 −6 data/sqlite/random/aggregates/slt_good_102.slt
+0 −2 data/sqlite/random/aggregates/slt_good_103.slt
+0 −2 data/sqlite/random/aggregates/slt_good_106.slt
+0 −2 data/sqlite/random/aggregates/slt_good_108.slt
+0 −2 data/sqlite/random/aggregates/slt_good_11.slt
+0 −4 data/sqlite/random/aggregates/slt_good_112.slt
+0 −2 data/sqlite/random/aggregates/slt_good_12.slt
+0 −2 data/sqlite/random/aggregates/slt_good_122.slt
+0 −4 data/sqlite/random/aggregates/slt_good_123.slt
+0 −2 data/sqlite/random/aggregates/slt_good_25.slt
+0 −2 data/sqlite/random/aggregates/slt_good_31.slt
+0 −2 data/sqlite/random/aggregates/slt_good_36.slt
+0 −2 data/sqlite/random/aggregates/slt_good_38.slt
+0 −2 data/sqlite/random/aggregates/slt_good_4.slt
+0 −2 data/sqlite/random/aggregates/slt_good_43.slt
+0 −2 data/sqlite/random/aggregates/slt_good_46.slt
+0 −2 data/sqlite/random/aggregates/slt_good_51.slt
+0 −2 data/sqlite/random/aggregates/slt_good_53.slt
+0 −2 data/sqlite/random/aggregates/slt_good_62.slt
+0 −2 data/sqlite/random/aggregates/slt_good_68.slt
+0 −2 data/sqlite/random/aggregates/slt_good_70.slt
+0 −4 data/sqlite/random/aggregates/slt_good_72.slt
+0 −2 data/sqlite/random/aggregates/slt_good_81.slt
+0 −2 data/sqlite/random/aggregates/slt_good_9.slt
+0 −2 data/sqlite/random/aggregates/slt_good_93.slt
+0 −2 data/sqlite/random/aggregates/slt_good_96.slt
+0 −2 data/sqlite/random/aggregates/slt_good_97.slt
+0 −1 data/sqlite/random/expr/slt_good_10.slt
+0 −1 data/sqlite/random/expr/slt_good_104.slt
+0 −1 data/sqlite/random/expr/slt_good_13.slt
+0 −1 data/sqlite/random/expr/slt_good_2.slt
+0 −1 data/sqlite/random/expr/slt_good_29.slt
+1 −1 data/sqlite/random/expr/slt_good_47.slt
+0 −92 data/sqlite/random/groupby/slt_good_0.slt
+0 −162 data/sqlite/random/groupby/slt_good_1.slt
+0 −102 data/sqlite/random/groupby/slt_good_10.slt
+0 −278 data/sqlite/random/groupby/slt_good_11.slt
+0 −288 data/sqlite/random/groupby/slt_good_12.slt
+0 −60 data/sqlite/random/groupby/slt_good_13.slt
+0 −142 data/sqlite/random/groupby/slt_good_2.slt
+0 −202 data/sqlite/random/groupby/slt_good_3.slt
+0 −236 data/sqlite/random/groupby/slt_good_4.slt
+0 −220 data/sqlite/random/groupby/slt_good_5.slt
+0 −32 data/sqlite/random/groupby/slt_good_6.slt
+0 −182 data/sqlite/random/groupby/slt_good_7.slt
+0 −112 data/sqlite/random/groupby/slt_good_8.slt
+0 −114 data/sqlite/random/groupby/slt_good_9.slt
+21,897 −32 data/sqlite/select4.slt
2 changes: 0 additions & 2 deletions datafusion/sqllogictest/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ indicatif = "0.17"
itertools = { workspace = true }
log = { workspace = true }
object_store = { workspace = true }
once_cell = { version = "1.20", optional = true }
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹

postgres-protocol = { version = "0.6.7", optional = true }
postgres-types = { version = "0.2.8", features = ["derive", "with-chrono-0_4"], optional = true }
rust_decimal = { version = "1.36.0", features = ["tokio-pg"] }
Expand All @@ -69,7 +68,6 @@ avro = ["datafusion/avro"]
postgres = [
"bytes",
"chrono",
"once_cell",
"postgres-types",
"postgres-protocol",
"testcontainers",
Expand Down
151 changes: 151 additions & 0 deletions datafusion/sqllogictest/bin/postgres_container.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
// 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.

#![cfg(feature = "postgres")]

use crate::Options;
use datafusion_common::Result;
use log::info;
use std::env::set_var;
use std::future::Future;
use std::sync::LazyLock;
use std::{env, thread};
use testcontainers::core::IntoContainerPort;
use testcontainers::runners::AsyncRunner;
use testcontainers::ImageExt;
use testcontainers_modules::postgres;
use tokio::sync::mpsc::{UnboundedReceiver, UnboundedSender};
use tokio::sync::{mpsc, Mutex};
use ContainerCommands::{FetchHost, FetchPort};

#[derive(Debug)]
pub enum ContainerCommands {
FetchHost,
FetchPort,
Stop,
}

pub struct Channel<T> {
pub tx: UnboundedSender<T>,
pub rx: Mutex<UnboundedReceiver<T>>,
}

pub fn channel<T>() -> Channel<T> {
let (tx, rx) = mpsc::unbounded_channel();
Channel {
tx,
rx: Mutex::new(rx),
}
}

pub fn execute_blocking<F: Future>(f: F) {
tokio::runtime::Builder::new_current_thread()
.enable_all()
.build()
.unwrap()
.block_on(f);
}

static POSTGRES_IN: LazyLock<Channel<ContainerCommands>> = LazyLock::new(channel);
static POSTGRES_HOST: LazyLock<Channel<String>> = LazyLock::new(channel);
static POSTGRES_PORT: LazyLock<Channel<u16>> = LazyLock::new(channel);
static POSTGRES_STOPPED: LazyLock<Channel<()>> = LazyLock::new(channel);

pub async fn initialize_postgres_container(options: &Options) -> Result<()> {
let start_pg_database = options.postgres_runner && !is_pg_uri_set();
if start_pg_database {
info!("Starting postgres db ...");

thread::spawn(|| {
execute_blocking(start_postgres(
&POSTGRES_IN,
&POSTGRES_HOST,
&POSTGRES_PORT,
&POSTGRES_STOPPED,
))
});

POSTGRES_IN.tx.send(FetchHost).unwrap();
let db_host = POSTGRES_HOST.rx.lock().await.recv().await.unwrap();

POSTGRES_IN.tx.send(FetchPort).unwrap();
let db_port = POSTGRES_PORT.rx.lock().await.recv().await.unwrap();

let pg_uri = format!("postgresql://postgres:postgres@{db_host}:{db_port}/test");
info!("Postgres uri is {pg_uri}");

set_var("PG_URI", pg_uri);
} else {
// close receiver
POSTGRES_IN.rx.lock().await.close();
}

Ok(())
}

pub async fn terminate_postgres_container() -> Result<()> {
if !POSTGRES_IN.tx.is_closed() {
println!("Stopping postgres db ...");
POSTGRES_IN.tx.send(ContainerCommands::Stop).unwrap_or(());
POSTGRES_STOPPED.rx.lock().await.recv().await;
}

Ok(())
}

async fn start_postgres(
in_channel: &Channel<ContainerCommands>,
host_channel: &Channel<String>,
port_channel: &Channel<u16>,
stopped_channel: &Channel<()>,
) {
info!("Starting postgres test container with user postgres/postgres and db test");

let container = postgres::Postgres::default()
.with_user("postgres")
.with_password("postgres")
.with_db_name("test")
.with_mapped_port(16432, 5432.tcp())
.with_tag("17-alpine")
.start()
.await
.unwrap();
// uncomment this if you are running docker in docker
let host = "host.docker.internal".to_string();
// let host = container.get_host().await.unwrap().to_string();
let port = container.get_host_port_ipv4(5432).await.unwrap();

let mut rx = in_channel.rx.lock().await;
while let Some(command) = rx.recv().await {
match command {
FetchHost => host_channel.tx.send(host.clone()).unwrap(),
FetchPort => port_channel.tx.send(port).unwrap(),
ContainerCommands::Stop => {
container.stop().await.unwrap();
stopped_channel.tx.send(()).unwrap();
rx.close();
}
}
}
}

fn is_pg_uri_set() -> bool {
match env::var("PG_URI") {
Ok(_) => true,
Err(_) => false,
}
}
148 changes: 8 additions & 140 deletions datafusion/sqllogictest/bin/sqllogictests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,33 +28,21 @@ use indicatif::{
use itertools::Itertools;
use log::Level::{Info, Warn};
use log::{info, log_enabled, warn};
#[cfg(feature = "postgres")]
use once_cell::sync::Lazy;
use sqllogictest::{
parse_file, strict_column_validator, AsyncDB, Condition, Normalizer, Record,
Validator,
};

#[cfg(feature = "postgres")]
use std::env::set_var;
use crate::postgres_container::{
initialize_postgres_container, terminate_postgres_container,
};
use std::ffi::OsStr;
use std::fs;
#[cfg(feature = "postgres")]
use std::future::Future;
use std::path::{Path, PathBuf};

#[cfg(feature = "postgres")]
use std::{env, thread};
#[cfg(feature = "postgres")]
use testcontainers::core::IntoContainerPort;
#[cfg(feature = "postgres")]
use testcontainers::runners::AsyncRunner;
#[cfg(feature = "postgres")]
use testcontainers::ImageExt;
#[cfg(feature = "postgres")]
use tokio::sync::mpsc::{UnboundedReceiver, UnboundedSender};
#[cfg(feature = "postgres")]
use tokio::sync::{mpsc, Mutex};
#[cfg(feature = "postgres")]
use ContainerCommands::{FetchHost, FetchPort};
mod postgres_container;

const TEST_DIRECTORY: &str = "test_files/";
const DATAFUSION_TESTING_TEST_DIRECTORY: &str = "../../datafusion-testing/data/";
Expand Down Expand Up @@ -170,31 +158,7 @@ async fn run_tests() -> Result<()> {
options.warn_on_ignored();

#[cfg(feature = "postgres")]
let start_pg_database = options.postgres_runner && !is_pg_uri_set();
#[cfg(feature = "postgres")]
if start_pg_database {
info!("Starting postgres db ...");

thread::spawn(|| {
execute_blocking(start_postgres(
&POSTGRES_IN,
&POSTGRES_HOST,
&POSTGRES_PORT,
&POSTGRES_STOPPED,
))
});

POSTGRES_IN.tx.send(FetchHost).unwrap();
let db_host = POSTGRES_HOST.rx.lock().await.recv().await.unwrap();

POSTGRES_IN.tx.send(FetchPort).unwrap();
let db_port = POSTGRES_PORT.rx.lock().await.recv().await.unwrap();

let pg_uri = format!("postgresql://postgres:postgres@{db_host}:{db_port}/test");
info!("Postgres uri is {pg_uri}");

set_var("PG_URI", pg_uri);
}
initialize_postgres_container(&options).await?;

// Run all tests in parallel, reporting failures at the end
//
Expand Down Expand Up @@ -277,11 +241,7 @@ async fn run_tests() -> Result<()> {
m.println(format!("Completed in {}", HumanDuration(start.elapsed())))?;

#[cfg(feature = "postgres")]
if start_pg_database {
println!("Stopping postgres db ...");
POSTGRES_IN.tx.send(ContainerCommands::Stop).unwrap_or(());
POSTGRES_STOPPED.rx.lock().await.recv().await;
}
terminate_postgres_container().await?;

// report on any errors
if !errors.is_empty() {
Expand All @@ -294,14 +254,6 @@ async fn run_tests() -> Result<()> {
}
}

#[cfg(feature = "postgres")]
fn is_pg_uri_set() -> bool {
match env::var("PG_URI") {
Ok(_) => true,
Err(_) => false,
}
}

async fn run_test_file(
test_file: TestFile,
validator: Validator,
Expand Down Expand Up @@ -758,87 +710,3 @@ impl Options {
}
}
}

#[cfg(feature = "postgres")]
pub async fn start_postgres(
in_channel: &Channel<ContainerCommands>,
host_channel: &Channel<String>,
port_channel: &Channel<u16>,
stopped_channel: &Channel<()>,
) {
info!("Starting postgres test container with user postgres/postgres and db test");

let container = testcontainers_modules::postgres::Postgres::default()
.with_user("postgres")
.with_password("postgres")
.with_db_name("test")
.with_mapped_port(16432, 5432.tcp())
.with_tag("17-alpine")
.start()
.await
.unwrap();
// uncomment this if you are running docker in docker
// let host = "host.docker.internal".to_string();
let host = container.get_host().await.unwrap().to_string();
let port = container.get_host_port_ipv4(5432).await.unwrap();

let mut rx = in_channel.rx.lock().await;
while let Some(command) = rx.recv().await {
match command {
FetchHost => host_channel.tx.send(host.clone()).unwrap(),
FetchPort => port_channel.tx.send(port).unwrap(),
ContainerCommands::Stop => {
container.stop().await.unwrap();
stopped_channel.tx.send(()).unwrap();
rx.close();
}
}
}
}

#[cfg(feature = "postgres")]
#[derive(Debug)]
pub enum ContainerCommands {
FetchHost,
FetchPort,
Stop,
}

#[cfg(feature = "postgres")]
pub struct Channel<T> {
pub tx: UnboundedSender<T>,
pub rx: Mutex<UnboundedReceiver<T>>,
}

#[cfg(feature = "postgres")]
pub fn channel<T>() -> Channel<T> {
let (tx, rx) = mpsc::unbounded_channel();
Channel {
tx,
rx: Mutex::new(rx),
}
}

#[cfg(feature = "postgres")]
pub fn execute_blocking<F: Future>(f: F) {
tokio::runtime::Builder::new_current_thread()
.enable_all()
.build()
.unwrap()
.block_on(f);
}

#[cfg(feature = "postgres")]
pub struct HostPort {
pub host: String,
pub port: u16,
}

#[cfg(feature = "postgres")]
static POSTGRES_IN: Lazy<Channel<ContainerCommands>> = Lazy::new(channel);
#[cfg(feature = "postgres")]
static POSTGRES_HOST: Lazy<Channel<String>> = Lazy::new(channel);
#[cfg(feature = "postgres")]
static POSTGRES_PORT: Lazy<Channel<u16>> = Lazy::new(channel);
#[cfg(feature = "postgres")]
static POSTGRES_STOPPED: Lazy<Channel<()>> = Lazy::new(channel);
1 change: 0 additions & 1 deletion datafusion/sqllogictest/src/engines/postgres_engine/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,6 @@ fn no_quotes(t: &str) -> &str {
fn schema_name(relative_path: &Path) -> String {
relative_path
.to_string_lossy()
.to_string()
.chars()
.filter(|ch| ch.is_ascii_alphanumeric())
.collect::<String>()
Expand Down
Loading