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

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;19pub mod trace;2021pub use ctx::*;22pub use dynamic::*;23pub use error::*;24pub use evaluate::*;25pub use function::parse_function_call;26pub use import::*;27use jrsonnet_parser::*;28pub use obj::*;29use std::{cell::{Ref, RefCell, RefMut}, collections::HashMap, fmt::Debug, path::PathBuf, rc::Rc};30pub use val::*;31use trace::{offset_to_location, CodeLocation};3233type BindableFn = dyn Fn(Option<ObjValue>, Option<ObjValue>) -> Result<LazyVal>;34#[derive(Clone)]35pub enum LazyBinding {36	Bindable(Rc<BindableFn>),37	Bound(LazyVal),38}3940impl Debug for LazyBinding {41	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {42		write!(f, "LazyBinding")43	}44}45impl LazyBinding {46	pub fn evaluate(&self, this: Option<ObjValue>, super_obj: Option<ObjValue>) -> Result<LazyVal> {47		match self {48			LazyBinding::Bindable(v) => v(this, super_obj),49			LazyBinding::Bound(v) => Ok(v.clone()),50		}51	}52}5354struct EvaluationSettings {55	max_stack_frames: usize,56	max_stack_trace_size: usize,57	ext_vars: HashMap<Rc<str>, Val>,58	globals: HashMap<Rc<str>, Val>,59	import_resolver: Box<dyn ImportResolver>,60}61impl Default for EvaluationSettings {62	fn default() -> Self {63		EvaluationSettings {64			max_stack_frames: 200,65			max_stack_trace_size: 20,66			globals: Default::default(),67			ext_vars: Default::default(),68			import_resolver: Box::new(DummyImportResolver),69		}70	}71}7273#[derive(Default)]74struct EvaluationData {75	/// Used for stack-overflows and stacktraces76	stack: Vec<StackTraceElement>,77	/// Contains file source codes and evaluated results for imports and pretty78	/// printing stacktraces79	files: HashMap<Rc<PathBuf>, FileData>,80	str_files: HashMap<Rc<PathBuf>, Rc<str>>,81}8283pub struct FileData(Rc<str>, LocExpr, Option<Val>);84#[derive(Default)]85pub struct EvaluationStateInternals {86	data: RefCell<EvaluationData>,87	settings: RefCell<EvaluationSettings>,88}8990thread_local! {91	/// Contains state for currently executing file92	/// Global state is fine there93	pub(crate) static EVAL_STATE: RefCell<Option<EvaluationState>> = RefCell::new(None)94}95pub(crate) fn with_state<T>(f: impl FnOnce(&EvaluationState) -> T) -> T {96	EVAL_STATE.with(|s| f(s.borrow().as_ref().unwrap()))97}98pub fn create_error(err: Error) -> LocError {99	with_state(|s| s.error(err))100}101pub fn create_error_result<T>(err: Error) -> Result<T> {102	Err(with_state(|s| s.error(err)))103}104pub(crate) fn push<T>(105	e: &Option<ExprLocation>,106	comment: &str,107	f: impl FnOnce() -> Result<T>,108) -> Result<T> {109	if e.is_some() {110		with_state(|s| s.push(e.clone().unwrap(), comment.to_owned(), f))111	} else {112		f()113	}114}115116/// Maintains stack trace and import resolution117#[derive(Default, Clone)]118pub struct EvaluationState(Rc<EvaluationStateInternals>);119impl EvaluationState {120	fn data(&self) -> Ref<EvaluationData> {121		self.0.data.borrow()122	}123	fn data_mut(&self) -> RefMut<EvaluationData> {124		self.0.data.borrow_mut()125	}126	fn settings(&self) -> Ref<EvaluationSettings> {127		self.0.settings.borrow()128	}129	fn settings_mut(&self) -> RefMut<EvaluationSettings> {130		self.0.settings.borrow_mut()131	}132133	pub fn set_import_resolver(&self, resolver: Box<dyn ImportResolver>) {134		self.settings_mut().import_resolver = resolver;135	}136	pub fn import_resolver(&self) -> Ref<dyn ImportResolver> {137		Ref::map(self.settings(), |s|&*s.import_resolver)138	}139140	pub fn evaluate_file_to_json(141		&self,142		path: &PathBuf,143	) -> std::result::Result<Rc<str>, LocError> {144		self.import_file(&PathBuf::new(), &path).and_then(|v|v.into_json(4))145	}146	pub fn evaluate_snippet_to_json(147		&self,148		path: &PathBuf,149		snippet: &str,150	) -> std::result::Result<Rc<str>, LocError> {151		self.parse_evaluate_raw_with_source(Rc::new(path.clone()), snippet).and_then(|v|v.into_json(4))152	}153154	pub fn add_file(155		&self,156		name: Rc<PathBuf>,157		code: Rc<str>,158	) -> std::result::Result<(), ParseError> {159		self.data_mut().files.insert(160			name.clone(),161			FileData(162				code.clone(),163				parse(164					&code,165					&ParserSettings {166						file_name: name,167						loc_data: true,168					},169				)?,170				None,171			),172		);173174		Ok(())175	}176	pub fn add_parsed_file(177		&self,178		name: Rc<PathBuf>,179		code: Rc<str>,180		parsed: LocExpr,181	) -> std::result::Result<(), ()> {182		self.data_mut()183			.files184			.insert(name, FileData(code, parsed, None));185186		Ok(())187	}188	pub fn get_source(&self, name: &PathBuf) -> Option<Rc<str>> {189		let ro_map = &self.data().files;190		ro_map.get(name).map(|value| value.0.clone())191	}192	pub fn map_source_locations(&self, file: &PathBuf, locs: &[usize]) -> Vec<CodeLocation> {193		offset_to_location(&self.get_source(file).unwrap(), locs)194	}195196	pub fn evaluate_file(&self, name: &PathBuf) -> Result<Val> {197		self.run_in_state(|| {198			let expr: LocExpr = {199				let ro_map = &self.data().files;200				let value = ro_map201					.get(name)202					.unwrap_or_else(|| panic!("file not added: {:?}", name));203				if value.2.is_some() {204					return Ok(value.2.clone().unwrap());205				}206				value.1.clone()207			};208			let value = evaluate(self.create_default_context()?, &expr)?;209			{210				self.0211					.data.borrow_mut()212					.files213					.get_mut(name)214					.unwrap()215					.2216					.replace(value.clone());217			}218			Ok(value)219		})220	}221	pub(crate) fn import_file(&self, from: &PathBuf, path: &PathBuf) -> Result<Val> {222		let file_path = self.settings().import_resolver.resolve_file(from, path)?;223		{224			let files = &self.data().files;225			if files.contains_key(&file_path) {226				return self.evaluate_file(&file_path);227			}228		}229		let contents = self.settings().import_resolver.load_file_contents(&file_path)?;230		self.add_file(file_path.clone(), contents).map_err(|e| {231			create_error(Error::ImportSyntaxError(e))232		})?;233		self.evaluate_file(&file_path)234	}235	pub(crate) fn import_file_str(&self, from: &PathBuf, path: &PathBuf) -> Result<Rc<str>> {236		let path = self.settings().import_resolver.resolve_file(from, path)?;237		if !self.data().str_files.contains_key(&path) {238			let file_str = self.settings().import_resolver.load_file_contents(&path)?;239			self.data_mut()240				.str_files241				.insert(path.clone(), file_str);242		}243		Ok(self.data().str_files.get(&path).cloned().unwrap())244	}245246	pub fn parse_evaluate_raw_with_source(&self, source: Rc<PathBuf>, code: &str) -> Result<Val> {247		let parsed = parse(248			&code,249			&ParserSettings {250				file_name: source,251				loc_data: true,252			},253		)254		.unwrap();255		self.evaluate_raw(parsed)256	}257	pub fn parse_evaluate_raw(&self, code: &str) -> Result<Val> {258		self.parse_evaluate_raw_with_source(Rc::new(PathBuf::from("raw.jsonnet")), code)259	}260261	pub fn evaluate_raw(&self, code: LocExpr) -> Result<Val> {262		self.run_in_state(|| evaluate(self.create_default_context()?, &code))263	}264265	pub fn add_global(&self, name: Rc<str>, value: Val) {266		self.settings_mut().globals.insert(name, value);267	}268	pub fn add_ext_var(&self, name: Rc<str>, value: Val) {269		self.settings_mut().ext_vars.insert(name, value);270	}271	pub fn set_max_trace(&self, max_trace: usize) {272		self.settings_mut().max_stack_trace_size = max_trace;273	}274	pub fn set_max_stack(&self, max_stack: usize) {275		self.settings_mut().max_stack_frames = max_stack;276	}277278	pub fn with_stdlib(&self) -> &Self {279		let std_path = Rc::new(PathBuf::from("std.jsonnet"));280		self.run_in_state(|| {281			use jrsonnet_stdlib::STDLIB_STR;282			let mut parsed = false;283			#[cfg(feature = "codegenerated-stdlib")]284			if !parsed {285				parsed = true;286				#[allow(clippy::all)]287				let stdlib = {288					use jrsonnet_parser::*;289					include!(concat!(env!("OUT_DIR"), "/stdlib.rs"))290				};291				self.add_parsed_file(std_path.clone(), STDLIB_STR.to_owned().into(), stdlib)292					.unwrap();293			}294295			#[cfg(feature = "serialized-stdlib")]296			if !parsed {297				parsed = true;298				self.add_parsed_file(299					std_path.clone(),300					STDLIB_STR.to_owned().into(),301					bincode::deserialize(include_bytes!(concat!(302						env!("OUT_DIR"),303						"/stdlib.bincode"304					)))305					.expect("deserialize stdlib"),306				)307				.unwrap();308			}309310			if !parsed {311				self.add_file(std_path, STDLIB_STR.to_owned().into())312					.unwrap();313			}314			let val = self.evaluate_file(&PathBuf::from("std.jsonnet")).unwrap();315			self.add_global("std".into(), val);316		});317		self318	}319320	pub fn create_default_context(&self) -> Result<Context> {321		let globals = &self.settings().globals;322		let mut new_bindings: HashMap<Rc<str>, LazyBinding> = HashMap::new();323		for (name, value) in globals.iter() {324			new_bindings.insert(325				name.clone(),326				LazyBinding::Bound(resolved_lazy_val!(value.clone())),327			);328		}329		Context::new().extend_unbound(new_bindings, None, None, None)330	}331332	/// Executes code, creating new stack frame333	pub fn push<T>(334		&self,335		e: ExprLocation,336		comment: String,337		f: impl FnOnce() -> Result<T>,338	) -> Result<T> {339		{340			let mut data = self.data_mut();341			let stack = &mut data.stack;342			if stack.len() > self.settings().max_stack_frames {343				// Error creation uses data, so i drop guard here344				drop(data);345				return Err(self.error(Error::StackOverflow));346			} else {347				stack.push(StackTraceElement(e, comment));348			}349		}350		let result = f();351		self.data_mut().stack.pop();352		result353	}354355	/// Returns current stack trace356	pub fn stack_trace(&self) -> StackTrace {357		StackTrace(358			self.data()359				.stack360				.iter()361				.rev()362				.take(self.settings().max_stack_trace_size)363				.cloned()364				.collect(),365		)366	}367368	/// Creates error with stack trace369	pub fn error(&self, err: Error) -> LocError {370		LocError(err, self.stack_trace())371	}372373	/// Runs passed function in state (required, if function needs to modify stack trace)374	pub fn run_in_state<T>(&self, f: impl FnOnce() -> T) -> T {375		EVAL_STATE.with(|v| {376			let has_state = v.borrow().is_some();377			if !has_state {378				v.borrow_mut().replace(self.clone());379			}380			let result = f();381			if !has_state {382				v.borrow_mut().take();383			}384			result385		})386	}387}388389#[cfg(test)]390pub mod tests {391	use super::Val;392	use crate::EvaluationState;393	use jrsonnet_parser::*;394	use std::{path::PathBuf, rc::Rc};395396	#[test]397	fn eval_state_stacktrace() {398		let state = EvaluationState::default();399		state400			.push(401				ExprLocation(Rc::new(PathBuf::from("test1.jsonnet")), 10, 20),402				"outer".to_owned(),403				|| {404					state.push(405						ExprLocation(Rc::new(PathBuf::from("test2.jsonnet")), 30, 40),406						"inner".to_owned(),407						|| {408							Ok(())409						},410					)?;411					Ok(())412				},413			)414			.unwrap();415	}416417	#[test]418	fn eval_state_standard() {419		let state = EvaluationState::default();420		state.with_stdlib();421		assert_eq!(422			state423				.parse_evaluate_raw(r#"std.assertEqual(std.base64("test"), "dGVzdA==")"#)424				.unwrap(),425			Val::Bool(true)426		);427	}428429	macro_rules! eval {430		($str: expr) => {431			EvaluationState::default()432				.with_stdlib()433				.parse_evaluate_raw($str)434				.unwrap()435		};436	}437	macro_rules! eval_json {438		($str: expr) => {{439			let evaluator = EvaluationState::default();440			evaluator.with_stdlib();441			evaluator.run_in_state(||{442				evaluator443					.parse_evaluate_raw($str)444					.unwrap()445					.into_json(0)446					.unwrap()447					.replace("\n", "")448			})449		}}450	}451452	/// Asserts given code returns `true`453	macro_rules! assert_eval {454		($str: expr) => {455			assert_eq!(eval!($str), Val::Bool(true))456		};457	}458459	/// Asserts given code returns `false`460	macro_rules! assert_eval_neg {461		($str: expr) => {462			assert_eq!(eval!($str), Val::Bool(false))463		};464	}465	macro_rules! assert_json {466		($str: expr, $out: expr) => {467			assert_eq!(eval_json!($str), $out.replace("\t", ""))468		};469	}470471	/// Sanity checking, before trusting to another tests472	#[test]473	fn equality_operator() {474		assert_eval!("2 == 2");475		assert_eval_neg!("2 != 2");476		assert_eval!("2 != 3");477		assert_eval_neg!("2 == 3");478		assert_eval!("'Hello' == 'Hello'");479		assert_eval_neg!("'Hello' != 'Hello'");480		assert_eval!("'Hello' != 'World'");481		assert_eval_neg!("'Hello' == 'World'");482	}483484	#[test]485	fn math_evaluation() {486		assert_eval!("2 + 2 * 2 == 6");487		assert_eval!("3 + (2 + 2 * 2) == 9");488	}489490	#[test]491	fn string_concat() {492		assert_eval!("'Hello' + 'World' == 'HelloWorld'");493		assert_eval!("'Hello' * 3 == 'HelloHelloHello'");494		assert_eval!("'Hello' + 'World' * 3 == 'HelloWorldWorldWorld'");495	}496497	#[test]498	fn faster_join() {499		assert_eval!("std.join([0,0], [[1,2],[3,4],[5,6]]) == [1,2,0,0,3,4,0,0,5,6]");500		assert_eval!("std.join(',', ['1','2','3','4']) == '1,2,3,4'");501	}502503	#[test]504	fn function_contexts() {505		assert_eval!(506			r#"507				local k = {508					t(name = self.h): [self.h, name],509					h: 3,510				};511				local f = {512					t: k.t(),513					h: 4,514				};515				f.t[0] == f.t[1]516			"#517		);518	}519520	#[test]521	fn local() {522		assert_eval!("local a = 2; local b = 3; a + b == 5");523		assert_eval!("local a = 1, b = a + 1; a + b == 3");524		assert_eval!("local a = 1; local a = 2; a == 2");525	}526527	#[test]528	fn object_lazyness() {529		assert_json!("local a = {a:error 'test'}; {}", r#"{}"#);530	}531532	#[test]533	fn object_inheritance() {534		assert_json!("{a: self.b} + {b:3}", r#"{"a": 3,"b": 3}"#);535	}536537	#[test]538	fn object_assertion_success() {539		eval!("{assert \"a\" in self} + {a:2}");540	}541542	#[test]543	fn object_assertion_error() {544		eval!("{assert \"a\" in self}");545	}546547	#[test]548	fn lazy_args() {549		eval!("local test(a) = 2; test(error '3')");550	}551552	#[test]553	#[should_panic]554	fn tailstrict_args() {555		eval!("local test(a) = 2; test(error '3') tailstrict");556	}557558	#[test]559	#[should_panic]560	fn no_binding_error() {561		eval!("a");562	}563564	#[test]565	fn test_object() {566		assert_json!("{a:2}", r#"{"a": 2}"#);567		assert_json!("{a:2+2}", r#"{"a": 4}"#);568		assert_json!("{a:2}+{b:2}", r#"{"a": 2,"b": 2}"#);569		assert_json!("{b:3}+{b:2}", r#"{"b": 2}"#);570		assert_json!("{b:3}+{b+:2}", r#"{"b": 5}"#);571		assert_json!("local test='a'; {[test]:2}", r#"{"a": 2}"#);572		assert_json!(573			r#"574				{575					name: "Alice",576					welcome: "Hello " + self.name + "!",577				}578			"#,579			r#"{"name": "Alice","welcome": "Hello Alice!"}"#580		);581		assert_json!(582			r#"583				{584					name: "Alice",585					welcome: "Hello " + self.name + "!",586				} + {587					name: "Bob"588				}589			"#,590			r#"{"name": "Bob","welcome": "Hello Bob!"}"#591		);592	}593594	#[test]595	fn functions() {596		assert_json!(r#"local a = function(b, c = 2) b + c; a(2)"#, "4");597		assert_json!(598			r#"local a = function(b, c = "Dear") b + c + d, d = "World"; a("Hello")"#,599			r#""HelloDearWorld""#600		);601	}602603	#[test]604	fn local_methods() {605		assert_json!(r#"local a(b, c = 2) = b + c; a(2)"#, "4");606		assert_json!(607			r#"local a(b, c = "Dear") = b + c + d, d = "World"; a("Hello")"#,608			r#""HelloDearWorld""#609		);610	}611612	#[test]613	fn object_locals() {614		assert_json!(r#"{local a = 3, b: a}"#, r#"{"b": 3}"#);615		assert_json!(r#"{local a = 3, local c = a, b: c}"#, r#"{"b": 3}"#);616		assert_json!(617			r#"{local a = function (b) {[b]:4}, test: a("test")}"#,618			r#"{"test": {"test": 4}}"#619		);620	}621622	#[test]623	fn object_comp() {624		assert_json!(625			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}"#,626			"{\"h1_2\": \"0a\",\"h1_3\": \"0a\",\"h1_4\": \"0a\",\"h2_3\": \"a1\",\"h2_4\": \"a1\",\"h3_2\": \"0a\",\"h3_4\": \"a1\"}"627		)628	}629630	#[test]631	fn direct_self() {632		println!(633			"{:#?}",634			eval!(635				r#"636					{637						local me = self,638						a: 3,639						b(): me.a,640					}641				"#642			)643		);644	}645646	#[test]647	fn indirect_self() {648		// `self` assigned to `me` was lost when being649		// referenced from field650		eval!(651			r#"{652				local me = self,653				a: 3,654				b: me.a,655			}.b"#656		);657	}658659	// We can't trust other tests (And official jsonnet testsuite), if assert is not working correctly660	#[test]661	fn std_assert_ok() {662		eval!("std.assertEqual(4.5 << 2, 16)");663	}664665	#[test]666	#[should_panic]667	fn std_assert_failure() {668		eval!("std.assertEqual(4.5 << 2, 15)");669	}670671	#[test]672	fn string_is_string() {673		assert_eq!(674			eval!("local arr = 'hello'; (!std.isArray(arr)) && (!std.isString(arr))"),675			Val::Bool(false)676		);677	}678679	#[test]680	fn base64_works() {681		assert_json!(r#"std.base64("test")"#, r#""dGVzdA==""#);682	}683684	#[test]685	fn utf8_chars() {686		assert_json!(687			r#"local c="😎";{c:std.codepoint(c),l:std.length(c)}"#,688			r#"{"c": 128526,"l": 1}"#689		)690	}691692	#[test]693	fn json() {694		assert_json!(695			r#"std.manifestJsonEx({a:3, b:4, c:6},"")"#,696			r#""{\n\"a\": 3,\n\"b\": 4,\n\"c\": 6\n}""#697		);698	}699700	#[test]701	fn test() {702		assert_json!(703			r#"[[a, b] for a in [1,2,3] for b in [4,5,6]]"#,704			"[[1,4],[1,5],[1,6],[2,4],[2,5],[2,6],[3,4],[3,5],[3,6]]"705		);706	}707708	#[test]709	fn sjsonnet() {710		eval!(711			r#"712			local x0 = {k: 1};713			local x1 = {k: x0.k + x0.k};714			local x2 = {k: x1.k + x1.k};715			local x3 = {k: x2.k + x2.k};716			local x4 = {k: x3.k + x3.k};717			local x5 = {k: x4.k + x4.k};718			local x6 = {k: x5.k + x5.k};719			local x7 = {k: x6.k + x6.k};720			local x8 = {k: x7.k + x7.k};721			local x9 = {k: x8.k + x8.k};722			local x10 = {k: x9.k + x9.k};723			local x11 = {k: x10.k + x10.k};724			local x12 = {k: x11.k + x11.k};725			local x13 = {k: x12.k + x12.k};726			local x14 = {k: x13.k + x13.k};727			local x15 = {k: x14.k + x14.k};728			local x16 = {k: x15.k + x15.k};729			local x17 = {k: x16.k + x16.k};730			local x18 = {k: x17.k + x17.k};731			local x19 = {k: x18.k + x18.k};732			local x20 = {k: x19.k + x19.k};733			local x21 = {k: x20.k + x20.k};734			x21.k735		"#736		);737	}738739	use test::Bencher;740741	// This test is commented out by default, because of huge compilation slowdown742	// #[bench]743	// fn bench_codegen(b: &mut Bencher) {744	// 	b.iter(|| {745	// 		#[allow(clippy::all)]746	// 		let stdlib = {747	// 			use jrsonnet_parser::*;748	// 			include!(concat!(env!("OUT_DIR"), "/stdlib.rs"))749	// 		};750	// 		stdlib751	// 	})752	// }753754	#[bench]755	fn bench_serialize(b: &mut Bencher) {756		b.iter(|| {757			bincode::deserialize::<jrsonnet_parser::LocExpr>(include_bytes!(concat!(758				env!("OUT_DIR"),759				"/stdlib.bincode"760			)))761			.expect("deserialize stdlib")762		})763	}764765	#[bench]766	fn bench_parse(b: &mut Bencher) {767		b.iter(|| {768			jrsonnet_parser::parse(769				jrsonnet_stdlib::STDLIB_STR,770				&jrsonnet_parser::ParserSettings {771					loc_data: true,772					file_name: Rc::new(PathBuf::from("std.jsonnet")),773				},774			)775		})776	}777}