trailofbits/manticore

Cleanup Manticore workspace when a test passes

Open

#1,617 opened on Feb 21, 2020

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (481 forks)batch import
good first issuetesting

Repository metrics

Stars
 (3,469 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

It's nice if testing doesn't produce unnecessary artifacts after running with success but keeps relevant info on fail for further inspection.

Pytest should have a nice way of creating fixtures that can post-process a test based on whether it failed or not https://docs.pytest.org/en/latest/example/simple.html#making-test-result-information-available-in-fixtures

If a test fails, then keep the Manticore workspace, and, if possible, print the associated failed test's workspace directory in the pytest output to know where the user should look.

If a test passes, then remove the Manticore workspace.

Since some of our tests are structured differently, the exact implementation will likely look different for different tests.

@reaperhulk Do you have any comments, suggestions, or references for doing something like this?

Contributor guide

Research direction
Read the pytest documentation on making test result information available in fixtures, then examine the existing Manticore test fixtures to implement conditional cleanup of workspace based on test pass/fail. Print the workspace directory on failure for debugging.
Tech stack
python
Domain
testing
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.
1-3 hours
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
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75