sschmidTU/mr-kanji-search-wtk

Testing Framework: Test search queries

Open

#9 opened on Nov 8, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)HTML (3 forks)auto 404
help wantedtesting

Repository metrics

Stars
 (10 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Use a testing framework (e.g. mocha or karma) to test the search automatically.

example tests with mode, search terms, kanji that should be found:

wk,coffin sun,者
rtk,old man sun,者
wk,mustache scooter,過&適

For that, set wtk_search(query, {updateHTMLElements: false}. (of course we can also add browser testing where it tests interacting with HTML elements, but one step at a time)

Maybe also integrate the tests into the build / continuous integration (Github actions, so that the build only passes if the tests pass).

This could also be a nice issue for volunteer contributors.

Contributor guide

Research direction
Set up a testing framework (e.g., Mocha) and write test cases for search queries using the example CSV data, invoking wtk search with updateHTMLElements: false. Optionally integrate with GitHub Actions CI.
Tech stack
javascript
Domain
testing
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75