Skip to content

Latest commit

 

History

History
186 lines (140 loc) · 8.69 KB

README.md

File metadata and controls

186 lines (140 loc) · 8.69 KB
GADS - Open Source Mobile Device Farm Platform for iOS and Android Automated Testing

GADS - Open Source Device Farm for Mobile Testing

GitHub Stars GitHub Release GitHub Downloads License: MIT Discord

🚀 Self-Hosted Device Farm & Test Automation Platform - Open Source Alternative to AWS Device Farm and Firebase Test Lab

🎯 What is GADS?

GADS is a free, open-source device farm platform that enables remote device control and Appium test execution on mobile devices. Perfect for QA teams, mobile developers, and organizations looking for a self-hosted alternative to expensive cloud testing services like AWS Device Farm and Firebase Test Lab.

The platform architecture consists of two main components:

  • Hub: A web interface for remote device control and provider management.
  • Provider: Handles device setup and makes them available for remote access.

Why Choose GADS?

  • 💰 Free & Open Source: Complete alternative to AWS Device Farm and Firebase Test Lab
  • 📱 Cross-Platform: Full support for both iOS and Android devices
  • 🎮 Remote Control: Real-time device control and testing capabilities
  • 🔌 Appium Compatible: Works with industry-standard Appium testing framework
  • 🛠 Easy Setup: Simple installation and configuration process

✨ Key Features

Hub Features 🎯

  • 🔐 Authentication System
    • User login with session management
    • Admin user management
  • 📱 Device Control
    • Real-time video streaming (MJPEG)
    • Remote interactions: tap, swipe, text input
    • App installation/uninstallation
    • High-quality screenshots
    • Device reservation system
  • 🔄 Backend Capabilities
    • Web interface serving
    • Provider communication proxy
    • Experimental Selenium Grid replacement
  • 👥 Workspace Management

Provider Features 🔌

  • 🛠️ Easy Setup
    • UI-based device management
  • 🤖 Automated Device Provisioning
    • Per-device Appium server configuration
  • 📡 Remote Control
  • 🧪 Testing Integration
    • Individual Appium server endpoints
    • Optional Selenium Grid 4 node registration

💻 Platform Support

OS Android Support iOS Support Notes
macOS ✅ ✅ Full support
Linux ✅ ⚠️ Limited iOS support due to Xcode dependency
Windows ✅ ⚠️ Limited iOS support due to Xcode dependency

🚀 Getting Started

Prerequisites

Before getting started, make sure you have the following:

  • A MongoDB instance (v6.0 recommended)
  • Network connectivity between Hub, Providers, MongoDB, and Selenium Grid

⚡ Quick Start

Option 1: Download the latest binary

  1. Go to the releases page and download the latest binary for your platform.

Option 2: Build from source

# Clone the repository
git clone https://github.com/shamanec/GADS

# Build the UI
cd hub/gads-ui
npm install
npm run build

# Build the application
cd ../..
go build .

🛠️ Common setup

🌱 MongoDB

The project uses MongoDB for storing logs and for synchronization of some data between hub and providers. You can either run MongoDB in a docker container:

  • You need to have Docker(Docker Desktop on macOS, Windows) installed.
  • Execute docker run -d --restart=always --name mongodb -p 27017:27017 mongo:6.0. This will pull the official MongoDB 6.0 image from Docker Hub and start a container binding ports 27017 for the MongoDB instance.
  • You can use MongoDB Compass or another tool to access the db if needed.

or

  • Start MongoDB instance in the way you prefer

⚙️ Hub setup

For detailed instructions on setting up the Hub, refer to the Hub Setup Docs

📱 Provider setup

For detailed instructions on setting up the Provider, refer to the Provider Setup Docs.

Running GADS as a System Service

To ensure that GADS runs continuously and can be managed easily, it is recommended to execute it as a service on your operating system. Running GADS as a service allows it to start automatically on boot, restart on failure, and be managed through standard service commands.

🐧 Linux

For detailed instructions on how to create a service for Linux using systemd, please refer to the Linux Service Documentation.

🖥️ Windows

Note: Service implementation for Windows is yet to be documented.

🍏 macOS

Note: Service implementation for macOS is yet to be documented.

❓ FAQ

The FAQ (Frequently Asked Questions) section has been created to provide quick answers to the most common questions about GADS. If you have any questions regarding installation, setup, or functionality, check out the answers in our documentation.

For more details, refer to the full FAQ.

🙏 Thanks

About
go-ios Many thanks for creating this CLI tool to communicate with iOS devices, perfect for installing/reinstalling and running WebDriverAgentRunner without Xcode
Appium It would be impossible to control the devices remotely without Appium for the control and WebDriverAgent for the iOS screen stream, kudos!

🎥 Videos

Start hub

Screen.Recording.2024-07-19.at.14.53.40.mov

Add provider configuration

Screen.Recording.2024-07-19.at.14.55.34.mov

Add devices and start provider

Screen.Recording.2024-07-19.at.15.05.21.mov

Run Appium tests in parallel with TestNG

Screen.Recording.2024-07-19.at.15.10.01.mov

Remote control

ScreenRecording2024-07-19at15.11.46-ezgif.com-resize-video.1.mov

💡 Use Cases

  • Mobile App Testing: Automate testing across multiple real devices
  • Manual QA: Remote access to physical devices for manual testing
  • CI/CD Pipeline: Integrate automated testing in your deployment workflow
  • Device Lab Management: Centralized management of your organization's mobile devices
  • Cross-Browser Testing: Test web applications across multiple mobile browsers

📊 Project Status

🔍 Keywords

device-farm, mobile-testing, ios-testing, android-testing, appium, test-automation, qa-tools, continuous-testing, mobile-device-management, selenium-grid, remote-device-control, mobile-qa