crash_gen.py 93.3 KB
Newer Older
S
Shuduo Sang 已提交
1
# -----!/usr/bin/python3.7
S
Steven Li 已提交
2 3 4 5 6 7 8 9 10 11 12 13
###################################################################
#           Copyright (c) 2016 by TAOS Technologies, Inc.
#                     All rights reserved.
#
#  This file is proprietary and confidential to TAOS Technologies.
#  No part of this file may be reproduced, stored, transmitted,
#  disclosed or used in any form or by any means other than as
#  expressly provided by the written permission from Jianhui Tao
#
###################################################################

# -*- coding: utf-8 -*-
S
Shuduo Sang 已提交
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
# For type hinting before definition, ref:
# https://stackoverflow.com/questions/33533148/how-do-i-specify-that-the-return-type-of-a-method-is-the-same-as-the-class-itsel
from __future__ import annotations
import taos
import crash_gen
from util.sql import *
from util.cases import *
from util.dnodes import *
from util.log import *
from queue import Queue, Empty
from typing import IO
from typing import Set
from typing import Dict
from typing import List
from requests.auth import HTTPBasicAuth
import textwrap
import datetime
import logging
import time
import random
import threading
import requests
import copy
import argparse
import getopt
39

S
Steven Li 已提交
40
import sys
41
import os
42 43
import io
import signal
44
import traceback
45 46 47 48
# Require Python 3
if sys.version_info[0] < 3:
    raise Exception("Must be using Python 3")

S
Steven Li 已提交
49

S
Shuduo Sang 已提交
50
# Global variables, tried to keep a small number.
51 52 53

# Command-line/Environment Configurations, will set a bit later
# ConfigNameSpace = argparse.Namespace
S
Shuduo Sang 已提交
54
gConfig = argparse.Namespace()  # Dummy value, will be replaced later
55
logger = None
S
Steven Li 已提交
56

S
Shuduo Sang 已提交
57 58

def runThread(wt: WorkerThread):
59
    wt.run()
60

S
Shuduo Sang 已提交
61

62 63
class CrashGenError(Exception):
    def __init__(self, msg=None, errno=None):
S
Shuduo Sang 已提交
64
        self.msg = msg
65
        self.errno = errno
S
Shuduo Sang 已提交
66

67 68 69
    def __str__(self):
        return self.msg

S
Shuduo Sang 已提交
70

S
Steven Li 已提交
71
class WorkerThread:
S
Shuduo Sang 已提交
72 73 74 75 76
    def __init__(self, pool: ThreadPool, tid,
                 tc: ThreadCoordinator,
                 # te: TaskExecutor,
                 ):  # note: main thread context!
        # self._curStep = -1
77
        self._pool = pool
S
Shuduo Sang 已提交
78 79
        self._tid = tid
        self._tc = tc  # type: ThreadCoordinator
S
Steven Li 已提交
80
        # self.threadIdent = threading.get_ident()
81 82
        self._thread = threading.Thread(target=runThread, args=(self,))
        self._stepGate = threading.Event()
S
Steven Li 已提交
83

84
        # Let us have a DB connection of our own
S
Shuduo Sang 已提交
85
        if (gConfig.per_thread_db_connection):  # type: ignore
86
            # print("connector_type = {}".format(gConfig.connector_type))
87 88 89 90 91 92 93 94 95 96 97
            if gConfig.connector_type == 'native':
                self._dbConn = DbConn.createNative() 
            elif gConfig.connector_type == 'rest':
                self._dbConn = DbConn.createRest() 
            elif gConfig.connector_type == 'mixed':
                if Dice.throw(2) == 0: # 1/2 chance
                    self._dbConn = DbConn.createNative() 
                else:
                    self._dbConn = DbConn.createRest() 
            else:
                raise RuntimeError("Unexpected connector type: {}".format(gConfig.connector_type))
98

S
Shuduo Sang 已提交
99
        self._dbInUse = False  # if "use db" was executed already
100

101
    def logDebug(self, msg):
S
Steven Li 已提交
102
        logger.debug("    TRD[{}] {}".format(self._tid, msg))
103 104

    def logInfo(self, msg):
S
Steven Li 已提交
105
        logger.info("    TRD[{}] {}".format(self._tid, msg))
106

107 108 109 110
    def dbInUse(self):
        return self._dbInUse

    def useDb(self):
S
Shuduo Sang 已提交
111
        if (not self._dbInUse):
112 113 114
            self.execSql("use db")
        self._dbInUse = True

115
    def getTaskExecutor(self):
S
Shuduo Sang 已提交
116
        return self._tc.getTaskExecutor()
117

S
Steven Li 已提交
118
    def start(self):
119
        self._thread.start()  # AFTER the thread is recorded
S
Steven Li 已提交
120

S
Shuduo Sang 已提交
121
    def run(self):
S
Steven Li 已提交
122
        # initialization after thread starts, in the thread context
123
        # self.isSleeping = False
124 125
        logger.info("Starting to run thread: {}".format(self._tid))

S
Shuduo Sang 已提交
126
        if (gConfig.per_thread_db_connection):  # type: ignore
127
            logger.debug("Worker thread openning database connection")
128
            self._dbConn.open()
S
Steven Li 已提交
129

S
Shuduo Sang 已提交
130 131
        self._doTaskLoop()

132
        # clean up
S
Shuduo Sang 已提交
133
        if (gConfig.per_thread_db_connection):  # type: ignore
134
            self._dbConn.close()
135

S
Shuduo Sang 已提交
136
    def _doTaskLoop(self):
137 138
        # while self._curStep < self._pool.maxSteps:
        # tc = ThreadCoordinator(None)
S
Shuduo Sang 已提交
139 140
        while True:
            tc = self._tc  # Thread Coordinator, the overall master
141
            tc.crossStepBarrier()  # shared barrier first, INCLUDING the last one
142
            logger.debug("[TRD] Worker thread [{}] exited barrier...".format(self._tid))
143
            self.crossStepGate()   # then per-thread gate, after being tapped
144
            logger.debug("[TRD] Worker thread [{}] exited step gate...".format(self._tid))
145
            if not self._tc.isRunning():
146
                logger.debug("[TRD] Thread Coordinator not running any more, worker thread now stopping...")
147 148
                break

149
            # Fetch a task from the Thread Coordinator
150
            logger.debug( "[TRD] Worker thread [{}] about to fetch task".format(self._tid))
151
            task = tc.fetchTask()
152 153

            # Execute such a task
S
Shuduo Sang 已提交
154 155 156
            logger.debug(
                "[TRD] Worker thread [{}] about to execute task: {}".format(
                    self._tid, task.__class__.__name__))
157
            task.execute(self)
158
            tc.saveExecutedTask(task)
159
            logger.debug("[TRD] Worker thread [{}] finished executing task".format(self._tid))
S
Shuduo Sang 已提交
160 161

            self._dbInUse = False  # there may be changes between steps
162

S
Shuduo Sang 已提交
163 164
    def verifyThreadSelf(self):  # ensure we are called by this own thread
        if (threading.get_ident() != self._thread.ident):
S
Steven Li 已提交
165 166
            raise RuntimeError("Unexpectly called from other threads")

S
Shuduo Sang 已提交
167 168
    def verifyThreadMain(self):  # ensure we are called by the main thread
        if (threading.get_ident() != threading.main_thread().ident):
S
Steven Li 已提交
169 170 171
            raise RuntimeError("Unexpectly called from other threads")

    def verifyThreadAlive(self):
S
Shuduo Sang 已提交
172
        if (not self._thread.is_alive()):
S
Steven Li 已提交
173 174
            raise RuntimeError("Unexpected dead thread")

175
    # A gate is different from a barrier in that a thread needs to be "tapped"
S
Steven Li 已提交
176 177
    def crossStepGate(self):
        self.verifyThreadAlive()
S
Shuduo Sang 已提交
178 179
        self.verifyThreadSelf()  # only allowed by ourselves

180
        # Wait again at the "gate", waiting to be "tapped"
S
Shuduo Sang 已提交
181 182 183 184
        logger.debug(
            "[TRD] Worker thread {} about to cross the step gate".format(
                self._tid))
        self._stepGate.wait()
185
        self._stepGate.clear()
S
Shuduo Sang 已提交
186

187
        # self._curStep += 1  # off to a new step...
S
Steven Li 已提交
188

S
Shuduo Sang 已提交
189
    def tapStepGate(self):  # give it a tap, release the thread waiting there
S
Steven Li 已提交
190
        self.verifyThreadAlive()
S
Shuduo Sang 已提交
191 192
        self.verifyThreadMain()  # only allowed for main thread

S
Steven Li 已提交
193
        logger.debug("[TRD] Tapping worker thread {}".format(self._tid))
S
Shuduo Sang 已提交
194 195
        self._stepGate.set()  # wake up!
        time.sleep(0)  # let the released thread run a bit
196

S
Shuduo Sang 已提交
197 198 199
    def execSql(self, sql):  # TODO: expose DbConn directly
        if (gConfig.per_thread_db_connection):
            return self._dbConn.execute(sql)
200
        else:
201
            return self._tc.getDbManager().getDbConn().execute(sql)
202

S
Shuduo Sang 已提交
203 204 205
    def querySql(self, sql):  # TODO: expose DbConn directly
        if (gConfig.per_thread_db_connection):
            return self._dbConn.query(sql)
206 207 208 209
        else:
            return self._tc.getDbManager().getDbConn().query(sql)

    def getQueryResult(self):
S
Shuduo Sang 已提交
210 211
        if (gConfig.per_thread_db_connection):
            return self._dbConn.getQueryResult()
212 213 214
        else:
            return self._tc.getDbManager().getDbConn().getQueryResult()

215
    def getDbConn(self):
S
Shuduo Sang 已提交
216 217
        if (gConfig.per_thread_db_connection):
            return self._dbConn
218
        else:
219
            return self._tc.getDbManager().getDbConn()
220

221 222
    # def querySql(self, sql): # not "execute", since we are out side the DB context
    #     if ( gConfig.per_thread_db_connection ):
S
Shuduo Sang 已提交
223
    #         return self._dbConn.query(sql)
224 225
    #     else:
    #         return self._tc.getDbState().getDbConn().query(sql)
226

227
# The coordinator of all worker threads, mostly running in main thread
S
Shuduo Sang 已提交
228 229


230
class ThreadCoordinator:
231
    def __init__(self, pool: ThreadPool, dbManager):
S
Shuduo Sang 已提交
232
        self._curStep = -1  # first step is 0
233
        self._pool = pool
234
        # self._wd = wd
S
Shuduo Sang 已提交
235
        self._te = None  # prepare for every new step
236
        self._dbManager = dbManager
S
Shuduo Sang 已提交
237 238
        self._executedTasks: List[Task] = []  # in a given step
        self._lock = threading.RLock()  # sync access for a few things
S
Steven Li 已提交
239

S
Shuduo Sang 已提交
240 241
        self._stepBarrier = threading.Barrier(
            self._pool.numThreads + 1)  # one barrier for all threads
242
        self._execStats = ExecutionStats()
243
        self._runStatus = MainExec.STATUS_RUNNING
S
Steven Li 已提交
244

245 246 247
    def getTaskExecutor(self):
        return self._te

S
Shuduo Sang 已提交
248
    def getDbManager(self) -> DbManager:
249
        return self._dbManager
250

251 252 253
    def crossStepBarrier(self):
        self._stepBarrier.wait()

254 255 256 257
    def requestToStop(self):
        self._runStatus = MainExec.STATUS_STOPPING
        self._execStats.registerFailure("User Interruption")

258 259 260 261 262 263 264 265 266 267 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 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
    def _runShouldEnd(self, transitionFailed, hasAbortedTask):
        maxSteps = gConfig.max_steps  # type: ignore
        if self._curStep >= (maxSteps - 1): # maxStep==10, last curStep should be 9
            return True
        if self._runStatus != MainExec.STATUS_RUNNING:
            return True
        if transitionFailed:
            return True
        if hasAbortedTask:
            return True
        return False

    def _hasAbortedTask(self): # from execution of previous step
        for task in self._executedTasks:
            if task.isAborted():
                # print("Task aborted: {}".format(task))
                # hasAbortedTask = True
                return True
        return False

    def _releaseAllWorkerThreads(self, transitionFailed):
        self._curStep += 1  # we are about to get into next step. TODO: race condition here!
        # Now not all threads had time to go to sleep
        logger.debug(
            "--\r\n\n--> Step {} starts with main thread waking up".format(self._curStep))

        # A new TE for the new step
        self._te = None # set to empty first, to signal worker thread to stop
        if not transitionFailed:  # only if not failed
            self._te = TaskExecutor(self._curStep)

        logger.debug("[TRD] Main thread waking up at step {}, tapping worker threads".format(
                self._curStep))  # Now not all threads had time to go to sleep
        # Worker threads will wake up at this point, and each execute it's own task
        self.tapAllThreads() # release all worker thread from their "gate"

    def _syncAtBarrier(self):
         # Now main thread (that's us) is ready to enter a step
        # let other threads go past the pool barrier, but wait at the
        # thread gate
        logger.debug("[TRD] Main thread about to cross the barrier")
        self.crossStepBarrier()
        self._stepBarrier.reset()  # Other worker threads should now be at the "gate"
        logger.debug("[TRD] Main thread finished crossing the barrier")

    def _doTransition(self):
        transitionFailed = False
        try:
            sm = self._dbManager.getStateMachine()
            logger.debug("[STT] starting transitions")
            # at end of step, transiton the DB state
            sm.transition(self._executedTasks)
            logger.debug("[STT] transition ended")
            # Due to limitation (or maybe not) of the Python library,
            # we cannot share connections across threads
            if sm.hasDatabase():
                for t in self._pool.threadList:
                    logger.debug("[DB] use db for all worker threads")
                    t.useDb()
                    # t.execSql("use db") # main thread executing "use
                    # db" on behalf of every worker thread
        except taos.error.ProgrammingError as err:
            if (err.msg == 'network unavailable'):  # broken DB connection
                logger.info("DB connection broken, execution failed")
                traceback.print_stack()
                transitionFailed = True
                self._te = None  # Not running any more
                self._execStats.registerFailure("Broken DB Connection")
                # continue # don't do that, need to tap all threads at
                # end, and maybe signal them to stop
            else:
                raise

        self.resetExecutedTasks()  # clear the tasks after we are done
        # Get ready for next step
        logger.debug("<-- Step {} finished, trasition failed = {}".format(self._curStep, transitionFailed))
        return transitionFailed

S
Shuduo Sang 已提交
336
    def run(self):
