Jenkins Google Summer of Code Office Hours, 4 Jun 2019

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: GSoC 2019 - Knowledge Transfer: Making Promoted Builds plugin Pipeline-compatible

Description

This is a recording of the Knowledge Transfer session about making Promoted Builds plugin Pipeline-compatible while retaining binary compatibility (Jun 04, 2019). This session could be useful to Jenkins Developers who migrate their plugins to Pipeline.

Meeting notes: https://docs.google.com/document/d/1SRLb8IeIKy3Ih83de0bDSHdJQdtmygloPfMMNRArkvo/edit#

GSoC project link: https://jenkins.io/projects/gsoc/2019/artifact-promotion-plugin-for-jenkins-pipeline/

A

Okay, so we gave real-life.

A

B

B

Somewhere there is I was thinking that we'd, oh we've got through the agenda figure out where to press the button. There.

A

A

B

A

If you want taken screen shape, for you know,.

B

You should I can't remember how to do it.

A

A

B

Anyway, that was that was the part, because I want to show just yeah proposed agenda that from stick put in the Kidder. Yes, I. Think yes, yeah, then there's just talk it through this I think about the last part about breaking down talks. It should be somewhat easy to do it offline. So there's no need to use your time all night. To this so I say that's why I should take it at last, there's just just to wrote an example of the one of the issues we should break down so anyway.

B

C

B

C

I start on with the questions yes or not: Alec, hello, yeah,.

A

C

So first question is like the compatibility issue that you mentioned yesterday, like how can it be resolved.

A

Actually discussed yes,.

C

A

Because I have shown some code, samples etc, but.

C

A

Do you want me to do that again now or do you have another no.

C

Like just that part at that particular code, like okay.

A

A promotion batch right, yes,.

C

Yes, Automotion match yeah.

A

C

Think what this you have? Okay,.

A

Okay, I'll probably just be idea so.

A

So you just put information about. Oh.

A

Yeah now it's starting okay, good, so yeah. There is a document for pipeline integration and the results, a document for a belief from eclipse about compatibility.

A

Just the can't evolve in java-based EPX, oh yeah, you remember. We have already seen this patient. Oh yeah. These documents are rather 2 main guidelines describing how you could do that so yeah. This documentation is probably not enough for but yeah some topics so yeah. Let's take a look at our particular example believe it's loading, promoting bills, yeah.

A

A

C

You want I can have the good.

A

Because how to make to this promotion which appear binary compatible, so I think that we can just have a short show-and-tell session.

A

A

So that I just.

A

Yeah I can just mute or one particular channel, so serving disconnected from handouts.

A

A

Okay: let's go to the master branch; okay, so yeah together. This promotion.

A

Okay, sorry, a ski, and we have a method which takes abstract build. So, yes, we discussed that the previous session, when you use the abstract, build apps from project another types. It should be read for you that it's not compatible this pipeline and have a problem here, because we have a method and we already have a extension points which increment this method, hmm probably we have extension points outside the plug-in.

A

So if you just change here from abstract loop to run as you did in your pull request, if you go to this guideline, you may see that there is.

A

A shape change of type of formal parameter, it's actually a breaking compatibility, even if you upstream the type, so it might not be obvious, sometimes because yeah there are some documentation tool. So it you retain source compatibility here by changing the type by, but you do not retain binary time. Peabody can so what we do instead.

A

So something like that. So now we keep this method as this, but we stopped eating in any you method. So, for example, yeah now it will be run so, firstly, what you need to keep in mind here that AVMA, if you have a new method here, you can get in the source code which I mean with so you cannot retain the same method, usually how it's being done, for example, you can pass built listener here or it's doing the configuration resting up, so you have a new method actually built.

A

This is not fast, so it would have been unnecessary to in shape anyway, I.

C

Didn't really listener is usual. My things only I know.

A

Yeah, it's just a second, so run the various think he because the run missing it is a is a method for for checking completions of for the neurons, so I.

