GitLab Release Group, 7 Apr 2022

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: release-cli development environment

Description

Jaime showing how he develops/tests release-cli, also showing how to run in docker

A

Okay, uh let me bring a terminal and then from there.

A

Cool, so I'm here and I really see like, can you see my screen? Yeah yeah, okay, cool uh alrighty, so I I think I just pull. Let me just I'm sure again.

A

Yeah cool, so the the cli itself is actually very fairly simple to run. What I normally do is just call make, and this should build it. uh You can see here basically removes whatever we have before, and then it just gets the dependencies and builds it and yeah.

A

It builds this command on the cmd, slash relay cli. Let me bring in my editor as well.

A

Oh uh yeah, so here on the right side, I have the the command and, as you can see, is this really cli? uh It's fairly simple in terms of code, all it does is initializes the app and it has some logging in there. uh We use this app. So I'll walk you through the code, the for the first part of the code. I guess it's not too not too complicated.

A

um We use this. Your fav cli package, which basically give us like an interface to to uh interact with the cli, uh is the same that the runner uses. So it's the output is very similar. So basically, when I've built it, I can just call this binary here and I can just call help and it should give me the output for it, and this is basically uh the two commands that we have is create and get and then a few of the global options that you can, that you can configure.

B

A

For example, if I wanted to run and get a release right now, I can do this. I just need to do server url, let's try with gitlab.com um project id. I just need to get an id from my.

A

Projects think I have one.

A

This one maybe yep hello, and I should have some releases in here- yeah cool.

A

I just I'll, get a tag, this one and then okay, so I set the server. uh We need a job token or a private token. So you see there's two options here. The job token only works with the ci job token. uh So here you just need to use private token.

A

And this is one of the api tokens.

A

I have that one there and then you can configure things like the timeout. If you want to, I think the default 30 seconds should be enough. uh Then this other flag is the ca search bundle if you're using like custom certificates or self-signed certificates, you can find them there if you want to skip the https verification and if you want to debug, actually a tn recently added this debug plug, so we can see a bit more in there and then uh the way this uh your fav cli uh thing works.

A

You need to specify the global options first and then you need to specify a command. So in this case I can say get and then we can do help to get the help for the get command.

A

I guess I missed something incorrect, you say it help get.

B

A

ah Project, oh, I missed type project id, there's a title here, yeah, so all the global options and then we do get, and I want to get the help for get yeah cool. So it's down here. Basically the options for get is the tag name. This.

B

A

A required option and then, if you want to include the description as html, you just set this flag when getting a release. So if I just replace help with tag name and then I give it uh sorry, this one.

B

A

I wanted to copy the tag from here: yep tech name: can you see my screen or is it too small yeah yeah yeah yeah cool, so I'm just passing the tag name here and they should. They should give me back the yeah. The list of the release.

B

Right now, you can get it only by the tag name right, no not by id or you can get it by the.

A

No bad id only by by tag name, because this is basically a proxy to the uh releases api yeah. It is text, okay, yeah and it uses text in here. So.

A

Get a release by tech, name yeah! It's basically making this api call okay, yeah uh and as you see, because I pass a debug flag in here, we can see some information like uh you know the request that we send and then the response that we're getting back from the server and then the json object for the release in here. If I remove the debug flag, it should only give me the the json, so I can just pass it past it with jq, for example, and then I get the release information in here.

A

Yeah, uh that's basically for getting a release. This is the easiest command. The the one for create needs a bit more information, so we can use the help here. uh I think the at a minimum. You need to specify the name and.

B

A

Sorry, the tag name and the reference yes.

B

A

Are the minimum two things that we can that we need? So I can just say tag name s today, whatever and arrest, I think I can just say, master master. It should work. Let's try this yeah release created successfully with this tag.

A

Yeah, and it just gives you a bit of information. um So if I go, if I call it doesn't print the json object, not when you create one okay yeah, so that.

B

Could be any return.

A

