lbryio/lbry-sdk

Ensure that default download directory is writable on daemon startup

Open

#3,270 opened on Apr 20, 2021

View on GitHub
 (10 comments) (0 reactions) (0 assignees)Python (7,220 stars) (500 forks)batch import
area: downloadsgood first issuehelp wantedtype: improvement

Description

Creating a new issue based on lbryio/lbry-sdk#877

  • Update ensure_directory_exists() to check that the directory is writable by the current process.
  • If it's not, return a useful error
  • Add tests to cover the case when
    • download directory does not exist
    • download dir exists but is not writable
    • dir exists and is writable
    • the path refers to a file not a directory

bonus: also check if disk is full when sdk starts. this check should be outside ensure_directory_exists(). it probably goes somewhere near here

Contributor guide

Tech stack
python
Domain
backend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Pythonfile system operationsunit testing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Update `ensure directory exists()` in `lbry/extras/cli.py` to verify the download directory is writable and return a useful error if not. Add unit tests covering the cases: directory does not exist, exists but not writable, exists and writable, and path is a file. Optionally, add disk space check near line 296. See related issue lbryio/lbry sdk#877 and existing test patterns in the repository.