wiki:SummerOfCode

Version 70 (modified by pmagrath@…, 13 years ago) (diff)

--

Google Summer of Code 2008

This is the main tracking page for MacPorts' Google Summer of Code.

2008

Project Student Mentor
Logging and MPWA Dale Emmons Juan Manuel Palacios
MacPorts Framework: A Cocoa Framework for the MacPorts Tcl based API George Armah Randall Wood
MacPorts Web Application Rick Martinez James Berry
Root privileges Paul Magrath Rainer Müller

2007

The MacPorts projects that were undertaken can be found on last year's page on the SoC site.

Applying for SoC

Applications must be done online, on the Google SoC website. You will find more information on their page on Student Applications. Student applications must be submitted by 5 pm PDT, April 7th, 2008. The official timeline should be consulted for the other dates.

There are several things to consider. We are willing to support and mentor students who want to gain an experience by working on The MacPorts Project. We have many ideas for potential internship subjects, yet we are open to anything that is both interesting and relevant to MacPorts. Motivated students do not necessarily need to know Tcl language beforehand, especially if they already know several script languages such as python, ruby, php or perl.

The best way to apply is to first make contact with us, either by sending a mail to the MacPorts developer mailing list, to the potential mentors listed below, or to irc members on #macports on freenode.

Mentors

The following committers have agreed to be mentors for SoC (append @macports.org for e-mail)

Name Area Email
William Siegrist infrastructure wms
Ernest Prabhakar gui drernie
James Berry mpwa, dependencies jberry
Juan Manuel Palacios logging, binaries, MacPorts port, shell environment, documentation and website jmpp
Rainer Mueller python groups, root privilege droppingraimue
Randall Wood MP Port, shell scriptingrhwood

Tasks

This is a list of some potential tasks that student SoC members could undertake. These are just ideas, and while they express our current concerns, we are open to blue-sky projects related to MacPorts. We strongly suggest that you discuss your contribution ideas with potential mentors by e-mail, on the MacPorts development list or the irc channel before applying.

Core Tasks

Task 1: Dependencies

This task consists of implementing a new dependencies engine for MacPorts. The current dependency engine properly deals with installing packages, but it does not deal satisfactorily with dependencies on variants (and versions), uninstalling and upgrading. This very challenging task requires a complete formalization of the use cases (installation, upgrade, uninstallation) and of the user needs before any implementation, as well as a deep understanding of the dependency relations (required for fetching, building, configuring; static and dynamic linking; dependence at runtime).

Classification: very challenging task
Programming languages: Tcl and C
Potential mentors: jberry

Task 2: Python Group

Improve Python group code.
We currently have a lot of Python modules, which are built for Python 2.4. We now need a system to re-use port information about one python port to create Ports for Python 2.4 AND Python 2.5 (and also for the upcoming 2.6 and 3.0 release). This though has to be made modular, so we can just re-use the description, etc. (if different versions of one module are required for different Python versions) or just re-use the whole information (checksums, etc.). This system will be interesting for other kind of subsystems, too, where different interpreters/virtual machines/compilers should be used.

Classification: medium task
Programming languages: Tcl
Potential mentor: raimue

Task 3: MacPorts Port

The MacPorts port should be the source for updating a user's MacPorts installation.

Currently the MacPorts port is used to build the .dmg installer for MacPorts that is used for the initial installation of MacPorts, and port uses the "selfupdate" mechanism for maintaining the MacPorts installation. The selfupdate mechanism is (at least not documented as such) not accessible through the MacPorts API and does not use the MacPorts mechanisms for maintaining ports

Classification: challenging task
Programming languages: Tcl and C
Potential mentor: rhwood, jmpp

Task 4: Binaries

MacPorts project does not provide binaries yet (installation of software without compiling them). This project consists in working in concert (or cooperatively) with whomever does (virtual chroot) to setup a mechanism to automatically build packages, send reports on failures and implement a distribution mechanisms to allow users to fetch binary packages. This task could extend to support universal binaries, cross-testing (building on an intel box and testing on a powerpc box) and extending the livecheck mechanism to automatically send reports when ports are updated.

Classification: relatively challenging to challenging task
Programming language: Tcl
Potential mentors: wms, jmpp

Task 5: Graphical user interface

Come up with a front-end for installing packages (or building ports, where no package exists) for naive end-users. See also drernie's post about MacPorts GUIs.

Classification: major task
Programming languages: Tcl and any other language for the GUI part (e.g. ObjC)
Potential mentors: drernie

Task 6: Images (Pkgview, depot-to-depot dependencies)

