https://github.com/runpod-workers/mock-worker

🦜 | Emulate RunPod worker functionality.
https://github.com/runpod-workers/mock-worker

runpod serverless

Last synced: about 2 months ago
JSON representation

🦜 | Emulate RunPod worker functionality.

• Host: GitHub
• URL: https://github.com/runpod-workers/mock-worker
• Owner: runpod-workers
• License: mit
• Created: 2023-07-24T17:44:12.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-06-23T20:34:34.000Z (9 months ago)
• Last Synced: 2025-06-23T21:35:14.060Z (9 months ago)
• Topics: runpod, serverless
• Language: Python
• Homepage:
• Size: 53.7 KB
• Stars: 2
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


Mock | Worker


[![CI | Test Worker](https://github.com/runpod-workers/mock-worker/actions/workflows/CI-test_worker.yml/badge.svg)](https://github.com/runpod-workers/mock-worker/actions/workflows/CI-test_worker.yml)

 

[![CD | Dev Docker Image](https://github.com/runpod-workers/mock-worker/actions/workflows/CD-docker_dev.yml/badge.svg)](https://github.com/runpod-workers/mock-worker/actions/workflows/CD-docker_dev.yml)

🦜 | A mock worker that can be used to emulate the behavior of different types of endpoints. [Docker Link](https://hub.docker.com/r/runpod/mock-worker)



## Usage

```json

{"input":

    {

        "mock_return": "Anything here will be returned as the output of the worker.",

        "mock_delay": 0, // The number of seconds to wait before returning output, raising error or crashing. If generator is enabled, this is the delay between each yeild.

        "mock_progress": {

            "updates": [],  // A list of progress updates to send back to the RunPod API.

            "wait_time": 0 // The number of seconds to wait before sending a progress update.

        },

        "mock_error": false, // If true, the worker will raise an error.

        "mock_crash": false, // If true, the worker will crash (kills the processes)

        "mock_refresh": false, // If true, the refresh_worker flag is enabled.

        "mock_external": {

            "error_job_return": false, // If true, the job will fail to return the job results.

        },

        "mock_logs": [  // A list of log messages to generate, these are sent at the start of the job.

            {

                "level": "info", // The log level to use. Options: debug, info, warn, error

                "message": "This is a log message." // The log message to send.

            }

        ]

    }

}

```

### Generator or Async Handler

To test the generator handler override the docker command with the following:

```bash

python3 -u /handler.py --generator

```

```bash

python3 -u /handler.py --async_generator

```

To return the stream aggregation include `--return_aggregate_stream` argument.

```json

# To test multiple yeild outputs, set the `mock_return` to a list of values.

{

    "input": {

        "mock_return": ["value1", "value2", "value3"],

        "mock_delay": 0,

        "mock_error": false,

        "mock_crash": false

    }

}

```