Jenkins Google Summer of Code Office Hours, 10 Mar 2020

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: GSoC 2020 - REST API Specification Generator Project Discussion

Description

GSoC 2020 - REST API Specification Generator Project Discussion. https://jenkins.io/projects/gsoc/2020/project-ideas/automatic-spec-generator-for-jenkins-rest-api/

A

Okay, I started recording so just in case you're watched online. We are recording interest, we think about another state, PA specification generator project, it's one of google Summer of Code 2020 projects and right now we have a number of potential mentalists and potential students on the call. Christine will be driving this discussion and to answer any questions by students.

A

Christian the floor is yours all.

B

B

So, okay welcome everyone. I got the Calico saying if I guess the first thing we'll start off with is anyone have anything directly specificity to talk about for this because yeah like I figured? Oh, yes,.

B

Did you have to beg your essay Oh.

C

Should ask you question, sir.

B

C

Last time when I missed EPA so like like have mentioned about the says so say, suppose, a redoubling right turn the Hertz and packages.

D

B

A

Well suppose is for notations, it's not vs. post goes so like we discussed Museum the chart. It allows you.

E

To capture particular.

A

Difficulties here, but here means this pose, is just for capturing connotations. Do you see my screen now.

A

The library swim, but we should have couple more but suppose to be the factor, many kisses and, for example, if you go to Jenkins repository or too many plugin repositories, you can find one notations like exported there, and here you can see that, for example, that is take something easy. So there is a whole, my page where you can go and just see details about your user. So here you can see that there are some information provided.

A

So basically, when you go here, you can see that there is a name out indicated at set of user and this is exported annotation, so how it works. I'll, just open up one of my instances. They don't have so many alliances, but this one should do the job. Okay,.

A

So here I just go to: who am I okay? This is being coated in just a second.

A

Jenkins available from the a folder now, okay.

A

Let's take a look at the code why it's not available I! Believe it's just because of rotating code, the request, oh.

A

Yeah it so it was just keys. So here you can see that I get some details, like name insulted kid authorities, so this information is not the billikin generated projects automatically. That is page rendering for that. But there is Trista k, and this is good REST API, where you can receive some additional permission: I click, JSON API, and here you can see some information, so you can see that basically, there is a bunch of groups being pulled from my github account I, believe that is nothing secret in there.

A

So there is a bunch of authorities: I can use for security, the result, unification, etc. So this information is being generated by step there. So this step pleasure it's just a framework for data binding and other things, and really it uses fermentation processes to provide you this information. So these exports and allocations didn't get processed and exported to rest API. So as a developer, for example, if you wanted to generate specification for this particular dress today, you could have gone through these notations using says.

A

This output of specification, but it works for that it doesn't work for the use cases which we discussed before the days of meetings. So, for example, they give there is.

A

You see the strange blue thing: yeah.

B

A

Sure what I've done? Okay! So let's go just job Java.

A

Here, for example, do description, oh yeah, what's in the description, so this is a magic, each ourselves ourselves the job description here. You can see that basically, it's a vegetable in point, but depending on what you sent and get or post you will get different results. So forget it returns your information for post. It just asserts of information, so we could go to a page in vogue. This end point and then get this description and again it still qualifies as a part of rested in Jenkins or some other notations are the use kisses.

A

But this part of the logic is quite complex and it may require a lot of analysis or maybe a redesign of how Jenkins annotations work, because it might be acceptable for this project come up with a proposal which says: okay, let's do an addition for this rest. Api calls. If you want to get them generated automatically, they will be additional requirements, but right now it's quite a straightforward things, just in handle by step, they're independent on many assumptions.

C

I assume right for because there were no errant ations for these type of function, methods right, yeah,.

C

A

Again, missus pause won't have this use case, you can't use it. I can.

C

Use it, but only this is only capable of getting the extinction point right: extinction, education, it's.

A

Capable of them getting Kenny annotation, but it's not capable, for example, the in Jenkins that are also optional, such notations like get I'm sure we have it in this file.

C

A

Just short, okay, so you can produce rotations using access pose and we, if you explore hijinx rest api documentation. That is a bunch of them, for example, for other things like one. I present it to. Please do something what you could do. You could just process how stapler code otherwise be fixed, because you can find a lot of things there.

