Improved mig/shared/fileio.py unit test coverage
#377
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jonasbardino
added
the
test-only
…ollow up to PR48. Minor comment clean up and line length adjustment from autopep8.
1. `read_file` 2. `read_file_lines` 3. `get_file_size` 4. `delete_file` 5. `read_head_lines` 6. `read_tail_lines` 7. `make_symlink` reusing the existing structure. Includes a TODO to fix get_file_size to actually return result value on exception as it currently doesn't and therefore effectively returns None.
1. `touch` 2. `remove_dir` 3. `remove_rec` 4. `move_file` and `move_rec` 5. `copy_file` and `copy_rec` 6. `check_empty_dir` 7. `makedirs_rec` Discovered a corner-case bug in `touch` which renders it broken for existing files and directories. So the corresponding tests are disabled and with TODO markers to fix the bug and enable them.
Please note that we effectively run unit tests as uid 0 when using the containerized setup, and that may yield rather surprising results when testing file access, because super-users have access to everything despite what the permissions indicate. The added tests take uid 0 into account and will succeed, but we should really eliminate these privileges when unit testing as they can easily cause a lot of head-scratching. The tests also uncovered a couple of additional corner case bugs in the access checks, which don't show up with the uid 0 case but need to be addressed for the general benefit. They have been registered in issue #378 for further work.
jonasbardino
force-pushed
the
add/improved-fileio-unit-test-coverage
branch
from
1ce6985 to
24f29dd
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds basic unit tests for additional
mig/shared/fileio.pyfunctions like:read_file,read_file_lines,read_head_lines,read_tail_lines,write_file_linesmake_symlink,delete_symlinktouch,delete_file,get_file_sizemakedirs_rec,remove_dir,remove_rec,check_empty_dirmove_file,move_rec,copy_file,copy_reccheck_read_access,check_write_access,check_readable,check_writable,check_readonly,check_readwritablereusing the existing structure.
Integrates PR #376 fixes so this PR should either replace the former or only be merged afterwards.
Includes a TODO to fix
get_file_sizeto actually return result value on exception as it currently doesn't and therefore effectively returnsNonee.g. for missing paths.Includes a TODO to fix a (possible py3 regression) bug in
touchto make it work again for existing files and directories.Includes tests to cover the corner-case bugs of the check access helpers registered in issue #378 when run outside the docker containers e.g. with
make unittestrather thanmake test.