Skip to content

Commit 442dce1

Browse files
eitsupizeroshadembrobbel
authored
fix(rust/core): fix build errror on windows and enable ci for windows (#3148)
Fix #3149 Close #3122 - adbc_snowflake tests for Windows fails so excluded. - Some tests of driver_manager are skipped because they fail for windows. --------- Co-authored-by: Matt Topol <zotthewizard@gmail.com> Co-authored-by: Matthijs Brobbel <m1brobbel@gmail.com>
1 parent 6148162 commit 442dce1

File tree

4 files changed

+95
-38
lines changed

4 files changed

+95
-38
lines changed

‎.github/workflows/rust.yml‎

Lines changed: 38 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,12 @@ jobs:
4444
rust:
4545
strategy:
4646
matrix:
47-
# TODO(alexandreyc): add `windows-latest`
4847
# See: https://github.com/apache/arrow-adbc/pull/1803#issuecomment-2117669300
4948
os:
5049
- macos-13
5150
- macos-latest
5251
- ubuntu-latest
52+
- windows-latest
5353
minimal-versions:
5454
- false
5555
include:
@@ -97,9 +97,24 @@ jobs:
9797
curl -L "https://github.com/protocolbuffers/protobuf/releases/download/v28.3/protoc-28.3-osx-universal_binary.zip" -o protoc.zip
9898
unzip "protoc.zip" -d $HOME/.local
9999
echo "$HOME/.local/bin" >> "$GITHUB_PATH"
100+
- name: Install Protoc
101+
if: runner.os == 'Windows'
102+
run: |
103+
curl -L "https://github.com/protocolbuffers/protobuf/releases/download/v28.3/protoc-28.3-win64.zip" -o protoc.zip
104+
unzip "protoc.zip" -d $HOME/.local
105+
echo "$HOME/.local/bin" >> "$GITHUB_PATH"
100106
- name: Install sqlite3
101107
if: runner.os == 'Linux'
102108
run: sudo apt-get install libsqlite3-dev
109+
- name: Setup conda
110+
uses: conda-incubator/setup-miniconda@835234971496cad1653abb28a638a281cf32541f # v3.2.0
111+
if: runner.os == 'Windows'
112+
with:
113+
miniforge-version: latest
114+
- name: Install Dependencies
115+
if: runner.os == 'Windows'
116+
run: |
117+
conda install -c conda-forge --file ci/conda_env_cpp.txt
103118
- name: Build C++/Go drivers
104119
run: |
105120
mkdir -p build
@@ -120,9 +135,10 @@ jobs:
120135
cmake --build . --target install
121136
popd
122137
- name: Set dynamic linker path
123-
if: matrix.os == 'ubuntu-latest'
138+
if: runner.os == 'Linux'
124139
run: |
125140
echo "LD_LIBRARY_PATH=${{ github.workspace }}/local/lib:$LD_LIBRARY_PATH" >> "$GITHUB_ENV"
141+
echo "ADBC_DRIVER_MANAGER_TEST_LIB=${{ github.workspace }}/local/lib/libadbc_driver_sqlite.so" >> "$GITHUB_ENV"
126142
- name: Set dynamic linker path
127143
if: matrix.os == 'macos-latest'
128144
run: |
@@ -133,9 +149,11 @@ jobs:
133149
run: |
134150
echo "DYLD_LIBRARY_PATH=/usr/local/opt/sqlite/lib:${{ github.workspace }}/local/lib:$DYLD_LIBRARY_PATH" >> "$GITHUB_ENV"
135151
echo "ADBC_DRIVER_MANAGER_TEST_LIB=${{ github.workspace }}/local/lib/libadbc_driver_sqlite.dylib" >> "$GITHUB_ENV"
136-
- name: Set test env var
137-
if: runner.os == 'Linux'
138-
run: echo "ADBC_DRIVER_MANAGER_TEST_LIB=${{ github.workspace }}/local/lib/libadbc_driver_sqlite.so" >> "$GITHUB_ENV"
152+
- name: Set dynamic linker path
153+
if: runner.os == 'Windows'
154+
run: |
155+
echo "PATH=${{ github.workspace }}/local/bin;${{ github.workspace }}/local/lib;$PATH" >> "$GITHUB_ENV"
156+
echo "ADBC_DRIVER_MANAGER_TEST_LIB=${{ github.workspace }}/local/bin/adbc_driver_sqlite.dll" >> "$GITHUB_ENV"
139157
- name: Set search dir for Snowflake Go lib
140158
run: echo "ADBC_SNOWFLAKE_GO_LIB_DIR=${{ github.workspace }}/local/lib" >> "$GITHUB_ENV"
141159
- name: Clippy
@@ -145,20 +163,29 @@ jobs:
145163
cargo clippy --workspace --all-targets --all-features --locked -- -Dwarnings
146164
- name: Test
147165
working-directory: rust
148-
run: |
149-
cargo test --all-targets --all-features --workspace ${{ matrix.minimal-versions && '--exclude adbc_datafusion' || '' }}
166+
# TODO: enable snowflake tests on windows
167+
run: >
168+
cargo test --all-targets --all-features --workspace
169+
${{ matrix.minimal-versions && '--exclude adbc_datafusion' || '' }}
170+
${{ runner.os == 'Windows' && '--exclude adbc_snowflake' || '' }}
150171
# env:
151172
# ADBC_SNOWFLAKE_TESTS: 1
152173
# ADBC_SNOWFLAKE_URI: ${{ secrets.SNOWFLAKE_URI }}
153174
# ADBC_SNOWFLAKE_SQL_DB: ADBC_TESTING
154175
- name: Doctests
155176
working-directory: rust
156-
run: |
157-
cargo test --doc --all-features --workspace ${{ matrix.minimal-versions && '--exclude adbc_datafusion' || '' }}
177+
# TODO: enable snowflake tests on windows
178+
run: >
179+
cargo test --doc --all-features --workspace
180+
${{ matrix.minimal-versions && '--exclude adbc_datafusion' || '' }}
181+
${{ runner.os == 'Windows' && '--exclude adbc_snowflake' || '' }}
158182
- name: Check docs
159183
working-directory: rust
160-
run: |
161-
cargo doc --all-features --workspace ${{ matrix.minimal-versions && '--exclude adbc_datafusion' || '' }}
184+
# TODO: enable snowflake tests on windows
185+
run: >
186+
cargo doc --all-features --workspace
187+
${{ matrix.minimal-versions && '--exclude adbc_datafusion' || '' }}
188+
${{ runner.os == 'Windows' && '--exclude adbc_snowflake' || '' }}
162189
- name: Verify MSRV (Minimum Supported Rust Version)
163190
if: matrix.os == 'ubuntu-latest' && ! matrix.minimal-versions
164191
working-directory: rust

‎rust/core/Cargo.toml‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,5 +52,9 @@ tempfile = "3.20.0"
5252
all-features = true
5353

5454
[target.'cfg(windows)'.dependencies]
55-
windows-sys = {version = ">= 0.59.0", features = ["Win32_UI_Shell"], optional = true}
55+
windows-sys = {version = ">= 0.59.0", features = [
56+
"Win32_UI_Shell",
57+
"Win32_Globalization",
58+
"Win32_System_Com",
59+
], optional = true}
5660
windows-registry = {version = ">= 0.5.3", optional = true}

‎rust/core/src/driver_manager.rs‎

Lines changed: 44 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -491,42 +491,51 @@ impl ManagedDriver {
491491
load_flags: LoadFlags,
492492
) -> Result<Self> {
493493
if load_flags & LOAD_FLAG_SEARCH_ENV != 0 {
494-
if let Ok(result) =
495-
Self::search_path_list(driver_path, LOAD_FLAG_SEARCH_ENV, entrypoint, version)
496-
{
494+
if let Ok(result) = Self::search_path_list(
495+
driver_path,
496+
get_search_paths(LOAD_FLAG_SEARCH_ENV),
497+
entrypoint,
498+
version,
499+
) {
497500
return Ok(result);
498501
}
499502
}
500503

501504
if load_flags & LOAD_FLAG_SEARCH_USER != 0 {
502505
// first check registry for the driver, then check the user config path
503506
if let Ok(result) = load_driver_from_registry(
504-
&windows_registry::CURRENT_USER,
507+
windows_registry::CURRENT_USER,
505508
driver_path.as_os_str(),
506509
entrypoint,
507510
) {
508511
return Self::load_dynamic_from_filename(result.lib_path, entrypoint, version);
509512
}
510513

511-
if let Ok(result) =
512-
Self::search_path_list(driver_path, LOAD_FLAG_SEARCH_USER, entrypoint, version)
513-
{
514+
if let Ok(result) = Self::search_path_list(
515+
driver_path,
516+
get_search_paths(LOAD_FLAG_SEARCH_USER),
517+
entrypoint,
518+
version,
519+
) {
514520
return Ok(result);
515521
}
516522
}
517523

518524
if load_flags & LOAD_FLAG_SEARCH_SYSTEM != 0 {
519525
if let Ok(result) = load_driver_from_registry(
520-
&windows_registry::LOCAL_MACHINE,
526+
windows_registry::LOCAL_MACHINE,
521527
driver_path.as_os_str(),
522528
entrypoint,
523529
) {
524530
return Self::load_dynamic_from_filename(result.lib_path, entrypoint, version);
525531
}
526532

527-
if let Ok(result) =
528-
Self::search_path_list(driver_path, LOAD_FLAG_SEARCH_SYSTEM, entrypoint, version)
529-
{
533+
if let Ok(result) = Self::search_path_list(
534+
driver_path,
535+
get_search_paths(LOAD_FLAG_SEARCH_SYSTEM),
536+
entrypoint,
537+
version,
538+
) {
530539
return Ok(result);
531540
}
532541
}
@@ -609,15 +618,24 @@ fn load_driver_from_registry(
609618
entrypoint: Option<&[u8]>,
610619
) -> Result<DriverInfo> {
611620
const ADBC_DRIVER_REGISTRY: &str = "SOFTWARE\\ADBC\\Drivers";
612-
let drivers_key = root.open(ADBC_DRIVER_REGISTRY)?;
621+
let drivers_key = root
622+
.open(ADBC_DRIVER_REGISTRY)
623+
.and_then(|k| k.open(driver_name.to_str().unwrap_or_default()))
624+
.map_err(|e| {
625+
Error::with_message_and_status(
626+
format!("Failed to open registry key: {e}"),
627+
Status::NotFound,
628+
)
629+
})?;
630+
631+
let entrypoint_val = drivers_key
632+
.get_string("entrypoint")
633+
.ok()
634+
.map(|s| s.into_bytes());
613635

614636
Ok(DriverInfo {
615-
driver_name: drivers_key.get_string("name").unwrap_or_default(),
616-
entrypoint: entrypoint
617-
.or_else(|| drivers_key.get_string("entrypoint").map(|e| e.into_bytes())),
618-
version: drivers_key.get_string("version").unwrap_or_default(),
619-
source: drivers_key.get_string("source").unwrap_or_default(),
620637
lib_path: PathBuf::from(drivers_key.get_string("driver").unwrap_or_default()),
638+
entrypoint: entrypoint_val.or_else(|| entrypoint.map(|s| s.to_vec())),
621639
})
622640
}
623641

@@ -1658,25 +1676,24 @@ impl Drop for ManagedStatement {
16581676
}
16591677
}
16601678

1661-
#[cfg(target_os = "windows")]
1662-
use windows_sys as windows;
1663-
16641679
#[cfg(target_os = "windows")]
16651680
mod target_windows {
1681+
use windows_sys as windows;
1682+
16661683
use std::ffi::c_void;
16671684
use std::ffi::OsString;
16681685
use std::os::windows::ffi::OsStringExt;
16691686
use std::path::PathBuf;
16701687
use std::slice;
16711688

1672-
use super::windows::Win32::UI::Shell;
1689+
use windows::Win32::UI::Shell;
16731690

16741691
// adapted from https://github.com/dirs-dev/dirs-sys-rs/blob/main/src/lib.rs#L150
1675-
fn user_config_dir() -> Option<PathBuf> {
1692+
pub fn user_config_dir() -> Option<PathBuf> {
16761693
unsafe {
16771694
let mut path_ptr: windows::core::PWSTR = std::ptr::null_mut();
16781695
let result = Shell::SHGetKnownFolderPath(
1679-
Shell::FOLDERID_LocalAppData,
1696+
&Shell::FOLDERID_LocalAppData,
16801697
0,
16811698
std::ptr::null_mut(),
16821699
&mut path_ptr,
@@ -1851,6 +1868,7 @@ mod tests {
18511868
(tmp_dir, manifest_path)
18521869
}
18531870

1871+
#[cfg_attr(target_os = "windows", ignore)] // TODO: remove this line after fixing
18541872
#[test]
18551873
fn test_default_entrypoint() {
18561874
for driver in [
@@ -1892,6 +1910,7 @@ mod tests {
18921910

18931911
#[test]
18941912
#[cfg_attr(not(feature = "driver_manager_test_lib"), ignore)]
1913+
#[cfg_attr(target_os = "windows", ignore)] // TODO: remove this line after fixing
18951914
fn test_load_driver_env() {
18961915
// ensure that we fail without the env var set
18971916
env::remove_var("ADBC_CONFIG_PATH");
@@ -1960,6 +1979,7 @@ mod tests {
19601979

19611980
#[test]
19621981
#[cfg_attr(not(feature = "driver_manager_test_lib"), ignore)]
1982+
#[cfg_attr(target_os = "windows", ignore)] // TODO: remove this line after fixing
19631983
fn test_disallow_env_config() {
19641984
let (tmp_dir, manifest_path) =
19651985
write_manifest_to_tempfile(PathBuf::from("sqlite.toml"), simple_manifest());
@@ -2092,6 +2112,7 @@ mod tests {
20922112
)),
20932113
ignore
20942114
)]
2115+
#[cfg_attr(target_os = "windows", ignore)] // TODO: remove this line after fixing
20952116
fn test_manifest_user_config() {
20962117
let err = ManagedDriver::load_from_name(
20972118
"adbc-test-sqlite",

‎rust/driver/snowflake/build.rs‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
use std::error::Error;
1919

2020
/// Build and link the Go driver statically.
21-
#[cfg(feature = "bundled")]
21+
#[cfg(all(not(target_os = "windows"), feature = "bundled"))]
2222
fn bundled() -> Result<(), Box<dyn Error>> {
2323
use std::{env, path::PathBuf, process::Command};
2424

@@ -33,6 +33,7 @@ fn bundled() -> Result<(), Box<dyn Error>> {
3333
let status = Command::new("go")
3434
.current_dir(go_pkg.as_path())
3535
.arg("build")
36+
.arg("-a")
3637
.arg("-tags")
3738
.arg("driverlib")
3839
.arg("-buildmode=c-archive")
@@ -50,7 +51,10 @@ fn bundled() -> Result<(), Box<dyn Error>> {
5051
println!("cargo:rustc-link-lib=static=snowflake");
5152

5253
// Link other dependencies.
54+
#[cfg(not(target_os = "windows"))]
5355
println!("cargo:rustc-link-lib=resolv");
56+
#[cfg(target_os = "windows")]
57+
println!("cargo:rustc-link-lib=legacy_stdio_definitions");
5458
#[cfg(target_os = "macos")]
5559
{
5660
println!("cargo:rustc-link-lib=framework=CoreFoundation");
@@ -70,7 +74,8 @@ fn linked() -> Result<(), Box<dyn Error>> {
7074
if let Some(path) = option_env!("ADBC_SNOWFLAKE_GO_LIB_DIR") {
7175
println!("cargo:rustc-link-search={path}");
7276
}
73-
77+
#[cfg(target_os = "windows")]
78+
println!("cargo:rustc-link-lib=legacy_stdio_definitions");
7479
// Link the driver.
7580
println!("cargo:rustc-link-lib=adbc_driver_snowflake");
7681

@@ -79,7 +84,7 @@ fn linked() -> Result<(), Box<dyn Error>> {
7984

8085
fn main() -> Result<(), Box<dyn Error>> {
8186
// Bundle the Go driver.
82-
#[cfg(feature = "bundled")]
87+
#[cfg(all(not(target_os = "windows"), feature = "bundled"))]
8388
bundled()?;
8489

8590
// Link the Go driver.

0 commit comments

Comments
 (0)