Month: June 2015

Implementing missing endpoints

Hello people!

I’d like to share with you my weekly internship experience. This week I had the opportunity to finally start digging into the code! So at first, I had to understand how was the API organized. Once I understood that, I started working on the code by adding the features that were missing, which were:  ‘pool_update’, ‘pool_list’, ‘flavor_update’ and a ‘flavor_list’. There were other methods that had a similar functionality, so I could use those to implement something like that in the missing endpoints I was working on.

After writing code for these features, I started working on unit tests; as some of the methods I could look at in order to implement the missing endpoints, there were also some tests that I could use as examples to write my tests, even though I had some trouble understanding how to implement the flavor_update test. Flavors and pools usually have a similar implementation, but they are different from each other: you can think about pools like containers, or more precisely, like containers of data containers; while flavors basically have the main task of exposing pools.

(more…)

Dealing with specs

Hello everyone!

So, as I said before, I got accepted to Outreachy and my whole task during my internship  is to work for OpenStack on python-zaqarclient adding support for Zaqar API v1.1. This week, I had to work on a specification that explained what features are missing in the client side of Zaqar, and which are the things that need to be done in order to add those features.

The thing about specs is that they have to be written with the markup language, which is a system for annotating a document in a way that is syntactically distinguishable from the text. Python uses a type of markup language for documentation, called reStructuredText, which is a component of Docutils.

When writing a spec you have to be very careful to the syntax, because writing something syntactically wrong, changes completely the output, and you’ll have to fix it in order to see your spec like it should be seen. Here’s a link to the reStructuredText, if you want to know more about it: http://docutils.sourceforge.net/docs/user/rst/quickref.html.

Anyway, working on specs was my first weakly internship experience, and I found out that you need to be very precise and be careful to the way you write them, but people is always open to help you understand what is wrong or what you could improve. It was also great to know that my mentor was always available and ready to help me if I had any kind of question.

So, that’s it! Be ready for my next posts because they’ll become more interesting every week!