roc/compiler/load/tests/test_load.rs

#[macro_use]
extern crate pretty_assertions;
#[macro_use]
extern crate maplit;

extern crate bumpalo;
extern crate inlinable_string;
extern crate roc_collections;
extern crate roc_load;
extern crate roc_module;

mod helpers;

#[cfg(test)]
mod test_load {
    use crate::helpers::{fixtures_dir, test_async};
    use inlinable_string::InlinableString;
    use roc_can::def::Declaration::*;
    use roc_can::def::Def;
    use roc_collections::all::MutMap;
    use roc_constrain::module::SubsByModule;
    use roc_load::file::{load, LoadedModule};
    use roc_module::symbol::{Interns, ModuleId};
    use roc_types::pretty_print::{content_to_string, name_all_type_vars};
    use roc_types::subs::Subs;
    use std::collections::HashMap;

    // HELPERS

    async fn load_fixture(
        dir_name: &str,
        module_name: &str,
        subs_by_module: SubsByModule,
    ) -> LoadedModule {
        let src_dir = fixtures_dir().join(dir_name);
        let filename = src_dir.join(format!("{}.roc", module_name));
        let loaded = load(
            &roc_builtins::std::standard_stdlib(),
            src_dir,
            filename,
            subs_by_module,
        )
        .await;
        let loaded_module = loaded.expect("Test module failed to load");

        assert_eq!(loaded_module.can_problems, Vec::new());
        assert_eq!(loaded_module.type_problems, Vec::new());

        let expected_name = loaded_module
            .interns
            .module_ids
            .get_name(loaded_module.module_id)
            .expect("Test ModuleID not found in module_ids");

        assert_eq!(expected_name, &InlinableString::from(module_name));

        loaded_module
    }

    fn expect_def(
        interns: &Interns,
        subs: &mut Subs,
        home: ModuleId,
        def: &Def,
        expected_types: &HashMap<&str, &str>,
    ) {
        for (symbol, expr_var) in &def.pattern_vars {
            let content = subs.get(*expr_var).content;

            name_all_type_vars(*expr_var, subs);

            let actual_str = content_to_string(content, subs, home, &interns);
            let fully_qualified = symbol.fully_qualified(&interns, home).to_string();
            let expected_type = expected_types
                .get(fully_qualified.as_str())
                .unwrap_or_else(|| {
                    panic!("Defs included an unexpected symbol: {:?}", fully_qualified)
                });

            assert_eq!((&symbol, expected_type), (&symbol, &actual_str.as_str()));
        }
    }

    fn expect_types(mut loaded_module: LoadedModule, expected_types: HashMap<&str, &str>) {
        let home = loaded_module.module_id;
        let mut subs = loaded_module.solved.into_inner();

        assert_eq!(loaded_module.can_problems, Vec::new());
        assert_eq!(loaded_module.type_problems, Vec::new());

        let mut num_decls = 0;

        for decl in loaded_module.declarations_by_id.remove(&home).unwrap() {
            num_decls += 1;

            match decl {
                Declare(def) => expect_def(
                    &loaded_module.interns,
                    &mut subs,
                    home,
                    &def,
                    &expected_types,
                ),
                DeclareRec(defs) => {
                    for def in defs {
                        expect_def(
                            &loaded_module.interns,
                            &mut subs,
                            home,
                            &def,
                            &expected_types,
                        );
                    }
                }
                Builtin(_) => {}
                cycle @ InvalidCycle(_, _) => {
                    panic!("Unexpected cyclic def in module declarations: {:?}", cycle);
                }
            };
        }

        assert_eq!(expected_types.len(), num_decls);
    }

    // TESTS

