Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Google Summer of Code 2022 Ideas
Please see our main Google Summer of Code page for participation information.
This year, projects should take ~175 hours or ~350 hours for GSoC contributors to complete.
Each project on the Ideas list should include:
- a project title/description
- more detailed description of the project (2-5 sentences)
- expected outcomes
- skills required/preferred
- possible mentors
- expected size of project (175 or 350 hour).
- And if possible, an easy, medium or hard rating of each project.
Contents
- 1 Project ideas
- 1.1 Example Project idea
- 1.2 Eclipse Ditto™ – Cloud Events mappings
- 1.3 Eclipse JKube™: Improve JKube user experience
- 1.4 Eclipse JKube™: Migrate To Mockito for mocking tests
- 1.5 Eclipse JKube™: Migrate To JUnit5 Testing Framework from JUnit4
- 1.6 Eclipse Kuksa™: Device Twin for Vehicle Signal Specification (VSS) automotive data
- 1.7 Eclipse SWTChart™ (Radar/Spider Chart Support)
- 1.8 Eclipse SWTChart™ (Export Options)
- 1.9 Eclipse 4diac™ (Domain-specific modelling environment)
- 1.10 Eclipse Vert.x™: JSONRPC as wire protocol for the eventbus TCP bridge
- 1.11 Eclipse Vert.x™: Implement Security audit logging for Vert.x Web
- 1.12 Eclipse Sirius Web: Contribute Card Board representation
- 1.13 Eclipse Cargo Tracker: Improvements and Updates
Project ideas
Example Project idea
Description of the Example Project idea with links to more information, bugs, and other useful content. This could include a list of specific objectives
Expected outcomes list of the results expected to be achieved after completing of the project.
Skills required/preferred list of skill set required to be able to complete the project in the proposed time.
Project size 175/350 hours
Possible mentors: Somebody Mentor
Rating Easy, medium or hard rating of each project.
Eclipse Ditto™ – Cloud Events mappings
Description Eclipse Ditto is a digital twin project and can consume events for device updates from several messaging solutions (MQTT, Kafka). As Ditto needs to understand the payload, it provides a data model, which defines how data is represented inside Ditto. However, it needs to interface with existing systems, which do not follow the Ditto data model or encoding of that. Kafka (or MQTT) on the other hand can transport any kind of payload.
Cloud Events are a definition of some common properties of events, like payload and header, which maps to multiple event drive technologies (like Kafka, MQTT, HTTP/WS, AMQP, …). So a "cloud event" can be represented in all of those technologies, still allowing to transport any kind of payload.
This proposal is to bring Cloud Events to Ditto. There currently already exists a Cloud Events HTTP endpoint, which can passively accept Cloud Events. However, Ditto supports "connections", which are more active and implemented in a different way. These connections (might be Kafka, MQTT, …) either require the payload to be in the Ditto format, or allowing hooking in default/custom payload/event mapping logic to translate events into the Ditto format. Same for outbound messages, these can be mapped from Ditto into something that is understood be an external system.
So what is required to complete this project:
- Create an out-of-the-box inbound and outbound mapper, which translates Ditto events into Cloud Events (and back)
- Provide a way to use e.g. the "Normalize" step as part of that mapping
This includes:
- Defining a mapping specification
- Creating an implementation
- Creating unit-tests
- Updating the documentation
Expected outcomes an event mapper for Ditto Events to/from Cloud Events including a mapping specification, an implementation, unit tests, and documentation.
Skills required/preferred Java, Cloud Events, Maven
Project size 175 hours
Possible mentors: Jens Reimann
Rating Easy
Eclipse JKube™: Improve JKube user experience
Description Eclipse JKube™ is a collection of plugins and libraries that are used for building container images using Docker, JIB or S2I build strategies. Eclipse JKube generates and deploys Kubernetes/OpenShift manifests at compile time too.
This project focuses on providing compile-time plugins and libraries for the Java ecosystem for:
- Building container images
- Creating Kubernetes and OpenShift resource descriptors
- Deploying resources descriptors
The goal of this proposal is to improve the user experience of JKube for a better adoption. Basically to work on the issues with the label ‘UX’ https://github.com/eclipse/jkube/labels/UX . Students could also propose issues that would help JKube to be well/better adopted.
Expected outcomes are of course contributions in terms of code. But it could also involve the website or the documentation or videos.
Skills required/preferred.
- Basic knowledge of Kubernetes
- Good knowledge of Java
Project size 350
Possible mentors: Sun Tan (CET/CEST), Marc Nuri (CET/CEST)
Rating medium
Eclipse JKube™: Migrate To Mockito for mocking tests
Description Eclipse JKube™ is a collection of plugins and libraries that are used for building container images using Docker, JIB or S2I build strategies. Eclipse JKube generates and deploys Kubernetes/OpenShift manifests at compile time too.
This project focuses on providing compile-time plugins and libraries for the Java ecosystem for:
- Building container images
- Creating Kubernetes and OpenShift resource descriptors
- Deploying resources descriptors
The goal of this proposal is to migrate our current test mocking framework to Mockito instead of JMockit https://github.com/eclipse/jkube/issues/857
Currently all unit tests in Eclipse JKube repository are using JMockit for mocking objects. JMockit is good but Mockito provided a cleaner and simpler API to allow developers to mock objects. It also seems to be more popular and up to date framework.
While building gradle plugins, the Eclipse JKube team started writing tests using Mockito. Other modules, namely all submodules of jkube-kit, kubernetes-maven-plugin and openshift-maven-plugin tests, need to be migrated to use Mockito instead of JMockit.
Expected outcomes are of course contributions in terms of code.
Skills required/preferred. Basic knowledge of Java is required.
Project size 350
Possible mentors: Marc Nuri (CET/CEST), Rohan Kumar (IST)
Rating easy
Eclipse JKube™: Migrate To JUnit5 Testing Framework from JUnit4
Description Eclipse JKube™ is a collection of plugins and libraries that are used for building container images using Docker, JIB or S2I build strategies. Eclipse JKube generates and deploys Kubernetes/OpenShift manifests at compile time too.
This project focuses on providing compile-time plugins and libraries for the Java ecosystem for:
- Building container images
- Creating Kubernetes and OpenShift resource descriptors
- Deploying resources descriptors
The goal of this proposal is to migrate our current testing framework to JUnit 5 . It is currently using JUnit 4 . It would be nice to upgrade to JUnit5 in order to use new features like precise exception handling, display names, annotations etc.
For better understanding, more detailed information can be found in the JUnit5 Migrating from JUnit4 Guide. This needs to be done for every unit test of the Eclipse JKube repository.
Expected outcomes are of course contributions in terms of code.
Skills required/preferred. Basic knowledge of Java is required.
Project size 350
Possible mentors: Marc Nuri (CET/CEST), Rohan Kumar (IST)
Rating easy
Eclipse Kuksa™: Device Twin for Vehicle Signal Specification (VSS) automotive data
Description: Eclipse Kuksa provides building blocks for connected-car ecosystems responding to increasing demand for software and data-driven services in and around cars. As part of the Eclipse Kuksa project, Kuksa.val delivers an implementation of the W3C VSS [1] specification, which defines the structure and the access to signals and data in a vehicle.
Many applications hosted in a cloud backend face similar challenges of how to retrieve and transport vehicle data to the cloud. IoT scenarios often solve these challenges through an instance of a device twin acting as a digital representation of the actual thing. One implementation for such device twins is Eclipse Ditto. Having unified device twins for vehicles allows faster development of portable applications and improves the overall developer experience for working with VSS.
[1] https://covesa.github.io/vehicle_signal_specification/
Expected outcomes: Expected outcomes: At the end of the project, we envision to add deployment scripts, a service implementation, and a running example available, for the realization of a digital twin based on the VSS implementation of Eclipse Kuksa. Preferably - Kuksa.cloud has new services in its deployment scripts, which provides a device twin which could for example be on an instance of Eclipse Ditto - Kuksa.val has a new adapter that allows to send data from Kuksa.val to a device twin instance in the cloud
Skills required/preferred: Students should be able to program in the Java programming language, have a good understanding of cloud architectures and service deployments based on Kubernetes and Helm. Understanding Python code helps to understand the VSS implementation.
Project size: 350 hours
Possible mentors: Johannes Kristan, Sebastian Schildt, Sven Erik Jeroschewski
Rating: Medium
Eclipse SWTChart™ (Radar/Spider Chart Support)
Description Eclipse SWTChart provides the means to create rich, flexible and interactive data visualizations natively in SWT. This project will add support to easily create radar and spider charts in SWTChart. Other chart types like Pie-, Doughnut-, Line-, Scatter- or Barplots are supported out-of-the-box already.
Expected outcomes: A specific type for radar and spider charts as well as an example section how to use them must be available after finishing the project successfully.
Skills required/preferred: Java, SWT, Eclipse, RCP, OSGi
Project size: 350 hours
Possible mentors: Philip Wenig
Rating: Medium
Eclipse SWTChart™ (Export Options)
Description Eclipse SWTChart provides the means to create rich, flexible and interactive data visualizations natively in SWT. This project will improve the existing export options in SWTChart, especially the SVG template export.
Expected outcomes: More export types shall be supported like Pie- and Doughnutplots. Additional options shall be added to export labels.
Skills required/preferred: Java, SWT, Eclipse, RCP, OSGi
Project size: 350 hours
Possible mentors: Philip Wenig
Rating: Easy
Eclipse 4diac™ (Domain-specific modelling environment)
Description The Eclipse 4diac project provides an open source infrastructure for distributed Industrial Process Measurement and Control Systems (IPMCS) based on the IEC 61499 standard. This project will add user interface for testing software components (so-called Function Blocks) based on behavior models. Currently, the tool environment has limited tool support for (semi-)automated testing of Function Blocks. A framework for the test execution is however available.
Expected outcomes: A user interface for generating tests based on behavior models and executing them must be available (including documentation). It should be furthermore possible to record new scenarios, which can be later used as test cases.
Skills required/preferred: Programming skills required, preferably one or more of the following technologies: Java, SWT, Eclipse, RCP
Project size: 175 or 350 hours (scope can be adjusted)
Possible mentors: Alois Zoitl Bianca Wiesmayr
Rating: Medium
Eclipse Vert.x™: JSONRPC as wire protocol for the eventbus TCP bridge
Description: Eclipse Vert.x offers a message-driven programming model based on an event bus that allows applications to scale to multiple processes or nodes without requiring code changes or knowledge during development. The event bus can be extended to non-native vert.x applications, including other platforms such as nodejs, python, etc... At the moment, the wire format of the messages in this event bus bridge is vert.x specific. To make the bridge more accessible to everyone, a more popular format should be added. We would like to see JSON-RPC as a wire format, as the current format is JSON based. This would keep the project scope small and not require many changes for clients to adapt.
Expected outcomes: At the end of the project we should have simple communication with the existing bridge using a client of choice of the student using JSON-RPC showcasing the communication modes:
- send and forget
- request-response
- push
Skills required/preferred: Students should be fluent in Java programming language and have some basic knowledge on another language of choice to test the client.
Having some experience with asynchronous programming is highly recommended, to understand the vert.x code base.
Project size: 350 hours
Possible mentor: Paulo Lopes
Rating: Medium/Hard.
Eclipse Vert.x™: Implement Security audit logging for Vert.x Web
Description: Eclipse Vert.x Web is a small library to build modern web applications with vert.x. Although vert.x web already supports many security handlers, there is no easy way to create an audit authentication logging trail. This project is to create a simple logging audit trail handler, that captures all the authentication related events and logs then to a specific logger.
Expected outcomes: At the end of the project, a handler, tests and documentation should be delivered. One of the goals is to keep the handler agnostic to the backend logger, so the documentation should include examples on how to use common logging frameworks, either local or remote. Remote examples are required to showcase non repudiation.
Skills required/preferred: Students should have a good understanding of Java programming language and be able to learn or experiment with logging frameworks like logback or log4j.
Project size: 175/350 hours The scope can be adjusted to reflect the desired length.
Possible mentor: Paulo Lopes
Rating: Easy/Medium.
Eclipse Sirius Web: Contribute Card Board representation
Description: Eclipse Sirius Web is a framework to build modern modeling studios to the web. Sirius Web provides today two different kind of representations: diagrams and forms. This project is to contribute a new "Card Board representation" like Trello/Focalboard/Github Projects.
Expected outcomes: At the end of the project, it will be possible for the studio maker to define directly from the web a new Card Board description and for the studio user to get a card+column representation with support of add/delete column and cards, reorder column, reorder cards, D&D cards between columns, edit card details in a properties view.
Skills required/preferred: Java, Spring Boot, React, JS.
Project size: 175/350 hours The scope can be adjusted to reflect the desired length.
Possible mentor: Mélanie Bats Pierre Charles David
Rating: Medium.
Eclipse Cargo Tracker: Improvements and Updates
Description Description The Eclipse Cargo Tracker project demonstrates how you can develop applications with Jakarta EE using widely adopted architectural best practices like Domain-Driven Design (DDD). It is a realistic, non-trivial Jakarta EE sample application. The project is a key part of the EE4J/Jakarta EE umbrella at the Eclipse Foundation. The project is mature but needs a number of important enhancements ranging from improving look/feel, upgrading to Jakarta EE 10/Payara 6/Java SE 11, adding more JUnit tests, adding JMeter tests, adding support for more IDEs such as VS Code/IntelliJ and supporting more runtimes such as GlassFish/Open Liberty/WildFly. Here is a complete list of issues where contribution is needed: https://github.com/eclipse-ee4j/cargotracker/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22. The Eclipse Cargo Tracker website is here: https://eclipse-ee4j.github.io/cargotracker/.
Expected outcomes The contributor(s) will successfully merge the enhancement(s) they elect to work on into the main branch of the project and close the corresponding issues. Their work will be included in a subsequent Eclipse Cargo Tracker release. They will be recognized as a project contributor and possibly a qualified committer.
Skills required/preferred Java, Jakarta EE, JUnit, JMeter, HTML, CSS, JavaScript
Project size 175/350 hours
Possible mentors: Reza Rahman (Reza.Rahman@microsoft.com)
Rating There are easy, medium and hard tasks in the project.