_cmd.py 54.2 KB
Newer Older
R
Rongfeng Fu 已提交
1

O
oceanbase-admin 已提交
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
# coding: utf-8
# OceanBase Deploy.
# Copyright (C) 2021 OceanBase
#
# This file is part of OceanBase Deploy.
#
# OceanBase Deploy is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# OceanBase Deploy 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 General Public License
# along with OceanBase Deploy.  If not, see <https://www.gnu.org/licenses/>.


from __future__ import absolute_import, division, print_function

import os
import sys
import time
import logging
from logging import handlers
from uuid import uuid1 as uuid
R
Rongfeng Fu 已提交
30
from optparse import OptionParser, OptionGroup, BadOptionError, Option
O
oceanbase-admin 已提交
31 32 33 34

from core import ObdHome
from _stdio import IO
from log import Logger
F
v1.5.0  
frf12 已提交
35
from tool import DirectoryUtil, FileUtil, COMMAND_ENV
R
Rongfeng Fu 已提交
36
from _errno import DOC_LINK_MSG, LockError
O
oceanbase-admin 已提交
37 38 39


ROOT_IO = IO(1)
F
v1.5.0  
frf12 已提交
40
VERSION = '<VERSION>'
R
Rongfeng Fu 已提交
41 42 43
REVISION = '<CID>'
BUILD_BRANCH = '<B_BRANCH>'
BUILD_TIME = '<B_TIME>'
R
Rongfeng Fu 已提交
44
DEBUG = True if '<DEBUG>' else False
O
oceanbase-admin 已提交
45

F
v1.5.0  
frf12 已提交
46 47 48 49 50 51 52 53
CONST_OBD_HOME = "OBD_HOME"
CONST_OBD_INSTALL_PRE = "OBD_INSTALL_PRE"
FORBIDDEN_VARS = (CONST_OBD_HOME, CONST_OBD_INSTALL_PRE)

OBD_HOME_PATH = os.path.join(os.environ.get(CONST_OBD_HOME, os.getenv('HOME')), '.obd')
COMMAND_ENV.load(os.path.join(OBD_HOME_PATH, '.obd_environ'), ROOT_IO)
DEV_MODE = "OBD_DEV_MODE"

O
oceanbase-admin 已提交
54

R
Rongfeng Fu 已提交
55
class AllowUndefinedOptionParser(OptionParser):
F
v1.5.0  
frf12 已提交
56
    IS_TTY = sys.stdin.isatty()
R
Rongfeng Fu 已提交
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76

    def __init__(self,
                usage=None,
                option_list=None,
                option_class=Option,
                version=None,
                conflict_handler="error",
                description=None,
                formatter=None,
                add_help_option=True,
                prog=None,
                epilog=None,
                allow_undefine=True):
        OptionParser.__init__(
            self, usage, option_list, option_class, version, conflict_handler,
            description, formatter, add_help_option, prog, epilog
        )
        self.allow_undefine = allow_undefine

    def warn(self, msg, file=None):
F
v1.5.0  
frf12 已提交
77 78 79 80
        if self.IS_TTY:
            print("%s %s" % (IO.WARNING_PREV, msg))
        else:
            print('warn: %s' % msg)
R
Rongfeng Fu 已提交
81 82 83

    def _process_long_opt(self, rargs, values):
        try:
F
v1.4.0  
frf12 已提交
84
            value = rargs[0]
R
Rongfeng Fu 已提交
85 86 87
            OptionParser._process_long_opt(self, rargs, values)
        except BadOptionError as e:
            if self.allow_undefine:
F
v1.4.0  
frf12 已提交
88 89
                key = e.opt_str
                value = value[len(key)+1:]
F
frf12 已提交
90
                setattr(values, key.strip('-').replace('-', '_'), value if value != '' else True)
R
Rongfeng Fu 已提交
91 92 93 94 95 96
                return self.warn(e)
            else:
                raise e

    def _process_short_opts(self, rargs, values):
        try:
F
v1.4.0  
frf12 已提交
97
            value = rargs[0]
R
Rongfeng Fu 已提交
98 99 100
            OptionParser._process_short_opts(self, rargs, values)
        except BadOptionError as e:
            if self.allow_undefine:
F
v1.4.0  
frf12 已提交
101 102
                key = e.opt_str
                value = value[len(key)+1:]
F
v1.5.0  
frf12 已提交
103
                setattr(values, key.strip('-').replace('-', '_'),  value if value != '' else True)
R
Rongfeng Fu 已提交
104 105 106 107 108
                return self.warn(e)
            else:
                raise e


O
oceanbase-admin 已提交
109 110 111 112 113 114 115 116 117 118
class BaseCommand(object):

    def __init__(self, name, summary):
        self.name = name
        self.summary = summary
        self.args = []
        self.cmds = []
        self.opts = {}
        self.prev_cmd = ''
        self.is_init = False
R
Rongfeng Fu 已提交
119 120
        self.hidden = False
        self.parser = AllowUndefinedOptionParser(add_help_option=False)
R
Rongfeng Fu 已提交
121 122
        self.parser.add_option('-h', '--help', action='callback', callback=self._show_help, help='Show help and exit.')
        self.parser.add_option('-v', '--verbose', action='callback', callback=self._set_verbose, help='Activate verbose output.')
O
oceanbase-admin 已提交
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155

    def _set_verbose(self, *args, **kwargs):
        ROOT_IO.set_verbose_level(0xfffffff)

    def init(self, cmd, args):
        if self.is_init is False:
            self.prev_cmd = cmd
            self.args = args
            self.is_init = True
            self.parser.prog = self.prev_cmd
            option_list = self.parser.option_list[2:]
            option_list.append(self.parser.option_list[0])
            option_list.append(self.parser.option_list[1])
            self.parser.option_list = option_list
        return self

    def parse_command(self):
        self.opts, self.cmds = self.parser.parse_args(self.args)
        return self.opts

    def do_command(self):
        raise NotImplementedError

    def _show_help(self, *args, **kwargs):
        ROOT_IO.print(self._mk_usage())
        self.parser.exit(1)

    def _mk_usage(self):
        return self.parser.format_help()


class ObdCommand(BaseCommand):

F
v1.5.0  
frf12 已提交
156 157
    OBD_PATH = OBD_HOME_PATH
    OBD_INSTALL_PRE = os.environ.get(CONST_OBD_INSTALL_PRE, '/')
O
oceanbase-admin 已提交
158 159 160 161 162 163 164

    def init_home(self):
        version_path = os.path.join(self.OBD_PATH, 'version')
        need_update = True
        version_fobj = FileUtil.open(version_path, 'a+', stdio=ROOT_IO)
        version_fobj.seek(0)
        version = version_fobj.read()
R
Rongfeng Fu 已提交
165
        if VERSION != version:
R
Rongfeng Fu 已提交
166 167 168 169 170 171
            for part in ['plugins', 'config_parser', 'mirror/remote']:
                obd_part_dir = os.path.join(self.OBD_PATH, part)
                if DirectoryUtil.mkdir(self.OBD_PATH):
                    root_part_path = os.path.join(self.OBD_INSTALL_PRE, 'usr/obd/', part)
                    if os.path.exists(root_part_path):
                        DirectoryUtil.copy(root_part_path, obd_part_dir, ROOT_IO)
O
oceanbase-admin 已提交
172 173 174 175 176 177
            version_fobj.seek(0)
            version_fobj.truncate()
            version_fobj.write(VERSION)
            version_fobj.flush()
        version_fobj.close()

R
Rongfeng Fu 已提交
178 179
    @property
    def dev_mode(self):
F
v1.5.0  
frf12 已提交
180 181 182 183 184
        return COMMAND_ENV.get(DEV_MODE) == "1"

    def parse_command(self):
        self.parser.allow_undefine = self.dev_mode
        return super(ObdCommand, self).parse_command()
R
Rongfeng Fu 已提交
185 186 187 188 189

    def parse_command(self):
        self.parser.allow_undefine = self.dev_mode
        return super(ObdCommand, self).parse_command()

O
oceanbase-admin 已提交
190 191 192
    def do_command(self):
        self.parse_command()
        self.init_home()
R
Rongfeng Fu 已提交
193 194
        trace_id = uuid()
        ret = False