337
        self._pool.createAndStartThreads(self)
S
Steven Li 已提交
338 339

        # Coordinate all threads step by step
S
Shuduo Sang 已提交
340
        self._curStep = -1  # not started yet
341
        
S
Shuduo Sang 已提交
342
        self._execStats.startExec()  # start the stop watch
343 344
        transitionFailed = False
        hasAbortedTask = False
345 346
        while not self._runShouldEnd(transitionFailed, hasAbortedTask):
            if not gConfig.debug: # print this only if we are not in debug mode                
S
Shuduo Sang 已提交
347
                print(".", end="", flush=True)
348 349
                        
            self._syncAtBarrier() # For now just cross the barrier
350 351

            # At this point, all threads should be pass the overall "barrier" and before the per-thread "gate"
S
Shuduo Sang 已提交
352 353
            # We use this period to do house keeping work, when all worker
            # threads are QUIET.
354 355 356
            hasAbortedTask = self._hasAbortedTask() # from previous step
            if hasAbortedTask: 
                logger.info("Aborted task encountered, exiting test program")
357
                self._execStats.registerFailure("Aborted Task Encountered")
358
                break # do transition only if tasks are error free
S
Shuduo Sang 已提交
359

360 361 362 363
            # Ending previous step
            transitionFailed = self._doTransition() # To start, we end step -1 first
            # Then we move on to the next step
            self._releaseAllWorkerThreads(transitionFailed)                    
364

365 366 367 368 369
        if hasAbortedTask or transitionFailed : # abnormal ending, workers waiting at "gate"
            logger.debug("Abnormal ending of main thraed")
        else: # regular ending, workers waiting at "barrier"
            logger.debug("Regular ending, main thread waiting for all worker threads to stop...")
            self._syncAtBarrier()
370

371 372 373
        self._te = None  # No more executor, time to end
        logger.debug("Main thread tapping all threads one last time...")
        self.tapAllThreads()  # Let the threads run one last time
374

375
        logger.debug("\r\n\n--> Main thread ready to finish up...")
376
        logger.debug("Main thread joining all threads")
S
Shuduo Sang 已提交
377
        self._pool.joinAll()  # Get all threads to finish
378
        logger.info("\nAll worker threads finished")
379 380
        self._execStats.endExec()

381 382
    def printStats(self):
        self._execStats.printStats()
S
Steven Li 已提交
383

S
Steven Li 已提交
384 385 386 387 388 389
    def isFailed(self):
        return self._execStats.isFailed()

    def getExecStats(self):
        return self._execStats

S
Shuduo Sang 已提交
390
    def tapAllThreads(self):  # in a deterministic manner
S
Steven Li 已提交
391
        wakeSeq = []
S
Shuduo Sang 已提交
392 393
        for i in range(self._pool.numThreads):  # generate a random sequence
            if Dice.throw(2) == 1:
S
Steven Li 已提交
394 395 396
                wakeSeq.append(i)
            else:
                wakeSeq.insert(0, i)
S
Shuduo Sang 已提交
397 398 399
        logger.debug(
            "[TRD] Main thread waking up worker threads: {}".format(
                str(wakeSeq)))
400
        # TODO: set dice seed to a deterministic value
S
Steven Li 已提交
401
        for i in wakeSeq:
S
Shuduo Sang 已提交
402 403 404
            # TODO: maybe a bit too deep?!
            self._pool.threadList[i].tapStepGate()
            time.sleep(0)  # yield
S
Steven Li 已提交
405

406
    def isRunning(self):
S
Shuduo Sang 已提交
407
        return self._te is not None
408

S
Shuduo Sang 已提交
409 410
    def fetchTask(self) -> Task:
        if (not self.isRunning()):  # no task
411
            raise RuntimeError("Cannot fetch task when not running")
412 413
        # return self._wd.pickTask()
        # Alternatively, let's ask the DbState for the appropriate task
414 415 416 417 418 419 420
        # dbState = self.getDbState()
        # tasks = dbState.getTasksAtState() # TODO: create every time?
        # nTasks = len(tasks)
        # i = Dice.throw(nTasks)
        # logger.debug(" (dice:{}/{}) ".format(i, nTasks))
        # # return copy.copy(tasks[i]) # Needs a fresh copy, to save execution results, etc.
        # return tasks[i].clone() # TODO: still necessary?
S
Shuduo Sang 已提交
421 422 423 424 425
        # pick a task type for current state
        taskType = self.getDbManager().getStateMachine().pickTaskType()
        return taskType(
            self.getDbManager(),
            self._execStats)  # create a task from it
426 427

    def resetExecutedTasks(self):
S
Shuduo Sang 已提交
428
        self._executedTasks = []  # should be under single thread
429 430 431 432

    def saveExecutedTask(self, task):
        with self._lock:
            self._executedTasks.append(task)
433 434

# We define a class to run a number of threads in locking steps.
S
Shuduo Sang 已提交
435 436


437
class ThreadPool:
438
    def __init__(self, numThreads, maxSteps):
439 440 441 442
        self.numThreads = numThreads
        self.maxSteps = maxSteps
        # Internal class variables
        self.curStep = 0
S
Shuduo Sang 已提交
443 444
        self.threadList = []  # type: List[WorkerThread]

445
    # starting to run all the threads, in locking steps
446
    def createAndStartThreads(self, tc: ThreadCoordinator):
S
Shuduo Sang 已提交
447 448
        for tid in range(0, self.numThreads):  # Create the threads
            workerThread = WorkerThread(self, tid, tc)
449
            self.threadList.append(workerThread)
S
Shuduo Sang 已提交
450
            workerThread.start()  # start, but should block immediately before step 0
451 452 453 454 455 456

    def joinAll(self):
        for workerThread in self.threadList:
            logger.debug("Joining thread...")
            workerThread._thread.join()

457 458
# A queue of continguous POSITIVE integers, used by DbManager to generate continuous numbers
# for new table names
S
Shuduo Sang 已提交
459 460


S
Steven Li 已提交
461 462
class LinearQueue():
    def __init__(self):
463
        self.firstIndex = 1  # 1st ever element
S
Steven Li 已提交
464
        self.lastIndex = 0
S
Shuduo Sang 已提交
465 466
        self._lock = threading.RLock()  # our functions may call each other
        self.inUse = set()  # the indexes that are in use right now
S
Steven Li 已提交
467

468
    def toText(self):
S
Shuduo Sang 已提交
469 470
        return "[{}..{}], in use: {}".format(
            self.firstIndex, self.lastIndex, self.inUse)
471 472

    # Push (add new element, largest) to the tail, and mark it in use
S
Shuduo Sang 已提交
473
    def push(self):
474
        with self._lock:
S
Shuduo Sang 已提交
475 476
            # if ( self.isEmpty() ):
            #     self.lastIndex = self.firstIndex
477
            #     return self.firstIndex
478 479
            # Otherwise we have something
            self.lastIndex += 1
480 481
            self.allocate(self.lastIndex)
            # self.inUse.add(self.lastIndex) # mark it in use immediately
482
            return self.lastIndex
S
Steven Li 已提交
483 484

    def pop(self):
485
        with self._lock:
S
Shuduo Sang 已提交
486 487 488 489
            if (self.isEmpty()):
                # raise RuntimeError("Cannot pop an empty queue")
                return False  # TODO: None?

490
            index = self.firstIndex
S
Shuduo Sang 已提交
491
            if (index in self.inUse):
492 493
                return False

494 495 496 497 498 499 500
            self.firstIndex += 1
            return index

    def isEmpty(self):
        return self.firstIndex > self.lastIndex

    def popIfNotEmpty(self):
501
        with self._lock:
502 503 504 505
            if (self.isEmpty()):
                return 0
            return self.pop()

S
Steven Li 已提交
506
    def allocate(self, i):
507
        with self._lock:
508
            # logger.debug("LQ allocating item {}".format(i))
S
Shuduo Sang 已提交
509 510 511
            if (i in self.inUse):
                raise RuntimeError(
                    "Cannot re-use same index in queue: {}".format(i))
512 513
            self.inUse.add(i)

S
Steven Li 已提交
514
    def release(self, i):
515
        with self._lock:
516
            # logger.debug("LQ releasing item {}".format(i))
S
Shuduo Sang 已提交
517
            self.inUse.remove(i)  # KeyError possible, TODO: why?
518 519 520 521

    def size(self):
        return self.lastIndex + 1 - self.firstIndex

S
Steven Li 已提交
522
    def pickAndAllocate(self):
S
Shuduo Sang 已提交
523
        if (self.isEmpty()):
524 525
            return None
        with self._lock:
S
Shuduo Sang 已提交
526
            cnt = 0  # counting the interations
527 528
            while True:
                cnt += 1
S
Shuduo Sang 已提交
529
                if (cnt > self.size() * 10):  # 10x iteration already
530 531
                    # raise RuntimeError("Failed to allocate LinearQueue element")
                    return None
S
Shuduo Sang 已提交
532 533
                ret = Dice.throwRange(self.firstIndex, self.lastIndex + 1)
                if (ret not in self.inUse):
534 535 536
                    self.allocate(ret)
                    return ret

S
Shuduo Sang 已提交
537

538
class DbConn:
539
    TYPE_NATIVE = "native-c"
540
    TYPE_REST =   "rest-api"
541 542 543 544 545 546 547 548 549
    TYPE_INVALID = "invalid"

    @classmethod
    def create(cls, connType):
        if connType == cls.TYPE_NATIVE:
            return DbConnNative()
        elif connType == cls.TYPE_REST:
            return DbConnRest()
        else:
S
Shuduo Sang 已提交
550 551
            raise RuntimeError(
                "Unexpected connection type: {}".format(connType))
552 553 554 555 556 557 558 559 560

    @classmethod
    def createNative(cls):
        return cls.create(cls.TYPE_NATIVE)

    @classmethod
    def createRest(cls):
        return cls.create(cls.TYPE_REST)

561 562
    def __init__(self):
        self.isOpen = False
563 564 565
        self._type = self.TYPE_INVALID

    def open(self):
S
Shuduo Sang 已提交
566
        if (self.isOpen):
567 568
            raise RuntimeError("Cannot re-open an existing DB connection")

569 570
        # below implemented by child classes
        self.openByType()
571

S
Shuduo Sang 已提交
572 573 574
        logger.debug(
            "[DB] data connection opened, type = {}".format(
                self._type))
575 576
        self.isOpen = True

S
Shuduo Sang 已提交
577 578 579 580
    def resetDb(self):  # reset the whole database, etc.
        if (not self.isOpen):
            raise RuntimeError(
                "Cannot reset database until connection is open")
581 582
        # self._tdSql.prepare() # Recreate database, etc.

583
        self.execute('drop database if exists db')
584 585
        logger.debug("Resetting DB, dropped database")
        # self._cursor.execute('create database db')
586
        # self._cursor.execute('use db')
587 588
        # tdSql.execute('show databases')

S
Shuduo Sang 已提交
589
    def queryScalar(self, sql) -> int:
590 591
        return self._queryAny(sql)

S
Shuduo Sang 已提交
592
    def queryString(self, sql) -> str:
593 594
        return self._queryAny(sql)

S
Shuduo Sang 已提交
595 596 597 598
    def _queryAny(self, sql):  # actual query result as an int
        if (not self.isOpen):
            raise RuntimeError(
                "Cannot query database until connection is open")
599
        nRows = self.query(sql)
S
Shuduo Sang 已提交
600 601 602 603
        if nRows != 1:
            raise RuntimeError(
                "Unexpected result for query: {}, rows = {}".format(
                    sql, nRows))
604
        if self.getResultRows() != 1 or self.getResultCols() != 1:
S
Shuduo Sang 已提交
605 606
            raise RuntimeError(
                "Unexpected result set for query: {}".format(sql))
607 608 609 610
        return self.getQueryResult()[0][0]

    def execute(self, sql):
        raise RuntimeError("Unexpected execution, should be overriden")
S
Shuduo Sang 已提交
611

612 613
    def openByType(self):
        raise RuntimeError("Unexpected execution, should be overriden")
S
Shuduo Sang 已提交
614

615 616
    def getQueryResult(self):
        raise RuntimeError("Unexpected execution, should be overriden")
S
Shuduo Sang 已提交
617

618 619
    def getResultRows(self):
        raise RuntimeError("Unexpected execution, should be overriden")
S
Shuduo Sang 已提交
620

621 622 623 624
    def getResultCols(self):
        raise RuntimeError("Unexpected execution, should be overriden")

# Sample: curl -u root:taosdata -d "show databases" localhost:6020/rest/sql
S
Shuduo Sang 已提交
625 626


627 628 629 630
class DbConnRest(DbConn):
    def __init__(self):
        super().__init__()
        self._type = self.TYPE_REST
S
Shuduo Sang 已提交
631
        self._url = "http://localhost:6020/rest/sql"  # fixed for now
632 633
        self._result = None

S
Shuduo Sang 已提交
634 635 636
    def openByType(self):  # Open connection
        pass  # do nothing, always open

637
    def close(self):
S
Shuduo Sang 已提交
638 639 640
        if (not self.isOpen):
            raise RuntimeError(
                "Cannot clean up database until connection is open")
641 642 643 644 645
        # Do nothing for REST
        logger.debug("[DB] REST Database connection closed")
        self.isOpen = False

    def _doSql(self, sql):
646 647 648 649 650 651 652
        try:
            r = requests.post(self._url, 
                data = sql,
                auth = HTTPBasicAuth('root', 'taosdata'))            
        except:
            print("REST API Failure (TODO: more info here)")
            raise
653 654
        rj = r.json()
        # Sanity check for the "Json Result"
S
Shuduo Sang 已提交
655
        if ('status' not in rj):
656 657
            raise RuntimeError("No status in REST response")

S
Shuduo Sang 已提交
658 659 660 661
        if rj['status'] == 'error':  # clearly reported error
            if ('code' not in rj):  # error without code
                raise RuntimeError("REST error return without code")
            errno = rj['code']  # May need to massage this in the future
662
            # print("Raising programming error with REST return: {}".format(rj))
S
Shuduo Sang 已提交
663 664
            raise taos.error.ProgrammingError(
                rj['desc'], errno)  # todo: check existance of 'desc'
665

S
Shuduo Sang 已提交
666 667 668 669
        if rj['status'] != 'succ':  # better be this
            raise RuntimeError(
                "Unexpected REST return status: {}".format(
                    rj['status']))
670 671

        nRows = rj['rows'] if ('rows' in rj) else 0
S
Shuduo Sang 已提交
672
        self._result = rj
