1#![cfg_attr(feature = "unstable", feature(stmt_expr_attributes))]2#![allow(macro_expanded_macro_exports_accessed_by_absolute_paths)]34mod builtin;5mod ctx;6mod dynamic;7pub mod error;8mod evaluate;9mod function;10mod import;11mod integrations;12mod map;13mod obj;14pub mod trace;15mod val;1617pub use ctx::*;18pub use dynamic::*;19use error::{Error::*, LocError, Result, StackTraceElement};20pub use evaluate::*;21pub use function::parse_function_call;22pub use import::*;23use jrsonnet_parser::*;24pub use obj::*;25use std::{26 cell::{Ref, RefCell, RefMut},27 collections::HashMap,28 fmt::Debug,29 path::PathBuf,30 rc::Rc,31};32use trace::{offset_to_location, CodeLocation, CompactFormat, TraceFormat};33pub use val::*;3435type BindableFn = dyn Fn(Option<ObjValue>, Option<ObjValue>) -> Result<LazyVal>;36#[derive(Clone)]37pub enum LazyBinding {38 Bindable(Rc<BindableFn>),39 Bound(LazyVal),40}4142impl Debug for LazyBinding {43 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {44 write!(f, "LazyBinding")45 }46}47impl LazyBinding {48 pub fn evaluate(&self, this: Option<ObjValue>, super_obj: Option<ObjValue>) -> Result<LazyVal> {49 match self {50 LazyBinding::Bindable(v) => v(this, super_obj),51 LazyBinding::Bound(v) => Ok(v.clone()),52 }53 }54}5556#[derive(Clone)]57pub enum ManifestFormat {58 Yaml(usize),59 Json(usize),60 None,61}6263pub struct EvaluationSettings {64 65 pub max_stack: usize,66 67 pub max_trace: usize,68 69 pub ext_vars: HashMap<Rc<str>, Val>,70 71 pub tla_vars: HashMap<Rc<str>, Val>,72 73 pub globals: HashMap<Rc<str>, Val>,74 75 pub import_resolver: Box<dyn ImportResolver>,76 77 pub manifest_format: ManifestFormat,78 79 pub trace_format: Box<dyn TraceFormat>,80}81impl Default for EvaluationSettings {82 fn default() -> Self {83 EvaluationSettings {84 max_stack: 200,85 max_trace: 20,86 globals: Default::default(),87 ext_vars: Default::default(),88 tla_vars: Default::default(),89 import_resolver: Box::new(DummyImportResolver),90 manifest_format: ManifestFormat::Json(4),91 trace_format: Box::new(CompactFormat {92 padding: 4,93 resolver: trace::PathResolver::Absolute,94 }),95 }96 }97}9899#[derive(Default)]100struct EvaluationData {101 102 stack_depth: usize,103 104 105 files: HashMap<Rc<PathBuf>, FileData>,106 str_files: HashMap<Rc<PathBuf>, Rc<str>>,107}108109pub struct FileData {110 source_code: Rc<str>,111 parsed: LocExpr,112 evaluated: Option<Val>,113}114#[derive(Default)]115pub struct EvaluationStateInternals {116 117 data: RefCell<EvaluationData>,118 119 settings: RefCell<EvaluationSettings>,120}121122thread_local! {123 124 125 pub(crate) static EVAL_STATE: RefCell<Option<EvaluationState>> = RefCell::new(None)126}127pub(crate) fn with_state<T>(f: impl FnOnce(&EvaluationState) -> T) -> T {128 EVAL_STATE.with(|s| f(s.borrow().as_ref().unwrap()))129}130pub(crate) fn push<T>(131 e: &Option<ExprLocation>,132 frame_desc: impl FnOnce() -> String,133 f: impl FnOnce() -> Result<T>,134) -> Result<T> {135 if let Some(v) = e {136 with_state(|s| s.push(&v, frame_desc, f))137 } else {138 f()139 }140}141142143#[derive(Default, Clone)]144pub struct EvaluationState(Rc<EvaluationStateInternals>);145146impl EvaluationState {147 148 pub fn add_file(&self, path: Rc<PathBuf>, source_code: Rc<str>) -> Result<()> {149 self.add_parsed_file(150 path.clone(),151 source_code.clone(),152 parse(153 &source_code,154 &ParserSettings {155 file_name: path.clone(),156 loc_data: true,157 },158 )159 .map_err(|error| ImportSyntaxError {160 error,161 path,162 source_code,163 })?,164 )?;165166 Ok(())167 }168169 170 pub fn add_parsed_file(171 &self,172 name: Rc<PathBuf>,173 source_code: Rc<str>,174 parsed: LocExpr,175 ) -> Result<()> {176 self.data_mut().files.insert(177 name,178 FileData {179 source_code,180 parsed,181 evaluated: None,182 },183 );184185 Ok(())186 }187 pub fn get_source(&self, name: &PathBuf) -> Option<Rc<str>> {188 let ro_map = &self.data().files;189 ro_map.get(name).map(|value| value.source_code.clone())190 }191 pub fn map_source_locations(&self, file: &PathBuf, locs: &[usize]) -> Vec<CodeLocation> {192 offset_to_location(&self.get_source(file).unwrap(), locs)193 }194195 pub(crate) fn import_file(&self, from: &PathBuf, path: &PathBuf) -> Result<Val> {196 let file_path = self.resolve_file(from, path)?;197 {198 let files = &self.data().files;199 if files.contains_key(&file_path) {200 return self.evaluate_loaded_file_raw(&file_path);201 }202 }203 let contents = self.load_file_contents(&file_path)?;204 self.add_file(file_path.clone(), contents)?;205 self.evaluate_loaded_file_raw(&file_path)206 }207 pub(crate) fn import_file_str(&self, from: &PathBuf, path: &PathBuf) -> Result<Rc<str>> {208 let path = self.resolve_file(from, path)?;209 if !self.data().str_files.contains_key(&path) {210 let file_str = self.load_file_contents(&path)?;211 self.data_mut().str_files.insert(path.clone(), file_str);212 }213 Ok(self.data().str_files.get(&path).cloned().unwrap())214 }215216 fn evaluate_loaded_file_raw(&self, name: &PathBuf) -> Result<Val> {217 let expr: LocExpr = {218 let ro_map = &self.data().files;219 let value = ro_map220 .get(name)221 .unwrap_or_else(|| panic!("file not added: {:?}", name));222 if let Some(ref evaluated) = value.evaluated {223 return Ok(evaluated.clone());224 }225 value.parsed.clone()226 };227 let value = evaluate(self.create_default_context()?, &expr)?;228 {229 self.data_mut()230 .files231 .get_mut(name)232 .unwrap()233 .evaluated234 .replace(value.clone());235 }236 Ok(value)237 }238239 240 pub fn with_stdlib(&self) -> &Self {241 use jrsonnet_stdlib::STDLIB_STR;242 let std_path = Rc::new(PathBuf::from("std.jsonnet"));243 self.run_in_state(|| {244 self.add_parsed_file(245 std_path.clone(),246 STDLIB_STR.to_owned().into(),247 builtin::get_parsed_stdlib(),248 )249 .unwrap();250 let val = self.evaluate_loaded_file_raw(&std_path).unwrap();251 self.settings_mut().globals.insert("std".into(), val);252 });253 self254 }255256 257 pub fn create_default_context(&self) -> Result<Context> {258 let globals = &self.settings().globals;259 let mut new_bindings: HashMap<Rc<str>, LazyBinding> = HashMap::new();260 for (name, value) in globals.iter() {261 new_bindings.insert(262 name.clone(),263 LazyBinding::Bound(resolved_lazy_val!(value.clone())),264 );265 }266 Context::new().extend_unbound(new_bindings, None, None, None)267 }268269 270 pub fn push<T>(271 &self,272 e: &ExprLocation,273 frame_desc: impl FnOnce() -> String,274 f: impl FnOnce() -> Result<T>,275 ) -> Result<T> {276 {277 let mut data = self.data_mut();278 let stack_depth = &mut data.stack_depth;279 if *stack_depth > self.max_stack() {280 281 drop(data);282 throw!(StackOverflow);283 } else {284 *stack_depth += 1;285 }286 }287 let result = f();288 self.data_mut().stack_depth -= 1;289 if let Err(mut err) = result {290 (err.1).0.push(StackTraceElement {291 location: e.clone(),292 desc: frame_desc(),293 });294 return Err(err);295 }296 result297 }298299 300 pub fn run_in_state<T>(&self, f: impl FnOnce() -> T) -> T {301 EVAL_STATE.with(|v| {302 let has_state = v.borrow().is_some();303 if !has_state {304 v.borrow_mut().replace(self.clone());305 }306 let result = f();307 if !has_state {308 v.borrow_mut().take();309 }310 result311 })312 }313314 pub fn stringify_err(&self, e: &LocError) -> String {315 let mut out = String::new();316 self.settings()317 .trace_format318 .write_trace(&mut out, self, e)319 .unwrap();320 out321 }322323 pub fn manifest(&self, val: Val) -> Result<Rc<str>> {324 self.run_in_state(|| {325 Ok(match self.manifest_format() {326 ManifestFormat::Yaml(padding) => val.into_yaml(padding)?,327 ManifestFormat::Json(padding) => val.into_json(padding)?,328 ManifestFormat::None => match val {329 Val::Str(s) => s,330 _ => throw!(StringManifestOutputIsNotAString),331 },332 })333 })334 }335336 337 pub fn with_tla(&self, val: Val) -> Result<Val> {338 Ok(match val {339 Val::Func(func) => func.evaluate_map(340 self.create_default_context()?,341 &self.settings().tla_vars,342 true,343 )?,344 v => v,345 })346 }347}348349350impl EvaluationState {351 fn data(&self) -> Ref<EvaluationData> {352 self.0.data.borrow()353 }354 fn data_mut(&self) -> RefMut<EvaluationData> {355 self.0.data.borrow_mut()356 }357 pub fn settings(&self) -> Ref<EvaluationSettings> {358 self.0.settings.borrow()359 }360 pub fn settings_mut(&self) -> RefMut<EvaluationSettings> {361 self.0.settings.borrow_mut()362 }363}364365366impl EvaluationState {367 pub fn evaluate_file_raw(&self, name: &PathBuf) -> Result<Val> {368 self.run_in_state(|| self.import_file(&std::env::current_dir().expect("cwd"), &name))369 }370 pub fn evaluate_file_raw_nocwd(&self, name: &PathBuf) -> Result<Val> {371 self.run_in_state(|| self.import_file(&PathBuf::from("."), &name))372 }373 374 pub fn evaluate_snippet_raw(&self, source: Rc<PathBuf>, code: Rc<str>) -> Result<Val> {375 let parsed = parse(376 &code,377 &ParserSettings {378 file_name: source.clone(),379 loc_data: true,380 },381 )382 .unwrap();383 self.add_parsed_file(source, code, parsed.clone())?;384 self.evaluate_expr_raw(parsed)385 }386 387 pub fn evaluate_expr_raw(&self, code: LocExpr) -> Result<Val> {388 self.run_in_state(|| evaluate(self.create_default_context()?, &code))389 }390}391392393impl EvaluationState {394 pub fn add_ext_var(&self, name: Rc<str>, value: Val) {395 self.settings_mut().ext_vars.insert(name, value);396 }397 pub fn add_ext_str(&self, name: Rc<str>, value: Rc<str>) {398 self.add_ext_var(name, Val::Str(value));399 }400 pub fn add_ext_code(&self, name: Rc<str>, code: Rc<str>) -> Result<()> {401 let value =402 self.evaluate_snippet_raw(Rc::new(PathBuf::from(format!("ext_code {}", name))), code)?;403 self.add_ext_var(name, value);404 Ok(())405 }406407 pub fn add_tla(&self, name: Rc<str>, value: Val) {408 self.settings_mut().tla_vars.insert(name, value);409 }410 pub fn add_tla_str(&self, name: Rc<str>, value: Rc<str>) {411 self.add_tla(name, Val::Str(value));412 }413 pub fn add_tla_code(&self, name: Rc<str>, code: Rc<str>) -> Result<()> {414 let value =415 self.evaluate_snippet_raw(Rc::new(PathBuf::from(format!("tla_code {}", name))), code)?;416 self.add_ext_var(name, value);417 Ok(())418 }419420 pub fn resolve_file(&self, from: &PathBuf, path: &PathBuf) -> Result<Rc<PathBuf>> {421 Ok(self.settings().import_resolver.resolve_file(from, path)?)422 }423 pub fn load_file_contents(&self, path: &PathBuf) -> Result<Rc<str>> {424 Ok(self.settings().import_resolver.load_file_contents(path)?)425 }426427 pub fn import_resolver(&self) -> Ref<dyn ImportResolver> {428 Ref::map(self.settings(), |s| &*s.import_resolver)429 }430 pub fn set_import_resolver(&self, resolver: Box<dyn ImportResolver>) {431 self.settings_mut().import_resolver = resolver;432 }433434 pub fn manifest_format(&self) -> ManifestFormat {435 self.settings().manifest_format.clone()436 }437 pub fn set_manifest_format(&self, format: ManifestFormat) {438 self.settings_mut().manifest_format = format;439 }440441 pub fn trace_format(&self) -> Ref<dyn TraceFormat> {442 Ref::map(self.settings(), |s| &*s.trace_format)443 }444 pub fn set_trace_format(&self, format: Box<dyn TraceFormat>) {445 self.settings_mut().trace_format = format;446 }447448 pub fn max_trace(&self) -> usize {449 self.settings().max_trace450 }451 pub fn set_max_trace(&self, trace: usize) {452 self.settings_mut().max_trace = trace;453 }454455 pub fn max_stack(&self) -> usize {456 self.settings().max_stack457 }458 pub fn set_max_stack(&self, trace: usize) {459 self.settings_mut().max_stack = trace;460 }461}462463#[cfg(test)]464pub mod tests {465 use super::Val;466 use crate::{error::Error::*, primitive_equals, EvaluationState};467 use jrsonnet_parser::*;468 use std::{path::PathBuf, rc::Rc};469470 #[test]471 #[should_panic]472 fn eval_state_stacktrace() {473 let state = EvaluationState::default();474 state.run_in_state(|| {475 state476 .push(477 &ExprLocation(Rc::new(PathBuf::from("test1.jsonnet")), 10, 20),478 || "outer".to_owned(),479 || {480 state.push(481 &ExprLocation(Rc::new(PathBuf::from("test2.jsonnet")), 30, 40),482 || "inner".to_owned(),483 || Err(RuntimeError("".into()).into()),484 )?;485 Ok(())486 },487 )488 .unwrap();489 });490 }491492 #[test]493 fn eval_state_standard() {494 let state = EvaluationState::default();495 state.with_stdlib();496 assert!(primitive_equals(497 &state498 .evaluate_snippet_raw(499 Rc::new(PathBuf::from("raw.jsonnet")),500 r#"std.assertEqual(std.base64("test"), "dGVzdA==")"#.into()501 )502 .unwrap(),503 &Val::Bool(true),504 )505 .unwrap());506 }507508 macro_rules! eval {509 ($str: expr) => {510 EvaluationState::default()511 .with_stdlib()512 .evaluate_snippet_raw(Rc::new(PathBuf::from("raw.jsonnet")), $str.into())513 .unwrap()514 };515 }516 macro_rules! eval_json {517 ($str: expr) => {{518 let evaluator = EvaluationState::default();519 evaluator.with_stdlib();520 evaluator.run_in_state(|| {521 evaluator522 .evaluate_snippet_raw(Rc::new(PathBuf::from("raw.jsonnet")), $str.into())523 .unwrap()524 .into_json(0)525 .unwrap()526 .replace("\n", "")527 })528 }};529 }530531 532 macro_rules! assert_eval {533 ($str: expr) => {534 assert!(primitive_equals(&eval!($str), &Val::Bool(true)).unwrap())535 };536 }537538 539 macro_rules! assert_eval_neg {540 ($str: expr) => {541 assert!(primitive_equals(&eval!($str), &Val::Bool(false)).unwrap())542 };543 }544 macro_rules! assert_json {545 ($str: expr, $out: expr) => {546 assert_eq!(eval_json!($str), $out.replace("\t", ""))547 };548 }549550 551 #[test]552 fn equality_operator() {553 assert_eval!("2 == 2");554 assert_eval_neg!("2 != 2");555 assert_eval!("2 != 3");556 assert_eval_neg!("2 == 3");557 assert_eval!("'Hello' == 'Hello'");558 assert_eval_neg!("'Hello' != 'Hello'");559 assert_eval!("'Hello' != 'World'");560 assert_eval_neg!("'Hello' == 'World'");561 }562563 #[test]564 fn math_evaluation() {565 assert_eval!("2 + 2 * 2 == 6");566 assert_eval!("3 + (2 + 2 * 2) == 9");567 }568569 #[test]570 fn string_concat() {571 assert_eval!("'Hello' + 'World' == 'HelloWorld'");572 assert_eval!("'Hello' * 3 == 'HelloHelloHello'");573 assert_eval!("'Hello' + 'World' * 3 == 'HelloWorldWorldWorld'");574 }575576 #[test]577 fn faster_join() {578 assert_eval!("std.join([0,0], [[1,2],[3,4],[5,6]]) == [1,2,0,0,3,4,0,0,5,6]");579 assert_eval!("std.join(',', ['1','2','3','4']) == '1,2,3,4'");580 }581582 #[test]583 fn function_contexts() {584 assert_eval!(585 r#"586 local k = {587 t(name = self.h): [self.h, name],588 h: 3,589 };590 local f = {591 t: k.t(),592 h: 4,593 };594 f.t[0] == f.t[1]595 "#596 );597 }598599 #[test]600 fn local() {601 assert_eval!("local a = 2; local b = 3; a + b == 5");602 assert_eval!("local a = 1, b = a + 1; a + b == 3");603 assert_eval!("local a = 1; local a = 2; a == 2");604 }605606 #[test]607 fn object_lazyness() {608 assert_json!("local a = {a:error 'test'}; {}", r#"{}"#);609 }610611 #[test]612 fn object_inheritance() {613 assert_json!("{a: self.b} + {b:3}", r#"{"a": 3,"b": 3}"#);614 }615616 #[test]617 fn object_assertion_success() {618 eval!("{assert \"a\" in self} + {a:2}");619 }620621 #[test]622 fn object_assertion_error() {623 eval!("{assert \"a\" in self}");624 }625626 #[test]627 fn lazy_args() {628 eval!("local test(a) = 2; test(error '3')");629 }630631 #[test]632 #[should_panic]633 fn tailstrict_args() {634 eval!("local test(a) = 2; test(error '3') tailstrict");635 }636637 #[test]638 #[should_panic]639 fn no_binding_error() {640 eval!("a");641 }642643 #[test]644 fn test_object() {645 assert_json!("{a:2}", r#"{"a": 2}"#);646 assert_json!("{a:2+2}", r#"{"a": 4}"#);647 assert_json!("{a:2}+{b:2}", r#"{"a": 2,"b": 2}"#);648 assert_json!("{b:3}+{b:2}", r#"{"b": 2}"#);649 assert_json!("{b:3}+{b+:2}", r#"{"b": 5}"#);650 assert_json!("local test='a'; {[test]:2}", r#"{"a": 2}"#);651 assert_json!(652 r#"653 {654 name: "Alice",655 welcome: "Hello " + self.name + "!",656 }657 "#,658 r#"{"name": "Alice","welcome": "Hello Alice!"}"#659 );660 assert_json!(661 r#"662 {663 name: "Alice",664 welcome: "Hello " + self.name + "!",665 } + {666 name: "Bob"667 }668 "#,669 r#"{"name": "Bob","welcome": "Hello Bob!"}"#670 );671 }672673 #[test]674 fn functions() {675 assert_json!(r#"local a = function(b, c = 2) b + c; a(2)"#, "4");676 assert_json!(677 r#"local a = function(b, c = "Dear") b + c + d, d = "World"; a("Hello")"#,678 r#""HelloDearWorld""#679 );680 }681682 #[test]683 fn local_methods() {684 assert_json!(r#"local a(b, c = 2) = b + c; a(2)"#, "4");685 assert_json!(686 r#"local a(b, c = "Dear") = b + c + d, d = "World"; a("Hello")"#,687 r#""HelloDearWorld""#688 );689 }690691 #[test]692 fn object_locals() {693 assert_json!(r#"{local a = 3, b: a}"#, r#"{"b": 3}"#);694 assert_json!(r#"{local a = 3, local c = a, b: c}"#, r#"{"b": 3}"#);695 assert_json!(696 r#"{local a = function (b) {[b]:4}, test: a("test")}"#,697 r#"{"test": {"test": 4}}"#698 );699 }700701 #[test]702 fn object_comp() {703 assert_json!(704 r#"{local t = "a", ["h"+i+"_"+z]: if "h"+(i-1)+"_"+z in self then t+1 else 0+t for i in [1,2,3] for z in [2,3,4] if z != i}"#,705 "{\"h1_2\": \"0a\",\"h1_3\": \"0a\",\"h1_4\": \"0a\",\"h2_3\": \"a1\",\"h2_4\": \"a1\",\"h3_2\": \"0a\",\"h3_4\": \"a1\"}"706 )707 }708709 #[test]710 fn direct_self() {711 println!(712 "{:#?}",713 eval!(714 r#"715 {716 local me = self,717 a: 3,718 b(): me.a,719 }720 "#721 )722 );723 }724725 #[test]726 fn indirect_self() {727 728 729 eval!(730 r#"{731 local me = self,732 a: 3,733 b: me.a,734 }.b"#735 );736 }737738 739 #[test]740 fn std_assert_ok() {741 eval!("std.assertEqual(4.5 << 2, 16)");742 }743744 #[test]745 #[should_panic]746 fn std_assert_failure() {747 eval!("std.assertEqual(4.5 << 2, 15)");748 }749750 #[test]751 fn string_is_string() {752 assert!(primitive_equals(753 &eval!("local arr = 'hello'; (!std.isArray(arr)) && (!std.isString(arr))"),754 &Val::Bool(false),755 )756 .unwrap());757 }758759 #[test]760 fn base64_works() {761 assert_json!(r#"std.base64("test")"#, r#""dGVzdA==""#);762 }763764 #[test]765 fn utf8_chars() {766 assert_json!(767 r#"local c="😎";{c:std.codepoint(c),l:std.length(c)}"#,768 r#"{"c": 128526,"l": 1}"#769 )770 }771772 #[test]773 fn json() {774 assert_json!(775 r#"std.manifestJsonEx({a:3, b:4, c:6},"")"#,776 r#""{\n\"a\": 3,\n\"b\": 4,\n\"c\": 6\n}""#777 );778 }779780 #[test]781 fn test() {782 assert_json!(783 r#"[[a, b] for a in [1,2,3] for b in [4,5,6]]"#,784 "[[1,4],[1,5],[1,6],[2,4],[2,5],[2,6],[3,4],[3,5],[3,6]]"785 );786 }787788 #[test]789 fn sjsonnet() {790 eval!(791 r#"792 local x0 = {k: 1};793 local x1 = {k: x0.k + x0.k};794 local x2 = {k: x1.k + x1.k};795 local x3 = {k: x2.k + x2.k};796 local x4 = {k: x3.k + x3.k};797 local x5 = {k: x4.k + x4.k};798 local x6 = {k: x5.k + x5.k};799 local x7 = {k: x6.k + x6.k};800 local x8 = {k: x7.k + x7.k};801 local x9 = {k: x8.k + x8.k};802 local x10 = {k: x9.k + x9.k};803 local x11 = {k: x10.k + x10.k};804 local x12 = {k: x11.k + x11.k};805 local x13 = {k: x12.k + x12.k};806 local x14 = {k: x13.k + x13.k};807 local x15 = {k: x14.k + x14.k};808 local x16 = {k: x15.k + x15.k};809 local x17 = {k: x16.k + x16.k};810 local x18 = {k: x17.k + x17.k};811 local x19 = {k: x18.k + x18.k};812 local x20 = {k: x19.k + x19.k};813 local x21 = {k: x20.k + x20.k};814 x21.k815 "#816 );817 }818819 820 821 822 823 824 825 826 827 828 829 830 831832 833834835836837838839840841842843844845846847848849850851852853854855856857858 #[test]859 fn equality() {860 println!(861 "{:?}",862 jrsonnet_parser::parse(863 "{ x: 1, y: 2 } == { x: 1, y: 2 }",864 &ParserSettings::default()865 )866 );867 assert_eval!("{ x: 1, y: 2 } == { x: 1, y: 2 }")868 }869}