Allow to plan tests with todo flag

[mateusjbarbosa]

Hi, everyone!

First, congratulations on the initiative! I’m using Poku in a new project and I’m loving it.

One thing I used in Jest and believe I can add here is also the possibility of planning tests before developing them, using the todo flag or method, as the example below.

• Jest format Jest API reference

test.todo('ensure that is possible sum two numbers')

• Propused Poku format

import { describe, test, it } from 'poku'

describe('Using todo', () => {
  test.todo('ensure that is possible sum two numbers')
  // or
  it.todo('ensure that is possible sum two numbers')
})

If I may, I can try to develop and open a PR. I would love to be part of the project!

[wellwelwel]

Thanks, @mateusjbarbosa 🤝

Can you show a visual reference of what the terminal output would look like?

---

For example, the skip visual:

As I've never used this method before, in my mind it would sound similar.

[wellwelwel]

I'm wondering about the current complexity of test / it modules

poku/src/modules/helpers/test.ts

Lines 8 to 14 in 8dae9f3

	export async function test(
	message: string,
	cb: () => Promise<unknown>
	): Promise<void>;
	export async function test(message: string, cb: () => unknown): Promise<void>;
	export async function test(cb: () => Promise<unknown>): Promise<void>;
	export function test(cb: () => unknown): void;

---

What do you think about this approach?

import { describe, it, todo } from 'poku'

describe('Using todo', () => {
  todo('ensure that is possible sum two numbers');

  it('real test', () => true)
})

todo('ensure that is possible sum two numbers')

[mateusjbarbosa]

Thanks, @mateusjbarbosa 🤝

Can you show a visual reference of what the terminal output would look like?

For example, the skip visual:

As I've never used this method before, in my mind it would sound similar.

Of course, @wellwelwel !

I think it could be something like this:

Directory: <dir>

<file>.test.ts
    ✔︎ passed test description
    ✘ failed test description
    ❍ planned test description (yellow or orange)
✔ 1/3 <cmd> › <time>

Start at › <start>
Duration › <duration>
Test Files › <files count>

PASS › 1 PLANNED › 1 (same color) FAIL › 1

Of course we can think of a better icon for the planned test, it was just an example.

[mateusjbarbosa]

I'm wondering about the current complexity of test / it modules

poku/src/modules/helpers/test.ts

Lines 8 to 14 in 8dae9f3

	export async function test(
	message: string,
	cb: () => Promise<unknown>
	): Promise<void>;
	export async function test(message: string, cb: () => unknown): Promise<void>;
	export async function test(cb: () => Promise<unknown>): Promise<void>;
	export function test(cb: () => unknown): void;

What do you think about this approach?

import { describe, it, todo } from 'poku'

describe('Using todo', () => {
  todo('ensure that is possible sum two numbers');

  it('real test', () => true)
})

todo('ensure that is possible sum two numbers')

It's perfect!

[mrazauskas]

To be honest, I just wanted to open an issue asking for .fail, .only, .skip, .todo modifiers. Not so important how that would be designed. What is important:

• it must be possible to set any of the modifiers for any describe(), test() or it()
• also a single assertion can be skipped or focused (that’s optional)

Motivation is very simple. If tests are well organised, while debugging / developing certain behaviour user might want to skip or focus the whole file, the whole describe() or test() and even a single assert() (note that test() is not required in Poku). Why not? ;D

[wellwelwel]

(note that test() is not required in Poku). Why not? ;D

In theory, even assertions aren't necessary, it's enough for the process to end in success.
My idea in creating Poku was to have a really modular tester that I could build my own style of testing.

• Please feel free to request features, report bugs and even discuss ideias for PRs (I'd love that) 🙋🏻‍♂️

[wellwelwel]

Hey @mateusjbarbosa, it was solved in #633 and will be released in the next version 🙋🏻‍♂️

Similar to the .skip method from other testers, .todo also accepts callbacks which will be ignored for future elaborations or prototype implementations (this isn't a replacement for the future .skip method).

For more details, please see https://poku.io/docs/documentation/helpers/todo.

Now that all the bug labels have been fixed, I'm happy to be able closing the first feature request 🎉

[mateusjbarbosa]

Once again, thank you for your attention and congratulations on the work! 🚀

[wellwelwel]

Once again, thank you for your attention and congratulations on the work! 🚀

Thanks for your support, @mateusjbarbosa 💙

Already released in v2.3.0 🙋🏻‍♂️