feat(api): unlockdb (#3730)

Signed-off-by: Yvonnick Esnault <[email protected]>

cli/cdsctl/admin.go

@@ -13,6 +13,7 @@ var adminCmd = cli.Command{
 
 func adminCommands() []*cobra.Command {
 	return []*cobra.Command{
+		adminDatabase(),
 		adminServices(),
 		adminHooks(),
 		adminPlatformModels(),

cli/cdsctl/admin_database.go

@@ -0,0 +1,30 @@
+package main
+
+import (
+	"github.com/spf13/cobra"
+
+	"github.com/ovh/cds/cli"
+)
+
+var adminDatabaseCmd = cli.Command{
+	Name:  "database",
+	Short: "Manage CDS Database",
+}
+
+func adminDatabase() *cobra.Command {
+	return cli.NewCommand(adminDatabaseCmd, nil, []*cobra.Command{
+		cli.NewCommand(adminDatabaseUnlockCmd, adminDatabaseUnlockFunc, nil),
+	})
+}
+
+var adminDatabaseUnlockCmd = cli.Command{
+	Name:  "unlock",
+	Short: "Unlock a pending migration (Use with caution)",
+	Args: []cli.Arg{
+		{Name: "id"},
+	},
+}
+
+func adminDatabaseUnlockFunc(v cli.Values) error {
+	return client.AdminDatabaseMigrationUnlock(v.GetString("id"))
+}

engine/api/api_routes.go

@@ -44,6 +44,7 @@ func (api *API) InitRouter() {
 	// Admin
 	r.Handle("/admin/maintenance", r.POST(api.postMaintenanceHandler, NeedAdmin(true)))
 	r.Handle("/admin/warning", r.DELETE(api.adminTruncateWarningsHandler, NeedAdmin(true)))
+	r.Handle("/admin/database/migration/unlock/{id}", r.POST(api.postMigrationUnlockedHandler, NeedAdmin(true)))
 	r.Handle("/admin/debug", r.GET(api.getProfileIndexHandler, Auth(false)))
 	r.Handle("/admin/debug/trace", r.POST(api.getTraceHandler, NeedAdmin(true)), r.GET(api.getTraceHandler, NeedAdmin(true)))
 	r.Handle("/admin/debug/cpu", r.POST(api.getCPUProfileHandler, NeedAdmin(true)), r.GET(api.getCPUProfileHandler, NeedAdmin(true)))

engine/api/database.go

@@ -0,0 +1,25 @@
+package api
+
+import (
+	"context"
+	"net/http"
+
+	"github.com/gorilla/mux"
+
+	"github.com/ovh/cds/engine/api/database/dbmigrate"
+	"github.com/ovh/cds/engine/service"
+	"github.com/ovh/cds/sdk"
+)
+
+func (api *API) postMigrationUnlockedHandler() service.Handler {
+	return func(ctx context.Context, w http.ResponseWriter, r *http.Request) error {
+		vars := mux.Vars(r)
+		id := vars["id"]
+
+		if len(id) == 0 {
+			return sdk.NewErrorFrom(sdk.ErrWrongRequest, "Id is mandatory. Check id from table gorp_migrations_lock")
+		}
+
+		return dbmigrate.UnlockMigrate(api.mustDB().Db, id)
+	}
+}

engine/api/database/dbmigrate/migrate.go

@@ -37,7 +37,7 @@ func Do(DBFunc func() *sql.DB, sqlMigrateDir string, dir migrate.MigrationDirect
 
 	_, errExec := migrate.ExecMax(DBFunc(), "postgres", source, dir, limit)
 
-	if err := unlockMigrate(DBFunc(), hostname); err != nil {
+	if err := UnlockMigrate(DBFunc(), hostname); err != nil {
 		return nil, fmt.Errorf("Cannot unlock migration: %v", err)
 	}
 
@@ -100,7 +100,8 @@ func lockMigrate(db *sql.DB, id string) error {
 	return nil
 }
 
-func unlockMigrate(db *sql.DB, id string) error {
+// UnlockMigrate unlocks an ID from table gorp_migrations_lock
+func UnlockMigrate(db *sql.DB, id string) error {
 	// construct a gorp DbMap
 	dbmap := &gorp.DbMap{Db: db, Dialect: gorp.PostgresDialect{}}
 	dbmap.AddTableWithName(MigrationLock{}, "gorp_migrations_lock").SetKeys(false, "ID")

engine/api/scheduler.go

@@ -30,8 +30,7 @@ func (api *API) getSchedulerApplicationPipelineHandler() service.Handler {
 		///Load application
 		app, errA := application.LoadByName(api.mustDB(), api.Cache, key, appName, getUser(ctx))
 		if errA != nil {
-			return sdk.WrapError(errA, "getSchedulerApplicationPipelineHandler> Cannot load application %s for project %s from db", appName, key)
-
+			return sdk.WrapError(errA, "Cannot load application %s for project %s from db", appName, key)
 		}
 
 		//Load pipeline
@@ -43,9 +42,9 @@ func (api *API) getSchedulerApplicationPipelineHandler() service.Handler {
 
 		//Load environment
 		if err := r.ParseForm(); err != nil {
-			return sdk.WrapError(sdk.ErrWrongRequest, "getSchedulerApplicationPipelineHandler> Cannot parse form")
-
+			return sdk.NewErrorFrom(sdk.ErrWrongRequest, "Cannot parse form")
 		}
+
 		envName := r.Form.Get("envName")
 		var env *sdk.Environment
 		if envName != "" {

sdk/cdsclient/client_admin.go

@@ -8,6 +8,11 @@ import (
 	"github.com/ovh/cds/sdk"
 )
 
+func (c *client) AdminDatabaseMigrationUnlock(id string) error {
+	_, _, _, err := c.Request(context.Background(), "POST", "/admin/database/migration/unlock/"+id, nil)
+	return err
+}
+
 func (c *client) Services() ([]sdk.Service, error) {
 	srvs := []sdk.Service{}
 	if _, err := c.GetJSON(context.Background(), "/admin/services", &srvs); err != nil {

sdk/cdsclient/interface.go

@@ -27,6 +27,7 @@ type TemplateClient interface {
 
 // AdminService expose all function to CDS services
 type AdminService interface {
+	AdminDatabaseMigrationUnlock(id string) error
 	Services() ([]sdk.Service, error)
 	ServicesByName(name string) (*sdk.Service, error)
 	ServiceDelete(name string) error