673 674
        return nRows

S
Shuduo Sang 已提交
675 676 677 678
    def execute(self, sql):
        if (not self.isOpen):
            raise RuntimeError(
                "Cannot execute database commands until connection is open")
679 680
        logger.debug("[SQL-REST] Executing SQL: {}".format(sql))
        nRows = self._doSql(sql)
S
Shuduo Sang 已提交
681 682
        logger.debug(
            "[SQL-REST] Execution Result, nRows = {}, SQL = {}".format(nRows, sql))
683 684
        return nRows

S
Shuduo Sang 已提交
685
    def query(self, sql):  # return rows affected
686 687 688 689 690 691 692 693 694 695 696 697 698
        return self.execute(sql)

    def getQueryResult(self):
        return self._result['data']

    def getResultRows(self):
        print(self._result)
        raise RuntimeError("TBD")
        # return self._tdSql.queryRows

    def getResultCols(self):
        print(self._result)
        raise RuntimeError("TBD")
S
Shuduo Sang 已提交
699

700
    # Duplicate code from TDMySQL, TODO: merge all this into DbConnNative
701 702


703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730
class MyTDSql:
    def __init__(self):
        self.queryRows = 0
        self.queryCols = 0
        self.affectedRows = 0

    def init(self, cursor, log=True):
        self.cursor = cursor
        # if (log):
        #     caller = inspect.getframeinfo(inspect.stack()[1][0])
        #     self.cursor.log(caller.filename + ".sql")

    def close(self):
        self.cursor.close()

    def query(self, sql):
        self.sql = sql
        try:
            self.cursor.execute(sql)
            self.queryResult = self.cursor.fetchall()
            self.queryRows = len(self.queryResult)
            self.queryCols = len(self.cursor.description)
        except Exception as e:
            # caller = inspect.getframeinfo(inspect.stack()[1][0])
            # args = (caller.filename, caller.lineno, sql, repr(e))
            # tdLog.exit("%s(%d) failed: sql:%s, %s" % args)
            raise
        return self.queryRows
731

732 733 734 735 736 737 738 739 740 741 742
    def execute(self, sql):
        self.sql = sql
        try:
            self.affectedRows = self.cursor.execute(sql)
        except Exception as e:
            # caller = inspect.getframeinfo(inspect.stack()[1][0])
            # args = (caller.filename, caller.lineno, sql, repr(e))
            # tdLog.exit("%s(%d) failed: sql:%s, %s" % args)
            raise
        return self.affectedRows

S
Shuduo Sang 已提交
743

744 745 746
class DbConnNative(DbConn):
    def __init__(self):
        super().__init__()
747
        self._type = self.TYPE_NATIVE
S
Shuduo Sang 已提交
748
        self._conn = None
749
        self._cursor = None
S
Shuduo Sang 已提交
750

751 752 753 754 755 756 757 758 759 760 761
    def getBuildPath(self):
        selfPath = os.path.dirname(os.path.realpath(__file__))
        if ("community" in selfPath):
            projPath = selfPath[:selfPath.find("communit")]
        else:
            projPath = selfPath[:selfPath.find("tests")]

        for root, dirs, files in os.walk(projPath):
            if ("taosd" in files):
                rootRealPath = os.path.dirname(os.path.realpath(root))
                if ("packaging" not in rootRealPath):
S
Shuduo Sang 已提交
762
                    buildPath = root[:len(root) - len("/build/bin")]
763 764 765
                    break
        return buildPath

S
Shuduo Sang 已提交
766
    def openByType(self):  # Open connection
767
        cfgPath = self.getBuildPath() + "/test/cfg"
S
Shuduo Sang 已提交
768 769 770
        self._conn = taos.connect(
            host="127.0.0.1",
            config=cfgPath)  # TODO: make configurable
771 772 773 774
        self._cursor = self._conn.cursor()

        # Get the connection/cursor ready
        self._cursor.execute('reset query cache')
S
Shuduo Sang 已提交
775 776
        # self._cursor.execute('use db') # do this at the beginning of every
        # step
777 778

        # Open connection
779
        self._tdSql = MyTDSql()
780
        self._tdSql.init(self._cursor)
S
Shuduo Sang 已提交
781

782
    def close(self):
S
Shuduo Sang 已提交
783 784 785
        if (not self.isOpen):
            raise RuntimeError(
                "Cannot clean up database until connection is open")
786
        self._tdSql.close()
787
        logger.debug("[DB] Database connection closed")
788
        self.isOpen = False
S
Steven Li 已提交
789

S
Shuduo Sang 已提交
790 791 792 793
    def execute(self, sql):
        if (not self.isOpen):
            raise RuntimeError(
                "Cannot execute database commands until connection is open")
794 795
        logger.debug("[SQL] Executing SQL: {}".format(sql))
        nRows = self._tdSql.execute(sql)
S
Shuduo Sang 已提交
796 797 798
        logger.debug(
            "[SQL] Execution Result, nRows = {}, SQL = {}".format(
                nRows, sql))
799
        return nRows
S
Steven Li 已提交
800

S
Shuduo Sang 已提交
801 802 803 804
    def query(self, sql):  # return rows affected
        if (not self.isOpen):
            raise RuntimeError(
                "Cannot query database until connection is open")
805 806
        logger.debug("[SQL] Executing SQL: {}".format(sql))
        nRows = self._tdSql.query(sql)
S
Shuduo Sang 已提交
807 808 809
        logger.debug(
            "[SQL] Query Result, nRows = {}, SQL = {}".format(
                nRows, sql))
810
        return nRows
811
        # results are in: return self._tdSql.queryResult
812

813 814 815
    def getQueryResult(self):
        return self._tdSql.queryResult

816 817
    def getResultRows(self):
        return self._tdSql.queryRows
818

819 820
    def getResultCols(self):
        return self._tdSql.queryCols
821

S
Shuduo Sang 已提交
822

823
class AnyState:
S
Shuduo Sang 已提交
824 825 826
    STATE_INVALID = -1
    STATE_EMPTY = 0  # nothing there, no even a DB
    STATE_DB_ONLY = 1  # we have a DB, but nothing else
827
    STATE_TABLE_ONLY = 2  # we have a table, but totally empty
S
Shuduo Sang 已提交
828
    STATE_HAS_DATA = 3  # we have some data in the table
829 830 831 832 833
    _stateNames = ["Invalid", "Empty", "DB_Only", "Table_Only", "Has_Data"]

    STATE_VAL_IDX = 0
    CAN_CREATE_DB = 1
    CAN_DROP_DB = 2
834 835
    CAN_CREATE_FIXED_SUPER_TABLE = 3
    CAN_DROP_FIXED_SUPER_TABLE = 4
836 837 838 839 840 841 842
    CAN_ADD_DATA = 5
    CAN_READ_DATA = 6

    def __init__(self):
        self._info = self.getInfo()

    def __str__(self):
S
Shuduo Sang 已提交
843 844
        # -1 hack to accomodate the STATE_INVALID case
        return self._stateNames[self._info[self.STATE_VAL_IDX] + 1]
845 846 847 848

    def getInfo(self):
        raise RuntimeError("Must be overriden by child classes")

S
Steven Li 已提交
849 850 851 852 853 854
    def equals(self, other):
        if isinstance(other, int):
            return self.getValIndex() == other
        elif isinstance(other, AnyState):
            return self.getValIndex() == other.getValIndex()
        else:
S
Shuduo Sang 已提交
855 856 857
            raise RuntimeError(
                "Unexpected comparison, type = {}".format(
                    type(other)))
S
Steven Li 已提交
858

859 860 861
    def verifyTasksToState(self, tasks, newState):
        raise RuntimeError("Must be overriden by child classes")

S
Steven Li 已提交
862 863 864
    def getValIndex(self):
        return self._info[self.STATE_VAL_IDX]

865 866
    def getValue(self):
        return self._info[self.STATE_VAL_IDX]
S
Shuduo Sang 已提交
867

868 869
    def canCreateDb(self):
        return self._info[self.CAN_CREATE_DB]
S
Shuduo Sang 已提交
870

871 872
    def canDropDb(self):
        return self._info[self.CAN_DROP_DB]
S
Shuduo Sang 已提交
873

874 875
    def canCreateFixedSuperTable(self):
        return self._info[self.CAN_CREATE_FIXED_SUPER_TABLE]
S
Shuduo Sang 已提交
876

877 878
    def canDropFixedSuperTable(self):
        return self._info[self.CAN_DROP_FIXED_SUPER_TABLE]
S
Shuduo Sang 已提交
879

880 881
    def canAddData(self):
        return self._info[self.CAN_ADD_DATA]
S
Shuduo Sang 已提交
882

883 884 885 886 887
    def canReadData(self):
        return self._info[self.CAN_READ_DATA]

    def assertAtMostOneSuccess(self, tasks, cls):
        sCnt = 0
S
Shuduo Sang 已提交
888
        for task in tasks:
889 890 891
            if not isinstance(task, cls):
                continue
            if task.isSuccess():
S
Steven Li 已提交
892
                # task.logDebug("Task success found")
893
                sCnt += 1
S
Shuduo Sang 已提交
894 895 896
                if (sCnt >= 2):
                    raise RuntimeError(
                        "Unexpected more than 1 success with task: {}".format(cls))
897 898 899 900

    def assertIfExistThenSuccess(self, tasks, cls):
        sCnt = 0
        exists = False
S
Shuduo Sang 已提交
901
        for task in tasks:
902 903
            if not isinstance(task, cls):
                continue
S
Shuduo Sang 已提交
904
            exists = True  # we have a valid instance
905 906
            if task.isSuccess():
                sCnt += 1
S
Shuduo Sang 已提交
907 908 909
        if (exists and sCnt <= 0):
            raise RuntimeError(
                "Unexpected zero success for task: {}".format(cls))
910 911

    def assertNoTask(self, tasks, cls):
S
Shuduo Sang 已提交
912
        for task in tasks:
913
            if isinstance(task, cls):
S
Shuduo Sang 已提交
914 915
                raise CrashGenError(
                    "This task: {}, is not expected to be present, given the success/failure of others".format(cls.__name__))
916 917

    def assertNoSuccess(self, tasks, cls):
S
Shuduo Sang 已提交
918
        for task in tasks:
919 920
            if isinstance(task, cls):
                if task.isSuccess():
S
Shuduo Sang 已提交
921 922
                    raise RuntimeError(
                        "Unexpected successful task: {}".format(cls))
923 924

    def hasSuccess(self, tasks, cls):
S
Shuduo Sang 已提交
925
        for task in tasks:
926 927 928 929 930 931
            if not isinstance(task, cls):
                continue
            if task.isSuccess():
                return True
        return False

S
Steven Li 已提交
932
    def hasTask(self, tasks, cls):
S
Shuduo Sang 已提交
933
        for task in tasks:
S
Steven Li 已提交
934 935 936 937
            if isinstance(task, cls):
                return True
        return False

S
Shuduo Sang 已提交
938

939 940 941 942
class StateInvalid(AnyState):
    def getInfo(self):
        return [
            self.STATE_INVALID,
S
Shuduo Sang 已提交
943 944 945
            False, False,  # can create/drop Db
            False, False,  # can create/drop fixed table
            False, False,  # can insert/read data with fixed table
946 947 948 949
        ]

    # def verifyTasksToState(self, tasks, newState):

S
Shuduo Sang 已提交
950

951 952 953 954
class StateEmpty(AnyState):
    def getInfo(self):
        return [
            self.STATE_EMPTY,
S
Shuduo Sang 已提交
955 956 957
            True, False,  # can create/drop Db
            False, False,  # can create/drop fixed table
            False, False,  # can insert/read data with fixed table
958 959
        ]

S
Shuduo Sang 已提交
960 961
    def verifyTasksToState(self, tasks, newState):
        if (self.hasSuccess(tasks, TaskCreateDb)
962
                ):  # at EMPTY, if there's succes in creating DB
S
Shuduo Sang 已提交
963 964 965 966
            if (not self.hasTask(tasks, TaskDropDb)):  # and no drop_db tasks
                # we must have at most one. TODO: compare numbers
                self.assertAtMostOneSuccess(tasks, TaskCreateDb)

967 968 969 970 971 972 973 974 975 976 977

class StateDbOnly(AnyState):
    def getInfo(self):
        return [
            self.STATE_DB_ONLY,
            False, True,
            True, False,
            False, False,
        ]

    def verifyTasksToState(self, tasks, newState):
S
Shuduo Sang 已提交
978 979 980
        if (not self.hasTask(tasks, TaskCreateDb)):
            # only if we don't create any more
            self.assertAtMostOneSuccess(tasks, TaskDropDb)
981
        self.assertIfExistThenSuccess(tasks, TaskDropDb)
S
Steven Li 已提交
982
        # self.assertAtMostOneSuccess(tasks, CreateFixedTableTask) # not true in massively parrallel cases
983
        # Nothing to be said about adding data task
984
        # if ( self.hasSuccess(tasks, DropDbTask) ): # dropped the DB
S
Shuduo Sang 已提交
985 986 987
        # self.assertHasTask(tasks, DropDbTask) # implied by hasSuccess
        # self.assertAtMostOneSuccess(tasks, DropDbTask)
        # self._state = self.STATE_EMPTY
988 989
        # if ( self.hasSuccess(tasks, TaskCreateSuperTable) ): # did not drop db, create table success
        #     # self.assertHasTask(tasks, CreateFixedTableTask) # tried to create table
S
Shuduo Sang 已提交
990
        #     if ( not self.hasTask(tasks, TaskDropSuperTable) ):
991
        #         self.assertAtMostOneSuccess(tasks, TaskCreateSuperTable) # at most 1 attempt is successful, if we don't drop anything
S
Shuduo Sang 已提交
992 993 994 995 996 997
        # self.assertNoTask(tasks, DropDbTask) # should have have tried
        # if ( not self.hasSuccess(tasks, AddFixedDataTask) ): # just created table, no data yet
        #     # can't say there's add-data attempts, since they may all fail
        #     self._state = self.STATE_TABLE_ONLY
        # else:
        #     self._state = self.STATE_HAS_DATA
998 999 1000 1001
        # What about AddFixedData?
        # elif ( self.hasSuccess(tasks, AddFixedDataTask) ):
        #     self._state = self.STATE_HAS_DATA
        # else: # no success in dropping db tasks, no success in create fixed table? read data should also fail
S
Shuduo Sang 已提交
1002
        #     # raise RuntimeError("Unexpected no-success scenario")   # We might just landed all failure tasks,
1003 1004
        #     self._state = self.STATE_DB_ONLY  # no change

