skilj 0.1.0

SkilJ: a Rust library for building event-sourced, DDD-style applications backed by Postgres, exposing a GraphQL surface and a REST surface. A thin facade over skilj-core/skilj-graphql/skilj-rest - see docs/architecture.md §3.1.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
//! Codeberg issue #100 - a supported single-user local mode.
//!
//! `postgresql_embedded` (already used by the test harnesses) starts a
//! real Postgres 18 server in a data directory of this process's own,
//! creates one database, and hands back its URL. Nothing here is a
//! different storage engine or an in-memory shortcut: it is the same
//! Postgres schema, migrations and behaviour as a production deployment,
//! with the server owned by this process.
//!
//! The data directory persists between runs by default (`cleanup: false`);
//! `cleanup: true` deletes it when
//! [`LocalPostgres::shutdown`](crate::local::LocalPostgres::shutdown) runs
//! (or on `Drop`, via `postgresql_embedded`'s own `temporary` setting). The
//! server listens on `127.0.0.1` only (`listen_addresses`), never on a
//! network interface.
//!
//! **The password is a real secret.** The login is the cluster's
//! superuser, and anyone who can log in as a Postgres superuser can run
//! programs as the user the server runs as (`COPY ... TO PROGRAM`) and read
//! every private field in plaintext. Listening on `127.0.0.1` keeps other
//! machines out, not other processes or users on this one. So the password
//! is generated randomly (256 bits) on first start and kept in
//! `<data_dir>.pgpass`, readable by the owner only (`0600` on Unix), and
//! read back on every later start so the same data directory keeps working.
//!
//! **The Postgres major version is pinned** ([`postgres_version`](crate::local::postgres_version)). A data
//! directory can only be opened by the major version that created it; left
//! unpinned, `postgresql_embedded` installs the newest release it finds, so
//! a new machine or a cleared install cache could fetch a newer major and
//! fail to start on existing data. Moving to a newer major is a deliberate
//! dump-and-restore, not something a dependency update should do.
//!
//! Enabled by the `local` feature, so a consuming application that
//! already brings its own Postgres pays nothing for it.

use postgresql_embedded::{PostgreSQL, Settings, VersionReq};
use std::io::Write;
use std::path::{Path, PathBuf};
use std::time::Duration;

/// `postgresql_embedded` always initializes the `postgres` role
/// (`BOOTSTRAP_SUPERUSER`).
const LOCAL_USER: &str = "postgres";
const DEFAULT_DATABASE: &str = "skilj";

/// The Postgres major version local mode installs and runs: any 18.x, never
/// 19. See this module's own docs.
pub fn postgres_version() -> VersionReq {
    postgresql_embedded::V18.clone()
}

/// Where and how [`LocalPostgres::start`] runs its server.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct LocalConfig {
    /// Where Postgres keeps its data. Created if missing.
    pub data_dir: PathBuf,
    /// `None`/`Some(0)` asks Postgres for an ephemeral port.
    pub port: Option<u16>,
    /// The database skilj uses, created if missing.
    pub database: String,
    /// Delete `data_dir` on shutdown.
    pub cleanup: bool,
}

impl Default for LocalConfig {
    fn default() -> Self {
        Self {
            data_dir: default_data_dir(),
            port: None,
            database: DEFAULT_DATABASE.to_string(),
            cleanup: false,
        }
    }
}