    #[test]
    fn interface_with_deps() {
        let subs_by_module = MutMap::default();
        let src_dir = fixtures_dir().join("interface_with_deps");
        let filename = src_dir.join("Primary.roc");

        test_async(async {
            let loaded = load(
                &roc_builtins::std::standard_stdlib(),
                src_dir,
                filename,
                subs_by_module,
            )
            .await;

            let mut loaded_module = loaded.expect("Test module failed to load");

            assert_eq!(loaded_module.can_problems, Vec::new());
            assert_eq!(loaded_module.type_problems, Vec::new());

            let def_count: usize = loaded_module
                .declarations_by_id
                .remove(&loaded_module.module_id)
                .unwrap()
                .into_iter()
                .map(|decl| decl.def_count())
                .sum();

            let expected_name = loaded_module
                .interns
                .module_ids
                .get_name(loaded_module.module_id)
                .expect("Test ModuleID not found in module_ids");

            assert_eq!(expected_name, &InlinableString::from("Primary"));
            assert_eq!(def_count, 10);
        });
    }

    #[test]
    fn load_unit() {
        test_async(async {
            let subs_by_module = MutMap::default();
            let loaded_module = load_fixture("no_deps", "Unit", subs_by_module).await;

            expect_types(
                loaded_module,
                hashmap! {
                    "unit" => "Unit",
                },
            );
        });
    }

    #[test]
    fn import_alias() {
        test_async(async {
            let subs_by_module = MutMap::default();
            let loaded_module =
                load_fixture("interface_with_deps", "ImportAlias", subs_by_module).await;

            expect_types(
                loaded_module,
                hashmap! {
                    "unit" => "Dep1.Unit",
                },
            );
        });
    }

    #[test]
    fn load_and_typecheck() {
        test_async(async {
            let subs_by_module = MutMap::default();
            let loaded_module =
                load_fixture("interface_with_deps", "WithBuiltins", subs_by_module).await;

            expect_types(
                loaded_module,
                hashmap! {
                    "floatTest" => "Float",
                    "divisionFn" => "Float, Float -> Float",
                    "divisionTest" => "Float",
                    "intTest" => "Int",
                    "x" => "Float",
                    "constantNum" => "Num *",
                    "divDep1ByDep2" => "Float",
                    "fromDep2" => "Float",
                },
            );
        });
    }

    #[test]
    fn iface_quicksort() {
        test_async(async {
            let subs_by_module = MutMap::default();
            let loaded_module =
                load_fixture("interface_with_deps", "Quicksort", subs_by_module).await;

            expect_types(
                loaded_module,
                hashmap! {
                    "swap" => "Int, Int, List a -> List a",
                    "partition" => "Int, Int, List (Num a) -> [ Pair Int (List (Num a)) ]",
                    "quicksort" => "List (Num a), Int, Int -> List (Num a)",
                },
            );
        });
    }

    #[test]
    fn app_quicksort() {
        test_async(async {
            let subs_by_module = MutMap::default();
            let loaded_module = load_fixture("app_with_deps", "Quicksort", subs_by_module).await;

            expect_types(
                loaded_module,
                hashmap! {
                    "swap" => "Int, Int, List a -> List a",
                    "partition" => "Int, Int, List (Num a) -> [ Pair Int (List (Num a)) ]",
                    "quicksort" => "List (Num a), Int, Int -> List (Num a)",
                },
            );
        });
    }

    #[test]
    fn load_astar() {
        test_async(async {
            let subs_by_module = MutMap::default();
            let loaded_module = load_fixture("interface_with_deps", "AStar", subs_by_module).await;

            expect_types(
                loaded_module,
                hashmap! {
                    "findPath" => "{ costFunction : (position, position -> Float), end : position, moveFunction : (position -> Set position), start : position } -> Result (List position) [ KeyNotFound ]*",
                    "initialModel" => "position -> Model position",
                    "reconstructPath" => "Map position position, position -> List position",
                    "updateCost" => "position, position, Model position -> Model position",
                    "cheapestOpen" => "(position -> Float), Model position -> Result position [ KeyNotFound ]*",
                    "astar" => "(position, position -> Float), (position -> Set position), position, Model position -> [ Err [ KeyNotFound ]*, Ok (List position) ]*",
                },
            );
        });
    }

    #[test]
    fn load_principal_types() {
        test_async(async {
            let subs_by_module = MutMap::default();
            let loaded_module = load_fixture("no_deps", "Principal", subs_by_module).await;

            expect_types(
                loaded_module,
                hashmap! {
                    "intVal" => "Str",
                    "identity" => "a -> a",
                },
            );
        });
    }

