TestHTTPServer Class Reference

provides a very, very basic HTTP server for testing. More...

#include <testhttpserver_p.h>

Inheritance diagram for TestHTTPServer:

Collaboration diagram for TestHTTPServer:

Public Types
enum	Mode { Normal , Delay , Disconnect }

Public Member Functions
	TestHTTPServer ()
bool	listen ()
quint16	port () const
QUrl	baseUrl () const
QUrl	url (const QString &documentPath) const
QString	urlString (const QString &documentPath) const
QString	errorString () const
bool	serveDirectory (const QString &, Mode=Normal)
bool	wait (const QUrl &expect, const QUrl &reply, const QUrl &body)
bool	hasFailed () const
void	addAlias (const QString &filename, const QString &aliasName)
void	addRedirect (const QString &filename, const QString &redirectName)
void	registerFileNameForContentSubstitution (const QString &fileName)
void	sendDelayedItem ()
Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.
virtual	~QObject ()
	Destroys the object, deleting all its child objects.
virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.
virtual bool	eventFilter (QObject *watched, QEvent *event)
	Filters events if this object has been installed as an event filter for the watched object.
QString	objectName () const
Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.
void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
QBindable< QString >	bindableObjectName ()
bool	isWidgetType () const
	Returns true if the object is a widget; otherwise returns false.
bool	isWindowType () const
	Returns true if the object is a window; otherwise returns false.
bool	isQuickItemType () const
	Returns true if the object is a QQuickItem; otherwise returns false.
bool	signalsBlocked () const noexcept
	Returns true if signals are blocked; otherwise returns false.
bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
QThread *	thread () const
	Returns the thread in which the object lives.
bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns true on success.
int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void	killTimer (int id)
	Kills the timer with timer identifier, id.
void	killTimer (Qt::TimerId id)
template<typename T >
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
template<typename T >
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
template<typename T >
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const QObjectList &	children () const
	Returns a list of child objects.
void	setParent (QObject *parent)
	Makes the object a child of parent.
void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.
void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool	disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
bool	disconnect (const QObject *receiver, const char *member=nullptr) const
void	dumpObjectTree () const
	Dumps a tree of children to the debug output.
void	dumpObjectInfo () const
	Dumps information about signal connections, etc.
bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.
bool	setProperty (const char *name, QVariant &&value)
QVariant	property (const char *name) const
	Returns the value of the object's name property.
QList< QByteArray >	dynamicPropertyNames () const
QBindingStorage *	bindingStorage ()
const QBindingStorage *	bindingStorage () const
QObject *	parent () const
	Returns a pointer to the parent object.
bool	inherits (const char *classname) const
	Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe
Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.
Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe
static QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
	\threadsafe
static bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.
template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
int	senderSignalIndex () const
int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.
bool	isSignalConnected (const QMetaMethod &signal) const
virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.
virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.
virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	disconnectNotify (const QMetaMethod &signal)
	QObject (QObjectPrivate &dd, QObject *parent=nullptr)
Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr
Properties inherited from QObject
QString	objectName
	the name of this object
Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()
template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()
	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

provides a very, very basic HTTP server for testing.

Inside the test case, an instance of TestHTTPServer should be created, with the appropriate port to listen on. The server will listen on the localhost interface.

Directories to serve can then be added to server, which will be added as "roots". Each root can be added as a Normal, Delay or Disconnect root. Requests for files within a Normal root are returned immediately. Request for files within a Delay root are delayed for 500ms, and then served. Requests for files within a Disconnect directory cause the server to disconnect immediately. A request for a file that isn't found in any root will return a 404 error.

If you have the following directory structure:

disconnect/disconnectTest.qml
files/main.qml
files/Button.qml
files/content/WebView.qml
slowFiles/slowMain.qml

it can be added like this:

TestHTTPServer server;
QVERIFY2(server.listen(14445), qPrintable(server.errorString()));
server.serveDirectory("disconnect", TestHTTPServer::Disconnect);
server.serveDirectory("files");
server.serveDirectory("slowFiles", TestHTTPServer::Delay);

The following request urls will then result in the appropriate action: \table \header

• URL
• Action \row
• http://localhost:14445/disconnectTest.qml
• Disconnection \row
• http://localhost:14445/main.qml
• main.qml returned immediately \row
• http://localhost:14445/Button.qml
• Button.qml returned immediately \row
• http://localhost:14445/content/WebView.qml
• content/WebView.qml returned immediately \row
• http://localhost:14445/slowMain.qml
• slowMain.qml returned after 500ms \endtable