impl LocalConfig {
    /// `SKILJ_LOCAL_DATA_DIR`, `SKILJ_LOCAL_PORT`, `SKILJ_LOCAL_DATABASE`
    /// and `SKILJ_LOCAL_CLEANUP` (`true`/`1`), with the defaults above for
    /// anything unset. A malformed value is an error rather than silently
    /// ignored, so a typo never starts a server somewhere unexpected.
    pub fn from_env() -> Result<Self, Error> {
        let mut config = Self::default();
        if let Some(value) = std::env::var_os("SKILJ_LOCAL_DATA_DIR") {
            config.data_dir = PathBuf::from(value);
        }
        if let Some(value) = std::env::var_os("SKILJ_LOCAL_PORT") {
            let value = value.to_string_lossy();
            config.port = Some(value.parse().map_err(|_| Error::InvalidConfig {
                variable: "SKILJ_LOCAL_PORT".to_string(),
                value: value.to_string(),
            })?);
        }
        if let Some(value) = std::env::var_os("SKILJ_LOCAL_DATABASE") {
            config.database = value.to_string_lossy().to_string();
        }
        if let Some(value) = std::env::var_os("SKILJ_LOCAL_CLEANUP") {
            let value = value.to_string_lossy();
            config.cleanup = match value.to_ascii_lowercase().as_str() {
                "1" | "true" | "yes" | "on" => true,
                "0" | "false" | "no" | "off" => false,
                _ => {
                    return Err(Error::InvalidConfig {
                        variable: "SKILJ_LOCAL_CLEANUP".to_string(),
                        value: value.to_string(),
                    })
                }
            };
        }
        config.validate()?;
        Ok(config)
    }

    /// Rejects a database name that cannot be safely placed in the URL
    /// and `CREATE DATABASE` statement. Called by [from_env](Self::from_env)
    /// and [start](LocalPostgres::start), so a hand-built config is
    /// checked too.
    pub fn validate(&self) -> Result<(), Error> {
        if self.database.is_empty()
            || !self
                .database
                .chars()
                .all(|c| c.is_ascii_alphanumeric() || c == '_' || c == '-')
        {
            return Err(Error::InvalidDatabase {
                database: self.database.clone(),
            });
        }
        Ok(())
    }
}

/// The platform's per-user data directory, `skilj/postgresql` under it:
/// `%LOCALAPPDATA%`, else `$XDG_DATA_HOME`, else `~/.local/share`.
pub fn default_data_dir() -> PathBuf {
    if let Some(local_app_data) = std::env::var_os("LOCALAPPDATA") {
        return PathBuf::from(local_app_data)
            .join("skilj")
            .join("postgresql");
    }
    if let Some(xdg) = std::env::var_os("XDG_DATA_HOME") {
        return PathBuf::from(xdg).join("skilj").join("postgresql");
    }
    if let Some(home) = std::env::var_os("HOME") {
        return PathBuf::from(home)
            .join(".local")
            .join("share")
            .join("skilj")
            .join("postgresql");
    }
    PathBuf::from(".skilj").join("postgresql")
}

enum Backend {
    Embedded(Box<PostgreSQL>),
    /// System server binaries run as the `postgres` user, for when this
    /// process is root - which `initdb`/`postgres` refuse to run as.
    System {
        bin_dir: PathBuf,
    },
}

/// A running local Postgres. Keep it alive for as long as the `Skilj`
/// built against its URL is in use; call [shutdown](Self::shutdown) (or
/// drop it) to stop the server.
pub struct LocalPostgres {
    server: Backend,
    database_url: String,
    display_url: String,
    data_dir: PathBuf,
    cleanup: bool,
}

/// `<data_dir>.pgpass` - outside `data_dir`, because `initdb` refuses a
/// directory that already has anything in it.
pub fn password_file(data_dir: &Path) -> PathBuf {
    data_dir.with_extension("pgpass")
}

/// Reads the password from `path`, or, the first time, generates one and
/// writes it there owner-only. `postgresql_embedded` only writes its own
/// password file when none exists, so creating it here first is what
/// decides its permissions. An existing file readable by anyone else is
/// narrowed to owner-only rather than trusted as is.
pub fn load_or_create_password(path: &Path) -> Result<String, Error> {
    let io_error = |source| Error::Io {
        path: path.to_path_buf(),
        source,
    };
    if path.exists() {
        restrict_to_owner(path).map_err(io_error)?;
        let password = std::fs::read_to_string(path).map_err(io_error)?;
        let password = password.trim().to_string();
        if password.is_empty() {
            return Err(Error::EmptyPasswordFile {
                path: path.to_path_buf(),
            });
        }
        return Ok(password);
    }
    let password = skilj_core::shared::generate_token_secret();
    let mut options = std::fs::OpenOptions::new();
    options.write(true).create_new(true);
    #[cfg(unix)]
    {
        use std::os::unix::fs::OpenOptionsExt;
        options.mode(0o600);
    }
    let mut file = options.open(path).map_err(io_error)?;
    file.write_all(password.as_bytes()).map_err(io_error)?;
    Ok(password)
}

