bootstrap: allow setting certain env flags for usage in CLI scripts.

- we can catch that later in pyramid and skip certain heavy actions to speed-up CLI invokation

rhodecode/apps/ssh_support/lib/ssh_wrapper.py

@@ -1,81 +1,81 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2016-2018 RhodeCode GmbH
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License, version 3
 # (only), as published by the Free Software Foundation.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 # This program is dual-licensed. If you wish to learn more about the
 # RhodeCode Enterprise Edition, including its added features, Support services,
 # and proprietary license terms, please see https://rhodecode.com/licenses/
 
 import os
 import sys
 import logging
 
 import click
 
 from pyramid.paster import setup_logging
 
 from rhodecode.lib.pyramid_utils import bootstrap
 from .backends import SshWrapper
 
 log = logging.getLogger(__name__)
 
 
 def setup_custom_logging(ini_path, debug):
     if debug:
         # enabled rhodecode.ini controlled logging setup
         setup_logging(ini_path)
     else:
         # configure logging in a mode that doesn't print anything.
         # in case of regularly configured logging it gets printed out back
         # to the client doing an SSH command.
         logger = logging.getLogger('')
         null = logging.NullHandler()
         # add the handler to the root logger
         logger.handlers = [null]
 
 
 @click.command()
 @click.argument('ini_path', type=click.Path(exists=True))
 @click.option(
     '--mode', '-m', required=False, default='auto',
     type=click.Choice(['auto', 'vcs', 'git', 'hg', 'svn', 'test']),
     help='mode of operation')
 @click.option('--user', help='Username for which the command will be executed')
 @click.option('--user-id', help='User ID for which the command will be executed')
 @click.option('--key-id', help='ID of the key from the database')
 @click.option('--shell', '-s', is_flag=True, help='Allow Shell')
 @click.option('--debug', is_flag=True, help='Enabled detailed output logging')
 def main(ini_path, mode, user, user_id, key_id, shell, debug):
     setup_custom_logging(ini_path, debug)
 
     command = os.environ.get('SSH_ORIGINAL_COMMAND', '')
     if not command and mode not in ['test']:
         raise ValueError(
             'Unable to fetch SSH_ORIGINAL_COMMAND from environment.'
             'Please make sure this is set and available during execution '
             'of this script.')
     connection_info = os.environ.get('SSH_CONNECTION', '')
 
-    with bootstrap(ini_path) as env:
+    with bootstrap(ini_path, env={'RC_CMD_SSH_WRAPPER': '1'}) as env:
         try:
             ssh_wrapper = SshWrapper(
                 command, connection_info, mode,
                 user, user_id, key_id, shell, ini_path, env)
         except Exception:
             log.exception('Failed to execute SshWrapper')
             sys.exit(-5)
 
         return_code = ssh_wrapper.wrap()
         sys.exit(return_code)

rhodecode/lib/pyramid_utils.py

@@ -1,56 +1,58 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2016-2018 RhodeCode GmbH
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License, version 3
 # (only), as published by the Free Software Foundation.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 # This program is dual-licensed. If you wish to learn more about the
 # RhodeCode Enterprise Edition, including its added features, Support services,
 # and proprietary license terms, please see https://rhodecode.com/licenses/
 
 import os
 from pyramid.compat import configparser
 from pyramid.paster import bootstrap as pyramid_bootstrap, setup_logging  # noqa
 from pyramid.request import Request
 from pyramid.scripting import prepare
 
 
 def get_config(ini_path, **kwargs):
     parser = configparser.ConfigParser(**kwargs)
     parser.read(ini_path)
     return parser
 
 
 def get_app_config(ini_path):
     from paste.deploy.loadwsgi import appconfig
     return appconfig('config:{}'.format(ini_path), relative_to=os.getcwd())
 
 
-def bootstrap(config_uri, request=None, options=None):
+def bootstrap(config_uri, request=None, options=None, env=None):
+    if env:
+        os.environ.update(env)
 
     config = get_config(config_uri)
     base_url = 'http://rhodecode.local'
     try:
         base_url = config.get('app:main', 'app.base_url')
     except (configparser.NoSectionError, configparser.NoOptionError):
         pass
 
     request = request or Request.blank('/', base_url=base_url)
 
     return pyramid_bootstrap(config_uri, request=request, options=options)
 
 
 def prepare_request(environ):
     request = Request.blank('/', environ=environ)
     prepare(request)  # set pyramid threadlocal request
     return request