Yeah it does, but uh we price, like the price, the response, and then we just print it like this. It's like a bit prettier, okay, but yeah. It could be an improvement that can be done there and if I just go test today, it should give me the latest videos, yeah, okay- and this should be reflected in the ui as well yesterday, yeah so yeah. That's that's! Basically what the really cli does uh if you want to work with the cli by itself. So that's that's how it works.

A

uh If you want to use it in ci, you just need to make sure that whatever machine is running, your job has access to the release cli, so that the best option is to have the release cli image and run it in a docker runner, and then it does the thing by itself and you know the release keyword. I have something.

B

Yeah, actually, no, maybe how it works.

A

Yeah, so if, if you know how that works, then yeah we can maybe skip it. um Just have a real quick to show you there's a release, keyword and then you basically specify the same things.

B

Yeah the way I understand it is just the syntax sugar for like it basically creates a script for you, which runs the same released cli with.

A

Like with all these parameters, yeah yeah exactly it's basically a one-to-one relationship with the with this parameters. On the c on the ci template.

A

So that's basically how how I run it uh anytime. You make a change. You can just call make or make build that should get the latest changes and then to run tests. I can just call make tests.

B

Why it's underscore test?

B

Oh or let's see.

A

Wrong place yeah it's called make test, but then underneath it all, it calls this underscore test because there's a couple of modifiers, it's more like a function, kind of thing, and then you just pass whatever parameters you want is.

B

It is there a way to test it like in a short way, so I don't see every test being run, but only summary and only failed tests.

A

Maybe I don't remember if I added this, I mean.

B

In pages, I just run the go test like dot, slash, dot, dot and it tests everything just prints there. Oh.

A

Yeah yeah, you can do that. You can do the same. Go test like this.

A

That's probably easier.

A

Yeah, okay, so make tests. It's just give you like a lot more information, but yeah. It's the same as pages okay and then yeah. I uh do you want to see the docker file or how that works and stuff yeah if possible, yeah. So we built this in ci for the image that gets pushed so here in the build scripts.

A

There should be one that calls nico yeah. So.

B

A

This docker image to build it's basically like a docker in docker uh builder. That allows you to build okay images uh and this guy. I don't use this locally. I I think I can just call um docker build here. Docker fill you need to give it the file or you can just.

A

uh We can tag it so, as I say, test release, cli and then the path.

A

ah Sorry, it's just minus t yep. uh I might need to restart my thing.

B

A

B

Rancher, instead of the docker desktop right.

A

Yeah, because of the licensing issue.

B

A

It's a bit: it's a bit painful this. This wrencher sometimes doesn't work like. I just need to restart it. For some reason it uses like a a lima virtual machine under underneath, and then it runs docker inside the the virtual machine. So it exposes like the interface to your mic and then it just like sometimes doesn't work.

A

Let me see like restarting sometimes that's a trick.

A

And it also this one runs a kubernetes cluster in your local machine, and sometimes you don't need all that so yeah. Can you disable it? uh The cluster? I don't know I haven't. I haven't played with it.

B

Okay yeah- I never used it before so, yes, we'll need to find out how it works.

A

Yeah um this should take a while, but.

B

Oh yeah, I see.

A

Basically, once this is built in theory, you can just do docker run and then you can probably you need to pass like the the current environment or where the project, where you, where you're running from so I normally do uh here and then to whatever whatever you want to do so, go ahead. What it does.

B

It uh it's mountain, the volume.

A

Or yeah, so minus v is a volume and it's telling it okay mount my current directory into the containers into this containers directory.

A

Okay and then you need to tell it okay, my working directory is gonna, be go up, so it's just to switch into.

B

A

Okay and then in here you can just say: uh look around: you need to pass the the image name so because I tagged it as this release. Cli test, really click.

A

Here and then you can just pass the commands in here really cli help, for example.

A

So in theory this should work once my socket is running yeah. Let me build it again. Bill.

B

Is there a way to do like build and run in single command.

A

I know you need to build it and then run it. You need to build it with a tag and then run it. Okay,.

B

If I build multiple times for the same attack, it will replace it.

A

Or uh it should replace it. Yes, okay, yeah! You don't need to create a new new tag. All the time.

