difftreelog
feat support imports from fifo on unix
in: master
3 files changed
crates/jrsonnet-evaluator/src/import.rsdiffbeforeafterboth1use std::{2 any::Any,3 cell::RefCell,4 env::current_dir,5 fs,6 io::{ErrorKind, Read},7 path::{Path, PathBuf},8};910use fs::File;11use jrsonnet_gcmodule::Trace;12use jrsonnet_parser::{SourceDirectory, SourceFile, SourcePath};1314use crate::{15 bail,16 error::{ErrorKind::*, Result},17};1819/// Implements file resolution logic for `import` and `importStr`20pub trait ImportResolver: Trace {21 /// Resolves file path, e.g. `(/home/user/manifests, b.libjsonnet)` can correspond22 /// both to `/home/user/manifests/b.libjsonnet` and to `/home/user/${vendor}/b.libjsonnet`23 /// where `${vendor}` is a library path.24 ///25 /// `from` should only be returned from [`ImportResolver::resolve`], or from other defined file, any other value26 /// may result in panic27 fn resolve_from(&self, from: &SourcePath, path: &str) -> Result<SourcePath> {28 bail!(ImportNotSupported(from.clone(), path.into()))29 }30 fn resolve_from_default(&self, path: &str) -> Result<SourcePath> {31 self.resolve_from(&SourcePath::default(), path)32 }33 /// Resolves absolute path, doesn't supports jpath and other fancy things34 fn resolve(&self, path: &Path) -> Result<SourcePath> {35 bail!(AbsoluteImportNotSupported(path.to_owned()))36 }3738 /// Load resolved file39 /// This should only be called with value returned from [`ImportResolver::resolve_file`]/[`ImportResolver::resolve`],40 /// this cannot be resolved using associated type, as evaluator uses object instead of generic for [`ImportResolver`]41 fn load_file_contents(&self, resolved: &SourcePath) -> Result<Vec<u8>>;4243 /// For downcasts44 fn as_any(&self) -> &dyn Any;45}4647/// Dummy resolver, can't resolve/load any file48#[derive(Trace)]49pub struct DummyImportResolver;50impl ImportResolver for DummyImportResolver {51 fn load_file_contents(&self, _resolved: &SourcePath) -> Result<Vec<u8>> {52 panic!("dummy resolver can't load any file")53 }5455 fn as_any(&self) -> &dyn Any {56 self57 }58}59#[allow(clippy::use_self)]60impl Default for Box<dyn ImportResolver> {61 fn default() -> Self {62 Box::new(DummyImportResolver)63 }64}6566/// File resolver, can load file from both FS and library paths67#[derive(Default, Trace)]68pub struct FileImportResolver {69 /// Library directories to search for file.70 /// Referred to as `jpath` in original jsonnet implementation.71 library_paths: RefCell<Vec<PathBuf>>,72}73impl FileImportResolver {74 pub fn new(jpath: Vec<PathBuf>) -> Self {75 Self {76 library_paths: RefCell::new(jpath),77 }78 }79 /// Dynamically add new jpath, used by bindings80 pub fn add_jpath(&self, path: PathBuf) {81 self.library_paths.borrow_mut().push(path);82 }83}8485impl ImportResolver for FileImportResolver {86 fn resolve_from(&self, from: &SourcePath, path: &str) -> Result<SourcePath> {87 let mut direct = if let Some(f) = from.downcast_ref::<SourceFile>() {88 let mut o = f.path().to_owned();89 o.pop();90 o91 } else if let Some(d) = from.downcast_ref::<SourceDirectory>() {92 d.path().to_owned()93 } else if from.is_default() {94 current_dir().map_err(|e| ImportIo(e.to_string()))?95 } else {96 unreachable!("resolver can't return this path")97 };98 direct.push(path);99 if direct.is_file() {100 Ok(SourcePath::new(SourceFile::new(101 direct.canonicalize().map_err(|e| ImportIo(e.to_string()))?,102 )))103 } else {104 for library_path in self.library_paths.borrow().iter() {105 let mut cloned = library_path.clone();106 cloned.push(path);107 if cloned.exists() {108 return Ok(SourcePath::new(SourceFile::new(109 cloned.canonicalize().map_err(|e| ImportIo(e.to_string()))?,110 )));111 }112 }113 bail!(ImportFileNotFound(from.clone(), path.to_owned()))114 }115 }116 fn resolve(&self, path: &Path) -> Result<SourcePath> {117 let meta = match fs::metadata(path) {118 Ok(v) => v,119 Err(e) if e.kind() == ErrorKind::NotFound => {120 bail!(AbsoluteImportFileNotFound(path.to_owned()))121 }122 Err(e) => bail!(ImportIo(e.to_string())),123 };124 if meta.is_file() {125 Ok(SourcePath::new(SourceFile::new(126 path.canonicalize().map_err(|e| ImportIo(e.to_string()))?,127 )))128 } else if meta.is_dir() {129 Ok(SourcePath::new(SourceDirectory::new(130 path.canonicalize().map_err(|e| ImportIo(e.to_string()))?,131 )))132 } else {133 unreachable!("this can't be a symlink")134 }135 }136137 fn load_file_contents(&self, id: &SourcePath) -> Result<Vec<u8>> {138 let path = if let Some(f) = id.downcast_ref::<SourceFile>() {139 f.path()140 } else if id.downcast_ref::<SourceDirectory>().is_some() || id.is_default() {141 bail!(ImportIsADirectory(id.clone()))142 } else {143 unreachable!("other types are not supported in resolve");144 };145 let mut file = File::open(path).map_err(|_e| ResolvedFileNotFound(id.clone()))?;146 let mut out = Vec::new();147 file.read_to_end(&mut out)148 .map_err(|e| ImportIo(e.to_string()))?;149 Ok(out)150 }151152 fn as_any(&self) -> &dyn Any {153 self154 }155156 fn resolve_from_default(&self, path: &str) -> Result<SourcePath> {157 self.resolve_from(&SourcePath::default(), path)158 }159}crates/jrsonnet-parser/src/lib.rsdiffbeforeafterboth--- a/crates/jrsonnet-parser/src/lib.rs
+++ b/crates/jrsonnet-parser/src/lib.rs
@@ -11,7 +11,9 @@
mod source;
mod unescape;
pub use location::CodeLocation;
-pub use source::{Source, SourceDirectory, SourceFile, SourcePath, SourcePathT, SourceVirtual};
+pub use source::{
+ Source, SourceDirectory, SourceFifo, SourceFile, SourcePath, SourcePathT, SourceVirtual,
+};
pub struct ParserSettings {
pub source: Source,
crates/jrsonnet-parser/src/source.rsdiffbeforeafterboth--- a/crates/jrsonnet-parser/src/source.rs
+++ b/crates/jrsonnet-parser/src/source.rs
@@ -7,7 +7,7 @@
};
use jrsonnet_gcmodule::{Trace, Tracer};
-use jrsonnet_interner::IStr;
+use jrsonnet_interner::{IBytes, IStr};
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};
#[cfg(feature = "structdump")]
@@ -75,6 +75,7 @@
/// - [`SourceFile`] - for any file
/// - [`SourceDirectory`] - for resolution from CWD
/// - [`SourceVirtual`] - for stdlib/ext-str
+/// - [`SourceFifo`] - for /dev/fd/X (This path may appear with `jrsonnet <(command_that_produces_jsonnet)`)
///
/// From all of those, only [`SourceVirtual`] may be constructed manually, any other path kind should be only obtained
/// from assigned `ImportResolver`
@@ -254,6 +255,37 @@
any_ext_impl!(SourcePathT);
}
+/// Represents resolved FIFO file, those files may only be read once, and this type is only used for
+/// unix, where user might want to do `jrsonnet <(command_that_produces_jsonnet_source)`
+/// In most cases, user most probably want to use `jrsonnet -` instead of `jrsonnet /dev/stdin`
+/// for better cross-platform support.
+// PartialEq is limited to ptr equality
+#[allow(clippy::derived_hash_with_manual_eq)]
+#[derive(Trace, Debug, Hash)]
+pub struct SourceFifo(pub String, pub IBytes);
+impl PartialEq for SourceFifo {
+ fn eq(&self, other: &Self) -> bool {
+ std::ptr::eq(self, other)
+ }
+}
+impl fmt::Display for SourceFifo {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ write!(f, "fifo({:?})", self.0)
+ }
+}
+impl SourcePathT for SourceFifo {
+ fn is_default(&self) -> bool {
+ // In case of FD input, user won't expect relative paths to be resolved from /dev/fd/
+ true
+ }
+
+ fn path(&self) -> Option<&Path> {
+ None
+ }
+
+ any_ext_impl!(SourcePathT);
+}
+
/// Either real file, or virtual
/// Hash of FileName always have same value as raw Path, to make it possible to use with raw_entry_mut
#[cfg_attr(feature = "structdump", derive(Codegen))]