O
oceanbase-admin 已提交
195 196 197 198 199 200
        try:
            log_dir = os.path.join(self.OBD_PATH, 'log')
            DirectoryUtil.mkdir(log_dir)
            log_path = os.path.join(log_dir, 'obd')
            logger = Logger('obd')
            handler = handlers.TimedRotatingFileHandler(log_path, when='midnight', interval=1, backupCount=30)
R
Rongfeng Fu 已提交
201
            handler.setFormatter(logging.Formatter("[%%(asctime)s.%%(msecs)03d] [%s] [%%(levelname)s] %%(message)s" % trace_id, "%Y-%m-%d %H:%M:%S"))
O
oceanbase-admin 已提交
202 203
            logger.addHandler(handler)
            ROOT_IO.trace_logger = logger
R
Rongfeng Fu 已提交
204
            obd = ObdHome(self.OBD_PATH, self.dev_mode, ROOT_IO)
O
oceanbase-admin 已提交
205
            ROOT_IO.track_limit += 1
R
Rongfeng Fu 已提交
206 207
            ROOT_IO.verbose('cmd: %s' % self.cmds)
            ROOT_IO.verbose('opts: %s' % self.opts)
R
Rongfeng Fu 已提交
208
            ret = self._do_command(obd)
R
Rongfeng Fu 已提交
209 210
            if not ret:
                ROOT_IO.print(DOC_LINK_MSG)
O
oceanbase-admin 已提交
211 212
        except NotImplementedError:
            ROOT_IO.exception('command \'%s\' is not implemented' % self.prev_cmd)
R
Rongfeng Fu 已提交
213
        except LockError:
R
Rongfeng Fu 已提交
214
            ROOT_IO.exception('Another app is currently holding the obd lock.')
O
oceanbase-admin 已提交
215 216
        except SystemExit:
            pass
F
v1.5.0  
frf12 已提交
217 218
        except KeyboardInterrupt:
            ROOT_IO.exception('Keyboard Interrupt')
O
oceanbase-admin 已提交
219
        except:
R
Rongfeng Fu 已提交
220 221
            e = sys.exc_info()[1]
            ROOT_IO.exception('Running Error: %s' % e)
R
Rongfeng Fu 已提交
222 223
        if DEBUG:
            ROOT_IO.print('Trace ID: %s' % trace_id)
R
Rongfeng Fu 已提交
224
        return ret
O
oceanbase-admin 已提交
225 226 227 228 229 230 231 232 233 234 235 236 237

    def _do_command(self, obd):
        raise NotImplementedError


class MajorCommand(BaseCommand):

    def __init__(self, name, summary):
        super(MajorCommand, self).__init__(name, summary)
        self.commands = {}

    def _mk_usage(self):
        if self.commands:
R
Rongfeng Fu 已提交
238
            usage = ['%s <command> [options]\n\nAvailable commands:\n' % self.prev_cmd]
O
oceanbase-admin 已提交
239 240 241
            commands = [x for x in self.commands.values() if not (hasattr(x, 'hidden') and x.hidden)]
            commands.sort(key=lambda x: x.name)
            for command in commands:
R
Rongfeng Fu 已提交
242 243
                if command.hidden is False:
                    usage.append("%-14s %s\n" % (command.name, command.summary))
O
oceanbase-admin 已提交
244 245 246 247 248 249 250 251
            self.parser.set_usage('\n'.join(usage))
        return super(MajorCommand, self)._mk_usage()

    def do_command(self):
        if not self.is_init:
            ROOT_IO.error('%s command not init' % self.prev_cmd)
            raise SystemExit('command not init')
        if len(self.args) < 1:
R
Rongfeng Fu 已提交
252
            ROOT_IO.print('You need to give some commands.\n\nTry `obd --help` for more information.')
O
oceanbase-admin 已提交
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
            self._show_help()
            return False
        base, args = self.args[0], self.args[1:]
        if base not in self.commands:
            self.parse_command()
            self._show_help()
            return False
        cmd = '%s %s' % (self.prev_cmd, base)
        ROOT_IO.track_limit += 1
        return self.commands[base].init(cmd, args).do_command()
        
    def register_command(self, command):
        self.commands[command.name] = command


R
Rongfeng Fu 已提交
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296


class HiddenObdCommand(ObdCommand):

    def __init__(self, name, summary):
        super(HiddenObdCommand, self).__init__(name, summary)
        self.hidden = self.dev_mode is False


class HiddenMajorCommand(MajorCommand, HiddenObdCommand):

    pass


class DevCommand(HiddenObdCommand):

    def do_command(self):
        if self.hidden:
            ROOT_IO.error('`%s` is a developer command. Please start the developer mode first.\nUse `obd devmode enable` to start the developer mode' % self.prev_cmd)
            return False
        return super(DevCommand, self).do_command()


class DevModeEnableCommand(HiddenObdCommand):

    def __init__(self):
        super(DevModeEnableCommand, self).__init__('enable', 'Enable Dev Mode')

    def _do_command(self, obd):
F
v1.5.0  
frf12 已提交
297
        if COMMAND_ENV.set(DEV_MODE, "1", save=True, stdio=obd.stdio):
R
Rongfeng Fu 已提交
298 299 300 301 302 303 304 305 306 307 308
            obd.stdio.print("Dev Mode: ON")
            return True
        return False


class DevModeDisableCommand(HiddenObdCommand):

    def __init__(self):
        super(DevModeDisableCommand, self).__init__('disable', 'Disable Dev Mode')

    def _do_command(self, obd):
F
v1.5.0  
frf12 已提交
309
        if COMMAND_ENV.set(DEV_MODE, "0", save=True, stdio=obd.stdio):
R
Rongfeng Fu 已提交
310 311 312 313 314 315 316 317 318 319 320 321 322
            obd.stdio.print("Dev Mode: OFF")
            return True
        return False


class DevModeMajorCommand(HiddenMajorCommand):

    def __init__(self):
        super(DevModeMajorCommand, self).__init__('devmode', 'Developer mode switch')
        self.register_command(DevModeEnableCommand())
        self.register_command(DevModeDisableCommand())


F
v1.5.0  
frf12 已提交
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
class EnvironmentSetCommand(HiddenObdCommand):

    def __init__(self):
        super(EnvironmentSetCommand, self).__init__("set", "Set obd environment variable")

    def init(self, cmd, args):
        super(EnvironmentSetCommand, self).init(cmd, args)
        self.parser.set_usage('%s [key] [value]' % self.prev_cmd)
        return self

    def _do_command(self, obd):
        if len(self.cmds) == 2:
            key = self.cmds[0]
            if key in FORBIDDEN_VARS:
                obd.stdio.error("Set the environment variable {} is not allowed.".format(key))
                return False
            return COMMAND_ENV.set(key, self.cmds[1], save=True, stdio=obd.stdio)
        else:
            return self._show_help()


class EnvironmentUnsetCommand(HiddenObdCommand):

    def __init__(self):
        super(EnvironmentUnsetCommand, self).__init__("unset", "Unset obd environment variable")

    def init(self, cmd, args):
        super(EnvironmentUnsetCommand, self).init(cmd, args)
        self.parser.set_usage('%s [key] [value]' % self.prev_cmd)
        return self

    def _do_command(self, obd):
        if len(self.cmds) == 1:
            return COMMAND_ENV.delete(self.cmds[0], save=True, stdio=obd.stdio)
        else:
            return self._show_help()


class EnvironmentShowCommand(HiddenObdCommand):

    def __init__(self):
        super(EnvironmentShowCommand, self).__init__("show", "Show obd environment variables")
        self.parser.add_option('-A', '--all', action="store_true", help="Show all environment variables including system variables")

    def _do_command(self, obd):
        if self.opts.all:
            envs = COMMAND_ENV.copy().items()
        else:
            envs = COMMAND_ENV.show_env().items()
        obd.stdio.print_list(envs, ["Key", "Value"], title="Environ")
        return True


class EnvironmentClearCommand(HiddenObdCommand):

    def __init__(self):
        super(EnvironmentClearCommand, self).__init__("clear", "Clear obd environment variables")

    def _do_command(self, obd):
        return COMMAND_ENV.clear(stdio=obd.stdio)


