Skip to content

DEVELOP.md

Latest commit

 

History

History
90 lines (59 loc) · 1.61 KB

DEVELOP.md

File metadata and controls

90 lines (59 loc) · 1.61 KB

Development

This document explains how to develop Ory Oathkeeper, run tests, and work with the tooling around it.

Upgrading and changelog

New releases might introduce breaking changes. To help you identify and incorporate those changes, we document these changes in UPGRADE.md and CHANGELOG.md.

Command line documentation

To see available commands and flags, run:

oathkeeper -h
# or
oathkeeper help

Contribution guidelines

We encourage all contributions. Before opening a pull request, read the contribution guidelines.

Prerequisites

You need Go 1.16+ and, for the test suites:

  • Docker and Docker Compose
  • make
  • Node.js and npm

You can develop Ory Oathkeeper on Windows, but most guides assume a Unix shell such as bash or zsh.

Install from source

To install Oathkeeper from source:

cd ~
go get -d -u github.com/ory/oathkeeper
cd $GOPATH/src/github.com/ory/oathkeeper
make install

Formatting code

Format all code using:

make format

The continuous integration pipeline checks code formatting.

Running tests

There are three types of tests:

  • Short tests that do not require a SQL database
  • Regular tests that require PostgreSQL, MySQL, and CockroachDB
  • End to end tests that use real databases and a test browser

Short tests

Short tests run quickly and use SQLite.

Run all short tests:

go test -short  ./...

Run short tests in a specific module:

cd internal/check
go test -short  .

Build Docker image

To build a development Docker image:

make docker