wiki:SummerOfCode

Google Summer of Code 2019

This is the MacPorts Project’s page for Google Summer of Code.

Information about the past years can be found at SummerOfCodeArchive.

Applications for GSoC

Students will be able to apply from 25 March until 9 April 18:00 UTC.

If you're interested in working with MacPorts for Google Summer of Code 2019, you don't have to wait until the application period for students starts. Introduce yourself on the macports-dev mailing list today or drop by in IRC by joining #macports on Freenode. See Ways to Contact Us for more information.

General info

For future reference, you may check the Google Summer of Code website. The GSoC Student Guide is also worth reading and explains what GSoC is about and how it works in detail. We suggest you take a few minutes and read this guide. See also So You Want to Be a Google Summer of Code Student? video.

For the official schedule and deadlines, consult the timeline.

Proposal Guidelines

Submit your proposal early: early submissions get more attention from developers for the simple fact that they have more time to dedicate to reading them. The more people see it, the more it'll get known.

Do not leave it all to the last minute: Make sure you send your application before the final rush. Also, note that the applications submitted very late will get the least attention from mentors, so you may get a low vote because of that.

Keep it simple: we don't need a 30-page essay on the project and on you. You just need to be concise and precise.

Know what you are talking about: the last thing we need is for students to submit ideas that cannot be accomplished realistically or ideas that aren't even remotely related to MacPorts or the project. If your idea is unusual, be sure to explain why you have chosen MacPorts as the best place for the project.

About Us

We are eager to support and mentor students who want to gain 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. If you have an idea of your own, feel free to contact us to discuss it.

MacPorts is written in the Tcl scripting language with some low-level parts implemented in C. Most students that have previously applied and successfully completed Google Summer of Code with us did not know Tcl when they applied. Feel free to apply if you don't know Tcl yet, especially if you're willing to learn and already know several scripting 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 mailing list, to potential mentors listed below, or to IRC member on #macports on Freenode. See also Ways to Contact Us for in-depth information on how to reach us.

What we expect from students for their applications

  • Write your own abstract and proposal, copying text from this idea page is not enough.
  • Show us that you fully understand your task and know what you want to do over the summer.
  • At best, include a short weekly roadmap covering how you would work on the task.
  • Please use our application template.

What you should do before handing in an application

Get in contact! Most important is to discuss your ideas with potential mentors via private email, the MacPorts development list, or the IRC channel before applying.

Students

For the students and projects in the previous editions of GSoC with MacPorts, see SummerOfCodeArchive.

Projects

This is a list of some potential tasks that student GSoC members could undertake. These are just ideas, and while they express our current concerns, we are open to blue-sky projects related to MacPorts.

Please note that this list is absolutely not exclusive! If you have any idea about what you want to see improved in MacPorts, you are free to propose this as your own project. In any case, we recommend you talk to mentors before writing your application.

Ideas mainly fall into one of the following categories:

macports_base
You would be expected to extend and improve functionality of the core of the package manager, mainly written Tcl (and C). It's OK if you have no prior experience with Tcl though. See below for various ideas.
ports
With tens of thousands of available ports probably overlapping with your daily needs of software. Portfiles are written in simple declarative Tcl, but you would probably spend more time figuring out how to (better) package the software which might be written in almost any programming language. A knowledge and passion of any language like C++, Perl, Ruby, Python, Rust, Go, Haskell, JavaScript, ... or technology like Qt, KDE, ... could greatly improve support of certain software in our ecosystem.
infrastructure
Several independent projects to support development of MacPorts could be undertaken in any language of your choice (gravitating towards python & web), like writing a Django app in Python, improving frontend or backend of Buildbot continuous integration (JavaScript or Python), implementing a way to fire up virtual machines with macOS for continuous integration builds, ...

Ideas

Update Orphaned Ports

