Implement Cobra CLI tooling, Viper config tooling (#336)

* start pulling out + replacing urfave and config

* replace many many instances of config

* move more stuff => viper

* properly remove urfave

* move some flags to root command

* add testrig commands to root

* alias config file keys

* start adding cli parsing tests

* reorder viper init

* remove config path alias

* fmt

* change config file keys to non-nested

* we're more or less in business now

* tidy up the common func

* go fmt

* get tests passing again

* add note about the cliparsing tests

* reorganize

* update docs with changes

* structure cmd dir better

* rename + move some files around

* fix dangling comma

cmd/gotosocial/action/action.go

@@ -0,0 +1,28 @@
+/*
+   GoToSocial
+   Copyright (C) 2021 GoToSocial Authors admin@gotosocial.org
+
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU Affero General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU Affero General Public License for more details.
+
+   You should have received a copy of the GNU Affero General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+package action
+
+import (
+	"context"
+)
+
+// GTSAction defines one *action* that can be taken by the gotosocial cli command.
+// This can be either a long-running action (like server start) or something
+// shorter like db init or db inspect.
+type GTSAction func(context.Context) error

cmd/gotosocial/action/admin/account/account.go

@@ -0,0 +1,258 @@
+/*
+   GoToSocial
+   Copyright (C) 2021 GoToSocial Authors admin@gotosocial.org
+
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU Affero General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU Affero General Public License for more details.
+
+   You should have received a copy of the GNU Affero General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+package account
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"time"
+
+	"github.com/spf13/viper"
+	"github.com/superseriousbusiness/gotosocial/cmd/gotosocial/action"
+	"github.com/superseriousbusiness/gotosocial/internal/config"
+	"github.com/superseriousbusiness/gotosocial/internal/db"
+	"github.com/superseriousbusiness/gotosocial/internal/db/bundb"
+	"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
+	"github.com/superseriousbusiness/gotosocial/internal/validate"
+	"golang.org/x/crypto/bcrypt"
+)
+
+// Create creates a new account in the database using the provided flags.
+var Create action.GTSAction = func(ctx context.Context) error {
+	dbConn, err := bundb.NewBunDBService(ctx)
+	if err != nil {
+		return fmt.Errorf("error creating dbservice: %s", err)
+	}
+
+	username := viper.GetString(config.Keys.AdminAccountUsername)
+	if username == "" {
+		return errors.New("no username set")
+	}
+	if err := validate.Username(username); err != nil {
+		return err
+	}
+
+	email := viper.GetString(config.Keys.AdminAccountEmail)
+	if email == "" {
+		return errors.New("no email set")
+	}
+	if err := validate.Email(email); err != nil {
+		return err
+	}
+
+	password := viper.GetString(config.Keys.AdminAccountPassword)
+	if password == "" {
+		return errors.New("no password set")
+	}
+	if err := validate.NewPassword(password); err != nil {
+		return err
+	}
+
+	_, err = dbConn.NewSignup(ctx, username, "", false, email, password, nil, "", "", false, false)
+	if err != nil {
+		return err
+	}
+
+	return dbConn.Stop(ctx)
+}
+
+// Confirm sets a user to Approved, sets Email to the current UnconfirmedEmail value, and sets ConfirmedAt to now.
+var Confirm action.GTSAction = func(ctx context.Context) error {
+	dbConn, err := bundb.NewBunDBService(ctx)
+	if err != nil {
+		return fmt.Errorf("error creating dbservice: %s", err)
+	}
+
+	username := viper.GetString(config.Keys.AdminAccountUsername)
+	if username == "" {
+		return errors.New("no username set")
+	}
+	if err := validate.Username(username); err != nil {
+		return err
+	}
+
+	a, err := dbConn.GetLocalAccountByUsername(ctx, username)
+	if err != nil {
+		return err
+	}
+
+	u := &gtsmodel.User{}
+	if err := dbConn.GetWhere(ctx, []db.Where{{Key: "account_id", Value: a.ID}}, u); err != nil {
+		return err
+	}
+
+	u.Approved = true
+	u.Email = u.UnconfirmedEmail
+	u.ConfirmedAt = time.Now()
+	if err := dbConn.UpdateByPrimaryKey(ctx, u); err != nil {
+		return err
+	}
+
+	return dbConn.Stop(ctx)
+}
+
+// Promote sets a user to admin.
+var Promote action.GTSAction = func(ctx context.Context) error {
+	dbConn, err := bundb.NewBunDBService(ctx)
+	if err != nil {
+		return fmt.Errorf("error creating dbservice: %s", err)
+	}
+
+	username := viper.GetString(config.Keys.AdminAccountUsername)
+	if username == "" {
+		return errors.New("no username set")
+	}
+	if err := validate.Username(username); err != nil {
+		return err
+	}
+
+	a, err := dbConn.GetLocalAccountByUsername(ctx, username)
+	if err != nil {
+		return err
+	}
+
+	u := &gtsmodel.User{}
+	if err := dbConn.GetWhere(ctx, []db.Where{{Key: "account_id", Value: a.ID}}, u); err != nil {
+		return err
+	}
+	u.Admin = true
+	if err := dbConn.UpdateByPrimaryKey(ctx, u); err != nil {
+		return err
+	}
+
+	return dbConn.Stop(ctx)
+}
+
+// Demote sets admin on a user to false.
+var Demote action.GTSAction = func(ctx context.Context) error {
+	dbConn, err := bundb.NewBunDBService(ctx)
+	if err != nil {
+		return fmt.Errorf("error creating dbservice: %s", err)
+	}
+
+	username := viper.GetString(config.Keys.AdminAccountUsername)
+	if username == "" {
+		return errors.New("no username set")
+	}
+	if err := validate.Username(username); err != nil {
+		return err
+	}
+
+	a, err := dbConn.GetLocalAccountByUsername(ctx, username)
+	if err != nil {
+		return err
+	}
+
+	u := &gtsmodel.User{}
+	if err := dbConn.GetWhere(ctx, []db.Where{{Key: "account_id", Value: a.ID}}, u); err != nil {
+		return err
+	}
+	u.Admin = false
+	if err := dbConn.UpdateByPrimaryKey(ctx, u); err != nil {
+		return err
+	}
+
+	return dbConn.Stop(ctx)
+}
+
+// Disable sets Disabled to true on a user.
+var Disable action.GTSAction = func(ctx context.Context) error {
+	dbConn, err := bundb.NewBunDBService(ctx)
+	if err != nil {
+		return fmt.Errorf("error creating dbservice: %s", err)
+	}
+
+	username := viper.GetString(config.Keys.AdminAccountUsername)
+	if username == "" {
+		return errors.New("no username set")
+	}
+	if err := validate.Username(username); err != nil {
+		return err
+	}
+
+	a, err := dbConn.GetLocalAccountByUsername(ctx, username)
+	if err != nil {
+		return err
+	}
+
+	u := &gtsmodel.User{}
+	if err := dbConn.GetWhere(ctx, []db.Where{{Key: "account_id", Value: a.ID}}, u); err != nil {
+		return err
+	}
+	u.Disabled = true
+	if err := dbConn.UpdateByPrimaryKey(ctx, u); err != nil {
+		return err
+	}
+
+	return dbConn.Stop(ctx)
+}
+
+// Suspend suspends the target account, cleanly removing all of its media, followers, following, likes, statuses, etc.
+var Suspend action.GTSAction = func(ctx context.Context) error {
+	// TODO
+	return nil
+}
+
+// Password sets the password of target account.
+var Password action.GTSAction = func(ctx context.Context) error {
+	dbConn, err := bundb.NewBunDBService(ctx)
+	if err != nil {
+		return fmt.Errorf("error creating dbservice: %s", err)
+	}
+
+	username := viper.GetString(config.Keys.AdminAccountUsername)
+	if username == "" {
+		return errors.New("no username set")
+	}
+	if err := validate.Username(username); err != nil {
+		return err
+	}
+
+	password := viper.GetString(config.Keys.AdminAccountPassword)
+	if password == "" {
+		return errors.New("no password set")
+	}
+	if err := validate.NewPassword(password); err != nil {
+		return err
+	}
+
+	a, err := dbConn.GetLocalAccountByUsername(ctx, username)
+	if err != nil {
+		return err
+	}
+
+	u := &gtsmodel.User{}
+	if err := dbConn.GetWhere(ctx, []db.Where{{Key: "account_id", Value: a.ID}}, u); err != nil {
+		return err
+	}
+
+	pw, err := bcrypt.GenerateFromPassword([]byte(password), bcrypt.DefaultCost)
+	if err != nil {
+		return fmt.Errorf("error hashing password: %s", err)
+	}
+
+	u.EncryptedPassword = string(pw)
+
+	if err := dbConn.UpdateByPrimaryKey(ctx, u); err != nil {
+		return err
+	}
+
+	return nil
+}

cmd/gotosocial/action/admin/trans/export.go

@@ -0,0 +1,52 @@
+/*
+   GoToSocial
+   Copyright (C) 2021 GoToSocial Authors admin@gotosocial.org
+
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU Affero General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU Affero General Public License for more details.
+
+   You should have received a copy of the GNU Affero General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+package trans
+
+import (
+	"context"
+	"errors"
+	"fmt"
+
+	"github.com/spf13/viper"
+	"github.com/superseriousbusiness/gotosocial/cmd/gotosocial/action"
+	"github.com/superseriousbusiness/gotosocial/internal/config"
+	"github.com/superseriousbusiness/gotosocial/internal/db/bundb"
+	"github.com/superseriousbusiness/gotosocial/internal/trans"
+)
+
+// Export exports info from the database into a file
+var Export action.GTSAction = func(ctx context.Context) error {
+	dbConn, err := bundb.NewBunDBService(ctx)
+	if err != nil {
+		return fmt.Errorf("error creating dbservice: %s", err)
+	}
+
+	exporter := trans.NewExporter(dbConn)
+
+	path := viper.GetString(config.Keys.AdminTransPath)
+	if path == "" {
+		return errors.New("no path set")
+	}
+
+	if err := exporter.ExportMinimal(ctx, path); err != nil {
+		return err
+	}
+
+	return dbConn.Stop(ctx)
+}

cmd/gotosocial/action/admin/trans/import.go

@@ -0,0 +1,52 @@
+/*
+   GoToSocial
+   Copyright (C) 2021 GoToSocial Authors admin@gotosocial.org
+
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU Affero General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU Affero General Public License for more details.
+
+   You should have received a copy of the GNU Affero General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+package trans
+
+import (
+	"context"
+	"errors"
+	"fmt"
+
+	"github.com/spf13/viper"
+	"github.com/superseriousbusiness/gotosocial/cmd/gotosocial/action"
+	"github.com/superseriousbusiness/gotosocial/internal/config"
+	"github.com/superseriousbusiness/gotosocial/internal/db/bundb"
+	"github.com/superseriousbusiness/gotosocial/internal/trans"
+)
+
+// Import imports info from a file into the database
+var Import action.GTSAction = func(ctx context.Context) error {
+	dbConn, err := bundb.NewBunDBService(ctx)
+	if err != nil {
+		return fmt.Errorf("error creating dbservice: %s", err)
+	}
+
+	importer := trans.NewImporter(dbConn)
+
+	path := viper.GetString(config.Keys.AdminTransPath)
+	if path == "" {
+		return errors.New("no path set")
+	}
+
+	if err := importer.Import(ctx, path); err != nil {
+		return err
+	}
+
+	return dbConn.Stop(ctx)
+}

cmd/gotosocial/action/debug/config/config.go

@@ -0,0 +1,39 @@
+/*
+   GoToSocial
+   Copyright (C) 2021 GoToSocial Authors admin@gotosocial.org
+
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU Affero General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU Affero General Public License for more details.
+
+   You should have received a copy of the GNU Affero General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+package config
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+
+	"github.com/spf13/viper"
+	"github.com/superseriousbusiness/gotosocial/cmd/gotosocial/action"
+)
+
+// Config just prints the collated config out to stdout as json.
+var Config action.GTSAction = func(ctx context.Context) error {
+	allSettings := viper.AllSettings()
+	b, err := json.Marshal(&allSettings)
+	if err != nil {
+		return err
+	}
+	fmt.Println(string(b))
+	return nil
+}

cmd/gotosocial/action/server/server.go

@@ -0,0 +1,225 @@
+/*
+   GoToSocial
+   Copyright (C) 2021 GoToSocial Authors admin@gotosocial.org
+
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU Affero General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU Affero General Public License for more details.
+
+   You should have received a copy of the GNU Affero General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+package server
+
+import (
+	"context"
+	"fmt"
+	"net/http"
+	"os"
+	"os/signal"
+	"syscall"
+
+	"codeberg.org/gruf/go-store/kv"
+	"github.com/sirupsen/logrus"
+	"github.com/spf13/viper"
+	"github.com/superseriousbusiness/gotosocial/cmd/gotosocial/action"
+	"github.com/superseriousbusiness/gotosocial/internal/api"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/account"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/admin"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/app"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/auth"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/blocks"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/emoji"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/favourites"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/fileserver"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/filter"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/followrequest"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/instance"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/list"
+	mediaModule "github.com/superseriousbusiness/gotosocial/internal/api/client/media"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/notification"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/search"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/status"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/streaming"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/timeline"
+	userClient "github.com/superseriousbusiness/gotosocial/internal/api/client/user"
+	"github.com/superseriousbusiness/gotosocial/internal/api/s2s/nodeinfo"
+	"github.com/superseriousbusiness/gotosocial/internal/api/s2s/user"
+	"github.com/superseriousbusiness/gotosocial/internal/api/s2s/webfinger"
+	"github.com/superseriousbusiness/gotosocial/internal/api/security"
+	"github.com/superseriousbusiness/gotosocial/internal/config"
+	"github.com/superseriousbusiness/gotosocial/internal/db/bundb"
+	"github.com/superseriousbusiness/gotosocial/internal/email"
+	"github.com/superseriousbusiness/gotosocial/internal/federation"
+	"github.com/superseriousbusiness/gotosocial/internal/federation/federatingdb"
+	"github.com/superseriousbusiness/gotosocial/internal/gotosocial"
+	"github.com/superseriousbusiness/gotosocial/internal/media"
+	"github.com/superseriousbusiness/gotosocial/internal/oauth"
+	"github.com/superseriousbusiness/gotosocial/internal/oidc"
+	"github.com/superseriousbusiness/gotosocial/internal/processing"
+	"github.com/superseriousbusiness/gotosocial/internal/router"
+	timelineprocessing "github.com/superseriousbusiness/gotosocial/internal/timeline"
+	"github.com/superseriousbusiness/gotosocial/internal/transport"
+	"github.com/superseriousbusiness/gotosocial/internal/typeutils"
+	"github.com/superseriousbusiness/gotosocial/internal/web"
+)
+
+// Start creates and starts a gotosocial server
+var Start action.GTSAction = func(ctx context.Context) error {
+	dbService, err := bundb.NewBunDBService(ctx)
+	if err != nil {
+		return fmt.Errorf("error creating dbservice: %s", err)
+	}
+
+	if err := dbService.CreateInstanceAccount(ctx); err != nil {
+		return fmt.Errorf("error creating instance account: %s", err)
+	}
+
+	if err := dbService.CreateInstanceInstance(ctx); err != nil {
+		return fmt.Errorf("error creating instance instance: %s", err)
+	}
+
+	federatingDB := federatingdb.New(dbService)
+
+	router, err := router.New(ctx, dbService)
+	if err != nil {
+		return fmt.Errorf("error creating router: %s", err)
+	}
+
+	// build converters and util
+	typeConverter := typeutils.NewConverter(dbService)
+	timelineManager := timelineprocessing.NewManager(dbService, typeConverter)
+
+	// Open the storage backend
+	storageBasePath := viper.GetString(config.Keys.StorageBasePath)
+	storage, err := kv.OpenFile(storageBasePath, nil)
+	if err != nil {
+		return fmt.Errorf("error creating storage backend: %s", err)
+	}
+
+	// build backend handlers
+	mediaHandler := media.New(dbService, storage)
+	oauthServer := oauth.New(ctx, dbService)
+	transportController := transport.NewController(dbService, &federation.Clock{}, http.DefaultClient)
+	federator := federation.NewFederator(dbService, federatingDB, transportController, typeConverter, mediaHandler)
+
+	// decide whether to create a noop email sender (won't send emails) or a real one
+	var emailSender email.Sender
+	smtpHost := viper.GetString(config.Keys.SMTPHost)
+	if smtpHost != "" {
+		// host is defined so create a proper sender
+		emailSender, err = email.NewSender()
+		if err != nil {
+			return fmt.Errorf("error creating email sender: %s", err)
+		}
+	} else {
+		// no host is defined so create a noop sender
+		emailSender, err = email.NewNoopSender(nil)
+		if err != nil {
+			return fmt.Errorf("error creating noop email sender: %s", err)
+		}
+	}
+
+	// create and start the message processor using the other services we've created so far
+	processor := processing.NewProcessor(typeConverter, federator, oauthServer, mediaHandler, storage, timelineManager, dbService, emailSender)
+	if err := processor.Start(ctx); err != nil {
+		return fmt.Errorf("error starting processor: %s", err)
+	}
+
+	idp, err := oidc.NewIDP(ctx)
+	if err != nil {
+		return fmt.Errorf("error creating oidc idp: %s", err)
+	}
+
+	// build client api modules
+	authModule := auth.New(dbService, oauthServer, idp)
+	accountModule := account.New(processor)
+	instanceModule := instance.New(processor)
+	appsModule := app.New(processor)
+	followRequestsModule := followrequest.New(processor)
+	webfingerModule := webfinger.New(processor)
+	nodeInfoModule := nodeinfo.New(processor)
+	webBaseModule := web.New(processor)
+	usersModule := user.New(processor)
+	timelineModule := timeline.New(processor)
+	notificationModule := notification.New(processor)
+	searchModule := search.New(processor)
+	filtersModule := filter.New(processor)
+	emojiModule := emoji.New(processor)
+	listsModule := list.New(processor)
+	mm := mediaModule.New(processor)
+	fileServerModule := fileserver.New(processor)
+	adminModule := admin.New(processor)
+	statusModule := status.New(processor)
+	securityModule := security.New(dbService, oauthServer)
+	streamingModule := streaming.New(processor)
+	favouritesModule := favourites.New(processor)
+	blocksModule := blocks.New(processor)
+	userClientModule := userClient.New(processor)
+
+	apis := []api.ClientModule{
+		// modules with middleware go first
+		securityModule,
+		authModule,
+
+		// now everything else
+		webBaseModule,
+		accountModule,
+		instanceModule,
+		appsModule,
+		followRequestsModule,
+		mm,
+		fileServerModule,
+		adminModule,
+		statusModule,
+		webfingerModule,
+		nodeInfoModule,
+		usersModule,
+		timelineModule,
+		notificationModule,
+		searchModule,
+		filtersModule,
+		emojiModule,
+		listsModule,
+		streamingModule,
+		favouritesModule,
+		blocksModule,
+		userClientModule,
+	}
+
+	for _, m := range apis {
+		if err := m.Route(router); err != nil {
+			return fmt.Errorf("routing error: %s", err)
+		}
+	}
+
+	gts, err := gotosocial.NewServer(dbService, router, federator)
+	if err != nil {
+		return fmt.Errorf("error creating gotosocial service: %s", err)
+	}
+
+	if err := gts.Start(ctx); err != nil {
+		return fmt.Errorf("error starting gotosocial service: %s", err)
+	}
+
+	// catch shutdown signals from the operating system
+	sigs := make(chan os.Signal, 1)
+	signal.Notify(sigs, os.Interrupt, syscall.SIGTERM)
+	sig := <-sigs
+	logrus.Infof("received signal %s, shutting down", sig)
+
+	// close down all running services in order
+	if err := gts.Stop(ctx); err != nil {
+		return fmt.Errorf("error closing gotosocial service: %s", err)
+	}
+
+	logrus.Info("done! exiting...")
+	return nil
+}

cmd/gotosocial/action/testrig/testrig.go

@@ -0,0 +1,184 @@
+/*
+   GoToSocial
+   Copyright (C) 2021 GoToSocial Authors admin@gotosocial.org
+
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU Affero General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU Affero General Public License for more details.
+
+   You should have received a copy of the GNU Affero General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+package testrig
+
+import (
+	"bytes"
+	"context"
+	"fmt"
+	"io/ioutil"
+	"net/http"
+	"os"
+	"os/signal"
+	"syscall"
+
+	"github.com/sirupsen/logrus"
+	"github.com/superseriousbusiness/gotosocial/cmd/gotosocial/action"
+	"github.com/superseriousbusiness/gotosocial/internal/api"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/account"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/admin"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/app"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/auth"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/blocks"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/emoji"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/favourites"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/fileserver"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/filter"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/followrequest"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/instance"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/list"
+	mediaModule "github.com/superseriousbusiness/gotosocial/internal/api/client/media"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/notification"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/search"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/status"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/streaming"
+	"github.com/superseriousbusiness/gotosocial/internal/api/client/timeline"
+	userClient "github.com/superseriousbusiness/gotosocial/internal/api/client/user"
+	"github.com/superseriousbusiness/gotosocial/internal/api/s2s/nodeinfo"
+	"github.com/superseriousbusiness/gotosocial/internal/api/s2s/user"
+	"github.com/superseriousbusiness/gotosocial/internal/api/s2s/webfinger"
+	"github.com/superseriousbusiness/gotosocial/internal/api/security"
+	"github.com/superseriousbusiness/gotosocial/internal/gotosocial"
+	"github.com/superseriousbusiness/gotosocial/internal/oidc"
+	"github.com/superseriousbusiness/gotosocial/internal/web"
+	"github.com/superseriousbusiness/gotosocial/testrig"
+)
+
+// Start creates and starts a gotosocial testrig server
+var Start action.GTSAction = func(ctx context.Context) error {
+	testrig.InitTestConfig()
+	testrig.InitTestLog()
+
+	dbService := testrig.NewTestDB()
+	testrig.StandardDBSetup(dbService, nil)
+	router := testrig.NewTestRouter(dbService)
+	storageBackend := testrig.NewTestStorage()
+	testrig.StandardStorageSetup(storageBackend, "./testrig/media")
+
+	// build backend handlers
+	oauthServer := testrig.NewTestOauthServer(dbService)
+	transportController := testrig.NewTestTransportController(testrig.NewMockHTTPClient(func(req *http.Request) (*http.Response, error) {
+		r := ioutil.NopCloser(bytes.NewReader([]byte{}))
+		return &http.Response{
+			StatusCode: 200,
+			Body:       r,
+		}, nil
+	}), dbService)
+	federator := testrig.NewTestFederator(dbService, transportController, storageBackend)
+
+	emailSender := testrig.NewEmailSender("./web/template/", nil)
+
+	processor := testrig.NewTestProcessor(dbService, storageBackend, federator, emailSender)
+	if err := processor.Start(ctx); err != nil {
+		return fmt.Errorf("error starting processor: %s", err)
+	}
+
+	idp, err := oidc.NewIDP(ctx)
+	if err != nil {
+		return fmt.Errorf("error creating oidc idp: %s", err)
+	}
+
+	// build client api modules
+	authModule := auth.New(dbService, oauthServer, idp)
+	accountModule := account.New(processor)
+	instanceModule := instance.New(processor)
+	appsModule := app.New(processor)
+	followRequestsModule := followrequest.New(processor)
+	webfingerModule := webfinger.New(processor)
+	nodeInfoModule := nodeinfo.New(processor)
+	webBaseModule := web.New(processor)
+	usersModule := user.New(processor)
+	timelineModule := timeline.New(processor)
+	notificationModule := notification.New(processor)
+	searchModule := search.New(processor)
+	filtersModule := filter.New(processor)
+	emojiModule := emoji.New(processor)
+	listsModule := list.New(processor)
+	mm := mediaModule.New(processor)
+	fileServerModule := fileserver.New(processor)
+	adminModule := admin.New(processor)
+	statusModule := status.New(processor)
+	securityModule := security.New(dbService, oauthServer)
+	streamingModule := streaming.New(processor)
+	favouritesModule := favourites.New(processor)
+	blocksModule := blocks.New(processor)
+	userClientModule := userClient.New(processor)
+
+	apis := []api.ClientModule{
+		// modules with middleware go first
+		securityModule,
+		authModule,
+
+		// now everything else
+		webBaseModule,
+		accountModule,
+		instanceModule,
+		appsModule,
+		followRequestsModule,
+		mm,
+		fileServerModule,
+		adminModule,
+		statusModule,
+		webfingerModule,
+		nodeInfoModule,
+		usersModule,
+		timelineModule,
+		notificationModule,
+		searchModule,
+		filtersModule,
+		emojiModule,
+		listsModule,
+		streamingModule,
+		favouritesModule,
+		blocksModule,
+		userClientModule,
+	}
+
+	for _, m := range apis {
+		if err := m.Route(router); err != nil {
+			return fmt.Errorf("routing error: %s", err)
+		}
+	}
+
+	gts, err := gotosocial.NewServer(dbService, router, federator)
+	if err != nil {
+		return fmt.Errorf("error creating gotosocial service: %s", err)
+	}
+
+	if err := gts.Start(ctx); err != nil {
+		return fmt.Errorf("error starting gotosocial service: %s", err)
+	}
+
+	// catch shutdown signals from the operating system
+	sigs := make(chan os.Signal, 1)
+	signal.Notify(sigs, os.Interrupt, syscall.SIGTERM)
+	sig := <-sigs
+	logrus.Infof("received signal %s, shutting down", sig)
+
+	testrig.StandardDBTeardown(dbService)
+	testrig.StandardStorageTeardown(storageBackend)
+
+	// close down all running services in order
+	if err := gts.Stop(ctx); err != nil {
+		return fmt.Errorf("error closing gotosocial service: %s", err)
+	}
+
+	logrus.Info("done! exiting...")
+	return nil
+}