A

You can just try finding the ogre and it works. It's just a test.

A

So it's not going to work us so, but yeah you can just go through this code, so it's just try looking for rest again, I'm, not sure what exactly I'm looking for so making so many iterations.

A

We can always see some additional code, for example dispatcher code. We shall basically processes at request and mapping them to objects, so you can see how it's being handled there and try to reverse-engineer that and probably replace and bits of this code to specification generator, but it might be just a second part of the project because just reporting get EP is these. Notations would be good first step.

A

So if somebody wants a step deeper if I need to prepare but yeah the code today, so you can take a look.

A

Somebody has raised hand.

B

B

Our searches, our question.

E

Is a bridge like I'm not getting by using gates, you.

A

So step little space bridge framework, so it translates say: okay, excellent anyway, yeah. There is no really reading in this repository, but the eastern engine, which receives requests, so it's HTTP or HTTPS, and it can map them to Java calls or vice versa. So if you take a look, for example, a job here, you can see that say, do submit.

A

Okay, delete okay, again the description, so here you can see that the stapler requests that response and other methods. So it implies that this methods actually handled by step there so step yet, basically, logic which receives a form, submission or any kind of other HTTP requests processes for them and maps it to Java objects and to endpoints saying in the Java code, so which does all the mapping Commission. Could you expect, for example, from Spring Framework from quark?

A

Oh, so all the things now Casey it's step, they're doing that, because it's a historical piece of code.

A

Let's transfer your question.

E

You I have to search it. I, don't think so. Oh.

B

E

Not clear yet have to search it. What answer.

A

Okay, so you can review some information about requests, hope we can come nothing between what was already showing at the previous meeting. There is a bunch of jobs, and there is some jobs are related to stapler, especially a one for, for example, a tablet, requestdispatcher filtering and fragmentation. So this job to one it can provide you some insights about how stuff works in terms of new common are requests and filters.

A

So it can provide you some insights and provide links to other documentation because, yes, tablet itself is not documented, as well as the main would like.

B

Freedom, I guess opposed projects, maybe 100 or something like that. You can. If you, if you're doing research you can make well, you know ahead of time. You can make pull requests with documentation, examples or to these repositories, and that can help with understanding and then people to help other people figure out. What's going on with this deeper as well, okay,.

A

Yeah, that's right.

A

So we can find more of the communication and the developer mailing list, but yeah right now. My suggestion would be to start from a good EPS, because Getty Paris am only easy to understand and more easy to implement. So if you do prototyping it's better to start from there.

A

Okay, any other questions.

A

A

So Kristen, what would be your perception about this project? What would you like to be achieved with regards to dead.

B

Right so I.

B

Think the community I was kind of looking for something that would be able to easily there's just a little bit more bottom for whenever you go to look her and the different things within Jenkins. It's really honestly hoping that we end up with something like open, API document that would, at least you know, be a little bit more digestible easier to read through people who are kind of working with anything with Jenkins. If so, because there are a lot of API, so there are is coming.

B

There are powerful things you can do with them, especially if we start seeing in some of the plugins, but it's very difficult to figure out where they all are. So if there was just kind of a new URL based off of Jenkins, where you could see what is installed and like what api's are available and it's in an open, API, well Matt. That would be a lot easier for people to understand.

B

What's going on, I think if there was a way to that, we could keep a hand it Center, it's a difficult task, but being able to also polish that somewhere on the website. So if people will be able to know that this is even an option with you and to also then I guess included in continued building into Jenkins documentation.

B

That would be useful as well, so I think it'll start with something that is that lose vocal, and we could update our documentation to point to hey there's this there's now this document that you can look at inside it, your Jenkins, to see what they eat. The HTTP response options are of the codes, how to be able to use it and then maybe eventually, maybe you'd like later on a face for your I. Don't know that you even be able do.

B

It is figure out a way to be able to generate this and publish it to the web site as well. So it's just an easier list, so.

A

I'm, just a screen sharing one of the jobs of 2019 results, basically folded authorization project, it's a project created by all student, be the Sharma and as a part of this project, he created the depositor and small github for that organization, and here you can see aristocrat calls supported by the plugin. Now it has one of those weakness because it's generated to monitor. So there is no automation for that, but if there was automated, we should at least create skeletons. It would be a good step and again it can be done incrementally.