Several of the current MacPorts developers originally became interested in the project because they wanted to improve the software that MacPorts installs. Fixing and/or updating ports is an excellent introduction to the MacPorts systems (phases, variants, PortGroups, etc.). It forces you to read the documentation and examine commit histories. This does not have to be an entire GSOC project, but it could be used as part of the application process and/or a supplement to the main project. Most version increases in a port require only minor changes. A small number of updates, such as to the Glasgow Haskell Compiler, would be much more of a challenge.

  • Difficulty: Easy to Hard
  • Languages: Tcl, language of the port
  • Potential mentors: mcalhoun

Managing and Fixing Qt Versions

Fix issues in open tickets for Qt 3, Qt 4, and Qt 5, in particular allowing for concurrent installation of the various Qt versions. There are around 50 outstanding tickets for the various Qt versions. Some involve patching and testing on multiple OSs. Some are probably invalid but need to be tested to determine validity. The end goal for this project is to allowing for concurrent installation of the various Qt versions, and then verifying and resolving as many issues as possible that weren't resolved by the concurrent changes. Requires knowledge of Portfile programming (Tcl), Qt programming (primarily C++), and Qt makefile programming (QMake); other programming knowledge that would be useful include shell (e.g., bash) and C.

  • Difficulty: Medium to Hard
  • Languages: Tcl, C++, QMake
  • Potential mentors: mcalhoun, michaelld

Make Blacklisting MacPorts Compilers Easier

Not all compilers work with all ports. For example, a port may require C++11, which is not supported by GCC 4.2, which is the default compilers on older macOS systems. MacPorts has a mechanism to blacklist compilers that do not meet the port's requirements. Currently, blacklisting a range of compilers is very easy (e.g. compiler.blacklist {clang < 500} ensures that the Clang compiler supports C++11). However, this only works for compilers provided by Xcode. Ports can also use compilers provided by MacPorts. It would be nice, for example, to be able to have something like compiler.blacklist {macports-clang < 6.0}.

  • Difficulty: Easy to Medium
  • Languages: Tcl
  • Potential mentors: mcalhoun

Add Support for x86_64h Architecture

The system compilers have supported, at various times, x86_64, i386, ppc, and ppc64 as valid architectures. MacPorts has support for all four. Relatively recently, system compiler started supporting the x86_64h architecture, which is a lot like x86_64, except it allows compiler to take advantage of the Haswell microarchitecture. Adding the architecture support itself would be straightforward. However, it is not clear what, if any, performance improvement this could bring. Also, unlike other architectures in MacPorts, x86_64h and x86_64 libraries can be linked together.

  • Difficulty: Medium
  • Languages: Tcl
  • Potential mentors: mcalhoun

Allow for Multiple Runs of Each Phase

There are times when it is convenient to run configure/build/destroot more than once. For example:

  • cargo depends on the port cargo-stage1, whose only purpose is to help build cargo. Instead, one could run configure/build and use the resulting binary without installing another port.
  • fluidsynth depends on a subproject, which has no use beyond aiding the build process. The subproject does not inherit the MacPorts settings. It would be nice to configure/build the subproject properly (from a MacPorts point of view).
  • 75% of the muniversal PortGroup is to get multiple runs of the configure/build/destroot phases.
  • Difficulty: Difficult
  • Languages: Tcl
  • Potential mentors: mcalhoun

Allow a Variant to More Elegantly Become “undefaulted”

A port can be installed with different variants. A variant is used if requested by a user or if the variant is declared default. If the default designation is removed, new installations will not use it, but it will continue to be used by the users who upgrade from a port version when it was still the default. It would be useful to have a way to perpetuate a previously default variant only if the user specifically requested it.

  • Difficulty: Medium
  • Languages: Tcl
  • Potential mentors: mcalhoun

Prevent port reclaim from Removing Build Dependencies

port reclaim attempts to keep only ports requested by the user or required by them. Currently, this means uninstalling ports used to build the port. There is interest in modifying this behavior.

  • Difficulty: Medium
  • Languages: Tcl
  • Potential mentors: mcalhoun