#[cfg(unix)]
fn restrict_to_owner(path: &Path) -> std::io::Result<()> {
    use std::os::unix::fs::PermissionsExt;
    let mode = std::fs::metadata(path)?.permissions().mode();
    if mode & 0o077 != 0 {
        std::fs::set_permissions(path, std::fs::Permissions::from_mode(0o600))?;
    }
    Ok(())
}

/// On Windows the file lives under the user's own profile directory, whose
/// default ACL already keeps other users out.
#[cfg(not(unix))]
fn restrict_to_owner(_path: &Path) -> std::io::Result<()> {
    Ok(())
}

impl LocalPostgres {
    /// Installs (first run only), initializes, starts, and creates the
    /// configured database if it does not exist yet.
    pub async fn start(config: LocalConfig) -> Result<Self, Error> {
        config.validate()?;
        if running_as_root() {
            return Self::start_system(config).await;
        }
        Self::start_embedded(config).await
    }

    async fn start_embedded(config: LocalConfig) -> Result<Self, Error> {
        std::fs::create_dir_all(&config.data_dir).map_err(|source| Error::Io {
            path: config.data_dir.clone(),
            source,
        })?;

        let password_file = password_file(&config.data_dir);
        let password = load_or_create_password(&password_file)?;

        let mut settings = Settings::new();
        settings.version = postgres_version();
        settings.data_dir = config.data_dir.clone();
        settings.password_file = password_file;
        settings.host = "127.0.0.1".to_string();
        // `host` only shapes the URL; this is what the server binds to.
        settings
            .configuration
            .insert("listen_addresses".to_string(), "127.0.0.1".to_string());
        settings.port = config.port.unwrap_or(0);
        settings.username = LOCAL_USER.to_string();
        settings.password = password.clone();
        // `temporary` is `postgresql_embedded`'s own cleanup switch; a
        // persistent local mode leaves it false, a throwaway one true.
        settings.temporary = config.cleanup;
        settings.timeout = Some(Duration::from_secs(60));

        let mut server = PostgreSQL::new(settings);
        server.setup().await?;
        server.start().await?;
        if !server.database_exists(&config.database).await? {
            server.create_database(&config.database).await?;
        }
        let database_url = server.settings().url(&config.database);
        let display_url = database_url.replace(&password, "***");
        Ok(Self {
            server: Backend::Embedded(Box::new(server)),
            database_url,
            display_url,
            data_dir: config.data_dir,
            cleanup: config.cleanup,
        })
    }