A

So nobody requires you to create full specification, the first step or during the entire project. You need to start.

B

Somewhere exactly but documents see how it just makes it so much easier to know what's going on with the plug engine, but it since it's done manually, it requires someone to continue to make sure the document is up-to-date, so it can easily fall behind so being able to auto generate something, even if we start off with just being able to get post nothing creaking to get. That would be useful as well it just. This is a great example of something that makes it a little bit easier for people to read to find out.

B

What's going on good examples, I think it will really people who want to be able to use the api's or even to figure out that api's are an option because sometimes I don't even know. People know that you can use API is to do everything. The penguin said.

A

Actually, one of the topics you can consider is language and rate to the specifications, because there are basically two ways. One way is that you generate them in runtime, so one Jenkins runs. Then we do it for several other projects where you can go. Example. That's more instance, that is the agent can say also here, for example, you can get the serve documentation for pipeline or documentation for configurations code based on installed plugins, most likely it will fail because it is haven't fixed but yeah.

A

This reference documentation is specification which be which is being generated on the flight dependent conduct audience sets. We use a session, it's one of the ways to do that and same is basically used, for example, by pipeline, because alright and again you can get the communication generated. Another way which might be paying attention just is generate link. Is it using the build time?

A

Also, when you build the plug-in, using whatever magic, to again generate REST API specification for particular component, and then we could have another model which combines that is documentation for either the phone instance specifically communication.

A

It might be not the trivial, but it's also doable, so you can reveal one of this approach. Edges.

B

Neither one is wrong: I think it easier to talk about in your proposal, which one you'd like to focus on first and then maybe create a library that can be cooled in the different places and that way it can be reused.

A

So basically turns up is what you prefer. If you like, front-end development, exactly it's mondo jenkins site, you could do if you like back-end development yeah, you can just take a plugin that is a plugin called maven is a plugin which basically includes so the most of Jenkins, specifically mailing functionality. For example. We could just add logic there, or maybe, as a library and.

A

It's not a junkies plug-in, it's a plug-in. Chameleon design principles are more or less the same.

A

Looks like everyone is completely confused.

A

B

Me your bottle be nice to look at.

A

So any questions any additional information or pointers. You could provide.

A

Yep again, what we discussed in chats and enjoy stock meetings. If you want to do a quick start with this project, the easiest way is to just focus on guitar api's. Maybe right, really really simple. Prototype which uses polls and polls of this information may be in.

A

A

C

A

A

A

B

C

Can I get okay if I will try to explore if I face any issues in conduct yeah.

A

So that's right, then same for all other students who might be interesting to just take a look at different implementations. Different approaches and I mean we try to keep all the information public, so we will be shank the details and, for example, if you want to collaborate between each other to somehow make projects independent, it's possible. So, for example, if you want to collaborate and split it somehow or if you just want to do some prototyping kind didn't want to step on each other's toes.

A

It's also possible so again use public channels, so that would be exempt. You ended, but again at the application phase. It's not a bigger concern. So even if you propose to pull requests which basically do the same, it won't impact anyone, because you will just take a look at this tool or the place and take them into consideration.

E

Sometimes like, if our PR, that it is enlarged for an issue that we know for an issue or something we want to, so what can we do then, like we have to wait for PR to be over, so you just start contributing.

A

Yes, so in Jenkins, especially generous cover and other chaoticness, a pool request cycle may be quite long because we need to verify the stability etc, and for you, if a particular pull request is staged, is already enough. You can move on to other area unless you're blocked. You can keep exploring that and contributing to the same request.

A

So, for example, if you take me, probably not the best example, but you can see that better- maybe it doesn't I made a clean up, but still there should be acceptable pool requests and you can all do the same. So as long as so they are independent as long as so they can be contributed separately.

A

You can just keep submitting them and if you need help use the reviews, so just think some dieter channels, because here sometimes pool requests formula through the cracks. We try to improve the situation across the community, but yeah. If you submit a request, a random plugin, you may need to raise visibility.

B

Right generally, people are incredibly helpful. They want you to work on the corpus and not let it sit around for a long time. But yes, like it, always measures on a channel or ask on the developers mailing list and people are pretty responsive.

