Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document where to save corpus #194

Open
fitzgen opened this issue Nov 22, 2019 · 2 comments
Open

Document where to save corpus #194

fitzgen opened this issue Nov 22, 2019 · 2 comments

Comments

@fitzgen
Copy link
Member

fitzgen commented Nov 22, 2019

This is something that hasn't been super clear to me, and I haven't really seen it discussed anywhere ever.

The corpus

Committing it to the project-being-fuzzed's repo seems like it could add a bunch of git overhead and even make merges difficult.

But, it is needed to "pick up where you left off" when doing time-budgeted fuzzing. Anyone fuzzing the project is going to want that corpus.

I guess it could be in a git submodule? That has its own overhead, but seems like maybe a good fit for when only some folks (or just CI or something) are fuzzing, and not every local developer.

Although, maybe I'm more concerned about this than I should be?

Do folks have thoughts on this?

@Manishearth
Copy link
Member

I don't have a strong opinion, but I do think the corpus is not actually a version controlled object and should not be in your main repo (or even a submodule). Using a newer corpus on an older commit should be fine, and vice versa. The problem with merge conflicts is a manifestation of this: it's not a thing you actually want to merge carefully.

I'd recommend you store it on a server as a file, or perhaps use a separate repo that your CI's deploy step keeps up to date (the way folks do with github pages docs). Your CI can download this repo to a folder and use it.

@fitzgen
Copy link
Member Author

fitzgen commented Dec 3, 2019

Yeah, I think keeping it in a new repo is the way to go. I'll leave this issue open for tracking documentation of that.

@fitzgen fitzgen changed the title Recommendation for whether to commit corpus to repo? Document where to save corpus Dec 3, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants