sTeam GSoC 2016 Windup
(ˢᵒᶜⁱᵉᵗʸserver) aims to be a platform for developing collaborative applications.
sTeam server project repository: sTeam.
sTeam-REST API repository: sTeam-REST
An overview of the work done by ajinkya007 during Google Summer of code 2016 with FOSSASIA on its project sTeam.
The community bonding period saw the creation of a docker image and a debian package for the sTeam server. The integration of the sTeam shell into vi, improvements in the export and import to git scripts, user and group manipulation commands, sending mails through the commandline, viewing logs and the edit script modifications were done subsequently. The later part of GSOC saw that the sTeam-rest repository was restructured, unit and api-end point tests were performed. The new web interface developed was tested.
The code written during this period by me and siddhant was merged and the conflicts were resolved. The merged code was tested thoroughly as no automated test integration tool supports pike programming language. Documentation was generated using Doxygen and deployed in the gh-pages of the sTeam server repository.
A trello board was maintained throughout the course of GSOC 2016.
Trello Board: sTeam
Accomplishments
- Issues Resolved and Pull Requests Submitted for the same
- Commits Merged
- Blog Posts
- Scrums
- Further Improvements
Issues Reported and Resolved
A list of tasks covered and all the Pull requests related to each:
| Tasks | Issue | PR |
|---|---|---|
| Make changes in the Makefile for installation of sTeam. | Issue-25 Issue-27 | PR-66 PR-67 |
| Edit script modifications | Issue-20 Issue-29 Issue-43 | PR-44 PR-48 |
| Indentation of output in steal-shell. | Issue-24 | PR-42 |
| Integrate steam-shell into vim or emacs. | Issue-37 Issue-43 Issue-49 | PR-41 PR-48 PR-51 |
| Improve the import and export from git scripts. | Issue-9 Issue-14 Issue-16 Issue-18 Issue-19 Issue-46 | PR-45 PR-54 PR-55 PR-76 |
| Create, Delete and List the user through commandline | Issue-58 Issue-69 Issue-72 | PR-59 PR-70 PR-78 |
| Sending Mails through commandline | Issue-74 | PR-85 |
| Generate error logs and display them in CLI | Issue-83 | PR-86 |
| Create a file of any mime type from command line. | Issue-79 | PR-82 |
| Add more commands for group operations. | Issue-80 | PR-84 |
| Add more utility to the steam-shell | Issue-56 Issue-71 Issue-73 | PR-57 PR-75 PR-81 |
| Restructure the sTeam-rest repository | List of Issue’s | List of PR’s |
| Write test cases to test sTeam-rest api | List of Issue’s | List of PR’s |
| Create a debian package and a docker image for easy deployment | Create docker image | Docker Image |
| Document the work done | Issue 149 | sTeam Server Structure, sTeam Server Documentation |
| Test the web-interface | ✓ | ✓ |
Commits Merged
During the course of GSOC 2016, work was done on the sTeam and sTeam-rest repositories.
1. The work done on the sTeam repository.
We have combined all the work into two branches for the ease of creating a debian package. The commits made by me in each branch can be seen here.
2. The work done on the sTeam-rest repository
The push request’s sent for the issue’s are yet to be merged in the main repository. The list of PR’s for the sTeam-rest repository.
The weekly blogs
The blogs summarizing the work done during the week were published on my personal website. These can be found on Weekly Blogs
All the blogs can also be found on the Fossasia blog.
The list in reverse chronological order is as follows.
- sTeam Server Object permissions and Doxygen Documentation
- sTeam Server Peer Review and Merging.
- sTeam REST API Unit Testing
- sTeam API Endpoint Testing
- Generating Documentation and Modifying the sTeam-REST API
- Pike
- sTeam REST API
- sTeam demo
- Extending sTeam shell commands
- Increasing utility of sTeam tools
- Improvements in sTeam shell and export script
- Enhancement of steam-shell plugin and Import from git
- Integrate sTeam-shell into Vi and Indentation of output
Scrums
Scrum reports were posted on the #steam-devel on irc.freenode.net and sTeam google group. The sTeam trello board also has everyday scrum reports.
Further Improvements
- sTeam command line lacks the functionality to read and set the object access permissions. sTeam function analogous to getfacl() to change the sTeam server object permisssions.
- sTeam debian package for easy installation of the sTeam server. The debian package is yet to be fully packaged.
Special Thanks
- I would like to thank my mentors Mario Behling, Hong Phuc Dang, Martin Bahr, Trilok Tourani and my peers for being there to help me and guide me.
- I would like to thank FOSSASIA, sTeam and Pike Community for giving me this opportunity and guiding me in this endeavour.
- I would also like to thank Google Summer of Code for this experience.
Feel free to explore the repository. Suggestions for improvements are welcomed.
Checkout the FOSSASIA Idea’s page for more information on projects supported by FOSSASIA.