A

Still cannot open the project properly.

A

A

But actually build get built listener.

A

All maybe not just second.

A

Okay, let's start from task listener, so task listing it is a top-level endpoint.

A

Well, there should be me today by the way.

A

A

I just forgot the method but yeah, so it should be. Listen, FK, we'll get to it later. So if we take a look- yes, sorry I really forgot the code yeah so bill. This net is what we, even if we work for fight one on Python.

A

So here what we can do is yeah. There is in limited here we can call it run to make it.

A

So, instead of that, we just put an annotation to make the.

A

Patient's environment variables- it's not documented, but we can check.

A

C

This makes it compatible I.

A

For now its compatible so anyways we will see how to refer to the entire code yeah but yeah. So what you here, what we need to do is say you have a new method. This one we see it's duplicated.

A

Because if you want to all.

A

Coming so your story for distracted, sometimes.

A

Distracted also, my ID Hanks, which also doesn't yes. So, let's see currency at the branch targets, very alteration core, but yes, you. We have this method here, so yeah.

A

Well, it should be this method though yeah there are. There is a more simple implementation, so from.

A

So what we need to do here, promotion.

A

Which okay? So what we need here we introduced a new method and you need to ensure that since not every new implementation has all we can say that if an instance of abstract ago so yeah, if a new implementation authorized this method, then it's fine. Okay,.

A

Okay, if the message is not overwritten.

C

It will be the classical baby. This is an instance of attract good means. If it is a classical build, then what do you do.

A

So if it's a classic build, very simple sub proach is to just invoke or the existing methods. So here we just converted abstract build.

A

Please not required.

A

Yeah and then you know what else do we need me to pass environment? That's it so here we invoke the vault method. So what it means is that when this matrices in row to be full but to the all the implementation, then here yeah we can keep it uses. But ID have invitation here which comes from our status. So you me see that it also uses all PPI and we have to do pretty much the same here. So we create deprecated method here.

A

He use a substrate built here, but we can still pass just missing that now so yep we use new EPRI in old method so that it still involves new lps ways were possible, but you basically deprecated this existing committed.

A

A

So something like that so here we also retained compatibility.

A

Okay, yeah so yeah. You will be able to polish up this implementation later and just show how it works so yeah we have a new method, but then what we need to do. We need to see you who uses to this old method, 1 method which is getting environment so, and you may see that it actually already receives task listener.

A

So what we discovered here that you will have a method which all the game has login attention which you haven't even before, so we pass the listener here but yeah. If we do that there is type conflicts, because we assumed that all listeners actually build listeners. So the most simple way to fix that and to retain will actually go to definition. Decoration just say the turkey. It will be task listener. It doesn't really matter fault, because this is just an abstraction class. But here you just say task.

A

A

Emotion fix Javadoc, yeah okey, so now this get status thing should be able yeah. It's able to invoke the thing correctly here.

A

Let's take a look politics and the code, so he you may see that target he with abstract build, so we won't be Tasha bit right now, so a factor so yeah I'm leaving good for you, so that we do not go much forward, but we did only one part of the intimidation, because what is our problem that we have promotion page a bit having limited here, but implementation still use this method, so we need to find implementations.

A

So you may see that there are two implementations end up turning the ignition and condition what we do here, but yeah it uses mooing. Okay, let's use.

A

A

So here there is no sense to invoke this method. To be honest, so I will just keep it because it was no up it.

C

A

For historical reasons, so yeah this method is fixed and there is also a manual condition, which also has a saw promotion which you can see it's no, but in Monell condition you also have bad. She believed yet he he was at the beach and he which he wheels have built and first method. So here we do the same.

A

A

And here you can see that there are some tricky things here, because yeah there is.

A

Good clothes and yeah here you can see a problem which is going here because yeah more than is instance of promotion, a factor to support pipeline emotion types so again, I just want to do so that we don't touch it now. So what you can do here, I just will give you a hint. So here you have a promotion.