A

This might take a while, because it's downloading that go image.

A

Yeah and my my 4g is only not very fast.

B

Oh yeah, let's see.

B

By the way where the cache for the docker leaves it is it on your local machine or on this strange virtual machine in rancher.

B

Basically, I'm asking like.

A

It's been directed.

B

So, every time you restart the rancher, if you try to rebuild anything, it will download everything from scratch right.

A

uh You should keep the images now. You should keep the images in the virtual machine because it doesn't delete the machine. When you stop it, you should only stop the machine yeah, but I think I haven't used. I haven't downloaded this go image, so that's why it's taking a bit longer.

B

A

A

In the in the meantime, I don't know if you had uh questions about the code, do you want me to walk through it or are you? Are you happy with just exploring.

B

I looked at it before a, but not recently, I don't know.

A

B

Anything interesting about the code. You can well we're waiting. You can just show me.

A

Yeah uh so I'll give you a quick overview. The main package basically just calls this app new, and this creates this uh your fav cli instance, and it gives it a few commands or a few configurations. So if you want to modify the help text, for example, you can do so by defining some of the functions in here and then you just basically pass.

A

However, however many commands you want to add, so if, in the future you wanted to add an update, for example, you will need to implement the command here and then just pass it from from here. um This list of commands are defined in this package in the commands package, so there's one create and then there's one get and then each sub command.

A

You can define like the different flags that it needs, so it's pretty straightforward really how to if you wanted to add or modify any of the flags going here and then each command, you pass it an action, and then this this action function is is gonna, do whatever you tell it so this will only this will call the create release and then it's just gonna do some parsing and validations and stuff, and we create a gitlab client, which is basically the one that is going to talk to the api.

A

So the gitlab client is defined here and it's it's a simple http http client that you know it does a it attaches a token. If it's there, the project id blah blah blah and it sends sets the correct headers and it makes requests to whatever you. You ask it too.

A

So yeah, it's pretty simple basic, and basically, when we get the output from the release, we just print it. So the the pretty version I I showed you is done by this function.

A

Instead of you know, instead of printing the full json, we just print some information about it and that that's pretty much it the for the get command is very similar. It gets the release and this one actually prints, so it creates a json encoder and then encodes the release object in json json format,.

A

And yeah: that's pretty much it there's a bunch of tests everywhere, so that probably makes the code a bit bigger than what it is.

B

Yeah, what's the red lines on the console, just something was printed.

A

To us there, uh no, this is actually just. uh I think it's because we're building is the docker uh client building the image, and it just prints this in different color. For some reason: okay, yeah.

B

Basically successful.

A

Right, yeah yeah everything was successful. You can see here successfully tagged here and then, if I do docker images.

A

It's here this is the tag, and this is a sha that is generated as well, so it should match always so if we call docker run now uh yeah, but uh we're mounting the directory into here, we're just saying work from this directory and then like this.

A

This should theory help yep this. This worked so basically it's just printing their help from inside the container.

A

B

And I, if I recall correctly, I can just.

B

Get an interactive terminal into this range yep yeah.

A

So you could do that by doing bash and then just saying minus ti, I think bash is not maybe sh yeah so yeah. Basically this is the same same output as my working directory outside of the over here so whoop. Sorry,.

A

And then the release here like when we build the image we expose the release here live binary and we put it in here.

B

Yeah I saw this in the docker build.

A

Yeah, so if I just call it uh from here, it's the same.

A

And in theory we should be able to call the api as well, but I don't have my environment variables anyway. Yeah you should be able to just make uh calls from thai.

B

Yeah yeah, the only.

A

Thing the only thing to be aware of is: if you make changes to the code, you will need to reveal the docker image.

A

But it shouldn't take, it shouldn't. Take too long.

B

Yeah, okay, maybe I'll make add a couple of make comments to kind of automate all of this and make it like a single command to just run an extract, interactive terminal and maybe or just run the release. Cli.

B

Yeah cool yeah thanks so much for showing this can we, I probably stopped recording.