Support for nested describe blocks

[jshayes]

What:

• Bug Fix
• New Feature

Description:

Calls parent beforeEach and afterEach functions in nested describe blocks. Also updates the test names to handle multiple nested describe blocks.

Given the following test, here is the output before and after this change

describe('outer', function () {
    beforeEach(function () {
        var_dump('outer');
    });

    describe('middle', function () {
        beforeEach(function () {
            var_dump('middle');
        });

        describe('inner', function () {
            beforeEach(function () {
                var_dump('inner');
            });

            test('test', function () {
                expect(1)->toBe(1);
            });
        });
    });
});

Before

string(5) "inner"

   PASS  Test
  ✓ inner → test → This test printed output: string(5) "inner"

After

string(5) "outer"
string(6) "middle"
string(5) "inner"

   PASS  Test
  ✓ outer → middle → inner → test

This change could cause breaking changes, so I'm not sure what you think of this. Since this project follows semver, I suppose this should go towards version 4.

Related:

#1023
#1138

This change was based off #1294, so it includes those changes as well, since they were required for this change.

[nunomaduro]

@jshayes honestly, looks solid. do you mind to add a few more tests? specially around stuff like chaining methods after describe blocks, hooks, etc...

[jshayes]

@nunomaduro I added some more test. Let me know if there are any cases you think I missed that you would like tested.

[zormandi-byborg]

I would LOVE this. Having no support for nested describe and beforeEach blocks was the main blocker why we hesitated to switch to Pest. This would finally remove the last roadblock. ❤️

[nunomaduro]

end() advances array's internal pointer to the last element, and returns its value.

Because this function actually mutates the given value, i rather not use it.

[nunomaduro]

We use the format array<int, string> instead.

[nunomaduro]

Can you add some tests too in the middle of the test file?

[nunomaduro]

Can you add some tests too in the middle of the test file?

[nunomaduro]

Can you add some tests too in the middle of the test file?

[nunomaduro]

Can you add some tests too in the middle of the test file?

[nunomaduro]

Can you add some tests too in the middle of the test file?

[jshayes]

There is a test after this one: multiple notes, let me know if you want other tests here as well

[nunomaduro]

Can you add some tests too in the middle of the test file?

[nunomaduro]

Can you add some tests too in the middle of the test file?

[jshayes]

I added some more tests to the end of the test files, after the describe blocks. Is this what you had in mind?

[jshayes]

Also, I noticed another issue with describe blocks that I have a separate PR for, but I think the issue is a bigger deal due do to nested describe blocks in this PR.

For instance, the following test

describe('same-name', function () {
    beforeEach(function () {
        var_dump('before each');
    });
});

describe('same-name', function () {
    test('test', function () {
        expect(true)->toBeTrue();
    });
});

Will produce the following output

string(11) "before each"

   WARN  Tests\Features\BeforeEach
  ! same-name → test → This test printed output: string(11) "before each"                                               0.01s  

Since it is just checking the name of the describe block, it will match the before each from one block into another block. I do have a PR where I address this issue, however I figured I'd bring it up here because this could have some implications on nested describe blocks until the issue is resolved.

For instance, the following test

describe('outer block 1', function () {
    describe('same-name', function () {
        beforeEach(function () {
            var_dump('before each');
        });
    });
});

describe('outer block 2', function () {
    describe('same-name', function () {
        test('test', function () {
            expect(true)->toBeTrue();
        });
    });
});

will produce the following output

string(11) "before each"

   WARN  Tests\Features\BeforeEach
  ! same-name → test → This test printed output: string(11) "before each"                                               0.01s  

This is the current behaviour, before my changes here, but I think this is a fairly common use case to have describe blocks with the same name when they are nested in different describe blocks.

Anyway, let me know if you are okay with this being a separate PR, or if you want me to add those changes here.

[hafezdivandari]

Does this also fix #1010? And #984?

[jshayes]

Does this also fix #1010? And #984?

No, this PR doesn't address those issues. For #1010, the calling with works on a describe block, however, the value is not passed in as an argument to the describe callback. It is only passed in to the test callback