git.delta.rocks / jrsonnet / refs/commits / fab41c8db644

difftreelog

source

crates/jsonnet-evaluator/src/lib.rs11.2 KiBsourcehistory
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)]5mod ctx;6mod dynamic;7mod error;8mod evaluate;9mod obj;10mod val;1112use closure::closure;13pub use ctx::*;14pub use dynamic::*;15pub use error::*;16pub use evaluate::*;17use jsonnet_parser::*;18pub use obj::*;19use std::{cell::RefCell, collections::HashMap, rc::Rc};20pub use val::*;2122rc_fn_helper!(23	Binding,24	binding,25	dyn Fn(Option<ObjValue>, Option<ObjValue>) -> Result<Val>26);27rc_fn_helper!(28	LazyBinding,29	lazy_binding,30	dyn Fn(Option<ObjValue>, Option<ObjValue>) -> Result<LazyVal>31);32rc_fn_helper!(FunctionRhs, function_rhs, dyn Fn(Context) -> Result<Val>);33rc_fn_helper!(34	FunctionDefault,35	function_default,36	dyn Fn(Context, LocExpr) -> Result<Val>37);3839pub struct FileData(String, LocExpr, Option<Val>);40#[derive(Default)]41pub struct EvaluationStateInternals {42	/// Used for stack-overflows and stacktraces43	stack: RefCell<Vec<StackTraceElement>>,44	/// Contains file source codes and evaluated results for imports and pretty printing stacktraces45	files: RefCell<HashMap<String, FileData>>,46	globals: RefCell<HashMap<String, Val>>,47}4849thread_local! {50	pub static EVAL_STATE: RefCell<Option<EvaluationState>> = RefCell::new(None)51}52pub(crate) fn with_state<T>(f: impl FnOnce(&EvaluationState) -> T) -> T {53	EVAL_STATE.with(|s| f(s.borrow().as_ref().unwrap()))54}55pub(crate) fn create_error<T>(err: Error) -> Result<T> {56	with_state(|s| s.error(err))57}58pub(crate) fn push<T>(e: LocExpr, comment: String, f: impl FnOnce() -> T) -> T {59	with_state(|s| s.push(e, comment, f))60}6162#[derive(Default, Clone)]63pub struct EvaluationState(Rc<EvaluationStateInternals>);64impl EvaluationState {65	pub fn add_file(66		&self,67		name: String,68		code: String,69	) -> std::result::Result<(), Box<dyn std::error::Error>> {70		self.0.files.borrow_mut().insert(71			name.clone(),72			FileData(73				code.clone(),74				parse(75					&code,76					&ParserSettings {77						file_name: name,78						loc_data: true,79					},80				)?,81				None,82			),83		);8485		Ok(())86	}87	pub fn evaluate_file(&self, name: &str) -> Result<Val> {88		self.begin_state();89		let expr: LocExpr = {90			let ro_map = self.0.files.borrow();91			let value = ro_map92				.get(name)93				.unwrap_or_else(|| panic!("file not added: {:?}", name));94			if value.2.is_some() {95				return Ok(value.2.clone().unwrap());96			}97			value.1.clone()98		};99		let value = evaluate(self.create_default_context()?, &expr)?;100		{101			self.0102				.files103				.borrow_mut()104				.get_mut(name)105				.unwrap()106				.2107				.replace(value.clone());108		}109		self.end_state();110		Ok(value)111	}112113	pub fn parse_evaluate_raw(&self, code: &str) -> Result<Val> {114		let parsed = parse(115			&code,116			&ParserSettings {117				file_name: "raw.jsonnet".to_owned(),118				loc_data: true,119			},120		);121		self.begin_state();122		let value = evaluate(self.create_default_context()?, &parsed.unwrap());123		self.end_state();124		value125	}126127	pub fn add_stdlib(&self) {128		self.begin_state();129		use jsonnet_stdlib::STDLIB_STR;130		self.add_file("std.jsonnet".to_owned(), STDLIB_STR.to_owned())131			.unwrap();132		let val = self.evaluate_file("std.jsonnet").unwrap();133		self.0.globals.borrow_mut().insert("std".to_owned(), val);134		self.end_state();135	}136137	pub fn create_default_context(&self) -> Result<Context> {138		let globals = self.0.globals.borrow();139		let mut new_bindings: HashMap<String, LazyBinding> = HashMap::new();140		for (name, value) in globals.iter() {141			new_bindings.insert(142				name.clone(),143				lazy_binding!(144					closure!(clone value, |_self, _super_obj| Ok(lazy_val!(closure!(clone value, ||Ok(value.clone())))))145				),146			);147		}148		Context::new().extend(new_bindings, None, None, None)149	}150151	pub fn push<T>(&self, e: LocExpr, comment: String, f: impl FnOnce() -> T) -> T {152		self.0153			.stack154			.borrow_mut()155			.push(StackTraceElement(e, comment));156		let result = f();157		self.0.stack.borrow_mut().pop();158		result159	}160	pub fn print_stack_trace(&self) {161		for e in self.stack_trace().0 {162			println!("{:?} - {:?}", e.0, e.1)163		}164	}165	pub fn stack_trace(&self) -> StackTrace {166		StackTrace(self.0.stack.borrow().iter().rev().cloned().collect())167	}168	pub fn error<T>(&self, err: Error) -> Result<T> {169		Err(LocError(err, self.stack_trace()))170	}171172	fn begin_state(&self) {173		EVAL_STATE.with(|v| v.borrow_mut().replace(self.clone()));174	}175	fn end_state(&self) {176		EVAL_STATE.with(|v| v.borrow_mut().take());177	}178}179180#[cfg(test)]181pub mod tests {182	use super::Val;183	use crate::EvaluationState;184	use jsonnet_parser::*;185186	#[test]187	fn eval_state_stacktrace() {188		let state = EvaluationState::default();189		state.push(190			loc_expr!(Expr::Num(0.0), true, ("test1.jsonnet".to_owned(), 10, 20)),191			"outer".to_owned(),192			|| {193				state.push(194					loc_expr!(Expr::Num(0.0), true, ("test2.jsonnet".to_owned(), 30, 40)),195					"inner".to_owned(),196					|| state.print_stack_trace(),197				);198			},199		);200	}201202	#[test]203	fn eval_state_standard() {204		let state = EvaluationState::default();205		state.add_stdlib();206		assert_eq!(207			state208				.parse_evaluate_raw(r#"std.assertEqual(std.base64("test"), "dGVzdA==w")"#)209				.unwrap(),210			Val::Bool(true)211		);212	}213214	macro_rules! eval {215		($str: expr) => {216			evaluate(217				Context::new(),218				EvaluationState::default(),219				&parse(220					$str,221					&ParserSettings {222						loc_data: true,223						file_name: "test.jsonnet".to_owned(),224					},225					)226				.unwrap(),227				)228		};229	}230231	macro_rules! eval_stdlib {232		($str: expr) => {{233			let std = "local std = ".to_owned() + jsonnet_stdlib::STDLIB_STR + ";";234			evaluate(235				Context::new(),236				EvaluationState::default(),237				&parse(238					&(std + $str),239					&ParserSettings {240						loc_data: true,241						file_name: "test.jsonnet".to_owned(),242					},243					)244				.unwrap(),245				)246			}};247	}248249	macro_rules! assert_eval {250		($str: expr) => {251			assert_eq!(252				evaluate(253					Context::new(),254					EvaluationState::default(),255					&parse(256						$str,257						&ParserSettings {258							loc_data: true,259							file_name: "test.jsonnet".to_owned(),260						}261						)262					.unwrap()263					),264				Val::Bool(true)265				)266		};267	}268	macro_rules! assert_json {269		($str: expr, $out: expr) => {270			assert_eq!(271				format!(272					"{}",273					evaluate(274						Context::new(),275						EvaluationState::default(),276						&parse(277							$str,278							&ParserSettings {279								loc_data: true,280								file_name: "test.jsonnet".to_owned(),281							}282						)283						.unwrap()284						)285					),286				$out287				)288		};289	}290	macro_rules! assert_json_stdlib {291		($str: expr, $out: expr) => {292			assert_eq!(format!("{}", eval_stdlib!($str)), $out)293		};294	}295	macro_rules! assert_eval_neg {296		($str: expr) => {297			assert_eq!(298				evaluate(299					Context::new(),300					EvaluationState::default(),301					&parse(302						$str,303						&ParserSettings {304							loc_data: true,305							file_name: "test.jsonnet".to_owned(),306						}307						)308					.unwrap()309					),310				Val::Bool(false)311				)312		};313	}314315	/*316	/// Sanity checking, before trusting to another tests317	#[test]318	fn equality_operator() {319		assert_eval!("2 == 2");320		assert_eval_neg!("2 != 2");321		assert_eval!("2 != 3");322		assert_eval_neg!("2 == 3");323		assert_eval!("'Hello' == 'Hello'");324		assert_eval_neg!("'Hello' != 'Hello'");325		assert_eval!("'Hello' != 'World'");326		assert_eval_neg!("'Hello' == 'World'");327	}328329	#[test]330	fn math_evaluation() {331		assert_eval!("2 + 2 * 2 == 6");332		assert_eval!("3 + (2 + 2 * 2) == 9");333	}334335	#[test]336	fn string_concat() {337		assert_eval!("'Hello' + 'World' == 'HelloWorld'");338		assert_eval!("'Hello' * 3 == 'HelloHelloHello'");339		assert_eval!("'Hello' + 'World' * 3 == 'HelloWorldWorldWorld'");340	}341342	#[test]343	fn local() {344		assert_eval!("local a = 2; local b = 3; a + b == 5");345		assert_eval!("local a = 1, b = a + 1; a + b == 3");346		assert_eval!("local a = 1; local a = 2; a == 2");347	}348349	#[test]350	fn object_lazyness() {351		assert_json!("local a = {a:error 'test'}; {}", r#"{}"#);352	}353354	#[test]355	fn object_inheritance() {356		assert_json!("{a: self.b} + {b:3}", r#"{"a":3,"b":3}"#);357	}358359	#[test]360	fn test_object() {361		assert_json!("{a:2}", r#"{"a":2}"#);362		assert_json!("{a:2+2}", r#"{"a":4}"#);363		assert_json!("{a:2}+{b:2}", r#"{"a":2,"b":2}"#);364		assert_json!("{b:3}+{b:2}", r#"{"b":2}"#);365		assert_json!("{b:3}+{b+:2}", r#"{"b":5}"#);366		assert_json!("local test='a'; {[test]:2}", r#"{"a":2}"#);367		assert_json!(368			r#"369				{370					name: "Alice",371					welcome: "Hello " + self.name + "!",372				}373			"#,374			r#"{"name":"Alice","welcome":"Hello Alice!"}"#375		);376		assert_json!(377			r#"378				{379					name: "Alice",380					welcome: "Hello " + self.name + "!",381				} + {382					name: "Bob"383				}384			"#,385			r#"{"name":"Bob","welcome":"Hello Bob!"}"#386		);387	}388389	#[test]390	fn functions() {391		assert_json!(r#"local a = function(b, c = 2) b + c; a(2)"#, "4");392		assert_json!(393			r#"local a = function(b, c = "Dear") b + c + d, d = "World"; a("Hello")"#,394			r#""HelloDearWorld""#395		);396	}397398	#[test]399	fn local_methods() {400		assert_json!(r#"local a(b, c = 2) = b + c; a(2)"#, "4");401		assert_json!(402			r#"local a(b, c = "Dear") = b + c + d, d = "World"; a("Hello")"#,403			r#""HelloDearWorld""#404		);405	}406407	#[test]408	fn object_locals() {409		assert_json!(r#"{local a = 3, b: a}"#, r#"{"b":3}"#);410		assert_json!(r#"{local a = 3, local c = a, b: c}"#, r#"{"b":3}"#);411		assert_json!(412			r#"{local a = function (b) {[b]:4}, test: a("test")}"#,413			r#"{"test":{"test":4}}"#414		);415	}416417	#[test]418	fn direct_self() {419		println!(420			"{:#?}",421			eval!(422				r#"423					{424						local me = self,425						a: 3,426						b(): me.a,427					}428				"#429			)430		);431	}432433	#[test]434	fn indirect_self() {435		// `self` assigned to `me` was lost when being436		// referenced from field437		eval_stdlib!(438			r#"{439				local me = self,440				a: 3,441				b: me.a,442			}.b"#443		);444	}445446	// We can't trust other tests (And official jsonnet testsuite), if assert is not working correctly447	#[test]448	fn std_assert_ok() {449		eval_stdlib!("std.assertEqual(4.5 << 2, 16)");450	}451452	#[test]453	#[should_panic]454	fn std_assert_failure() {455		eval_stdlib!("std.assertEqual(4.5 << 2, 15)");456	}457458	#[test]459	fn string_is_string() {460		assert_eq!(461			eval_stdlib!("local arr = 'hello'; (!std.isArray(arr)) && (!std.isString(arr))"),462			Val::Bool(false)463		);464	}465466	#[test]467	fn base64_works() {468		assert_json_stdlib!(r#"std.base64("test")"#, r#""dGVzdA==""#);469	}470471	#[test]472	fn utf8_chars() {473		assert_json_stdlib!(474			r#"local c="😎";{c:std.codepoint(c),l:std.length(c)}"#,475			r#"{"c":128526,"l":1}"#476		)477	}478479	#[test]480	fn json() {481		assert_json_stdlib!(482			r#"std.manifestJsonEx({a:3, b:4, c:6},"")"#,483			r#""{\n"a": 3,\n"b": 4,\n"c": 6\n}""#484		);485	}486487	#[test]488	fn test() {489		assert_json_stdlib!(490			r#"[[a, b] for a in [1,2,3] for b in [4,5,6]]"#,491			"[[1,4],[1,5],[1,6],[2,4],[2,5],[2,6],[3,4],[3,5],[3,6]]"492		);493	}494495	#[test]496	fn sjsonnet() {497		eval!(498			r#"499			local x0 = {k: 1};500			local x1 = {k: x0.k + x0.k};501			local x2 = {k: x1.k + x1.k};502			local x3 = {k: x2.k + x2.k};503			local x4 = {k: x3.k + x3.k};504			local x5 = {k: x4.k + x4.k};505			local x6 = {k: x5.k + x5.k};506			local x7 = {k: x6.k + x6.k};507			local x8 = {k: x7.k + x7.k};508			local x9 = {k: x8.k + x8.k};509			local x10 = {k: x9.k + x9.k};510			local x11 = {k: x10.k + x10.k};511			local x12 = {k: x11.k + x11.k};512			local x13 = {k: x12.k + x12.k};513			local x14 = {k: x13.k + x13.k};514			local x15 = {k: x14.k + x14.k};515			local x16 = {k: x15.k + x15.k};516			local x17 = {k: x16.k + x16.k};517			local x18 = {k: x17.k + x17.k};518			local x19 = {k: x18.k + x18.k};519			local x20 = {k: x19.k + x19.k};520			local x21 = {k: x20.k + x20.k};521			x21.k522		"#523		);524	}525	*/526}