tests/testthat/test-set_assignment.R

In MansMeg/markmyassignment: Automatic Marking of R Assignments

context("set_assignment")

test_that(desc="set_assignment() url",{
  skip_if_offline()
  skip_on_cran()
  
  correct_url1 <- "https://raw.githubusercontent.com/MansMeg/markmyassignment/master/inst/extdata/example_assignment01.yml"
  correct_url2 <- "https://raw.githubusercontent.com/MansMeg/markmyassignment/master/inst/extdata/example_assignment02.yml"
  correct_url3 <- "https://raw.githubusercontent.com/MansMeg/markmyassignment/master/inst/extdata/example_assignment03.yml"
  correct_url4 <- "https://raw.githubusercontent.com/MansMeg/markmyassignment/master/inst/extdata/example_assignment04.yml"
  correct_url5 <- "https://raw.githubusercontent.com/MansMeg/markmyassignment/master/inst/extdata/example_assignment05.yml"
  wrong_url1 <- "https://raw.githubusercontent.com/MansMeg/markmyassignment/master/inst/extdata/example_lab_file.R"
  wrong_url2 <- "https://raw.githubusercontent.com/MansMeg/markmyassignment/master/inst/extdata/file_that_do_not_exist.R"
  correct_local2_with_url <- file.path(system.file(package = "markmyassignment"), "extdata/example_assignment02.yml")

  expect_is(suppressMessages(set_assignment(correct_url1)), "character")
  expect_warning(suppressMessages(set_assignment(path = correct_url2)))
  expect_is(suppressMessages(set_assignment(path = correct_url4)), "character")
  expect_error(set_assignment(path = correct_url3))
  expect_error(set_assignment(path = correct_url5))
  expect_error(set_assignment(path = wrong_url1))
  expect_error(set_assignment(wrong_url2))
  expect_warning(suppressMessages(set_assignment(correct_local2_with_url)))

  github_url1 <- "https://github.com/MansMeg/markmyassignment/blob/master/inst/extdata/example_assignment01.yml"
  github_url2 <- "https://api.github.com/repos/MansMeg/markmyassignment/contents/inst/extdata/example_assignment01.yml"
  
  expect_is(suppressMessages(set_assignment(github_url1)), "character")
  expect_is(suppressMessages(set_assignment(github_url2)), "character")
  
})

test_that(desc="set_assignment() locally",{
  correct_local1 <- file.path(system.file(package = "markmyassignment"), "extdata/example_assignment01.yml")
  wrong_local1 <- file.path(system.file(package = "markmyassignment"), "extdata/example_lab_file.R")
  wrong_local2 <- file.path(system.file(package = "markmyassignment"), "file_that_do_not_exist.R")
  
  expect_is(suppressMessages(set_assignment(correct_local1)), "character")
  expect_error(set_assignment(wrong_local1))
  expect_error(set_assignment(wrong_local2))
  expect_error(set_assignment(super_wrong_path))
  
})

test_that(desc="show_tasks() online",{
  skip_on_cran()
  skip_if_offline()
  
  correct_url4 <- "https://raw.githubusercontent.com/MansMeg/markmyassignment/master/inst/extdata/example_assignment04.yml"
  suppressMessages(set_assignment(correct_url4))
  expect_equal(show_tasks(), c("task1"))
  
  correct_local1 <- file.path(system.file(package = "markmyassignment"), "extdata/example_assignment01.yml")
  correct_local2 <- file.path(system.file(package = "markmyassignment"), "extdata/example_assignment02.yml")
  suppressMessages(set_assignment(correct_local1))
  expect_equal(show_tasks(), c("task1","task2"))
  expect_warning(suppressMessages(set_assignment(correct_local2)))
  expect_equal(suppressWarnings(show_tasks()), c("task1","task2"))
})