rhodecode/lib/rc_commands/setup_rc.py

@@ -1,103 +1,103 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2016-2018 RhodeCode GmbH
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License, version 3
 # (only), as published by the Free Software Foundation.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 # This program is dual-licensed. If you wish to learn more about the
 # RhodeCode Enterprise Edition, including its added features, Support services,
 # and proprietary license terms, please see https://rhodecode.com/licenses/
 import logging
 
 import click
 import pyramid.paster
 
 from rhodecode.lib.pyramid_utils import bootstrap, get_app_config
 from rhodecode.lib.db_manage import DbManage
 from rhodecode.model.db import Session
 
 
 log = logging.getLogger(__name__)
 
 
 @click.command()
 @click.argument('ini_path', type=click.Path(exists=True))
 @click.option(
     '--force-yes/--force-no', default=None,
     help="Force yes/no to every question")
 @click.option(
     '--user',
     default=None,
     help='Initial super-admin username')
 @click.option(
     '--email',
     default=None,
     help='Initial super-admin email address.')
 @click.option(
     '--password',
     default=None,
     help='Initial super-admin password. Minimum 6 chars.')
 @click.option(
     '--api-key',
     help='Initial API key for the admin user')
 @click.option(
     '--repos',
     default=None,
     help='Absolute path to storage location. This is storage for all '
          'existing and future repositories, and repository groups.')
 @click.option(
     '--public-access/--no-public-access',
     default=None,
     help='Enable public access on this installation. '
          'Default is public access enabled.')
 def main(ini_path, force_yes, user, email, password, api_key, repos,
          public_access):
     return command(ini_path, force_yes, user, email, password, api_key,
                    repos, public_access)
 
 
 def command(ini_path, force_yes, user, email, password, api_key, repos,
             public_access):
     # mapping of old parameters to new CLI from click
     options = dict(
         username=user,
         email=email,
         password=password,
         api_key=api_key,
         repos_location=repos,
         force_ask=force_yes,
         public_access=public_access
     )
     pyramid.paster.setup_logging(ini_path)
 
     config = get_app_config(ini_path)
 
     db_uri = config['sqlalchemy.db1.url']
     dbmanage = DbManage(log_sql=True, dbconf=db_uri, root='.',
                         tests=False, cli_args=options)
     dbmanage.create_tables(override=True)
     dbmanage.set_db_version()
     opts = dbmanage.config_prompt(None)
     dbmanage.create_settings(opts)
     dbmanage.create_default_user()
     dbmanage.create_admin_and_prompt()
     dbmanage.create_permissions()
     dbmanage.populate_default_permissions()
     Session().commit()
 
-    with bootstrap(ini_path) as env:
+    with bootstrap(ini_path, env={'RC_CMD_SETUP_RC': '1'}) as env:
         msg = 'Successfully initialized database, schema and default data.'
         print()
         print('*' * len(msg))
         print(msg.upper())
         print('*' * len(msg))

rhodecode/lib/rc_commands/upgrade_db.py

@@ -1,52 +1,52 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2016-2018 RhodeCode GmbH
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License, version 3
 # (only), as published by the Free Software Foundation.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 # This program is dual-licensed. If you wish to learn more about the
 # RhodeCode Enterprise Edition, including its added features, Support services,
 # and proprietary license terms, please see https://rhodecode.com/licenses/
 
 import logging
 
 import click
 import pyramid.paster
 
 from rhodecode.lib.pyramid_utils import bootstrap
 from rhodecode.lib.db_manage import DbManage
 
 log = logging.getLogger(__name__)
 
 
 @click.command()
 @click.argument('ini_path', type=click.Path(exists=True))
 @click.option('--force-yes/--force-no', default=None,
               help="Force yes/no to every question")
 def main(ini_path, force_yes):
     return command(ini_path, force_yes)
 
 
 def command(ini_path, force_yes):
     pyramid.paster.setup_logging(ini_path)
 
-    with bootstrap(ini_path) as env:
+    with bootstrap(ini_path, env={'RC_CMD_UPGRADE_DB': '1'}) as env:
         config = env['registry'].settings
         db_uri = config['sqlalchemy.db1.url']
         options = {}
         if force_yes is not None:
             options['force_ask'] = force_yes
         dbmanage = DbManage(
             log_sql=True, dbconf=db_uri, root='.', tests=False,
             cli_args=options)
         dbmanage.upgrade()