err0.io Open Source Test Bundle

Testing Infrastructure for 31 Major Open-Source Projects

Quick Start • Documentation • Contributing • Support

---

🎯 What is This?

A comprehensive test suite containing 31 major open-source projects as git submodules for testing the err0.io error code management agent across diverse programming languages and frameworks.

What is err0.io?

err0.io is an error code management system that automatically inserts unique error codes into your source code's logging statements, making it easier to trace and debug issues in production. This repository provides a large-scale test environment to validate the err0 agent's capabilities.

✨ Features

• 🔧 31 Production Projects - Test across real-world codebases
• 🐳 Docker-Based - Consistent execution environment
• 🤖 Automated Testing - Comprehensive soak tests and validation
• 🔒 Secure - Token-based authentication with gitignored credentials
• 📚 Multi-Language - Java, Python, Ruby, Rust, Kotlin, Swift, C#, JavaScript, and more
• ⚡ Flexible - Production, development, and local testing modes

📦 Repository Contents

This repository contains 31 open-source projects organized by category:

🤖 Android/Mobile (5 projects)

• Signal-Android - Private messaging for Android
• Signal-iOS - Private messaging for iOS
• Telegram - Messaging app for Android
• Telegram-iOS - Messaging app for iOS
• UTM - Virtual machines for iOS and macOS

☕ Backend Frameworks - JVM (4 projects)

• spring-framework - Application framework for Java
• ktor - Asynchronous framework for Kotlin
• ratpack - Web framework for Java
• tomcat - Java servlet container

🌐 Backend Frameworks - Other (4 projects)

• django - Web framework for Python
• rails - Web framework for Ruby
• vapor - Web framework for Swift
• strapi - Headless CMS for Node.js

₿ Blockchain/Cryptocurrency (1 project)

• bitcoin - Bitcoin Core implementation

📝 CMS/E-commerce (4 projects)

• WordPress - Content management system (PHP)
• drupal - Content management framework (PHP)
• magento2 - E-commerce platform (PHP)
• moodle - Learning management system (PHP)

🚀 DevOps/IoT (4 projects)

• kubernetes - Container orchestration system
• mender - OTA software updater
• SmartThingsEdgeDrivers - Samsung SmartThings drivers
• cerbos - Access control and authorization

💎 .NET (2 projects)

