GitLab Pipeline Insights Group, 15 Jul 2021

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Code Coverage MR Approval walk through

Description

James (Product Manager) and Erick (BE Engineer) Walk through setup and sue of the new coverage check approval rule: https://docs.gitlab.com/ee/ci/pipelines/settings.html#coverage-check-approval-rule.

A

Hey I'm james heimbach, the product manager for the testing team in the verify stage, and today I'm going to walk you through a new feature of the just headgatelab.com on canary uh maybe has made its way all the way out to production around the code coverage approval rule. uh So I'm going to start by sharing my screen and I just shared the zoom link with my team. So we might have somebody be joining us at some point.

A

um So, starting with the issue that we're working on uh displaying the code coverage approval rule um all the back end works actually done in 14.0. You could hack around um and get it set up. That's just not a great experience for customers.

A

um So now we have the mr is done and we have a coverage check, approval rule, and so I'm going to be walking through just one of my demo projects setting this up so that if code coverage decreases, I will not be able to merge that mr without approval of emr because of this rule. um So that is what I'll be tackling I haven't set this up before I haven't played with merger press approval rules before uh so. This is going to be fun and exciting for both of us, um so I'm going to take.

A

This is a clone of a project that I used previously to create the same sword: functionality uh just with the shell script. um Super hacky way to do it easily worked around, but it was at least a speed bump for teams to be able to do. This, you'll still be able to do this if you're using um just a core product with free product um or ce, uh so because this requires request approvals, which is a premium feature, um but this is just a clone of that.

A

So what I'm going to do is actually start with the docs. With this request approval the docs are out there.

A

And I believe it is in here and approval rules.

A

Separation of duties- oh.

A

So we have a coverage, check, approval here.

A

Okay, so we actually have steps for this. Let's break this window out.

A

Oh, let's do a share a couple screens. Everybody can see everything there we go okay, so it looks like we just follow our steps um kudos to the team for making this nice and easy for me uh thanks folks, so we're just going to follow these steps to enable the government's check. Mr approval rule um in this project.

A

And this is the old project. This is the. This is just an mr that failed with these shell scripts, we're going to remove that from the gitlab ci demo after we get this approval rule set up.

A

So this is the project, it's a public project, so that I can use this preview feature and, let's just go through so going into settings general merge, request. Approvals is here because it's a public project and, let's say prevent users from modifying mr approval rules and merge requests and enable this one.

A

I'm going to do this on our default branch here master requirement approval and I need an approver.

A

See if that'll.

A

A

Great, so I am in there.

A

I don't think I'm in this project so that may not work.

A

Yeah that matches okay, so to make myself an approver um just for the sake of this demo. Usually you would make another group or somebody else, an approver for a project like this. The workflow would probably be make team lead or tech leads an approver so that you can kind of go that break last scenario. We have to push patch out no test coverage is decreasing.

A

All right, go ahead and say my changes. Great all right, um enable the coverage check, select, target branch variable is greater than zero, which we did the users and then great, um so that is all set. uh Let's go into our project then, and let's get ready to state yammel all right. So we don't need this coverage check.

A

A

Okay, um so that is done, and then I'm gonna basically copy this, mr, that adds the untested function. I don't remember what I added so we'll put that over there.

A

A

Okay, so we're going to add a function here that.

A

A

A

Just a simple little thing cool: so I'm going to save this and run pipeline.

A

A

A

It should actually be pretty quick, so I'm not going to pause the recording.

A

Click in and see what this javascript.

A

That's pretty boring, um see every other thing I could have added here.

A

That might be helpful.

A

Hey this test coverage, visual visualization. Could work really nicely with this feature as you go in, you can see really quickly what is not covered by a test that is causing that test coverage decrease in the mr diff.

A

That is not something that I have enabled in this feature, though, so I don't think I did look at the old project well, that one's doing its thing.

A

Yeah uploaded the report g unit um because I'm creating looks like a jococo file here I could pretty easily uh convert that over into cobotura, which is the format that's supported and then upload it as a artifact report coverterra and then get that test coverage visualization data, but I was using jococo for this one. It does look like that gets published out to pages, so I still see the data there on file view, which would be nice.

A

Looks like my job is done, cool and that's some coverage. There.

A

Probably because I didn't have test coverage set up in here, let's go into.

A

I always forget where this is.

A

A

A

A

A

A

A

I was looking for all of the examples that are not there.

A

A

A

That's going to be helpful here: let's go back into the merge request and actually remove the code that we added and just update the.

