1.0 release

Author: alejomoles

.gitignore

@@ -5,7 +5,6 @@ test-bot*/
 .vscode copy/launch.json
 .vscode copy/settings.json
 third_party/*
-config/*
 
 Skip to content
 
@@ -224,4 +223,3 @@ gitignore/Python.gitignore at main · github/gitignore · GitHub
 
 tests/backend/api/__pycache__/__init__.cpython-310.pyc
 tests/backend/api/__pycache__/__init__.cpython-310.pyc
-config

Dockerfile

@@ -0,0 +1,17 @@
+# Use an official Python runtime as a parent image
+FROM python:3.13-slim
+
+# Set the working directory in the container
+WORKDIR /app
+
+# Copy the bot source code into the container
+COPY . /app
+
+# Install any needed packages specified in requirements.txt
+RUN pip install --no-cache-dir -r requirements.txt
+
+# Define environment variables
+ENV PYTHONUNBUFFERED=1
+
+# Command to run the bot
+CMD ["python", "butler.py", "run_bot", "-c", "config" "test-bot"]

README.md

@@ -1,52 +1,17 @@
+## Documentation Index
 
+Below is an index of the available documentation files:
 
-# Introduction
+### General Documentation
 
-PinguBot is a fuzzing bot that allows you to automate your software testing. Fuzzy testing is a technique that injects random data into software to trigger unexpected behavior. PinguBot is designed to perform a specific set of tasks that cover various aspects of fuzzing, including:
+- [PinguBot Documentation](docs/bot-documentation.md): Overview of PinguBot's features and usage.
+- [Configuration](docs/configuration.md): Details about configuring PinguBot.
 
-1. **Analyze**: This task runs a manually uploaded test case against a job to see if it crashes. It helps to determine if a specific test case is viable for fuzz testing.
-2. **Blame**: This task helps you identify the specific code that caused a problem detected during the fuzzing process. It helps to locate the root cause of an issue much more quickly than manual troubleshooting.
-3. **Corpus pruning**: This task minimizes a corpus to the smallest size based on coverage (libFuzzer only).
-4. **Fuzz**: This task runs a fuzzing session, which involves injecting random data into a piece of software to trigger unexpected behavior and find vulnerabilities.
-5. **Impact analysis**: This task analyzes the potential impact of vulnerabilities detected during the fuzzing process, including the probability of execution, the severity, and the possible damage if the vulnerability is exploited.
-6. **Minimization**: This task performs testcase minimization, which helps to reduce the time and resources required for testing.
-7. **Train RNN generator**: This task involves training and retraining a machine learning model in the context of fuzzing.
-8. **Progression testing**: This task checks if a test case still reproduces or if it's fixed. It helps to determine if previous bugs have been resolved or if new bugs have been introduced during a code change.
-9. **Regression testing**: This task calculates the revision range in which a crash was introduced. This helps to determine the source of the issue and the changes that need to be reverted to fix the problem.
-10. **Symbolize**: This task automatically generates a symbolic table for a piece of software, making it easier to analyze a bug or issue when it occurs.
-11. **Unpack**: This task automatically unpacks a piece of software, making it easier to analyze its behavior and detect vulnerabilities.
-12. **Upload reports**: This task automatically uploads the reports generated by the other tasks to a remote server for analysis and archival.
-13. **Variant analysis**: This task allows you to run variants of a piece of software to see how it behaves in different scenarios, making it easier to detect and fix issues.
+### Task Documentation
 
- By automating these tasks, you can save time and increase the efficiency of your software testing process."
-
-
-
-# Deplyment & Usage
-
-[Deployment](../../docs/deployment_instructions.md) and bot usage can be handled with the [Butler command line](../../docs/butler.md#Run-Bot-Command), which is part of the Pingucrew project. For added convenience, Pingubot also includes its own Butler command line that only includes the **run_bot** command. If you're exclusively using the PinguBot repository, you'll need to install the Python dependencies before running the Butler command line.
-
-```bash
-# create a local virtual enviroment
-python -m venv .venv
-
-# Activate the clean enviroment
-source .venv/bin/activate
-
-# install pip dependencies
-pip install -r requirements.txt
-```
-
-
-
-Once all the dependencies are installed the bot can be exeuted using the following command:
-
-```bash
-python butler.py run_bot -c configs/test/bot test-bot
-```
-
-**Note**: that when running the `butlerrun_bot` command, a new working directory named `test-bot` is created. This directory includes the source code of the bot as well as all the files and folders from the original `bot_working_directory` folder. Additionally, the command includes the `--testing` flag, which sets the Python ROOT_DIR to the original `src/bot` folder. This allows developers to debug and modify code during the development process, without relying on the copied code. This feature is intended to provide convenience and improve the development experience.
-
-# Bot Architecture
-
-The bot internal details can be found in the [architecture document](docs/architecture.md).
+- [Analyze Task](docs/tasks/analyze_task.md): Information about the analyze task.
+- [Fuzz Task](docs/tasks/fuzz_task.md): Details about fuzzing sessions and strategies.
+- [Minimize Task](docs/tasks/minimize_task.md): Guide to test case minimization.
+- [Regression Task](docs/tasks/regression_task.md): Explanation of regression testing.
+- [Progression Task](docs/tasks/progression_task.md): Details about progression testing.
+- [Symbolize Task](docs/tasks/symbolize_task.md): Guide to generating symbolized stack traces.

bot_working_directory/cache/cache-b6f386a850d6639b95f04f764cb513c5078cb7da.json

@@ -76,9 +76,6 @@ def _setup():
     os.environ['PYTHONIOENCODING'] = 'UTF-8'
 
     sys.path.insert(0, os.path.abspath(os.path.join('src')))
-    from bot.system import modules
-    modules.fix_module_search_paths()
-
 
 if __name__ == '__main__':
     main()

bot_working_directory/env.yaml

@@ -0,0 +1,55 @@
+APP_ARGS: ''
+APP_ARGS_APPEND_TESTCASE: true
+APP_LAUNCH_COMMAND: ''
+APP_NAME: ''
+APP_PATH: ''
+APP_PATH_DEBUG: ''
+ASSERTS_HAVE_SECURITY_IMPLICATION: false
+BAD_BUILD_CHECK: true
+BETA_BUILD_BUCKET_PATH: ''
+BOT_NAME: luckycat
+CACHE_STORE: true
+CHECKS_HAVE_SECURITY_IMPLICATION: false
+CRASH_RETRIES: 10
+DATAFLOW_BUILD_BUCKET_PATH: ''
+ENABLE_CHECK_JNI: false
+ENABLE_DEBUG_CHECKS: false
+FAIL_RETRIES: 5
+FAIL_WAIT: 300
+FAST_WARMUP_TIMEOUT: 40
+FILTER_FUNCTIONAL_BUGS: false
+FUZZER: libFuzzer
+FUZZER_DIR: ''
+FUZZER_TIMEOUT: 5400
+FUZZ_TARGET_BUILD_BUCKET_PATH: ''
+FUZZ_TEST_TIMEOUT: 5400
+GCE_METADATA_TIMEOUT: 60
+LSAN: false
+MAX_FUZZ_THREADS: 4
+MAX_TESTCASES: 5
+MINIMIZE_RESOURCES: true
+PINGUAPI_HOST: http://127.0.0.1:8086
+PINGUAPI_KEY: AUTOGENERATED BY THE BACKEND WHEN A BOT IS CREATED
+PKG_NAME: ''
+PLATFORM: Linux
+PROCESS_POLL_INTERVAL: 0.5
+REINSTALL_APP_BEFORE_EACH_TASK: false
+RELEASE_BUILD_BUCKET_PATH: test-([0-9]+).zip
+REQUIRED_APP_ARGS: ''
+SKIP_AUTO_CLOSE_ISSUE: false
+SKIP_SYSTEM_TEMP_CLEANUP: false
+STABLE_BUILD_BUCKET_PATH: ''
+SYM_DEBUG_BUILD_BUCKET_PATH: ''
+SYM_RELEASE_BUILD_BUCKET_PATH: ''
+SYSTEM_BINARY_DIR: ''
+TESTCASES_BEFORE_STALE_PROCESS_CLEANUP: 1
+TEST_TIMEOUT: 10
+THREAD_DELAY: 0
+TIMEOUT_MULTIPLIER: 1
+TRUSTED_HOST: true
+UNPACK_ALL_FUZZ_TARGETS_AND_FILES: true
+URL_BLOCKING_OPERATIONS_TIMEOUT: 600
+USER_PROFILE_IN_MEMORY: true
+VERSION_PATTERN: ''
+WARMUP_TIMEOUT: 120
+WATCH_FOR_PROCESS_EXIT: false

butler.py

@@ -0,0 +1,3 @@
+Placeholder for platform-specific init scripts. Modify them to add cleanup
+steps you want to run after completion of a task. Examples include app
+specific artifacts cleanup from non-temp directories.

config/bot/config.yaml

@@ -1,3 +1,4 @@
+#!/bin/bash
 # Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

config/bot/init/README.md

@@ -1,4 +1,5 @@
-# Copyright 2020 Google LLC
+#!/bin/bash
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.