feat(cdsctl): cdsctl admin database for cdn service (#5930)

* feat: cdsctl admin database for cdn service

$ cdsctl admin database unlock api id-to-unlock
$ cdsctl admin database unlock cdn id-to-unlock
$ cdsctl admin database delete api id-migration-to-delete
$ cdsctl admin database delete cdn id-migration-to-delete
$ cdsctl admin database list api
$ cdsctl admin database list cdn

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

Author: yesnault

cli/cdsctl/admin_database.go

@@ -29,34 +29,66 @@ func adminDatabase() *cobra.Command {
 var adminDatabaseUnlockCmd = cli.Command{
 	Name:  "unlock",
 	Short: "Unlock a pending migration (Use with caution)",
+	Example: `
+$ cdsctl admin database unlock api id-to-unlock
+$ cdsctl admin database unlock cdn id-to-unlock
+	`,
 	Args: []cli.Arg{
+		{
+			Name: argServiceName,
+			IsValid: func(s string) bool {
+				return s == sdk.TypeCDN || s == sdk.TypeAPI
+			},
+		},
 		{Name: "id"},
 	},
 }
 
-func adminDatabaseUnlockFunc(v cli.Values) error {
-	return client.AdminDatabaseMigrationUnlock(v.GetString("id"))
+func adminDatabaseUnlockFunc(args cli.Values) error {
+	return client.AdminDatabaseMigrationUnlock(args.GetString(argServiceName), args.GetString("id"))
 }
 
 var adminDatabaseDeleteMigrationCmd = cli.Command{
 	Name:  "delete",
 	Short: "Delete a database migration from table gorp_migration (use with caution)",
+	Example: `
+$ cdsctl admin database delete api id-migration-to-delete
+$ cdsctl admin database delete cdn id-migration-to-delete
+	`,
 	Args: []cli.Arg{
+		{
+			Name: argServiceName,
+			IsValid: func(s string) bool {
+				return s == sdk.TypeCDN || s == sdk.TypeAPI
+			},
+		},
 		{Name: "id"},
 	},
 }
 
-func adminDatabaseDeleteFunc(v cli.Values) error {
-	return client.AdminDatabaseMigrationDelete(v.GetString("id"))
+func adminDatabaseDeleteFunc(args cli.Values) error {
+	return client.AdminDatabaseMigrationDelete(args.GetString(argServiceName), args.GetString("id"))
 }
 
 var adminDatabaseMigrationsList = cli.Command{
 	Name:  "list",
 	Short: "List all CDS DB migrations",
+	Example: `
+$ cdsctl admin database list api
+$ cdsctl admin database list cdn
+	`,
+	Args: []cli.Arg{
+		{
+			Name: argServiceName,
+			IsValid: func(s string) bool {
+				return s == sdk.TypeCDN || s == sdk.TypeAPI
+			},
+		},
+	},
 }
 
-func adminDatabaseMigrationsListFunc(_ cli.Values) (cli.ListResult, error) {
-	migrations, err := client.AdminDatabaseMigrationsList()
+func adminDatabaseMigrationsListFunc(args cli.Values) (cli.ListResult, error) {
+	migrations, err := client.AdminDatabaseMigrationsList(args.GetString(argServiceName))
 	if err != nil {
 		return nil, err
 	}

docker-compose.yml

@@ -72,11 +72,10 @@ services:
             cdn.storageUnits.buffers.redis.redis.password=cds \
             cdn.storageUnits.buffers.local-buffer.local.path=/app/cdn-buffer \
             cdn.storageUnits.storages.local.local.path=/app/cdn-storage \
-            cdn.storageUnits.storages.cds.cds.host=http://cds-api:8081 \
             cdn.database.host=cds-db \
             cdn.publicTCP=${HOSTNAME}:8090 \
             cdn.api.http.url=http://cds-api:8081 \
-            cdn.url=http://cds-cdn:8089 \
+            cdn.URL=http://cds-cdn:8089 \
             hatchery.local.commonConfiguration.url=http://cds-hatchery-local:8086 \
             hatchery.local.commonConfiguration.api.http.url=http://cds-api:8081 \
             hatchery.local.basedir=/app/hatchery-local \

engine/api/admin.go

@@ -181,6 +181,18 @@ func putPostAdminServiceCallHandler(api *API, method string) service.Handler {
 	}
 }
 
+func (api *API) deleteDatabaseMigrationHandler() service.Handler {
+	return database.AdminDeleteDatabaseMigration(api.mustDB)
+}
+
+func (api *API) postDatabaseMigrationUnlockedHandler() service.Handler {
+	return database.AdminDatabaseMigrationUnlocked(api.mustDB)
+}
+
+func (api *API) getDatabaseMigrationHandler() service.Handler {
+	return database.AdminGetDatabaseMigration(api.mustDB)
+}
+
 func (api *API) getAdminDatabaseSignatureResume() service.Handler {
 	return database.AdminDatabaseSignatureResume(api.mustDB, gorpmapping.Mapper)
 }

engine/api/database.go

@@ -5,6 +5,18 @@ import (
 	"github.com/ovh/cds/engine/service"
 )
 
+func (s *Service) deleteDatabaseMigrationHandler() service.Handler {
+	return database.AdminDeleteDatabaseMigration(s.mustDB)
+}
+
+func (s *Service) postDatabaseMigrationUnlockedHandler() service.Handler {
+	return database.AdminDatabaseMigrationUnlocked(s.mustDB)
+}
+
+func (s *Service) getDatabaseMigrationHandler() service.Handler {
+	return database.AdminGetDatabaseMigration(s.mustDB)
+}
+
 func (s *Service) getAdminDatabaseSignatureResume() service.Handler {
 	return database.AdminDatabaseSignatureResume(s.mustDB, s.Mapper)
 }

engine/cdn/cdn_admin.go

@@ -46,6 +46,10 @@ func (s *Service) initRouter(ctx context.Context) {
 
 	r.Handle("/size/item/project/{projectKey}", nil, r.GET(s.getSizeByProjectHandler))
 
+	r.Handle("/admin/database/migration/delete/{id}", nil, r.DELETE(s.deleteDatabaseMigrationHandler))
+	r.Handle("/admin/database/migration/unlock/{id}", nil, r.POST(s.postDatabaseMigrationUnlockedHandler))
+	r.Handle("/admin/database/migration", nil, r.GET(s.getDatabaseMigrationHandler))
+
 	r.Handle("/admin/database/signature", nil, r.GET(s.getAdminDatabaseSignatureResume))
 	r.Handle("/admin/database/signature/{entity}/roll/{pk}", nil, r.POST(s.postAdminDatabaseSignatureRollEntityByPrimaryKey))
 	r.Handle("/admin/database/signature/{entity}/{signer}", nil, r.GET(s.getAdminDatabaseSignatureTuplesBySigner))

engine/cdn/cdn_router.go

@@ -18,8 +18,8 @@ import (
 	migrate "github.com/rubenv/sql-migrate"
 	"github.com/spf13/cobra"
 
-	"github.com/ovh/cds/engine/api/database/dbmigrate"
 	"github.com/ovh/cds/engine/database"
+	"github.com/ovh/cds/engine/database/dbmigrate"
 	"github.com/ovh/cds/sdk"
 	"github.com/ovh/cds/sdk/cdsclient"
 )

engine/cmd_database.go

@@ -7,13 +7,50 @@ import (
 	"github.com/go-gorp/gorp"
 	"github.com/gorilla/mux"
 
+	"github.com/ovh/cds/engine/database/dbmigrate"
 	"github.com/ovh/cds/engine/gorpmapper"
 	"github.com/ovh/cds/engine/service"
 	"github.com/ovh/cds/sdk"
 )
 
 type DBFunc func() *gorp.DbMap
 
+func AdminDeleteDatabaseMigration(db DBFunc) 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")
+		}
+
+		return dbmigrate.DeleteMigrate(db().Db, id)
+	}
+}
+
+func AdminDatabaseMigrationUnlocked(db DBFunc) 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(db().Db, id, gorp.PostgresDialect{})
+	}
+}
+
+func AdminGetDatabaseMigration(db DBFunc) service.Handler {
+	return func(ctx context.Context, w http.ResponseWriter, r *http.Request) error {
+		a, err := dbmigrate.List(db().Db)
+		if err != nil {
+			return sdk.WrapError(err, "Cannot load database migration list %d", err)
+		}
+		return service.WriteJSON(w, a, http.StatusOK)
+	}
+}
+
 func AdminDatabaseSignatureResume(db DBFunc, mapper *gorpmapper.Mapper) service.Handler {
 	return func(ctx context.Context, w http.ResponseWriter, r *http.Request) error {
 		var entities = mapper.ListSignedEntities()

engine/api/database/dbmigrate/migrate.go renamed to engine/database/dbmigrate/migrate.go

@@ -10,8 +10,8 @@ import (
 	"github.com/rockbears/log"
 	migrate "github.com/rubenv/sql-migrate"
 
-	"github.com/ovh/cds/engine/api/database/dbmigrate"
 	"github.com/ovh/cds/engine/database"
+	"github.com/ovh/cds/engine/database/dbmigrate"
 	"github.com/ovh/cds/sdk"
 )