Skip to content

KF-33 add tests for Thread #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SergiusTheBest merged 5 commits into from
Jan 16, 2026
Merged

KF-33 add tests for Thread #73

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f85be67
add tests for Thread
Aug 20, 2025
c481911
Merge branch 'main' into KF-33-test-Thread
SergiusTheBest Jan 16, 2026
d22eff4
Refactor tests
SergiusTheBest Jan 16, 2026
b254ce3
Update test/ThreadTest.cpp
SergiusTheBest Jan 16, 2026
e6dfbd7
Fix review comments
SergiusTheBest Jan 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions test/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ wdk_add_driver(kf-test WINVER NTDDI_WIN10 STL
AutoSpinLockTest.cpp
EResourceSharedLockTest.cpp
RecursiveAutoSpinLockTest.cpp
ThreadTest.cpp
SemaphoreTest.cpp
UStringBuilderTest.cpp
USimpleStringTest.cpp
Expand Down
216 changes: 216 additions & 0 deletions test/ThreadTest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,216 @@
#include "pch.h"
#include <kf/Thread.h>

namespace
{
struct ThreadContext
{
bool started = false;
};

void threadProc(void* context)
{
static_cast<ThreadContext*>(context)->started = true;
PsTerminateSystemThread(STATUS_SUCCESS);
}

struct TestObject
{
ThreadContext m_threadContext;

NTSTATUS run()
{
m_threadContext.started = true;
return STATUS_SUCCESS;
}
};
}

SCENARIO("kf::Thread basic lifecycle")
{
GIVEN("A default constructed thread")
{
kf::Thread thread;

WHEN("join() is called without start()")
{
thread.join();

THEN("it should be a no-op")
{
REQUIRE(true);
}
}

WHEN("start() is used with threadProc")
{
ThreadContext context;

const NTSTATUS status = thread.start(&threadProc, &context);

THEN("start() should succeed")
{
REQUIRE_NT_SUCCESS(status);
}

THEN("join() waits for completion")
{
thread.join();
REQUIRE(context.started);
}
}

WHEN("start() is used with lambda")
{
ThreadContext context;

NTSTATUS status = thread.start([](void* context)
{
static_cast<ThreadContext*>(context)->started = true;
PsTerminateSystemThread(STATUS_SUCCESS);
},
&context);

THEN("start() should succeed")
{
REQUIRE_NT_SUCCESS(status);
}

thread.join();

THEN("lambda should run")
{
REQUIRE(context.started);
}
}

WHEN("start() is used with object member routine")
{
TestObject obj;

const NTSTATUS status = thread.start<&TestObject::run>(&obj);

THEN("start() should succeed")
{
REQUIRE_NT_SUCCESS(status);
}

thread.join();

THEN("member routine should run")
{
REQUIRE(obj.m_threadContext.started);
}
}

WHEN("calling join twice after start")
{
REQUIRE_NT_SUCCESS(thread.start([](void*) { PsTerminateSystemThread(STATUS_SUCCESS); }, nullptr));

thread.join();
thread.join();

THEN("it's safe to call join() multiple times")
{
REQUIRE(true);
}
}

WHEN("thread object is destroyed while running")
{
ThreadContext context;

{
kf::Thread local;
REQUIRE_NT_SUCCESS(local.start(&threadProc, &context));
}

THEN("destructor should join and thread should have run")
{
REQUIRE(context.started);
}
}

WHEN("starting a thread with a long working function")
{
ThreadContext context;

REQUIRE_NT_SUCCESS(thread.start([](void* context)
{
LARGE_INTEGER oneMillisecond{ .QuadPart = -10'000LL }; // 1ms
KeDelayExecutionThread(KernelMode, false, &oneMillisecond);

static_cast<ThreadContext*>(context)->started = true;
PsTerminateSystemThread(STATUS_SUCCESS);
},
&context));

THEN("join() waits for completion")
{
thread.join();
REQUIRE(context.started);
}
}
}
}

SCENARIO("kf::Thread move constructor and move assignment")
{
GIVEN("A started thread")
{
ThreadContext context;
kf::Thread thread1;
REQUIRE_NT_SUCCESS(thread1.start(&threadProc, &context));

WHEN("Thread is move-constructed")
{
kf::Thread thread2(std::move(thread1));

THEN("moved-to object should be able to join")
{
thread2.join();
REQUIRE(context.started);
}

THEN("moved-from object join() should be safe")
{
thread1.join();
REQUIRE(context.started);
}
}
}

GIVEN("Two threads where left-hand side already owns a running thread")
{
ThreadContext context1;
ThreadContext context2;

kf::Thread thread1;
kf::Thread thread2;

REQUIRE_NT_SUCCESS(thread1.start(&threadProc, &context1));
REQUIRE_NT_SUCCESS(thread2.start(&threadProc, &context2));

WHEN("Move-assigning thread1 = std::move(thread2)")
{
thread1 = std::move(thread2);

THEN("thread1 should join the thread it now owns")
{
thread1.join();
REQUIRE(context2.started);
}

THEN("thread2 should be in a valid empty state")
{
thread2.join();
REQUIRE(true);
}

THEN("the original thread from thread1 should have executed")
{
REQUIRE(context1.started);
}
}
}
}