git.delta.rocks / jrsonnet / refs/commits / 7eb32146c8af

1#![feature(box_syntax, box_patterns)]2#![feature(type_alias_impl_trait)]3#![feature(debug_non_exhaustive)]4#![feature(test)]5#![allow(macro_expanded_macro_exports_accessed_by_absolute_paths)]67extern crate test;89mod ctx;10mod dynamic;11mod error;12mod evaluate;13mod function;14mod import;15mod map;16mod obj;17mod val;1819pub use ctx::*;20pub use dynamic::*;21pub use error::*;22pub use evaluate::*;23pub use function::parse_function_call;24pub use import::*;25use jsonnet_parser::*;26pub use obj::*;27use std::{cell::RefCell, collections::HashMap, fmt::Debug, path::PathBuf, rc::Rc};28pub use val::*;2930type BindableFn = dyn Fn(Option<ObjValue>, Option<ObjValue>) -> Result<LazyVal>;31#[derive(Clone)]32pub enum LazyBinding {33	Bindable(Rc<BindableFn>),34	Bound(LazyVal),35}3637impl Debug for LazyBinding {38	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {39		write!(f, "LazyBinding")40	}41}42impl LazyBinding {43	pub fn evaluate(&self, this: Option<ObjValue>, super_obj: Option<ObjValue>) -> Result<LazyVal> {44		match self {45			LazyBinding::Bindable(v) => v(this, super_obj),46			LazyBinding::Bound(v) => Ok(v.clone()),47		}48	}49}5051pub struct EvaluationSettings {52	pub max_stack_frames: usize,53	pub max_stack_trace_size: usize,54}55impl Default for EvaluationSettings {56	fn default() -> Self {57		EvaluationSettings {58			max_stack_frames: 200,59			max_stack_trace_size: 20,60		}61	}62}6364pub struct FileData(Rc<str>, LocExpr, Option<Val>);65#[derive(Default)]66pub struct EvaluationStateInternals {67	/// Used for stack-overflows and stacktraces68	stack: RefCell<Vec<StackTraceElement>>,69	/// Contains file source codes and evaluated results for imports and pretty70	/// printing stacktraces71	files: RefCell<HashMap<Rc<PathBuf>, FileData>>,72	str_files: RefCell<HashMap<Rc<PathBuf>, Rc<str>>>,73	globals: RefCell<HashMap<Rc<str>, Val>>,7475	/// Values to use with std.extVar76	ext_vars: RefCell<HashMap<Rc<str>, Val>>,7778	settings: EvaluationSettings,79	import_resolver: Box<dyn ImportResolver>,80}8182thread_local! {83	/// Contains state for currently executing file84	/// Global state is fine there85	pub(crate) static EVAL_STATE: RefCell<Option<EvaluationState>> = RefCell::new(None)86}87pub(crate) fn with_state<T>(f: impl FnOnce(&EvaluationState) -> T) -> T {88	EVAL_STATE.with(|s| f(s.borrow().as_ref().unwrap()))89}90pub(crate) fn create_error(err: Error) -> LocError {91	with_state(|s| s.error(err))92}93pub(crate) fn create_error_result<T>(err: Error) -> Result<T> {94	Err(with_state(|s| s.error(err)))95}96pub(crate) fn push<T>(97	e: &Option<ExprLocation>,98	comment: &str,99	f: impl FnOnce() -> Result<T>,100) -> Result<T> {101	if e.is_some() {102		with_state(|s| s.push(e.clone().unwrap(), comment.to_owned(), f))103	} else {104		f()105	}106}107108/// Maintains stack trace and import resolution109#[derive(Default, Clone)]110pub struct EvaluationState(Rc<EvaluationStateInternals>);111impl EvaluationState {112	pub fn new(settings: EvaluationSettings, import_resolver: Box<dyn ImportResolver>) -> Self {113		EvaluationState(Rc::new(EvaluationStateInternals {114			settings,115			import_resolver,116			..Default::default()117		}))118	}119	pub fn add_file(120		&self,121		name: Rc<PathBuf>,122		code: Rc<str>,123	) -> std::result::Result<(), ParseError> {124		self.0.files.borrow_mut().insert(125			name.clone(),126			FileData(127				code.clone(),128				parse(129					&code,130					&ParserSettings {131						file_name: name,132						loc_data: true,133					},134				)?,135				None,136			),137		);138139		Ok(())140	}141	pub fn add_parsed_file(142		&self,143		name: Rc<PathBuf>,144		code: Rc<str>,145		parsed: LocExpr,146	) -> std::result::Result<(), ()> {147		self.0148			.files149			.borrow_mut()150			.insert(name, FileData(code, parsed, None));151152		Ok(())153	}154	pub fn get_source(&self, name: &PathBuf) -> Option<Rc<str>> {155		let ro_map = self.0.files.borrow();156		ro_map.get(name).map(|value| value.0.clone())157	}158	pub fn evaluate_file(&self, name: &PathBuf) -> Result<Val> {159		self.run_in_state(|| {160			let expr: LocExpr = {161				let ro_map = self.0.files.borrow();162				let value = ro_map163					.get(name)164					.unwrap_or_else(|| panic!("file not added: {:?}", name));165				if value.2.is_some() {166					return Ok(value.2.clone().unwrap());167				}168				value.1.clone()169			};170			let value = evaluate(self.create_default_context()?, &expr)?;171			{172				self.0173					.files174					.borrow_mut()175					.get_mut(name)176					.unwrap()177					.2178					.replace(value.clone());179			}180			Ok(value)181		})182	}183	pub(crate) fn import_file(&self, from: &PathBuf, path: &PathBuf) -> Result<Val> {184		let file_path = self.0.import_resolver.resolve_file(from, path)?;185		{186			let files = self.0.files.borrow();187			if files.contains_key(&file_path) {188				return self.evaluate_file(&file_path);189			}190		}191		let contents = self.0.import_resolver.load_file_contents(&file_path)?;192		self.add_file(file_path.clone(), contents).map_err(|e| {193			create_error(Error::ImportSyntaxError(e))194		})?;195		self.evaluate_file(&file_path)196	}197	pub(crate) fn import_file_str(&self, from: &PathBuf, path: &PathBuf) -> Result<Rc<str>> {198		let path = self.0.import_resolver.resolve_file(from, path)?;199		if !self.0.str_files.borrow().contains_key(&path) {200			let file_str = self.0.import_resolver.load_file_contents(&path)?;201			self.0202				.str_files203				.borrow_mut()204				.insert(path.clone(), file_str);205		}206		Ok(self.0.str_files.borrow().get(&path).cloned().unwrap())207	}208209	pub fn parse_evaluate_raw(&self, code: &str) -> Result<Val> {210		let parsed = parse(211			&code,212			&ParserSettings {213				file_name: Rc::new(PathBuf::from("raw.jsonnet")),214				loc_data: true,215			},216		)217		.unwrap();218		self.evaluate_raw(parsed)219	}220221	pub fn evaluate_raw(&self, code: LocExpr) -> Result<Val> {222		self.run_in_state(|| evaluate(self.create_default_context()?, &code))223	}224225	pub fn add_global(&self, name: Rc<str>, value: Val) {226		self.0.globals.borrow_mut().insert(name, value);227	}228	pub fn add_ext_var(&self, name: Rc<str>, value: Val) {229		self.0.ext_vars.borrow_mut().insert(name, value);230	}231232	pub fn with_stdlib(&self) -> &Self {233		let std_path = Rc::new(PathBuf::from("std.jsonnet"));234		self.run_in_state(|| {235			use jsonnet_stdlib::STDLIB_STR;236			let mut parsed = false;237			#[cfg(feature = "codegenerated-stdlib")]238			if !parsed {239				parsed = true;240				#[allow(clippy::all)]241				let stdlib = {242					use jsonnet_parser::*;243					include!(concat!(env!("OUT_DIR"), "/stdlib.rs"))244				};245				self.add_parsed_file(std_path.clone(), STDLIB_STR.to_owned().into(), stdlib)246					.unwrap();247			}248249			#[cfg(feature = "serialized-stdlib")]250			if !parsed {251				parsed = true;252				self.add_parsed_file(253					std_path.clone(),254					STDLIB_STR.to_owned().into(),255					bincode::deserialize(include_bytes!(concat!(256						env!("OUT_DIR"),257						"/stdlib.bincode"258					)))259					.expect("deserialize stdlib"),260				)261				.unwrap();262			}263264			if !parsed {265				self.add_file(std_path, STDLIB_STR.to_owned().into())266					.unwrap();267			}268			let val = self.evaluate_file(&PathBuf::from("std.jsonnet")).unwrap();269			self.add_global("std".into(), val);270		});271		self272	}273274	pub fn create_default_context(&self) -> Result<Context> {275		let globals = self.0.globals.borrow();276		let mut new_bindings: HashMap<Rc<str>, LazyBinding> = HashMap::new();277		for (name, value) in globals.iter() {278			new_bindings.insert(279				name.clone(),280				LazyBinding::Bound(resolved_lazy_val!(value.clone())),281			);282		}283		Context::new().extend_unbound(new_bindings, None, None, None)284	}285286	pub fn push<T>(287		&self,288		e: ExprLocation,289		comment: String,290		f: impl FnOnce() -> Result<T>,291	) -> Result<T> {292		{293			let mut stack = self.0.stack.borrow_mut();294			if stack.len() > self.0.settings.max_stack_frames {295				drop(stack);296				return Err(self.error(Error::StackOverflow));297			} else {298				stack.push(StackTraceElement(e, comment));299			}300		}301		let result = f();302		self.0.stack.borrow_mut().pop();303		result304	}305	pub fn print_stack_trace(&self) {306		for e in self.stack_trace().0 {307			println!("{:?} - {:?}", e.0, e.1)308		}309	}310	pub fn stack_trace(&self) -> StackTrace {311		StackTrace(312			self.0313				.stack314				.borrow()315				.iter()316				.rev()317				.take(self.0.settings.max_stack_trace_size)318				.cloned()319				.collect(),320		)321	}322	pub fn error(&self, err: Error) -> LocError {323		LocError(err, self.stack_trace())324	}325326	pub fn run_in_state<T>(&self, f: impl FnOnce() -> T) -> T {327		EVAL_STATE.with(|v| {328			let has_state = v.borrow().is_some();329			if !has_state {330				v.borrow_mut().replace(self.clone());331			}332			let result = f();333			if !has_state {334				v.borrow_mut().take();335			}336			result337		})338	}339}340341#[cfg(test)]342pub mod tests {343	use super::Val;344	use crate::EvaluationState;345	use jsonnet_parser::*;346	use std::{path::PathBuf, rc::Rc};347348	#[test]349	fn eval_state_stacktrace() {350		let state = EvaluationState::default();351		state352			.push(353				ExprLocation(Rc::new(PathBuf::from("test1.jsonnet")), 10, 20),354				"outer".to_owned(),355				|| {356					state.push(357						ExprLocation(Rc::new(PathBuf::from("test2.jsonnet")), 30, 40),358						"inner".to_owned(),359						|| {360							state.print_stack_trace();361							Ok(())362						},363					)?;364					Ok(())365				},366			)367			.unwrap();368	}369370	#[test]371	fn eval_state_standard() {372		let state = EvaluationState::default();373		state.with_stdlib();374		assert_eq!(375			state376				.parse_evaluate_raw(r#"std.assertEqual(std.base64("test"), "dGVzdA==")"#)377				.unwrap(),378			Val::Bool(true)379		);380	}381382	macro_rules! eval {383		($str: expr) => {384			EvaluationState::default()385				.with_stdlib()386				.parse_evaluate_raw($str)387				.unwrap()388		};389	}390	macro_rules! eval_json {391		($str: expr) => {{392			let evaluator = EvaluationState::default();393			evaluator.with_stdlib();394			evaluator.run_in_state(||{395				evaluator396					.parse_evaluate_raw($str)397					.unwrap()398					.into_json(0)399					.unwrap()400					.replace("\n", "")401			})402		}}403	}404405	/// Asserts given code returns `true`406	macro_rules! assert_eval {407		($str: expr) => {408			assert_eq!(eval!($str), Val::Bool(true))409		};410	}411412	/// Asserts given code returns `false`413	macro_rules! assert_eval_neg {414		($str: expr) => {415			assert_eq!(eval!($str), Val::Bool(false))416		};417	}418	macro_rules! assert_json {419		($str: expr, $out: expr) => {420			assert_eq!(eval_json!($str), $out.replace("\t", ""))421		};422	}423424	/// Sanity checking, before trusting to another tests425	#[test]426	fn equality_operator() {427		assert_eval!("2 == 2");428		assert_eval_neg!("2 != 2");429		assert_eval!("2 != 3");430		assert_eval_neg!("2 == 3");431		assert_eval!("'Hello' == 'Hello'");432		assert_eval_neg!("'Hello' != 'Hello'");433		assert_eval!("'Hello' != 'World'");434		assert_eval_neg!("'Hello' == 'World'");435	}436437	#[test]438	fn math_evaluation() {439		assert_eval!("2 + 2 * 2 == 6");440		assert_eval!("3 + (2 + 2 * 2) == 9");441	}442443	#[test]444	fn string_concat() {445		assert_eval!("'Hello' + 'World' == 'HelloWorld'");446		assert_eval!("'Hello' * 3 == 'HelloHelloHello'");447		assert_eval!("'Hello' + 'World' * 3 == 'HelloWorldWorldWorld'");448	}449450	#[test]451	fn faster_join() {452		assert_eval!("std.join([0,0], [[1,2],[3,4],[5,6]]) == [1,2,0,0,3,4,0,0,5,6]");453		assert_eval!("std.join(',', ['1','2','3','4']) == '1,2,3,4'");454	}455456	#[test]457	fn function_contexts() {458		assert_eval!(459			r#"460				local k = {461					t(name = self.h): [self.h, name],462					h: 3,463				};464				local f = {465					t: k.t(),466					h: 4,467				};468				f.t[0] == f.t[1]469			"#470		);471	}472473	#[test]474	fn local() {475		assert_eval!("local a = 2; local b = 3; a + b == 5");476		assert_eval!("local a = 1, b = a + 1; a + b == 3");477		assert_eval!("local a = 1; local a = 2; a == 2");478	}479480	#[test]481	fn object_lazyness() {482		assert_json!("local a = {a:error 'test'}; {}", r#"{}"#);483	}484485	#[test]486	fn object_inheritance() {487		assert_json!("{a: self.b} + {b:3}", r#"{"a": 3,"b": 3}"#);488	}489490	#[test]491	fn object_assertion_success() {492		eval!("{assert \"a\" in self} + {a:2}");493	}494495	#[test]496	fn object_assertion_error() {497		eval!("{assert \"a\" in self}");498	}499500	#[test]501	fn lazy_args() {502		eval!("local test(a) = 2; test(error '3')");503	}504505	#[test]506	#[should_panic]507	fn tailstrict_args() {508		eval!("local test(a) = 2; test(error '3') tailstrict");509	}510511	#[test]512	#[should_panic]513	fn no_binding_error() {514		eval!("a");515	}516517	#[test]518	fn test_object() {519		assert_json!("{a:2}", r#"{"a": 2}"#);520		assert_json!("{a:2+2}", r#"{"a": 4}"#);521		assert_json!("{a:2}+{b:2}", r#"{"a": 2,"b": 2}"#);522		assert_json!("{b:3}+{b:2}", r#"{"b": 2}"#);523		assert_json!("{b:3}+{b+:2}", r#"{"b": 5}"#);524		assert_json!("local test='a'; {[test]:2}", r#"{"a": 2}"#);525		assert_json!(526			r#"527				{528					name: "Alice",529					welcome: "Hello " + self.name + "!",530				}531			"#,532			r#"{"name": "Alice","welcome": "Hello Alice!"}"#533		);534		assert_json!(535			r#"536				{537					name: "Alice",538					welcome: "Hello " + self.name + "!",539				} + {540					name: "Bob"541				}542			"#,543			r#"{"name": "Bob","welcome": "Hello Bob!"}"#544		);545	}546547	#[test]548	fn functions() {549		assert_json!(r#"local a = function(b, c = 2) b + c; a(2)"#, "4");550		assert_json!(551			r#"local a = function(b, c = "Dear") b + c + d, d = "World"; a("Hello")"#,552			r#""HelloDearWorld""#553		);554	}555556	#[test]557	fn local_methods() {558		assert_json!(r#"local a(b, c = 2) = b + c; a(2)"#, "4");559		assert_json!(560			r#"local a(b, c = "Dear") = b + c + d, d = "World"; a("Hello")"#,561			r#""HelloDearWorld""#562		);563	}564565	#[test]566	fn object_locals() {567		assert_json!(r#"{local a = 3, b: a}"#, r#"{"b": 3}"#);568		assert_json!(r#"{local a = 3, local c = a, b: c}"#, r#"{"b": 3}"#);569		assert_json!(570			r#"{local a = function (b) {[b]:4}, test: a("test")}"#,571			r#"{"test": {"test": 4}}"#572		);573	}574575	#[test]576	fn object_comp() {577		assert_json!(578			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}"#,579			"{\"h1_2\": \"0a\",\"h1_3\": \"0a\",\"h1_4\": \"0a\",\"h2_3\": \"a1\",\"h2_4\": \"a1\",\"h3_2\": \"0a\",\"h3_4\": \"a1\"}"580		)581	}582583	#[test]584	fn direct_self() {585		println!(586			"{:#?}",587			eval!(588				r#"589					{590						local me = self,591						a: 3,592						b(): me.a,593					}594				"#595			)596		);597	}598599	#[test]600	fn indirect_self() {601		// `self` assigned to `me` was lost when being602		// referenced from field603		eval!(604			r#"{605				local me = self,606				a: 3,607				b: me.a,608			}.b"#609		);610	}611612	// We can't trust other tests (And official jsonnet testsuite), if assert is not working correctly613	#[test]614	fn std_assert_ok() {615		eval!("std.assertEqual(4.5 << 2, 16)");616	}617618	#[test]619	#[should_panic]620	fn std_assert_failure() {621		eval!("std.assertEqual(4.5 << 2, 15)");622	}623624	#[test]625	fn string_is_string() {626		assert_eq!(627			eval!("local arr = 'hello'; (!std.isArray(arr)) && (!std.isString(arr))"),628			Val::Bool(false)629		);630	}631632	#[test]633	fn base64_works() {634		assert_json!(r#"std.base64("test")"#, r#""dGVzdA==""#);635	}636637	#[test]638	fn utf8_chars() {639		assert_json!(640			r#"local c="😎";{c:std.codepoint(c),l:std.length(c)}"#,641			r#"{"c": 128526,"l": 1}"#642		)643	}644645	#[test]646	fn json() {647		assert_json!(648			r#"std.manifestJsonEx({a:3, b:4, c:6},"")"#,649			r#""{\n\"a\": 3,\n\"b\": 4,\n\"c\": 6\n}""#650		);651	}652653	#[test]654	fn test() {655		assert_json!(656			r#"[[a, b] for a in [1,2,3] for b in [4,5,6]]"#,657			"[[1,4],[1,5],[1,6],[2,4],[2,5],[2,6],[3,4],[3,5],[3,6]]"658		);659	}660661	#[test]662	fn sjsonnet() {663		eval!(664			r#"665			local x0 = {k: 1};666			local x1 = {k: x0.k + x0.k};667			local x2 = {k: x1.k + x1.k};668			local x3 = {k: x2.k + x2.k};669			local x4 = {k: x3.k + x3.k};670			local x5 = {k: x4.k + x4.k};671			local x6 = {k: x5.k + x5.k};672			local x7 = {k: x6.k + x6.k};673			local x8 = {k: x7.k + x7.k};674			local x9 = {k: x8.k + x8.k};675			local x10 = {k: x9.k + x9.k};676			local x11 = {k: x10.k + x10.k};677			local x12 = {k: x11.k + x11.k};678			local x13 = {k: x12.k + x12.k};679			local x14 = {k: x13.k + x13.k};680			local x15 = {k: x14.k + x14.k};681			local x16 = {k: x15.k + x15.k};682			local x17 = {k: x16.k + x16.k};683			local x18 = {k: x17.k + x17.k};684			local x19 = {k: x18.k + x18.k};685			local x20 = {k: x19.k + x19.k};686			local x21 = {k: x20.k + x20.k};687			x21.k688		"#689		);690	}691692	use test::Bencher;693694	// This test is commented out by default, because of huge compilation slowdown695	// #[bench]696	// fn bench_codegen(b: &mut Bencher) {697	// 	b.iter(|| {698	// 		#[allow(clippy::all)]699	// 		let stdlib = {700	// 			use jsonnet_parser::*;701	// 			include!(concat!(env!("OUT_DIR"), "/stdlib.rs"))702	// 		};703	// 		stdlib704	// 	})705	// }706707	#[bench]708	fn bench_serialize(b: &mut Bencher) {709		b.iter(|| {710			bincode::deserialize::<jsonnet_parser::LocExpr>(include_bytes!(concat!(711				env!("OUT_DIR"),712				"/stdlib.bincode"713			)))714			.expect("deserialize stdlib")715		})716	}717718	#[bench]719	fn bench_parse(b: &mut Bencher) {720		b.iter(|| {721			jsonnet_parser::parse(722				jsonnet_stdlib::STDLIB_STR,723				&jsonnet_parser::ParserSettings {724					loc_data: true,725					file_name: Rc::new(PathBuf::from("std.jsonnet")),726				},727			)728		})729	}730}