A

And yeah, if you hope to pick your proposals, which you're trying to do something rebuked should help yeah, because yeah we will do our best to ensure that that is communicable around this project and for this particular project, I'm not concerned at all. We will have a dozen of stakeholders easily across the community interested in that, maybe more but again, I'm just trying to do something is the best way to explore how to.

B

Write and I guess also you like a litter, you're saying all the stakeholders. If they have awareness early, they can also help they'll, be excited that someone's interested looking this and be able to you know, get involved a little bit earlier and another more people to ask questions to and to share other perspectives. Now.

A

E

We have to start submitting a proposal.

A

So you can take a look at the ji-sook timeline, so there is a visual timeline and state so that application period opens on March 16th, so just in one week, but this is the first day when you can officially submit your proposal through the JSOC website, but it doesn't mean that you cannot work on your proposals now, because what we usually recommend students to do is you create a proposal draft? You can already know what information is expected, because google has student guide and we also have the student guide on the jenkees website.

A

So you can just go to this page and you can see that there is information summarizing what we expect from student proposals. Well, it's mostly built on the Google student guide, but we have some additional expectations, so you can start drafting your proposal and you can just immediate jobs through the main entries. So you didn't hit. Wait, wait until much 16th. If you already have something to propose to discuss just admit a document and people start reviewing that, though yeah right now, it may be.

A

Iterations might be long, but yeah I hope to tell you you'll. Be able to review all the proposals? Fine.

A

Okay, any other questions.

A

E

So my question is like I'm new to Jenkins platform. So do I have to just go. First, you go through what is thank, Jenkins paid from be familiar with it and then start contributing or I should just go to the github date from github and check to the PR sensor. Well,.

A

If you are not familiar to a scientist, it definitely makes sense to try it out. So what we usually recommend you can just run Jenkins example in a docker container locally, and you can just try out to making some of your projects I. Guess you have something in your universities, for example, million projects with Java or something with C++, so you could just try using Jenkins Toto meet the bill, for your project is a first step. So just study ETA and its features.

A

There'd be good.

B

I'm sorry for little, but I was thinking also I.

B

Was also thinking that sometimes with if you start to run Jenkins, it might help put some of these. You know projects that we've talked about in context as well, so you might be able to see well stapler talks about your constructing URLs inside of Jenkins. It's like alright. So now, if I create some jobs, I can click and see you know the URL being generated like and you can kind of start to see how things are built, so that might help as well. So here I say you see the folder infrastructure here.

B

I think it will help under some of these projects. That might seem a little bit more more confusing. It might help clarify what they're doing.

A

Things like yeah, probably this is not the best instance, so we have staging so you know we drive at some guys repairs, but yeah heads up a number of REST API, so they is blocked. So it's probably not the best project. But if you have your own running instance or if you find there another public instance, because many are projects like adopt, open, JDK, Apache, etc, they use to Jenkins. So you can find a lot of public instances and explore how they're organized and what is being used just to submit for the link.

A

Okay, anything else for today.

F

If I could go a little off-topic can I just throw it out there. That I could add to your list of cue items, a similar discussion for the fingerprint project. No, you.

A

Mean notice the K.

B

F

Fing up the cloud native, the finger external stop talking a print project just you know similar conversation like this. A meeting this okay right.

B

Right I think we would be really helpful to have the people who would be potential hunters and that I'm not as familiar with that project.

F

You know whether.

A

It's it to my to-do list, so certainly.

F

A

Really behind to all my projects of this week's, because they, if you open logic, has changed logs and little CS change logs, look can I see why but try to catch up tonight. So.

D

Also for the potential students on this call, if you're still here in listening, if you look in the zoom chat, submit, is put a link to setting up your development environment with Jenkins. It's a very good walk through one setting that up so I wanted to make sure we've called that out thanks.

F

A

A

Anything else should you just close the call.

B

And then so, there's no other questions so.

A

Again, thanks to everybody for your time and for interest in the junkies project, once you have applications, please think us. So we can organize something.

B

Thank y'all for bringing your questions yeah. It's good right here, we're here to help you.

A

D

Thank you, everybody. It was good to see you marked in.

F

Situ bye-bye.