From 4c7fcec0e3a1c56e9b70a63cf553ba22a414a80b Mon Sep 17 00:00:00 2001 From: b0undl3ss <55514816+b0undl3ss@users.noreply.github.com> Date: Thu, 4 Nov 2021 12:25:17 -0700 Subject: [PATCH] docs: add testing info to readme (#301) * refactor: Upgrade to Gorm 2.0 * Clean up dependencies * Fix linting errors Remove gorm v1 delete callback * Resolve unittest failures * Fix association query * Add testing section to readme Co-authored-by: Jordan Craven --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index fae2771..6309e9f 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,7 @@ Features include: independence of users and hosts, convenient user invite system - [portal alias (.ssh/config)](#portal-alias-sshconfig) - [Scaling](#scaling) - [Under the hood](#under-the-hood) +- [Testing](#testing) @@ -472,6 +473,26 @@ See [examples/mysql](http://github.com/moul/sshportal/tree/master/examples/mysql ![sshportal data model](https://raw.github.com/moul/sshportal/master/.assets/sql-schema.png) +--- + +## Testing + +[Install golangci-lint](https://golangci-lint.run/usage/install/#local-installation) and run this in project root: +``` +golangci-lint run +``` +--- +Perform integration tests +``` +make integration +``` +--- +Perform unit tests +``` +make unittest +``` +--- + ## Contributors ### Code Contributors