microsoft/RecursiveExtractor

Improve tests to validate the correct contents of extracted files

Open

#104 opened on Dec 20, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C# (36 forks)auto 404
enhancementgood first issuetest

Repository metrics

Stars
 (218 stars)
PR merge metrics
 (PR metrics pending)

Description

Currently the tests primarily check that the correct number of files are returned from extraction commands. However, as the issue identified in #102 shows this can be insufficient in cases where the underlying library may not be threadsafe (for example). In such cases the tests can still succeed, finding the correct number of files, but their contents may be incomplete. We should develop additional tests that verify for each file type we support that the contents + sizes of each file are correct. Perhaps the easiest method would be with a hash of the contents of the extracted stream.

Contributor guide

Research direction
Examine the existing test suite, identify the tests that count files, and add assertions that verify file content integrity using hashes (e.g., MD5 or SHA) for each supported archive type.
Tech stack
csharp
Domain
backendtesting
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#Gittesting basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65