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 map;12mod obj;13mod val;1415pub use ctx::*;16pub use dynamic::*;17pub use error::*;18pub use evaluate::*;19pub use function::parse_function_call;20use jsonnet_parser::*;21pub use obj::*;22use std::{cell::RefCell, collections::HashMap, fmt::Debug, path::PathBuf, rc::Rc};23pub use val::*;2425type BindableFn = dyn Fn(Option<ObjValue>, Option<ObjValue>) -> Result<LazyVal>;26#[derive(Clone)]27pub enum LazyBinding {28 Bindable(Rc<BindableFn>),29 Bound(LazyVal),30}3132impl Debug for LazyBinding {33 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {34 write!(f, "LazyBinding")35 }36}37impl LazyBinding {38 pub fn evaluate(&self, this: Option<ObjValue>, super_obj: Option<ObjValue>) -> Result<LazyVal> {39 match self {40 LazyBinding::Bindable(v) => v(this, super_obj),41 LazyBinding::Bound(v) => Ok(v.clone()),42 }43 }44}4546pub struct EvaluationSettings {47 pub max_stack_frames: usize,48 pub max_stack_trace_size: usize,49 pub import_resolver: Box<dyn Fn(&PathBuf) -> String>,50}51impl Default for EvaluationSettings {52 fn default() -> Self {53 EvaluationSettings {54 max_stack_frames: 200,55 max_stack_trace_size: 20,56 import_resolver: Box::new(|path| {57 panic!("default EvaluationSettings have no support for import resolution, can't import {:?}", path)58 }),59 }60 }61}6263pub struct FileData(String, LocExpr, Option<Val>);64#[derive(Default)]65pub struct EvaluationStateInternals {66 67 stack: RefCell<Vec<StackTraceElement>>,68 69 70 files: RefCell<HashMap<PathBuf, FileData>>,71 str_files: RefCell<HashMap<PathBuf, String>>,72 globals: RefCell<HashMap<String, Val>>,7374 75 ext_vars: RefCell<HashMap<String, Val>>,7677 settings: EvaluationSettings,78}7980thread_local! {81 82 83 pub(crate) static EVAL_STATE: RefCell<Option<EvaluationState>> = RefCell::new(None)84}85#[inline(always)]86pub(crate) fn with_state<T>(f: impl FnOnce(&EvaluationState) -> T) -> T {87 EVAL_STATE.with(88 #[inline(always)]89 |s| f(s.borrow().as_ref().unwrap()),90 )91}92pub(crate) fn create_error<T>(err: Error) -> Result<T> {93 with_state(|s| s.error(err))94}95#[inline(always)]96pub(crate) fn push<T>(e: LocExpr, comment: String, f: impl FnOnce() -> Result<T>) -> Result<T> {97 with_state(|s| s.push(e, comment, f))98}99100101#[derive(Default, Clone)]102pub struct EvaluationState(Rc<EvaluationStateInternals>);103impl EvaluationState {104 pub fn new(settings: EvaluationSettings) -> Self {105 EvaluationState(Rc::new(EvaluationStateInternals {106 settings,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.begin_state();147 let value = self.evaluate_file_in_current_state(name)?;148 self.end_state();149 Ok(value)150 }151 pub(crate) fn evaluate_file_in_current_state(&self, name: &PathBuf) -> Result<Val> {152 let expr: LocExpr = {153 let ro_map = self.0.files.borrow();154 let value = ro_map155 .get(name)156 .unwrap_or_else(|| panic!("file not added: {:?}", name));157 if value.2.is_some() {158 return Ok(value.2.clone().unwrap());159 }160 value.1.clone()161 };162 let value = evaluate(self.create_default_context()?, &expr)?;163 {164 self.0165 .files166 .borrow_mut()167 .get_mut(name)168 .unwrap()169 .2170 .replace(value.clone());171 }172 Ok(value)173 }174 pub(crate) fn import_file(&self, path: &PathBuf) -> Result<Val> {175 if !self.0.files.borrow().contains_key(path) {176 let file_str = (self.0.settings.import_resolver)(path);177 self.add_file(path.clone(), file_str).unwrap();178 }179 self.evaluate_file_in_current_state(path)180 }181 pub(crate) fn import_file_str(&self, path: &PathBuf) -> Result<String> {182 if !self.0.str_files.borrow().contains_key(path) {183 let file_str = (self.0.settings.import_resolver)(path);184 self.0.str_files.borrow_mut().insert(path.clone(), file_str);185 }186 Ok(self.0.str_files.borrow().get(path).cloned().unwrap())187 }188189 pub fn parse_evaluate_raw(&self, code: &str) -> Result<Val> {190 let parsed = parse(191 &code,192 &ParserSettings {193 file_name: PathBuf::from("raw.jsonnet"),194 loc_data: true,195 },196 )197 .unwrap();198 self.evaluate_raw(parsed)199 }200201 pub fn evaluate_raw(&self, code: LocExpr) -> Result<Val> {202 self.begin_state();203 let value = evaluate(self.create_default_context()?, &code);204 self.end_state();205 value206 }207208 pub fn add_global(&self, name: String, value: Val) {209 self.0.globals.borrow_mut().insert(name, value);210 }211 pub fn add_ext_var(&self, name: String, value: Val) {212 self.0.ext_vars.borrow_mut().insert(name, value);213 }214215 pub fn with_stdlib(&self) -> &Self {216 self.begin_state();217 use jsonnet_stdlib::STDLIB_STR;218 if cfg!(feature = "serialized-stdlib") {219 self.add_parsed_file(220 PathBuf::from("std.jsonnet"),221 STDLIB_STR.to_owned(),222 bincode::deserialize(include_bytes!(concat!(env!("OUT_DIR"), "/stdlib.bincode")))223 .expect("deserialize stdlib"),224 )225 .unwrap();226 } else {227 self.add_file(PathBuf::from("std.jsonnet"), STDLIB_STR.to_owned())228 .unwrap();229 }230 let val = self.evaluate_file(&PathBuf::from("std.jsonnet")).unwrap();231 self.add_global("std".to_owned(), val);232 self.end_state();233 self234 }235236 pub fn create_default_context(&self) -> Result<Context> {237 let globals = self.0.globals.borrow();238 let mut new_bindings: HashMap<String, LazyBinding> = HashMap::new();239 for (name, value) in globals.iter() {240 new_bindings.insert(241 name.clone(),242 LazyBinding::Bound(resolved_lazy_val!(value.clone())),243 );244 }245 Context::new().extend_unbound(new_bindings, None, None, None)246 }247248 #[inline(always)]249 pub fn push<T>(&self, e: LocExpr, comment: String, f: impl FnOnce() -> Result<T>) -> Result<T> {250 {251 let mut stack = self.0.stack.borrow_mut();252 if stack.len() > self.0.settings.max_stack_frames {253 drop(stack);254 return self.error(Error::StackOverflow);255 } else {256 stack.push(StackTraceElement(e, comment));257 }258 }259 let result = f();260 self.0.stack.borrow_mut().pop();261 result262 }263 pub fn print_stack_trace(&self) {264 for e in self.stack_trace().0 {265 println!("{:?} - {:?}", e.0, e.1)266 }267 }268 pub fn stack_trace(&self) -> StackTrace {269 StackTrace(270 self.0271 .stack272 .borrow()273 .iter()274 .rev()275 .take(self.0.settings.max_stack_trace_size)276 .cloned()277 .collect(),278 )279 }280 pub fn error<T>(&self, err: Error) -> Result<T> {281 Err(LocError(err, self.stack_trace()))282 }283284 fn begin_state(&self) {285 EVAL_STATE.with(|v| v.borrow_mut().replace(self.clone()));286 }287 fn end_state(&self) {288 EVAL_STATE.with(|v| v.borrow_mut().take());289 }290}291292#[cfg(test)]293pub mod tests {294 use super::Val;295 use crate::EvaluationState;296 use jsonnet_parser::*;297 use std::path::PathBuf;298299 #[test]300 fn eval_state_stacktrace() {301 let state = EvaluationState::default();302 state303 .push(304 loc_expr!(305 Expr::Num(0.0),306 true,307 (PathBuf::from("test1.jsonnet"), 10, 20)308 ),309 "outer".to_owned(),310 || {311 state.push(312 loc_expr!(313 Expr::Num(0.0),314 true,315 (PathBuf::from("test2.jsonnet"), 30, 40)316 ),317 "inner".to_owned(),318 || {319 state.print_stack_trace();320 Ok(())321 },322 )?;323 Ok(())324 },325 )326 .unwrap();327 }328329 #[test]330 fn eval_state_standard() {331 let state = EvaluationState::default();332 state.with_stdlib();333 assert_eq!(334 state335 .parse_evaluate_raw(r#"std.assertEqual(std.base64("test"), "dGVzdA==")"#)336 .unwrap(),337 Val::Bool(true)338 );339 }340341 macro_rules! eval {342 ($str: expr) => {343 EvaluationState::default()344 .with_stdlib()345 .parse_evaluate_raw($str)346 .unwrap()347 };348 }349 macro_rules! eval_json {350 ($str: expr) => {{351 let evaluator = EvaluationState::default();352 evaluator.with_stdlib();353 let val = evaluator.parse_evaluate_raw($str).unwrap();354 evaluator.add_global("__tmp__to_yaml__".to_owned(), val);355 evaluator356 .parse_evaluate_raw("std.manifestJsonEx(__tmp__to_yaml__, \"\")")357 .unwrap()358 .try_cast_str("there should be json string")359 .unwrap()360 .clone()361 .replace("\n", "")362 }};363 }364365 366 macro_rules! assert_eval {367 ($str: expr) => {368 assert_eq!(eval!($str), Val::Bool(true))369 };370 }371372 373 macro_rules! assert_eval_neg {374 ($str: expr) => {375 assert_eq!(eval!($str), Val::Bool(false))376 };377 }378 macro_rules! assert_json {379 ($str: expr, $out: expr) => {380 assert_eq!(eval_json!($str), $out.replace("\t", ""))381 };382 }383384 385 #[test]386 fn equality_operator() {387 assert_eval!("2 == 2");388 assert_eval_neg!("2 != 2");389 assert_eval!("2 != 3");390 assert_eval_neg!("2 == 3");391 assert_eval!("'Hello' == 'Hello'");392 assert_eval_neg!("'Hello' != 'Hello'");393 assert_eval!("'Hello' != 'World'");394 assert_eval_neg!("'Hello' == 'World'");395 }396397 #[test]398 fn math_evaluation() {399 assert_eval!("2 + 2 * 2 == 6");400 assert_eval!("3 + (2 + 2 * 2) == 9");401 }402403 #[test]404 fn string_concat() {405 assert_eval!("'Hello' + 'World' == 'HelloWorld'");406 assert_eval!("'Hello' * 3 == 'HelloHelloHello'");407 assert_eval!("'Hello' + 'World' * 3 == 'HelloWorldWorldWorld'");408 }409410 #[test]411 fn faster_join() {412 assert_eval!("std.join([0,0], [[1,2],[3,4],[5,6]]) == [1,2,0,0,3,4,0,0,5,6]");413 assert_eval!("std.join(',', ['1','2','3','4']) == '1,2,3,4'");414 }415416 #[test]417 fn function_contexts() {418 assert_eval!(419 r#"420 local k = {421 t(name = self.h): [self.h, name],422 h: 3,423 };424 local f = {425 t: k.t(),426 h: 4,427 };428 f.t[0] == f.t[1]429 "#430 );431 }432433 #[test]434 fn local() {435 assert_eval!("local a = 2; local b = 3; a + b == 5");436 assert_eval!("local a = 1, b = a + 1; a + b == 3");437 assert_eval!("local a = 1; local a = 2; a == 2");438 }439440 #[test]441 fn object_lazyness() {442 assert_json!("local a = {a:error 'test'}; {}", r#"{}"#);443 }444445 446 #[test]447 fn object_inheritance() {448 assert_json!("{a: self.b} + {b:3}", r#"{"a": 3,"b": 3}"#);449 }450451 #[test]452 fn object_assertion_success() {453 eval!("{assert \"a\" in self} + {a:2}");454 }455456 #[test]457 fn object_assertion_error() {458 eval!("{assert \"a\" in self}");459 }460 #[test]461 fn test_object() {462 assert_json!("{a:2}", r#"{"a": 2}"#);463 assert_json!("{a:2+2}", r#"{"a": 4}"#);464 assert_json!("{a:2}+{b:2}", r#"{"a": 2,"b": 2}"#);465 assert_json!("{b:3}+{b:2}", r#"{"b": 2}"#);466 assert_json!("{b:3}+{b+:2}", r#"{"b": 5}"#);467 assert_json!("local test='a'; {[test]:2}", r#"{"a": 2}"#);468 assert_json!(469 r#"470 {471 name: "Alice",472 welcome: "Hello " + self.name + "!",473 }474 "#,475 r#"{"name": "Alice","welcome": "Hello Alice!"}"#476 );477 assert_json!(478 r#"479 {480 name: "Alice",481 welcome: "Hello " + self.name + "!",482 } + {483 name: "Bob"484 }485 "#,486 r#"{"name": "Bob","welcome": "Hello Bob!"}"#487 );488 }489490 #[test]491 fn functions() {492 assert_json!(r#"local a = function(b, c = 2) b + c; a(2)"#, "4");493 assert_json!(494 r#"local a = function(b, c = "Dear") b + c + d, d = "World"; a("Hello")"#,495 r#""HelloDearWorld""#496 );497 }498499 #[test]500 fn local_methods() {501 assert_json!(r#"local a(b, c = 2) = b + c; a(2)"#, "4");502 assert_json!(503 r#"local a(b, c = "Dear") = b + c + d, d = "World"; a("Hello")"#,504 r#""HelloDearWorld""#505 );506 }507508 #[test]509 fn object_locals() {510 assert_json!(r#"{local a = 3, b: a}"#, r#"{"b": 3}"#);511 assert_json!(r#"{local a = 3, local c = a, b: c}"#, r#"{"b": 3}"#);512 assert_json!(513 r#"{local a = function (b) {[b]:4}, test: a("test")}"#,514 r#"{"test": {"test": 4}}"#515 );516 }517518 #[test]519 fn object_comp() {520 assert_json!(521 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}"#,522 "{\"h1_2\": \"0a\",\"h1_3\": \"0a\",\"h1_4\": \"0a\",\"h2_3\": \"a1\",\"h2_4\": \"a1\",\"h3_2\": \"0a\",\"h3_4\": \"a1\"}"523 )524 }525526 #[test]527 fn direct_self() {528 println!(529 "{:#?}",530 eval!(531 r#"532 {533 local me = self,534 a: 3,535 b(): me.a,536 }537 "#538 )539 );540 }541542 #[test]543 fn indirect_self() {544 545 546 eval!(547 r#"{548 local me = self,549 a: 3,550 b: me.a,551 }.b"#552 );553 }554555 556 #[test]557 fn std_assert_ok() {558 eval!("std.assertEqual(4.5 << 2, 16)");559 }560561 #[test]562 #[should_panic]563 fn std_assert_failure() {564 eval!("std.assertEqual(4.5 << 2, 15)");565 }566567 #[test]568 fn string_is_string() {569 assert_eq!(570 eval!("local arr = 'hello'; (!std.isArray(arr)) && (!std.isString(arr))"),571 Val::Bool(false)572 );573 }574575 #[test]576 fn base64_works() {577 assert_json!(r#"std.base64("test")"#, r#""dGVzdA==""#);578 }579580 #[test]581 fn utf8_chars() {582 assert_json!(583 r#"local c="😎";{c:std.codepoint(c),l:std.length(c)}"#,584 r#"{"c": 128526,"l": 1}"#585 )586 }587588 #[test]589 fn json() {590 assert_json!(591 r#"std.manifestJsonEx({a:3, b:4, c:6},"")"#,592 r#""{\n\"a\": 3,\n\"b\": 4,\n\"c\": 6\n}""#593 );594 }595596 #[test]597 fn test() {598 assert_json!(599 r#"[[a, b] for a in [1,2,3] for b in [4,5,6]]"#,600 "[[1,4],[1,5],[1,6],[2,4],[2,5],[2,6],[3,4],[3,5],[3,6]]"601 );602 }603604 #[test]605 fn sjsonnet() {606 eval!(607 r#"608 local x0 = {k: 1};609 local x1 = {k: x0.k + x0.k};610 local x2 = {k: x1.k + x1.k};611 local x3 = {k: x2.k + x2.k};612 local x4 = {k: x3.k + x3.k};613 local x5 = {k: x4.k + x4.k};614 local x6 = {k: x5.k + x5.k};615 local x7 = {k: x6.k + x6.k};616 local x8 = {k: x7.k + x7.k};617 local x9 = {k: x8.k + x8.k};618 local x10 = {k: x9.k + x9.k};619 local x11 = {k: x10.k + x10.k};620 local x12 = {k: x11.k + x11.k};621 local x13 = {k: x12.k + x12.k};622 local x14 = {k: x13.k + x13.k};623 local x15 = {k: x14.k + x14.k};624 local x16 = {k: x15.k + x15.k};625 local x17 = {k: x16.k + x16.k};626 local x18 = {k: x17.k + x17.k};627 local x19 = {k: x18.k + x18.k};628 local x20 = {k: x19.k + x19.k};629 local x21 = {k: x20.k + x20.k};630 x21.k631 "#632 );633 }634}