Give Portfile Better Access to CFLAGS, CXXFLAGS, etc.

Currently, the environmental variables CFLAGS, CXXFLAGS, and the like are set late in the process (arch flags added, -pipe added, etc.). Of course, there are good reasons for this. Unfortunately, this means that there is no Portfile access to these values. This causes some ugly workarounds such as duplication of code from the base or configure.cmd printenv and configure.post_args {>> Makefile.macports.inc}. Giving Portfile at least the option of accessing these values could help clean up Portfile code.

  • Difficulty: Medium
  • Languages: Tcl
  • Potential mentors: mcalhoun

Simplify Compilers and MPI PortGroups with Recent Base Changes

Recently, significant changes were made in the base code concerning default compiler selection. As a result, the PortGroups that aid in user defined compiler selection can be simplified.

  • Difficulty: Easy to Medium
  • Languages: Tcl
  • Potential mentors: mcalhoun

Phase out dependency on Xcode

MacPorts currently requires a full Xcode installation, even though a lot of ports will install just fine with the Command Line Tools package only. Since we also have a number of ports that need Xcode to build, we cannot completely remove the Xcode dependency. Your task would be to provide a way for maintainers to easily identify ports that depend on Xcode and mark them as such, so MacPorts can warn users without Xcode installed that a port they want to install needs the full Xcode package.

To achieve this, you can modify "trace mode", a DYLD_INSERT_LIBRARIES-based sandbox to track whether a port has accessed files belonging to the Xcode package. If it does, your modifications should cause a warning to be printed suggesting the port maintainers to add use_xcode yes to the Portfile (unless of course, it is already there). You should also implement an error message if a user without Xcode installed tries to install a port that has use_xcode yes set.

  • Difficulty: Medium
  • Languages: Tcl, C
  • Potential mentors: mcalhoun, cal

Announcements distributed over the ports tree

Some announcements about configuration changes could be presented to users when they update their ports tree. That involves a mechanism to add news items to the ports tree and a new port news command that allows the user to read them (and also mark them as read). Each news items could define conditions when they should be shown to the user, for example depending on OS version or if a specific port is installed. It will need a new API in macports1.0 to check for unread items, so the port client can poll it, for example when using a port news command. Additionally, these news items should also be available on the web.

As an example, there is a similar feature in Gentoo Portage. You can refer to these emails as well - March 21 and March 24, 2018.

  • Difficulty: Easy
  • Languages: Tcl, HTML
  • Potential mentors: g5pw, raimue

Collect build statistics