test_that(desc="show_tasks() locally",{
  correct_local1 <- file.path(system.file(package = "markmyassignment"), "extdata/example_assignment01.yml")
  suppressMessages(set_assignment(correct_local1))
  expect_equal(show_tasks(), c("task1","task2"))
})


test_that(desc="show_assignment()",{
  skip_on_cran()
  skip_if_offline()  
  correct_url4 <- "https://raw.githubusercontent.com/MansMeg/markmyassignment/master/inst/extdata/example_assignment04.yml"
  suppressMessages(set_assignment(correct_url4))
  expect_output(show_assignment(), "Test assignment 04")
  expect_output(show_assignment(), "task1")
})

test_that(desc="show_assignment() locally",{
  correct_local1 <- file.path(system.file(package = "markmyassignment"), "extdata/example_assignment01.yml")
  suppressMessages(set_assignment(correct_local1))
  expect_output(show_assignment(), "Test assignment 01")
  expect_output(show_assignment(), "task1")
})


test_that(desc="check_installed_packages()",{
  assgn_path <- file.path(system.file(package = "markmyassignment"), "extdata/example_assignment08_bad_pkgs.yml")
  expect_warning(suppressMessages(set_assignment(path = assgn_path)))
  assgn_path <- file.path(system.file(package = "markmyassignment"), "extdata/example_assignment07_pkgs.yml")
  expect_warning(suppressMessages(set_assignment(path = assgn_path)))
  library(codetools)
  library(yaml)
  expect_is(suppressMessages(set_assignment(assgn_path)), "character")
  detach(name = "package:codetools")
  detach(name = "package:yaml")
})


# path_type <- markmyassignment:::path_type
test_that(desc="path_type()",{
  skip_if_offline()
  skip_on_cran()
  
  correct_url1 <- "https://raw.githubusercontent.com/MansMeg/markmyassignment/master/inst/extdata/example_assignment01.yml"
  correct_url2 <- "https://raw.githubusercontent.com/MansMeg/markmyassignment/master/inst/extdata/example_assignment02.yml"
  wrong_url1 <- "https://raw.githubusercontent.com/MansMeg/markmyassignment/master/inst/extdata/file_that_do_not_exist.R"
  wrong_url2 <- "XXX"
  github_url1 <- "https://api.github.com/repos/octokit/octokit.rb/contents/README/README.md"
  github_url2 <- "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1"
  github_url3 <- "https://github.com/octokit/octokit.rb/blob/master/README/README.md"
  github_url4 <- "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md"
  correct_local1 <- file.path(system.file(package = "markmyassignment"), "extdata/example_assignment01.yml")
  correct_local2 <- file.path(system.file(package = "markmyassignment"), "extdata/example_assignment02.yml")
  

  expect_silent(pt <- path_type(correct_url1))
  checkmate::expect_class(pt, classes = c("path_http", "path_type"))
  checkmate::expect_names(names(pt), permutation.of = "path")
  
  expect_silent(pt <- path_type(correct_url2))
  checkmate::expect_class(pt, classes = c("path_http", "path_type"))
  checkmate::expect_names(names(pt), permutation.of = "path")
  
  expect_error(pt <- path_type(wrong_url1))
  expect_error(pt <- path_type(wrong_url2))

  expect_silent(suppressMessages(pt <- path_type(github_url1)))
  checkmate::expect_class(pt, classes = c("path_github", "path_type"))
  checkmate::expect_names(names(pt), permutation.of = c("path", "owner", "repo", "branch", "subpath"))

  expect_silent(suppressMessages(pt <- path_type(github_url2)))
  checkmate::expect_class(pt, classes = c("path_github", "path_type"))
  checkmate::expect_names(names(pt), permutation.of = c("path", "owner", "repo", "branch", "subpath"))
  
  expect_silent(pt <- path_type(github_url3))
  checkmate::expect_class(pt, classes = c("path_github", "path_type"))
  checkmate::expect_names(names(pt), permutation.of = c("path", "owner", "repo", "branch", "subpath"))

  expect_silent(pt <- path_type(github_url4))
  checkmate::expect_class(pt, classes = c("path_http", "path_type"))
  checkmate::expect_names(names(pt), permutation.of = c("path"))
  
  expect_silent(pt <- path_type(correct_local1))
  checkmate::expect_class(pt, classes = c("path_local", "path_type"))
  checkmate::expect_names(names(pt), permutation.of = c("path"))

  expect_silent(pt <- path_type(correct_local2))
  checkmate::expect_class(pt, classes = c("path_local", "path_type"))
  checkmate::expect_names(names(pt), permutation.of = c("path"))
    
})

