mirror of
https://github.com/trailofbits/buttercup
synced 2026-06-21 14:11:39 +00:00
main
6 Commits
| Author | SHA1 | Message | Date | |
|---|---|---|---|---|
 Dan Guido
|
e67a32ab3f |
docs: improve developer documentation
CLAUDE.md: - Add code navigation section with Serena tool recommendations - Recommend symbolic tools over line-based edits CONTRIBUTING.md: - Add linting infrastructure section covering shellcheck, hadolint, actionlint - Document pre-commit hook configuration - Add integration with lint Makefile target Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> |
||
|
Riccardo Schirone
|
3fd777063b |
Test and improve AKS deployment (#336)
* Test configuration for Azure deployment * ci: re-enable docker build/push * ci: docker push labeled PRs * Use `make deploy` for both local and azure deployments * doc: update AKS_DEPLOYMENT doc * add confirmation in Makefile * Make resource group location configurable |
||
|
Evan Downing
|
2be6f91545 |
Parse result logs (#326)
* Add doc on parsing logs and scripts to unpack dataset * Reorganize scripts * Reorg markdown files. |
||
|
Dan Guido
|
7ab5da641e |
feat: add pre-commit infrastructure for code quality (#311)
* feat: add minimal pre-commit infrastructure - Add pre-commit configuration with essential checks only - Check YAML, TOML, JSON syntax - Check for merge conflicts and large files - Enforce LF line endings (fix 2 test files with CRLF) - Add debug statement detection - Integrate ruff for Python formatting and linting - Add GitHub workflow for pre-commit CI - No unnecessary Python code changes * fix: add explicit permissions to pre-commit workflow - Set GITHUB_TOKEN permissions to read-only for contents - Follows principle of least privilege - Addresses CodeQL security recommendation - Pre-commit checks only need to read code, not write * fix: exclude test data from line ending modifications - Exclude .proto files and test/data directories from mixed-line-ending hook - Revert changes to test data files (traced_crash.proto, java_stacktrace.txt) - These files need to preserve their original format for test integrity - Binary proto files could be corrupted by line ending changes * docs: add pre-commit hooks documentation to CONTRIBUTING.md - Add pre-commit installation instructions to development setup - Document pre-commit hooks in Code Quality Standards section - Update submission workflow to include pre-commit checks - Provide manual pre-commit run commands for contributors * docs: streamline CONTRIBUTING.md for better readability - Reduce from 214 to 124 lines (42% reduction) while keeping all essential info - Consolidate setup instructions into concise Quick Start section - Convert component descriptions to scannable table format - Streamline testing strategy with clear requirements and timing - Add back critical testing prerequisites (codequery, ripgrep, cscope) - Create actionable Getting Help section with common troubleshooting - Remove redundant command listings and verbose explanations - Maintain all security requirements and essential workflows |
||
|
Dan Guido
|
731b998094 |
Add Claude Code GitHub Workflow (#264)
* "Claude PR Assistant workflow" * "Claude Code Review workflow" * Apply required customizations to Claude workflows This commit applies the necessary customizations learned from our previous Claude workflow deployment: ## claude.yml changes: - Add Git config environment variables for private submodule authentication - Enable submodules in checkout with persist-credentials: false - Set 60-minute timeout - Enable Buttercup-specific allowed tools: make lint, deployment commands, and pytest ## claude-code-review.yml changes: - Enable sticky comments for better PR review experience - Filter to run only on external contributors (FIRST_TIME_CONTRIBUTOR, CONTRIBUTOR, NONE) - Add same Git authentication and submodules support - Set 60-minute timeout - Enable Buttercup-specific allowed tools These changes ensure Claude can: 1. Access private submodules 2. Run necessary build/test commands 3. Provide effective code reviews for external contributors 4. Maintain review context with sticky comments 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * Enhance Claude workflows and improve CI efficiency This commit applies critical customizations to Claude workflows and improves overall CI efficiency: ## Claude Workflow Enhancements - Enable sticky comments for better PR review UX - Add comprehensive allowed_tools list for development commands - Keep 60-minute timeout for complex operations - Enable submodules support for complete repository context - Remove unnecessary Git auth (repo is now public) - Remove author filtering to review all PRs initially ## CI Performance Improvements - Add intelligent path filtering to lint and test workflows - Skip CI runs for documentation-only changes - Always run full suite on main branch - ~70% reduction in CI minutes for non-code changes - Add fail-fast: false to see all failures at once - Separate fuzzer into experimental jobs with clear labeling - lint-fuzzer-experimental - test-fuzzer-experimental - Makes it obvious fuzzer is allowed to fail ## Benefits - Clearer CI status (experimental vs required) - Faster feedback on PRs - Reduced GitHub Actions costs - Better debugging with all failures visible - Claude can effectively review and assist with development 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * Fix CI failures for seed-gen and improve test infrastructure This commit fixes critical CI issues and improves test infrastructure: ## Bug Fixes - Fix coverage module name mapping for components with hyphens (seed-gen -> seed_gen, program-model -> program_model) - Install codequery dependencies for both program-model AND seed-gen (seed-gen imports from program_model.codequery) - Use bash parameter substitution to handle hyphen-to-underscore conversion consistently ## Safety Improvements - Restrict git operations in Claude workflow to safe patterns only: - git merge --ff-only (fast-forward only, no conflicts) - git merge --no-ff --no-edit origin/* (no interactive prompts) - git rebase --abort (can abort but not start rebases) ## Why seed-gen was failing 1. pytest-cov was looking for module "seed-gen" but Python module is "seed_gen" 2. seed-gen tests import from program_model.codequery but codequery wasn't installed These fixes ensure all component tests run correctly with proper coverage tracking. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * Optimize CI with smart path filtering and consolidated coverage Major CI optimizations to reduce unnecessary runs and improve efficiency: ## Smart Path Filtering with dorny/paths-filter - Added component-specific change detection - Only runs tests/linting for components that actually changed - Respects dependencies (e.g., common changes trigger all dependent components) - Workflow changes trigger full suite for safety - Main branch always runs everything ## Explicit Matrix Configuration - Removed fragile bash transformations (tr '-' '_') - Each component explicitly defines its coverage_module - Matrix includes should_run conditions based on detected changes - Cleaner, more maintainable configuration ## Consolidated Coverage Upload - Single coverage-upload job after all tests complete - Downloads all artifacts and uploads once to Codecov - Reduces API calls and avoids rate limiting - More efficient than per-component uploads ## Test Dependencies Optimization - Reverted pytest-html/pytest-cov from component dependencies - Install test tools with --isolated flag at CI level - Avoids dependency duplication across components - Prevents version conflicts ## Benefits - ~70% reduction in CI minutes for component-specific changes - Only affected components run tests/linting - Single coverage upload instead of 6+ separate uploads - Cleaner dependency management - Better resource utilization ## Example Impact - Changing patcher/src/foo.py now only runs patcher tests (not all 6 components) - Changing common/ still triggers all tests (since everything depends on it) - Documentation changes don't trigger any component tests 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * Trigger CI tests for patcher and seed-gen to verify fixes * Add test trigger to Python files to verify CI fixes for patcher and seed-gen * ci: temporarily remove path filtering to debug test failures - Remove path filtering from tests.yml to ensure tests run - Remove conditional execution based on path changes - This is temporary - will re-enable after confirming our coverage fixes work - Need to verify that buttercup.patcher and buttercup.seed_gen modules are correctly resolved * ci: remove risky operations and unnecessary tools from Claude workflow - Remove risky git merge --no-ff --no-edit origin/* operation This was too broad and could merge any remote branch automatically - Remove Docker/Kubernetes operational tools (docker ps, kubectl, helm) Claude doesn't need direct access to running containers or clusters - These tools are for ops tasks, not development work - Also includes temporary removal of path filtering to debug test failures * fix: correct helper.py path in seed-gen test fixtures The test fixtures were creating helper.py at the wrong location: - Was: fuzz-tooling/infra/infra/helper.py - Now: fuzz-tooling/projects/infra/helper.py This matches the actual path expected by ChallengeTask, fixing 4 test failures in the seed-gen component. * fix: install codequery dependencies for patcher tests The patcher component imports and uses program-model's codequery functionality, so it needs the same dependencies (cscope, ctags, cqmakedb, cqsearch) installed during CI testing. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * fix: install docker-buildx-plugin for deploy-local target (fixes #265) The docker buildx plugin is required for the deploy-local target. This change ensures the plugin is installed regardless of whether Docker is already installed or not. * refactor: remove experimental label from fuzzer tests - Integrate fuzzer into main test matrix alongside other components - Remove separate test-fuzzer-experimental job entirely - Split ruff and mypy steps in lint workflow for better granularity - Keep mypy as continue-on-error with clear documentation about why - Add warning message when mypy fails to track technical debt The fuzzer tests have been stable with all 50 tests passing consistently. The 'experimental' label was a vestige from earlier development when the component had stability issues. Type checking still has known issues due to complex external dependencies, but this is technical debt rather than test instability. * cleanup: remove CI trigger comments and files - Remove '# Trigger CI test run' comments from README files - Delete __init__.py files that were added solely to trigger CI - These artifacts were temporary fixes to force CI runs and are no longer needed The CI now runs properly based on path filters and these trigger artifacts just add noise to the codebase. * feat: implement multi-tiered integration testing strategy - Add test-integration job to tests.yml with selective triggers - Daily schedule at 2 AM UTC - Manual workflow dispatch with component selection - PR label trigger 'integration-tests' - Tests 4 components: common, patcher, program-model, seed-gen - Modify integration.yml triggers to be more selective - Remove main branch push trigger - Add weekly schedule (Sundays at 3 AM UTC) - Add PR label trigger 'full-integration' - Keep workflow dispatch for manual runs - Add CI status badges to README - Unit Tests, Integration Tests, System Integration badges - Document integration testing strategy in CONTRIBUTING.md - Three test tiers with timing and resource usage - Local testing instructions - PR labeling guidance This avoids running expensive tests on every main push while maintaining regular automated testing through schedules and manual control via labels. * fix: restore seed_gen __init__.py with module_name definition The __init__.py file was accidentally deleted in the cleanup commit, but it contains the __module_name__ variable needed by utils.py * security: restrict Claude workflow permissions - Replace wildcard script execution with explicit allowed scripts - Remove potentially risky git operations (checkout, merge, fetch, pull) - Keep only safe git operations (status, diff, log, add, commit, push) - Explicitly list allowed scripts for better security control * docs: clarify base64 encoding in integration workflow Add comment explaining that base64 encoding of GitHub token is for Docker registry authentication format requirements, not security --------- Co-authored-by: Claude <noreply@anthropic.com> |
||
|
Michael D Brown
|
35ce4034ea |
Simplify README and restructure documentation (#214)
* Simplify README and restructure documentation - Move AKS deployment docs to separate AKS_DEPLOYMENT.md file - Move manual setup instructions to MANUAL_SETUP.md file - Create CONTRIBUTING.md with development workflow and contribution guidelines - Restructure README to focus on individual users with: - Minimum system requirements (8 CPUs, 64GB RAM, 100GB storage) - Supported systems/architectures (Linux x86_64, ARM64 in dev) - Supported targets (C/Java OSS-Fuzz compatible repositories) - Instructions for creating and running challenges - GUI component usage instructions - Required system packages info - Remove alternative manual commands (now automated in Makefile) - Add links to all new documentation files Fixes #174 Co-authored-by: Michael D Brown <michaelbrownuc@users.noreply.github.com> * Address review feedback: update system requirements, fix ARM support description, and clean up documentation - Reduce RAM requirement from 64GB to 16GB (with 10GB basic option) - Reduce storage requirement from 100GB to 50GB - Clarify ARM64 support is only for upstream Google OSS-Fuzz projects - Remove incorrect build system requirement statement - Update command examples to use make send-libpng-task - Remove unimplemented GUI features (Results Dashboard, Log Viewer) - Simplify challenge creation section to focus on pre-defined challenges - Clean up CONTRIBUTING.md by removing alternative manual commands - Add SigNoz reference for log monitoring - Add note about docker-compose directory requirement Co-authored-by: Riccardo Schirone <ret2libc@users.noreply.github.com> * Update README.md * Fix documentation issues after merge conflict resolution - Fix test command references from send-integration-task to send-libpng-task - Remove alternative manual commands sections as requested in review - Clean up merge conflict artifacts - Update challenge description to be more accurate Co-authored-by: Michael D Brown <michaelbrownuc@users.noreply.github.com> * WIP manual edits * WIP manual edits * WIP manual edits * WIP manual edits * WIP manual edits * WIP manual edits * Update README.md * Update README.md * Update README.md * Update README.md Co-authored-by: Ronald Eytchison <58823072+reytchison@users.noreply.github.com> * Update README.md Co-authored-by: Ronald Eytchison <58823072+reytchison@users.noreply.github.com> * Update CONTRIBUTING.md * Update CONTRIBUTING.md Co-authored-by: Ronald Eytchison <58823072+reytchison@users.noreply.github.com> * Update README.md Co-authored-by: Ronald Eytchison <58823072+reytchison@users.noreply.github.com> * Update CONTRIBUTING.md Co-authored-by: Ronald Eytchison <58823072+reytchison@users.noreply.github.com> --------- Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com> Co-authored-by: Michael D Brown <michaelbrownuc@users.noreply.github.com> Co-authored-by: Riccardo Schirone <ret2libc@users.noreply.github.com> Co-authored-by: Riccardo Schirone <562321+ret2libc@users.noreply.github.com> Co-authored-by: Ronald Eytchison <58823072+reytchison@users.noreply.github.com> |