S
Shuduo Sang 已提交
1005

1006
class StateSuperTableOnly(AnyState):
1007 1008 1009 1010 1011 1012 1013 1014 1015
    def getInfo(self):
        return [
            self.STATE_TABLE_ONLY,
            False, True,
            False, True,
            True, True,
        ]

    def verifyTasksToState(self, tasks, newState):
S
Shuduo Sang 已提交
1016
        if (self.hasSuccess(tasks, TaskDropSuperTable)
1017
                ):  # we are able to drop the table
1018
            #self.assertAtMostOneSuccess(tasks, TaskDropSuperTable)
S
Shuduo Sang 已提交
1019 1020
            # we must have had recreted it
            self.hasSuccess(tasks, TaskCreateSuperTable)
1021

1022
            # self._state = self.STATE_DB_ONLY
S
Steven Li 已提交
1023 1024
        # elif ( self.hasSuccess(tasks, AddFixedDataTask) ): # no success dropping the table, but added data
        #     self.assertNoTask(tasks, DropFixedTableTask) # not true in massively parrallel cases
1025
            # self._state = self.STATE_HAS_DATA
S
Steven Li 已提交
1026 1027 1028
        # elif ( self.hasSuccess(tasks, ReadFixedDataTask) ): # no success in prev cases, but was able to read data
            # self.assertNoTask(tasks, DropFixedTableTask)
            # self.assertNoTask(tasks, AddFixedDataTask)
1029
            # self._state = self.STATE_TABLE_ONLY # no change
S
Steven Li 已提交
1030 1031 1032
        # else: # did not drop table, did not insert data, did not read successfully, that is impossible
        #     raise RuntimeError("Unexpected no-success scenarios")
        # TODO: need to revamp!!
1033

S
Shuduo Sang 已提交
1034

1035 1036 1037 1038 1039 1040 1041 1042 1043 1044
class StateHasData(AnyState):
    def getInfo(self):
        return [
            self.STATE_HAS_DATA,
            False, True,
            False, True,
            True, True,
        ]

    def verifyTasksToState(self, tasks, newState):
S
Shuduo Sang 已提交
1045
        if (newState.equals(AnyState.STATE_EMPTY)):
1046
            self.hasSuccess(tasks, TaskDropDb)
S
Shuduo Sang 已提交
1047 1048 1049 1050
            if (not self.hasTask(tasks, TaskCreateDb)):
                self.assertAtMostOneSuccess(tasks, TaskDropDb)  # TODO: dicy
        elif (newState.equals(AnyState.STATE_DB_ONLY)):  # in DB only
            if (not self.hasTask(tasks, TaskCreateDb)
1051
                ):  # without a create_db task
S
Shuduo Sang 已提交
1052 1053
                # we must have drop_db task
                self.assertNoTask(tasks, TaskDropDb)
1054
            self.hasSuccess(tasks, TaskDropSuperTable)
1055
            # self.assertAtMostOneSuccess(tasks, DropFixedSuperTableTask) # TODO: dicy
1056 1057 1058 1059
        # elif ( newState.equals(AnyState.STATE_TABLE_ONLY) ): # data deleted
            # self.assertNoTask(tasks, TaskDropDb)
            # self.assertNoTask(tasks, TaskDropSuperTable)
            # self.assertNoTask(tasks, TaskAddData)
S
Steven Li 已提交
1060
            # self.hasSuccess(tasks, DeleteDataTasks)
S
Shuduo Sang 已提交
1061 1062
        else:  # should be STATE_HAS_DATA
            if (not self.hasTask(tasks, TaskCreateDb)
1063
                ):  # only if we didn't create one
S
Shuduo Sang 已提交
1064 1065 1066
                # we shouldn't have dropped it
                self.assertNoTask(tasks, TaskDropDb)
            if (not self.hasTask(tasks, TaskCreateSuperTable)
1067
                    ):  # if we didn't create the table
S
Shuduo Sang 已提交
1068 1069
                # we should not have a task that drops it
                self.assertNoTask(tasks, TaskDropSuperTable)
1070
            # self.assertIfExistThenSuccess(tasks, ReadFixedDataTask)
S
Steven Li 已提交
1071

S
Shuduo Sang 已提交
1072

1073
class StateMechine:
1074 1075
    def __init__(self, dbConn):
        self._dbConn = dbConn
S
Shuduo Sang 已提交
1076 1077 1078 1079 1080
        self._curState = self._findCurrentState()  # starting state
        # transitition target probabilities, indexed with value of STATE_EMPTY,
        # STATE_DB_ONLY, etc.
        self._stateWeights = [1, 3, 5, 15]

1081 1082 1083
    def getCurrentState(self):
        return self._curState

1084 1085 1086
    def hasDatabase(self):
        return self._curState.canDropDb()  # ha, can drop DB means it has one

1087
    # May be slow, use cautionsly...
S
Shuduo Sang 已提交
1088
    def getTaskTypes(self):  # those that can run (directly/indirectly) from the current state
1089 1090 1091 1092 1093 1094
        def typesToStrings(types):
            ss = []
            for t in types:
                ss.append(t.__name__)
            return ss

S
Shuduo Sang 已提交
1095
        allTaskClasses = StateTransitionTask.__subclasses__()  # all state transition tasks
1096 1097
        firstTaskTypes = []
        for tc in allTaskClasses:
S
Shuduo Sang 已提交
1098
            # t = tc(self) # create task object
1099 1100
            if tc.canBeginFrom(self._curState):
                firstTaskTypes.append(tc)
S
Shuduo Sang 已提交
1101 1102 1103 1104 1105 1106 1107 1108
        # now we have all the tasks that can begin directly from the current
        # state, let's figure out the INDIRECT ones
        taskTypes = firstTaskTypes.copy()  # have to have these
        for task1 in firstTaskTypes:  # each task type gathered so far
            endState = task1.getEndState()  # figure the end state
            if endState is None:  # does not change end state
                continue  # no use, do nothing
            for tc in allTaskClasses:  # what task can further begin from there?
1109
                if tc.canBeginFrom(endState) and (tc not in firstTaskTypes):
S
Shuduo Sang 已提交
1110
                    taskTypes.append(tc)  # gather it
1111 1112

        if len(taskTypes) <= 0:
S
Shuduo Sang 已提交
1113 1114 1115 1116 1117 1118 1119
            raise RuntimeError(
                "No suitable task types found for state: {}".format(
                    self._curState))
        logger.debug(
            "[OPS] Tasks found for state {}: {}".format(
                self._curState,
                typesToStrings(taskTypes)))
1120 1121 1122 1123
        return taskTypes

    def _findCurrentState(self):
        dbc = self._dbConn
S
Shuduo Sang 已提交
1124 1125
        ts = time.time()  # we use this to debug how fast/slow it is to do the various queries to find the current DB state
        if dbc.query("show databases") == 0:  # no database?!
1126
            # logger.debug("Found EMPTY state")
S
Shuduo Sang 已提交
1127 1128 1129
            logger.debug(
                "[STT] empty database found, between {} and {}".format(
                    ts, time.time()))
1130
            return StateEmpty()
S
Shuduo Sang 已提交
1131 1132 1133 1134
        # did not do this when openning connection, and this is NOT the worker
        # thread, which does this on their own
        dbc.execute("use db")
        if dbc.query("show tables") == 0:  # no tables
1135
            # logger.debug("Found DB ONLY state")
S
Shuduo Sang 已提交
1136 1137 1138
            logger.debug(
                "[STT] DB_ONLY found, between {} and {}".format(
                    ts, time.time()))
1139
            return StateDbOnly()
S
Shuduo Sang 已提交
1140 1141
        if dbc.query("SELECT * FROM db.{}".format(DbManager.getFixedSuperTableName())
                     ) == 0:  # no regular tables
1142
            # logger.debug("Found TABLE_ONLY state")
S
Shuduo Sang 已提交
1143 1144 1145
            logger.debug(
                "[STT] SUPER_TABLE_ONLY found, between {} and {}".format(
                    ts, time.time()))
1146
            return StateSuperTableOnly()
S
Shuduo Sang 已提交
1147
        else:  # has actual tables
1148
            # logger.debug("Found HAS_DATA state")
S
Shuduo Sang 已提交
1149 1150 1151
            logger.debug(
                "[STT] HAS_DATA found, between {} and {}".format(
                    ts, time.time()))
1152 1153 1154
            return StateHasData()

    def transition(self, tasks):
S
Shuduo Sang 已提交
1155
        if (len(tasks) == 0):  # before 1st step, or otherwise empty
1156
            logger.debug("[STT] Starting State: {}".format(self._curState))
S
Shuduo Sang 已提交
1157
            return  # do nothing
1158

S
Shuduo Sang 已提交
1159 1160
        # this should show up in the server log, separating steps
        self._dbConn.execute("show dnodes")
1161 1162 1163 1164

        # Generic Checks, first based on the start state
        if self._curState.canCreateDb():
            self._curState.assertIfExistThenSuccess(tasks, TaskCreateDb)
S
Shuduo Sang 已提交
1165 1166
            # self.assertAtMostOneSuccess(tasks, CreateDbTask) # not really, in
            # case of multiple creation and drops
1167 1168 1169

        if self._curState.canDropDb():
            self._curState.assertIfExistThenSuccess(tasks, TaskDropDb)
S
Shuduo Sang 已提交
1170 1171
            # self.assertAtMostOneSuccess(tasks, DropDbTask) # not really in
            # case of drop-create-drop
1172 1173 1174

        # if self._state.canCreateFixedTable():
            # self.assertIfExistThenSuccess(tasks, CreateFixedTableTask) # Not true, DB may be dropped
S
Shuduo Sang 已提交
1175 1176
            # self.assertAtMostOneSuccess(tasks, CreateFixedTableTask) # not
            # really, in case of create-drop-create
1177 1178 1179

        # if self._state.canDropFixedTable():
            # self.assertIfExistThenSuccess(tasks, DropFixedTableTask) # Not True, the whole DB may be dropped
S
Shuduo Sang 已提交
1180 1181
            # self.assertAtMostOneSuccess(tasks, DropFixedTableTask) # not
            # really in case of drop-create-drop
1182 1183

        # if self._state.canAddData():
S
Shuduo Sang 已提交
1184 1185
        # self.assertIfExistThenSuccess(tasks, AddFixedDataTask)  # not true
        # actually
1186 1187 1188 1189 1190 1191

        # if self._state.canReadData():
            # Nothing for sure

        newState = self._findCurrentState()
        logger.debug("[STT] New DB state determined: {}".format(newState))
S
Shuduo Sang 已提交
1192 1193
        # can old state move to new state through the tasks?
        self._curState.verifyTasksToState(tasks, newState)
1194 1195 1196
        self._curState = newState

    def pickTaskType(self):
S
Shuduo Sang 已提交
1197 1198
        # all the task types we can choose from at curent state
        taskTypes = self.getTaskTypes()
1199 1200 1201
        weights = []
        for tt in taskTypes:
            endState = tt.getEndState()
S
Shuduo Sang 已提交
1202 1203 1204
            if endState is not None:
                # TODO: change to a method
                weights.append(self._stateWeights[endState.getValIndex()])
1205
            else:
S
Shuduo Sang 已提交
1206 1207
                # read data task, default to 10: TODO: change to a constant
                weights.append(10)
1208
        i = self._weighted_choice_sub(weights)
S
Shuduo Sang 已提交
1209
        # logger.debug(" (weighted random:{}/{}) ".format(i, len(taskTypes)))
1210 1211
        return taskTypes[i]

S
Shuduo Sang 已提交
1212 1213 1214 1215 1216
    # ref:
    # https://eli.thegreenplace.net/2010/01/22/weighted-random-generation-in-python/
    def _weighted_choice_sub(self, weights):
        # TODO: use our dice to ensure it being determinstic?
        rnd = random.random() * sum(weights)
1217 1218 1219 1220
        for i, w in enumerate(weights):
            rnd -= w
            if rnd < 0:
                return i
1221

1222
# Manager of the Database Data/Connection
S
Shuduo Sang 已提交
1223 1224 1225 1226


class DbManager():
    def __init__(self, resetDb=True):
S
Steven Li 已提交
1227
        self.tableNumQueue = LinearQueue()
S
Shuduo Sang 已提交
1228 1229 1230
        # datetime.datetime(2019, 1, 1) # initial date time tick
        self._lastTick = self.setupLastTick()
        self._lastInt = 0  # next one is initial integer
1231
        self._lock = threading.RLock()
S
Shuduo Sang 已提交
1232

1233
        # self.openDbServerConnection()
S
Shuduo Sang 已提交
1234 1235
        self._dbConn = DbConn.createNative() if (
            gConfig.connector_type == 'native') else DbConn.createRest()
1236
        try:
S
Shuduo Sang 已提交
1237
            self._dbConn.open()  # may throw taos.error.ProgrammingError: disconnected
1238 1239
        except taos.error.ProgrammingError as err:
            # print("Error type: {}, msg: {}, value: {}".format(type(err), err.msg, err))
S
Shuduo Sang 已提交
1240 1241 1242
            if (err.msg == 'client disconnected'):  # cannot open DB connection
                print(
                    "Cannot establish DB connection, please re-run script without parameter, and follow the instructions.")
S
Steven Li 已提交
1243
                sys.exit(2)
1244
            else:
S
Shuduo Sang 已提交
1245 1246
                raise
        except BaseException:
S
Steven Li 已提交
1247
            print("[=] Unexpected exception")
S
Shuduo Sang 已提交
1248 1249 1250 1251
            raise

        if resetDb:
            self._dbConn.resetDb()  # drop and recreate DB
1252

S
Shuduo Sang 已提交
1253 1254
        # Do this after dbConn is in proper shape
        self._stateMachine = StateMechine(self._dbConn)
1255

1256 1257 1258
    def getDbConn(self):
        return self._dbConn

S
Shuduo Sang 已提交
1259
    def getStateMachine(self) -> StateMechine:
1260 1261 1262 1263
        return self._stateMachine

    # def getState(self):
    #     return self._stateMachine.getCurrentState()
1264 1265 1266 1267 1268 1269

    # We aim to create a starting time tick, such that, whenever we run our test here once
    # We should be able to safely create 100,000 records, which will not have any repeated time stamp
    # when we re-run the test in 3 minutes (180 seconds), basically we should expand time duration
    # by a factor of 500.
    # TODO: what if it goes beyond 10 years into the future
1270
    # TODO: fix the error as result of above: "tsdb timestamp is out of range"
1271
    def setupLastTick(self):