    /// Root fallback: `initdb` and `postgres` refuse to run as root, so
    /// the system's server binaries are run as the `postgres` user via
    /// `runuser` - the same arrangement as `scripts/ci-postgres-local.sh`
    /// and `skilj_test_support::FailoverServer`.
    ///
    /// Same login rules as the embedded path: TCP on `127.0.0.1` needs the
    /// random password from `<data_dir>.pgpass` (`scram-sha-256`), set by
    /// `initdb` itself. This process's own setup commands use a Unix socket
    /// in `<data_dir>.sockets`, owner-only, with `peer` authentication - so
    /// only the operating-system user `postgres` gets in that way. Never
    /// `trust`: on a shared machine that would let any local process in as
    /// superuser with no password at all.
    async fn start_system(config: LocalConfig) -> Result<Self, Error> {
        let existing_major = std::fs::read_to_string(config.data_dir.join("PG_VERSION"))
            .ok()
            .and_then(|version| version.trim().parse::<u32>().ok());
        let bin_dir = system_pg_bin(existing_major).ok_or_else(|| Error::InvalidConfig {
            variable: "SKILJ_TEST_PGBIN".to_string(),
            value: "running as root, and no system PostgreSQL server binaries were found (install `postgresql`, or set SKILJ_TEST_PGBIN)".to_string(),
        })?;
        // Outside `data_dir`: `initdb` refuses a directory that already has
        // anything in it.
        let socket_dir = config.data_dir.with_extension("sockets");
        // Root hands these to `postgres`; a symlink planted at either path
        // (a data directory in a shared, writable place) would hand over
        // whatever it points at instead.
        refuse_symlink(&config.data_dir)?;
        refuse_symlink(&socket_dir)?;
        std::fs::create_dir_all(&config.data_dir).map_err(|source| Error::Io {
            path: config.data_dir.clone(),
            source,
        })?;
        chown_to_postgres(&config.data_dir).await?;
        std::fs::create_dir_all(&socket_dir).map_err(|source| Error::Io {
            path: socket_dir.clone(),
            source,
        })?;
        set_owner_only_dir(&socket_dir)?;
        chown_to_postgres(&socket_dir).await?;

        let password = load_or_create_password(&password_file(&config.data_dir))?;
        if existing_major.is_none() {
            // `initdb` reads the superuser password from a file it can open
            // as `postgres`; the `.pgpass` file stays root-only, so this is a
            // short-lived owner-only copy, removed straight after.
            let pwfile = config.data_dir.with_extension("initpw");
            let _ = std::fs::remove_file(&pwfile);
            {
                let mut options = std::fs::OpenOptions::new();
                options.write(true).create_new(true);
                #[cfg(unix)]
                {
                    use std::os::unix::fs::OpenOptionsExt;
                    options.mode(0o600);
                }
                let io_error = |source| Error::Io {
                    path: pwfile.clone(),
                    source,
                };
                let mut file = options.open(&pwfile).map_err(io_error)?;
                file.write_all(password.as_bytes()).map_err(io_error)?;
            }
            let initialized = async {
                chown_to_postgres(&pwfile).await?;
                let mut initdb = as_postgres(&bin_dir, "initdb");
                initdb
                    .args([
                        "--auth-host=scram-sha-256",
                        "--auth-local=peer",
                        "-U",
                        LOCAL_USER,
                    ])
                    .arg(format!("--pwfile={}", pwfile.display()))
                    .arg("-D")
                    .arg(&config.data_dir);
                run_as_postgres_output(&mut initdb).await
            }
            .await;
            let _ = std::fs::remove_file(&pwfile);
            initialized?;
        } else {
            refuse_trust_authentication(&config.data_dir)?;
        }

        let port = match config.port {
            Some(port) if port != 0 => port,
            _ => free_port()?,
        };
        let options = format!(
            "-F -p {port} -k {} -c listen_addresses=127.0.0.1",
            socket_dir.display()
        );
        let log = config.data_dir.with_extension("log");
        let mut start = as_postgres(&bin_dir, "pg_ctl");
        start
            .args(["start", "-w", "-t", "60", "-D"])
            .arg(&config.data_dir)
            .arg("-l")
            .arg(&log)
            .arg("-o")
            .arg(&options);
        run_as_postgres_output(&mut start).await?;
        let socket = socket_dir.display().to_string();
        let port_arg = port.to_string();
        // `config.validate` already restricts the name to ASCII letters,
        // digits, `_` and `-`, so interpolating it is safe.
        let check = format!(
            "SELECT 1 FROM pg_database WHERE datname='{}'",
            config.database
        );
        let mut query = as_postgres(&bin_dir, "psql");
        query.args([
            "-h", &socket, "-p", &port_arg, "-U", LOCAL_USER, "-d", "postgres", "-tAc", &check,
        ]);
        let exists = run_as_postgres_output(&mut query).await?;
        if String::from_utf8_lossy(&exists.stdout).trim() != "1" {
            let mut createdb = as_postgres(&bin_dir, "createdb");
            createdb
                .args(["-h", &socket, "-p", &port_arg, "-U", LOCAL_USER])
                .arg(&config.database);
            run_as_postgres_output(&mut createdb).await?;
        }
        let database_url = format!(
            "postgres://{LOCAL_USER}:{password}@127.0.0.1:{port}/{}",
            config.database
        );
        let display_url = database_url.replace(&password, "***");
        Ok(Self {
            server: Backend::System { bin_dir },
            database_url,
            display_url,
            data_dir: config.data_dir,
            cleanup: config.cleanup,
        })
    }