C

A

A new communication so yeah, you already started refactoring this class, but you have already discovered that it's a kind of a pill bottle. So what you could do is you can so here we can say that it's promotion for.

A

Abstract projects and yeah, we can do what we can say that yeah there will be a new interface, so yeah. I will create just in the hats, on a package for now, but yeah, it's budget to move it yep. Okay, let's skip it! Is this okay, the sauce.

C

A

A

With promotion or something quite a bit, yeah I just make up, we think for now, so we creating in you, let's say interface for now promotion. So this promotion.

C

A

C

The needed methods from promotion would be used in this new interface exactly.

A

And here you can I'm not sure what it's to do.

A

Okay, so I'm not sure what they really mean it I'm, not touching it. So here let's go back to our mineral condition, and here and now we have that if.

A

If it's not a promotion or an expected, a promotion around but good.

A

So here we have promotion around and now we know that this method needs to have parameter values in order to support this promotion.

C

A

Yeah, what we do yep is it find that I probably consume too much time at the call.

C

It Ryan did. This is needed to build.

A

Okay, there should be public method here: okay,.

A

Something yet too many classes, Orton, oh good, parameter values. I was looking for the wrong thing so yeah. We know that that was meted good parameters radios. So here.

C

A

Say yeah and move this implementation upstairs. It looks like so for promotion, page I'm, not sure, but the elbow just move it for now or so that we keep it simple. Okay,.

C

A

A

Yeah, so we just have a method to.

A

Implementation.

A

Yeah I'm not sure how it would be finally done, so we need to do more crunching to get it right. So I just refer to do comment behind. We move through this line, and our next problem is about parameter values, so that is a method for building environment variables.

A

It's a part of Jenkins for actually, but you may see that the base material is already duplicated and we have a new method for runs, so what it means. Firstly, that if you want to make it efficient, we would need to provide to a built environment for promoted run, but since we are not fully sure what would be the interface of promotion run. For example, me yeah, one of the ways is to say that promotion run is always a run.

C

A

Yeah, we can say.

A

So for me right now it doesn't look like 100% condition. So here we can say that.

A

So we can just say that they will being limited something like.

A

Run and he, if we follow such approach, it already looks like we might eat genetics here, I.

C

A

A minute with generics in Java, oh yeah, so if you have a genetics, we could have added some static. Attaching.

C

A

But here let's move on again so now we broke computability of this method because yeah now we do not have they think and yeah it's already.

A

So maybe we actually need two methods because yeah this is already a difference because promoted run, emotion, run yeah, so it's very quite complicated, so yeah. You will like to need to rename this method.

A

And this is execution which does the promotion.

A

So again we see that which.

A

Because this may be two separate jobs.

C

A

They even exist. These jobs are separate, but, for example, in your new implementation for pipeline, it might be different.

A

Promotion run so we implemented these two interfaces here, but now we need to understand what we actually returned here, because now obviously not an option but yeah. Here we have here we have a good target, so the target is the Builder that this promotion from outed so yeah. My interface is just the target here: yeah well yeah you can rename it later. Maybe it should be just a good target of its source whatever, and here you get promotion run. We just return this actually because.

C

A

It's here, so, let's take a look here in this method to actually retrieve built for these, so it's actually, promotion run and Venice some run conditions which so there is some magic which we may refer to later yeah, because he definitely makes to move to a default method.

A

But yeah, let's go back to mono condition, so here we can say that we can again apply refactoring. So now we have promotion run so drop me. This code is not longer required because we can say that actually it's a promotion run. So instead of having this woozy check, we just enforce it in API.

A

Well, so yeah, it's yeah I will keep it as ease, but you can add a factory.

A

So yeah it's just a question in there, but you here what we do.

A

We just convert the type.

A

And the yep here a promotion we just actually put it here, the built-in parts- and he we know that it's a good promotion run so one which actually execute the thing. And now we see that actually it wasn't like post, I, probably messed up the interface.

