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

internal/api/s2s/nodeinfo/nodeinfo.go

@@ -22,7 +22,6 @@ import (
 	"net/http"
 
 	"github.com/superseriousbusiness/gotosocial/internal/api"
-	"github.com/superseriousbusiness/gotosocial/internal/config"
 	"github.com/superseriousbusiness/gotosocial/internal/processing"
 	"github.com/superseriousbusiness/gotosocial/internal/router"
 )
@@ -36,14 +35,12 @@ const (
 
 // Module implements the FederationModule interface
 type Module struct {
-	config    *config.Config
 	processor processing.Processor
 }
 
 // New returns a new nodeinfo module
-func New(config *config.Config, processor processing.Processor) api.FederationModule {
+func New(processor processing.Processor) api.FederationModule {
 	return &Module{
-		config:    config,
 		processor: processor,
 	}
 }

internal/api/s2s/user/inboxpost_test.go

@@ -87,7 +87,7 @@ func (suite *InboxPostTestSuite) TestPostBlock() {
 	federator := testrig.NewTestFederator(suite.db, tc, suite.storage)
 	emailSender := testrig.NewEmailSender("../../../../web/template/", nil)
 	processor := testrig.NewTestProcessor(suite.db, suite.storage, federator, emailSender)
-	userModule := user.New(suite.config, processor).(*user.Module)
+	userModule := user.New(processor).(*user.Module)
 
 	// setup request
 	recorder := httptest.NewRecorder()
@@ -187,7 +187,7 @@ func (suite *InboxPostTestSuite) TestPostUnblock() {
 	federator := testrig.NewTestFederator(suite.db, tc, suite.storage)
 	emailSender := testrig.NewEmailSender("../../../../web/template/", nil)
 	processor := testrig.NewTestProcessor(suite.db, suite.storage, federator, emailSender)
-	userModule := user.New(suite.config, processor).(*user.Module)
+	userModule := user.New(processor).(*user.Module)
 
 	// setup request
 	recorder := httptest.NewRecorder()
@@ -277,7 +277,7 @@ func (suite *InboxPostTestSuite) TestPostUpdate() {
 	federator := testrig.NewTestFederator(suite.db, tc, suite.storage)
 	emailSender := testrig.NewEmailSender("../../../../web/template/", nil)
 	processor := testrig.NewTestProcessor(suite.db, suite.storage, federator, emailSender)
-	userModule := user.New(suite.config, processor).(*user.Module)
+	userModule := user.New(processor).(*user.Module)
 
 	// setup request
 	recorder := httptest.NewRecorder()
@@ -398,7 +398,7 @@ func (suite *InboxPostTestSuite) TestPostDelete() {
 	processor := testrig.NewTestProcessor(suite.db, suite.storage, federator, emailSender)
 	err = processor.Start(context.Background())
 	suite.NoError(err)
-	userModule := user.New(suite.config, processor).(*user.Module)
+	userModule := user.New(processor).(*user.Module)
 
 	// setup request
 	recorder := httptest.NewRecorder()

internal/api/s2s/user/outboxget_test.go

@@ -48,7 +48,7 @@ func (suite *OutboxGetTestSuite) TestGetOutbox() {
 	federator := testrig.NewTestFederator(suite.db, tc, suite.storage)
 	emailSender := testrig.NewEmailSender("../../../../web/template/", nil)
 	processor := testrig.NewTestProcessor(suite.db, suite.storage, federator, emailSender)
-	userModule := user.New(suite.config, processor).(*user.Module)
+	userModule := user.New(processor).(*user.Module)
 
 	// setup request
 	recorder := httptest.NewRecorder()
@@ -102,7 +102,7 @@ func (suite *OutboxGetTestSuite) TestGetOutboxFirstPage() {
 	federator := testrig.NewTestFederator(suite.db, tc, suite.storage)
 	emailSender := testrig.NewEmailSender("../../../../web/template/", nil)
 	processor := testrig.NewTestProcessor(suite.db, suite.storage, federator, emailSender)
-	userModule := user.New(suite.config, processor).(*user.Module)
+	userModule := user.New(processor).(*user.Module)
 
 	// setup request
 	recorder := httptest.NewRecorder()
@@ -156,7 +156,7 @@ func (suite *OutboxGetTestSuite) TestGetOutboxNextPage() {
 	federator := testrig.NewTestFederator(suite.db, tc, suite.storage)
 	emailSender := testrig.NewEmailSender("../../../../web/template/", nil)
 	processor := testrig.NewTestProcessor(suite.db, suite.storage, federator, emailSender)
-	userModule := user.New(suite.config, processor).(*user.Module)
+	userModule := user.New(processor).(*user.Module)
 
 	// setup request
 	recorder := httptest.NewRecorder()

internal/api/s2s/user/repliesget_test.go

@@ -51,7 +51,7 @@ func (suite *RepliesGetTestSuite) TestGetReplies() {
 	federator := testrig.NewTestFederator(suite.db, tc, suite.storage)
 	emailSender := testrig.NewEmailSender("../../../../web/template/", nil)
 	processor := testrig.NewTestProcessor(suite.db, suite.storage, federator, emailSender)
-	userModule := user.New(suite.config, processor).(*user.Module)
+	userModule := user.New(processor).(*user.Module)
 
 	// setup request
 	recorder := httptest.NewRecorder()
@@ -111,7 +111,7 @@ func (suite *RepliesGetTestSuite) TestGetRepliesNext() {
 	federator := testrig.NewTestFederator(suite.db, tc, suite.storage)
 	emailSender := testrig.NewEmailSender("../../../../web/template/", nil)
 	processor := testrig.NewTestProcessor(suite.db, suite.storage, federator, emailSender)
-	userModule := user.New(suite.config, processor).(*user.Module)
+	userModule := user.New(processor).(*user.Module)
 
 	// setup request
 	recorder := httptest.NewRecorder()
@@ -174,7 +174,7 @@ func (suite *RepliesGetTestSuite) TestGetRepliesLast() {
 	federator := testrig.NewTestFederator(suite.db, tc, suite.storage)
 	emailSender := testrig.NewEmailSender("../../../../web/template/", nil)
 	processor := testrig.NewTestProcessor(suite.db, suite.storage, federator, emailSender)
-	userModule := user.New(suite.config, processor).(*user.Module)
+	userModule := user.New(processor).(*user.Module)
 
 	// setup request
 	recorder := httptest.NewRecorder()

internal/api/s2s/user/user.go

@@ -22,7 +22,6 @@ import (
 	"net/http"
 
 	"github.com/superseriousbusiness/gotosocial/internal/api"
-	"github.com/superseriousbusiness/gotosocial/internal/config"
 	"github.com/superseriousbusiness/gotosocial/internal/processing"
 	"github.com/superseriousbusiness/gotosocial/internal/router"
 	"github.com/superseriousbusiness/gotosocial/internal/util"
@@ -66,14 +65,12 @@ const (
 
 // Module implements the FederationAPIModule interface
 type Module struct {
-	config    *config.Config
 	processor processing.Processor
 }
 
 // New returns a new auth module
-func New(config *config.Config, processor processing.Processor) api.FederationModule {
+func New(processor processing.Processor) api.FederationModule {
 	return &Module{
-		config:    config,
 		processor: processor,
 	}
 }

internal/api/s2s/user/user_test.go

@@ -23,7 +23,6 @@ import (
 	"github.com/stretchr/testify/suite"
 	"github.com/superseriousbusiness/gotosocial/internal/api/s2s/user"
 	"github.com/superseriousbusiness/gotosocial/internal/api/security"
-	"github.com/superseriousbusiness/gotosocial/internal/config"
 	"github.com/superseriousbusiness/gotosocial/internal/db"
 	"github.com/superseriousbusiness/gotosocial/internal/email"
 	"github.com/superseriousbusiness/gotosocial/internal/federation"
@@ -37,7 +36,6 @@ import (
 type UserStandardTestSuite struct {
 	// standard suite interfaces
 	suite.Suite
-	config         *config.Config
 	db             db.DB
 	tc             typeutils.TypeConverter
 	federator      federation.Federator
@@ -73,17 +71,18 @@ func (suite *UserStandardTestSuite) SetupSuite() {
 }
 
 func (suite *UserStandardTestSuite) SetupTest() {
-	suite.config = testrig.NewTestConfig()
+	testrig.InitTestLog()
+	testrig.InitTestConfig()
+
 	suite.db = testrig.NewTestDB()
 	suite.tc = testrig.NewTestTypeConverter(suite.db)
 	suite.storage = testrig.NewTestStorage()
-	testrig.InitTestLog()
 	suite.federator = testrig.NewTestFederator(suite.db, testrig.NewTestTransportController(testrig.NewMockHTTPClient(nil), suite.db), suite.storage)
 	suite.emailSender = testrig.NewEmailSender("../../../../web/template/", nil)
 	suite.processor = testrig.NewTestProcessor(suite.db, suite.storage, suite.federator, suite.emailSender)
-	suite.userModule = user.New(suite.config, suite.processor).(*user.Module)
+	suite.userModule = user.New(suite.processor).(*user.Module)
 	suite.oauthServer = testrig.NewTestOauthServer(suite.db)
-	suite.securityModule = security.New(suite.config, suite.db, suite.oauthServer).(*security.Module)
+	suite.securityModule = security.New(suite.db, suite.oauthServer).(*security.Module)
 	testrig.StandardDBSetup(suite.db, suite.testAccounts)
 	testrig.StandardStorageSetup(suite.storage, "../../../../testrig/media")
 }

internal/api/s2s/user/userget_test.go

@@ -49,7 +49,7 @@ func (suite *UserGetTestSuite) TestGetUser() {
 	federator := testrig.NewTestFederator(suite.db, tc, suite.storage)
 	emailSender := testrig.NewEmailSender("../../../../web/template/", nil)
 	processor := testrig.NewTestProcessor(suite.db, suite.storage, federator, emailSender)
-	userModule := user.New(suite.config, processor).(*user.Module)
+	userModule := user.New(processor).(*user.Module)
 
 	// setup request
 	recorder := httptest.NewRecorder()

internal/api/s2s/webfinger/webfinger.go

@@ -22,7 +22,6 @@ import (
 	"net/http"
 
 	"github.com/superseriousbusiness/gotosocial/internal/api"
-	"github.com/superseriousbusiness/gotosocial/internal/config"
 	"github.com/superseriousbusiness/gotosocial/internal/processing"
 	"github.com/superseriousbusiness/gotosocial/internal/router"
 )
@@ -34,14 +33,12 @@ const (
 
 // Module implements the FederationModule interface
 type Module struct {
-	config    *config.Config
 	processor processing.Processor
 }
 
 // New returns a new webfinger module
-func New(config *config.Config, processor processing.Processor) api.FederationModule {
+func New(processor processing.Processor) api.FederationModule {
 	return &Module{
-		config:    config,
 		processor: processor,
 	}
 }

internal/api/s2s/webfinger/webfinger_test.go

@@ -28,7 +28,6 @@ import (
 	"github.com/superseriousbusiness/gotosocial/internal/ap"
 	"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"
 	"github.com/superseriousbusiness/gotosocial/internal/email"
 	"github.com/superseriousbusiness/gotosocial/internal/federation"
@@ -42,7 +41,6 @@ import (
 type WebfingerStandardTestSuite struct {
 	// standard suite interfaces
 	suite.Suite
-	config         *config.Config
 	db             db.DB
 	tc             typeutils.TypeConverter
 	federator      federation.Federator
@@ -76,17 +74,18 @@ func (suite *WebfingerStandardTestSuite) SetupSuite() {
 }
 
 func (suite *WebfingerStandardTestSuite) SetupTest() {
-	suite.config = testrig.NewTestConfig()
+	testrig.InitTestLog()
+	testrig.InitTestConfig()
+
 	suite.db = testrig.NewTestDB()
 	suite.tc = testrig.NewTestTypeConverter(suite.db)
 	suite.storage = testrig.NewTestStorage()
-	testrig.InitTestLog()
 	suite.federator = testrig.NewTestFederator(suite.db, testrig.NewTestTransportController(testrig.NewMockHTTPClient(nil), suite.db), suite.storage)
 	suite.emailSender = testrig.NewEmailSender("../../../../web/template/", nil)
 	suite.processor = testrig.NewTestProcessor(suite.db, suite.storage, suite.federator, suite.emailSender)
-	suite.webfingerModule = webfinger.New(suite.config, suite.processor).(*webfinger.Module)
+	suite.webfingerModule = webfinger.New(suite.processor).(*webfinger.Module)
 	suite.oauthServer = testrig.NewTestOauthServer(suite.db)
-	suite.securityModule = security.New(suite.config, suite.db, suite.oauthServer).(*security.Module)
+	suite.securityModule = security.New(suite.db, suite.oauthServer).(*security.Module)
 	testrig.StandardDBSetup(suite.db, suite.testAccounts)
 	testrig.StandardStorageSetup(suite.storage, "../../../../testrig/media")
 }

internal/api/s2s/webfinger/webfingerget.go

@@ -26,6 +26,8 @@ import (
 
 	"github.com/gin-gonic/gin"
 	"github.com/sirupsen/logrus"
+	"github.com/spf13/viper"
+	"github.com/superseriousbusiness/gotosocial/internal/config"
 	"github.com/superseriousbusiness/gotosocial/internal/util"
 )
 
@@ -59,16 +61,19 @@ func (m *Module) WebfingerGETRequest(c *gin.Context) {
 	}
 
 	username := strings.ToLower(usernameAndAccountDomain[0])
-	accountDomain := strings.ToLower(usernameAndAccountDomain[1])
-	if username == "" || accountDomain == "" {
+	requestedAccountDomain := strings.ToLower(usernameAndAccountDomain[1])
+	if username == "" || requestedAccountDomain == "" {
 		l.Debug("aborting request because username or domain was empty")
 		c.JSON(http.StatusBadRequest, gin.H{"error": "bad request"})
 		return
 	}
 
-	if accountDomain != m.config.AccountDomain && accountDomain != m.config.Host {
-		l.Debugf("aborting request because accountDomain %s does not belong to this instance", accountDomain)
-		c.JSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("accountDomain %s does not belong to this instance", accountDomain)})
+	accountDomain := viper.GetString(config.Keys.AccountDomain)
+	host := viper.GetString(config.Keys.Host)
+
+	if requestedAccountDomain != accountDomain && requestedAccountDomain != host {
+		l.Debugf("aborting request because accountDomain %s does not belong to this instance", requestedAccountDomain)
+		c.JSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("accountDomain %s does not belong to this instance", requestedAccountDomain)})
 		return
 	}
 

internal/api/s2s/webfinger/webfingerget_test.go

@@ -27,9 +27,11 @@ import (
 	"testing"
 
 	"github.com/gin-gonic/gin"
+	"github.com/spf13/viper"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/suite"
 	"github.com/superseriousbusiness/gotosocial/internal/api/s2s/webfinger"
+	"github.com/superseriousbusiness/gotosocial/internal/config"
 	"github.com/superseriousbusiness/gotosocial/internal/processing"
 	"github.com/superseriousbusiness/gotosocial/testrig"
 )
@@ -42,7 +44,8 @@ func (suite *WebfingerGetTestSuite) TestFingerUser() {
 	targetAccount := suite.testAccounts["local_account_1"]
 
 	// setup request
-	requestPath := fmt.Sprintf("/%s?resource=acct:%s@%s", webfinger.WebfingerBasePath, targetAccount.Username, suite.config.Host)
+	host := viper.GetString(config.Keys.Host)
+	requestPath := fmt.Sprintf("/%s?resource=acct:%s@%s", webfinger.WebfingerBasePath, targetAccount.Username, host)
 
 	recorder := httptest.NewRecorder()
 	ctx, _ := gin.CreateTestContext(recorder)
@@ -63,10 +66,10 @@ func (suite *WebfingerGetTestSuite) TestFingerUser() {
 }
 
 func (suite *WebfingerGetTestSuite) TestFingerUserWithDifferentAccountDomainByHost() {
-	suite.config.Host = "gts.example.org"
-	suite.config.AccountDomain = "example.org"
-	suite.processor = processing.NewProcessor(suite.config, suite.tc, suite.federator, testrig.NewTestOauthServer(suite.db), testrig.NewTestMediaHandler(suite.db, suite.storage), suite.storage, testrig.NewTestTimelineManager(suite.db), suite.db, suite.emailSender)
-	suite.webfingerModule = webfinger.New(suite.config, suite.processor).(*webfinger.Module)
+	viper.Set(config.Keys.Host, "gts.example.org")
+	viper.Set(config.Keys.AccountDomain, "example.org")
+	suite.processor = processing.NewProcessor(suite.tc, suite.federator, testrig.NewTestOauthServer(suite.db), testrig.NewTestMediaHandler(suite.db, suite.storage), suite.storage, testrig.NewTestTimelineManager(suite.db), suite.db, suite.emailSender)
+	suite.webfingerModule = webfinger.New(suite.processor).(*webfinger.Module)
 
 	targetAccount := accountDomainAccount()
 	if err := suite.db.Put(context.Background(), targetAccount); err != nil {
@@ -74,7 +77,8 @@ func (suite *WebfingerGetTestSuite) TestFingerUserWithDifferentAccountDomainByHo
 	}
 
 	// setup request
-	requestPath := fmt.Sprintf("/%s?resource=acct:%s@%s", webfinger.WebfingerBasePath, targetAccount.Username, suite.config.Host)
+	host := viper.GetString(config.Keys.Host)
+	requestPath := fmt.Sprintf("/%s?resource=acct:%s@%s", webfinger.WebfingerBasePath, targetAccount.Username, host)
 
 	recorder := httptest.NewRecorder()
 	ctx, _ := gin.CreateTestContext(recorder)
@@ -95,10 +99,10 @@ func (suite *WebfingerGetTestSuite) TestFingerUserWithDifferentAccountDomainByHo
 }
 
 func (suite *WebfingerGetTestSuite) TestFingerUserWithDifferentAccountDomainByAccountDomain() {
-	suite.config.Host = "gts.example.org"
-	suite.config.AccountDomain = "example.org"
-	suite.processor = processing.NewProcessor(suite.config, suite.tc, suite.federator, testrig.NewTestOauthServer(suite.db), testrig.NewTestMediaHandler(suite.db, suite.storage), suite.storage, testrig.NewTestTimelineManager(suite.db), suite.db, suite.emailSender)
-	suite.webfingerModule = webfinger.New(suite.config, suite.processor).(*webfinger.Module)
+	viper.Set(config.Keys.Host, "gts.example.org")
+	viper.Set(config.Keys.AccountDomain, "example.org")
+	suite.processor = processing.NewProcessor(suite.tc, suite.federator, testrig.NewTestOauthServer(suite.db), testrig.NewTestMediaHandler(suite.db, suite.storage), suite.storage, testrig.NewTestTimelineManager(suite.db), suite.db, suite.emailSender)
+	suite.webfingerModule = webfinger.New(suite.processor).(*webfinger.Module)
 
 	targetAccount := accountDomainAccount()
 	if err := suite.db.Put(context.Background(), targetAccount); err != nil {
@@ -106,7 +110,8 @@ func (suite *WebfingerGetTestSuite) TestFingerUserWithDifferentAccountDomainByAc
 	}
 
 	// setup request
-	requestPath := fmt.Sprintf("/%s?resource=acct:%s@%s", webfinger.WebfingerBasePath, targetAccount.Username, suite.config.AccountDomain)
+	accountDomain := viper.GetString(config.Keys.AccountDomain)
+	requestPath := fmt.Sprintf("/%s?resource=acct:%s@%s", webfinger.WebfingerBasePath, targetAccount.Username, accountDomain)
 
 	recorder := httptest.NewRecorder()
 	ctx, _ := gin.CreateTestContext(recorder)
@@ -130,7 +135,8 @@ func (suite *WebfingerGetTestSuite) TestFingerUserWithoutAcct() {
 	targetAccount := suite.testAccounts["local_account_1"]
 
 	// setup request -- leave out the 'acct:' prefix, which is prettymuch what pixelfed currently does
-	requestPath := fmt.Sprintf("/%s?resource=%s@%s", webfinger.WebfingerBasePath, targetAccount.Username, suite.config.Host)
+	host := viper.GetString(config.Keys.Host)
+	requestPath := fmt.Sprintf("/%s?resource=%s@%s", webfinger.WebfingerBasePath, targetAccount.Username, host)
 
 	recorder := httptest.NewRecorder()
 	ctx, _ := gin.CreateTestContext(recorder)