8000 Added a tip about hardcoding URLs in functional tests by javiereguiluz · Pull Request #3592 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

Added a tip about hardcoding URLs in functional tests #3592

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 8, 2014
Merged

Added a tip about hardcoding URLs in functional tests #3592

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
220e124
Added a tip about hardcoding URLS in functional tests
javiereguiluz Feb 20, 2014
b284e88
Fixed a minor typo
javiereguiluz Feb 20, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions book/testing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,12 @@ into your Symfony2 application::
The ``request()`` method takes the HTTP method and a URL as arguments and
returns a ``Crawler`` instance.

.. tip::

Hardcoding the request URLs is a best practice for functional tests. If the
Copy link
Contributor

Choose a reason for hiding this comment

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

I am not sure it is very clear. I think you can just also adjust a base url as a parameter and that should take care of things no?

Copy link
Member Author

Choose a reason for hiding this comment

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

No, this is about the following scenario:

Your app has a "foo" route with the "/foo" path.
Your test generates the route using the "foo" route name, not the path.
Everything works and your users are very happy with you :)

2 months later, the new company intern changes the "foo" route and the new path is "/foooooooo"
The functional tests keep working, because routes are generated with the "foo" route name.
But the website is completely broken for the end users, because the "/foo" path no longer works

Copy link
Contributor

Choose a reason for hiding this comment

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

but this is not the solution, the idea with route names relating to path is intended. Instead I think what we can be proposing is to lock a route to path test for functional, that locks this definition, if there is a change in any of the route map then it should fire up a warning to update the path on the functional test. no?

Copy link
Member Author

Choose a reason for hiding this comment

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

@cordoval I'm afraid that I don't fully understand your alternative solution.

Copy link
Contributor

Choose a reason for hiding this comment

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

it is simple, you mentioned that you may have a test

public function it_should_return_200()
{
    // ...
    $customCrawler = $this->visit('gush_go');
    $this->assertEquals(self::OK, $customCrawler->getStatusCode());
}

instead you would have an extra test:

/**
 * @test
 * This test was autogenerated by an extra command in GushBundle :D
 */
public function it_locks_my_routes()
{
    // ...
    $routes = [
        'gush_go' => '/gush-go-go',
        // ...
    ];

    // some assert using the router asserting that a given route correspond to a given path
    // ...
}

just trying to think on your problem and how it could have been avoided.

Copy link
Member

Choose a reason for hiding this comment

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

I think that only makes things much more difficult, @cordoval

Functional tests (acceptance tests actually) are created to test if the website works for the end user. Creating yet another Unit test to test if it works for the end user is a no go imo

Copy link
Contributor

Choose a reason for hiding this comment

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

exactly we make things difficult for this newbie, and tests should flag red when she does something that she is not supposed to without updating the route properly. That is exactly the task for a good test. Notice for us that we know we can just generate this type of test automatically so it is totally easy to maintain such test.

Copy link
Member

Choose a reason for hiding this comment

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

I don't think we follow eachother, @cordoval. It's easier for someone new to testing and Sf2 to use a hardcoded URL than to use the router to create a route.

test generates URLs using the Symfony router, it won't detect any change
made to the application URLs which may impact the end users.

Use the Crawler to find DOM elements in the Response. These elements can then
be used to click on links and submit forms::

Expand Down
0