VBox Tests Runner

📚 Table of Contents

• Description
• Requirements
• Installing
• VM Configuration
• Desktop Tests
  • desktop_tests_config.json Parameters
  • Desktop Test Commands
  • Desktop-test Flags
• Builder Tests
  • builder_tests_config.json Parameters
  • Builder Test Commands
  • Builder-test Flags
• Sending Messages to Telegram
• Report Portal Connection
• Downloading Virtual Machines
• Package URL Checker

---

Description

A project for running tests inside VirtualBox virtual machines.

Requirements

• Python 3.12
• VirtualBox 7.1.6
• Python package manager: uv

Installing

1. Install the uv package manager:

   pip install uv

2. Downloading or create VirtualBox virtual machines for testing.

3. Set up VM Configuration:

   • Make sure to specify the name of your network adapter.

4. (Optional) Set up Sending Messages to Telegram

5. (Optional) Set up Report Portal Connection

---

VM Configuration

Configure the file ./vm_configs/vm_config.json

Base Specifications

• cpus (optional): Number of virtual CPUs allocated to the VM.
• memory (optional): Amount of RAM in megabytes.
• audio (optional): Set to false to disable audio devices and reduce overhead.
• nested_virtualization (optional): Enables nested virtualization, allowing the VM to run other virtual machines.
• speculative_execution_control (optional): Enables protection against speculative execution vulnerabilities (e.g., Spectre, Meltdown).

Network Configuration

• connect_type (optional): Network connection type (e.g., bridged).
• adapter_name (required): Name of the host network interface to bridge with. Required for proper network connectivity.

---

Desktop Tests

desktop_tests_config.json Parameters

• branch (optional): Git branch to download the script from (default: master).
• token_file (optional): File name containing the Telegram token, located in the ~/.telegram directory (default: token).
• chat_id_file (optional): File name containing the Telegram chat ID, located in the ~/.telegram directory (default: chat).
• password (optional): Password for the virtual machine user.
• hosts (required): List of virtual machine names to run tests on.

Desktop Test Commands

uv run inv desktop-test

Desktop-test Flags

• --version or -v (required): Specifies the version of DesktopEditor.
• --headless or -h (optional): Runs virtual machines in the background (headless mode).
• --processes or -p (optional): Number of threads to run tests in multithreaded mode (default: 1).
• --name or -n (optional): Name of a specific virtual machine to selectively run tests.
• --connect-portal or -c (optional): Enables report upload to Report Portal.
• --telegram or -t (optional): Send the report to Telegram.

---

Builder Tests

builder_tests_config.json Parameters

• dep_test_branch (optional): Git branch from which the dep_test script will be downloaded (default: master).
• build_tools_branch (optional): Git branch for downloading build_tools scripts (default: master).
• office_js_api_branch (optional): Git branch for downloading office_js_api scripts (default: master).
• document_builder_samples (optional): Git branch for downloading document_builder_samples (default: master).
• token_file (optional): File name containing the Telegram token, located in the ~/.telegram folder (default: token).
• chat_id_file (optional): File name containing the Telegram chat ID, located in the ~/.telegram folder (default: chat).
• password (optional): Password for the virtual machine user.
• hosts (required): Array of virtual machine names to run the tests on.

Builder Test Commands

uv run inv builder-test

Builder-test Flags

• --version or -v (required): Specifies the version of DocBuilder.
• --headless or -h (optional): Runs virtual machines in the background (headless mode).
• --processes or -p (optional): Amount threads to run tests in multithreaded mode (default: 1).
• --name or -n (optional): Name of the virtual machine to selectively run tests.
• --connect-portal or -c (optional): Enables report upload to Report Portal.
• --telegram or -t (optional): Send the report to Telegram.

---

Sending Messages to Telegram

To enable Telegram notifications (e.g. script termination reports), you need to create the following files in the ~/.telegram directory:

• token — contains the Telegram bot token.
• chat — contains the Telegram chat ID (channel or user).

Using a Proxy

To send messages via a proxy, create an additional file at ~/.telegram/proxy.json with the following content:

{
  "login": "",
  "password": "",
  "ip": "",
  "port": ""
}

---

Report Portal Connection

To enable integration with Report Portal, you need to create a configuration file at the following path: ~/.report_portal/config.json

The file should have the following structure:

{
  "endpoint": "https://reports.<your-host>.com",
  "api_key": "your_api_key"
}

Downloading Virtual Machines

S3 Authentication

By default, S3Wrapper will look for your AWS credentials in the ~/.s3 directory:

• ~/.s3/key - contains your AWS Access Key ID
• ~/.s3/private_key - contains your AWS Secret Access Key

Downloading Virtual Machines Usage

To automatically download virtual machine .zip images from your configured S3 bucket, you can use the download-os task.

uv run inv download-os

Download-os Flags

• --cores or -c (optional) Amount threads to run tests in multithreaded mode.

s3_config.json Parameters

• bucket_name (required): The name of the S3 bucket that contains VM image archives (.zip files).
• region (required): AWS region where the S3 bucket is located.
• download_dir (optional): Local directory path where downloaded images should be saved. (default location: Project_dir/downloads)

Package URL Checker

PackageURLChecker is a utility for validating the existence of software package URLs (builder, desktop, etc.) based on version.

Package URL Checker Usage

Run the URL checker using:

uv run inv check-package --version 9.0.0.123

Package URL Checker Flags

• --version or -v (required): Specifies the version of pakages.

--name or -n (optional): Specifies a particular category to check (e.g. core, builder, desktop).