Implement new step-by-step setup

endpoints/api/suconfig.py

@@ -1,19 +1,22 @@
 import logging
 import os
 import json
+import signal
 
-from flask import abort
+from flask import abort, Response
 from endpoints.api import (ApiResource, nickname, resource, internal_only, show_if,
                            require_fresh_login, request, validate_json_request, verify_not_prod)
 
 from endpoints.common import common_login
 from app import app, CONFIG_PROVIDER, superusers
 from data import model
+from data.database import configure
 from auth.permissions import SuperUserPermission
 from auth.auth_context import get_authenticated_user
 from data.database import User
 from util.config.configutil import add_enterprise_config_defaults
 from util.config.validator import validate_service_for_config, SSL_FILENAMES
+from data.runmigration import run_alembic_migration
 
 import features
 
@@ -21,12 +24,16 @@ logger = logging.getLogger(__name__)
 
 def database_is_valid():
   """ Returns whether the database, as configured, is valid. """
+  if app.config['TESTING']:
+    return False
+
   try:
-    User.select().limit(1)
+    list(User.select().limit(1))
     return True
   except:
     return False
 
+
 def database_has_users():
   """ Returns whether the database has any users defined. """
   return bool(list(User.select().limit(1)))
@@ -42,17 +49,107 @@ class SuperUserRegistryStatus(ApiResource):
   @nickname('scRegistryStatus')
   @verify_not_prod
   def get(self):
-    """ Returns whether a valid configuration, database and users exist. """
-    file_exists = CONFIG_PROVIDER.yaml_exists()
+    """ Returns the status of the registry. """
+    # If there is no conf/stack volume, then report that status.
+    if not CONFIG_PROVIDER.volume_exists():
+      return {
+        'status': 'missing-config-dir'
+      }
+
+    # If there is no config file, we need to setup the database.
+    if not CONFIG_PROVIDER.yaml_exists():
+      return {
+        'status': 'config-db'
+      }
+
+    # If the database isn't yet valid, then we need to set it up.
+    if not database_is_valid():
+      return {
+        'status': 'setup-db'
+      }
+
+    # If we have SETUP_COMPLETE, then we're ready to go!
+    if app.config.get('SETUP_COMPLETE', False):
+      return {
+        'requires_restart': CONFIG_PROVIDER.requires_restart(app.config),
+        'status': 'ready'
+      }
+
     return {
-      'dir_exists': CONFIG_PROVIDER.volume_exists(),
-      'file_exists': file_exists,
-      'is_testing': app.config['TESTING'],
-      'valid_db': database_is_valid(),
-      'ready': not app.config['TESTING'] and file_exists and superusers.has_superusers()
+      'status': 'create-superuser' if not database_has_users() else 'config'
     }
 
 
+class _AlembicLogHandler(logging.Handler):
+  def __init__(self):
+    super(_AlembicLogHandler, self).__init__()
+    self.records = []
+
+  def emit(self, record):
+    self.records.append({
+      'level': record.levelname,
+      'message': record.getMessage()
+    })
+
+@resource('/v1/superuser/setupdb')
+@internal_only
+@show_if(features.SUPER_USERS)
+class SuperUserSetupDatabase(ApiResource):
+  """ Resource for invoking alembic to setup the database. """
+  @verify_not_prod
+  @nickname('scSetupDatabase')
+  def get(self):
+    """ Invokes the alembic upgrade process. """
+    # Note: This method is called after the database configured is saved, but before the
+    # database has any tables. Therefore, we only allow it to be run in that unique case.
+    if CONFIG_PROVIDER.yaml_exists() and not database_is_valid():
+      # Note: We need to reconfigure the database here as the config has changed.
+      combined = dict(**app.config)
+      combined.update(CONFIG_PROVIDER.get_yaml())
+
+      configure(combined)
+      app.config['DB_URI'] = combined['DB_URI']
+
+      log_handler = _AlembicLogHandler()
+
+      try:
+        run_alembic_migration(log_handler)
+      except Exception as ex:
+        return {
+          'error': str(ex)
+        }
+
+      return {
+        'logs': log_handler.records
+      }
+
+    abort(403)
+
+
+
+@resource('/v1/superuser/shutdown')
+@internal_only
+@show_if(features.SUPER_USERS)
+class SuperUserShutdown(ApiResource):
+  """ Resource for sending a shutdown signal to the container. """
+
+  @verify_not_prod
+  @nickname('scShutdownContainer')
+  def post(self):
+    """ Sends a signal to the phusion init system to shut down the container. """
+    # Note: This method is called to set the database configuration before super users exists,
+    # so we also allow it to be called if there is no valid registry configuration setup.
+    if app.config['TESTING'] or not database_has_users() or SuperUserPermission().can():
+      # Note: We skip if debugging locally.
+      if app.config.get('DEBUGGING') == True:
+        return {}
+
+      os.kill(1, signal.SIGINT)
+      return {}
+
+    abort(403)
+
+
 @resource('/v1/superuser/config')
 @internal_only
 @show_if(features.SUPER_USERS)