1026110 - port buildapi to relengapi

Status: RESOLVED WONTFIX

(Release Engineering :: General, defect, P3)

Description

[Dustin J. Mitchell [:dustin] (he/him)]

This will be a big chunk to move, but should give relengapi a nice workout.

Most likely, the agents will stay roughly the same, so this is really just about the web service.

Comment 1

[Chris Cooper [:coop] (he/him)]

Adding nthomas as a potential resource here for reviews, etc. since his name is all over the buildapi repo.

Comment 2

[Pete Moore [:pmoore][:pete]]

Both BuildAPI and RelengAPI are well documented, so this could be a good bug for a new contributor.

BuildAPI: https://wiki.mozilla.org/ReleaseEngineering/BuildAPI
RelengAPI: https://wiki.mozilla.org/ReleaseEngineering/Applications/RelengAPI

BuildAPI was written before RelengAPI was conceived, now we are keen to move services across to the new platform. This would be a great starting point for a keen python developer.

I'm happy to provide assistance.

Pete

Comment 3

[tanujsrivastava22]

Hey man! Regarding this issue.I read those wiki links thoroughly, I have configured my environment accordingly. Now how to proceed, please guide me a little. What I understood from the topic was, that buildapi were the first one to be wriiten, now it is required to port those apis to releng api. Am I on the right path?

Comment 4

[Pete Moore [:pmoore][:pete]]

That is a good start. I would recommend also getting a copy of buildapi, and seeing if you can run it locally, following the setup instructions.

Once you have an understanding of how it works, and what API it provides, the next step will be to understand how the same service can be implemented in RelEngAPI. So you should have a copy of both on your system, working, then try to move parts across or reimplement in the new framework. If there are already tests written, this is great, because you can use them to test your new implementation.

Comment 5

[Dustin J. Mitchell [:dustin] (he/him)]

Good advice.  As you've seen, there are a few parts to BuildAPI, and it may make sense to work on them one at a time.  The easiest will be the GET bits of https://secure.pub.build.mozilla.org/buildapi/self-serve

So, although it won't *complete* this bug, I think that's a good first milestone to reach: a RelengAPI blueprint that serves all of the GET URLs correctly but doesn't yet support the POST and DELETE URLs.  After that, we can start adding some UIs to display that data, start implementing the POST and DELETE URLs, start work on self-serve, and start work on some of the reports.

Note that RelengAPI has nearly 98% test coverage, so this will need to be covered by some exhaustive tests.  Those tests, alone, should be enough to convince a reader that your new buildapi behaves the same as the old BuildAPI.

Once you've got BuildAPI installed and working locally, your next step should be cloning https://github.com/mozilla/build-relengapi-skeleton and getting that to do something really basic like return "hello world" from /self-serve/branches (with tests).

Comment 6

[Dustin J. Mitchell [:dustin] (he/him)]

We weren't able to get a DB dump for Tanuj, and without that working on this was going to be pretty difficult.  So we switched over to bug 1135818, where I can supply a DB dump.

Comment 7

[Sreekar]

Hey Callek,
I'm a new contributor. I would like to try fixing this bug. I'm prepared to spend as much time and energy necessary to complete it. Could you help me get started?

Comment 8

[Justin Wood (:Callek)]

(In reply to Sreekar from comment #7)
> Hey Callek,
> I'm a new contributor. I would like to try fixing this bug. I'm prepared to
> spend as much time and energy necessary to complete it. Could you help me
> get started?

Unfortunately (partly explained in comment #6) this bug is not good fodder for a volunteer since its not easy at all to get a DB dump out for testing.

However a good candidate along the same lines as this is Bug 1135818, which I am happy to assist with.

Comment 9

[[e-mail] (:bhearsum)]

Buildbot is dying, and so is buildapi!