git.delta.rocks / jrsonnet / refs/commits / 8dc1868a104f

1#![feature(box_syntax, box_patterns)]2#![feature(type_alias_impl_trait)]3#![feature(debug_non_exhaustive)]4#![feature(test)]5#![feature(stmt_expr_attributes)]6#![allow(macro_expanded_macro_exports_accessed_by_absolute_paths)]78extern crate test;910mod ctx;11mod dynamic;12mod error;13mod evaluate;14mod function;15mod import;16mod map;17mod obj;18mod val;1920pub use ctx::*;21pub use dynamic::*;22pub use error::*;23pub use evaluate::*;24pub use function::parse_function_call;25pub use import::*;26use jrsonnet_parser::*;27pub use obj::*;28use std::{cell::{Ref, RefCell, RefMut}, collections::HashMap, fmt::Debug, path::PathBuf, rc::Rc};29pub use val::*;3031type BindableFn = dyn Fn(Option<ObjValue>, Option<ObjValue>) -> Result<LazyVal>;32#[derive(Clone)]33pub enum LazyBinding {34	Bindable(Rc<BindableFn>),35	Bound(LazyVal),36}3738impl Debug for LazyBinding {39	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {40		write!(f, "LazyBinding")41	}42}43impl LazyBinding {44	pub fn evaluate(&self, this: Option<ObjValue>, super_obj: Option<ObjValue>) -> Result<LazyVal> {45		match self {46			LazyBinding::Bindable(v) => v(this, super_obj),47			LazyBinding::Bound(v) => Ok(v.clone()),48		}49	}50}5152struct EvaluationSettings {53	max_stack_frames: usize,54	max_stack_trace_size: usize,55	ext_vars: HashMap<Rc<str>, Val>,56	globals: HashMap<Rc<str>, Val>,57	import_resolver: Box<dyn ImportResolver>,58}59impl Default for EvaluationSettings {60	fn default() -> Self {61		EvaluationSettings {62			max_stack_frames: 200,63			max_stack_trace_size: 20,64			globals: Default::default(),65			ext_vars: Default::default(),66			import_resolver: Box::new(DummyImportResolver),67		}68	}69}7071#[derive(Default)]72struct EvaluationData {73	/// Used for stack-overflows and stacktraces74	stack: Vec<StackTraceElement>,75	/// Contains file source codes and evaluated results for imports and pretty76	/// printing stacktraces77	files: HashMap<Rc<PathBuf>, FileData>,78	str_files: HashMap<Rc<PathBuf>, Rc<str>>,79}8081pub struct FileData(Rc<str>, LocExpr, Option<Val>);82#[derive(Default)]83pub struct EvaluationStateInternals {84	data: RefCell<EvaluationData>,85	settings: RefCell<EvaluationSettings>,86}8788thread_local! {89	/// Contains state for currently executing file90	/// Global state is fine there91	pub(crate) static EVAL_STATE: RefCell<Option<EvaluationState>> = RefCell::new(None)92}93pub(crate) fn with_state<T>(f: impl FnOnce(&EvaluationState) -> T) -> T {94	EVAL_STATE.with(|s| f(s.borrow().as_ref().unwrap()))95}96pub fn create_error(err: Error) -> LocError {97	with_state(|s| s.error(err))98}99pub fn create_error_result<T>(err: Error) -> Result<T> {100	Err(with_state(|s| s.error(err)))101}102pub(crate) fn push<T>(103	e: &Option<ExprLocation>,104	comment: &str,105	f: impl FnOnce() -> Result<T>,106) -> Result<T> {107	if e.is_some() {108		with_state(|s| s.push(e.clone().unwrap(), comment.to_owned(), f))109	} else {110		f()111	}112}113114/// Maintains stack trace and import resolution115#[derive(Default, Clone)]116pub struct EvaluationState(Rc<EvaluationStateInternals>);117impl EvaluationState {118	fn data(&self) -> Ref<EvaluationData> {119		self.0.data.borrow()120	}121	fn data_mut(&self) -> RefMut<EvaluationData> {122		self.0.data.borrow_mut()123	}124	fn settings(&self) -> Ref<EvaluationSettings> {125		self.0.settings.borrow()126	}127	fn settings_mut(&self) -> RefMut<EvaluationSettings> {128		self.0.settings.borrow_mut()129	}130131	pub fn set_import_resolver(&self, resolver: Box<dyn ImportResolver>) {132		self.settings_mut().import_resolver = resolver;133	}134	pub fn import_resolver(&self) -> Ref<dyn ImportResolver> {135		Ref::map(self.settings(), |s|&*s.import_resolver)136	}137138	pub fn evaluate_file_to_json(139		&self,140		path: &PathBuf,141	) -> std::result::Result<Rc<str>, LocError> {142		self.import_file(&PathBuf::new(), &path).and_then(|v|v.into_json(4))143	}144	pub fn evaluate_snippet_to_json(145		&self,146		path: &PathBuf,147		snippet: &str,148	) -> std::result::Result<Rc<str>, LocError> {149		self.parse_evaluate_raw_with_source(Rc::new(path.clone()), snippet).and_then(|v|v.into_json(4))150	}151152	pub fn add_file(153		&self,154		name: Rc<PathBuf>,155		code: Rc<str>,156	) -> std::result::Result<(), ParseError> {157		self.data_mut().files.insert(158			name.clone(),159			FileData(160				code.clone(),161				parse(162					&code,163					&ParserSettings {164						file_name: name,165						loc_data: true,166					},167				)?,168				None,169			),170		);171172		Ok(())173	}174	pub fn add_parsed_file(175		&self,176		name: Rc<PathBuf>,177		code: Rc<str>,178		parsed: LocExpr,179	) -> std::result::Result<(), ()> {180		self.data_mut()181			.files182			.insert(name, FileData(code, parsed, None));183184		Ok(())185	}186	pub fn get_source(&self, name: &PathBuf) -> Option<Rc<str>> {187		let ro_map = &self.data().files;188		ro_map.get(name).map(|value| value.0.clone())189	}190	pub fn evaluate_file(&self, name: &PathBuf) -> Result<Val> {191		self.run_in_state(|| {192			let expr: LocExpr = {193				let ro_map = &self.data().files;194				let value = ro_map195					.get(name)196					.unwrap_or_else(|| panic!("file not added: {:?}", name));197				if value.2.is_some() {198					return Ok(value.2.clone().unwrap());199				}200				value.1.clone()201			};202			let value = evaluate(self.create_default_context()?, &expr)?;203			{204				self.0205					.data.borrow_mut()206					.files207					.get_mut(name)208					.unwrap()209					.2210					.replace(value.clone());211			}212			Ok(value)213		})214	}215	pub(crate) fn import_file(&self, from: &PathBuf, path: &PathBuf) -> Result<Val> {216		let file_path = self.settings().import_resolver.resolve_file(from, path)?;217		{218			let files = &self.data().files;219			if files.contains_key(&file_path) {220				return self.evaluate_file(&file_path);221			}222		}223		let contents = self.settings().import_resolver.load_file_contents(&file_path)?;224		self.add_file(file_path.clone(), contents).map_err(|e| {225			create_error(Error::ImportSyntaxError(e))226		})?;227		self.evaluate_file(&file_path)228	}229	pub(crate) fn import_file_str(&self, from: &PathBuf, path: &PathBuf) -> Result<Rc<str>> {230		let path = self.settings().import_resolver.resolve_file(from, path)?;231		if !self.data().str_files.contains_key(&path) {232			let file_str = self.settings().import_resolver.load_file_contents(&path)?;233			self.data_mut()234				.str_files235				.insert(path.clone(), file_str);236		}237		Ok(self.data().str_files.get(&path).cloned().unwrap())238	}239240	pub fn parse_evaluate_raw_with_source(&self, source: Rc<PathBuf>, code: &str) -> Result<Val> {241		let parsed = parse(242			&code,243			&ParserSettings {244				file_name: source,245				loc_data: true,246			},247		)248		.unwrap();249		self.evaluate_raw(parsed)250	}251	pub fn parse_evaluate_raw(&self, code: &str) -> Result<Val> {252		self.parse_evaluate_raw_with_source(Rc::new(PathBuf::from("raw.jsonnet")), code)253	}254255	pub fn evaluate_raw(&self, code: LocExpr) -> Result<Val> {256		self.run_in_state(|| evaluate(self.create_default_context()?, &code))257	}258259	pub fn add_global(&self, name: Rc<str>, value: Val) {260		self.settings_mut().globals.insert(name, value);261	}262	pub fn add_ext_var(&self, name: Rc<str>, value: Val) {263		self.settings_mut().ext_vars.insert(name, value);264	}265	pub fn set_max_trace(&self, max_trace: usize) {266		self.settings_mut().max_stack_trace_size = max_trace;267	}268	pub fn set_max_stack(&self, max_stack: usize) {269		self.settings_mut().max_stack_frames = max_stack;270	}271272	pub fn with_stdlib(&self) -> &Self {273		let std_path = Rc::new(PathBuf::from("std.jsonnet"));274		self.run_in_state(|| {275			use jrsonnet_stdlib::STDLIB_STR;276			let mut parsed = false;277			#[cfg(feature = "codegenerated-stdlib")]278			if !parsed {279				parsed = true;280				#[allow(clippy::all)]281				let stdlib = {282					use jrsonnet_parser::*;283					include!(concat!(env!("OUT_DIR"), "/stdlib.rs"))284				};285				self.add_parsed_file(std_path.clone(), STDLIB_STR.to_owned().into(), stdlib)286					.unwrap();287			}288289			#[cfg(feature = "serialized-stdlib")]290			if !parsed {291				parsed = true;292				self.add_parsed_file(293					std_path.clone(),294					STDLIB_STR.to_owned().into(),295					bincode::deserialize(include_bytes!(concat!(296						env!("OUT_DIR"),297						"/stdlib.bincode"298					)))299					.expect("deserialize stdlib"),300				)301				.unwrap();302			}303304			if !parsed {305				self.add_file(std_path, STDLIB_STR.to_owned().into())306					.unwrap();307			}308			let val = self.evaluate_file(&PathBuf::from("std.jsonnet")).unwrap();309			self.add_global("std".into(), val);310		});311		self312	}313314	pub fn create_default_context(&self) -> Result<Context> {315		let globals = &self.settings().globals;316		let mut new_bindings: HashMap<Rc<str>, LazyBinding> = HashMap::new();317		for (name, value) in globals.iter() {318			new_bindings.insert(319				name.clone(),320				LazyBinding::Bound(resolved_lazy_val!(value.clone())),321			);322		}323		Context::new().extend_unbound(new_bindings, None, None, None)324	}325326	/// Executes code, creating new stack frame327	pub fn push<T>(328		&self,329		e: ExprLocation,330		comment: String,331		f: impl FnOnce() -> Result<T>,332	) -> Result<T> {333		{334			let mut data = self.data_mut();335			let stack = &mut data.stack;336			if stack.len() > self.settings().max_stack_frames {337				// Error creation uses data, so i drop guard here338				drop(data);339				return Err(self.error(Error::StackOverflow));340			} else {341				stack.push(StackTraceElement(e, comment));342			}343		}344		let result = f();345		self.data_mut().stack.pop();346		result347	}348349	/// Returns current stack trace350	pub fn stack_trace(&self) -> StackTrace {351		StackTrace(352			self.data()353				.stack354				.iter()355				.rev()356				.take(self.settings().max_stack_trace_size)357				.cloned()358				.collect(),359		)360	}361362	/// Creates error with stack trace363	pub fn error(&self, err: Error) -> LocError {364		LocError(err, self.stack_trace())365	}366367	/// Runs passed function in state (required, if function needs to modify stack trace)368	pub fn run_in_state<T>(&self, f: impl FnOnce() -> T) -> T {369		EVAL_STATE.with(|v| {370			let has_state = v.borrow().is_some();371			if !has_state {372				v.borrow_mut().replace(self.clone());373			}374			let result = f();375			if !has_state {376				v.borrow_mut().take();377			}378			result379		})380	}381}382383#[cfg(test)]384pub mod tests {385	use super::Val;386	use crate::EvaluationState;387	use jrsonnet_parser::*;388	use std::{path::PathBuf, rc::Rc};389390	#[test]391	fn eval_state_stacktrace() {392		let state = EvaluationState::default();393		state394			.push(395				ExprLocation(Rc::new(PathBuf::from("test1.jsonnet")), 10, 20),396				"outer".to_owned(),397				|| {398					state.push(399						ExprLocation(Rc::new(PathBuf::from("test2.jsonnet")), 30, 40),400						"inner".to_owned(),401						|| {402							Ok(())403						},404					)?;405					Ok(())406				},407			)408			.unwrap();409	}410411	#[test]412	fn eval_state_standard() {413		let state = EvaluationState::default();414		state.with_stdlib();415		assert_eq!(416			state417				.parse_evaluate_raw(r#"std.assertEqual(std.base64("test"), "dGVzdA==")"#)418				.unwrap(),419			Val::Bool(true)420		);421	}422423	macro_rules! eval {424		($str: expr) => {425			EvaluationState::default()426				.with_stdlib()427				.parse_evaluate_raw($str)428				.unwrap()429		};430	}431	macro_rules! eval_json {432		($str: expr) => {{433			let evaluator = EvaluationState::default();434			evaluator.with_stdlib();435			evaluator.run_in_state(||{436				evaluator437					.parse_evaluate_raw($str)438					.unwrap()439					.into_json(0)440					.unwrap()441					.replace("\n", "")442			})443		}}444	}445446	/// Asserts given code returns `true`447	macro_rules! assert_eval {448		($str: expr) => {449			assert_eq!(eval!($str), Val::Bool(true))450		};451	}452453	/// Asserts given code returns `false`454	macro_rules! assert_eval_neg {455		($str: expr) => {456			assert_eq!(eval!($str), Val::Bool(false))457		};458	}459	macro_rules! assert_json {460		($str: expr, $out: expr) => {461			assert_eq!(eval_json!($str), $out.replace("\t", ""))462		};463	}464465	/// Sanity checking, before trusting to another tests466	#[test]467	fn equality_operator() {468		assert_eval!("2 == 2");469		assert_eval_neg!("2 != 2");470		assert_eval!("2 != 3");471		assert_eval_neg!("2 == 3");472		assert_eval!("'Hello' == 'Hello'");473		assert_eval_neg!("'Hello' != 'Hello'");474		assert_eval!("'Hello' != 'World'");475		assert_eval_neg!("'Hello' == 'World'");476	}477478	#[test]479	fn math_evaluation() {480		assert_eval!("2 + 2 * 2 == 6");481		assert_eval!("3 + (2 + 2 * 2) == 9");482	}483484	#[test]485	fn string_concat() {486		assert_eval!("'Hello' + 'World' == 'HelloWorld'");487		assert_eval!("'Hello' * 3 == 'HelloHelloHello'");488		assert_eval!("'Hello' + 'World' * 3 == 'HelloWorldWorldWorld'");489	}490491	#[test]492	fn faster_join() {493		assert_eval!("std.join([0,0], [[1,2],[3,4],[5,6]]) == [1,2,0,0,3,4,0,0,5,6]");494		assert_eval!("std.join(',', ['1','2','3','4']) == '1,2,3,4'");495	}496497	#[test]498	fn function_contexts() {499		assert_eval!(500			r#"501				local k = {502					t(name = self.h): [self.h, name],503					h: 3,504				};505				local f = {506					t: k.t(),507					h: 4,508				};509				f.t[0] == f.t[1]510			"#511		);512	}513514	#[test]515	fn local() {516		assert_eval!("local a = 2; local b = 3; a + b == 5");517		assert_eval!("local a = 1, b = a + 1; a + b == 3");518		assert_eval!("local a = 1; local a = 2; a == 2");519	}520521	#[test]522	fn object_lazyness() {523		assert_json!("local a = {a:error 'test'}; {}", r#"{}"#);524	}525526	#[test]527	fn object_inheritance() {528		assert_json!("{a: self.b} + {b:3}", r#"{"a": 3,"b": 3}"#);529	}530531	#[test]532	fn object_assertion_success() {533		eval!("{assert \"a\" in self} + {a:2}");534	}535536	#[test]537	fn object_assertion_error() {538		eval!("{assert \"a\" in self}");539	}540541	#[test]542	fn lazy_args() {543		eval!("local test(a) = 2; test(error '3')");544	}545546	#[test]547	#[should_panic]548	fn tailstrict_args() {549		eval!("local test(a) = 2; test(error '3') tailstrict");550	}551552	#[test]553	#[should_panic]554	fn no_binding_error() {555		eval!("a");556	}557558	#[test]559	fn test_object() {560		assert_json!("{a:2}", r#"{"a": 2}"#);561		assert_json!("{a:2+2}", r#"{"a": 4}"#);562		assert_json!("{a:2}+{b:2}", r#"{"a": 2,"b": 2}"#);563		assert_json!("{b:3}+{b:2}", r#"{"b": 2}"#);564		assert_json!("{b:3}+{b+:2}", r#"{"b": 5}"#);565		assert_json!("local test='a'; {[test]:2}", r#"{"a": 2}"#);566		assert_json!(567			r#"568				{569					name: "Alice",570					welcome: "Hello " + self.name + "!",571				}572			"#,573			r#"{"name": "Alice","welcome": "Hello Alice!"}"#574		);575		assert_json!(576			r#"577				{578					name: "Alice",579					welcome: "Hello " + self.name + "!",580				} + {581					name: "Bob"582				}583			"#,584			r#"{"name": "Bob","welcome": "Hello Bob!"}"#585		);586	}587588	#[test]589	fn functions() {590		assert_json!(r#"local a = function(b, c = 2) b + c; a(2)"#, "4");591		assert_json!(592			r#"local a = function(b, c = "Dear") b + c + d, d = "World"; a("Hello")"#,593			r#""HelloDearWorld""#594		);595	}596597	#[test]598	fn local_methods() {599		assert_json!(r#"local a(b, c = 2) = b + c; a(2)"#, "4");600		assert_json!(601			r#"local a(b, c = "Dear") = b + c + d, d = "World"; a("Hello")"#,602			r#""HelloDearWorld""#603		);604	}605606	#[test]607	fn object_locals() {608		assert_json!(r#"{local a = 3, b: a}"#, r#"{"b": 3}"#);609		assert_json!(r#"{local a = 3, local c = a, b: c}"#, r#"{"b": 3}"#);610		assert_json!(611			r#"{local a = function (b) {[b]:4}, test: a("test")}"#,612			r#"{"test": {"test": 4}}"#613		);614	}615616	#[test]617	fn object_comp() {618		assert_json!(619			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}"#,620			"{\"h1_2\": \"0a\",\"h1_3\": \"0a\",\"h1_4\": \"0a\",\"h2_3\": \"a1\",\"h2_4\": \"a1\",\"h3_2\": \"0a\",\"h3_4\": \"a1\"}"621		)622	}623624	#[test]625	fn direct_self() {626		println!(627			"{:#?}",628			eval!(629				r#"630					{631						local me = self,632						a: 3,633						b(): me.a,634					}635				"#636			)637		);638	}639640	#[test]641	fn indirect_self() {642		// `self` assigned to `me` was lost when being643		// referenced from field644		eval!(645			r#"{646				local me = self,647				a: 3,648				b: me.a,649			}.b"#650		);651	}652653	// We can't trust other tests (And official jsonnet testsuite), if assert is not working correctly654	#[test]655	fn std_assert_ok() {656		eval!("std.assertEqual(4.5 << 2, 16)");657	}658659	#[test]660	#[should_panic]661	fn std_assert_failure() {662		eval!("std.assertEqual(4.5 << 2, 15)");663	}664665	#[test]666	fn string_is_string() {667		assert_eq!(668			eval!("local arr = 'hello'; (!std.isArray(arr)) && (!std.isString(arr))"),669			Val::Bool(false)670		);671	}672673	#[test]674	fn base64_works() {675		assert_json!(r#"std.base64("test")"#, r#""dGVzdA==""#);676	}677678	#[test]679	fn utf8_chars() {680		assert_json!(681			r#"local c="😎";{c:std.codepoint(c),l:std.length(c)}"#,682			r#"{"c": 128526,"l": 1}"#683		)684	}685686	#[test]687	fn json() {688		assert_json!(689			r#"std.manifestJsonEx({a:3, b:4, c:6},"")"#,690			r#""{\n\"a\": 3,\n\"b\": 4,\n\"c\": 6\n}""#691		);692	}693694	#[test]695	fn test() {696		assert_json!(697			r#"[[a, b] for a in [1,2,3] for b in [4,5,6]]"#,698			"[[1,4],[1,5],[1,6],[2,4],[2,5],[2,6],[3,4],[3,5],[3,6]]"699		);700	}701702	#[test]703	fn sjsonnet() {704		eval!(705			r#"706			local x0 = {k: 1};707			local x1 = {k: x0.k + x0.k};708			local x2 = {k: x1.k + x1.k};709			local x3 = {k: x2.k + x2.k};710			local x4 = {k: x3.k + x3.k};711			local x5 = {k: x4.k + x4.k};712			local x6 = {k: x5.k + x5.k};713			local x7 = {k: x6.k + x6.k};714			local x8 = {k: x7.k + x7.k};715			local x9 = {k: x8.k + x8.k};716			local x10 = {k: x9.k + x9.k};717			local x11 = {k: x10.k + x10.k};718			local x12 = {k: x11.k + x11.k};719			local x13 = {k: x12.k + x12.k};720			local x14 = {k: x13.k + x13.k};721			local x15 = {k: x14.k + x14.k};722			local x16 = {k: x15.k + x15.k};723			local x17 = {k: x16.k + x16.k};724			local x18 = {k: x17.k + x17.k};725			local x19 = {k: x18.k + x18.k};726			local x20 = {k: x19.k + x19.k};727			local x21 = {k: x20.k + x20.k};728			x21.k729		"#730		);731	}732733	use test::Bencher;734735	// This test is commented out by default, because of huge compilation slowdown736	// #[bench]737	// fn bench_codegen(b: &mut Bencher) {738	// 	b.iter(|| {739	// 		#[allow(clippy::all)]740	// 		let stdlib = {741	// 			use jrsonnet_parser::*;742	// 			include!(concat!(env!("OUT_DIR"), "/stdlib.rs"))743	// 		};744	// 		stdlib745	// 	})746	// }747748	#[bench]749	fn bench_serialize(b: &mut Bencher) {750		b.iter(|| {751			bincode::deserialize::<jrsonnet_parser::LocExpr>(include_bytes!(concat!(752				env!("OUT_DIR"),753				"/stdlib.bincode"754			)))755			.expect("deserialize stdlib")756		})757	}758759	#[bench]760	fn bench_parse(b: &mut Bencher) {761		b.iter(|| {762			jrsonnet_parser::parse(763				jrsonnet_stdlib::STDLIB_STR,764				&jrsonnet_parser::ParserSettings {765					loc_data: true,766					file_name: Rc::new(PathBuf::from("std.jsonnet")),767				},768			)769		})770	}771}