class EnvironmentMajorCommand(HiddenMajorCommand):

    def __init__(self):
        super(EnvironmentMajorCommand, self).__init__('env', 'Environment variables for OBD')
        self.register_command(EnvironmentSetCommand())
        self.register_command(EnvironmentUnsetCommand())
        self.register_command(EnvironmentShowCommand())
        self.register_command(EnvironmentClearCommand())


O
oceanbase-admin 已提交
395 396 397
class MirrorCloneCommand(ObdCommand):

    def __init__(self):
R
Rongfeng Fu 已提交
398
        super(MirrorCloneCommand, self).__init__('clone', 'Clone an RPM package to the local mirror repository.')
R
Rongfeng Fu 已提交
399
        self.parser.add_option('-f', '--force', action='store_true', help="Force clone, overwrite the mirror.")
O
oceanbase-admin 已提交
400 401 402

    def init(self, cmd, args):
        super(MirrorCloneCommand, self).init(cmd, args)
R
Rongfeng Fu 已提交
403
        self.parser.set_usage('%s [mirror path] [options]' % self.prev_cmd)
O
oceanbase-admin 已提交
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
        return self

    def _do_command(self, obd):
        if self.cmds:
            for src in self.cmds:
                if not obd.add_mirror(src, self.opts):
                    return False
            return True
        else:
            return self._show_help()


class MirrorCreateCommand(ObdCommand):

    def __init__(self):
R
Rongfeng Fu 已提交
419
        super(MirrorCreateCommand, self).__init__('create', 'Create a local mirror by using the local binary file.')
O
oceanbase-admin 已提交
420
        self.parser.conflict_handler = 'resolve'
R
Rongfeng Fu 已提交
421 422 423 424 425
        self.parser.add_option('-n', '--name', type='string', help="Mirror name.")
        self.parser.add_option('-t', '--tag', type='string', help="Mirror tags. Multiple tags are separated with commas.")
        self.parser.add_option('-V', '--version', type='string', help="Mirror version.")
        self.parser.add_option('-p','--path', type='string', help="Mirror path. [./]", default='./')
        self.parser.add_option('-f', '--force', action='store_true', help="Force create, overwrite the mirror.")
O
oceanbase-admin 已提交
426 427 428 429 430 431 432 433 434
        self.parser.conflict_handler = 'error'

    def _do_command(self, obd):
        return obd.create_repository(self.opts)


class MirrorListCommand(ObdCommand):

    def __init__(self):
R
Rongfeng Fu 已提交
435
        super(MirrorListCommand, self).__init__('list', 'List mirrors.')
O
oceanbase-admin 已提交
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452

    def show_pkg(self, name, pkgs):
        ROOT_IO.print_list(
            pkgs, 
            ['name', 'version', 'release', 'arch', 'md5'], 
            lambda x: [x.name, x.version, x.release, x.arch, x.md5],
            title='%s Package List' % name
        )

    def _do_command(self, obd):
        if self.cmds:
            name = self.cmds[0]
            if name == 'local':
                pkgs = obd.mirror_manager.local_mirror.get_all_pkg_info()
                self.show_pkg(name, pkgs)
                return True
            else:
R
Rongfeng Fu 已提交
453
                repos = obd.mirror_manager.get_mirrors(is_enabled=None)
O
oceanbase-admin 已提交
454
                for repo in repos:
R
Rongfeng Fu 已提交
455
                    if repo.section_name == name:
R
Rongfeng Fu 已提交
456 457 458
                        if not repo.enabled:
                            ROOT_IO.error('Mirror repository %s is disabled.' % name)
                            return False
O
oceanbase-admin 已提交
459 460 461 462 463 464
                        pkgs = repo.get_all_pkg_info()
                        self.show_pkg(name, pkgs)
                        return True
                ROOT_IO.error('No such mirror repository: %s' % name)
                return False
        else:
R
Rongfeng Fu 已提交
465
            repos = obd.mirror_manager.get_mirrors(is_enabled=None)
O
oceanbase-admin 已提交
466
            ROOT_IO.print_list(
R
Rongfeng Fu 已提交
467
                repos,
F
v1.5.0  
frf12 已提交
468
                ['SectionName', 'Type', 'Enabled','Update Time'],
R
Rongfeng Fu 已提交
469
                lambda x: [x.section_name, x.mirror_type.value, x.enabled, time.strftime("%Y-%m-%d %H:%M", time.localtime(x.repo_age))],
O
oceanbase-admin 已提交
470 471 472 473 474 475 476 477
                title='Mirror Repository List'
            )
        return True


class MirrorUpdateCommand(ObdCommand):

    def __init__(self):
R
Rongfeng Fu 已提交
478
        super(MirrorUpdateCommand, self).__init__('update', 'Update remote mirror information.')
O
oceanbase-admin 已提交
479 480 481
    
    def _do_command(self, obd):
        success = True
R
Rongfeng Fu 已提交
482 483 484
        current = int(time.time())
        mirrors = obd.mirror_manager.get_remote_mirrors()
        for mirror in mirrors:
O
oceanbase-admin 已提交
485
            try:
R
Rongfeng Fu 已提交
486 487
                if mirror.enabled and mirror.repo_age < current:
                    success = mirror.update_mirror() and success
O
oceanbase-admin 已提交
488 489 490
            except:
                success = False
                ROOT_IO.stop_loading('fail')
R
Rongfeng Fu 已提交
491
                ROOT_IO.exception('Fail to synchronize mirorr (%s)' % mirror.name)
O
oceanbase-admin 已提交
492 493 494
        return success


R
Rongfeng Fu 已提交
495 496 497 498
class MirrorEnableCommand(ObdCommand):

    def __init__(self):
        super(MirrorEnableCommand, self).__init__('enable', 'Enable remote mirror repository.')
F
v1.5.0  
frf12 已提交
499

R
Rongfeng Fu 已提交
500 501
    def _do_command(self, obd):
        name = self.cmds[0]
R
Rongfeng Fu 已提交
502
        return obd.mirror_manager.set_remote_mirror_enabled(name, True)
R
Rongfeng Fu 已提交
503 504 505 506 507 508


class MirrorDisableCommand(ObdCommand):

    def __init__(self):
        super(MirrorDisableCommand, self).__init__('disable', 'Disable remote mirror repository.')
F
v1.5.0  
frf12 已提交
509

R
Rongfeng Fu 已提交
510 511
    def _do_command(self, obd):
        name = self.cmds[0]
R
Rongfeng Fu 已提交
512
        return obd.mirror_manager.set_remote_mirror_enabled(name, False)
R
Rongfeng Fu 已提交
513 514


O
oceanbase-admin 已提交
515 516 517
class MirrorMajorCommand(MajorCommand):

    def __init__(self):
R
Rongfeng Fu 已提交
518
        super(MirrorMajorCommand, self).__init__('mirror', 'Manage a component repository for OBD.')
O
oceanbase-admin 已提交
519 520 521 522
        self.register_command(MirrorListCommand())
        self.register_command(MirrorCloneCommand())
        self.register_command(MirrorCreateCommand())
        self.register_command(MirrorUpdateCommand())
R
Rongfeng Fu 已提交
523 524
        self.register_command(MirrorEnableCommand())
        self.register_command(MirrorDisableCommand())
O
oceanbase-admin 已提交
525 526


R
Rongfeng Fu 已提交
527 528 529 530 531 532 533 534 535 536
class RepositoryListCommand(ObdCommand):

    def __init__(self):
        super(RepositoryListCommand, self).__init__('list', 'List local repository.')

    def show_repo(self, repos, name=None):
        ROOT_IO.print_list(
            repos,
            ['name', 'version', 'release', 'arch', 'md5', 'tags'], 
            lambda x: [x.name, x.version, x.release, x.arch, x.md5, ', '.join(x.tags)],
F
v1.5.0  
frf12 已提交
537
            title='%s Local Repository List' % name if name else 'Local Repository List'
R
Rongfeng Fu 已提交
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
        )

    def _do_command(self, obd):
        name = self.cmds[0] if self.cmds else None
        repos = obd.repository_manager.get_repositories_view(name)
        self.show_repo(repos, name)
        return True


class RepositoryMajorCommand(MajorCommand):

    def __init__(self):
        super(RepositoryMajorCommand, self).__init__('repo', 'Manage local repository for OBD.')
        self.register_command(RepositoryListCommand())


