Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

checks #61

Open
pachadotdev opened this issue Oct 19, 2022 · 1 comment
Open

checks #61

pachadotdev opened this issue Oct 19, 2022 · 1 comment

Comments

@pachadotdev
Copy link
Collaborator

Hi
I'm running a series of manual tests because I need to import a lot of files from canvas.
Do you have any urgent issues to fix in the package?

@pachadotdev
Copy link
Collaborator Author

we need to work on these

── R CMD check results ────────────────────────────────── rcanvas 0.0.0.9001 ────
Duration: 11.7s

❯ checking examples ... ERROR
  Running examples in ‘rcanvas-Ex.R’ failed
  The error most likely occurred in:
  
  > base::assign(".ptime", proc.time(), pos = "CheckExEnv")
  > ### Name: apihelpers
  > ### Title: Canvas API helpers
  > ### Aliases: apihelpers set_canvas_token set_canvas_domain check_token
  > 
  > ### ** Examples
  > 
  > set_canvas_token("abc123")
  Error in b__file_keyring_autocreate(self, private, keyring) : 
    The 'system' keyring does not exists, create it first!
  Calls: set_canvas_token ... b_file_set_with_value -> <Anonymous> -> b__file_keyring_autocreate
  Execution halted

❯ checking tests ...
  See below...

❯ checking Rd files ... WARNING
  prepare_Rd: create_course_assignment.Rd:101-103: Dropping empty section \value
  prepare_Rd: create_group_category.Rd:28-30: Dropping empty section \value
  prepare_Rd: get_group_categories.Rd:12-14: Dropping empty section \value
  prepare_Rd: get_group_category.Rd:12-14: Dropping empty section \value
  checkRd: (5) rcanvas.Rd:0-7: Must have a \description

❯ checking Rd metadata ... WARNING
  Rd files with duplicated alias 'get_group_categories':
    ‘get_group_categories.Rd’ ‘groups.Rd’

❯ checking for missing documentation entries ... WARNING
  Undocumented code objects:
    ‘upload_assignment_file’
  All user-level objects in a package should have documentation entries.
  See chapter ‘Writing R documentation files’ in the ‘Writing R
  Extensions’ manual.

❯ checking Rd \usage sections ... WARNING
  Undocumented arguments in documentation object 'create_group_category'
    ‘context_id’ ‘context_type’
  
  Undocumented arguments in documentation object 'add_enrollments'
    ‘user_ids’
  Documented arguments not in \usage in documentation object 'add_enrollments':
    ‘user_id’
  
  Undocumented arguments in documentation object 'get_group_categories'
    ‘course_id’
  Documented arguments not in \usage in documentation object 'get_group_categories':
    ‘context_type’
  
  Undocumented arguments in documentation object 'submit_file_upload_assignment'
    ‘parent_folder_id’ ‘parent_folder_path’ ‘on_duplicate’
  
  Functions with \usage entries need to have the appropriate \alias
  entries, and all their arguments documented.
  The \usage entries must correspond to syntactically valid R code.
  See chapter ‘Writing R documentation files’ in the ‘Writing R
  Extensions’ manual.

❯ checking Rd contents ... WARNING
  Argument items with no description in Rd object 'get_group_categories':
    ‘context_type’
  
  Argument items with no description in Rd object 'get_group_category':
    ‘group_category_id’

❯ checking R code for possible problems ... NOTE
  create_canvas_course: no visible binding for global variable ‘is_empty’
  create_course_content_migration: no visible binding for global variable
    ‘is_empty’
  get_course_gradebook: no visible binding for global variable ‘role’
  get_course_gradebook: no visible binding for global variable
    ‘user.name’
  get_course_gradebook: no visible binding for global variable ‘user_id’
  get_course_gradebook: no visible binding for global variable
    ‘grades.final_score’
  get_course_gradebook : <anonymous>: no visible binding for global
    variable ‘id’
  get_course_gradebook : <anonymous>: no visible binding for global
    variable ‘name’
  get_course_user_groups: no visible binding for global variable ‘id’
  get_course_user_groups: no visible binding for global variable
    ‘group_id’
  get_course_user_groups: no visible binding for global variable
    ‘group_name’
  get_course_user_groups: no visible binding for global variable
    ‘sortable_name’
  paginate: no visible global function definition for ‘txtProgressBar’
  Undefined global functions or variables:
    grades.final_score group_id group_name id is_empty name role
    sortable_name txtProgressBar user.name user_id
  Consider adding
    importFrom("utils", "txtProgressBar")
  to your NAMESPACE file.