1272
        t1 = datetime.datetime(2020, 6, 1)
1273
        t2 = datetime.datetime.now()
S
Shuduo Sang 已提交
1274 1275 1276 1277
        # maybe a very large number, takes 69 years to exceed Python int range
        elSec = int(t2.timestamp() - t1.timestamp())
        elSec2 = (elSec % (8 * 12 * 30 * 24 * 60 * 60 / 500)) * \
            500  # a number representing seconds within 10 years
1278
        # print("elSec = {}".format(elSec))
S
Shuduo Sang 已提交
1279 1280 1281
        t3 = datetime.datetime(2012, 1, 1)  # default "keep" is 10 years
        t4 = datetime.datetime.fromtimestamp(
            t3.timestamp() + elSec2)  # see explanation above
1282 1283 1284
        logger.info("Setting up TICKS to start from: {}".format(t4))
        return t4

S
Shuduo Sang 已提交
1285
    def pickAndAllocateTable(self):  # pick any table, and "use" it
S
Steven Li 已提交
1286 1287
        return self.tableNumQueue.pickAndAllocate()

1288 1289 1290 1291 1292
    def addTable(self):
        with self._lock:
            tIndex = self.tableNumQueue.push()
        return tIndex

1293 1294
    @classmethod
    def getFixedSuperTableName(cls):
1295
        return "fs_table"
1296

S
Shuduo Sang 已提交
1297
    def releaseTable(self, i):  # return the table back, so others can use it
S
Steven Li 已提交
1298 1299
        self.tableNumQueue.release(i)

1300
    def getNextTick(self):
S
Shuduo Sang 已提交
1301 1302
        with self._lock:  # prevent duplicate tick
            if Dice.throw(10) == 0:  # 1 in 10 chance
S
Steven Li 已提交
1303
                return self._lastTick + datetime.timedelta(0, -100)
S
Shuduo Sang 已提交
1304 1305 1306
            else:  # regular
                # add one second to it
                self._lastTick += datetime.timedelta(0, 1)
S
Steven Li 已提交
1307
                return self._lastTick
1308 1309

    def getNextInt(self):
1310 1311 1312
        with self._lock:
            self._lastInt += 1
            return self._lastInt
1313 1314

    def getNextBinary(self):
S
Shuduo Sang 已提交
1315 1316
        return "Beijing_Shanghai_Los_Angeles_New_York_San_Francisco_Chicago_Beijing_Shanghai_Los_Angeles_New_York_San_Francisco_Chicago_{}".format(
            self.getNextInt())
1317 1318 1319

    def getNextFloat(self):
        return 0.9 + self.getNextInt()
S
Shuduo Sang 已提交
1320

S
Steven Li 已提交
1321
    def getTableNameToDelete(self):
S
Shuduo Sang 已提交
1322 1323
        tblNum = self.tableNumQueue.pop()  # TODO: race condition!
        if (not tblNum):  # maybe false
1324
            return False
S
Shuduo Sang 已提交
1325

S
Steven Li 已提交
1326 1327
        return "table_{}".format(tblNum)

1328
    def cleanUp(self):
S
Shuduo Sang 已提交
1329 1330
        self._dbConn.close()

1331

1332
class TaskExecutor():
1333
    class BoundedList:
S
Shuduo Sang 已提交
1334
        def __init__(self, size=10):
1335 1336 1337
            self._size = size
            self._list = []

S
Shuduo Sang 已提交
1338 1339
        def add(self, n: int):
            if not self._list:  # empty
1340 1341 1342 1343 1344 1345 1346
                self._list.append(n)
                return
            # now we should insert
            nItems = len(self._list)
            insPos = 0
            for i in range(nItems):
                insPos = i
S
Shuduo Sang 已提交
1347 1348 1349
                if n <= self._list[i]:  # smaller than this item, time to insert
                    break  # found the insertion point
                insPos += 1  # insert to the right
1350

S
Shuduo Sang 已提交
1351 1352
            if insPos == 0:  # except for the 1st item, # TODO: elimiate first item as gating item
                return  # do nothing
1353 1354

            # print("Inserting at postion {}, value: {}".format(insPos, n))
S
Shuduo Sang 已提交
1355 1356
            self._list.insert(insPos, n)  # insert

1357
            newLen = len(self._list)
S
Shuduo Sang 已提交
1358 1359 1360 1361 1362
            if newLen <= self._size:
                return  # do nothing
            elif newLen == (self._size + 1):
                del self._list[0]  # remove the first item
            else:
1363 1364 1365 1366 1367 1368 1369
                raise RuntimeError("Corrupt Bounded List")

        def __str__(self):
            return repr(self._list)

    _boundedList = BoundedList()

1370 1371 1372
    def __init__(self, curStep):
        self._curStep = curStep

1373 1374 1375 1376
    @classmethod
    def getBoundedList(cls):
        return cls._boundedList

1377 1378 1379
    def getCurStep(self):
        return self._curStep

S
Shuduo Sang 已提交
1380
    def execute(self, task: Task, wt: WorkerThread):  # execute a task on a thread
1381
        task.execute(wt)
1382

1383 1384 1385 1386
    def recordDataMark(self, n: int):
        # print("[{}]".format(n), end="", flush=True)
        self._boundedList.add(n)

1387 1388
    # def logInfo(self, msg):
    #     logger.info("    T[{}.x]: ".format(self._curStep) + msg)
1389

1390 1391
    # def logDebug(self, msg):
    #     logger.debug("    T[{}.x]: ".format(self._curStep) + msg)
1392

S
Shuduo Sang 已提交
1393

S
Steven Li 已提交
1394
class Task():
1395 1396 1397 1398
    taskSn = 100

    @classmethod
    def allocTaskNum(cls):
S
Shuduo Sang 已提交
1399
        Task.taskSn += 1  # IMPORTANT: cannot use cls.taskSn, since each sub class will have a copy
S
Steven Li 已提交
1400 1401
        # logger.debug("Allocating taskSN: {}".format(Task.taskSn))
        return Task.taskSn
1402

S
Shuduo Sang 已提交
1403
    def __init__(self, dbManager: DbManager, execStats: ExecutionStats):
1404
        self._dbManager = dbManager
S
Shuduo Sang 已提交
1405
        self._workerThread = None
1406
        self._err = None
1407
        self._aborted = False
1408
        self._curStep = None
S
Shuduo Sang 已提交
1409
        self._numRows = None  # Number of rows affected
1410

S
Shuduo Sang 已提交
1411
        # Assign an incremental task serial number
1412
        self._taskNum = self.allocTaskNum()
S
Steven Li 已提交
1413
        # logger.debug("Creating new task {}...".format(self._taskNum))
1414

1415
        self._execStats = execStats
S
Shuduo Sang 已提交
1416
        self._lastSql = ""  # last SQL executed/attempted
1417

1418
    def isSuccess(self):
S
Shuduo Sang 已提交
1419
        return self._err is None
1420

1421 1422 1423
    def isAborted(self):
        return self._aborted

S
Shuduo Sang 已提交
1424
    def clone(self):  # TODO: why do we need this again?
1425
        newTask = self.__class__(self._dbManager, self._execStats)
1426 1427 1428
        return newTask

    def logDebug(self, msg):
S
Shuduo Sang 已提交
1429 1430 1431
        self._workerThread.logDebug(
            "Step[{}.{}] {}".format(
                self._curStep, self._taskNum, msg))
1432 1433

    def logInfo(self, msg):
S
Shuduo Sang 已提交
1434 1435 1436
        self._workerThread.logInfo(
            "Step[{}.{}] {}".format(
                self._curStep, self._taskNum, msg))
1437

1438
    def _executeInternal(self, te: TaskExecutor, wt: WorkerThread):
S
Shuduo Sang 已提交
1439 1440 1441
        raise RuntimeError(
            "To be implemeted by child classes, class name: {}".format(
                self.__class__.__name__))
1442

1443 1444
    def execute(self, wt: WorkerThread):
        wt.verifyThreadSelf()
S
Shuduo Sang 已提交
1445
        self._workerThread = wt  # type: ignore
1446 1447

        te = wt.getTaskExecutor()
1448
        self._curStep = te.getCurStep()
S
Shuduo Sang 已提交
1449 1450
        self.logDebug(
            "[-] executing task {}...".format(self.__class__.__name__))
1451 1452

        self._err = None
S
Shuduo Sang 已提交
1453 1454
        self._execStats.beginTaskType(
            self.__class__.__name__)  # mark beginning
1455
        try:
S
Shuduo Sang 已提交
1456
            self._executeInternal(te, wt)  # TODO: no return value?
1457
        except taos.error.ProgrammingError as err:
S
Shuduo Sang 已提交
1458 1459
            errno2 = err.errno if (
                err.errno > 0) else 0x80000000 + err.errno  # correct error scheme
1460 1461 1462 1463
            if (gConfig.continue_on_exception):  # user choose to continue
                self.logDebug(
                    "[=] Continue after TAOS exception: errno=0x{:X}, msg: {}, SQL: {}".format(
                        errno2, err, self._lastSql))
1464
                self._err = err
1465
            elif (errno2 in [
S
Shuduo Sang 已提交
1466
                0x05,  # TSDB_CODE_RPC_NOT_READY
1467 1468 1469 1470
                0x200, 0x360, 0x362, 0x36A, 0x36B, 0x36D,
                0x381, 0x380, 0x383,
                0x386,  # DB is being dropped?!
                0x503,
S
Shuduo Sang 已提交
1471
                0x510,  # vnode not in ready state
1472
                0x600,
S
Shuduo Sang 已提交
1473 1474 1475 1476 1477
                1000  # REST catch-all error
            ]):  # allowed errors
                self.logDebug(
                    "[=] Acceptable Taos library exception: errno=0x{:X}, msg: {}, SQL: {}".format(
                        errno2, err, self._lastSql))
1478
                print("_", end="", flush=True)
S
Shuduo Sang 已提交
1479
                self._err = err
1480
            else:
S
Shuduo Sang 已提交
1481 1482
                errMsg = "[=] Unexpected Taos library exception: errno=0x{:X}, msg: {}, SQL: {}".format(
                    errno2, err, self._lastSql)
1483
                self.logDebug(errMsg)
S
Shuduo Sang 已提交
1484
                if gConfig.debug:
1485 1486
                    # raise # so that we see full stack
                    traceback.print_exc()
1487 1488
                print(
                    "\n\n----------------------------\nProgram ABORTED Due to Unexpected TAOS Error: \n\n{}\n".format(errMsg) +
1489 1490 1491 1492
                    "----------------------------\n")
                # sys.exit(-1)
                self._err = err
                self._aborted = True
S
Shuduo Sang 已提交
1493
        except Exception as e:
S
Steven Li 已提交
1494
            self.logInfo("Non-TAOS exception encountered")
S
Shuduo Sang 已提交
1495
            self._err = e
S
Steven Li 已提交
1496
            self._aborted = True
1497
            traceback.print_exc()
1498
        except BaseException as e:
1499
            self.logInfo("Python base exception encountered")
1500
            self._err = e
1501
            self._aborted = True
S
Steven Li 已提交
1502
            traceback.print_exc()
S
Shuduo Sang 已提交
1503 1504 1505 1506
        except BaseException:
            self.logDebug(
                "[=] Unexpected exception, SQL: {}".format(
                    self._lastSql))
1507
            raise
1508
        self._execStats.endTaskType(self.__class__.__name__, self.isSuccess())
S
Shuduo Sang 已提交
1509 1510 1511 1512 1513

        self.logDebug("[X] task execution completed, {}, status: {}".format(
            self.__class__.__name__, "Success" if self.isSuccess() else "Failure"))
        # TODO: merge with above.
        self._execStats.incExecCount(self.__class__.__name__, self.isSuccess())
S
Steven Li 已提交
1514

1515
    def execSql(self, sql):
1516
        self._lastSql = sql
1517
        return self._dbManager.execute(sql)
1518

S
Shuduo Sang 已提交
1519
    def execWtSql(self, wt: WorkerThread, sql):  # execute an SQL on the worker thread
1520 1521 1522
        self._lastSql = sql
        return wt.execSql(sql)

S
Shuduo Sang 已提交
1523
    def queryWtSql(self, wt: WorkerThread, sql):  # execute an SQL on the worker thread
1524 1525 1526
        self._lastSql = sql
        return wt.querySql(sql)

S
Shuduo Sang 已提交
1527
    def getQueryResult(self, wt: WorkerThread):  # execute an SQL on the worker thread
1528 1529 1530
        return wt.getQueryResult()


1531
class ExecutionStats:
1532
    def __init__(self):
S
Shuduo Sang 已提交
1533 1534
        # total/success times for a task
        self._execTimes: Dict[str, [int, int]] = {}
1535 1536 1537
        self._tasksInProgress = 0
        self._lock = threading.Lock()
        self._firstTaskStartTime = None
1538
        self._execStartTime = None
S
Shuduo Sang 已提交
1539 1540
        self._elapsedTime = 0.0  # total elapsed time
        self._accRunTime = 0.0  # accumulated run time
1541

1542 1543 1544
        self._failed = False
        self._failureReason = None

S
Steven Li 已提交
1545
    def __str__(self):
S
Shuduo Sang 已提交
1546 1547
        return "[ExecStats: _failed={}, _failureReason={}".format(
            self._failed, self._failureReason)
S
Steven Li 已提交
1548 1549

    def isFailed(self):
S
Shuduo Sang 已提交
1550
        return self._failed
S
Steven Li 已提交
1551

1552 1553 1554 1555 1556 1557
    def startExec(self):
        self._execStartTime = time.time()

    def endExec(self):
        self._elapsedTime = time.time() - self._execStartTime

S
Shuduo Sang 已提交
1558
    def incExecCount(self, klassName, isSuccess):  # TODO: add a lock here
1559 1560
        if klassName not in self._execTimes:
            self._execTimes[klassName] = [0, 0]
S
Shuduo Sang 已提交
1561 1562
        t = self._execTimes[klassName]  # tuple for the data
        t[0] += 1  # index 0 has the "total" execution times
1563
        if isSuccess:
S
Shuduo Sang 已提交
1564
            t[1] += 1  # index 1 has the "success" execution times
1565 1566 1567

    def beginTaskType(self, klassName):
        with self._lock:
S
Shuduo Sang 已提交
1568 1569
            if self._tasksInProgress == 0:  # starting a new round
                self._firstTaskStartTime = time.time()  # I am now the first task
1570 1571 1572 1573 1574
            self._tasksInProgress += 1

    def endTaskType(self, klassName, isSuccess):
        with self._lock:
            self._tasksInProgress -= 1