O
oceanbase-admin 已提交
554 555 556 557
class ClusterMirrorCommand(ObdCommand):

    def init(self, cmd, args):
        super(ClusterMirrorCommand, self).init(cmd, args)
R
Rongfeng Fu 已提交
558
        self.parser.set_usage('%s <deploy name> [options]' % self.prev_cmd)
O
oceanbase-admin 已提交
559 560 561
        return self


R
Rongfeng Fu 已提交
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
class ClusterConfigStyleChange(ClusterMirrorCommand):

    def __init__(self):
        super(ClusterConfigStyleChange, self).__init__('chst', 'Change Deployment Configuration Style')
        self.parser.add_option('-c', '--components', type='string', help="List the components. Multiple components are separated with commas.")
        self.parser.add_option('--style', type='string', help="Preferred Style")

    def _do_command(self, obd):
        if self.cmds:
            return obd.change_deploy_config_style(self.cmds[0], self.opts)
        else:
            return self._show_help()



class ClusterCheckForOCPChange(ClusterMirrorCommand):

    def __init__(self):
        super(ClusterCheckForOCPChange, self).__init__('check4ocp', 'Check Whether OCP Can Take Over Configurations in Use')
        self.parser.add_option('-c', '--components', type='string', help="List the components. Multiple components are separated with commas.")
        self.parser.add_option('-V', '--version', type='string', help="OCP Version", default='3.1.1')

    def _do_command(self, obd):
        if self.cmds:
            return obd.check_for_ocp(self.cmds[0], self.opts)
        else:
            return self._show_help()


R
Rongfeng Fu 已提交
591 592 593 594 595 596
class ClusterAutoDeployCommand(ClusterMirrorCommand):

    def __init__(self):
        super(ClusterAutoDeployCommand, self).__init__('autodeploy', 'Deploy a cluster automatically by using a simple configuration file.')
        self.parser.add_option('-c', '--config', type='string', help="Path to the configuration file.")
        self.parser.add_option('-f', '--force', action='store_true', help="Force autodeploy, overwrite the home_path.")
F
v1.5.0  
frf12 已提交
597
        self.parser.add_option('-C', '--clean', action='store_true', help="Clean the home path if the directory belong to you.", default=False)
R
Rongfeng Fu 已提交
598
        self.parser.add_option('-U', '--unuselibrepo', '--ulp', action='store_true', help="Disable OBD from installing the libs mirror automatically.")
A
Amber Zhang 已提交
599
        self.parser.add_option('-A', '--auto-create-tenant', '--act', action='store_true', help="Automatically create a tenant named `test` by using all the available resource of the cluster.")
R
Rongfeng Fu 已提交
600 601 602 603 604
        self.parser.add_option('--force-delete', action='store_true', help="Force delete, delete the registered cluster.")
        self.parser.add_option('-s', '--strict-check', action='store_true', help="Throw errors instead of warnings when check fails.")

    def _do_command(self, obd):
        if self.cmds:
F
v1.5.0  
frf12 已提交
605 606
            if getattr(self.opts, 'force', False) or getattr(self.opts, 'clean', False):
                setattr(self.opts, 'skip_cluster_status_check', True)
R
Rongfeng Fu 已提交
607 608 609 610 611 612 613 614 615
            name = self.cmds[0]
            if obd.genconfig(name, self.opts):
                self.opts.config = ''
                return obd.deploy_cluster(name, self.opts) and obd.start_cluster(name, self.cmds[1:], self.opts)
            return False        
        else:
            return self._show_help()


O
oceanbase-admin 已提交
616 617 618
class ClusterDeployCommand(ClusterMirrorCommand):

    def __init__(self):
R
Rongfeng Fu 已提交
619 620 621
        super(ClusterDeployCommand, self).__init__('deploy', 'Deploy a cluster by using the current deploy configuration or a deploy yaml file.')
        self.parser.add_option('-c', '--config', type='string', help="Path to the configuration yaml file.")
        self.parser.add_option('-f', '--force', action='store_true', help="Force deploy, overwrite the home_path.", default=False)
F
v1.5.0  
frf12 已提交
622
        self.parser.add_option('-C', '--clean', action='store_true', help="Clean the home path if the directory belong to you.", default=False)
R
Rongfeng Fu 已提交
623
        self.parser.add_option('-U', '--unuselibrepo', '--ulp', action='store_true', help="Disable OBD from installing the libs mirror automatically.")
A
Amber Zhang 已提交
624
        self.parser.add_option('-A', '--auto-create-tenant', '--act', action='store_true', help="Automatically create a tenant named `test` by using all the available resource of the cluster.")
O
oceanbase-admin 已提交
625 626 627 628
        # self.parser.add_option('-F', '--fuzzymatch', action='store_true', help="enable fuzzy match when search package")

    def _do_command(self, obd):
        if self.cmds:
F
v1.5.0  
frf12 已提交
629 630
            if getattr(self.opts, 'force', False) or getattr(self.opts, 'clean', False):
                setattr(self.opts, 'skip_cluster_status_check', True)
O
oceanbase-admin 已提交
631 632 633 634 635 636 637 638
            return obd.deploy_cluster(self.cmds[0], self.opts)
        else:
            return self._show_help()


class ClusterStartCommand(ClusterMirrorCommand):

    def __init__(self):
R
Rongfeng Fu 已提交
639 640 641 642 643
        super(ClusterStartCommand, self).__init__('start', 'Start a deployed cluster.')
        self.parser.add_option('-s', '--servers', type='string', help="List the started servers. Multiple servers are separated with commas.")
        self.parser.add_option('-c', '--components', type='string', help="List the started components. Multiple components are separated with commas.")
        self.parser.add_option('-f', '--force-delete', action='store_true', help="Force delete, delete the registered cluster.")
        self.parser.add_option('-S', '--strict-check', action='store_true', help="Throw errors instead of warnings when check fails.")
R
Rongfeng Fu 已提交
644
        self.parser.add_option('--without-parameter', '--wop', action='store_true', help='Start without parameters.')
O
oceanbase-admin 已提交
645 646 647 648 649 650 651 652 653 654 655

    def _do_command(self, obd):
        if self.cmds:
            return obd.start_cluster(self.cmds[0], self.cmds[1:], self.opts)
        else:
            return self._show_help()


class ClusterStopCommand(ClusterMirrorCommand):

    def __init__(self):
R
Rongfeng Fu 已提交
656 657
        super(ClusterStopCommand, self).__init__('stop', 'Stop a started cluster.')
        self.parser.add_option('-s', '--servers', type='string', help="List the started servers. Multiple servers are separated with commas.")
R
Rongfeng Fu 已提交
658
        self.parser.add_option('-c', '--components', type='string', help="List the stoped components. Multiple components are separated with commas.")
O
oceanbase-admin 已提交
659 660 661

    def _do_command(self, obd):
        if self.cmds:
R
Rongfeng Fu 已提交
662
            return obd.stop_cluster(self.cmds[0], self.opts)
O
oceanbase-admin 已提交
663 664 665 666 667 668 669
        else:
            return self._show_help()


class ClusterDestroyCommand(ClusterMirrorCommand):

    def __init__(self):
R
Rongfeng Fu 已提交
670 671
        super(ClusterDestroyCommand, self).__init__('destroy', 'Destroy a deployed cluster.')
        self.parser.add_option('-f', '--force-kill', action='store_true', help="Force kill the running observer process in the working directory.")
O
oceanbase-admin 已提交
672 673 674 675 676 677 678 679 680 681 682

    def _do_command(self, obd):
        if self.cmds:
            return obd.destroy_cluster(self.cmds[0], self.opts)
        else:
            return self._show_help()


class ClusterDisplayCommand(ClusterMirrorCommand):

    def __init__(self):
R
Rongfeng Fu 已提交
683
        super(ClusterDisplayCommand, self).__init__('display', 'Display the information for a cluster.')
O
oceanbase-admin 已提交
684 685 686 687 688 689 690 691 692 693 694

    def _do_command(self, obd):
        if self.cmds:
            return obd.display_cluster(self.cmds[0])
        else:
            return self._show_help()


class ClusterRestartCommand(ClusterMirrorCommand):

    def __init__(self):
R
Rongfeng Fu 已提交
695 696
        super(ClusterRestartCommand, self).__init__('restart', 'Restart a started cluster.')
        self.parser.add_option('-s', '--servers', type='string', help="List the started servers. Multiple servers are separated with commas.")
