Skip to content

Update unit testing guide (original PR#150) - #185

Open
rory-cd wants to merge 21 commits into
thoth-tech:mainfrom
rory-cd:update-unit-test-guide
Open

rory-cd wants to merge 21 commits into
thoth-tech:mainfrom
rory-cd:update-unit-test-guide

Conversation

@rory-cd

@rory-cd rory-cd commented Sep 1, 2026

Copy link
Copy Markdown
Collaborator

Description

This PR is a copy of #150, created by former contributor @dijidiji. The original PR had tests failing, which I have fixed along with some minor updates:

  • Prerequisites added back in, and shifted to their own section (these are required whether you use command line or VS Code)
  • Renamed "Unit Testing Guide" to "Writing Unit Tests", to make it clear this section only covers writing tests, not background info, building or running.

Original Description (#150)

I've revised and updated the unit testing guide. I've also merged previous testing instructions for sktest with relevant instructions that were part of the unit testing guide, since the build process builds both. As part of this, I've elaborated on the differences between sktest and skunit_tests a bit, and moved the part of the guide that outlined how to write a unit test to a separate page.

This way, someone following the guide is made aware of how to run both test programs, and is informed of how to add tests to either of them (as well as the reasons for doing so).

  • This also fixes an issue where resources for tests (such as images) aren't copied, causing tests to fail. This happens because building a specific executable target such as skunit_tests doesn't run the custom targets used for the copy. This could be fixed by altering CMakeLists.txt but updating this guide is simpler.

Type of change

  • Documentation (update or new)

How Has This Been Tested?

Made sure the guide looks good in local testing.

Testing Checklist

  • Have run npm run format
  • Have run npm run build
  • Have run npm run dev and/or npm run preview, using:
    • Chrome
    • Safari
    • Firefox

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have requested a review on the planner board

@netlify

netlify Bot commented Sep 1, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for thoth-tech ready!

Name Link
🔨 Latest commit 9bc09a8
🔍 Latest deploy log https://app.netlify.com/projects/thoth-tech/deploys/6a9625a58a43f10008a8bbb4
😎 Deploy Preview https://deploy-preview-185--thoth-tech.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@rory-cd rory-cd mentioned this pull request Sep 1, 2026
13 tasks done

@connorclancydev connorclancydev left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

General Information

Update to documentation website clarifying unit tests and regular tests, their differences and explainng in more detail how they work

  • Documentation update

Code Quality

The code is easy to read and should be able to be maintained rather easy as well looking through I dont see any mistakes in it including minor grammar mistakes

Functionality

The code fulfills its function and doesnt damage any other functions anything that it removed has been clarified in the code that was added

Testing

Files formatted correctly lint checker didnt have any issues and was able to be successfully built, all lint checks passed and additionally I was able to open the website successfully without finding any issues when opened on my local machine

Pull Request Details

The intention of the pull request has been completed including the additional changes that were made after all the checklist items in the PR were also right

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants