Skip to content

Latest commit

 

History

History
112 lines (74 loc) · 4.2 KB

README.md

File metadata and controls

112 lines (74 loc) · 4.2 KB
Raw

KubuQA

Kubuntu ISO Testing Utility - Spin up VMs with ease

New to Ubuntu Testing & Development ? No worries, we have got you covered!!

Overview

This Bash script automates the process of setting up a test environment based upon Ubuntu CD images. It downloads all required files if necessary and facilitates launching a test installation using VirtualBox. It leverages kdialog for graphical user interaction, making it accessible even for users who prefer not to work with the command line directly.

Installation

Prerequisites

We assume you're working on Kubuntu, or another Ubuntu based Linux distribution.

In order to execute this script, the following tools need to be installed on your system:

  • kdialog for graphical dialogs.
  • zsync for ISO file updates.
  • wget for downloading files.
  • VirtualBox and VBoxManage for running the test installation.

The script includes a preliminary check and attempts to install any missing tools using pkexec. You will be asked to authorize each installation with the root password. Please review the KubuQA.sh script to assure yourself of what is being installed.

Downloading the Script

Clone this repository or download the script directly from the GitHub page:

Clone

git clone git@github.com:kubuntu-team/KubuQA.git

Download

wget -O KubuQA.sh https://raw.githubusercontent.com/kubuntu-team/KubuQA/main/KubuQA.sh

Make the script executable:

chmod +x KubuQA.sh

Usage

To run the script with default settings, execute it from the terminal like this:

./KubuQA.sh

The script will guide you through the following steps:

  • Install all necessary programs it needs to run (see above)
  • Set up the scaffold of the testing VM if necessary
  • Create a Virtual Disk Image (VDI) if necessary
  • Look for the specified ISO download directory (~/Downloads/KubuQATestISOfiles by default) and create it if necessary
  • Check if the flavor ISO file exists within this directory:
    • If found, offer to check for updates using zsync.
    • If not found, prompt to download the ISO.
  • Ask if you want to launch a test installation in VirtualBox. If you choose Yes, a new VirtualBox VM will be started. Please make sure to select ISO cdimage when starting up a freshly created VM, since the VDI is empty and can't be used as boot device as long as there is no OS installed on it.

Upon subsequent runs, you may choose to boot from 'ISO cdimage' or 'VDI disk', giving you the ability to Stop/Start your testing as desired.

For each of the steps that require user interaction, a kdialog prompt will appear to guide you through the process.

Configuration

KubuQA aims to be usable by anyone, the goal is to provide an easy way to get started in the testing and development of Ubuntu. Following the KDE motto "Simple by default, powerful when needed", it comes with sane defaults and multiple configuration options.

You can set these variables either by directly editing the script, providing a config file (see the sample config file for reference), or passing flags when executing the script.

For an overview of all configuration options, run

./KubuQA.sh --help

Keep in mind that when the same variable is being set multiple times (e.g. in a config file and as a flag in the same command), only the last value will be processed.

Contributing

If you have ideas for additions or improvements please do create an Issue, or open a Pull Request on our Github KubuQA.

Please make sure your code contribution passes Shellcheck, to ensure good code quality.

Ideas (so far)

License

License GPL v3.0