R
Rongfeng Fu 已提交
697
        self.parser.add_option('-c', '--components', type='string', help="List the restarted components. Multiple components are separated with commas.")
R
Rongfeng Fu 已提交
698
        self.parser.add_option('--with-parameter', '--wp', action='store_true', help='Restart with parameters.')
O
oceanbase-admin 已提交
699 700 701

    def _do_command(self, obd):
        if self.cmds:
R
Rongfeng Fu 已提交
702 703
            if not getattr(self.opts, 'with_parameter', False):
                setattr(self.opts, 'without_parameter', True)
R
Rongfeng Fu 已提交
704
            return obd.restart_cluster(self.cmds[0], self.opts)
O
oceanbase-admin 已提交
705 706 707 708 709 710 711
        else:
            return self._show_help()


class ClusterRedeployCommand(ClusterMirrorCommand):

    def __init__(self):
R
Rongfeng Fu 已提交
712 713
        super(ClusterRedeployCommand, self).__init__('redeploy', 'Redeploy a started cluster.')
        self.parser.add_option('-f', '--force-kill', action='store_true', help="Force kill the running observer process in the working directory.")
O
oceanbase-admin 已提交
714 715 716

    def _do_command(self, obd):
        if self.cmds:
R
Rongfeng Fu 已提交
717
            return obd.redeploy_cluster(self.cmds[0], self.opts)
O
oceanbase-admin 已提交
718 719 720 721 722 723 724
        else:
            return self._show_help()


class ClusterReloadCommand(ClusterMirrorCommand):

    def __init__(self):
R
Rongfeng Fu 已提交
725
        super(ClusterReloadCommand, self).__init__('reload', 'Reload a started cluster.')
O
oceanbase-admin 已提交
726 727 728 729 730 731 732 733 734 735 736

    def _do_command(self, obd):
        if self.cmds:
            return obd.reload_cluster(self.cmds[0])
        else:
            return self._show_help()


class ClusterListCommand(ClusterMirrorCommand):

    def __init__(self):
R
Rongfeng Fu 已提交
737
        super(ClusterListCommand, self).__init__('list', 'List all the deployments.')
O
oceanbase-admin 已提交
738 739 740 741 742 743 744 745 746 747 748

    def _do_command(self, obd):
        if self.cmds:
            return self._show_help()
        else:
            return obd.list_deploy()


class ClusterEditConfigCommand(ClusterMirrorCommand):

    def __init__(self):
R
Rongfeng Fu 已提交
749
        super(ClusterEditConfigCommand, self).__init__('edit-config', 'Edit the configuration file for a specific deployment.')
O
oceanbase-admin 已提交
750 751 752 753 754 755 756 757

    def _do_command(self, obd):
        if self.cmds:
            return obd.edit_deploy_config(self.cmds[0])
        else:
            return self._show_help()


R
Rongfeng Fu 已提交
758 759 760
class ClusterChangeRepositoryCommand(ClusterMirrorCommand):

    def __init__(self):
F
v1.5.0  
frf12 已提交
761
        super(ClusterChangeRepositoryCommand, self).__init__('reinstall', 'Reinstall a deployed component')
R
Rongfeng Fu 已提交
762 763 764 765 766 767
        self.parser.add_option('-c', '--component', type='string', help="Component name to change repository.")
        self.parser.add_option('--hash', type='string', help="Repository's hash")
        self.parser.add_option('-f', '--force', action='store_true', help="force change even start failed.")

    def _do_command(self, obd):
        if self.cmds:
F
v1.5.0  
frf12 已提交
768
            return obd.reinstall(self.cmds[0], self.opts)
R
Rongfeng Fu 已提交
769 770 771 772
        else:
            return self._show_help()


R
Rongfeng Fu 已提交
773 774 775
class CLusterUpgradeCommand(ClusterMirrorCommand):

    def __init__(self):
R
Rongfeng Fu 已提交
776
        super(CLusterUpgradeCommand, self).__init__('upgrade', 'Upgrade a cluster.')
R
Rongfeng Fu 已提交
777 778 779 780 781 782
        self.parser.add_option('-c', '--component', type='string', help="Component name to upgrade.")
        self.parser.add_option('-V', '--version', type='string', help="Target version.")
        self.parser.add_option('--skip-check', action='store_true', help="Skip all the possible checks.")
        self.parser.add_option('--usable', type='string', help="Hash list for priority mirrors, separated with `,`.", default='')
        self.parser.add_option('--disable', type='string', help="Hash list for disabled mirrors, separated with `,`.", default='')
        self.parser.add_option('-e', '--executer-path', type='string', help="Executer path.", default=os.path.join(ObdCommand.OBD_INSTALL_PRE, 'usr/obd/lib/executer'))
R
Rongfeng Fu 已提交
783 784 785 786 787 788 789

    def _do_command(self, obd):
        if self.cmds:
            return obd.upgrade_cluster(self.cmds[0], self.opts)
        else:
            return self._show_help()

R
Rongfeng Fu 已提交
790 791 792 793 794

class ClusterTenantCreateCommand(ClusterMirrorCommand):

    def __init__(self):
        super(ClusterTenantCreateCommand, self).__init__('create', 'Create a tenant.')
F
v1.5.0  
frf12 已提交
795
        self.parser.add_option('-t', '-n', '--tenant-name', type='string', help="The tenant name. The default tenant name is [test].", default='test')
R
Rongfeng Fu 已提交
796 797
        self.parser.add_option('--max-cpu', type='float', help="Max CPU unit number.")
        self.parser.add_option('--min-cpu', type='float', help="Mind CPU unit number.")
F
v1.5.0  
frf12 已提交
798 799 800 801 802 803
        self.parser.add_option('--max-memory', type='string', help="Max memory unit size. Not supported after version 4.0, use `--memory-size` instead")
        self.parser.add_option('--min-memory', type='string', help="Min memory unit size. Not supported after version 4.0, use `--memory-size` instead")
        self.parser.add_option('--memory-size', type='string', help="Memory unit size. Supported since version 4.0.")
        self.parser.add_option('--max-disk-size', type='string', help="Max disk unit size. Not supported after version 4.0")
        self.parser.add_option('--log-disk-size', type='string', help="Log disk unit size.")
        self.parser.add_option('--max-iops', type='int', help="Max IOPS unit number.")
R
Rongfeng Fu 已提交
804
        self.parser.add_option('--min-iops', type='int', help="Min IOPS unit number.")
F
v1.5.0  
frf12 已提交
805 806
        self.parser.add_option('--iops-weight', type='int', help="The weight of IOPS. When Max IOPS is greater than Min IOPS, the weight of idle resources available to the current tenant. Supported since version 4.0.")
        self.parser.add_option('--max-session-num', type='int', help="Max session unit number. Not supported after version 4.0")
R
Rongfeng Fu 已提交
807 808 809 810
        self.parser.add_option('--unit-num', type='int', help="Pool unit number.")
        self.parser.add_option('-z', '--zone-list', type='string', help="Tenant zone list.")
        self.parser.add_option('--charset', type='string', help="Tenant charset.")
        self.parser.add_option('--collate', type='string', help="Tenant COLLATE.")
R
Rongfeng Fu 已提交
811
        self.parser.add_option('--replica-num', type='int', help="Tenant replica number.")
R
Rongfeng Fu 已提交
812 813
        self.parser.add_option('--logonly-replica-num', type='int', help="Tenant logonly replica number.")
        self.parser.add_option('--tablegroup', type='string', help="Tenant tablegroup.")
R
Rongfeng Fu 已提交
814
        self.parser.add_option('--primary-zone', type='string', help="Tenant primary zone. [RANDOM].", default='RANDOM')
R
Rongfeng Fu 已提交
815
        self.parser.add_option('--locality', type='string', help="Tenant locality.")
R
Rongfeng Fu 已提交
816
        self.parser.add_option('-s', '--variables', type='string', help="Set the variables for the system tenant. [ob_tcp_invited_nodes='%'].", default="ob_tcp_invited_nodes='%'")
R
Rongfeng Fu 已提交
817 818 819 820 821 822 823 824 825 826 827 828

    def _do_command(self, obd):
        if self.cmds:
            return obd.create_tenant(self.cmds[0], self.opts)
        else:
            return self._show_help()