A

Update the gitlab ciamo turn with the job.

A

A

A

So get us test.

A

Coverage ahead and pause, the recording, while this pipeline is running and then we'll be back when we have test coverage data.

A

All right my pipeline finished, um I actually already hit merge for it all right. It is in the process of it's already with that. um So now we have test coverage. We have 15 test coverage on this project from one job. If I was calculating test coverage in multiple jobs, which you see in the gitlab project for both front end and back end, our spec and java are our spec and chest. Rather, um you see multiple jobs there and that tool tip breaks it out. So you can see what each.

B

A

Is that contributes to that overall number and we just take the average, so that is there? We have our 50. Now we have something to compare against um so now that we have that I can go in and actually add my other code.

A

A

Just make sure I'm sharing the right stuff here we go cool, um I'm just.

A

A

A

Function start making merge requests. No, that's not gonna work.

A

I missed a curly bracket there we go that'll work better.

A

A

Alright, all right I'll pause for a minute. While this is running and when we get back, there should have some stuff to look at.

A

All right, my job is finished running you can see. Now we have 36 coverage, which is not going to be enough to get this merged.

A

Oh, it's totally again merchant.

A

A

Not sure what coverage check is saying that it's been approved, since I can't really prove it yet.

A

Well, that's interesting.

A

Normally, you would think that that would not be checked because it has not been imprinted by me, but I am not familiar with how the options from that work.

A

I'll pause for just a minute.

B

I'm going to try to.

A

Get another approver in here uh from the team who can help approve another, mr um and see if we can't show how this actually works.

A

All right uh we're back eric, has joined me he's sharing his screen, he's a engineer on the testing team and eric is going to basically recreate my mr in of this project, but with himself as the author, and that should get us what we need. He should not be able to approve it because he is not the owner of the project. That is the problem. If you're the owner of the project, we can merge things.

B

Okay, um let me see what do I do. ah Let me go to merge requests. I guess yeah.

A

If you copy the code, that's in that change and then go into the repository and click the web ide button on that file, you can just type that in and commit it and start a new. Mr.

A

You developers and you're working locally and pushing branches and stuff, not just the web. Ide.

B

Do I need do I need to fork this project or can? Can you add my user to your project? First, oh, I can add the user yeah but support this project. Although I can fork the project I can, I can add the user that'll be easy enough.

B

So I'll just copy this.

A

I have an owner of project information.

B

Members, sorry: what file was I editing them obligation right.

B

A

I can't thank you all right. I've invited you, as a member of the group, remember the project rather.

A

I should have just invited all the testing to start.

A

B

Create a new branch.

A

Eric you worked on the back end of this. To add the the check, I believe right, yep awesome. No, I don't.

B

Think we've ever.

A

Done one of these kind of feature demos and recorded it before I'm glad, I was able to snag an engineer who worked on it.

B

So yeah it shows the the coverage check rule here.

B

A

A

A

Cool- and I already see in my to-do's that you've sent me as an approver for that, mr.

A

Cool, well, we don't have to wait for the pipeline. um Can you stop your share?

A

That's probably I can. I can do mine cool so then in in the mr, because I'm the approver when I go and look at it, I see requires approval from the coverage check.

A

A

A

Doesn't show me the test coverage, though that's.

A

A

I wonder my coverage didn't parse.

A

A

A

hmm Well, that's interesting! You would think that I would need to approve this if there's no coverage, that's actually happening.

B

B

Does the job have the look at the space.

B

Did it have the coverage value.

B

B

We're trying to parse the coverage from the xml, I believe so well. It should be from the.

B

A

Oh there it goes it just took it a while coverage just showed up awesome. That's still really.

A

A

And I'm still not getting the coverage change on the mr or on the widget, though huh so not working quite as expected, uh it does tell me that I have to approve it.

A

I wonder, though, if that's, if it didn't have coverage data to compare yeah, it does not yeah wait.

A

The last master pipeline.

A

Yeah it had coverage so that coverage.

A

A

Now the coverage is there, otherwise, it's not showing up.

A

I mean the workflow would be I click approve. This is fine, oh then, it showed up yeah all right. Well, we found a bug.

A

It works kind of now that it's approved eric should be able to merge this though, um and it would decrease the coverage, but you can't see how much it decreases the coverage. I wonder if I revoke approval of it.

A

Now it's back! That is all right! Well, we'll keep testing on that and see what happens and um get that fixed up thanks. Sir all right, I don't know that I'm gonna post that.