execute_jmeter_test_non_gui
Run JMeter performance tests in non-GUI mode by providing a test file path to execute load testing scenarios without graphical interface overhead.
Instructions
Execute a JMeter test in non-GUI mode.
Args: test_file: Path to the JMeter test file (.jmx)
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| test_file | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Implementation Reference
- jmeter_server.py:92-99 (handler)The handler function for the 'execute_jmeter_test_non_gui' tool. It is registered via the @mcp.tool() decorator and delegates the execution to the run_jmeter helper function, ensuring non-GUI mode.
@mcp.tool() async def execute_jmeter_test_non_gui(test_file: str) -> str: """Execute a JMeter test in non-GUI mode. Args: test_file: Path to the JMeter test file (.jmx) """ return await run_jmeter(test_file, non_gui=True) - jmeter_server.py:22-81 (helper)Supporting function that contains the core logic for executing JMeter tests using subprocess. Handles file validation, command construction, logging, and output capture specifically for non-GUI mode.
async def run_jmeter(test_file: str, non_gui: bool = True) -> str: """Run a JMeter test. Args: test_file: Path to the JMeter test file (.jmx) non_gui: Run in non-GUI mode (default: True) Returns: str: JMeter execution output """ try: # Convert to absolute path test_file_path = Path(test_file).resolve() # Validate file exists and is a .jmx file if not test_file_path.exists(): return f"Error: Test file not found: {test_file}" if not test_file_path.suffix == '.jmx': return f"Error: Invalid file type. Expected .jmx file: {test_file}" # Get JMeter binary path from environment jmeter_bin = os.getenv('JMETER_BIN', 'jmeter') java_opts = os.getenv('JMETER_JAVA_OPTS', '') # Log the JMeter binary path and Java options logger.info(f"JMeter binary path: {jmeter_bin}") logger.debug(f"Java options: {java_opts}") # Build command cmd = [str(Path(jmeter_bin).resolve())] if non_gui: cmd.extend(['-n']) cmd.extend(['-t', str(test_file_path)]) # Log the full command for debugging logger.debug(f"Executing command: {' '.join(cmd)}") if non_gui: # For non-GUI mode, capture output result = subprocess.run(cmd, capture_output=True, text=True) # Log output for debugging logger.debug("Command output:") logger.debug(f"Return code: {result.returncode}") logger.debug(f"Stdout: {result.stdout}") logger.debug(f"Stderr: {result.stderr}") if result.returncode != 0: return f"Error executing JMeter test:\n{result.stderr}" return result.stdout else: # For GUI mode, start process without capturing output subprocess.Popen(cmd) return "JMeter GUI launched successfully" except Exception as e: return f"Unexpected error: {str(e)}"