    #[test]
    fn iface_dep_types() {
        test_async(async {
            let subs_by_module = MutMap::default();
            let loaded_module =
                load_fixture("interface_with_deps", "Primary", subs_by_module).await;

            expect_types(
                loaded_module,
                hashmap! {
                    "blah2" => "Float",
                    "blah3" => "Str",
                    "str" => "Str",
                    "alwaysThree" => "* -> Str",
                    "identity" => "a -> a",
                    "z" => "Str",
                    "w" => "Dep1.Identity {}",
                    "succeed" => "a -> Dep1.Identity a",
                    "yay" => "Res.Res {} err",
                    "withDefault" => "Res.Res a *, a -> a",
                },
            );
        });
    }

    #[test]
    fn app_dep_types() {
        test_async(async {
            let subs_by_module = MutMap::default();
            let loaded_module = load_fixture("app_with_deps", "Primary", subs_by_module).await;

            expect_types(
                loaded_module,
                hashmap! {
                    "blah2" => "Float",
                    "blah3" => "Str",
                    "str" => "Str",
                    "alwaysThree" => "* -> Str",
                    "identity" => "a -> a",
                    "z" => "Str",
                    "w" => "Dep1.Identity {}",
                    "succeed" => "a -> Dep1.Identity a",
                    "yay" => "Res.Res {} err",
                    "withDefault" => "Res.Res a *, a -> a",
                },
            );
        });
    }

    #[test]
    fn imported_dep_regression() {
        test_async(async {
            let subs_by_module = MutMap::default();
            let loaded_module = load_fixture("interface_with_deps", "OneDep", subs_by_module).await;

            expect_types(
                loaded_module,
                hashmap! {
                    "str" => "Str",
                },
            );
        });
    }

    // #[test]
    // fn load_records() {
    //     test_async(async {
    //         use roc::types::{ErrorType, Mismatch, Problem, TypeExt};

    //         let subs_by_module = MutMap::default();
    //         let loaded_module =
    //             load_fixture("interface_with_deps", "Records", subs_by_module).await;

    //         // NOTE: `a` here is unconstrained, so unifies with <type error>
    //         let expected_types = hashmap! {
    //             "Records.intVal" => "a",
    //         };

    //         let a = ErrorType::FlexVar("a".into());

    //         let mut record = SendMap::default();
    //         record.insert("x".into(), a);

    //         let problem = Problem::Mismatch(
    //             Mismatch::TypeMismatch,
    //             ErrorType::Record(SendMap::default(), TypeExt::Closed),
    //             ErrorType::Record(record, TypeExt::FlexOpen("b".into())),
    //         );

    //         assert_eq!(loaded_module.problems, vec![problem]);
    //         assert_eq!(expected_types.len(), loaded_module.declarations.len());

    //         let mut subs = loaded_module.solved.into_inner();

    //         for decl in loaded_module.declarations {
    //             let def = match decl {
    //                 Declare(def) => def,
    //                 rec_decl @ DeclareRec(_) => {
    //                     panic!(
    //                         "Unexpected recursive def in module declarations: {:?}",
    //                         rec_decl
    //                     );
    //                 }
    //                 cycle @ InvalidCycle(_, _) => {
    //                     panic!("Unexpected cyclic def in module declarations: {:?}", cycle);
    //                 }
    //             };

    //             for (symbol, expr_var) in def.pattern_vars {
    //                 let content = subs.get(expr_var).content;

    //                 name_all_type_vars(expr_var, &mut subs);

    //                 let actual_str = content_to_string(content, &mut subs);
    //                 let expected_type = expected_types.get(symbol.as_str()).unwrap_or_else(|| {
    //                     panic!("Defs included an unexpected symbol: {:?}", symbol)
    //                 });

    //                 assert_eq!((&symbol, expected_type), (&symbol, &actual_str.as_str()));
    //             }
    //         }
    //     });
    // }
}