1#![feature(box_syntax, box_patterns)]2#![feature(type_alias_impl_trait)]3#![feature(debug_non_exhaustive)]4#![allow(macro_expanded_macro_exports_accessed_by_absolute_paths)]5#![feature(stmt_expr_attributes)]6mod ctx;7mod dynamic;8mod error;9mod evaluate;10mod function;11mod import;12mod map;13mod obj;14mod val;1516pub use ctx::*;17pub use dynamic::*;18pub use error::*;19pub use evaluate::*;20pub use function::parse_function_call;21pub use import::*;22use jsonnet_parser::*;23pub use obj::*;24use std::{cell::RefCell, collections::HashMap, fmt::Debug, path::PathBuf, rc::Rc};25pub use val::*;2627type BindableFn = dyn Fn(Option<ObjValue>, Option<ObjValue>) -> Result<LazyVal>;28#[derive(Clone)]29pub enum LazyBinding {30 Bindable(Rc<BindableFn>),31 Bound(LazyVal),32}3334impl Debug for LazyBinding {35 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {36 write!(f, "LazyBinding")37 }38}39impl LazyBinding {40 pub fn evaluate(&self, this: Option<ObjValue>, super_obj: Option<ObjValue>) -> Result<LazyVal> {41 match self {42 LazyBinding::Bindable(v) => v(this, super_obj),43 LazyBinding::Bound(v) => Ok(v.clone()),44 }45 }46}4748pub struct EvaluationSettings {49 pub max_stack_frames: usize,50 pub max_stack_trace_size: usize,51}52impl Default for EvaluationSettings {53 fn default() -> Self {54 EvaluationSettings {55 max_stack_frames: 200,56 max_stack_trace_size: 20,57 }58 }59}6061pub struct FileData(String, LocExpr, Option<Val>);62#[derive(Default)]63pub struct EvaluationStateInternals {64 65 stack: RefCell<Vec<StackTraceElement>>,66 67 68 files: RefCell<HashMap<PathBuf, FileData>>,69 str_files: RefCell<HashMap<PathBuf, String>>,70 globals: RefCell<HashMap<String, Val>>,7172 73 ext_vars: RefCell<HashMap<String, Val>>,7475 settings: EvaluationSettings,76 import_resolver: Box<dyn ImportResolver>,77}7879thread_local! {80 81 82 pub(crate) static EVAL_STATE: RefCell<Option<EvaluationState>> = RefCell::new(None)83}84#[inline(always)]85pub(crate) fn with_state<T>(f: impl FnOnce(&EvaluationState) -> T) -> T {86 EVAL_STATE.with(87 #[inline(always)]88 |s| f(s.borrow().as_ref().unwrap()),89 )90}91pub(crate) fn create_error<T>(err: Error) -> Result<T> {92 with_state(|s| s.error(err))93}94#[inline(always)]95pub(crate) fn push<T>(e: LocExpr, comment: String, f: impl FnOnce() -> Result<T>) -> Result<T> {96 with_state(|s| s.push(e, comment, f))97}9899100#[derive(Default, Clone)]101pub struct EvaluationState(Rc<EvaluationStateInternals>);102impl EvaluationState {103 pub fn new(settings: EvaluationSettings, import_resolver: Box<dyn ImportResolver>) -> Self {104 EvaluationState(Rc::new(EvaluationStateInternals {105 settings,106 import_resolver,107 ..Default::default()108 }))109 }110 pub fn add_file(&self, name: PathBuf, code: String) -> std::result::Result<(), ParseError> {111 self.0.files.borrow_mut().insert(112 name.clone(),113 FileData(114 code.clone(),115 parse(116 &code,117 &ParserSettings {118 file_name: name,119 loc_data: true,120 },121 )?,122 None,123 ),124 );125126 Ok(())127 }128 pub fn add_parsed_file(129 &self,130 name: PathBuf,131 code: String,132 parsed: LocExpr,133 ) -> std::result::Result<(), ()> {134 self.0135 .files136 .borrow_mut()137 .insert(name, FileData(code, parsed, None));138139 Ok(())140 }141 pub fn get_source(&self, name: &PathBuf) -> Option<String> {142 let ro_map = self.0.files.borrow();143 ro_map.get(name).map(|value| value.0.clone())144 }145 pub fn evaluate_file(&self, name: &PathBuf) -> Result<Val> {146 self.run_in_state(|| {147 let expr: LocExpr = {148 let ro_map = self.0.files.borrow();149 let value = ro_map150 .get(name)151 .unwrap_or_else(|| panic!("file not added: {:?}", name));152 if value.2.is_some() {153 return Ok(value.2.clone().unwrap());154 }155 value.1.clone()156 };157 let value = evaluate(self.create_default_context()?, &expr)?;158 {159 self.0160 .files161 .borrow_mut()162 .get_mut(name)163 .unwrap()164 .2165 .replace(value.clone());166 }167 Ok(value)168 })169 }170 pub(crate) fn import_file(&self, from: &PathBuf, path: &PathBuf) -> Result<Val> {171 let file_path = self.0.import_resolver.resolve_file(from, path)?;172 {173 let files = self.0.files.borrow();174 if files.contains_key(&file_path) {175 return self.evaluate_file(&file_path);176 }177 }178 let contents = self.0.import_resolver.load_file_contents(&file_path)?;179 self.add_file(file_path.clone(), contents).map_err(|e| {180 create_error::<()>(Error::ImportSyntaxError(e))181 .err()182 .unwrap()183 })?;184 self.evaluate_file(&file_path)185 }186 pub(crate) fn import_file_str(&self, from: &PathBuf, path: &PathBuf) -> Result<String> {187 let path = self.0.import_resolver.resolve_file(from, path)?;188 if !self.0.str_files.borrow().contains_key(&path) {189 let file_str = self.0.import_resolver.load_file_contents(&path)?;190 self.0.str_files.borrow_mut().insert(path.clone(), file_str);191 }192 Ok(self.0.str_files.borrow().get(&path).cloned().unwrap())193 }194195 pub fn parse_evaluate_raw(&self, code: &str) -> Result<Val> {196 let parsed = parse(197 &code,198 &ParserSettings {199 file_name: PathBuf::from("raw.jsonnet"),200 loc_data: true,201 },202 )203 .unwrap();204 self.evaluate_raw(parsed)205 }206207 pub fn evaluate_raw(&self, code: LocExpr) -> Result<Val> {208 self.run_in_state(|| evaluate(self.create_default_context()?, &code))209 }210211 pub fn add_global(&self, name: String, value: Val) {212 self.0.globals.borrow_mut().insert(name, value);213 }214 pub fn add_ext_var(&self, name: String, value: Val) {215 self.0.ext_vars.borrow_mut().insert(name, value);216 }217218 pub fn with_stdlib(&self) -> &Self {219 self.run_in_state(|| {220 use jsonnet_stdlib::STDLIB_STR;221 if cfg!(feature = "serialized-stdlib") {222 self.add_parsed_file(223 PathBuf::from("std.jsonnet"),224 STDLIB_STR.to_owned(),225 bincode::deserialize(include_bytes!(concat!(226 env!("OUT_DIR"),227 "/stdlib.bincode"228 )))229 .expect("deserialize stdlib"),230 )231 .unwrap();232 } else {233 self.add_file(PathBuf::from("std.jsonnet"), STDLIB_STR.to_owned())234 .unwrap();235 }236 let val = self.evaluate_file(&PathBuf::from("std.jsonnet")).unwrap();237 self.add_global("std".to_owned(), val);238 });239 self240 }241242 pub fn create_default_context(&self) -> Result<Context> {243 let globals = self.0.globals.borrow();244 let mut new_bindings: HashMap<String, LazyBinding> = HashMap::new();245 for (name, value) in globals.iter() {246 new_bindings.insert(247 name.clone(),248 LazyBinding::Bound(resolved_lazy_val!(value.clone())),249 );250 }251 Context::new().extend_unbound(new_bindings, None, None, None)252 }253254 #[inline(always)]255 pub fn push<T>(&self, e: LocExpr, comment: String, f: impl FnOnce() -> Result<T>) -> Result<T> {256 {257 let mut stack = self.0.stack.borrow_mut();258 if stack.len() > self.0.settings.max_stack_frames {259 drop(stack);260 return self.error(Error::StackOverflow);261 } else {262 stack.push(StackTraceElement(e, comment));263 }264 }265 let result = f();266 self.0.stack.borrow_mut().pop();267 result268 }269 pub fn print_stack_trace(&self) {270 for e in self.stack_trace().0 {271 println!("{:?} - {:?}", e.0, e.1)272 }273 }274 pub fn stack_trace(&self) -> StackTrace {275 StackTrace(276 self.0277 .stack278 .borrow()279 .iter()280 .rev()281 .take(self.0.settings.max_stack_trace_size)282 .cloned()283 .collect(),284 )285 }286 pub fn error<T>(&self, err: Error) -> Result<T> {287 Err(LocError(err, self.stack_trace()))288 }289290 #[inline(always)]291 fn run_in_state<T>(&self, f: impl FnOnce() -> T) -> T {292 EVAL_STATE.with(|v| {293 let has_state = v.borrow().is_some();294 if !has_state {295 v.borrow_mut().replace(self.clone());296 }297 let result = f();298 if !has_state {299 v.borrow_mut().take();300 }301 result302 })303 }304}305306#[cfg(test)]307pub mod tests {308 use super::Val;309 use crate::EvaluationState;310 use jsonnet_parser::*;311 use std::path::PathBuf;312313 #[test]314 fn eval_state_stacktrace() {315 let state = EvaluationState::default();316 state317 .push(318 loc_expr!(319 Expr::Num(0.0),320 true,321 (PathBuf::from("test1.jsonnet"), 10, 20)322 ),323 "outer".to_owned(),324 || {325 state.push(326 loc_expr!(327 Expr::Num(0.0),328 true,329 (PathBuf::from("test2.jsonnet"), 30, 40)330 ),331 "inner".to_owned(),332 || {333 state.print_stack_trace();334 Ok(())335 },336 )?;337 Ok(())338 },339 )340 .unwrap();341 }342343 #[test]344 fn eval_state_standard() {345 let state = EvaluationState::default();346 state.with_stdlib();347 assert_eq!(348 state349 .parse_evaluate_raw(r#"std.assertEqual(std.base64("test"), "dGVzdA==")"#)350 .unwrap(),351 Val::Bool(true)352 );353 }354355 macro_rules! eval {356 ($str: expr) => {357 EvaluationState::default()358 .with_stdlib()359 .parse_evaluate_raw($str)360 .unwrap()361 };362 }363 macro_rules! eval_json {364 ($str: expr) => {{365 let evaluator = EvaluationState::default();366 evaluator.with_stdlib();367 let val = evaluator.parse_evaluate_raw($str).unwrap();368 evaluator.add_global("__tmp__to_yaml__".to_owned(), val);369 evaluator370 .parse_evaluate_raw("std.manifestJsonEx(__tmp__to_yaml__, \"\")")371 .unwrap()372 .try_cast_str("there should be json string")373 .unwrap()374 .clone()375 .replace("\n", "")376 }};377 }378379 380 macro_rules! assert_eval {381 ($str: expr) => {382 assert_eq!(eval!($str), Val::Bool(true))383 };384 }385386 387 macro_rules! assert_eval_neg {388 ($str: expr) => {389 assert_eq!(eval!($str), Val::Bool(false))390 };391 }392 macro_rules! assert_json {393 ($str: expr, $out: expr) => {394 assert_eq!(eval_json!($str), $out.replace("\t", ""))395 };396 }397398 399 #[test]400 fn equality_operator() {401 assert_eval!("2 == 2");402 assert_eval_neg!("2 != 2");403 assert_eval!("2 != 3");404 assert_eval_neg!("2 == 3");405 assert_eval!("'Hello' == 'Hello'");406 assert_eval_neg!("'Hello' != 'Hello'");407 assert_eval!("'Hello' != 'World'");408 assert_eval_neg!("'Hello' == 'World'");409 }410411 #[test]412 fn math_evaluation() {413 assert_eval!("2 + 2 * 2 == 6");414 assert_eval!("3 + (2 + 2 * 2) == 9");415 }416417 #[test]418 fn string_concat() {419 assert_eval!("'Hello' + 'World' == 'HelloWorld'");420 assert_eval!("'Hello' * 3 == 'HelloHelloHello'");421 assert_eval!("'Hello' + 'World' * 3 == 'HelloWorldWorldWorld'");422 }423424 #[test]425 fn faster_join() {426 assert_eval!("std.join([0,0], [[1,2],[3,4],[5,6]]) == [1,2,0,0,3,4,0,0,5,6]");427 assert_eval!("std.join(',', ['1','2','3','4']) == '1,2,3,4'");428 }429430 #[test]431 fn function_contexts() {432 assert_eval!(433 r#"434 local k = {435 t(name = self.h): [self.h, name],436 h: 3,437 };438 local f = {439 t: k.t(),440 h: 4,441 };442 f.t[0] == f.t[1]443 "#444 );445 }446447 #[test]448 fn local() {449 assert_eval!("local a = 2; local b = 3; a + b == 5");450 assert_eval!("local a = 1, b = a + 1; a + b == 3");451 assert_eval!("local a = 1; local a = 2; a == 2");452 }453454 #[test]455 fn object_lazyness() {456 assert_json!("local a = {a:error 'test'}; {}", r#"{}"#);457 }458459 #[test]460 fn object_inheritance() {461 assert_json!("{a: self.b} + {b:3}", r#"{"a": 3,"b": 3}"#);462 }463464 #[test]465 fn object_assertion_success() {466 eval!("{assert \"a\" in self} + {a:2}");467 }468469 #[test]470 fn object_assertion_error() {471 eval!("{assert \"a\" in self}");472 }473474 #[test]475 fn lazy_args() {476 eval!("local test(a) = 2; test(error '3')");477 }478479 #[test]480 fn tailstrict_args() {481 eval!("local test(a) = 2; test(error '3') tailstrict");482 }483484 #[test]485 fn no_binding_error() {486 eval!("a");487 }488489 #[test]490 fn test_object() {491 assert_json!("{a:2}", r#"{"a": 2}"#);492 assert_json!("{a:2+2}", r#"{"a": 4}"#);493 assert_json!("{a:2}+{b:2}", r#"{"a": 2,"b": 2}"#);494 assert_json!("{b:3}+{b:2}", r#"{"b": 2}"#);495 assert_json!("{b:3}+{b+:2}", r#"{"b": 5}"#);496 assert_json!("local test='a'; {[test]:2}", r#"{"a": 2}"#);497 assert_json!(498 r#"499 {500 name: "Alice",501 welcome: "Hello " + self.name + "!",502 }503 "#,504 r#"{"name": "Alice","welcome": "Hello Alice!"}"#505 );506 assert_json!(507 r#"508 {509 name: "Alice",510 welcome: "Hello " + self.name + "!",511 } + {512 name: "Bob"513 }514 "#,515 r#"{"name": "Bob","welcome": "Hello Bob!"}"#516 );517 }518519 #[test]520 fn functions() {521 assert_json!(r#"local a = function(b, c = 2) b + c; a(2)"#, "4");522 assert_json!(523 r#"local a = function(b, c = "Dear") b + c + d, d = "World"; a("Hello")"#,524 r#""HelloDearWorld""#525 );526 }527528 #[test]529 fn local_methods() {530 assert_json!(r#"local a(b, c = 2) = b + c; a(2)"#, "4");531 assert_json!(532 r#"local a(b, c = "Dear") = b + c + d, d = "World"; a("Hello")"#,533 r#""HelloDearWorld""#534 );535 }536537 #[test]538 fn object_locals() {539 assert_json!(r#"{local a = 3, b: a}"#, r#"{"b": 3}"#);540 assert_json!(r#"{local a = 3, local c = a, b: c}"#, r#"{"b": 3}"#);541 assert_json!(542 r#"{local a = function (b) {[b]:4}, test: a("test")}"#,543 r#"{"test": {"test": 4}}"#544 );545 }546547 #[test]548 fn object_comp() {549 assert_json!(550 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}"#,551 "{\"h1_2\": \"0a\",\"h1_3\": \"0a\",\"h1_4\": \"0a\",\"h2_3\": \"a1\",\"h2_4\": \"a1\",\"h3_2\": \"0a\",\"h3_4\": \"a1\"}"552 )553 }554555 #[test]556 fn direct_self() {557 println!(558 "{:#?}",559 eval!(560 r#"561 {562 local me = self,563 a: 3,564 b(): me.a,565 }566 "#567 )568 );569 }570571 #[test]572 fn indirect_self() {573 574 575 eval!(576 r#"{577 local me = self,578 a: 3,579 b: me.a,580 }.b"#581 );582 }583584 585 #[test]586 fn std_assert_ok() {587 eval!("std.assertEqual(4.5 << 2, 16)");588 }589590 #[test]591 #[should_panic]592 fn std_assert_failure() {593 eval!("std.assertEqual(4.5 << 2, 15)");594 }595596 #[test]597 fn string_is_string() {598 assert_eq!(599 eval!("local arr = 'hello'; (!std.isArray(arr)) && (!std.isString(arr))"),600 Val::Bool(false)601 );602 }603604 #[test]605 fn base64_works() {606 assert_json!(r#"std.base64("test")"#, r#""dGVzdA==""#);607 }608609 #[test]610 fn utf8_chars() {611 assert_json!(612 r#"local c="😎";{c:std.codepoint(c),l:std.length(c)}"#,613 r#"{"c": 128526,"l": 1}"#614 )615 }616617 #[test]618 fn json() {619 assert_json!(620 r#"std.manifestJsonEx({a:3, b:4, c:6},"")"#,621 r#""{\n\"a\": 3,\n\"b\": 4,\n\"c\": 6\n}""#622 );623 }624625 #[test]626 fn test() {627 assert_json!(628 r#"[[a, b] for a in [1,2,3] for b in [4,5,6]]"#,629 "[[1,4],[1,5],[1,6],[2,4],[2,5],[2,6],[3,4],[3,5],[3,6]]"630 );631 }632633 #[test]634 fn sjsonnet() {635 eval!(636 r#"637 local x0 = {k: 1};638 local x1 = {k: x0.k + x0.k};639 local x2 = {k: x1.k + x1.k};640 local x3 = {k: x2.k + x2.k};641 local x4 = {k: x3.k + x3.k};642 local x5 = {k: x4.k + x4.k};643 local x6 = {k: x5.k + x5.k};644 local x7 = {k: x6.k + x6.k};645 local x8 = {k: x7.k + x7.k};646 local x9 = {k: x8.k + x8.k};647 local x10 = {k: x9.k + x9.k};648 local x11 = {k: x10.k + x10.k};649 local x12 = {k: x11.k + x11.k};650 local x13 = {k: x12.k + x12.k};651 local x14 = {k: x13.k + x13.k};652 local x15 = {k: x14.k + x14.k};653 local x16 = {k: x15.k + x15.k};654 local x17 = {k: x16.k + x16.k};655 local x18 = {k: x17.k + x17.k};656 local x19 = {k: x18.k + x18.k};657 local x20 = {k: x19.k + x19.k};658 local x21 = {k: x20.k + x20.k};659 x21.k660 "#661 );662 }663}