A

The method is called built environment. So again you may see that there is method, name change and it has been overrun for binary compatibility in the core. So like.

C

A

Added additional parameter task listener because it was reasonable, but when the core was a refactored instead of data, there was a method renaming which is also fine. Okay,.

C

A

Yeah, we final condition and then firstly, we fixed all the partitions, so I will compile and our work has been for all existing by just be touched. At the same time, yep.

C

But testing, if it is like compile incompatible, is if it compiled successfully after change. We can assume that.

A

It's done because, well, you have noticed automation for that. So.

C

A

Why, when we discussed it before in the chart, I propose to have a promotion step, so something like well I can't easily do it here, because I don't have classes, but what we could do.

A

There is a new class like something adventure at a motion which step so instead of full implementation of the plug-in to test that you can have a small step which actually does the promotion.

A

So I won't be able to actually write anything here, because the decoder dependencies are too old, but yeah you can, if you take a look at this method of Python integration, so the descriptions about steps step.

A

Ok, so we are, one of the ways is to just implement simple build step, but we, a simple 2 step, actually requires works workspace. So it's better to use pipeline step. Api.

C

This step means what does this step mean like in the pipeline script? Chips in the pipeline script, yep.

A

Yeah, so I can show the way you can find that this API, because yes, so this guy actually so it's probably not the best guide.

A

Writing pipeline compatible plugins defining symbols. Yes, everything is important, so you will have to go through this guide. But the entry point for you here, there's a there is a dual step thing and yeah. This build step think actually recommends using simple, build step because simple, build step is really simple: okay, simple bills up for quickly the problem there that it will require workspace.

A

So it's probably okay for now, so, let's see whether I can access simple I feel step yep. So it's probably the most straightforward way: yeah use pipeline step, okay for advanced fields. So for me it would be fine if you start from simple build step, though it has its own limitations but yeah the advantage of it. It's really simple.

C

A

Something like, oh, why does it have so many methods, yeah I, think that the most of them are default. Ones: okay, if not yeah, I think, even if you got a doubt what is needed but yeah. Basically, you will end up with implemented this one simple matter to a plus some descriptors in order to.

C

Yes, then one question is a descriptors for a new instance. When a new class is made are descriptors, like mandatory, like I learned, that it is a global configuration to make instance available throughout the plugin. Yes,.

A

It's to make cool extension points and elements configurable. So if you do not want the extension point to be configurable, then you do not need descriptives.

C

A

So yeah just added some sample code, but yeah it's basically. What would be you need to do so he just somehow defined based.

A

Take and what so yeah we have this.

A

You just stop here for now, but it could stop. Okay,.

C

So I quickly move on to next questions like in promotion condition or like promotion condition yeah in that I guess that is the main entry point of this plug-in right because it extends the extension point, promotion condition.

A

C

To ask like, in this conventional method of passing the promotion parameters through the web, UI I, guess, there's something called a descriptor list in the promotion condition that registers the input the desired input right. How is it passed? How is it passed from the UI with parameters or which variables are through which these inputs are being passed? Okay,.

A

So, let's take a look one.

A

Condition which have already touched so you may see that there is actually a bunch of code, but what you can see that there are parameter definitions there. No, it means that promotion, condition, I, know, condition, stores its own definitions, and these definitions actually get retrieved by promotion.

A

When you start the code, so yeah, let's go here yeah, you may see that there is better such things like minor conditions, so what it does that yeah when somebody requests parameters for promotion, the code sheds the manual condition is enabled and if manual condition is enabled the parameters are propagated from there.

C

In promotion days manual condition right, but for self promotion there is no method called self promotion in promotion. So how does it happen? For others like self promotion, parameterised promotion.

A

Well, let's take a look myself.

C

Promotions made you look positive emotion, okay, take conditions.

A