S
Shuduo Sang 已提交
1575
            if self._tasksInProgress == 0:  # all tasks have stopped
1576 1577 1578
                self._accRunTime += (time.time() - self._firstTaskStartTime)
                self._firstTaskStartTime = None

1579 1580 1581 1582
    def registerFailure(self, reason):
        self._failed = True
        self._failureReason = reason

1583
    def printStats(self):
S
Shuduo Sang 已提交
1584 1585 1586 1587 1588 1589
        logger.info(
            "----------------------------------------------------------------------")
        logger.info(
            "| Crash_Gen test {}, with the following stats:". format(
                "FAILED (reason: {})".format(
                    self._failureReason) if self._failed else "SUCCEEDED"))
1590
        logger.info("| Task Execution Times (success/total):")
1591
        execTimesAny = 0
S
Shuduo Sang 已提交
1592
        for k, n in self._execTimes.items():
1593
            execTimesAny += n[0]
S
Shuduo Sang 已提交
1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613
            logger.info("|    {0:<24}: {1}/{2}".format(k, n[1], n[0]))

        logger.info(
            "| Total Tasks Executed (success or not): {} ".format(execTimesAny))
        logger.info(
            "| Total Tasks In Progress at End: {}".format(
                self._tasksInProgress))
        logger.info(
            "| Total Task Busy Time (elapsed time when any task is in progress): {:.3f} seconds".format(
                self._accRunTime))
        logger.info(
            "| Average Per-Task Execution Time: {:.3f} seconds".format(self._accRunTime / execTimesAny))
        logger.info(
            "| Total Elapsed Time (from wall clock): {:.3f} seconds".format(
                self._elapsedTime))
        logger.info(
            "| Top numbers written: {}".format(
                TaskExecutor.getBoundedList()))
        logger.info(
            "----------------------------------------------------------------------")
1614 1615 1616


class StateTransitionTask(Task):
1617 1618 1619 1620 1621
    LARGE_NUMBER_OF_TABLES = 35
    SMALL_NUMBER_OF_TABLES = 3
    LARGE_NUMBER_OF_RECORDS = 50
    SMALL_NUMBER_OF_RECORDS = 3

1622
    @classmethod
S
Shuduo Sang 已提交
1623
    def getInfo(cls):  # each sub class should supply their own information
1624 1625
        raise RuntimeError("Overriding method expected")

S
Shuduo Sang 已提交
1626
    _endState = None
1627
    @classmethod
S
Shuduo Sang 已提交
1628
    def getEndState(cls):  # TODO: optimize by calling it fewer times
1629 1630
        raise RuntimeError("Overriding method expected")

1631 1632 1633
    # @classmethod
    # def getBeginStates(cls):
    #     return cls.getInfo()[0]
1634

1635 1636 1637
    # @classmethod
    # def getEndState(cls): # returning the class name
    #     return cls.getInfo()[0]
1638 1639

    @classmethod
1640 1641 1642
    def canBeginFrom(cls, state: AnyState):
        # return state.getValue() in cls.getBeginStates()
        raise RuntimeError("must be overriden")
1643

1644 1645 1646 1647
    @classmethod
    def getRegTableName(cls, i):
        return "db.reg_table_{}".format(i)

1648 1649
    def execute(self, wt: WorkerThread):
        super().execute(wt)
S
Shuduo Sang 已提交
1650 1651


1652
class TaskCreateDb(StateTransitionTask):
1653
    @classmethod
1654
    def getEndState(cls):
S
Shuduo Sang 已提交
1655
        return StateDbOnly()
1656

1657 1658 1659 1660
    @classmethod
    def canBeginFrom(cls, state: AnyState):
        return state.canCreateDb()

1661
    def _executeInternal(self, te: TaskExecutor, wt: WorkerThread):
S
Shuduo Sang 已提交
1662 1663
        self.execWtSql(wt, "create database db")

1664

1665
class TaskDropDb(StateTransitionTask):
1666
    @classmethod
1667 1668
    def getEndState(cls):
        return StateEmpty()
1669

1670 1671 1672 1673
    @classmethod
    def canBeginFrom(cls, state: AnyState):
        return state.canDropDb()

1674
    def _executeInternal(self, te: TaskExecutor, wt: WorkerThread):
1675
        self.execWtSql(wt, "drop database db")
S
Steven Li 已提交
1676
        logger.debug("[OPS] database dropped at {}".format(time.time()))
1677

S
Shuduo Sang 已提交
1678

1679
class TaskCreateSuperTable(StateTransitionTask):
1680
    @classmethod
1681 1682
    def getEndState(cls):
        return StateSuperTableOnly()
1683

1684 1685
    @classmethod
    def canBeginFrom(cls, state: AnyState):
1686
        return state.canCreateFixedSuperTable()
1687

1688
    def _executeInternal(self, te: TaskExecutor, wt: WorkerThread):
S
Shuduo Sang 已提交
1689
        if not wt.dbInUse():  # no DB yet, to the best of our knowledge
1690 1691 1692
            logger.debug("Skipping task, no DB yet")
            return

S
Shuduo Sang 已提交
1693
        tblName = self._dbManager.getFixedSuperTableName()
1694
        # wt.execSql("use db")    # should always be in place
S
Shuduo Sang 已提交
1695 1696 1697 1698 1699
        self.execWtSql(
            wt,
            "create table db.{} (ts timestamp, speed int) tags (b binary(200), f float) ".format(tblName))
        # No need to create the regular tables, INSERT will do that
        # automatically
1700

S
Steven Li 已提交
1701

1702
class TaskReadData(StateTransitionTask):
1703
    @classmethod
1704
    def getEndState(cls):
S
Shuduo Sang 已提交
1705
        return None  # meaning doesn't affect state
1706

1707 1708 1709 1710
    @classmethod
    def canBeginFrom(cls, state: AnyState):
        return state.canReadData()

1711
    def _executeInternal(self, te: TaskExecutor, wt: WorkerThread):
S
Shuduo Sang 已提交
1712 1713 1714
        sTbName = self._dbManager.getFixedSuperTableName()
        self.queryWtSql(wt, "select TBNAME from db.{}".format(
            sTbName))  # TODO: analyze result set later
1715

S
Shuduo Sang 已提交
1716 1717
        if random.randrange(
                5) == 0:  # 1 in 5 chance, simulate a broken connection. TODO: break connection in all situations
1718 1719
            wt.getDbConn().close()
            wt.getDbConn().open()
1720
        else:
S
Shuduo Sang 已提交
1721 1722
            # wt.getDbConn().getQueryResult()
            rTables = self.getQueryResult(wt)
1723
            # print("rTables[0] = {}, type = {}".format(rTables[0], type(rTables[0])))
S
Shuduo Sang 已提交
1724
            for rTbName in rTables:  # regular tables
1725
                self.execWtSql(wt, "select * from db.{}".format(rTbName[0]))
1726

1727 1728
        # tdSql.query(" cars where tbname in ('carzero', 'carone')")

S
Shuduo Sang 已提交
1729

1730
class TaskDropSuperTable(StateTransitionTask):
1731
    @classmethod
1732
    def getEndState(cls):
S
Shuduo Sang 已提交
1733
        return StateDbOnly()
1734

1735 1736
    @classmethod
    def canBeginFrom(cls, state: AnyState):
1737
        return state.canDropFixedSuperTable()
1738

1739
    def _executeInternal(self, te: TaskExecutor, wt: WorkerThread):
S
Shuduo Sang 已提交
1740 1741 1742 1743 1744 1745 1746
        # 1/2 chance, we'll drop the regular tables one by one, in a randomized
        # sequence
        if Dice.throw(2) == 0:
            tblSeq = list(range(
                2 + (self.LARGE_NUMBER_OF_TABLES if gConfig.larger_data else self.SMALL_NUMBER_OF_TABLES)))
            random.shuffle(tblSeq)
            tickOutput = False  # if we have spitted out a "d" character for "drop regular table"
1747
            isSuccess = True
S
Shuduo Sang 已提交
1748 1749 1750
            for i in tblSeq:
                regTableName = self.getRegTableName(
                    i)  # "db.reg_table_{}".format(i)
1751
                try:
S
Shuduo Sang 已提交
1752 1753 1754 1755 1756 1757 1758
                    self.execWtSql(wt, "drop table {}".format(
                        regTableName))  # nRows always 0, like MySQL
                except taos.error.ProgrammingError as err:
                    # correcting for strange error number scheme
                    errno2 = err.errno if (
                        err.errno > 0) else 0x80000000 + err.errno
                    if (errno2 in [0x362]):  # mnode invalid table name
1759
                        isSuccess = False
S
Shuduo Sang 已提交
1760 1761 1762
                        logger.debug(
                            "[DB] Acceptable error when dropping a table")
                    continue  # try to delete next regular table
1763 1764

                if (not tickOutput):
S
Shuduo Sang 已提交
1765 1766
                    tickOutput = True  # Print only one time
                    if isSuccess:
1767 1768
                        print("d", end="", flush=True)
                    else:
S
Shuduo Sang 已提交
1769
                        print("f", end="", flush=True)
1770 1771

        # Drop the super table itself
S
Shuduo Sang 已提交
1772
        tblName = self._dbManager.getFixedSuperTableName()
1773
        self.execWtSql(wt, "drop table db.{}".format(tblName))
1774

S
Shuduo Sang 已提交
1775

1776 1777 1778
class TaskAlterTags(StateTransitionTask):
    @classmethod
    def getEndState(cls):
S
Shuduo Sang 已提交
1779
        return None  # meaning doesn't affect state
1780 1781 1782

    @classmethod
    def canBeginFrom(cls, state: AnyState):
S
Shuduo Sang 已提交
1783
        return state.canDropFixedSuperTable()  # if we can drop it, we can alter tags
1784 1785

    def _executeInternal(self, te: TaskExecutor, wt: WorkerThread):
S
Shuduo Sang 已提交
1786
        tblName = self._dbManager.getFixedSuperTableName()
1787
        dice = Dice.throw(4)
S
Shuduo Sang 已提交
1788
        if dice == 0:
1789
            sql = "alter table db.{} add tag extraTag int".format(tblName)
S
Shuduo Sang 已提交
1790
        elif dice == 1:
1791
            sql = "alter table db.{} drop tag extraTag".format(tblName)
S
Shuduo Sang 已提交
1792
        elif dice == 2:
1793
            sql = "alter table db.{} drop tag newTag".format(tblName)
S
Shuduo Sang 已提交
1794 1795 1796
        else:  # dice == 3
            sql = "alter table db.{} change tag extraTag newTag".format(
                tblName)
1797 1798

        self.execWtSql(wt, sql)
1799

S
Shuduo Sang 已提交
1800

1801
class TaskAddData(StateTransitionTask):
S
Shuduo Sang 已提交
1802 1803
    # Track which table is being actively worked on
    activeTable: Set[int] = set()
1804

S
Shuduo Sang 已提交
1805 1806
    # We use these two files to record operations to DB, useful for power-off
    # tests
1807 1808 1809 1810 1811
    fAddLogReady = None
    fAddLogDone = None

    @classmethod
    def prepToRecordOps(cls):
S
Shuduo Sang 已提交
1812 1813 1814 1815
        if gConfig.record_ops:
            if (cls.fAddLogReady is None):
                logger.info(
                    "Recording in a file operations to be performed...")
1816
                cls.fAddLogReady = open("add_log_ready.txt", "w")
S
Shuduo Sang 已提交
1817
            if (cls.fAddLogDone is None):
1818 1819
                logger.info("Recording in a file operations completed...")
                cls.fAddLogDone = open("add_log_done.txt", "w")
1820

1821
    @classmethod
1822 1823
    def getEndState(cls):
        return StateHasData()
1824 1825 1826 1827

    @classmethod
    def canBeginFrom(cls, state: AnyState):
        return state.canAddData()
S
Shuduo Sang 已提交
1828

1829
    def _executeInternal(self, te: TaskExecutor, wt: WorkerThread):
1830
        ds = self._dbManager
S
Shuduo Sang 已提交
1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841
        # wt.execSql("use db") # TODO: seems to be an INSERT bug to require
        # this
        tblSeq = list(
            range(
                self.LARGE_NUMBER_OF_TABLES if gConfig.larger_data else self.SMALL_NUMBER_OF_TABLES))
        random.shuffle(tblSeq)
        for i in tblSeq:
            if (i in self.activeTable):  # wow already active
                # logger.info("Concurrent data insertion into table: {}".format(i))
                # print("ct({})".format(i), end="", flush=True) # Concurrent
                # insertion into table
1842 1843
                print("x", end="", flush=True)
            else:
S
Shuduo Sang 已提交
1844 1845 1846 1847 1848 1849 1850 1851
                self.activeTable.add(i)  # marking it active
            # No need to shuffle data sequence, unless later we decide to do
            # non-increment insertion
            regTableName = self.getRegTableName(
                i)  # "db.reg_table_{}".format(i)
            for j in range(
                    self.LARGE_NUMBER_OF_RECORDS if gConfig.larger_data else self.SMALL_NUMBER_OF_RECORDS):  # number of records per table
                nextInt = ds.getNextInt()
1852 1853
                if gConfig.record_ops:
                    self.prepToRecordOps()
S
Shuduo Sang 已提交
1854 1855 1856
                    self.fAddLogReady.write(
                        "Ready to write {} to {}\n".format(
                            nextInt, regTableName))
1857 1858 1859
                    self.fAddLogReady.flush()
                    os.fsync(self.fAddLogReady)
                sql = "insert into {} using {} tags ('{}', {}) values ('{}', {});".format(
S
Shuduo Sang 已提交
1860 1861
                    regTableName,
                    ds.getFixedSuperTableName(),
1862
                    ds.getNextBinary(), ds.getNextFloat(),
1863
                    ds.getNextTick(), nextInt)
S
Shuduo Sang 已提交
1864 1865 1866
                self.execWtSql(wt, sql)
                # Successfully wrote the data into the DB, let's record it
                # somehow
1867
                te.recordDataMark(nextInt)
1868
                if gConfig.record_ops:
S
Shuduo Sang 已提交
1869 1870 1871
                    self.fAddLogDone.write(
                        "Wrote {} to {}\n".format(
                            nextInt, regTableName))
1872 1873
                    self.fAddLogDone.flush()
                    os.fsync(self.fAddLogDone)
S
Shuduo Sang 已提交
1874
            self.activeTable.discard(i)  # not raising an error, unlike remove
1875 1876