Go through the history of builds and collect per-port statistics & success matrix:

  • whether the current version of port built on each particular OS/arch
  • when was the last time the port built on that OS/arch
  • links to all builds
  • list of installed files, differences in installed files on different OS versions
  • perhaps include some basic functionality to allow checking for build reproducibility
  • what is the latest version of port (in case it's already outdated), ...

It would be nice to get a decent website for each port to get a quick overview of the port status & health across different OSes. (Part of statistics collection could also be implemented as an extension to Buildbot or Buildbot setup.)

The project has had a previous attempt by a previous student, the details of which can be found here: https://github.com/macports/macports-webapp. You'll find a lot of documentation in docs/ directory to serve as an initial idea but it's open to suggestions for any or complete change.

  • Difficulty: Easy to medium
  • Languages: JSON, HTML, Python or any scripting language
  • Potential mentors: mojca, umeshksingla

Improve startupitem code

MacPorts has the ability to automatically generate startup items for the current platform. For OS X, these are plist files for launchd which will be installed as /Library/LaunchDaemons/org.macports.*.plist. The current code would need a little care and could make use of options which have been added in recent releases of launchd.

Features that could be useful include (but are not limited to):

  • Not using daemondo if the daemon works fine under launchd without it
  • Ability to install multiple plists
  • Support for LaunchAgents as well as LaunchDaemons
  • Installing plists in ~/Library for non-root installs if the user wants
  • only modify specific XML tags to avoid clobbering additions by user
  • Support startupitems in standalone binary packages (currently a brutal hack is used to include daemondo in such packages, see #43648)

It would be great to write some shorthand in a portfile that builds an XML launchd plist.

  • Difficulty: Easy
  • Languages: Tcl, C
  • Potential mentors: larryv, pixilla

Implement fakeroot functionality

Currently, MacPorts uses root privileges in the destroot phase. That should be replaced by a system that runs as the macports user but intercepts all operations that would require root privileges (chown/chmod/etc.) and record the resulting permissions in a database.

The existing functionality of trace mode in darwintracelib1.0 could be leveraged for this task.

  • Difficulty: Medium
  • Languages: Tcl, C
  • Potential mentors: jeremyhu

Generating Portfiles

There are multiple tasks related to the generation of Portfiles (see below). Some of these may not be enough work for a full summer project, so they could be combined while writing proposals freely when the applying student wants to.

i. Perl modules integration from CPAN

There has been an attempt to write a script for automatic generation of Portfiles from CPAN. This would simplify the maintenance of Perl modules in MacPorts. Revive this project and finish the script or rewrite it.

Resources:

  • Difficulty: Easy to medium
  • Languages: Perl, probably Tcl
  • Potential mentors: pixilla
ii. Read packages from various package managers

As with the cpan2port proposal above, and with the previous pypi2port GSoC entry, except with other various package managers, such as opam for ocaml packages, cabal for Haskell, luarocks for Lua, npm for node.js, and so on.

  • Classification: Medium
  • Languages: Tcl, C, OCaml, Haskell, Lua, Node.js, etc.
  • Potential mentors: pixilla

Speed up trace mode

Trace mode is a library preloading-based sandbox used to hide files that a port does not depend on or that are not part of a standard system's installation (such as /usr/local). This can avoid problems due to incompatible user-installed software and avoid "automagic" dependencies and increase the reproducibility of builds.

Unfortunately, enabling trace mode adds a significant performance penalty to the build process. However, the trace mode code can certainly be optimized using appropriate cache data structures, such as a modified Trie. Your task would be to identify the performance bottlenecks, draft appropriate caching data structures and implement them.

  • Difficulty: Medium to Hard
  • Programming languages: Tcl, C
  • Potential mentors: cal

Auto-detection of build dependencies

When creating a new portfile one of the problems is always the specification of the complete (and preferably minimal) list of build dependencies, especially when one starts with a complete install where most dependencies are already available.

It is possible to invert the trace mode logic so that it detects all files a configure and/or build process accesses, in ${prefix} but outside of the port's build directory. This information can then be used to generate a dependency tree and information from the registry can then be used to simplify that tree so that it only lists direct dependencies. Can be combined with the above project. Consult mentor.

  • Difficulty: Medium to Easy
  • Programming languages: Tcl, C
  • Potential mentors: cal

Buildbot ideas

While other projects mostly require access to macOS, frontend javascript and/or python developers are welcome to work in close collaboration with buildbot mentors on any OS.

Implement better views in JavaScript

Buildbot 1.0 lost some advantages of waterfall view from version 0.8, but it supports writing custom views in Javascript. Extend the buildbot core and/or write some views that would make Buildbot 1.0 a lot more useful for MacPorts.

Buildbot is currently written in AngularJS 1.5, but could be extended in other more modern frameworks like vue or react.

More info about how the output could look like: #55978

  • Difficulty: Medium
  • Programming languages: JavaScript, Python, json, HTML, AngularJS, Vue.js, React
  • Potential mentors: from Buildbot community

More Ideas/Hints for your own ideas

Shell environment

Add support 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.

  • Difficulty: Easy
  • Potential mentors: raimue

Bump version and checksum of existing port

Homebrew has brew bump-formula-pr. Such functionality saves a lot of work when updating many ports. Bumping ports using PortGroup like GitHub and bitbucket should also be supported. Existing revision should be reset or removed interactively. A suggested commit message for the update should be shown.

Use cases (pseudo commands):

  • port bump [[portname | pseudo-portname | port-expressions | port-url]] bumps checksums only
  • port bump [[portname | pseudo-portname | port-expressions | port-url]] @<version> bumps version and checksums
  • port bump --livecheck [[portname | pseudo-portname | port-expressions | port-url]] bumps both with livecheck result if ${version} == ${livecheck.version}

See #53851 for more details.

  • Difficulty: Easy
  • Languages: Tcl, C
  • Potential mentors: TBD

MacPorts port for self-management

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

Currently, the MacPorts port is used to build the .pkg 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.

  • Difficulty: Challenging
  • Languages: Tcl, C
  • Potential mentors: TBD

Parallel execution

When an action will run targets on multiple ports, run them in parallel when possible and sensible (requires tracking dependencies between both targets and ports and figuring out the maximum reasonable parallelism, e.g. several ports can fetch at once on a fast connection but you only want one 'make -j8' at a time).

  • Difficulty: Challenging
  • Languages: Tcl, C
  • Potential mentors: TBD

Migrate muniversal into base (lipo merging)

Integrate the muniversal portgroup into base. Not just a direct copy-and-paste, but in a way that makes sense and preserves the way portfiles are expected to behave (which the current portgroup doesn't).

  • Difficulty: Medium
  • Languages: Tcl, C
  • Potential mentors: TBD

App portgoup

Enhance the launching of GUI apps packaged by MacPorts:

  • Fix app icon bouncing on Dock after app launched (#40110)
  • Support multiple apps per port (#41681)
  • Difficulty: Easy
  • Languages: TCL, XML
  • Potential mentors: TBD

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. This might also include porting additional packages to MacPorts and cleaning up or removing obsolete ports.

  • Classification: Medium
  • Language: Tcl
  • Potential mentors: larryv

Documentation and website

Improve MacPorts documentation, website and Trac system. Note that pure documentation proposals are not allowed by Google.

  • Difficulty: Easy to difficult
  • Languages: PHP, Python
  • Potential mentors: larryv

MacPorts statistics

Enhance collection and reporting of inventory of ports installed by participating users: StatisticsIdeas

  • Difficulty: Medium
  • Language: TBD
  • Potential mentors: TBD

Contacting us

There are several ways to contact us:

  • Dropping a mail to the MacPorts-dev mailing list will get you most attention. Note that you have to be subscribed to the list in order to send mail to it. We recommend you create a filter matching the header line List-Id: macports-dev.lists.macports.org and sort all the emails matching this filter into a separate folder. When sending inquiries about Google Summer of Code, we would welcome if you included "GSoC" in the subject of your mail.
  • You can get quick feedback and less formal discussion by joining the #macports channel on the Freenode IRC network. You'll need an IRC client to do so – Colloquy is a popular choice for OS X. Please note that due to timezones and day jobs you might not receive an answer right away. Most users will read your messages when they return and answer as soon as they can. Be prepared to wait a few hours.
  • Feel free to contact any potential mentor via email directly. You can get the email address by appending @macports.org to the handle listed in #Mentors above.

In general, don't hesitate to contact us – we're here to help you and eager to mentor motivated students in this year's GSoC!

Admins

Append @macports.org for email.

Name Email Area
Umesh Singla umeshksingla Administrator
Mojca Miklavec mojca Co-admin
Jackson Isaac ijackson Co-admin

Mentors

The following committers have agreed to be mentors for GSoC 2019 (append @macports.org for email if it is missing)

Name Email Area
Mojca Miklavec mojca Mentor
Marcus Calhoun-Lopez mcalhoun Mentor
Michael Dickens michaelld Mentor
Umesh Singla umeshksingla Mentor
Pierre Tardy tardyp@… Mentor/Buildbot contact
Last modified 4 weeks ago Last modified on May 25, 2019, 10:47:37 AM