OpenSlides/DEVELOPMENT.md

Development of OpenSlides 4

Requirements

You need git, bash, docker, docker-compose, make and openssl installed.

Go is needed to install https://github.com/FiloSottile/mkcert (but Go is not a requirement to start the development server). The development setup uses HTTPS per default. OpenSlides does not work with HTTP anymore since features are required (like http2) that only works in a secure environment.

Before starting the development

Clone this repository:

$ git clone --recurse-submodules git@github.com:OpenSlides/OpenSlides.git

After cloning you need to initialize all submodules:

$ git submodule update --init

Finally, start the development server:

$ make run-dev

(This command won't run without sudo, or without having set up Docker to run without sudo - see their documentation)

You can access the services independently using their corresponding ports or access the full stack on

$ https://localhost:8000

Running tests

To run all tests of all services, execute run-service-tests. TODO: Systemtests in this repo.

Adding a new Service

$ git submodule add <git@myrepo.git>

Append branch = main to the new entry in the .gitmodules file. Verify, that it is there (the folder should have 160000 permissions: Submodule) with the current commit:

$ git diff --cached

Then, commit changes and create a pull request.

Work in submodules

Create your own fork at github.

Remove the upstream repo as the origin in the submodule:

$ cd <submodule>
$ git remote remove origin

Add your fork and the main repo as origin and upstream

$ git remote add origin `<your fork>`
$ git remote add upstream `<main repo>`
$ git fetch --all
$ git checkout origin main

You can verify that your setup is correct using

$ git remote -v

The output should be similar to

origin    git@github.com:<GithubUsername>/OpenSlides.git (fetch)
origin	  git@github.com:<GithubUsername>/OpenSlides.git (push)
upstream  git@github.com:OpenSlides/OpenSlides.git (fetch)
upstream  git@github.com:OpenSlides/OpenSlides.git (push)

Requirements for services

Environment variables

These environment variables are available:

• <SERVICE>_HOST: The host from a required service
• <SERVICE>_PORT: The port from a required service

Required services can be MESSAGE_BUS, DATASTORE_WRITER, PERMISSION, AUTOUPDATE, etc. For private services (e.g. a database dedicated to exactly one service), use the following syntax: <SERVICE>_<PRIV_SERVICE>_<ATTRIBUTE>, e.g. the Postgresql user for the datastore: DATASTORE_POSTGRESQL_USER.

Makefile

A makefile must be provided at the root-level of the service. The currently required (phony) targets are:

• run-tests: Execute all tests from the submodule
• build-dev: Build an image with the tag openslides-<service>-dev

Build arguments in the Dockerfile

These build arguments should be supported by every service:

• REPOSITORY_URL: The git-url for the repository to use
• GIT_CHECKOUT: A branch/tag/commit to check out during the build

Note that meaningful defaults should be provided in the Dockerfile.

Developing on a single service

Go to the serivce and create a new branch (from main):

$ cd my-service
$ git status  # -> on main?
$ git checkout -b my-feature

Run OpenSlides in development mode (e.g. in a new terminal):

$ make run-dev

After making some changes in my-service, create a commit and push to your fork

$ git add -A
$ git commit -m "A meaningful commit message here"
$ git push origin -u my-feature

As the last step, you can create a PR on Github. After merging, these steps are required to be executed in the main repo:

$ cd my-service
$ git pull upstream main
$ cd ..
$ git diff  # -> commit hash changed for my-service

If the update commit should be a PR:

$ git checkout -b updated-my-service
$ git commit -am "Updated my-service"
$ git push origin updated-my-service

Or a direct push on main:

$ git commit -am "Updated my-service"
$ git push origin main

Working with Submodules

After working in many services with different branches, this command checks out main (or the given branch in the .gitmodules) in all submodules and pulls main from upstream (This requres to have upstreamset up as a remote in all submodules):

$ git submodule foreach -q --recursive 'git checkout $(git config -f $toplevel/.gitmodules submodule.$name.branch || echo main); git pull upstream $(git config -f $toplevel/.gitmodules submodule.$name.branch || echo main)'

This command has can also be called from the makefile using:

$ make services-to-main

When changing the branch in the main repo (this one), the submodules do not automatically gets changed. THis ocmmand checks out all submodules to the given commits in the main repo:

$ git submodule update