R.A.L.P.H. - Rapid Automated Load Performance Harness

Description

RALPH (Rapid Automated Load Performance Harness) is a powerful load testing tool written in Go. Designed to scrutinize the performance of websites using a multitude of load testing strategies, RALPH can efficiently simulate simple tests, stress tests, spike tests, endurance tests, and ramp-up tests. At the conclusion of each test, RALPH promptly saves the results into a CSV format, further offering the capability to upload these results seamlessly to Google Cloud Storage.

graph TD;
    A[Initialize RALPH] --> B[Setup Testing Parameters];
    B --> C[Choose Test Type];
    C --> D{Is it a Simple Test?};
    D -->|Yes| E[Execute Simple Test];
    D -->|No| F{Is it a Stress Test?};
    F -->|Yes| G[Execute Stress Test];
    F -->|No| H{Is it a Spike Test?};
    H -->|Yes| I[Execute Spike Test];
    H -->|No| J[... Other Tests ...];
    E --> K[Save Results];
    G --> K;
    I --> K;
    J --> K;
    K --> L[Upload to Google Cloud Storage?];
    L -->|Yes| M[Upload Results to GCS];
    L -->|No| N[End];
    M --> N;

Loading

Installation and Build Instructions

Prerequisites:

1. Go (Golang): RALPH requires Go to run. If you haven't installed it yet, you can download it from the official Go website.

2. Google Cloud SDK: To exploit the Google Cloud Storage upload functionality, ensure the Google Cloud SDK is installed. Download it from the official Google Cloud SDK website.

3. Environment Variable Setup: If you're leveraging the Google Cloud Storage feature, it's essential to have the GOOGLE_APPLICATION_CREDENTIALS environment variable pointing to your service account key's path. Here's a guide to assist you in setting it up.

Installation:

1. Get the Source:

   git clone https://github.com/Chaos-Camp/RAPLH.git
   cd RAPLH

2. Manage Dependencies:

   Ensure you've grabbed all the essential dependencies:

   go mod tidy

Build:

1. Craft the Executable:

   Compile the code to produce an executable named ralph (or ralph.exe for Windows users):

   go build -o ralph main.go

Running:

Execute the built tool:

./ralph -url=https://www.test-site.com -type=simple -iterations=3

(Note: Windows users should refer to the executable as ralph.exe)

Usage

Ensure the environment variable for GCS authentication is correctly set:

export GOOGLE_APPLICATION_CREDENTIALS=<path_to_service_account_json>

Options:

• URLs & Tests:

  • -url: Specifies the URL for testing. Default: "https://www.example.com".
  • -type: Indicates the type of load test. Options include "simple," "stress," "spike," "endurance," and "ramp_up". Default: "ramp_up".

• Parameters:

  • -iterations: Sets the iteration count for simple tests. Default: 1.
  • -concurrentRequests: Sets the concurrency level for stress tests. Default: 5.
  • -spikes: Designates the spike count for spike tests. Default: 3.
  • -spikeInterval: Determines the time (in seconds) between spikes. Default: 1.0s.
  • -duration: Specifies the total runtime (in seconds) for endurance tests. Default: 300s (5 minutes).
  • -maxUsers: Sets the user cap for ramp-up tests. Default: 10.
  • -rampUpPeriod: Determines the ramp-up duration (in seconds). Default: 10s.

• Storage:

  • -bucket: Identifies the Google Cloud Storage bucket for result uploads. Default: "my-bucket".

Examples:

The following are use-case scenarios showcasing how to utilize RALPH for various testing methodologies:

### Examples:

The following are use-case scenarios showcasing how to utilize RALPH for various testing methodologies:

1. **Simple Test**:
   ```bash
   ./ralph -url=https://www.test-site.com -type=simple -iterations=3

2. Stress Test:

   ./ralph -url=https://www.stress-site.com -type=stress -concurrentRequests=10

3. Spike Test:

   ./ralph -url=https://www.spike-site.com -type=spike -spikes=5 -spikeInterval=2

4. Endurance Test:

   ./ralph -url=https://www.endurance-site.com -type=endurance -duration=600

5. Ramp Up Test:

   ./ralph -url=https://www.rampup-site.com -type=ramp_up -maxUsers=15 -rampUpPeriod=15

6. Storing Results:

   ./ralph -url=https://www.example-site.com -type=spike -bucket=my-special-bucket

(Note: Windows users should use `ralph.exe` instead of `./ralph`.)

Post the test's completion, results will be stowed away in a CSV file named following the URL's sanitized format, ending with _results.csv. This file will subsequently be uploaded to the Google Cloud Storage bucket designated earlier.

Contributing

For those interested in contributing, please adhere strictly to Go's coding conventions and recognized best practices when submitting your pull requests.

License

RALPH is proudly open-sourced, welcoming everyone to access and use it. If you choose to incorporate or refer to this code elsewhere, we humbly ask for appropriate attribution.