Something went wrong. Try again.
Native PostgreSQL driver / client for Zig
Something went wrong. Try again.
pg.zig build.zig
7.9 kB · 176 lines
Zig
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177const std = @import("std");
pub fn build(b: *std.Build) !void { const target = b.standardTargetOptions(.{}); const optimize = b.standardOptimizeOption(.{});
// setup our dependencies const dep_opts = .{ .target = target, .optimize = optimize };
const openssl_lib_name = b.option([]const u8, "openssl_lib_name", ""); const openssl_lib_path = b.option(std.Build.LazyPath, "openssl_lib_path", ""); const openssl_include_path = b.option(std.Build.LazyPath, "openssl_include_path", ""); const openssl = b.option(bool, "openssl", "Enable OpenSSL/TLS support") orelse (openssl_lib_name != null or openssl_lib_path != null or openssl_include_path != null);
// When openssl is not enabled, skip translate-c entirely and substitute // an empty stub module. Otherwise the build fails on hosts/targets where // <openssl/ssl.h> isn't reachable — e.g. when -Dtarget switches Zig into // cross-compile mode and stops searching the system include paths. const openssl_module = if (openssl) blk: { const Translator = @import("translate_c").Translator; const translate_c = b.dependency("translate_c", .{}); const t: Translator = .init(translate_c, .{ .c_source_file = b.path("src/openssl.h"), .target = target, .optimize = optimize, }); if (openssl_include_path) |p| t.addIncludePath(p); break :blk t.mod; } else b.createModule(.{ .root_source_file = b.path("src/openssl_stub.zig") });
// Expose this as a module that others can import const pg_module = b.addModule("pg", .{ .target = target, .optimize = optimize, .root_source_file = b.path("src/pg.zig"), .imports = &.{ .{ .name = "buffer", .module = b.dependency("buffer", dep_opts).module("buffer") }, .{ .name = "metrics", .module = b.dependency("metrics", dep_opts).module("metrics") }, .{ .name = "openssl", .module = openssl_module }, }, });
if (openssl) { if (openssl_lib_path) |p| pg_module.addLibraryPath(p); pg_module.linkSystemLibrary("crypto", .{}); pg_module.linkSystemLibrary(openssl_lib_name orelse "ssl", .{}); pg_module.link_libc = true; }
var column_names = false; const column_names_opt = b.option(bool, "column_names", "");
if (column_names_opt) |val| { column_names = val; }
{ const options = b.addOptions(); options.addOption(bool, "openssl", openssl); options.addOption(bool, "column_names", column_names); pg_module.addOptions("config", options); }
{ // test step — always built with openssl enabled const Translator = @import("translate_c").Translator; const translate_c = b.dependency("translate_c", .{}); const t: Translator = .init(translate_c, .{ .c_source_file = b.path("src/openssl.h"), .target = target, .optimize = optimize, }); if (openssl_include_path) |p| t.addIncludePath(p);
const lib_test = b.addTest(.{ .root_module = b.createModule(.{ .target = target, .optimize = optimize, .root_source_file = b.path("src/pg.zig"), .imports = &.{ .{ .name = "buffer", .module = b.dependency("buffer", dep_opts).module("buffer") }, .{ .name = "metrics", .module = b.dependency("metrics", dep_opts).module("metrics") }, .{ .name = "openssl", .module = t.mod }, }, }), .test_runner = .{ .path = b.path("test_runner.zig"), .mode = .simple }, }); if (openssl_lib_path) |p| lib_test.root_module.addLibraryPath(p); lib_test.root_module.linkSystemLibrary("crypto", .{}); lib_test.root_module.linkSystemLibrary("ssl", .{});
{ const options = b.addOptions(); options.addOption(bool, "openssl", true); options.addOption(bool, "column_names", false); lib_test.root_module.addOptions("config", options); }
const run_test = b.addRunArtifact(lib_test); run_test.has_side_effects = true;
const test_step = b.step("test", "Run unit tests"); test_step.dependOn(&run_test.step); }
{ // `zig build test` compiles exactly one configuration -- openssl=true, // column_names=false -- and never compiles example/ at all, since that // is its own build root. Both can hide a compile error behind a green // test run. These are not dead paths: `has_openssl` selects a different // Stream type (stream.zig) and `column_names` changes Conn.Opts. // // This step compiles all four permutations plus example/ without // running anything, so it needs no database. const check_step = b.step("check", "compile every build-config permutation (no database needed)");
for ([_]bool{ false, true }) |ssl| { for ([_]bool{ false, true }) |cols| { const ssl_module = if (ssl) blk: { const Translator = @import("translate_c").Translator; const tc: Translator = .init(b.dependency("translate_c", .{}), .{ .c_source_file = b.path("src/openssl.h"), .target = target, .optimize = optimize, }); if (openssl_include_path) |p| tc.addIncludePath(p); break :blk tc.mod; } else b.createModule(.{ .root_source_file = b.path("src/openssl_stub.zig") });
const variant = b.addTest(.{ .root_module = b.createModule(.{ .target = target, .optimize = optimize, .root_source_file = b.path("src/pg.zig"), .imports = &.{ .{ .name = "buffer", .module = b.dependency("buffer", dep_opts).module("buffer") }, .{ .name = "metrics", .module = b.dependency("metrics", dep_opts).module("metrics") }, .{ .name = "openssl", .module = ssl_module }, }, }), .test_runner = .{ .path = b.path("test_runner.zig"), .mode = .simple }, }); if (ssl) { if (openssl_lib_path) |p| variant.root_module.addLibraryPath(p); variant.root_module.linkSystemLibrary("crypto", .{}); variant.root_module.linkSystemLibrary(openssl_lib_name orelse "ssl", .{}); } // t.zig reads PG_TEST_HOST/PG_TEST_PORT via std.c.getenv, so the // test build needs libc regardless of the openssl permutation. variant.root_module.link_libc = true;
const options = b.addOptions(); options.addOption(bool, "openssl", ssl); options.addOption(bool, "column_names", cols); variant.root_module.addOptions("config", options);
// depend on the compile step, not a run step: we want the // analysis, not the suite four more times check_step.dependOn(&variant.step); } }
const example = b.addExecutable(.{ .name = "example", .root_module = b.createModule(.{ .target = target, .optimize = optimize, .root_source_file = b.path("example/main.zig"), .imports = &.{.{ .name = "pg", .module = pg_module }}, }), }); check_step.dependOn(&example.step); }}