    /// The connection URL, **including the superuser password** - pass it
    /// to `Skilj`, never print or log it; use [display_url](Self::display_url)
    /// for that.
    pub fn database_url(&self) -> &str {
        &self.database_url
    }

    /// [database_url](Self::database_url) with the password replaced by
    /// `***`, safe to print.
    pub fn display_url(&self) -> &str {
        &self.display_url
    }

    /// Where this server keeps its data.
    pub fn data_dir(&self) -> &Path {
        &self.data_dir
    }

    /// Stops the server, and removes the data directory when
    /// `cleanup` was requested.
    pub async fn shutdown(self) -> Result<(), Error> {
        match &self.server {
            Backend::Embedded(server) => {
                server.stop().await?;
            }
            Backend::System { bin_dir, .. } => {
                let mut stop = as_postgres(bin_dir, "pg_ctl");
                // `fast`, not `immediate`: a clean shutdown, so the next
                // start needs no crash recovery.
                stop.args(["stop", "-m", "fast", "-w", "-D"])
                    .arg(&self.data_dir);
                run_as_postgres_output(&mut stop).await?;
            }
        }
        drop(self.server);
        if self.cleanup {
            // Everything this mode keeps next to the data directory too -
            // above all the password file, which must not outlive the data.
            for path in [
                self.data_dir.clone(),
                password_file(&self.data_dir),
                self.data_dir.with_extension("sockets"),
                self.data_dir.with_extension("log"),
            ] {
                let removed = if path.is_dir() {
                    std::fs::remove_dir_all(&path)
                } else {
                    std::fs::remove_file(&path)
                };
                match removed {
                    Ok(()) => {}
                    Err(source) if source.kind() == std::io::ErrorKind::NotFound => {}
                    Err(source) => return Err(Error::Io { path, source }),
                }
            }
        }
        Ok(())
    }
}

/// `program` from `bin_dir` run as the `postgres` user.
fn as_postgres(bin_dir: &Path, program: &str) -> tokio::process::Command {
    let mut command = tokio::process::Command::new("runuser");
    command
        .args(["-u", "postgres", "--"])
        .arg(bin_dir.join(program));
    command
}

async fn run_as_postgres_output(
    command: &mut tokio::process::Command,
) -> Result<std::process::Output, Error> {
    let output = command.output().await.map_err(|source| Error::Io {
        path: PathBuf::from("runuser -u postgres"),
        source,
    })?;
    if output.status.success() {
        Ok(output)
    } else {
        Err(Error::Command {
            command: "runuser -u postgres".to_string(),
            stdout: String::from_utf8_lossy(&output.stdout).to_string(),
            stderr: String::from_utf8_lossy(&output.stderr).to_string(),
        })
    }
}

fn free_port() -> Result<u16, Error> {
    std::net::TcpListener::bind("127.0.0.1:0")
        .and_then(|listener| listener.local_addr())
        .map(|address| address.port())
        .map_err(Error::IoSocket)
}

async fn chown_to_postgres(path: &Path) -> Result<(), Error> {
    run_as_postgres_output(
        // `-h`: change a symlink itself, never what it points at.
        tokio::process::Command::new("chown")
            .arg("-h")
            .arg("postgres:postgres")
            .arg(path),
    )
    .await
    .map(|_| ())
}

fn refuse_symlink(path: &Path) -> Result<(), Error> {
    match std::fs::symlink_metadata(path) {
        Ok(metadata) if metadata.file_type().is_symlink() => Err(Error::SymbolicLink {
            path: path.to_path_buf(),
        }),
        _ => Ok(()),
    }
}

#[cfg(unix)]
fn set_owner_only_dir(path: &Path) -> Result<(), Error> {
    use std::os::unix::fs::PermissionsExt;
    std::fs::set_permissions(path, std::fs::Permissions::from_mode(0o700)).map_err(|source| {
        Error::Io {
            path: path.to_path_buf(),
            source,
        }
    })
}