S
Steven Li 已提交
1877 1878
# Deterministic random number generator
class Dice():
S
Shuduo Sang 已提交
1879
    seeded = False  # static, uninitialized
S
Steven Li 已提交
1880 1881

    @classmethod
S
Shuduo Sang 已提交
1882
    def seed(cls, s):  # static
S
Steven Li 已提交
1883
        if (cls.seeded):
S
Shuduo Sang 已提交
1884 1885
            raise RuntimeError(
                "Cannot seed the random generator more than once")
S
Steven Li 已提交
1886 1887 1888 1889 1890
        cls.verifyRNG()
        random.seed(s)
        cls.seeded = True  # TODO: protect against multi-threading

    @classmethod
S
Shuduo Sang 已提交
1891
    def verifyRNG(cls):  # Verify that the RNG is determinstic
S
Steven Li 已提交
1892 1893 1894 1895
        random.seed(0)
        x1 = random.randrange(0, 1000)
        x2 = random.randrange(0, 1000)
        x3 = random.randrange(0, 1000)
S
Shuduo Sang 已提交
1896
        if (x1 != 864 or x2 != 394 or x3 != 776):
S
Steven Li 已提交
1897 1898 1899
            raise RuntimeError("System RNG is not deterministic")

    @classmethod
S
Shuduo Sang 已提交
1900
    def throw(cls, stop):  # get 0 to stop-1
1901
        return cls.throwRange(0, stop)
S
Steven Li 已提交
1902 1903

    @classmethod
S
Shuduo Sang 已提交
1904 1905
    def throwRange(cls, start, stop):  # up to stop-1
        if (not cls.seeded):
S
Steven Li 已提交
1906
            raise RuntimeError("Cannot throw dice before seeding it")
1907
        return random.randrange(start, stop)
S
Steven Li 已提交
1908 1909


S
Steven Li 已提交
1910 1911
class LoggingFilter(logging.Filter):
    def filter(self, record: logging.LogRecord):
S
Shuduo Sang 已提交
1912 1913
        if (record.levelno >= logging.INFO):
            return True  # info or above always log
S
Steven Li 已提交
1914

S
Steven Li 已提交
1915 1916 1917 1918
        # Commenting out below to adjust...

        # if msg.startswith("[TRD]"):
        #     return False
S
Steven Li 已提交
1919 1920
        return True

S
Shuduo Sang 已提交
1921 1922

class MyLoggingAdapter(logging.LoggerAdapter):
1923 1924 1925 1926
    def process(self, msg, kwargs):
        return "[{}]{}".format(threading.get_ident() % 10000, msg), kwargs
        # return '[%s] %s' % (self.extra['connid'], msg), kwargs

S
Shuduo Sang 已提交
1927 1928

class SvcManager:
1929
    def __init__(self):
1930
        print("Starting TDengine Service Manager")
1931 1932
        signal.signal(signal.SIGTERM, self.sigIntHandler)
        signal.signal(signal.SIGINT, self.sigIntHandler)
1933
        signal.signal(signal.SIGUSR1, self.sigUsrHandler)  # different handler!
1934

1935
        self.inSigHandler = False
1936 1937
        # self._status = MainExec.STATUS_RUNNING # set inside
        # _startTaosService()
1938
        self.svcMgrThread = None
1939

1940 1941 1942 1943 1944 1945 1946 1947
    def _doMenu(self):
        choice = ""
        while True:
            print("\nInterrupting Service Program, Choose an Action: ")
            print("1: Resume")
            print("2: Terminate")
            print("3: Restart")
            # Remember to update the if range below
S
Shuduo Sang 已提交
1948
            # print("Enter Choice: ", end="", flush=True)
1949 1950 1951
            while choice == "":
                choice = input("Enter Choice: ")
                if choice != "":
S
Shuduo Sang 已提交
1952 1953 1954
                    break  # done with reading repeated input
            if choice in ["1", "2", "3"]:
                break  # we are done with whole method
1955
            print("Invalid choice, please try again.")
S
Shuduo Sang 已提交
1956
            choice = ""  # reset
1957 1958
        return choice

S
Shuduo Sang 已提交
1959
    def sigUsrHandler(self, signalNumber, frame):
1960
        print("Interrupting main thread execution upon SIGUSR1")
1961
        if self.inSigHandler:  # already
1962
            print("Ignoring repeated SIG...")
S
Shuduo Sang 已提交
1963
            return  # do nothing if it's already not running
1964
        self.inSigHandler = True
1965 1966

        choice = self._doMenu()
S
Shuduo Sang 已提交
1967 1968 1969 1970 1971
        if choice == "1":
            # TODO: can the sub-process be blocked due to us not reading from
            # queue?
            self.sigHandlerResume()
        elif choice == "2":
1972
            self.stopTaosService()
S
Shuduo Sang 已提交
1973
        elif choice == "3":
1974 1975
            self.stopTaosService()
            self.startTaosService()
1976 1977
        else:
            raise RuntimeError("Invalid menu choice: {}".format(choice))
1978

1979 1980
        self.inSigHandler = False

1981 1982
    def sigIntHandler(self, signalNumber, frame):
        print("Sig INT Handler starting...")
1983
        if self.inSigHandler:
1984 1985
            print("Ignoring repeated SIG_INT...")
            return
1986
        self.inSigHandler = True
1987

S
Shuduo Sang 已提交
1988 1989
        self.stopTaosService()
        print("INT signal handler returning...")
1990
        self.inSigHandler = False
1991

S
Shuduo Sang 已提交
1992
    def sigHandlerResume(self):
1993
        print("Resuming TDengine service manager thread (main thread)...\n\n")
1994

1995
    def _checkServiceManagerThread(self):
1996 1997 1998 1999
        if self.svcMgrThread:  # valid svc mgr thread
            if self.svcMgrThread.isStopped():  # done?
                self.svcMgrThread.procIpcBatch()  # one last time. TODO: appropriate?
                self.svcMgrThread = None  # no more
2000 2001

    def _procIpcAll(self):
2002 2003 2004 2005 2006 2007 2008 2009
        while self.svcMgrThread:  # for as long as the svc mgr thread is still here
            self.svcMgrThread.procIpcBatch()  # regular processing,
            time.sleep(0.5)  # pause, before next round
            self._checkServiceManagerThread()
        print(
            "Service Manager Thread (with subprocess) has ended, main thread now exiting...")

    def startTaosService(self):
2010
        if self.svcMgrThread:
2011 2012 2013
            raise RuntimeError(
                "Cannot start TAOS service when one may already be running")
        self.svcMgrThread = ServiceManagerThread()  # create the object
2014 2015
        self.svcMgrThread.start()
        print("TAOS service started, printing out output...")
2016 2017 2018
        self.svcMgrThread.procIpcBatch(
            trimToTarget=10,
            forceOutput=True)  # for printing 10 lines
2019
        print("TAOS service started")
2020 2021

    def stopTaosService(self, outputLines=20):
2022 2023 2024 2025 2026
        print("Terminating Service Manager Thread (SMT) execution...")
        if not self.svcMgrThread:
            raise RuntimeError("Unexpected empty svc mgr thread")
        self.svcMgrThread.stop()
        if self.svcMgrThread.isStopped():
2027 2028
            self.svcMgrThread.procIpcBatch(outputLines)  # one last time
            self.svcMgrThread = None
2029 2030 2031 2032 2033 2034 2035
            print("----- End of TDengine Service Output -----\n")
            print("SMT execution terminated")
        else:
            print("WARNING: SMT did not terminate as expected")

    def run(self):
        self.startTaosService()
2036 2037 2038 2039 2040
        self._procIpcAll()  # pump/process all the messages
        if self.svcMgrThread:  # if sig handler hasn't destroyed it by now
            self.stopTaosService()  # should have started already


2041 2042 2043 2044 2045
class ServiceManagerThread:
    MAX_QUEUE_SIZE = 10000

    def __init__(self):
        self._tdeSubProcess = None
2046
        self._thread = None
2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063
        self._status = None

    def getStatus(self):
        return self._status

    def isRunning(self):
        # return self._thread and self._thread.is_alive()
        return self._status == MainExec.STATUS_RUNNING

    def isStopping(self):
        return self._status == MainExec.STATUS_STOPPING

    def isStopped(self):
        return self._status == MainExec.STATUS_STOPPED

    # Start the thread (with sub process), and wait for the sub service
    # to become fully operational
2064 2065
    def start(self):
        if self._thread:
2066
            raise RuntimeError("Unexpected _thread")
2067
        if self._tdeSubProcess:
2068 2069 2070 2071
            raise RuntimeError("TDengine sub process already created/running")

        self._status = MainExec.STATUS_STARTING

2072
        self._tdeSubProcess = TdeSubProcess()
2073 2074 2075 2076
        self._tdeSubProcess.start()

        self._ipcQueue = Queue()
        self._thread = threading.Thread(
2077
            target=self.svcOutputReader,
2078
            args=(self._tdeSubProcess.getStdOut(), self._ipcQueue))
2079
        self._thread.daemon = True  # thread dies with the program
2080 2081 2082
        self._thread.start()

        # wait for service to start
2083
        for i in range(0, 10):
2084 2085 2086
            time.sleep(1.0)
            # self.procIpcBatch() # don't pump message during start up
            print("_zz_", end="", flush=True)
2087
            if self._status == MainExec.STATUS_RUNNING:
2088
                logger.info("[] TDengine service READY to process requests")
2089 2090 2091
                return  # now we've started
        # TODO: handle this better?
        raise RuntimeError("TDengine service did not start successfully")
2092 2093 2094 2095 2096 2097

    def stop(self):
        # can be called from both main thread or signal handler
        print("Terminating TDengine service running as the sub process...")
        if self.isStopped():
            print("Service already stopped")
2098
            return
2099 2100 2101
        if self.isStopping():
            print("Service is already being stopped")
            return
2102 2103 2104 2105
        # Linux will send Control-C generated SIGINT to the TDengine process
        # already, ref:
        # https://unix.stackexchange.com/questions/176235/fork-and-how-signals-are-delivered-to-processes
        if not self._tdeSubProcess:
2106
            raise RuntimeError("sub process object missing")
2107

2108 2109 2110
        self._status = MainExec.STATUS_STOPPING
        self._tdeSubProcess.stop()

2111 2112 2113 2114
        if self._tdeSubProcess.isRunning():  # still running
            print(
                "FAILED to stop sub process, it is still running... pid = {}".format(
                    self.subProcess.pid))
2115
        else:
2116 2117 2118
            self._tdeSubProcess = None  # not running any more
            self.join()  # stop the thread, change the status, etc.

2119 2120 2121
    def join(self):
        # TODO: sanity check
        if not self.isStopping():
2122 2123 2124
            raise RuntimeError(
                "Unexpected status when ending svc mgr thread: {}".format(
                    self._status))
2125

2126
        if self._thread:
2127
            self._thread.join()
2128
            self._thread = None
2129
            self._status = MainExec.STATUS_STOPPED
S
Shuduo Sang 已提交
2130
        else:
2131
            print("Joining empty thread, doing nothing")
2132 2133 2134

    def _trimQueue(self, targetSize):
        if targetSize <= 0:
2135
            return  # do nothing
2136
        q = self._ipcQueue
2137
        if (q.qsize() <= targetSize):  # no need to trim
2138 2139 2140 2141
            return

        logger.debug("Triming IPC queue to target size: {}".format(targetSize))
        itemsToTrim = q.qsize() - targetSize
2142
        for i in range(0, itemsToTrim):
2143 2144 2145
            try:
                q.get_nowait()
            except Empty:
2146 2147
                break  # break out of for loop, no more trimming

2148
    TD_READY_MSG = "TDengine is initialized successfully"
S
Shuduo Sang 已提交
2149

2150 2151
    def procIpcBatch(self, trimToTarget=0, forceOutput=False):
        self._trimQueue(trimToTarget)  # trim if necessary
S
Shuduo Sang 已提交
2152 2153
        # Process all the output generated by the underlying sub process,
        # managed by IO thread
2154
        print("<", end="", flush=True)
S
Shuduo Sang 已提交
2155 2156
        while True:
            try:
2157
                line = self._ipcQueue.get_nowait()  # getting output at fast speed
2158
                self._printProgress("_o")
2159 2160 2161
            except Empty:
                # time.sleep(2.3) # wait only if there's no output
                # no more output
2162
                print(".>", end="", flush=True)
S
Shuduo Sang 已提交
2163
                return  # we are done with THIS BATCH
2164
            else:  # got line, printing out
2165 2166 2167 2168 2169 2170 2171
                if forceOutput:
                    logger.info(line)
                else:
                    logger.debug(line)
        print(">", end="", flush=True)

    _ProgressBars = ["--", "//", "||", "\\\\"]
2172

2173 2174
    def _printProgress(self, msg):  # TODO: assuming 2 chars
        print(msg, end="", flush=True)
2175 2176 2177
        pBar = self._ProgressBars[Dice.throw(4)]
        print(pBar, end="", flush=True)
        print('\b\b\b\b', end="", flush=True)
2178

2179 2180 2181
    def svcOutputReader(self, out: IO, queue):
        # Important Reference: https://stackoverflow.com/questions/375427/non-blocking-read-on-a-subprocess-pipe-in-python
        # print("This is the svcOutput Reader...")
2182
        # for line in out :
2183 2184 2185 2186
        for line in iter(out.readline, b''):
            # print("Finished reading a line: {}".format(line))
            # print("Adding item to queue...")
            line = line.decode("utf-8").rstrip()
2187 2188
            # This might block, and then causing "out" buffer to block
            queue.put(line)
2189 2190
            self._printProgress("_i")

2191 2192 2193
            if self._status == MainExec.STATUS_STARTING:  # we are starting, let's see if we have started
                if line.find(self.TD_READY_MSG) != -1:  # found
                    self._status = MainExec.STATUS_RUNNING
2194 2195

            # Trim the queue if necessary: TODO: try this 1 out of 10 times