# get_assignment_full_subpath <- markmyassignment:::get_assignment_full_subpath
test_that(desc="get_assignment_full_subpath()",{
  skip_if_offline()
  skip_on_cran()
  
  correct_url1 <- "https://raw.githubusercontent.com/MansMeg/markmyassignment/master/inst/extdata/example_assignment01.yml"
  correct_url1_path_type <- path_type(correct_url1)
  correct_url2 <- "https://raw.githubusercontent.com/MansMeg/markmyassignment/master/inst/extdata/example_assignment02.yml"
  correct_url2_path_type <- path_type(correct_url2)
  
  correct_local1 <- file.path(system.file(package = "markmyassignment"), "extdata/example_assignment01.yml")
  correct_local1_path_type <- path_type(correct_local1)
  correct_local2 <- file.path(system.file(package = "markmyassignment"), "extdata/example_assignment02.yml")
  correct_local2_path_type <- path_type(correct_local2)
  
  expect_error(get_assignment_full_subpath(sub_path = "test.R", correct_url1_path_type))
  expect_silent(fp <- get_assignment_full_subpath(sub_path = "example_assignment02.yml", correct_url1_path_type))
  expect_equal(fp$path, correct_url2)
  expect_silent(fp <- get_assignment_full_subpath(sub_path = correct_url1, correct_url1_path_type))

  expect_error(get_assignment_full_subpath(sub_path = "test.R", correct_url2_path_type))
  expect_silent(fp <- get_assignment_full_subpath(sub_path = "example_assignment01.yml", correct_url1_path_type))
  expect_equal(fp$path, correct_url1)
  expect_silent(fp <- get_assignment_full_subpath(sub_path = correct_url2, correct_url2_path_type))

  expect_error(get_assignment_full_subpath(sub_path = "test.R", correct_local1_path_type))
  expect_silent(fp <- get_assignment_full_subpath(sub_path = "example_assignment02.yml", correct_local1_path_type))
  expect_equal(fp$path, correct_local2)
  expect_silent(fp <- get_assignment_full_subpath(sub_path = correct_local1, correct_local1_path_type))
  
  expect_error(get_assignment_full_subpath(sub_path = "test.R", correct_local2_path_type))
  expect_silent(fp <- get_assignment_full_subpath(sub_path = "example_assignment01.yml", correct_local2_path_type))
  expect_equal(fp$path, correct_local1)
  expect_silent(fp <- get_assignment_full_subpath(sub_path = correct_local2, correct_local2_path_type))
  
})


test_that(desc="remove_assignment()",{
  correct_local1 <- file.path(system.file(package = "markmyassignment"), "extdata/example_assignment01.yml")

  expect_is(suppressMessages(set_assignment(correct_local1)), "character")
  expect_equal(show_tasks(), c("task1", "task2"))
  
  expect_silent(remove_assignment())
  expect_error(show_tasks(), regexp = "No assignment has been set")
  
})



test_that(desc="assignment_template",{
  skip_if_offline()
  skip_on_cran()
  assignment_template_file <- file.path(system.file(package = "markmyassignment"), "extdata/assignment_template.yml")
  library(checkmate)
  expect_message(set_assignment(assignment_template_file), regexp = "Assignment template")
  detach(name = "package:checkmate")
  remove_assignment()
})