#[cfg(not(unix))]
fn set_owner_only_dir(_path: &Path) -> Result<(), Error> {
    Ok(())
}

/// A data directory an earlier development build initialized with `trust`
/// authentication lets any local process in as superuser. Refused rather
/// than silently kept; it has no password to migrate to.
fn refuse_trust_authentication(data_dir: &Path) -> Result<(), Error> {
    let hba = data_dir.join("pg_hba.conf");
    let Ok(contents) = std::fs::read_to_string(&hba) else {
        return Ok(());
    };
    let trusts = contents.lines().any(|line| {
        let line = line.split('#').next().unwrap_or("");
        line.split_whitespace().any(|word| word == "trust")
    });
    if trusts {
        return Err(Error::TrustAuthentication { path: hba });
    }
    Ok(())
}

/// Whether this process runs as root, which Postgres refuses to.
fn running_as_root() -> bool {
    std::process::Command::new("id")
        .arg("-u")
        .output()
        .is_ok_and(|output| String::from_utf8_lossy(&output.stdout).trim() == "0")
}

/// The system's Postgres server binaries: `SKILJ_TEST_PGBIN`; else, for
/// an existing data directory, the `/usr/lib/postgresql/<major>/bin` that
/// matches its `PG_VERSION` (a data directory only opens under the major
/// version that created it); else the newest one there (Debian's layout);
/// else wherever `pg_ctl` is on the `PATH`.
fn system_pg_bin(existing_major: Option<u32>) -> Option<PathBuf> {
    if let Ok(dir) = std::env::var("SKILJ_TEST_PGBIN") {
        return Some(dir.into());
    }
    if let Some(major) = existing_major {
        let bin = PathBuf::from(format!("/usr/lib/postgresql/{major}/bin"));
        if bin.join("pg_ctl").exists() {
            return Some(bin);
        }
    }
    let newest = std::fs::read_dir("/usr/lib/postgresql")
        .ok()
        .into_iter()
        .flatten()
        .filter_map(|entry| {
            let entry = entry.ok()?;
            let version: u32 = entry.file_name().to_string_lossy().parse().ok()?;
            let bin = entry.path().join("bin");
            bin.join("pg_ctl").exists().then_some((version, bin))
        })
        .max_by_key(|(version, _)| *version)
        .map(|(_, bin)| bin);
    newest.or_else(|| {
        let output = std::process::Command::new("sh")
            .args(["-c", "command -v pg_ctl"])
            .output()
            .ok()?;
        let path = String::from_utf8_lossy(&output.stdout).trim().to_string();
        std::path::Path::new(&path)
            .parent()
            .map(|dir| dir.to_path_buf())
    })
}

/// Why local mode could not start or stop its server.
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum Error {
    /// The embedded server failed to install, start or stop.
    #[error("local Postgres: {0}")]
    Embedded(#[from] postgresql_embedded::Error),

    /// A system Postgres command (root mode) exited unsuccessfully.
    #[error("local Postgres: {command} failed: stdout={stdout} stderr={stderr}")]
    Command {
        /// The program that failed.
        command: String,
        /// Its standard output.
        stdout: String,
        /// Its standard error.
        stderr: String,
    },

    /// No free local port could be found.
    #[error("local Postgres: cannot bind a socket: {0}")]
    IoSocket(#[source] std::io::Error),

    /// A file or directory local mode manages could not be used.
    #[error("local Postgres: {path}: {source}")]
    Io {
        /// The file or directory.
        path: PathBuf,
        /// What went wrong.
        #[source]
        source: std::io::Error,
    },

    /// An environment variable (or the system binaries it names) is not
    /// usable.
    #[error("local Postgres: {variable}={value:?} is not valid")]
    InvalidConfig {
        /// The variable's name.
        variable: String,
        /// Its value, or why nothing usable was found.
        value: String,
    },

    /// The configured database name has characters other than ASCII
    /// letters, digits, `_` and `-`.
    #[error(
        "local Postgres: database name {database:?} must be ASCII letters, digits, '_' or '-'"
    )]
    InvalidDatabase {
        /// The refused name.
        database: String,
    },

    /// The password file exists but holds no password.
    #[error("local Postgres: password file {path} is empty")]
    EmptyPasswordFile {
        /// The password file.
        path: PathBuf,
    },

    /// Running as root, the data or socket directory is a symbolic link,
    /// which root would hand to the `postgres` user.
    #[error(
        "local Postgres: {path} is a symbolic link; running as root, local mode only uses a \
         real directory"
    )]
    SymbolicLink {
        /// The linked path.
        path: PathBuf,
    },

    /// An existing data directory allows `trust` logins.
    #[error(
        "local Postgres: {path} allows `trust` logins, which let any local process in as \
         superuser without a password; this data directory was initialized by an earlier \
         development build - move it aside and start again"
    )]
    TrustAuthentication {
        /// The data directory's `pg_hba.conf`.
        path: PathBuf,
    },
}