class ClusterTenantDropCommand(ClusterMirrorCommand):

    def __init__(self):
        super(ClusterTenantDropCommand, self).__init__('drop', 'Drop a tenant.')
F
v1.5.0  
frf12 已提交
829
        self.parser.add_option('-t', '-n', '--tenant-name', type='string', help="Tenant name.")
R
Rongfeng Fu 已提交
830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845

    def _do_command(self, obd):
        if self.cmds:
            return obd.drop_tenant(self.cmds[0], self.opts)
        else:
            return self._show_help()


class ClusterTenantCommand(MajorCommand):

    def __init__(self):
        super(ClusterTenantCommand, self).__init__('tenant', 'Create or drop a tenant.')
        self.register_command(ClusterTenantCreateCommand())
        self.register_command(ClusterTenantDropCommand())


O
oceanbase-admin 已提交
846 847 848
class ClusterMajorCommand(MajorCommand):

    def __init__(self):
R
Rongfeng Fu 已提交
849
        super(ClusterMajorCommand, self).__init__('cluster', 'Deploy and manage a cluster.')
R
Rongfeng Fu 已提交
850 851
        self.register_command(ClusterCheckForOCPChange())
        self.register_command(ClusterConfigStyleChange())
R
Rongfeng Fu 已提交
852
        self.register_command(ClusterAutoDeployCommand())
O
oceanbase-admin 已提交
853 854 855 856 857 858 859 860 861 862
        self.register_command(ClusterDeployCommand())
        self.register_command(ClusterStartCommand())
        self.register_command(ClusterStopCommand())
        self.register_command(ClusterDestroyCommand())
        self.register_command(ClusterDisplayCommand())
        self.register_command(ClusterListCommand())
        self.register_command(ClusterRestartCommand())
        self.register_command(ClusterRedeployCommand())
        self.register_command(ClusterEditConfigCommand())
        self.register_command(ClusterReloadCommand())
R
Rongfeng Fu 已提交
863
        self.register_command(CLusterUpgradeCommand())
R
Rongfeng Fu 已提交
864
        self.register_command(ClusterChangeRepositoryCommand())
R
Rongfeng Fu 已提交
865
        self.register_command(ClusterTenantCommand())
O
oceanbase-admin 已提交
866 867 868 869 870 871


class TestMirrorCommand(ObdCommand):

    def init(self, cmd, args):
        super(TestMirrorCommand, self).init(cmd, args)
R
Rongfeng Fu 已提交
872
        self.parser.set_usage('%s <deploy name> [options]' % self.prev_cmd)
O
oceanbase-admin 已提交
873 874 875 876 877 878
        return self


class MySQLTestCommand(TestMirrorCommand):

    def __init__(self):
R
Rongfeng Fu 已提交
879 880
        super(MySQLTestCommand, self).__init__('mysqltest', 'Run a mysqltest for a deployment.')
        self.parser.add_option('--component', type='string', help='Components for mysqltest.')
R
Rongfeng Fu 已提交
881 882 883 884 885 886 887
        self.parser.add_option('--test-server', type='string', help='The server for mysqltest. By default, the first root server in the component is the mysqltest server.')
        self.parser.add_option('--user', type='string', help='Username for a test. [admin]', default='admin')
        self.parser.add_option('--password', type='string', help='Password for a test. [admin]', default='admin')
        self.parser.add_option('--database', type='string', help='Database for a test. [test]', default='test')
        self.parser.add_option('--mysqltest-bin', type='string', help='Mysqltest bin path. [/u01/obclient/bin/mysqltest]', default='/u01/obclient/bin/mysqltest')
        self.parser.add_option('--obclient-bin', type='string', help='OBClient bin path. [obclient]', default='obclient')
        self.parser.add_option('--test-dir', type='string', help='Test case file directory. [./mysql_test/t]', default='./mysql_test/t')
F
v1.5.0  
frf12 已提交
888
        self.parser.add_option('--test-file-suffix', type='string', help='Test case file suffix. [.test]', default='.test')
R
Rongfeng Fu 已提交
889
        self.parser.add_option('--result-dir', type='string', help='Result case file directory. [./mysql_test/r]', default='./mysql_test/r')
F
v1.5.0  
frf12 已提交
890
        self.parser.add_option('--result-file-suffix', type='string', help='Result file suffix. [.result]', default='.result')
F
v1.4.0  
frf12 已提交
891
        self.parser.add_option('--record', action='store_true', help='record mysqltest execution results', default=False)
F
v1.5.0  
frf12 已提交
892 893 894
        self.parser.add_option('--record-dir', type='string', help='The directory of the result file for mysqltest.', default='./record')
        self.parser.add_option('--record-file-suffix', type='string', help='Result file suffix. [.record]', default='.record')
        self.parser.add_option('--log-dir', type='string', help='The log file directory.')
R
Rongfeng Fu 已提交
895 896
        self.parser.add_option('--tmp-dir', type='string', help='Temporary directory for mysqltest. [./tmp]', default='./tmp')
        self.parser.add_option('--var-dir', type='string', help='Var directory to use when run mysqltest. [./var]', default='./var')
O
oceanbase-admin 已提交
897
        self.parser.add_option('--test-set', type='string', help='test list, use `,` interval')
F
v1.5.0  
frf12 已提交
898
        self.parser.add_option('--exclude', type='string', help='exclude list, use `,` interval')
R
Rongfeng Fu 已提交
899
        self.parser.add_option('--test-pattern', type='string', help='Pattern for test file.')
R
Rongfeng Fu 已提交
900
        self.parser.add_option('--suite', type='string', help='Suite list. Multiple suites are separated with commas.')
R
Rongfeng Fu 已提交
901
        self.parser.add_option('--suite-dir', type='string', help='Suite case directory. [./mysql_test/test_suite]', default='./mysql_test/test_suite')
F
v1.5.0  
frf12 已提交
902
        self.parser.add_option('--init-sql-dir', type='string', help='Initiate sql directory. [./]', default='./')
R
Rongfeng Fu 已提交
903
        self.parser.add_option('--init-sql-files', type='string', help='Initiate sql file list.Multiple files are separated with commas.')
R
Rongfeng Fu 已提交
904
        self.parser.add_option('--need-init', action='store_true', help='Execute the init SQL file.', default=False)
F
v1.5.0  
frf12 已提交
905
        self.parser.add_option('--init-only', action='store_true', help='Exit after executing init SQL.', default=False)
R
Rongfeng Fu 已提交
906
        self.parser.add_option('--auto-retry', action='store_true', help='Auto retry when fails.', default=False)
F
v1.5.0  
frf12 已提交
907
        self.parser.add_option('--all', action='store_true', help='Run all cases.', default=False)
R
Rongfeng Fu 已提交
908
        self.parser.add_option('--psmall', action='store_true', help='Run psmall cases.', default=False)
F
v1.5.0  
frf12 已提交
909 910 911
        self.parser.add_option('--special-run', action='store_true', help='run mysqltest in special mode.', default=False)
        self.parser.add_option('--sp-hint', type='string', help='run test with specified hint', default='')
        self.parser.add_option('--sort-result', action='store_true', help='sort query result', default=False)
O
oceanbase-admin 已提交
912
        # self.parser.add_option('--java', action='store_true', help='use java sdk', default=False)
