leo/compiler/tests/mod.rs

// Copyright (C) 2019-2021 Aleo Systems Inc.
// This file is part of the Leo library.

// The Leo library is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// The Leo library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with the Leo library. If not, see <https://www.gnu.org/licenses/>.

// allow the use of EdwardsTestCompiler::parse_program_from_string for tests

#![allow(deprecated)]

pub mod address;
pub mod array;
pub mod boolean;
pub mod canonicalization;
pub mod circuits;
pub mod compiler;
pub mod console;
pub mod core;
pub mod definition;
// pub mod field;
pub mod function;
// pub mod group;
pub mod import;
pub mod input_files;
pub mod integers;
pub mod mutability;
pub mod statements;
pub mod syntax;
pub mod tuples;

use leo_asg::{new_alloc_context, new_context, AsgContext};
use leo_ast::{InputValue, MainInput};
use leo_compiler::{
    compiler::Compiler,
    errors::CompilerError,
    group::targets::edwards_bls12::EdwardsGroupType,
    ConstrainedValue,
    OutputBytes,
};
use leo_input::types::{IntegerType, U32Type, UnsignedIntegerType};

use snarkvm_curves::edwards_bls12::Fq;
use snarkvm_r1cs::TestConstraintSystem;

use std::path::PathBuf;

pub const TEST_OUTPUT_DIRECTORY: &str = "/output/";
const EMPTY_FILE: &str = "";

pub type EdwardsTestCompiler = Compiler<'static, Fq, EdwardsGroupType>;
pub type EdwardsConstrainedValue = ConstrainedValue<'static, Fq, EdwardsGroupType>;

//convenience function for tests, leaks memory
pub(crate) fn make_test_context() -> AsgContext<'static> {
    let allocator = Box::leak(Box::new(new_alloc_context()));
    new_context(allocator)
}

fn new_compiler() -> EdwardsTestCompiler {
    let program_name = "test".to_string();
    let path = PathBuf::from("/test/src/main.leo");
    let output_dir = PathBuf::from(TEST_OUTPUT_DIRECTORY);

    EdwardsTestCompiler::new(program_name, path, output_dir, make_test_context())
}

pub(crate) fn parse_program(program_string: &str) -> Result<EdwardsTestCompiler, CompilerError> {
    let mut compiler = new_compiler();

    compiler.parse_program_from_string(program_string)?;

    Ok(compiler)
}

pub(crate) fn parse_input(input_string: &str) -> Result<EdwardsTestCompiler, CompilerError> {
    let mut compiler = new_compiler();
    let path = PathBuf::new();

    compiler.parse_input(input_string, &path, EMPTY_FILE, &path)?;

    Ok(compiler)
}

pub(crate) fn parse_state(state_string: &str) -> Result<EdwardsTestCompiler, CompilerError> {
    let mut compiler = new_compiler();
    let path = PathBuf::new();

    compiler.parse_input(EMPTY_FILE, &path, state_string, &path)?;

    Ok(compiler)
}

pub(crate) fn parse_input_and_state(
    input_string: &str,
    state_string: &str,
) -> Result<EdwardsTestCompiler, CompilerError> {
    let mut compiler = new_compiler();
    let path = PathBuf::new();

    compiler.parse_input(input_string, &path, state_string, &path)?;

    Ok(compiler)
}

pub fn parse_program_with_input(
    program_string: &str,
    input_string: &str,
) -> Result<EdwardsTestCompiler, CompilerError> {
    let mut compiler = new_compiler();
    let path = PathBuf::new();

    compiler.parse_input(input_string, &path, EMPTY_FILE, &path)?;
    compiler.parse_program_from_string(program_string)?;

    Ok(compiler)
}

pub fn parse_program_with_state(
    program_string: &str,
    state_string: &str,
) -> Result<EdwardsTestCompiler, CompilerError> {
    let mut compiler = new_compiler();
    let path = PathBuf::new();

    compiler.parse_input(EMPTY_FILE, &path, state_string, &path)?;
    compiler.parse_program_from_string(program_string)?;

    Ok(compiler)
}

pub fn parse_program_with_input_and_state(
    program_string: &str,
    input_string: &str,
    state_string: &str,
) -> Result<EdwardsTestCompiler, CompilerError> {
    let mut compiler = new_compiler();
    let path = PathBuf::new();

    compiler.parse_input(input_string, &path, state_string, &path)?;
    compiler.parse_program_from_string(&program_string)?;

    Ok(compiler)
}

pub(crate) fn get_output(program: EdwardsTestCompiler) -> OutputBytes {
    // synthesize the circuit on the test constraint system
    let mut cs = TestConstraintSystem::<Fq>::new();
    let output = program.compile_constraints(&mut cs).unwrap();

    // assert the constraint system is satisfied
    assert!(cs.is_satisfied());

    output
}

pub(crate) fn assert_satisfied(program: EdwardsTestCompiler) {
    let empty_output_bytes = include_bytes!("compiler_output/empty.out");
    let res = get_output(program);

    // assert that the output is empty
    assert_eq!(empty_output_bytes, res.bytes().as_slice());
}

pub(crate) fn expect_compiler_error(program: EdwardsTestCompiler) -> CompilerError {
    let mut cs = TestConstraintSystem::<Fq>::new();
    program.compile_constraints(&mut cs).unwrap_err()
}

pub(crate) fn expect_asg_error(error: CompilerError) {
    assert!(matches!(error, CompilerError::AsgConvertError(_)))
}

pub(crate) fn generate_main_input(input: Vec<(&str, Option<InputValue>)>) -> MainInput {
    let mut main_input = MainInput::new();

    for (name, value) in input {
        main_input.insert(name.to_string(), value);
    }

    main_input
}

#[allow(clippy::unnecessary_wraps)] // consumers expect an optional value
pub(crate) fn generate_test_input_u32(number: u32) -> Option<InputValue> {
    Some(InputValue::Integer(
        IntegerType::Unsigned(UnsignedIntegerType::U32Type(U32Type {})),
        number.to_string(),
    ))
}