Conditions, promotion, okay, so yeah, it's health promotion, village, self promotion condition. So here, let's see so promotion be just consults. Is.

A

Well-Conditioned that promotes ability as soon as it's done so first thing he that actually doesn't return any parameters. Like my no condition you.

C

A

What it means that South promotion condition is not parameterize about: let's take a look at the its implementation, so he it's almost nothing except one completed handler Rashida's promotion, but it gives promotion and just does of execution. Let's take a look at the web, viewing so its resources, conditions of promotion, condition on and again there is no parameterization here at all. So what I believe that self promotion has no parameterization?

A

It has no premiere extra station the coat in web UI and it will just execute promotion. These default parameters, I mean.

C

How are these parameters then put into self promotion? Ideal, understand manual, I understood at this pattern trace. But how does the modules in this plug-in know that self promotion, self promotion is being called and how are those inputs.

A

Let's try to stick in the coat again so yeah just cause other passes. Okay, so here we have self promotion condition. If you stall down, you can see that there is a wrong listener, is extension point which actually mean monitors completions of jobs. So he monitor completions of abstract bills. So obviously you you will have to work it for pipeline, but this extension point here, probably looking to just rename it here and call it my not compatibility breakage so something to discuss later.

A

But here once job completes, this handle receives identification from Jamie's car, then water birth, it checks whether so one any job completes. Then they it retrieves job property. So don't.

C

A

So these job properties promotions, your property and when it exists, we assume that this is a job which has promotion logic defined. Then we go to promotion processes and for which process we check conditions and they, if any process has a condition with self promotion condition, then self promotion, so its promotion process I can see the promotional and we he we go to be schooled. Actually it just goes through all approvals, so yeah. If all approvals are past, whether it's my approval so whatever, then we just execute promotion. That's it.

C

But this future promotion is for after it is been built. This is for, after, like this.

A

C

A

So this condition gets invoked only when the build is completed, but they fail.

C

C

Fine and badges or like like badges one confusion about badges, is how our badges are saying like before promotion like in this self promotion. What we can see is it gives up an approval badge to that build okay. So how is that done? Badging is. How is it done? What's.

A

Here so there is no magic there so get to that using the code. So here the only code related to promote is can see the promotion here we process all the conditions, so I would assume that yeah. Then there is a method here which is considered sorry. There is the matter to consider promotion. Here we can get remotely built actions action a so. We okay.

A

Yes, oh yeah: if there is no promotion, we just go forward and yeah. There is a magic called remote, so yeah, let's go filter in the code implementation remote. Then there is action and he we actually have that there is a code code stubs qualification. So we need to return back because yeah they met. It was actually so. The quarter comes from qualifications promotion, so it might be here might be here, but we need to go back to consider promotion so and you can see the promotion.

A

The risk qualification code status, qualification is might so I guess that it's actually sound way inside in.

C

Promotion condition you.

A

Know it's a promotion condition or whatever so yeah. This stuff would be generated when promotion conditions are met, and now we need to understand where the bed is just injected. I focused that it's gets involved here but illustrate to find a way it comes from in the code, so go to declaration hey we have addiction or whatever so promoted, build action and I believe that it contains budgets right.

A

A

Actually, it's not.

A

Let's take a look where the badges come from, so this.

C

Another class promotion: this is one badge in the promotion bill, Mundi promotion, badge or Java. Oh yeah,.

A

Right so the one we were watching, so, let's take a look: well, it actually gets used, but yeah it will be everything current status, so yeah. You may see that register start in status as we discussed so what it means that when we had a qualification in this code, so here oh here, we actually at qualification with these badges to the action. So it means that it's just information about badges. Let's, let's take a look.

A

The pages actually get generated for these status, so you can just look for usages of this parameter and he would see we have value right. We have only one execution, I, it's in the constructor. So when we construct status, we put all the edges here. It said the only way to modify badges and, let's take a look. This logic was made. Yeah we come again to. This is much mattered. So therefore, so here is might for promotion torches, and so we passed all conditions disk and each condition it's a bridge.

