open-im-server/docs/contrib/development.md

Development Guide

Since OpenIM is written in Go, it is fair to assume that the Go tools are all one needs to contribute to this project. Unfortunately, there is a point where this no longer holds true when required to test or build local changes. This document elaborates on the required tooling for OpenIM development.

• Development Guide
  • Non-Linux environment prerequisites
    • Windows Setup
    • macOS Setup
  • Installing Required Software
    • Go
    • Docker
    • Vagrant
  • Dependency management

Non-Linux environment prerequisites

All the test and build scripts within this repository were created to be run on GNU Linux development environments. Due to this, it is suggested to use the virtual machine defined on this repository's Vagrantfile to use them.

Either way, if one still wants to build and test OpenIM on non-Linux environments, specific setups are to be followed.

Windows Setup

To build OpenIM on Windows is only possible for versions that support Windows Subsystem for Linux (WSL). If the development environment in question has Windows 10, Version 2004, Build 19041 or higher, follow these instructions to install WSL2; otherwise, use a Linux Virtual machine instead.

macOS Setup

The shell scripts in charge of the build and test processes rely on GNU utils (i.e. sed), which slightly differ on macOS, meaning that one must make some adjustments before using them.

First, install the GNU utils:

brew install coreutils findutils gawk gnu-sed gnu-tar grep make

Then update the shell init script (i.e. .bashrc) to prepend the GNU Utils to the $PATH variable

GNUBINS="$(find /usr/local/opt -type d -follow -name gnubin -print)"

for bindir in ${GNUBINS[@]}; do
  PATH=$bindir:$PATH
done

export PATH

Installing Required Software

Go

It is well known that OpenIM is written in Go. Please follow the Go Getting Started guide to install and set up the Go tools used to compile and run the test batteries.

OpenIM	requires Go
2.24 - 3.00	1.15 +
3.30 +	1.18 +

Docker

OpenIM build and test processes development require Docker to run certain steps. Follow the Docker website instructions to install Docker in the development environment.

Vagrant

As described in the Testing documentation, all the smoke tests are run in virtual machines managed by Vagrant. To install Vagrant in the development environment, follow the instructions from the Hashicorp website, alongside any of the following hypervisors:

• VirtualBox
• libvirt and the vagrant-libvirt plugin

Dependency management

OpenIM uses go modules to manage dependencies.