module test_settings use testsuite, only: new_unittest, unittest_t, error_t, test_failed use fpm_settings, only: fpm_global_settings, get_global_settings, get_registry_settings, official_registry_base_url use fpm_filesystem, only: is_dir, join_path, mkdir, filewrite, os_delete_dir, exists, get_local_prefix use fpm_environment, only: os_is_unix use tomlf, only: toml_table, new_table use fpm_toml, only: add_table, set_value use fpm_os, only: get_absolute_path, get_current_directory implicit none private public :: collect_settings character(len=*), parameter :: tmp_folder = 'tmp' character(len=*), parameter :: config_file_name = 'config.toml' contains !> Collect unit tests. subroutine collect_settings(tests) !> Unit tests to collect. type(unittest_t), allocatable, intent(out) :: tests(:) tests = [ & & new_unittest('no-folder', no_folder, should_fail=.true.), & & new_unittest('no-file', no_file, should_fail=.true.), & & new_unittest('empty-file', empty_file), & & new_unittest('default-config-settings', default_config_settings), & & new_unittest('error-reading-table', error_reading_table, should_fail=.true.), & & new_unittest('empty-registry-table', empty_registry_table), & & new_unittest('invalid-key', invalid_key, should_fail=.true.), & & new_unittest('invalid-type', invalid_type, should_fail=.true.), & & new_unittest('has-non-existent-path-to-registry', has_non_existent_path_to_registry, should_fail=.true.), & & new_unittest('has-existent-path-to-registry', has_existent_path_to_registry), & & new_unittest('absolute-path-to-registry', absolute_path_to_registry), & & new_unittest('relative-path-to-registry', relative_path_to_registry), & & new_unittest('relative-path-to-registry-file-read', relative_path_to_registry_file_read), & & new_unittest('canonical-path-to-registry', canonical_path_to_registry), & & new_unittest('has-url-to-registry', has_url_to_registry), & & new_unittest('has-both-path-and-url-to-registry', has_both_path_and_url_to_registry, should_fail=.true.), & & new_unittest('has-both-path-and-cache-path', has_both_path_and_cache_path, should_fail=.true.), & & new_unittest('abs-cache-path-no-dir', abs_cache_path_no_dir), & & new_unittest('abs-cache-path-has-dir', abs_cache_path_has_dir), & & new_unittest('rel-cache-path-no-dir', rel_cache_path_no_dir), & & new_unittest('rel-cache-path-has-dir', rel_cache_path_has_dir) & ] end subroutine collect_settings subroutine delete_tmp_folder if (is_dir(tmp_folder)) call os_delete_dir(os_is_unix(), tmp_folder) end subroutine subroutine setup_global_settings(global_settings, error) type(fpm_global_settings), intent(out) :: global_settings type(error_t), allocatable, intent(out) :: error character(:), allocatable :: cwd call get_current_directory(cwd, error) if (allocated(error)) return global_settings%path_to_config_folder = join_path(cwd, tmp_folder) global_settings%config_file_name = config_file_name end subroutine !> Throw error when custom path to config file was entered but no folder exists. subroutine no_folder(error) type(error_t), allocatable, intent(out) :: error type(fpm_global_settings) :: global_settings call delete_tmp_folder call setup_global_settings(global_settings, error) if (allocated(error)) return call get_global_settings(global_settings, error) end subroutine !> Throw error when custom path to config file was entered but no file exists. subroutine no_file(error) type(error_t), allocatable, intent(out) :: error type(fpm_global_settings) :: global_settings call delete_tmp_folder call mkdir(tmp_folder) call setup_global_settings(global_settings, error) if (allocated(error)) return call get_global_settings(global_settings, error) end subroutine !> No custom path and config file specified, use default path and file name. subroutine default_config_settings(error) type(error_t), allocatable, intent(out) :: error type(fpm_global_settings) :: global_settings character(:), allocatable :: default_path call delete_tmp_folder call get_global_settings(global_settings, error) if (allocated(error)) return if (os_is_unix()) then default_path = join_path(get_local_prefix(), 'share', 'fpm') else default_path = join_path(get_local_prefix(), 'fpm') end if if (global_settings%path_to_config_folder /= default_path) then call test_failed(error, "Path to config folder not set correctly :'"//global_settings%config_file_name//"'") return end if if (global_settings%config_file_name /= 'config.toml') then call test_failed(error, "Config file name not set correctly :'"//global_settings%config_file_name//"'") return end if end subroutine !> Config file exists and the path to that file is set. subroutine empty_file(error) type(error_t), allocatable, intent(out) :: error type(fpm_global_settings) :: global_settings character(:), allocatable :: cwd call delete_tmp_folder call mkdir(tmp_folder) call filewrite(join_path(tmp_folder, config_file_name), ['']) call setup_global_settings(global_settings, error) if (allocated(error)) return call get_global_settings(global_settings, error) call delete_tmp_folder if (allocated(error)) return call get_current_directory(cwd, error) if (allocated(error)) return if (global_settings%path_to_config_folder /= join_path(cwd, tmp_folder)) then call test_failed(error, "global_settings%path_to_config_folder not set correctly :'" & & //global_settings%path_to_config_folder//"'"); return end if if (.not. allocated(global_settings%registry_settings)) then call test_failed(error, 'global_settings%registry_settings not be allocated'); return end if if (global_settings%registry_settings%url /= official_registry_base_url) then call test_failed(error, 'Wrong default url'); return end if if (global_settings%registry_settings%cache_path /= join_path(global_settings%path_to_config_folder, & & 'dependencies')) then call test_failed(error, 'Wrong default cache_path'); return end if end subroutine !> Invalid TOML file. subroutine error_reading_table(error) type(error_t), allocatable, intent(out) :: error type(fpm_global_settings) :: global_settings call delete_tmp_folder call mkdir(tmp_folder) call filewrite(join_path(tmp_folder, config_file_name), ['[']) call setup_global_settings(global_settings, error) if (allocated(error)) return call get_global_settings(global_settings, error) call delete_tmp_folder if (allocated(global_settings%registry_settings)) then call test_failed(error, 'Registry settings should not be allocated'); return end if end subroutine subroutine empty_registry_table(error) type(error_t), allocatable, intent(out) :: error type(fpm_global_settings) :: global_settings type(toml_table) :: table type(toml_table), pointer :: child call new_table(table) call add_table(table, 'registry', child) call get_registry_settings(child, global_settings, error) if (allocated(error)) return if (.not. allocated(global_settings%registry_settings)) then call test_failed(error, 'Registry settings not allocated'); return end if if (allocated(global_settings%registry_settings%path)) then call test_failed(error, "Path shouldn't be allocated"); return end if if (global_settings%registry_settings%url /= official_registry_base_url) then call test_failed(error, "Url not be allocated"); return end if end subroutine subroutine invalid_key(error) type(error_t), allocatable, intent(out) :: error type(fpm_global_settings) :: global_settings type(toml_table) :: table type(toml_table), pointer :: child call new_table(table) call add_table(table, 'registry', child) call set_value(child, 'invalid_key', 'abc') call get_registry_settings(child, global_settings, error) end subroutine subroutine invalid_type(error) type(error_t), allocatable, intent(out) :: error type(fpm_global_settings) :: global_settings type(toml_table) :: table type(toml_table), pointer :: child call new_table(table) call add_table(table, 'registry', child) call set_value(child, 'path', 42) call get_registry_settings(child, global_settings, error) end subroutine subroutine has_non_existent_path_to_registry(error) type(error_t), allocatable, intent(out) :: error type(fpm_global_settings) :: global_settings type(toml_table) :: table type(toml_table), pointer :: child call new_table(table) call add_table(table, 'registry', child) call set_value(child, 'path', 'nonexistent_path') call get_registry_settings(child, global_settings, error) end subroutine subroutine has_existent_path_to_registry(error) type(error_t), allocatable, intent(out) :: error type(fpm_global_settings) :: global_settings type(toml_table) :: table type(toml_table), pointer :: child character(:), allocatable :: cwd call delete_tmp_folder call mkdir(tmp_folder) call setup_global_settings(global_settings, error) if (allocated(error)) return call new_table(table) call add_table(table, 'registry', child) call set_value(child, 'path', '.') call get_registry_settings(child, global_settings, error) if (.not. allocated(global_settings%registry_settings%path)) then call test_failed(error, 'Path not allocated') return end if call delete_tmp_folder call get_current_directory(cwd, error) if (allocated(error)) return if (global_settings%registry_settings%path /= join_path(cwd, tmp_folder)) then call test_failed(error, "Path not set correctly: '"//global_settings%registry_settings%path//"'") return end if if (allocated(global_settings%registry_settings%url)) then call test_failed(error, "Url shouldn't be allocated") return end if end subroutine subroutine absolute_path_to_registry(error) type(error_t), allocatable, intent(out) :: error type(fpm_global_settings) :: global_settings character(len=:), allocatable :: abs_path type(toml_table) :: table type(toml_table), pointer :: child call delete_tmp_folder call mkdir(tmp_folder) call get_absolute_path(tmp_folder, abs_path, error) if (allocated(error)) return call setup_global_settings(global_settings, error) if (allocated(error)) return call new_table(table) call add_table(table, 'registry', child) call set_value(child, 'path', abs_path) call get_registry_settings(child, global_settings, error) call delete_tmp_folder if (allocated(error)) return if (.not. allocated(global_settings%registry_settings)) then call test_failed(error, 'Registry settings not allocated') return end if if (.not. allocated(global_settings%registry_settings%path)) then call test_failed(error, 'Path not allocated') return end if if (global_settings%registry_settings%path /= abs_path) then call test_failed(error, "Path not set correctly: '"//global_settings%registry_settings%path//"'") return end if end subroutine subroutine relative_path_to_registry(error) type(error_t), allocatable, intent(out) :: error type(fpm_global_settings) :: global_settings character(len=:), allocatable :: abs_path type(toml_table) :: table type(toml_table), pointer :: child call delete_tmp_folder call mkdir(join_path(tmp_folder, 'abc')) call setup_global_settings(global_settings, error) if (allocated(error)) return call new_table(table) call add_table(table, 'registry', child) call set_value(child, 'path', 'abc') call get_registry_settings(child, global_settings, error) call get_absolute_path(tmp_folder, abs_path, error) call delete_tmp_folder if (allocated(error)) return if (.not. allocated(global_settings%registry_settings)) then call test_failed(error, 'Registry settings not allocated') return end if if (global_settings%registry_settings%path /= join_path(abs_path, 'abc')) then call test_failed(error, "Path not set correctly: '"//global_settings%registry_settings%path//"'") return end if end subroutine ! Test that the registry path is set correctly when the path is written to and read from a config file. subroutine relative_path_to_registry_file_read(error) type(error_t), allocatable, intent(out) :: error type(fpm_global_settings) :: global_settings character(len=:), allocatable :: abs_path call delete_tmp_folder call mkdir(join_path(tmp_folder, 'abc')) call filewrite(join_path(tmp_folder, config_file_name), ['[registry]', 'path="abc"']) call setup_global_settings(global_settings, error) if (allocated(error)) return call get_global_settings(global_settings, error) call get_absolute_path(tmp_folder, abs_path, error) call delete_tmp_folder if (allocated(error)) return if (.not. allocated(global_settings%registry_settings)) then call test_failed(error, 'Registry settings not allocated') return end if if (global_settings%registry_settings%path /= join_path(abs_path, 'abc')) then call test_failed(error, "Path not set correctly: '"//global_settings%registry_settings%path//"'") return end if end subroutine subroutine canonical_path_to_registry(error) type(error_t), allocatable, intent(out) :: error type(fpm_global_settings) :: global_settings character(len=:), allocatable :: abs_path type(toml_table) :: table type(toml_table), pointer :: child call delete_tmp_folder call mkdir(tmp_folder) call setup_global_settings(global_settings, error) if (allocated(error)) return call new_table(table) call add_table(table, 'registry', child) call set_value(child, 'path', join_path('..', tmp_folder)) call get_registry_settings(child, global_settings, error) call get_absolute_path(tmp_folder, abs_path, error) call delete_tmp_folder if (allocated(error)) return if (.not. allocated(global_settings%registry_settings)) then call test_failed(error, 'Registry settings not allocated') return end if if (global_settings%registry_settings%path /= abs_path) then call test_failed(error, "Path not set correctly: '"//global_settings%registry_settings%path//"'") return end if end subroutine subroutine has_url_to_registry(error) type(error_t), allocatable, intent(out) :: error type(fpm_global_settings) :: global_settings type(toml_table) :: table type(toml_table), pointer :: child call delete_tmp_folder call mkdir(tmp_folder) call setup_global_settings(global_settings, error) if (allocated(error)) return call new_table(table) call add_table(table, 'registry', child) call set_value(child, 'url', 'http') call get_registry_settings(child, global_settings, error) call delete_tmp_folder if (.not. allocated(global_settings%registry_settings)) then call test_failed(error, 'Registry settings not allocated') return end if if (allocated(global_settings%registry_settings%path)) then call test_failed(error, "Path shouldn't be allocated: '" & & //global_settings%registry_settings%path//"'") return end if if (.not. allocated(global_settings%registry_settings%url)) then call test_failed(error, 'Url not allocated') return end if if (global_settings%registry_settings%url /= 'http') then call test_failed(error, 'Failed to parse url') return end if end subroutine subroutine has_both_path_and_url_to_registry(error) type(error_t), allocatable, intent(out) :: error type(fpm_global_settings) :: global_settings type(toml_table) :: table type(toml_table), pointer :: child call delete_tmp_folder call mkdir(tmp_folder) call setup_global_settings(global_settings, error) if (allocated(error)) return call new_table(table) call add_table(table, 'registry', child) call set_value(child, 'path', '.') call set_value(child, 'url', 'http') call get_registry_settings(child, global_settings, error) call delete_tmp_folder end subroutine subroutine has_both_path_and_cache_path(error) type(error_t), allocatable, intent(out) :: error type(fpm_global_settings) :: global_settings type(toml_table) :: table type(toml_table), pointer :: child call delete_tmp_folder call mkdir(tmp_folder) call setup_global_settings(global_settings, error) if (allocated(error)) return call new_table(table) call add_table(table, 'registry', child) call set_value(child, 'path', '.') call set_value(child, 'cache_path', 'cache') call get_registry_settings(child, global_settings, error) call delete_tmp_folder end subroutine ! Custom cache location defined via absolute path but directory doesn't exist. Create it. subroutine abs_cache_path_no_dir(error) type(error_t), allocatable, intent(out) :: error type(fpm_global_settings) :: global_settings character(len=:), allocatable :: abs_path, abs_path_to_cache type(toml_table) :: table type(toml_table), pointer :: child call delete_tmp_folder call mkdir(tmp_folder) call get_absolute_path(tmp_folder, abs_path, error) if (allocated(error)) return abs_path_to_cache = join_path(abs_path, 'cache') call setup_global_settings(global_settings, error) if (allocated(error)) return call new_table(table) call add_table(table, 'registry', child) call set_value(child, 'cache_path', abs_path_to_cache) call get_registry_settings(child, global_settings, error) if (.not. exists(abs_path_to_cache)) then call test_failed(error, "Cache directory '"//abs_path_to_cache//"' not created.") return end if if (global_settings%registry_settings%cache_path /= abs_path_to_cache) then call test_failed(error, "Cache path '"//abs_path_to_cache//"' not registered.") return end if call delete_tmp_folder end subroutine ! Custom cache location defined via absolute path for existing directory. subroutine abs_cache_path_has_dir(error) type(error_t), allocatable, intent(out) :: error type(fpm_global_settings) :: global_settings character(len=:), allocatable :: abs_path type(toml_table) :: table type(toml_table), pointer :: child call delete_tmp_folder call mkdir(join_path(tmp_folder, 'cache')) call get_absolute_path(join_path(tmp_folder, 'cache'), abs_path, error) if (allocated(error)) return call setup_global_settings(global_settings, error) if (allocated(error)) return call new_table(table) call add_table(table, 'registry', child) call set_value(child, 'cache_path', abs_path) call get_registry_settings(child, global_settings, error) if (.not. exists(abs_path)) then call test_failed(error, "Cache directory '"//abs_path//"' not created.") return end if if (global_settings%registry_settings%cache_path /= abs_path) then call test_failed(error, "Cache path '"//abs_path//"' not registered.") return end if call delete_tmp_folder end subroutine ! Custom cache location defined via relative path but directory doesn't exist. Create it. subroutine rel_cache_path_no_dir(error) type(error_t), allocatable, intent(out) :: error type(fpm_global_settings) :: global_settings character(:), allocatable :: cache_path, abs_path type(toml_table) :: table type(toml_table), pointer :: child call delete_tmp_folder call mkdir(tmp_folder) call setup_global_settings(global_settings, error) if (allocated(error)) return call new_table(table) call add_table(table, 'registry', child) call set_value(child, 'cache_path', 'cache') call get_registry_settings(child, global_settings, error) cache_path = join_path(tmp_folder, 'cache') if (.not. exists(cache_path)) then call test_failed(error, "Cache directory '"//cache_path//"' not created.") return end if call get_absolute_path(cache_path, abs_path, error) if (allocated(error)) return if (global_settings%registry_settings%cache_path /= abs_path) then call test_failed(error, "Cache path '"//cache_path//"' not registered.") return end if call delete_tmp_folder end subroutine ! Custom cache location defined via relative path for existing directory. subroutine rel_cache_path_has_dir(error) type(error_t), allocatable, intent(out) :: error type(fpm_global_settings) :: global_settings character(len=:), allocatable :: cache_path, abs_path type(toml_table) :: table type(toml_table), pointer :: child call delete_tmp_folder cache_path = join_path(tmp_folder, 'cache') call mkdir(cache_path) call setup_global_settings(global_settings, error) if (allocated(error)) return call new_table(table) call add_table(table, 'registry', child) call set_value(child, 'cache_path', 'cache') call get_registry_settings(child, global_settings, error) if (.not. exists(cache_path)) then call test_failed(error, "Cache directory '"//cache_path//"' not created.") return end if call get_absolute_path(cache_path, abs_path, error) if (allocated(error)) return if (global_settings%registry_settings%cache_path /= abs_path) then call test_failed(error, "Cache path '"//cache_path//"' not registered.") return end if call delete_tmp_folder end subroutine end module test_settings