Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/QAInsights/hamster

instantly launch JMeter test plans πŸš€
https://github.com/QAInsights/hamster

hamster jmeter macos performance-testing utilties windows

Last synced: 3 months ago
JSON representation

instantly launch JMeter test plans πŸš€

Awesome Lists containing this project

README

        

# 🐹 Hamster - Instantly Launch JMeter Test Plans πŸš€

> ✨ Looking for Hamster Pro version? [Click here](https://qainsights.gumroad.com)

An app that puts your recent JMeter test plans just a click away from your Mac menu or Windows status bar.

![Hamster (Mac) - Instantly Launch JMeter Test Plans](./assets/Hamster.png)
![Hamster (Windows) - Instantly Launch JMeter Test Plans](assets/Hamster-Windows.png)

## Table of Contents

- [Features](#-features)
- [Usage](#-usage)
- [Build](#-build)
- [Install](#-install)
- [Points to Note](#-points-to-note)
- [Telemetry](#-telemetry)
- [License](#-license)
- [Sponsor](#-sponsor)

> ✨ Looking for Hamster Pro version? [Click here](https://qainsights.gumroad.com)

# βœ… Features
- 🎯 No more digging through folders or endless searches. With Hamster, launching your recent JMeter test plans is swift and seamless. Boost your productivity by accessing your tests instantly, streamlining your workflow like never before.
- 🌟 Whether you're a seasoned JMeter pro or just getting started, Hamster's user-friendly interface makes your testing experience effortless. Say hello to smoother workflows and goodbye to unnecessary hassle!
- πŸš€ Hamster is a lightweight app that's easy to install and use. It's also open-source, so you can customize it to your liking. What's more, it's free! So what are you waiting for? Download Hamster today and take your testing to the next level.
- πŸ›οΈ Supports Intel and Apple Silicon architectures.

## πŸ“š Usage

1. Configure `JMETER_HOME` by launching `Hamster > Edit JMETER_HOME` βš™οΈ
2. To launch JMeter, click on `Hamster > Just JMeter` πŸš€
3. To launch JMeter test plans, click on `Hamster > Recent Test Plans > select the test plan` πŸš€
4. To view the configuration, click on `Hamster > View Config` πŸ‘€
5. To refresh Hamster, click on` Hamster > Refresh` πŸ”„
6. To quit Hamster, click on `Hamster > Quit` ❌
7. To know more about Hamster, click on `Hamster > About` ℹ️

## πŸš€ Build

1. Clone the repository:

```bash
git clone https://github.com/qainsights/hamster.git
```
2. Create `venv` βš™οΈ

```
python3 -m venv
```
3. Install the required dependencies:

```bash
pip install -r requirements.txt
```
4. Run the project:
```bash
python ./hamster/__main__.py
```

## πŸ“₯ Install

1. Download the `dmg` file based on your architecture from the latest release from [here](https://github.com/QAInsights/hamster/releases)
2. Double-click on the `dmg` file
3. If you see the below screen, click on `OK` buttonπŸ‘‡
![Hamster - Security Warning](./assets/SecurityWarning.png)
4. Go to `System Preferences > Security & Privacy > General > Click on Open Anyway` button πŸ‘‡, then click on `Open` button
![Hamster - Open Anyway](./assets/OpenAnyway.png)
5. Move the `Hamster.app` to `Applications` folder
6. Launch `Hamster.app` from `Applications` folder
7. Configure `JMETER_HOME` by launching `Hamster > Edit JMETER_HOME` βš™οΈ
8. To launch JMeter, click on `Hamster > Just JMeter` πŸš€

> ✨ Looking for Hamster Pro version? [Click here](https://qainsights.gumroad.com)

## 🎯 Points to Note

- **Experimental App**: Please note that this application is experimental and may contain bugs. ⚠️
- **macOS**: This application is only for macOS and Windows.
- **JMeter**: This application requires JMeter to be installed on your machine. πŸ“₯

## πŸ” Telemetry

- Hamster collects anonymous usage data to improve the app. πŸ“Š
- The data collected is the menu clicks only.
- No personal information or entities are collected.
- The data collected is not shared with any third-party.
- The data collected is not used for any marketing purposes.
- The data is being collected using [Mixpanel](https://mixpanel.com) via AWS Lambda.
- You can opt out of telemetry by configuring `false` in `~/.hamster_app.properties` file and restart the app.
- ```commandline
[TELEMETRY]
enabled = false
```
- You can opt in of telemetry by configuring `true` in `~/.hamster_app.properties` file and restart the app.
- ```commandline
[TELEMETRY]
enabled = true
```

> ✨ Looking for Hamster Pro version? [Click here](https://qainsights.gumroad.com)

## 🧩 Windows Vs Mac app features

| Features | Windows | Mac |
|---------------------------------|---------|-----|
| Launch JMeter | βœ… | βœ… |
| Launch JMeter Recent Test Plans | βœ… | βœ… |
| Set JMeter Home | βœ… | βœ… |
| View Config | βœ… | βœ… |
| Refresh | βœ… | βœ… |
| Telemetry | ❌ | βœ… |
| Updates | ❌ | ❌ |

## πŸ—’οΈ License
- Apache 2 License

## πŸ’° Sponsor
- [Buy me a coffee β˜•](https://www.buymeacoffee.com/qainsights)

## πŸ™ Thanks
- Logo sourced from [OpenMoji](https://openmoji.org/library/emoji-1F439/)
- My daughter for the name 🐹