F
v1.5.0  
frf12 已提交
913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933
        self.parser.add_option('--slices', type='int', help='How many slices the test set should be')
        self.parser.add_option('--slice-idx', type='int', help='The id of slices')
        self.parser.add_option('--slb-host', type='string', help='The host of soft load balance.')
        self.parser.add_option('--exec-id', type='string', help='The unique execute id.')
        self.parser.add_option('--case-filter', type='string', help='The case filter file for mysqltest.')
        self.parser.add_option('--psmall-test', type='string', help='The file maintain psmall cases.', default='./mysql_test/psmalltest.py')
        self.parser.add_option('--psmall-source', type='string', help='The file maintain psmall source control.', default='./mysql_test/psmallsource.py')
        self.parser.add_option('--ps', action='store_true', help='Run in ps mode.', default=False)
        self.parser.add_option('--test-tags', type='string', help='The file maintain basic tags.', default='./mysql_test/test_tags.py')
        self.parser.add_option('--tags', type='string', help='Run cases by tag.', default='')
        self.parser.add_option('--regress-suite-map', type='string', help='The file maintain basic regress suite map', default='./regress_suite_map.py')
        self.parser.add_option('--regress_suite', type='string', help='Run cases by regress_suite.', default='')
        self.parser.add_option('--reboot-cases', type='string', help='The file maintain reboot cases')
        self.parser.add_option('--reboot-timeout', type='int', help='The timeout of observer bootstrap', default=0)
        self.parser.add_option('--reboot-retries', type='int', help='How many times to retry when rebooting failed', default=5)
        self.parser.add_option('--collect-all', action='store_true', help='Collect servers log.', default=False)
        self.parser.add_option('--collect-components', type='string', help='The components which need collect log, multiple components are separated with commas')
        self.parser.add_option('--case-timeout', type='int', help='The timeout of mysqltest case')
        self.parser.add_option('--log-pattern', type='string', help='The pattern for collected servers log ', default='*.log')
        self.parser.add_option('--cluster-mode', type='string', help="The mode of mysqltest")
        self.parser.add_option('--disable-reboot', action='store_true', help='Never reboot during test.', default=False)
O
oceanbase-admin 已提交
934 935 936 937 938 939 940 941

    def _do_command(self, obd):
        if self.cmds:
            return obd.mysqltest(self.cmds[0], self.opts)
        else:
            return self._show_help()


R
Rongfeng Fu 已提交
942 943 944 945
class SysBenchCommand(TestMirrorCommand):

    def __init__(self):
        super(SysBenchCommand, self).__init__('sysbench', 'Run sysbench for a deployment.')
R
Rongfeng Fu 已提交
946 947
        self.parser.add_option('--component', type='string', help='Components for test.')
        self.parser.add_option('--test-server', type='string', help='The server for test. By default, the first root server in the component is the test server.')
R
Rongfeng Fu 已提交
948 949
        self.parser.add_option('--user', type='string', help='Username for a test. [root]', default='root')
        self.parser.add_option('--password', type='string', help='Password for a test.')
F
v1.5.0  
frf12 已提交
950
        self.parser.add_option('-t', '--tenant', type='string', help='Tenant for a test. [test]', default='test')
R
Rongfeng Fu 已提交
951 952 953
        self.parser.add_option('--database', type='string', help='Database for a test. [test]', default='test')
        self.parser.add_option('--obclient-bin', type='string', help='OBClient bin path. [obclient]', default='obclient')
        self.parser.add_option('--sysbench-bin', type='string', help='Sysbench bin path. [sysbench]', default='sysbench')
R
Rongfeng Fu 已提交
954
        self.parser.add_option('--script-name', type='string', help='Sysbench lua script file name. [oltp_point_select]', default='oltp_point_select.lua')
R
Rongfeng Fu 已提交
955 956 957 958 959 960 961 962 963 964
        self.parser.add_option('--sysbench-script-dir', type='string', help='The directory of the sysbench lua script file. [/usr/sysbench/share/sysbench]', default='/usr/sysbench/share/sysbench')
        self.parser.add_option('--table-size', type='int', help='Number of data initialized per table. [20000]', default=20000)
        self.parser.add_option('--tables', type='int', help='Number of initialization tables. [30]', default=30)
        self.parser.add_option('--threads', type='int', help='Number of threads to use. [32]', default=16)
        self.parser.add_option('--time', type='int', help='Limit for total execution time in seconds. [60]', default=60)
        self.parser.add_option('--interval', type='int', help='Periodically report intermediate statistics with a specified time interval in seconds. 0 disables intermediate reports. [10]', default=10)
        self.parser.add_option('--events', type='int', help='Limit for total number of events.')
        self.parser.add_option('--rand-type', type='string', help='Random numbers distribution {uniform,gaussian,special,pareto}.')
        self.parser.add_option('--percentile', type='int', help='Percentile to calculate in latency statistics. Available values are 1-100. 0 means to disable percentile calculations.')
        self.parser.add_option('--skip-trx', dest='{on/off}', type='string', help='Open or close a transaction in a read-only test. ')
R
Rongfeng Fu 已提交
965
        self.parser.add_option('-O', '--optimization', type='int', help='optimization level {0/1}', default=1)
R
Rongfeng Fu 已提交
966 967 968 969 970 971 972 973

    def _do_command(self, obd):
        if self.cmds:
            return obd.sysbench(self.cmds[0], self.opts)
        else:
            return self._show_help()


R
Rongfeng Fu 已提交
974 975 976 977 978 979 980 981
class TPCHCommand(TestMirrorCommand):

    def __init__(self):
        super(TPCHCommand, self).__init__('tpch', 'Run a TPC-H test for a deployment.')
        self.parser.add_option('--component', type='string', help='Components for a test.')
        self.parser.add_option('--test-server', type='string', help='The server for a test. By default, the first root server in the component is the test server.')
        self.parser.add_option('--user', type='string', help='Username for a test. [root]', default='root')
        self.parser.add_option('--password', type='string', help='Password for a test.')
F
v1.5.0  
frf12 已提交
982
        self.parser.add_option('-t', '--tenant', type='string', help='Tenant for a test. [test]', default='test')
R
Rongfeng Fu 已提交
983 984
        self.parser.add_option('--database', type='string', help='Database for a test. [test]', default='test')
        self.parser.add_option('--obclient-bin', type='string', help='OBClient bin path. [obclient]', default='obclient')
R
Rongfeng Fu 已提交
985
        self.parser.add_option('--dbgen-bin', type='string', help='dbgen bin path. [/usr/tpc-h-tools/tpc-h-tools/bin/dbgen]', default='/usr/tpc-h-tools/tpc-h-tools/bin/dbgen')
R
Rongfeng Fu 已提交
986 987 988 989 990 991 992
        self.parser.add_option('-s', '--scale-factor', type='int', help='Set Scale Factor (SF) to <n>. [1] ', default=1)
        self.parser.add_option('--tmp-dir', type='string', help='The temporary directory for executing TPC-H. [./tmp]', default='./tmp')
        self.parser.add_option('--ddl-path', type='string', help='Directory for DDL files.')
        self.parser.add_option('--tbl-path', type='string', help='Directory for tbl files.')
        self.parser.add_option('--sql-path', type='string', help='Directory for SQL files.')
        self.parser.add_option('--remote-tbl-dir', type='string', help='Directory for the tbl on target observers. Make sure that you have read and write access to the directory when you start observer.')
        self.parser.add_option('--disable-transfer', '--dt', action='store_true', help='Disable the transfer. When enabled, OBD will use the tbl files under remote-tbl-dir instead of transferring local tbl files to remote remote-tbl-dir.')
R
Rongfeng Fu 已提交
993
        self.parser.add_option('--dss-config', type='string', help='Directory for dists.dss. [/usr/tpc-h-tools/tpc-h-tools]', default='/usr/tpc-h-tools/tpc-h-tools/')
R
Rongfeng Fu 已提交
994 995 996 997 998 999 1000 1001 1002 1003
        self.parser.add_option('-O', '--optimization', type='int', help='Optimization level {0/1}. [1]', default=1)
        self.parser.add_option('--test-only', action='store_true', help='Only testing SQLs are executed. No initialization is executed.')

    def _do_command(self, obd):
        if self.cmds:
            return obd.tpch(self.cmds[0], self.opts)
        else:
            return self._show_help()


R
Rongfeng Fu 已提交
1004 1005 1006 1007 1008 1009 1010 1011
class TPCCCommand(TestMirrorCommand):

    def __init__(self):
        super(TPCCCommand, self).__init__('tpcc', 'Run a TPC-C test for a deployment.')
        self.parser.add_option('--component', type='string', help='Components for a test.')
        self.parser.add_option('--test-server', type='string', help='The server for a test. By default, the first root server in the component is the test server.')
        self.parser.add_option('--user', type='string', help='Username for a test. [root]', default='root')
        self.parser.add_option('--password', type='string', help='Password for a test.')
F
v1.5.0  
frf12 已提交
1012
        self.parser.add_option('-t', '--tenant', type='string', help='Tenant for a test. [test]', default='test')
