How To Install sql2subunit on Ubuntu 21.04

One-liner install command

For those in a hurry, here's a one-line installation command:

sudo apt-get update && sudo apt -y install python-subunit2sql

But if you are interested in the detailed steps with descriptions, the following information is for you.

What is sql2subunit and what are the ways to install it?

Before beginning this tutorial, you will need access to a server or computer running Ubuntu 21.04. This guide was written specifically with a server running Ubuntu 21.04 in mind, although it should also work on older, supported versions of the operating system.

Also, make sure you are running a regular, non-root user with sudo privileges configured on your server. When you have an account available, log in as your non-root user to begin.

There are several ways to install sql2subunit on Ubuntu 21.04. You can use (links are clickable):

In the following sections, we will describe each method in detail. You can choose one of them or refer to the recommended one.

Install sql2subunit using apt-get

First, update apt database with apt-get using the following command.

sudo apt-get update

After updating apt-get database, You can install sql2subunit using apt by running the following command:

sudo apt -y install python-subunit2sql

Install sql2subunit using apt

Because sql2subunit is available in Ubuntu 21.04’s default repositories, it is possible to install it from these repositories using the apt packaging system.

To begin, update apt database with apt using the following command.

sudo apt update

After updating apt database, You can install sql2subunit using apt by running the following command:

sudo apt -y install python-subunit2sql

Install sql2subunit using aptitude

If you want to follow this method, you might need to install aptitude first since aptitude is usually not installed by default on Ubuntu 21.04. Update apt database with aptitude using the following command.

sudo aptitude update

After updating aptitude database, You can install sql2subunit by running the following command:

sudo aptitude -y install python-subunit2sql

How to upgrade (update) a single package sql2subunit using apt-get?

First, you will need to update packages index. Run update command as usual:

sudo apt-get update

Next, to upgrade only the sql2subunit, e.g. single package, you should use the following format with the apt-get command/apt command:

sudo apt-get --only-upgrade install python-subunit2sql

Note that this command will not install any new packages! If you wish to install the package if it doesn't exist you may leave out --only-upgrade part.

sudo apt-get install python-subunit2sql

How To Uninstall sql2subunit from Ubuntu 21.04

To uninstall only the sql2subunit package you can execute the following command:

sudo apt-get remove python-subunit2sql

Uninstall sql2subunit and all its dependencies

To uninstall sql2subunit and its dependencies that are no longer needed by Ubuntu 21.04, you can use the command below:

sudo apt-get -y autoremove python-subunit2sql

Remove sql2subunit with all configurations and data

To remove sql2subunit configuration and data from your system you can run the following purge command:

sudo apt-get -y purge python-subunit2sql

Remove sql2subunit completely (configurations, data and all of its dependencies)

And lastly, you can run the next command to remove absolutely everything related to sql2subunit package, e.g.: configurations, data and all of its dependencies. Just use this command:

sudo apt-get -y autoremove --purge python-subunit2sql

Extra info and code examples

subunit2SQL is a tool for storing test results data in a SQL database. Like it's name implies it was originally designed around converting subunit streams to data in a SQL database and the packaged utilities assume a subunit stream as the input format. However, the data model used for the DB does not preclude using any test result format. Additionally the analysis tooling built on top of a database is data format agnostic. However if you choose to use a different result format as an input for the database additional tooling using the DB API would need to be created to parse a different test result output format. It's also worth pointing out that subunit has several language library bindings available. So as a user you could create a small filter to convert a different format to subunit. Creating a filter should be fairly easy and then you don't have to worry about writing a tool like :ref:`subunit2sql` to use a different format. For multiple distributed test runs that are generating subunit output it is useful to store the results in a unified repository. This is the motivation for the testrepository project which does a good job for centralizing the results from multiple test runs. However, imagine something like the OpenStack CI system where the same basic test suite is normally run several hundreds of times a day. To provide useful introspection on the data from those runs and to build trends over time the test results need to be stored in a format that allows for easy querying. Using a SQL database makes a lot of sense for doing this, which was the original motivation for the project. At a high level subunit2SQL uses alembic migrations to setup a DB schema that can then be used by the subunit2sql tool to parse subunit streams and populate the DB. Then there are tools for interacting with the stored data in the subunit2sql-graph command as well as the sql2subunit command to create a subunit stream from data in the database. Additionally, subunit2sql provides a Python DB API that can be used to query information from the stored data to build other tooling. This package contains the Python 2.7 module.

Conclusion

You now have a full guide on how to install sql2subunit using apt, apt-get and aptitude tools. Also, we showed how to update as a single package and different ways to uninstall the sql2subunit from Ubuntu 21.04.

See also: