myvm

My personal virtual machines for testing, and a build tool written in a simple and easy shell script.

This is still a personal tool and at this time I do not intend to support it at this time. But you are free to use it if you wish.

What is this?

Tools for building virtual machines and my personal virtual machine environment building scripts. The goal is to automate to the installation of a basic operating system capable of ssh connections. The the virtual machine's keystroke function and OCR will be used as the technology for automated operations.

myvm.mp4

Requirements

virsh (libvirt)
virt-install (virtinst)
tesseract - OCR
gm - GraphicsMagick
VNC Viewer (recommendation)

Usage

Usage: myvm run <shrc-file> [<tasks> | --step-on]...
Usage: myvm sendkey <shrc-file> [--ocr] [<keys>]...
Usage: myvm ocr <shrc-file>
Usage: myvm vnc <shrc-file> [enable | disable | display]
Usage: myvm demolish <shrc-file>

DSL for building virtual machines

waitfor <pattern> Wait for text to be output.
- The pattern supports only "*" matching any string.
sendkey [keys]... Send Key corresponding to each character
enter [words]... Enter a string. The end of the string contains a newline
timeout <seconds> Extends the timeout for the next waitfor
step_on Turn on step execution for debugging

keys:

Special key
- {F1} {F2} {F3} {F4} {F5} {F6} {F7} {F8} {F9} {F10} {F11} {F12}
- {UP} {DOWN} {LEFT} {RIGHT} {ENTER} {TAB} {HOME} {END} {PAGEDOWN} {PAGEUP}
- {BS} {DEL} {INSERT} {CAPSLOCK} {SCROLLLOCK} {SYSRQ} {BREAK} {SPACE}
Repeat special key
- {<special key>}x<N> - e.g {DOWN}x10
Key with modifier
- {ALT}-A ... {ALT}-Z, {ALT}-0 ... {ALT}-9
- {CTRL}-A ... {CTRL}-Z, {CTRL}-0 ... {CTRL}-9
- {ALT+CTRL}-A ... {ALT+CTRL}-Z, {ALT+CTRL}-0 ... {ALT+CTRL}-9
- {CTRL+ALT}-A ... {CTRL+ALT}-Z, {CTRL+ALT}-0 ... {CTRL+ALT}-9
Other strings are treated as normal keystrokes.

Functions to manipulate virtual machines

vm.stop Stop the virtual machine
vm.restart Wait for the virtual machine to stop, then restart it
vm.setmem Set virtual machine memory
vm.vnc Enable or disable the VNC server for a virtual machine
vm.disk Add a disk

Configuration file

Load ~/.config/myvm or ~/.myvm if exists.

Examples

# Create a virtual machine and run the build and setup tasks
$ ./myvm run debian/12.0.shrc build setup

# Demolish the created virtual machine
$ ./myvm demolish debian/12.0.shrc

See shrc files in the project.

Hint: You are free to define any function beginning with do_ in the shrc file.

ko1nksm/myvm