• Umbraco-CMS - Content management system (C#)
• roslyn - C# and Visual Basic compiler

💬 Forums/Community (1 project)

• NodeBB - Forum software (Node.js)

📧 Infrastructure (1 project)

• postfix - Mail transfer agent

🎨 Kotlin Libraries (1 project)

• kotlinx.html - HTML DSL for Kotlin

🧠 Machine Learning (1 project)

• pytorch - Machine learning framework

🦀 Rust/Systems Programming (2 projects)

• servo - Browser engine
• leptos - Web framework for Rust

🧪 Test/Example (1 project)

• zf2-orders - Internal test project

🚀 Quick Start

Prerequisites

Requirement	Version	Installation
🐳 Docker	Latest	Install Docker
📦 Git	2.13+	Pre-installed on most systems
🔧 Perl	Any	Pre-installed on Linux/macOS

Disk Space Requirements:

• Initial clone: ~500 MB
• All submodules: ~50 GB
• Individual submodules: 10 MB - 5 GB each

Installation

# 1. Clone the repository
git clone https://github.com/Err0-io/err0-open-source-bundle.git
cd err0-open-source-bundle

# 2. Initialize submodules (choose one)
# Option A: Initialize specific projects only (recommended)
git submodule update --init --depth 1 django rails kubernetes

# Option B: Initialize all projects (downloads ~50 GB)
git submodule update --init --depth 1

# Option C: Full history with err0/initial branches
./freshen-submodules.sh

# 3. Configure environment
cp .env.template .env
nano .env  # Edit with your err0 server details

# 4. Set up authentication tokens
# See tokens/README.md for instructions

First Test Run

# Test a single project
./err0agent-dev-insert.sh tokens/err0-django-*.json django

# Test all configured projects
./dev-insert.sh

📖 Documentation

Document	Description
SETUP.md	📚 Detailed setup and configuration guide
TESTING.md	🧪 Testing workflows and soak tests
SECURITY.md	🔒 Security practices and token management
CONTRIBUTING.md	🤝 Contribution guidelines
MIGRATION.md	🔄 Migration guide for existing users
tokens/README.md	🎫 Token generation instructions

🔧 Usage

Script Overview

Script	Purpose	Environment
err0agent-insert.sh	Insert error codes	Production (latest)
err0agent-dev-insert.sh	Insert error codes	Development (develop)
err0agent-localdev-insert.sh	Insert error codes	Local build
err0agent-analyse.sh	Analyze error codes	Production
err0agent-dev-analyse.sh	Analyze uncommitted changes	Development
err0agent-dev-check.sh	Check canonicalization	Development
dev-insert.sh	Bulk insert (all projects)	Development
dev-analyse.sh	Bulk analyze (all projects)	Development

Example Workflows

🧪 Test a New Feature

# Initialize submodules
./freshen-submodules.sh

# Insert error codes into all projects
./dev-insert.sh

# Review changes
git submodule foreach git diff

# Commit changes
git submodule foreach git add .
git submodule foreach git commit -m "Add err0 codes"

# Verify canonicalization
./dev-analyse.sh

🔬 Run Comprehensive Soak Test

# Full integration test (4-6 hours)
# - Creates test branches
# - Runs insert operations
# - Commits and tags changes
# - Verifies code canonicalization
# - Tests idempotency
./soak-test.pl

🏠 Test Against Local Server

# Configure for localhost
echo "ERR0_HOST=localhost:8443" > .env

# Run operations
./dev-insert.sh
./dev-analyse.sh

🔐 Security

⚠️ NEVER commit token files to version control!

• Token files contain authentication credentials
• .gitignore prevents accidental commits
• Pre-commit hooks validate no secrets are committed
• Rotate tokens regularly (every 90 days recommended)
• See SECURITY.md for detailed practices

🤝 Contributing

We welcome contributions! Here's how you can help:

• 🐛 Report Bugs - Open an issue
• 💡 Suggest Features - Start a discussion
• 📝 Improve Docs - Submit documentation improvements
• 🔧 Add Projects - Propose new open-source projects to test

See CONTRIBUTING.md for detailed guidelines.

🛠️ Troubleshooting

🐳 Docker Issues

Cannot connect to Docker daemon:

# Start Docker service
sudo systemctl start docker  # Linux
# or start Docker Desktop     # macOS/Windows

Permission denied:

# Add user to docker group (Linux)
sudo usermod -aG docker $USER
newgrp docker

📦 Submodule Issues

Submodule could not be updated:

git submodule deinit -f <project>
git submodule update --init <project>

No submodule mapping found:

git submodule sync
git submodule update --init

🎫 Token Issues

No token file found:

# Check token file naming
ls tokens/err0-django-*.json

# Verify token directory
echo $ERR0_TOKEN_DIR

# Read setup guide
cat tokens/README.md

Authentication failed:

• Verify token is not expired
• Check ERR0_HOST matches token's host field
• Ensure network connectivity to err0 server

📊 Project Structure

err0-open-source-bundle/
├── 📄 README.md                  # This file
├── 📄 SETUP.md                   # Detailed setup guide
├── 📄 TESTING.md                 # Testing documentation
├── 📄 SECURITY.md                # Security practices
├── 📄 CONTRIBUTING.md            # Contribution guidelines
├── 📄 LICENSE                    # Apache 2.0 license
├── 📁 config/                    # Configuration files
│   ├── project-list.txt          # All 31 projects
│   └── submodule-mappings.txt    # GitHub URL mappings
├── 📁 scripts/                   # Helper scripts
│   ├── config-helper.sh          # Environment loader
│   ├── validate-setup.sh         # Setup validator
│   └── install-hooks.sh          # Git hooks installer
├── 📁 hooks/                     # Pre-commit hooks
│   └── pre-commit                # Token detection
├── 📁 tests/                     # Test suite
│   ├── security-test.sh          # Security validation
│   ├── unit-test.sh              # Unit tests
│   └── integration-test.sh       # Integration tests
├── 📁 tokens/                    # Token storage (gitignored)
│   ├── README.md                 # Token setup guide
│   └── *.json                    # Authentication tokens
├── 🔧 err0agent-*.sh             # Operation scripts (11 files)
├── 🔧 dev-*.sh                   # Bulk operation scripts
├── 🧪 soak-test*.pl              # Integration test scripts
├── 🔄 freshen-submodules.sh      # Submodule manager
└── 📁 [31 submodule directories] # Open-source projects

📜 License

This repository is licensed under the Apache License 2.0.

Note: Each submodule project retains its own license (MIT, Apache 2.0, GPL, etc.). Please refer to individual project directories for their specific licensing terms.

🙏 Acknowledgments

This test bundle includes code from 31 major open-source projects. We extend our gratitude to all contributors:

• 🐍 The Django Software Foundation
• ☸️ The Kubernetes Authors
• 💎 The Ruby on Rails team
• 🌸 The Spring Framework team
• ...and 27 other amazing projects!

See each project's directory for full contributor acknowledgments.

💬 Support

Need help? We've got you covered:

• 📚 Documentation - See SETUP.md for detailed guides
• 🎫 Token Help - See tokens/README.md
• 🔄 Migration - See MIGRATION.md for existing users
• 🌐 err0.io Docs - https://docs.err0.io
• 📧 Support Email - support@err0.io
• 💬 GitHub Discussions - Ask questions

🔗 Related Projects

• err0.io - Main error code management platform
• err0 Agent - Error code insertion agent
• err0 Documentation - Comprehensive guides

---

Made with ❤️ by the err0.io team