Up And Running with Pest
Playing
29. Sending a friend request

Episodes

0%
Your progress
  • Total: 4h 19m
  • Played: 0m
  • Remaining: 4h 19m
Join or sign in to track your progress

Transcript

00:00
OK. So in this episode, we're going to do a little bit of UI work. We're going to hook up our navigation just
00:05
to tidy up some things. And then we're going to get to the point where we can test. And then within our UI, enter an email address of another user and see them in our pending friend request list.
00:16
So first things first, let's go over to app.blade.php and head over to the friends link and just hook this up first of all so we can access it. So I can now navigate to that.
00:27
Great. And now let's build our form. And before we submit it through, we'll write a test that the endpoint actually
00:34
takes the email address, validates it correctly, and of course, adds the friend. So let's go over to friends and index and build out this form just at the top here.
00:47
So let's go ahead and steal the header here, pop that in there, add a friend, and then we'll build a form just down here. So the action is going to be probably to friends. The method is going to be post.
01:06
And let's build this out. Now, we'll steal this from login because we've already got some form stuff in here. So let's just grab this, paste this in, and pull this in.
01:16
Now, for a lot of the stuff that we've been doing, we've not been attaching errors on the UI. We'll clear that up a little bit later. For now, though, we just want to be
01:25
able to pass a friend's email address in and click a button. So why don't we just add a class onto here to say space y3 maybe. And then we'll go over to login. And let's just actually grab the markup we have on here
01:42
because that makes a little bit more sense. And then let's grab the Login button. And we'll put that in here to send request or whatever we want it to be called.
01:57
OK, great. That looks good. So we want to enter an email address. But before we actually submit this through,
02:03
we want to write a test for this. So let's go over and say php artisan make test. And we're going to call this friend store test because that's pretty much going to be
02:13
the name of our controller. Let's have our pest flag. Let's head to friend store test. And let's think about the three things
02:21
that we want to test here. The first one is that it validates the email address to make sure it's actually there. The second one is that we can't add ourself as a friend.
02:32
That doesn't make sense. So we need to bear that in mind with our validation rules. And the last is that it actually stores the friend request, e.g. we can see it in the database.
02:43
And because we've already created the test over on our friend test here that it can actually see this, as long as we know it's in the database, we then know it's going to appear down here.
02:53
So everything sort of links together and starts coming together. So if we head over to our friend test, let's just grab the refresh database trait.
03:03
And let's pop this in here, get rid of collection. And let's write our first test that it validates the email. In actual fact, the first test should probably be that we can't do this if we're not authenticated.
03:15
And we've already got that over in our feature test just here. So let's just grab this, go over to friend store test, put this in here. And we know that this is now a post request to slash friends.
03:28
So let's run this test. So test, tests, feature, and friend store test. Of course, it fails at the moment because we don't have anything to be found.
03:41
So let's create this out. So phpArtisan, makeController, friendStoreController. Let's go over to routes and web, create this out as a post request using the friendStoreController.
04:00
And over in the friendStoreController, we know to make this test work, we need a constructor with our middleware. That's auth.
04:10
And then down here, we need an invoke. And that's going to add the friend. So let's run our test. And we get green.
04:18
So that redirects successfully with that. And we can get on with the first test that it validates the email address. So it validates the email address.
04:29
Or you could be really specific and say that it's required. Let's create this out. So all we need here is just a user. So let's say user factory create.
04:41
And let's just make sure we pull that user model in. And then acting as that user, we want to post through to slash friends. And we don't want to send any data down here.
04:54
We just want to assert that the session has errors and email. So let's go ahead and run our test. Of course, this fails because we're not doing any kind of validation whatsoever.
05:14
So let's bring our request object in. And let's just do this in the controller. We can always refactor, as we saw earlier, to a form request if we want to.
05:24
And let's say that the email here is required. Let's just leave it at that for now. OK, that passes. Now, we also want to check.
05:33
So it validates the email address is required. But we also want to test that the email address exists. So we want to make sure that we're actually adding a user that exists.
05:48
Now, this is a pretty easy test to write because we can just pass in any email here. Because at this point in our test, we've only created one user in the database.
05:57
So we can pass any email that isn't this user, and it should exist, or it should not exist. So let's say mable at codecourse.com and expect that we see an error.
06:06
Now, at the moment, of course, that's going to fail because it's just required. There's no exists rule here whatsoever. So let's say that we want to make sure
06:16
that it exists in the users table under the email column. We don't need that. It's taken from here implicitly. But let's add that in here anyway.
06:25
Run our test. We get green. Great. So we know that the user has to exist before we add them.
06:31
Now, let's create a different test. And let's say it can't add self as friend. Pretty important. That would be silly.
06:42
So let's go ahead and switch this up to the user who is making the request and their email address. So again, a very similar test here,
06:51
but again, just making sure we cover everything. Now, if we run this test, we expect this to fail because, again, we're not checking anything within here that makes this fail.
07:03
So let's go to our Friend Store controller. I'm going to switch this over to an array so we can use Laravel's rule object. And we're going to say not in.
07:15
And we're going to pass an array in here. Let's just pull that rule in here. We're not in. And we'll just grab the currently authenticated user's
07:26
email address. So this cannot match anything in this array, which at the moment is just the requesting user's email address.
07:34
Let's run our tests. We get green. Great. There are our validation rules completely done.
07:40
OK, so the last test we need to write is that it actually stores the friend request. Let's write this out now. Stores the friend request.
07:50
And let's go ahead and create this out. So again, we're going to have a user in here. But we also need another user in here now to be the friend that we're sending the email down as.
08:04
So let's go ahead and say friend. And again, acting as, not action, so acting as that user. We want to make a post request to slash friends.
08:16
And we want that to be the friend email address. So we know that that should work now in terms of our validation rules. And then we want to expect that this data is in the database.
08:28
And therefore, expect that we see it in the UI because we've already written a test for that. So let's say assert database has. And under friends, we want to make sure
08:42
that the user ID is the requesting user. The friend ID is the friend that we're adding. And we can say accepted false. So we can cover that part here as well.
08:57
Because of course, this test could pass if we just had these two in here if we hadn't used the correct method to add that user and if they would have been accepted
09:06
within this controller. So this just adds a little bit more protection. Let's go ahead and run our test. Of course, we get false because the table is empty.
09:14
So now over in friend store controller, we just want to go ahead and implement the solution to this. So we already know what we need to do now because we've already written tests for this.
09:25
Grab the currently authenticated user and add a friend. We need to look this friend up by their email address. So we can just say user where email and request email. And grab the first user back who matches that email address.
09:42
Let's pull the user model in. Let's return back here with this. Let's run our test. And we get agree.
09:48
Perfect. So now we can hook our UI up pretty confident that as long as we send the data down properly here, this is going to work.
09:57
So let's do that now. OK, so if we just come over to our friends index page, let's take a look at our form. So that posts through to friends with an email address.
10:09
As long as we add our cross-site request forgery protection, this should work. Let's try it out. So over in the database, we've got Mabel.
10:18
Let's try and add her. And let's hit Send Request. And there we go. We know that we've got pending friend request as Mabel.
10:28
Everything works nicely. Now, we know that this shouldn't technically add this user twice because we've already created a test for this.
10:37
We're not handling this within our control and showing any kind of error. But we're also not showing any errors on the form at all for any of the validation that we have got.
10:45
So what we can do is just very quickly tidy that up. So if we come over to our register controller or register view, we didn't add any errors here either. So probably a good idea to just start on the friends index
11:00
page with this. And for this, we just want to go ahead and say error, email, end error. And then in here, just implement some sort
11:09
of styled error message. Let's say text small and text red 500, maybe a margin on the top. And just output the message in here.
11:21
OK, give that a refresh. Hit this. Email field is required. OK, there we go.
11:25
We have hooked up this pretty much by writing our test first and then implementing the UI. Let's head over and look at accepting friend requests from the other side.
35 episodes•4 hrs 19 mins

Overview

Pest is a PHP testing framework that brings beautifully simple syntax to your tests, without sacrificing on features. In this course, we'll get up and running with Pest in a Laravel project and write tests for a real-world application that we'll build along the way.

You'll learn how to set Pest up in a Laravel project, write tests with Pest's built-in assertions, generate code coverage, and more.

Alex Garrett-Smith
Alex Garrett-Smith
Hey, I'm the founder of Codecourse!

Episode discussion

No comments, yet. Be the first!