❯ checking Rd line widths ... NOTE
  Rd file 'create_course_assignment.Rd':
    \examples lines wider than 100 characters:
       create_course_assignment(course_id = 3432432, name = "R Packages, Review", peer_reviews = TRUE, points_possible = 100, omit_from_final_ ... [TRUNCATED]
  
  Rd file 'groups.Rd':
    \examples lines wider than 100 characters:
       ## Not run: add_group(category=128,name="group name", description="description", join_level="invitation_only")
       ## Not run: add_group(category=128,name=paste('group', 1:2), description="test groups", join_level="invitation_only")
  
  These lines will be truncated in the PDF manual.

❯ checking files in ‘vignettes’ ... NOTE
  Files named as vignettes but with no recognized vignette engine:
     ‘vignettes/contributing.Rmd’
  (Is a VignetteBuilder field missing?)

❯ checking package vignettes in ‘inst/doc’ ... NOTE
  Package vignette with placeholder title ‘Vignette Title’:
    ‘overview.Rmd’

── Test failures ────────────────────────────────────────────────── testthat ────

> library(testthat)
> library(rcanvas)
> 
> test_check("rcanvas")
[ FAIL 3 | WARN 0 | SKIP 0 | PASS 0 ]

══ Failed tests ════════════════════════════════════════════════════════════════
── Error ('test-courses.R:7'): returns the correct ─────────────────────────────
Error in `get("rcanvas_CANVAS_DOMAIN", envir = cdenv)`: object 'rcanvas_CANVAS_DOMAIN' not found
Backtrace:
    ▆
 1. └─rcanvas::get_course_list() at test-courses.R:7:2
 2.   └─rcanvas:::make_canvas_url("courses")
 3.     ├─base::paste(canvas_url(), ..., sep = "/")
 4.     └─rcanvas:::canvas_url()
 5.       ├─base::paste0(get("rcanvas_CANVAS_DOMAIN", envir = cdenv), "/api/v1")
 6.       └─base::get("rcanvas_CANVAS_DOMAIN", envir = cdenv)
── Error ('test-courses.R:29'): vectorization works: ───────────────────────────
Error in `get("rcanvas_CANVAS_DOMAIN", envir = cdenv)`: object 'rcanvas_CANVAS_DOMAIN' not found
Backtrace:
    ▆
 1. └─rcanvas::get_course_list(include = c("teachers", "total_students")) at test-courses.R:29:2
 2.   └─rcanvas:::make_canvas_url("courses")
 3.     ├─base::paste(canvas_url(), ..., sep = "/")
 4.     └─rcanvas:::canvas_url()
 5.       ├─base::paste0(get("rcanvas_CANVAS_DOMAIN", envir = cdenv), "/api/v1")
 6.       └─base::get("rcanvas_CANVAS_DOMAIN", envir = cdenv)
── Error ('test-users.R:5'): returns the correct ───────────────────────────────
Error in `get("rcanvas_CANVAS_DOMAIN", envir = cdenv)`: object 'rcanvas_CANVAS_DOMAIN' not found
Backtrace:
    ▆
 1. └─rcanvas::get_user_items(366, "details") at test-users.R:5:2
 2.   └─rcanvas:::make_canvas_url("users", user_id)
 3.     ├─base::paste(canvas_url(), ..., sep = "/")
 4.     └─rcanvas:::canvas_url()
 5.       ├─base::paste0(get("rcanvas_CANVAS_DOMAIN", envir = cdenv), "/api/v1")
 6.       └─base::get("rcanvas_CANVAS_DOMAIN", envir = cdenv)

[ FAIL 3 | WARN 0 | SKIP 0 | PASS 0 ]
Error: Test failures
Execution halted

2 errors ✖ | 5 warnings ✖ | 4 notes ✖

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant