hive: Refactor static file creation

This commit is contained in:
Zhaofeng Li 2022-06-02 16:39:45 -07:00
parent 52d969425c
commit ac8852dcdf
2 changed files with 91 additions and 45 deletions

81
src/nix/hive/assets.rs Normal file
View file

@ -0,0 +1,81 @@
//! Static files required to evaluate a Hive configuation.
//!
//! We embed Nix expressions (eval.nix, options.nix, modules.nix) as well as
//! as the auto-rollback script (auto-rollback.sh) into the resulting binary
//! to ease distribution. The files are written to a temporary path when
//! we need to use them.
use std::fs::File;
use std::io::Write;
use std::os::unix::fs::OpenOptionsExt;
use tempfile::TempDir;
use super::HivePath;
const EVAL_NIX: &[u8] = include_bytes!("eval.nix");
const OPTIONS_NIX: &[u8] = include_bytes!("options.nix");
const MODULES_NIX: &[u8] = include_bytes!("modules.nix");
/// Static files required to evaluate a Hive configuration.
#[derive(Debug)]
pub(super) struct Assets {
/// Temporary directory holding the files.
temp_dir: TempDir,
}
impl Assets {
pub fn new() -> Self {
let temp_dir = TempDir::new().unwrap();
create_file(&temp_dir, "eval.nix", false, EVAL_NIX);
create_file(&temp_dir, "options.nix", false, OPTIONS_NIX);
create_file(&temp_dir, "modules.nix", false, MODULES_NIX);
Self {
temp_dir,
}
}
/// Returns the base expression from which the evaluated Hive can be used.
pub fn get_base_expression(&self, hive_path: &HivePath) -> String {
match hive_path {
HivePath::Legacy(path) => {
format!(
"with builtins; let eval = import {eval_nix}; hive = eval {{ rawHive = import {path}; colmenaOptions = import {options_nix}; colmenaModules = import {modules_nix}; }}; in ",
path = path.to_str().unwrap(),
eval_nix = self.get_path("eval.nix"),
options_nix = self.get_path("options.nix"),
modules_nix = self.get_path("modules.nix"),
)
}
HivePath::Flake(flake) => {
format!(
"with builtins; let eval = import {eval_nix}; hive = eval {{ flakeUri = \"{flake_uri}\"; colmenaOptions = import {options_nix}; colmenaModules = import {modules_nix}; }}; in ",
flake_uri = flake.uri(),
eval_nix = self.get_path("eval.nix"),
options_nix = self.get_path("options.nix"),
modules_nix = self.get_path("modules.nix"),
)
}
}
}
fn get_path(&self, name: &str) -> String {
self.temp_dir.path().join(name)
.to_str().unwrap().to_string()
}
}
fn create_file(base: &TempDir, name: &str, executable: bool, contents: &[u8]) {
let mode = if executable { 0o700 } else { 0o600 };
let path = base.path().join(name);
let mut f = File::options()
.create_new(true)
.write(true)
.mode(mode)
.open(path)
.unwrap();
f.write_all(contents).unwrap();
}

View file

@ -1,3 +1,8 @@
mod assets;
#[cfg(test)]
mod tests;
use std::collections::HashMap; use std::collections::HashMap;
use std::io::Write; use std::io::Write;
use std::path::{Path, PathBuf}; use std::path::{Path, PathBuf};
@ -23,13 +28,7 @@ use super::deployment::TargetNode;
use crate::error::ColmenaResult; use crate::error::ColmenaResult;
use crate::util::{CommandExecution, CommandExt}; use crate::util::{CommandExecution, CommandExt};
use crate::job::JobHandle; use crate::job::JobHandle;
use assets::Assets;
#[cfg(test)]
mod tests;
const HIVE_EVAL: &[u8] = include_bytes!("eval.nix");
const HIVE_OPTIONS: &[u8] = include_bytes!("options.nix");
const HIVE_MODULES: &[u8] = include_bytes!("modules.nix");
#[derive(Debug)] #[derive(Debug)]
pub enum HivePath { pub enum HivePath {
@ -53,14 +52,8 @@ pub struct Hive {
/// or "flake.nix". /// or "flake.nix".
context_dir: Option<PathBuf>, context_dir: Option<PathBuf>,
/// Path to temporary file containing eval.nix. /// Static files required to evaluate a Hive configuration.
eval_nix: TempPath, assets: Assets,
/// Path to temporary file containing options.nix.
options_nix: TempPath,
/// Path to temporary file containing modules.nix.
modules_nix: TempPath,
/// Whether to pass --show-trace in Nix commands. /// Whether to pass --show-trace in Nix commands.
show_trace: bool, show_trace: bool,
@ -118,21 +111,12 @@ impl HivePath {
impl Hive { impl Hive {
pub fn new(path: HivePath) -> ColmenaResult<Self> { pub fn new(path: HivePath) -> ColmenaResult<Self> {
let mut eval_nix = NamedTempFile::new()?;
let mut options_nix = NamedTempFile::new()?;
let mut modules_nix = NamedTempFile::new()?;
eval_nix.write_all(HIVE_EVAL).unwrap();
options_nix.write_all(HIVE_OPTIONS).unwrap();
modules_nix.write_all(HIVE_MODULES).unwrap();
let context_dir = path.context_dir(); let context_dir = path.context_dir();
Ok(Self { Ok(Self {
path, path,
context_dir, context_dir,
eval_nix: eval_nix.into_temp_path(), assets: Assets::new(),
options_nix: options_nix.into_temp_path(),
modules_nix: modules_nix.into_temp_path(),
show_trace: false, show_trace: false,
machines_file: RwLock::new(None), machines_file: RwLock::new(None),
}) })
@ -353,26 +337,7 @@ impl Hive {
/// Returns the base expression from which the evaluated Hive can be used. /// Returns the base expression from which the evaluated Hive can be used.
fn get_base_expression(&self) -> String { fn get_base_expression(&self) -> String {
match self.path() { self.assets.get_base_expression(self.path())
HivePath::Legacy(path) => {
format!(
"with builtins; let eval = import {}; hive = eval {{ rawHive = import {}; colmenaOptions = import {}; colmenaModules = import {}; }}; in ",
self.eval_nix.to_str().unwrap(),
path.to_str().unwrap(),
self.options_nix.to_str().unwrap(),
self.modules_nix.to_str().unwrap(),
)
}
HivePath::Flake(flake) => {
format!(
"with builtins; let eval = import {}; hive = eval {{ flakeUri = \"{}\"; colmenaOptions = import {}; colmenaModules = import {}; }}; in ",
self.eval_nix.to_str().unwrap(),
flake.uri(),
self.options_nix.to_str().unwrap(),
self.modules_nix.to_str().unwrap(),
)
}
}
} }
/// Returns whether this Hive is a flake. /// Returns whether this Hive is a flake.