tests/testthat/test_console_file_menu.R

In John-Piper/consolechoice: An Easy and Quick Way to Loop a Character Vector as a Menu in the Console

library("consolechoice")


# setup -----------------------------------------------------------------------------------------------------------------------

test_folder_path <- "folder_files_for_tests"

test_pattern_for_txt_files <- ".txt"

test_pattern_for_bmp_files <- ".bmp"

test_pattern_for_no_files <- ".html"

test_args_select_one <- list(test_mode = TRUE, test_input = "1")

test_args_select_two <- list(test_mode = TRUE, test_input = "2")

test_args_select_q <- list(test_mode = TRUE, test_input = "q")

test_args_select_quit <- list(test_mode = TRUE, test_input = "quit")

test_error_msg_no_file <- "No file names were found in the folder path and pattern provided."

test_error_msg_no_chr_args <- "Error: A non character argument used for the folder path."

expected_menu_message <- paste0("1: example_doc_one.txt\\n2: example_doc_two.txt\\nTo quit please type q and press return.\\n",
                          "Type the number in the console your choice and press enter: ")


# tests -----------------------------------------------------------------------------------------------------------------------

test_that("return the first text file in the menu", {
  expect_equal(console_file_menu(
    test_folder_path,
    test_pattern_for_txt_files,
    test_args = test_args_select_one
  ), "example_doc_one.txt")
})

test_that("return the first bmp file in the menu", {
  expect_equal(console_file_menu(
    test_folder_path,
    test_pattern_for_bmp_files,
    test_args = test_args_select_two
  ), "example_image_two.bmp")
})

test_that("expect menu message from inputs", {
  expect_output(console_file_menu(
    test_folder_path,
    test_pattern_for_txt_files,
    test_args = test_args_select_two
  ), expected_menu_message)
})

test_that("returns the second choice as a number character", {
  expect_equal(console_file_menu(
    test_folder_path,
    test_pattern_for_txt_files,
    return_number = TRUE,
    test_args = test_args_select_two
  ), "2")
})

test_that("returns the default quit key", {
  expect_equal((console_file_menu(
    test_folder_path,
    test_pattern_for_txt_files,
    return_number = TRUE,
    test_args = test_args_select_q
  )), "q")
})

test_that("Quit key argument changed,  Returns the quit key", {
  expect_equal((console_file_menu(
    test_folder_path,
    test_pattern_for_txt_files,
    quit_key = "quit",
    return_number = TRUE,
    test_args = test_args_select_quit
  )), "quit")
})


test_that("Expect error message as no files found in folder with pattern", {
  expect_error(console_file_menu(
    test_folder_path,
    test_pattern_for_no_files,
    test_args = test_args_select_one
  ), test_error_msg_no_file)
})

test_that("Expect error when non character used for first argument", {
  expect_error(console_file_menu(1), test_error_msg_no_chr_args)
})