Definition at line 32 of file testhttpserver_p.h.

Member Enumeration Documentation

Mode

enum TestHTTPServer::Mode

Enumerator
Normal
Delay
Disconnect

Definition at line 45 of file testhttpserver_p.h.

Constructor & Destructor Documentation

TestHTTPServer()

TestHTTPServer::TestHTTPServer

(

)

Definition at line 72 of file testhttpserver.cpp.

References QObject::connect(), and QTcpServer::newConnection().

Here is the call graph for this function:

Member Function Documentation

addAlias()

void TestHTTPServer::addAlias	(	const QString &	filename,
		const QString &	aliasName )

Definition at line 118 of file testhttpserver.cpp.

References QHash< Key, T >::insert().

Here is the call graph for this function:

addRedirect()

void TestHTTPServer::addRedirect	(	const QString &	filename,
		const QString &	redirectName )

Definition at line 123 of file testhttpserver.cpp.

References QHash< Key, T >::insert().

Here is the call graph for this function:

baseUrl()

QUrl TestHTTPServer::baseUrl

(

)

const

Definition at line 83 of file testhttpserver.cpp.

References localHostUrl(), and QTcpServer::serverPort().

Referenced by url().

Here is the call graph for this function:

Here is the caller graph for this function:

errorString()

QString TestHTTPServer::errorString

(

)

const

Definition at line 103 of file testhttpserver.cpp.

References QTcpServer::errorString().

Here is the call graph for this function:

hasFailed()

bool TestHTTPServer::hasFailed

(

)

const

Definition at line 192 of file testhttpserver.cpp.

listen()

bool TestHTTPServer::listen

(

)

Definition at line 78 of file testhttpserver.cpp.

References QTcpServer::listen(), and QHostAddress::LocalHost.

Here is the call graph for this function:

port()

quint16 TestHTTPServer::port

(

)

const

Definition at line 88 of file testhttpserver.cpp.

References QTcpServer::serverPort().

Here is the call graph for this function:

registerFileNameForContentSubstitution()

void TestHTTPServer::registerFileNameForContentSubstitution

(

const QString &

fileName

)

Definition at line 128 of file testhttpserver.cpp.

References fileName, and QSet< T >::insert().

Here is the call graph for this function:

sendDelayedItem()

void TestHTTPServer::sendDelayedItem

(

)

Definition at line 346 of file testhttpserver.cpp.

serveDirectory()

bool TestHTTPServer::serveDirectory	(	const QString &	dir,
		Mode	mode = Normal )

Definition at line 108 of file testhttpserver.cpp.

References QList< T >::append(), dir, and qMakePair().

Here is the call graph for this function:

url()

QUrl TestHTTPServer::url

(

const QString &

documentPath

)

const

Definition at line 93 of file testhttpserver.cpp.

References baseUrl(), and QUrl::resolved().

Here is the call graph for this function:

urlString()

QString TestHTTPServer::urlString

(

const QString &

documentPath

)

const

Definition at line 98 of file testhttpserver.cpp.

References QUrl::toString(), and url.

Here is the call graph for this function:

wait()

bool TestHTTPServer::wait	(	const QUrl &	expect,
		const QUrl &	reply,
		const QUrl &	body )

Definition at line 133 of file testhttpserver.cpp.

References QByteArray::append(), QByteArray::at(), QString::at(), QByteArray::clear(), QByteArray::endsWith(), QString::endsWith(), QByteArray::insert(), QUrl::isValid(), QString::left(), line, QByteArray::number(), QByteArray(), QByteArrayLiteral, QIODeviceBase::ReadOnly, QString::replace(), reply, QTcpServer::serverPort(), QByteArray::size(), QString::size(), and QQmlFile::urlToLocalFileOrQrc().

Here is the call graph for this function:

---

The documentation for this class was generated from the following files:

• qtdeclarative/src/quicktestutils/qml/testhttpserver_p.h (85b7937b70ee7d2fbf02e7bdff12a01cf12e084c)
• qtdeclarative/src/quicktestutils/qml/testhttpserver.cpp (85b7937b70ee7d2fbf02e7bdff12a01cf12e084c)