R
Rongfeng Fu 已提交
1013 1014 1015 1016 1017 1018 1019 1020
        self.parser.add_option('--database', type='string', help='Database for a test. [test]', default='test')
        self.parser.add_option('--obclient-bin', type='string', help='OBClient bin path. [obclient]', default='obclient')
        self.parser.add_option('--java-bin', type='string', help='Java bin path. [java]', default='java')
        self.parser.add_option('--tmp-dir', type='string', help='The temporary directory for executing TPC-C. [./tmp]', default='./tmp')
        self.parser.add_option('--bmsql-dir', type='string', help='The directory of BenchmarkSQL.')
        self.parser.add_option('--bmsql-jar', type='string', help='BenchmarkSQL jar path.')
        self.parser.add_option('--bmsql-libs', type='string', help='BenchmarkSQL libs path.')
        self.parser.add_option('--bmsql-sql-dir', type='string', help='The directory of BenchmarkSQL sql scripts.')
F
v1.5.0  
frf12 已提交
1021
        self.parser.add_option('--warehouses', type='int', help='The number of warehouses.[10]', default=10)
R
Rongfeng Fu 已提交
1022 1023
        self.parser.add_option('--load-workers', type='int', help='The number of workers to load data.')
        self.parser.add_option('--terminals', type='int', help='The number of terminals.')
F
v1.5.0  
frf12 已提交
1024
        self.parser.add_option('--run-mins', type='int', help='To run for specified minutes.[10]', default=10)
R
Rongfeng Fu 已提交
1025 1026 1027 1028 1029 1030 1031 1032
        self.parser.add_option('--test-only', action='store_true', help='Only testing SQLs are executed. No initialization is executed.')
        self.parser.add_option('-O', '--optimization', type='int', help='Optimization level {0/1/2}. [1] 0 - No optimization. 1 - Optimize some of the parameters which do not need to restart servers. 2 - Optimize all the parameters and maybe RESTART SERVERS for better performance.', default=1)

    def _do_command(self, obd):
        if self.cmds:
            return obd.tpcc(self.cmds[0], self.opts)
        else:
            return self._show_help()
F
v1.5.0  
frf12 已提交
1033

R
Rongfeng Fu 已提交
1034

O
oceanbase-admin 已提交
1035 1036 1037
class TestMajorCommand(MajorCommand):

    def __init__(self):
R
Rongfeng Fu 已提交
1038
        super(TestMajorCommand, self).__init__('test', 'Run test for a running deployment.')
O
oceanbase-admin 已提交
1039
        self.register_command(MySQLTestCommand())
R
Rongfeng Fu 已提交
1040
        self.register_command(SysBenchCommand())
R
Rongfeng Fu 已提交
1041
        self.register_command(TPCHCommand())
F
v1.4.0  
frf12 已提交
1042
        self.register_command(TPCCCommand())
O
oceanbase-admin 已提交
1043 1044


F
v1.5.0  
frf12 已提交
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097
class DbConnectCommand(HiddenObdCommand):

    def init(self, cmd, args):
        super(DbConnectCommand, self).init(cmd, args)
        self.parser.set_usage('%s <deploy name> [options]' % self.prev_cmd)
        return self

    def __init__(self):
        super(DbConnectCommand, self).__init__('db_connect', 'Establish a database connection to the deployment.')
        self.parser.add_option('-c', '--component', type='string', help='The component used by database connection.')
        self.parser.add_option('-s', '--server', type='string',
                               help='The server used by database connection. The first server in the configuration will be used by default')
        self.parser.add_option('-u', '--user', type='string', help='The username used by d'
                                                                   'atabase connection. [root]', default='root')
        self.parser.add_option('-p', '--password', type='string', help='The password used by database connection.')
        self.parser.add_option('-t', '--tenant', type='string', help='The tenant used by database connection. [sys]', default='sys')
        self.parser.add_option('-D', '--database', type='string', help='The database name used by database connection.')
        self.parser.add_option('--obclient-bin', type='string', help='OBClient bin path. [obclient]', default='obclient')

    def _do_command(self, obd):
        if self.cmds:
            return obd.db_connect(self.cmds[0], self.opts)
        else:
            return self._show_help()


class CommandsCommand(HiddenObdCommand):

    def init(self, cmd, args):
        super(CommandsCommand, self).init(cmd, args)
        self.parser.set_usage('%s <deploy name> <command> [options]' % self.prev_cmd)
        return self

    def __init__(self):
        super(CommandsCommand, self).__init__('command', 'Common tool commands')
        self.parser.add_option('-c', '--components', type='string', help='The components used by the command. The first component in the configuration will be used by default in interactive commands, and all available components will be used by default in non-interactive commands.')
        self.parser.add_option('-s', '--servers', type='string', help='The servers used by the command. The first server in the configuration will be used by default in interactive commands, and all available servers will be used by default in non-interactive commands.')

    def _do_command(self, obd):
        if len(self.cmds) == 2:
            return obd.commands(self.cmds[0], self.cmds[1], self.opts)
        else:
            return self._show_help()


class ToolCommand(HiddenMajorCommand):

    def __init__(self):
        super(ToolCommand, self).__init__('tool', 'Tools')
        self.register_command(DbConnectCommand())
        self.register_command(CommandsCommand())


O
oceanbase-admin 已提交
1098 1099 1100 1101 1102 1103
class BenchMajorCommand(MajorCommand):

    def __init__(self):
        super(BenchMajorCommand, self).__init__('bench', '')


R
Rongfeng Fu 已提交
1104 1105 1106
class UpdateCommand(ObdCommand):

    def __init__(self):
R
Rongfeng Fu 已提交
1107
        super(UpdateCommand, self).__init__('update', 'Update OBD.')
R
Rongfeng Fu 已提交
1108 1109 1110

    def do_command(self):
        if os.getuid() != 0:
R
Rongfeng Fu 已提交
1111
            ROOT_IO.error('To update OBD, you must be a root user.')
R
Rongfeng Fu 已提交
1112 1113 1114 1115
            return False
        return super(UpdateCommand, self).do_command()

    def _do_command(self, obd):
R
Rongfeng Fu 已提交
1116
        return obd.update_obd(VERSION, self.OBD_INSTALL_PRE)
R
Rongfeng Fu 已提交
1117 1118


O
oceanbase-admin 已提交
1119 1120 1121 1122
class MainCommand(MajorCommand):

    def __init__(self):
        super(MainCommand, self).__init__('obd', '')
R
Rongfeng Fu 已提交
1123
        self.register_command(DevModeMajorCommand())
O
oceanbase-admin 已提交
1124 1125
        self.register_command(MirrorMajorCommand())
        self.register_command(ClusterMajorCommand())
R
Rongfeng Fu 已提交
1126
        self.register_command(RepositoryMajorCommand())
O
oceanbase-admin 已提交
1127
        self.register_command(TestMajorCommand())
R
Rongfeng Fu 已提交
1128
        self.register_command(UpdateCommand())
F
v1.5.0  
frf12 已提交
1129 1130
        self.register_command(EnvironmentMajorCommand())
        self.register_command(ToolCommand())
O
oceanbase-admin 已提交
1131
        self.parser.version = '''OceanBase Deploy: %s
R
Rongfeng Fu 已提交
1132 1133 1134
REVISION: %s
BUILD_BRANCH: %s
BUILD_TIME: %s
O
oceanbase-admin 已提交
1135 1136 1137
Copyright (C) 2021 OceanBase
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.
This is free software: you are free to change and redistribute it.
R
Rongfeng Fu 已提交
1138
There is NO WARRANTY, to the extent permitted by law.''' % (VERSION, REVISION, BUILD_BRANCH, BUILD_TIME)
O
oceanbase-admin 已提交
1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
        self.parser._add_version_option()

if __name__ == '__main__':
    defaultencoding = 'utf-8'
    if sys.getdefaultencoding() != defaultencoding:
        try:
            from imp import reload
        except:
            pass
        reload(sys)
        sys.setdefaultencoding(defaultencoding)
R
Rongfeng Fu 已提交
1150
    sys.path.append(os.path.join(ObdCommand.OBD_INSTALL_PRE, 'usr/obd/lib/site-packages'))
O
oceanbase-admin 已提交
1151 1152 1153 1154 1155
    ROOT_IO.track_limit += 2
    if MainCommand().init('obd', sys.argv[1:]).do_command():
        ROOT_IO.exit(0)
    ROOT_IO.exit(1)