MacPorts implements what we call the Image mode where software are stored in a depot (e.g. /opt/local/var/db/dports/software/gawk/3.1.5_2/opt/local/bin/gawk). For the moment, this functions like an archive and files are hardlinked to their active location (/opt/local/bin/gawk). If port A depends on dynamic library B.dylib from port B, it actually links to /opt/local/lib/B.dylib. The idea of this task is to figure out a way for port A to be linked to the library in the depot and to work even if port B is not active. That is to say that if port foo depends on version 1.2.3 of port bar, it should be compiled and linked in such a way that it's wired to the depot location of bar, not the "activated" location. That will finally fix the fragility problem where deactivating port bar vers n-1 in order to install port bar vers n (because other things depend on n) won't also require breaking everything that relies on n-1. This mechanism also has additional advantages such as limiting the unavailability time to a minimum, especially when upgrading libraries every other package depends on (such as gettext).

Classification: challenging to very challenging task
Programming language: Tcl
Potential mentor: wms

Task 7: Root privileges

Implement facility to reduce need to execute macports as root, by adding facilities to mark ports as requiring root, by dropping root privileges where possible, and perhaps by keeping repository in per-user space.

Classification: medium task
Programming language: Tcl, C
Potential mentors: raimue

Task 8: Portfiles

Sweep through all Portfiles and look for useful opportunities to add more built-in Tcl functions that make Portfiles more (usefully) terse, powerful, flexible or easier to write. I'm sure there is an entirely family of helper functions yet to be written here.

Classification: medium task
Programming language: Tcl
Potential mentor: wms

Task 9: Mirroring

Implement a mechanism and setup a system to mirror distribution files for MacPorts. This task consists in developing tools to automatically create and update mirror directories and will certainly require some rework of the code that fetches tarballs.

Classification: medium task
Potential mentors: wms

Task 10: Shell Environment

Add support for for providing basic and port-provided environmental services to users in the ~/.profile, ~/.cshrc, and ~/.xinitrc files, so that instead of manipulating the user's .profile to modify certain paths, the installer could append "source /opt/local/etc/bash.rc" to the end of a user's .profile file and that bash.rc would source all the files in /opt/local/etc/bash.d.

Classification: medium task
Potential mentors: rhwood, jmpp

Task 11: Automatic testing

MacPorts project currently includes a test framework to test features of the infrastructure. However, the tests do not cover all the code and they are not executed on an automatic basis. This task consists of extending the test framework and could be broadened to develop a code coverage technology for MacPorts to make the infrastructure more robust to future changes.

Classification: relatively easy to very challenging
Programming languages: Tcl, C
Potential mentor: wms

Task 12: Logging

Currently MacPorts has no notion of logging of build activities of a given port or sets of ports. When a a build is attempted but an error keeps it from completing, there's no way to track the problem other than the build progress that was output to the terminal, if verbose mode was requested in the first place. Otherwise, the build environment has to be pruned and the build attempted once again to even get a look at the precise error message. This is particularly problematic when automated builds are attempted, since there's usually no one around to have a look at the failure spew. An infrastructure to remedy this situation and endow MacPorts with a rich set of logging capabilities has to be developed to open up the door to true automated build runs of large sets of ports and thus to packaging of binaries, since with logging we'd have a fully reliable way of catching, reporting and processing of all sorts of fetch/configure/build/destroot/install/etc errors, possibly through the interaction with a server side application like MPWA that could consume these logs (read below). A more detailed draft of this task can be found on the LoggingProposal page.

Classification: medium task to relatively challenging
Prohramming languages: xml or yaml or html, C, Tcl, PHP or RoR
Potential mentor: jmpp, wms

Task 13: MacPorts Web Application

A very good start has been made on a Web Application for MacPorts to serve as a basis for easier user submission and maintenance of ports, not to mention monitoring of port build status, browsing of ports, etc. This work is known as MPWA and is written in Ruby on Rails. This task is to complete the work on MPWA so that it is usable for day to day usage by the MacPorts community. Work is needed on user credentials and authentication, port dependency integration, port submission and tracking, etc. This is a very exciting project and can help MacPorts scale to support a larger community.

Read more about the MPWA design and model.

Classification: moderate, with good follow through vision, and architecture required
Programming languages: Ruby, perhaps a bit of Tcl
Potential mentor: jberry

Additional tasks

Task A1: Ports

  • Porting of additional packages to MacPorts
  • Cleanup and/or remove obsolete ports

Classification: medium task
Potential mentors: wms

Task A2: Documentation and Website

  • Improve MacPorts documentation
  • Improve MacPorts website
  • Custom Trac plugins

Classification: minor task
Programming languages: php, python
Potential mentors: wms, jmpp