A

Here we accumulate bridges and don't return the status. So this way we get all the pages and then they get to the action.

C

Okay, we get okay, badges are assigned from this: okay, okay, okay, okay, that is pretty much it and like I, had like redefined one task in JIRA that I will be making at least ni. Yes, yes, the next question is okay. This is done. Okay, badges is done, since we were working for pipelines now, promotion trigger this class promotion trigger. How would we implement this in pipeline because we'll be triggering a new job? Okay, so now badges have been assigned, badges have been a sign now. How is triggering done? Oh yeah.

A

Let's talk about triggering so here what we have trigger that starts when a promotion happens: okay, so yeah! You may see that so, let's firstly see you where these three get gets involved, because I believe this trinket is a part of promotion process between nation right.

C

A

So promotion, so it's.

A

Basically, this is a trigger on therefore post execution, so for marking you some, we handle promotion figures and yeah. This promotion triggers. So it's your way. It gets from find usages.

A

Okay, so let's go to the super method. You may see that it's part of abstract mute but effectively it's executed after execution of the guild, so yeah we can just find usages but yep. Basically, when the build finishes in abstract build, then we go through this code in order to invoke emotion triggers so.

C

Around this, we don't need this. Do we.

A

Probably dead, but not in this implementation, because this implementation was likely created the in ancient times and now what we have already seen in this view that there is redundant sneer so maybe for the new implementation. It's enough to have done this in yet which actually checks, promotion triggers so run. Listener just verifies that the build is completed and the once it's completed a it can consult with promotion triggers and trigger other bits.

C

Ok like get to notification things from the build. That is what I didn't.

A

C

Look exactly so.

A

It means that you want me to implement the logic like you have a promotion process. Instead of that, you just subscribe to run listener so.

C

For this promotion process also I need to make a new interface and like taking important methods into the new interface right, yeah.

A

C

A

So one of the things you can do I can just push this piece of code. Yes,.

C

A

You kind of probably just start from it so that you have a small request which just addresses are these wedges and you can just.

C

Like push that code, okay, like I, think you have to go so like it is pretty much out Thank, You, Alec and, like last question. One question is: you said in get a page suggest that you suggest having separate, PRS and separate JIRA tickets. What did that yeah.

A

Right because, for example, if you take a look, we have created a pretty insulated logic for promotion batch. So if there was a separate ticket for promotion which we could have reviewed to this pool request separately and this request separately before you touch other things. So then now you can deliver mentally in smaller chunks.

A

B

The thing about the last bullet point for our agenda to split up that one issue into smaller issues.

A

Okay, so you know yeah what I will do. I will just submit this code. Oh yeah I'm, not using IntelliJ IDEA, so you may see that there are some things like that, which is not a good practice.

A

So yeah I'll have to revert it later, but okay I'll just submit it. As is, and oh.

A

Okay, I can do it in source tree, so it would do, but if I reverse it before pushing the change so yeah, let's agree that I will just submit a new change. Maybe in twenty to thirty minutes. Okay,.

C

Are they okay make no more questions from me? Like you have a meeting so I I guess Jordan. We will talk for a little long.

A

So if John is available, I.

B

Have a meeting you're telling up right now, but it's a short one. She'll get back to you plastic right right after I've done the other meeting: okay, okay, okay,.

A

Stop the broadcast for now and then, as a next step, you agree how to break down the thing. If you create a separate test for promotion, which I will just push the code with this ID and.

C

Also simply share the YouTube channel as like yeah.

A

Because I don't need to cut edited.

C

A

So yeah, thank you all thank.

B

You like very presentation, yeah.

A

Well, it was rather light coding, but yeah if it helped, you guys, consider doing coding, sometimes because it's a really helpful practice.

B

It helps me to get a better look to see what what hide the curtains magic, Jenkins's.

A

B

Okay, like my my.