2196
            self._trimQueue(self.MAX_QUEUE_SIZE * 9 // 10)  # trim to 90% size
2197

2198 2199 2200
            if self.isStopping():  # TODO: use thread status instead
                # WAITING for stopping sub process to finish its outptu
                print("_w", end="", flush=True)
2201 2202

            # queue.put(line)
2203 2204
        # meaning sub process must have died
        print("\nNo more output from IO thread managing TDengine service")
2205 2206
        out.close()

2207 2208

class TdeSubProcess:
2209 2210 2211 2212 2213
    def __init__(self):
        self.subProcess = None

    def getStdOut(self):
        return self.subProcess.stdout
2214

2215
    def isRunning(self):
2216
        return self.subProcess is not None
2217

S
Shuduo Sang 已提交
2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231
    def getBuildPath(self):
        selfPath = os.path.dirname(os.path.realpath(__file__))
        if ("community" in selfPath):
            projPath = selfPath[:selfPath.find("communit")]
        else:
            projPath = selfPath[:selfPath.find("tests")]

        for root, dirs, files in os.walk(projPath):
            if ("taosd" in files):
                rootRealPath = os.path.dirname(os.path.realpath(root))
                if ("packaging" not in rootRealPath):
                    buildPath = root[:len(root) - len("/build/bin")]
                    break
        return buildPath
2232

2233
    def start(self):
2234
        ON_POSIX = 'posix' in sys.builtin_module_names
S
Shuduo Sang 已提交
2235

2236 2237 2238
        taosdPath = self.getBuildPath() + "/build/bin/taosd"
        cfgPath = self.getBuildPath() + "/test/cfg"

S
Shuduo Sang 已提交
2239
        svcCmd = [taosdPath, '-c', cfgPath]
2240
        # svcCmd = ['vmstat', '1']
S
Shuduo Sang 已提交
2241
        if self.subProcess:  # already there
2242 2243 2244
            raise RuntimeError("Corrupt process state")

        self.subProcess = subprocess.Popen(
S
Shuduo Sang 已提交
2245 2246
            svcCmd,
            stdout=subprocess.PIPE,
2247
            # bufsize=1, # not supported in binary mode
S
Shuduo Sang 已提交
2248
            close_fds=ON_POSIX)  # had text=True, which interferred with reading EOF
2249

2250 2251 2252
    def stop(self):
        if not self.subProcess:
            print("Sub process already stopped")
2253 2254 2255
            return

        retCode = self.subProcess.poll()
S
Shuduo Sang 已提交
2256
        if retCode:  # valid return code, process ended
2257
            self.subProcess = None
S
Shuduo Sang 已提交
2258 2259
        else:  # process still alive, let's interrupt it
            print(
2260
                "Sub process is running, sending SIG_INT and waiting for it to terminate...")
S
Shuduo Sang 已提交
2261 2262 2263 2264
            # sub process should end, then IPC queue should end, causing IO
            # thread to end
            self.subProcess.send_signal(signal.SIGINT)
            try:
2265 2266 2267 2268
                self.subProcess.wait(10)
            except subprocess.TimeoutExpired as err:
                print("Time out waiting for TDengine service process to exit")
            else:
2269
                print("TDengine service process terminated successfully from SIG_INT")
2270 2271
                self.subProcess = None

S
Shuduo Sang 已提交
2272

2273 2274 2275 2276 2277 2278
class ClientManager:
    def __init__(self):
        print("Starting service manager")
        signal.signal(signal.SIGTERM, self.sigIntHandler)
        signal.signal(signal.SIGINT, self.sigIntHandler)

2279
        self._status = MainExec.STATUS_RUNNING
2280 2281 2282
        self.tc = None

    def sigIntHandler(self, signalNumber, frame):
2283
        if self._status != MainExec.STATUS_RUNNING:
2284 2285 2286
            print("Repeated SIGINT received, forced exit...")
            # return  # do nothing if it's already not running
            sys.exit(-1)
2287
        self._status = MainExec.STATUS_STOPPING  # immediately set our status
2288 2289 2290 2291

        print("Terminating program...")
        self.tc.requestToStop()

S
Shuduo Sang 已提交
2292
    def _printLastNumbers(self):  # to verify data durability
2293 2294
        dbManager = DbManager(resetDb=False)
        dbc = dbManager.getDbConn()
S
Shuduo Sang 已提交
2295
        if dbc.query("show databases") == 0:  # no databae
2296
            return
S
Shuduo Sang 已提交
2297
        if dbc.query("show tables") == 0:  # no tables
S
Steven Li 已提交
2298
            return
2299 2300

        dbc.execute("use db")
S
Shuduo Sang 已提交
2301
        sTbName = dbManager.getFixedSuperTableName()
2302 2303

        # get all regular tables
S
Shuduo Sang 已提交
2304 2305
        # TODO: analyze result set later
        dbc.query("select TBNAME from db.{}".format(sTbName))
2306 2307 2308
        rTables = dbc.getQueryResult()

        bList = TaskExecutor.BoundedList()
S
Shuduo Sang 已提交
2309
        for rTbName in rTables:  # regular tables
2310 2311
            dbc.query("select speed from db.{}".format(rTbName[0]))
            numbers = dbc.getQueryResult()
S
Shuduo Sang 已提交
2312
            for row in numbers:
2313 2314 2315 2316 2317 2318
                # print("<{}>".format(n), end="", flush=True)
                bList.add(row[0])

        print("Top numbers in DB right now: {}".format(bList))
        print("TDengine client execution is about to start in 2 seconds...")
        time.sleep(2.0)
S
Shuduo Sang 已提交
2319
        dbManager = None  # release?
2320 2321 2322 2323 2324

    def prepare(self):
        self._printLastNumbers()

    def run(self):
S
Shuduo Sang 已提交
2325
        if gConfig.auto_start_service:
2326 2327 2328
            svcMgr = SvcManager()
            svcMgr.startTaosService()

2329 2330
        self._printLastNumbers()

S
Shuduo Sang 已提交
2331
        dbManager = DbManager()  # Regular function
2332
        thPool = ThreadPool(gConfig.num_threads, gConfig.max_steps)
2333
        self.tc = ThreadCoordinator(thPool, dbManager)
S
Shuduo Sang 已提交
2334

2335
        self.tc.run()
S
Steven Li 已提交
2336 2337
        # print("exec stats: {}".format(self.tc.getExecStats()))
        # print("TC failed = {}".format(self.tc.isFailed()))
S
Shuduo Sang 已提交
2338
        if gConfig.auto_start_service:
2339
            svcMgr.stopTaosService()
2340 2341
        # Print exec status, etc., AFTER showing messages from the server
        self.conclude()
S
Steven Li 已提交
2342
        # print("TC failed (2) = {}".format(self.tc.isFailed()))
S
Shuduo Sang 已提交
2343 2344
        # Linux return code: ref https://shapeshed.com/unix-exit-codes/
        return 1 if self.tc.isFailed() else 0
2345 2346 2347

    def conclude(self):
        self.tc.printStats()
S
Shuduo Sang 已提交
2348
        self.tc.getDbManager().cleanUp()
2349 2350 2351


class MainExec:
2352 2353 2354
    STATUS_STARTING = 1
    STATUS_RUNNING = 2
    STATUS_STOPPING = 3
2355
    STATUS_STOPPED = 4
2356 2357 2358 2359

    @classmethod
    def runClient(cls):
        clientManager = ClientManager()
S
Steven Li 已提交
2360
        return clientManager.run()
2361 2362 2363

    @classmethod
    def runService(cls):
2364 2365
        svcManager = SvcManager()
        svcManager.run()
2366 2367

    @classmethod
S
Shuduo Sang 已提交
2368
    def runTemp(cls):  # for debugging purposes
2369 2370
        # # Hack to exercise reading from disk, imcreasing coverage. TODO: fix
        # dbc = dbState.getDbConn()
S
Shuduo Sang 已提交
2371
        # sTbName = dbState.getFixedSuperTableName()
2372 2373
        # dbc.execute("create database if not exists db")
        # if not dbState.getState().equals(StateEmpty()):
S
Shuduo Sang 已提交
2374
        #     dbc.execute("use db")
2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385

        # rTables = None
        # try: # the super table may not exist
        #     sql = "select TBNAME from db.{}".format(sTbName)
        #     logger.info("Finding out tables in super table: {}".format(sql))
        #     dbc.query(sql) # TODO: analyze result set later
        #     logger.info("Fetching result")
        #     rTables = dbc.getQueryResult()
        #     logger.info("Result: {}".format(rTables))
        # except taos.error.ProgrammingError as err:
        #     logger.info("Initial Super table OPS error: {}".format(err))
S
Shuduo Sang 已提交
2386

2387 2388 2389 2390 2391 2392 2393 2394
        # # sys.exit()
        # if ( not rTables == None):
        #     # print("rTables[0] = {}, type = {}".format(rTables[0], type(rTables[0])))
        #     try:
        #         for rTbName in rTables : # regular tables
        #             ds = dbState
        #             logger.info("Inserting into table: {}".format(rTbName[0]))
        #             sql = "insert into db.{} values ('{}', {});".format(
S
Shuduo Sang 已提交
2395
        #                 rTbName[0],
2396 2397
        #                 ds.getNextTick(), ds.getNextInt())
        #             dbc.execute(sql)
S
Shuduo Sang 已提交
2398
        #         for rTbName in rTables : # regular tables
2399
        #             dbc.query("select * from db.{}".format(rTbName[0])) # TODO: check success failure
S
Shuduo Sang 已提交
2400
        #         logger.info("Initial READING operation is successful")
2401
        #     except taos.error.ProgrammingError as err:
S
Shuduo Sang 已提交
2402 2403
        #         logger.info("Initial WRITE/READ error: {}".format(err))

2404 2405 2406
        # Sandbox testing code
        # dbc = dbState.getDbConn()
        # while True:
S
Shuduo Sang 已提交
2407
        #     rows = dbc.query("show databases")
2408
        #     print("Rows: {}, time={}".format(rows, time.time()))
S
Shuduo Sang 已提交
2409 2410
        return

S
Steven Li 已提交
2411

2412
def main():
S
Shuduo Sang 已提交
2413 2414
    # Super cool Python argument library:
    # https://docs.python.org/3/library/argparse.html
2415 2416 2417 2418 2419 2420 2421 2422 2423
    parser = argparse.ArgumentParser(
        formatter_class=argparse.RawDescriptionHelpFormatter,
        description=textwrap.dedent('''\
            TDengine Auto Crash Generator (PLEASE NOTICE the Prerequisites Below)
            ---------------------------------------------------------------------
            1. You build TDengine in the top level ./build directory, as described in offical docs
            2. You run the server there before this script: ./build/bin/taosd -c test/cfg

            '''))
2424

2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445
    # parser.add_argument('-a', '--auto-start-service', action='store_true',                        
    #                     help='Automatically start/stop the TDengine service (default: false)')
    # parser.add_argument('-c', '--connector-type', action='store', default='native', type=str,
    #                     help='Connector type to use: native, rest, or mixed (default: 10)')
    # parser.add_argument('-d', '--debug', action='store_true',                        
    #                     help='Turn on DEBUG mode for more logging (default: false)')
    # parser.add_argument('-e', '--run-tdengine', action='store_true',                        
    #                     help='Run TDengine service in foreground (default: false)')
    # parser.add_argument('-l', '--larger-data', action='store_true',                        
    #                     help='Write larger amount of data during write operations (default: false)')
    # parser.add_argument('-p', '--per-thread-db-connection', action='store_true',                        
    #                     help='Use a single shared db connection (default: false)')
    # parser.add_argument('-r', '--record-ops', action='store_true',                        
    #                     help='Use a pair of always-fsynced fils to record operations performing + performed, for power-off tests (default: false)')                    
    # parser.add_argument('-s', '--max-steps', action='store', default=1000, type=int,
    #                     help='Maximum number of steps to run (default: 100)')
    # parser.add_argument('-t', '--num-threads', action='store', default=5, type=int,
    #                     help='Number of threads to run (default: 10)')
    # parser.add_argument('-x', '--continue-on-exception', action='store_true',                        
    #                     help='Continue execution after encountering unexpected/disallowed errors/exceptions (default: false)')                        

S
Shuduo Sang 已提交
2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496
    parser.add_argument(
        '-a',
        '--auto-start-service',
        action='store_true',
        help='Automatically start/stop the TDengine service (default: false)')
    parser.add_argument(
        '-c',
        '--connector-type',
        action='store',
        default='native',
        type=str,
        help='Connector type to use: native, rest, or mixed (default: 10)')
    parser.add_argument(
        '-d',
        '--debug',
        action='store_true',
        help='Turn on DEBUG mode for more logging (default: false)')
    parser.add_argument(
        '-e',
        '--run-tdengine',
        action='store_true',
        help='Run TDengine service in foreground (default: false)')
    parser.add_argument(
        '-l',
        '--larger-data',
        action='store_true',
        help='Write larger amount of data during write operations (default: false)')
    parser.add_argument(
        '-p',
        '--per-thread-db-connection',
        action='store_true',
        help='Use a single shared db connection (default: false)')
    parser.add_argument(
        '-r',
        '--record-ops',
        action='store_true',
        help='Use a pair of always-fsynced fils to record operations performing + performed, for power-off tests (default: false)')
    parser.add_argument(
        '-s',
        '--max-steps',
        action='store',
        default=1000,
        type=int,
        help='Maximum number of steps to run (default: 100)')
    parser.add_argument(
        '-t',
        '--num-threads',
        action='store',
        default=5,
        type=int,
        help='Number of threads to run (default: 10)')
2497 2498 2499 2500 2501
    parser.add_argument(
        '-x',
        '--continue-on-exception',
        action='store_true',
        help='Continue execution after encountering unexpected/disallowed errors/exceptions (default: false)')
2502

2503
    global gConfig
2504
    gConfig = parser.parse_args()
2505

2506
    # Logging Stuff
2507
    global logger
S
Shuduo Sang 已提交
2508 2509
    _logger = logging.getLogger('CrashGen')  # real logger
    _logger.addFilter(LoggingFilter())
2510 2511 2512
    ch = logging.StreamHandler()
    _logger.addHandler(ch)

S
Shuduo Sang 已提交
2513 2514
    # Logging adapter, to be used as a logger
    logger = MyLoggingAdapter(_logger, [])
2515

S
Shuduo Sang 已提交
2516 2517
    if (gConfig.debug):
        logger.setLevel(logging.DEBUG)  # default seems to be INFO
S
Steven Li 已提交
2518 2519
    else:
        logger.setLevel(logging.INFO)
S
Shuduo Sang 已提交
2520

2521 2522
    Dice.seed(0)  # initial seeding of dice

2523
    # Run server or client
S
Shuduo Sang 已提交
2524
    if gConfig.run_tdengine:  # run server
2525
        MainExec.runService()
S
Shuduo Sang 已提交
2526
    else:
S
Steven Li 已提交
2527
        return MainExec.runClient()
2528

S
Shuduo Sang 已提交
2529

2530
if __name__ == "__main__":
S
Steven Li 已提交
2531 2532 2533
    exitCode = main()
    # print("Exiting with code: {}".format(exitCode))
    sys.exit(exitCode)