feat(CREATE): add configuration option to enable/disable database writes

Author: benoitdm-oslandia

config/pg_featureserv.toml.example

@@ -68,6 +68,9 @@ WriteTimeoutSec = 30
 # Publish functions from these schemas (default is publish postgisftw)
 # FunctionIncludes = [ "postgisftw", "schema2" ]
 
+# Allow write changes to database. Default is to read only.
+# AllowWrite = false
+
 [Paging]
 # The default number of features in a response
 LimitDefault = 20

hugo/content/installation/configuration.md

@@ -118,6 +118,9 @@ WriteTimeoutSec = 30
 # Publish functions from these schemas (default is publish postgisftw)
 # FunctionIncludes = [ "postgisftw", "schema2" ]
 
+# Allow write changes to database. Default is to read only.
+# AllowWrite = false
+
 [Paging]
 # The default number of features in a response
 LimitDefault = 20

internal/conf/config.go

@@ -44,6 +44,7 @@ func setDefaultConfig() {
 	viper.SetDefault("Database.TableIncludes", []string{})
 	viper.SetDefault("Database.TableExcludes", []string{})
 	viper.SetDefault("Database.FunctionIncludes", []string{"postgisftw"})
+	viper.SetDefault("Database.AllowWrite", false)
 
 	viper.SetDefault("Paging.LimitDefault", 10)
 	viper.SetDefault("Paging.LimitMax", 1000)
@@ -94,6 +95,7 @@ type Database struct {
 	TableIncludes         []string
 	TableExcludes         []string
 	FunctionIncludes      []string
+	AllowWrite            bool
 }
 
 // Metadata config

internal/service/db_test/handler_db_test.go

@@ -12,6 +12,7 @@ import (
 	"testing"
 
 	"github.com/CrunchyData/pg_featureserv/internal/api"
+	"github.com/CrunchyData/pg_featureserv/internal/conf"
 	"github.com/CrunchyData/pg_featureserv/internal/data"
 	"github.com/CrunchyData/pg_featureserv/internal/service"
 	"github.com/CrunchyData/pg_featureserv/util"
@@ -23,6 +24,8 @@ var db *pgxpool.Pool
 var cat data.Catalog
 
 func TestMain(m *testing.M) {
+	conf.Configuration.Database.AllowWrite = true
+
 	db = util.CreateTestDb()
 	defer util.CloseTestDb(db)
 

internal/service/handler.go

@@ -61,9 +61,12 @@ func InitRouter(basePath string) *mux.Router {
 
 	addRoute(router, "/collections/{id}/items", handleCollectionItems)
 	addRoute(router, "/collections/{id}/items.{fmt}", handleCollectionItems)
-	addRouteWithMethod(router, "/collections/{id}/items", handleCreateCollectionItem, "POST")
 
-	addRoute(router, "/collections/{id}/schema", handleCollectionSchemas)
+	if conf.Configuration.Database.AllowWrite {
+		addRouteWithMethod(router, "/collections/{id}/items", handleCreateCollectionItem, "POST")
+
+		addRoute(router, "/collections/{id}/schema", handleCollectionSchemas)
+	}
 
 	addRoute(router, "/collections/{id}/items/{fid}", handleItem)
 	addRoute(router, "/collections/{id}/items/{fid}.{fmt}", handleItem)

internal/service/handler_test.go

@@ -24,6 +24,7 @@ import (
 	"testing"
 
 	"github.com/CrunchyData/pg_featureserv/internal/api"
+	"github.com/CrunchyData/pg_featureserv/internal/conf"
 	"github.com/CrunchyData/pg_featureserv/internal/data"
 	"github.com/CrunchyData/pg_featureserv/util"
 )
@@ -33,6 +34,8 @@ var hTest util.HttpTesting
 var catalogMock *data.CatalogMock
 
 func TestMain(m *testing.M) {
+	conf.Configuration.Database.AllowWrite = true
+
 	catalogMock = data.CatMockInstance()
 	catalogInstance = catalogMock