#[cfg(test)]
mod tests {
    use super::*;

    fn temp_path(label: &str) -> PathBuf {
        let dir = std::env::temp_dir().join(format!(
            "skilj-local-unit-{label}-{}",
            skilj_core::shared::generate_token_id()
        ));
        std::fs::create_dir_all(&dir).unwrap();
        dir.join("data.pgpass")
    }

    #[test]
    fn a_first_start_generates_a_random_password() {
        let first = load_or_create_password(&temp_path("a")).unwrap();
        let second = load_or_create_password(&temp_path("b")).unwrap();
        assert_eq!(first.len(), 64, "256 bits, hex-encoded");
        assert_ne!(first, second);
    }

    #[test]
    fn a_later_start_reads_the_same_password_back() {
        let path = temp_path("reuse");
        let created = load_or_create_password(&path).unwrap();
        assert_eq!(load_or_create_password(&path).unwrap(), created);
    }

    #[cfg(unix)]
    #[test]
    fn the_password_file_is_owner_only() {
        use std::os::unix::fs::PermissionsExt;
        let path = temp_path("mode");
        load_or_create_password(&path).unwrap();
        let mode = std::fs::metadata(&path).unwrap().permissions().mode();
        assert_eq!(mode & 0o777, 0o600);
    }

    #[cfg(unix)]
    #[test]
    fn an_existing_world_readable_file_is_narrowed() {
        use std::os::unix::fs::PermissionsExt;
        let path = temp_path("narrow");
        std::fs::write(&path, "existing-password\n").unwrap();
        std::fs::set_permissions(&path, std::fs::Permissions::from_mode(0o644)).unwrap();
        assert_eq!(load_or_create_password(&path).unwrap(), "existing-password");
        let mode = std::fs::metadata(&path).unwrap().permissions().mode();
        assert_eq!(mode & 0o777, 0o600);
    }

    #[test]
    fn an_empty_password_file_is_refused() {
        let path = temp_path("empty");
        std::fs::write(&path, "\n").unwrap();
        assert!(matches!(
            load_or_create_password(&path),
            Err(Error::EmptyPasswordFile { .. })
        ));
    }

    #[test]
    fn a_data_directory_with_trust_logins_is_refused() {
        let dir = temp_path("hba").with_extension("");
        std::fs::create_dir_all(&dir).unwrap();
        let hba = dir.join("pg_hba.conf");
        std::fs::write(&hba, "# trust is mentioned in a comment only\nlocal all all peer\nhost all all 127.0.0.1/32 scram-sha-256\n").unwrap();
        assert!(refuse_trust_authentication(&dir).is_ok());
        std::fs::write(&hba, "host all all 127.0.0.1/32 trust\n").unwrap();
        assert!(matches!(
            refuse_trust_authentication(&dir),
            Err(Error::TrustAuthentication { .. })
        ));
    }

    #[test]
    fn the_major_version_is_pinned() {
        let version = postgres_version();
        assert!(version.matches(&postgresql_embedded::Version::new(18, 1, 0)));
        assert!(!version.matches(&postgresql_embedded::Version::new(19, 0, 0)));
    }
}