rstudio / rstudio/pins-python

Explicitly test cache pruning of each board constructor

Open
#81 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

testing
Dominant language
Python
Stars
59
Forks
11
PR merge metrics
No merged PRs in 30d

Description

Functions like pins.constructors.board_rsconnect provide a convenient high-level entry point for users. However, while we currently test that these boards follow the correct path structure in the cache (e.g. <board_folder>/<pin_folder>/<version_folder>), we do not explicitly test that cache_prune removes files these have created.

(Note that there are independent tests of cache_prune's behavior, though; where caches are independently created then pruned)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing tests for pins.constructors.board_rsconnect and the other board constructors, then review the independent cache_prune tests. Add coverage showing that cache_prune removes files created through each board constructor, while preserving the existing cache path assertions.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
testing
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.