ApprovalTests.cpp.Qt

KO | EN

gitlite — search

#typescript #llm #golang #deep-learning #macos #windows #awesome #kubernetes #vue #awesome-list #pytorch #security #mcp #openai

ApprovalTests.cpp.Qt

(★ 17)

No description available.

ApprovalTests.cpp.Qt Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ApprovalTests.cpp.Qt

[![Build status](https://ci.appveyor.com/api/projects/status/pf8et0nk1mdajskf/branch/master?svg=true)](https://ci.appveyor.com/project/isidore/approvaltests-cpp-qt/branch/master) 
[![Actions Status](https://github.com/approvals/ApprovalTests.cpp.Qt/workflows/build/badge.svg)](https://github.com/approvals/ApprovalTests.cpp.Qt/actions)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

<a href="https://github.com/approvals/ApprovalTests.cpp.Qt/releases/download/v.0.0.3/ApprovalTestsQt.v.0.0.3.hpp">Download the latest version (v.0.0.3) of the **single header file** here.</a>

## Contents

* [Purpose](#purpose)
 * [Features](#features)
 * [Requirements](#requirements)
 * [Getting Started](#getting-started)
 * [Limitations](#limitations)
 * [Reference](#reference)
 * [Setting up your main](#setting-up-your-main)
 * [Verifying a QImage](#verifying-a-qimage)
 * [Verifying a QTableView, e.g. QTableWidget](#verifying-a-qtableview-eg-qtablewidget)
 * [What's new?](#whats-new)

## Purpose

To enable easy, convenient testing and [Approval Testing](https://github.com/approvals/ApprovalTests.cpp) of [Qt](https://www.qt.io)-based C++ code by using modern test frameworks.

Currently [Catch](https://github.com/catchorg/Catch2) is supported.

## Features

* Creates a QApplication automatically, so that tests that create Qt widgets can run.
* Verify `QImage`. You give it a QImage, it saves this as a .png, and then verifies it by reading it back in.
* Verify `QTableView`. You give it a QTableView, and it saves its text contents in a tab-separated .tsv file.
* Augments ApprovalTests so that .png files are read in to QImage objects which are then compared - this is more reliable and portable than the default behaviour of doing character-by-character comparison of .png files on disk.
* Provides nicely-readable string representations of [a growing range of Qt classes](https://github.com/approvals/ApprovalTests.cpp.Qt/blob/master/ApprovalTestsQt/integrations/catch/Catch2QtStringMaker.h).

## Requirements

* [Qt](https://www.qt.io)'s Widgets and Tests modules

## Getting Started

You can download the [Starter Project](https://github.com/approvals/ApprovalTests.cpp.Qt.StarterProject) and start experimenting.

## Limitations

* **IMPORTANT:** Do not use the [Qt Test macros](https://doc.qt.io/qt-5/qtest.html#macros), such as `QCOMPARE`, `QVERIFY`, `QTRY_COMPARE` and so on. **Currently, any test failures of all any of the Qt Test macros will be silently swallowed, and tests will spuriously pass.**
* Currently, there are compile-time checks to prevent incorrect use of `QCOMPARE`, but not the others.
* Please note that this is a very early implementation, and there is not yet any promise of a stable interface.

## Reference

### Setting up your main

<a id='snippet-catch_2_qt_main'></a>
```cpp
// main.cpp:
#define APPROVALS_CATCH_QT
#include "ApprovalTestsQt.hpp"
```
<a href='/tests/Catch2_Tests/main.cpp#L1-L5' title='Snippet source file'>snippet source</a> | <a href='#snippet-catch_2_qt_main' title='Start of snippet'>anchor</a>

### Verifying a QImage

This takes a QImage, and saves this as a .png, and then verifies it by reading it back in.

In general, it's better to verify behaviour of objects rather than their appearance. However, if you do wish to test the contents of a QImage, this will work well.

<a id='snippet-verify_qimage'></a>
```cpp
QImage image(10, 20, QImage::Format_RGB32);
image.fill(Qt::red);
ApprovalTestsQt::verifyQImage(image);
```
<a href='/tests/Catch2_Tests/ApprovalsQtTests.cpp#L31-L35' title='Snippet source file'>snippet source</a> | <a href='#snippet-verify_qimage' title='Start of snippet'>anchor</a>

### Verifying a QTableView, e.g. QTableWidget

This takes QTableView, and saves its text contents in a tab-separated .tsv, for verification.

<a id='snippet-verify_table_view'></a>
```cpp
QTableWidget tableWidget;
populateTable(tableWidget);
ApprovalTestsQt::verifyQTableView(tableWidget);
```
<a href='/tests/Catch2_Tests/ApprovalsQtTests.cpp#L44-L48' title='Snippet source file'>snippet source</a> | <a href='#snippet-verify_table_view' title='Start of snippet'>anchor</a>

## What's new?

Check out the [Features](/doc/Features.md#top) page or [upcoming release notes](https://github.com/approvals/ApprovalTests.cpp.Qt/blob/master/build/relnotes_x.y.z.md) to see what we've been working on lately, or browse the [past release notes](https://github.com/approvals/ApprovalTests.cpp.Qt/releases).

ApprovalTests.cpp.Qt

ApprovalTests.cpp.Qt Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

ApprovalTests.cpp.Qt

ApprovalTests.cpp.Qt Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README