Week 3

Published: 06/20/2019

What did you do this week?


The main tasks that were accomplished this week are as follows:

* Successfully resolved merge conflicts in this PR which contained major changes and improved master.

* In the same PR, some work has been done in order to get the tests working on travis. Currently there has been a significant improvement in the number of failing tests (for now, a total of only 3 tests are failing, which will be resolved later as the priority for now is changed to implementing the functionalities of export section).

* Discussed what format to follow in order to raise issues and resolve them in PRs. So instead of having one big issue which contained all the information about failing tests, individual issues were raised which addressed the failing tests and the reason behind it being failing

* Tried finding out the cause of failing test and successfully resolved it. link

* Found a bug in the current implementation of export and resolved it. link

* Apart from this, we also decided discussed about having user stories which will help us in understanding the user scenario of our application and wrote some of the user stories. Inspired from this project

* Developed a solid understanding of the UX roadmap and what all features to expect from the export functionality in the website. Things were not very clear on the grounds of what to expect as a user when we visit the website and hence were a major hindrance in proceeding with the project. Those things got sorted out and I feel more confident with the UX roadmap and what all to expect from this project.


What is coming up next week?


* The initial user stories that we decided were mostly covering the tests, CI, and code analysis and some part of export. However, we later decided to move on to the export task being the focus for now and started writing stories that would be helpful in covering the export functionality. This is a WIP and the aim is to code up the maximum functionality of export which will cover these users stories by the end of first evaluation phase.


Did you get stuck anywhere?


* I was initially concerned while raising PRs and issues whether the format that I'm following and the path on which I'm progressing is correct or not. We had a discussion this week and then decided to give atmost priority to export functionality for now, instead of tests and CI (which can later be incorporated along with the implementation of desired features)

* I was stuck in writing user stories as I had no prior experience in writing such a thing and mostly because I didn't spend much time on the application and was not involved previously when the discussions related to UX and the roadmap was setup, so I didn't know what all to expect from this application. However, all these doubts got resolved and one of my mentor guided me in that and I am now comfortable with writing such stories.

* I was also stuck for some time in understanding the libraries that were imported and were used in the existing codebase. I played around them and used debugger extensively to understand the input/output for the methods that were used.

View Blog Post

Week 2

Published: 06/09/2019

What did you do this week


This week during our weekly hangout meeting, we've discussed the major outline of the project and what should be the primary focus of the project before the first evaluation. We also made some modifications in the original proposed plan, the minutes of the meeting are as follows:


Minutes Of the Meeting: Link


Above minutes of meeting lists out major tasks that have been/are to be accomplished and/or have been discussed this week. Apart from it, the following tasks are also achieved this week


  • Setting up project board on github which keeps track of the tasks accomplished and tasks that are to be done (or are ongoing), which will ensure a smooth and better communication of the project along with reflecting a proper understanding and accomplishments on the tasks
  • Simplified testing with travis CI and building the current project against version 5.1 of plone. Got the build pass for buildout, however the tests for the projects are still failing.
  • Had a look over the currently failing tests (a total of 6 tests were failing) and tried resolving it. Succeeded in resolving one of the tests completely and also proposed a solution for 1 more on how it can be handled and what necessary changes need to be done in order to fix it.
  • Published a list of all the failing tests (ongoing) by creating an issue on github which will help in keeping the track of the tests being fixed and the methods or proposed solutions being implemented in order to fix those tests
  • This week, I also got to learn PDB and how to use PDB in python development process
  • There was a old issue which addressed a zip file being corrupted (which was also one of the cause of failing tests). Resolved this thing and raised a PR with updated correct zip file (also mentioned in MoM)
  • Along with the above major issues, some minor issues like following good coding practises, typo fixes, updating README file for project were also look after this week by creating issues on project's repo.
  • Apart from it, I also got a chance to look after the main (core) code section of the project and played around it to develop an understanding of how things are working (primarily I explored importexport.pytest_importexport.py and utils.py)


What is coming up next week

Next week will primarily be focused on completing the above listed ongoing tasks and addressing the issues raised with main focus to listing all the failing tests and starting with the export part of the project. There are some section of the existing code that is not neatly written and may require rewriting for it to be used without any hindrance in future. However, the priorities may change accordingly when we have our next mentor meet the coming Wednesday which will decide a solid outline of what all are the things to be accomplished for the coming week.


Did you get stuck anywhere

I got stuck while trying to figure out the reasons for failing tests a little bit (with things like debugging while performing tests, import errors, IOErrors etc), however I was able to overcome it and started an issue to keep a proper track of it and organized it in a way which contains the section for Overview, Description (Reason), Proposed solution and Extra remarks so that while I try to fix all the tests, my mentors are well aware of the ongoing progress and proposed modifications.


Along with this, I was also very confused regarding how the project should proceed and how much of the time should be given to CI part (also how much of the support should be extended to various versions of plone), on which I got the clarity after our weekly mentor's meet, which proved to be really helpful.

View Blog Post

Week 1

Published: 06/02/2019

What did you do this week

This week was mostly getting familiarized with how testing with tox and travis works. The current build were getting failed and the main issue was a weird tox related error. Got rid of the error and finalized to shift tests without tox for now. Also had an introductory meet with 2 of the mentors and also decided to have a weekly meet which will be focused towards what target to accomplish every week. I also fixed a bug which was causing build to fail (the reason was a missing dependency in the project). Apart from this, I've received the permissions for the project repository from Plone. We also finalized which plone versions to support so that we can extend the support for our project to those versions of Plone. Since we were having our tests failing and other projects of plone also had similar manner of performing tests, I also got a chance to look at other projects of plone to figure out how they testing is done and what possibly could have went wrong.


What is coming up next week

Next coming weeks will completely be focused towards getting the build pass and cleaning up tests and getting them running successfully on travis.


Did you get stuck anywhere?

I was a bit stuck in tox related issues, some of which I was able to figure out and was able to resolve them on my own. However, I finalized with my mentors to leave tox for now and move on with travis alone for supporting multiple versions for the tests. Also I am still not very clear on some specifics of how the testing works in plone and what all tests we need to cover, which I target to get clarity on by my next weekly meeting with the project mentors.

View Blog Post

Week 0 (Before coding period starts)

Published: 05/26/2019

Tried understanding how testing works in plone. Also tried to understand the existing codebase and marked section of the code which can be further improved (that were initially not included in the proposal)


Also setup travis for experimentation purpose (apart from the one already setup on original repository). Faced a problem while in testing in travis CI. Currently all the PRs fails travis testing and not all tests are covered in travis test. The aim is to shift all the testings to travis so that we can have continous testing on travis itself along with each PR and commit.

View Blog Post