kworkflow / kworkflow/kworkflow

Break test dependencies

Open
#555 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Epic
Dominant language
Shell
Stars
191
Forks
112
PR merge metrics
No merged PRs in 30d

Description

In the ideal unit test setup, we want to eliminate external behaves from our target test. For example, suppose we want to add a test for functionX; inside this function, we call functionY from a different file. In this scenario, we should try to mock functionY. Unfortunately, this is not the case in the kw code, and it represents a huge technical deficit for the project. We need to refactor our tests at some point, but let's register this critical task as an Epic to someone else work in the near future.

Acceptance Criteria:
Expand our documentation to describe how to mock functions.
Create a milestone that has an issue per test with this dependency problem.

P.s.: Ideally, we want to fix this issue before releasing version 1.0.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by identifying kw tests whose target functions call external functions, since no specific files or tests are named. Document how to mock functions, then create a milestone with one issue for each test dependency problem; completion means the guidance and issue breakdown exist.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
documentation, testing
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.