crash_gen.py 121.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
# 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
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
38

S
Steven Li 已提交
39
import sys
40
import os
41 42
import io
import signal
43
import traceback
44 45 46
import resource
from guppy import hpy
import gc
47 48 49 50 51 52 53

try:
    import psutil
except:
    print("Psutil module needed, please install: sudo pip3 install psutil")
    sys.exit(-1)

54 55 56 57
# Require Python 3
if sys.version_info[0] < 3:
    raise Exception("Must be using Python 3")

S
Shuduo Sang 已提交
58
# Global variables, tried to keep a small number.
59 60 61

# Command-line/Environment Configurations, will set a bit later
# ConfigNameSpace = argparse.Namespace
S
Shuduo Sang 已提交
62
gConfig = argparse.Namespace()  # Dummy value, will be replaced later
63
gSvcMgr = None # TODO: refactor this hack, use dep injection
64
logger = None # type: Logger
S
Steven Li 已提交
65

S
Shuduo Sang 已提交
66
def runThread(wt: WorkerThread):
67
    wt.run()
68

69 70
class CrashGenError(Exception):
    def __init__(self, msg=None, errno=None):
S
Shuduo Sang 已提交
71
        self.msg = msg
72
        self.errno = errno
S
Shuduo Sang 已提交
73

74 75 76
    def __str__(self):
        return self.msg

S
Shuduo Sang 已提交
77

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

90
        # Let us have a DB connection of our own
S
Shuduo Sang 已提交
91
        if (gConfig.per_thread_db_connection):  # type: ignore
92
            # print("connector_type = {}".format(gConfig.connector_type))
93 94 95 96 97 98 99 100 101 102 103
            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))
104

105
        # self._dbInUse = False  # if "use db" was executed already
106

107
    def logDebug(self, msg):
S
Steven Li 已提交
108
        logger.debug("    TRD[{}] {}".format(self._tid, msg))
109 110

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

113 114
    # def dbInUse(self):
    #     return self._dbInUse
115

116 117 118 119
    # def useDb(self):
    #     if (not self._dbInUse):
    #         self.execSql("use db")
    #     self._dbInUse = True
120

121
    def getTaskExecutor(self):
S
Shuduo Sang 已提交
122
        return self._tc.getTaskExecutor()
123

S
Steven Li 已提交
124
    def start(self):
125
        self._thread.start()  # AFTER the thread is recorded
S
Steven Li 已提交
126

S
Shuduo Sang 已提交
127
    def run(self):
S
Steven Li 已提交
128
        # initialization after thread starts, in the thread context
129
        # self.isSleeping = False
130 131
        logger.info("Starting to run thread: {}".format(self._tid))

S
Shuduo Sang 已提交
132
        if (gConfig.per_thread_db_connection):  # type: ignore
133
            logger.debug("Worker thread openning database connection")
134
            self._dbConn.open()
S
Steven Li 已提交
135

S
Shuduo Sang 已提交
136 137
        self._doTaskLoop()

138
        # clean up
S
Shuduo Sang 已提交
139
        if (gConfig.per_thread_db_connection):  # type: ignore
140 141 142 143
            if self._dbConn.isOpen: #sometimes it is not open
                self._dbConn.close()
            else:
                logger.warning("Cleaning up worker thread, dbConn already closed")
144

S
Shuduo Sang 已提交
145
    def _doTaskLoop(self):
146 147
        # while self._curStep < self._pool.maxSteps:
        # tc = ThreadCoordinator(None)
S
Shuduo Sang 已提交
148 149
        while True:
            tc = self._tc  # Thread Coordinator, the overall master
150 151 152
            try:
                tc.crossStepBarrier()  # shared barrier first, INCLUDING the last one
            except threading.BrokenBarrierError as err: # main thread timed out
153
                print("_bto", end="")
154 155 156
                logger.debug("[TRD] Worker thread exiting due to main thread barrier time-out")
                break

157
            logger.debug("[TRD] Worker thread [{}] exited barrier...".format(self._tid))
158
            self.crossStepGate()   # then per-thread gate, after being tapped
159
            logger.debug("[TRD] Worker thread [{}] exited step gate...".format(self._tid))
160
            if not self._tc.isRunning():
161
                print("_wts", end="")
162
                logger.debug("[TRD] Thread Coordinator not running any more, worker thread now stopping...")
163 164
                break

165
            # Before we fetch the task and run it, let's ensure we properly "use" the database (not needed any more)
166
            try:
167 168 169
                if (gConfig.per_thread_db_connection):  # most likely TRUE
                    if not self._dbConn.isOpen:  # might have been closed during server auto-restart
                        self._dbConn.open()
170
                # self.useDb() # might encounter exceptions. TODO: catch
171 172
            except taos.error.ProgrammingError as err:
                errno = Helper.convertErrno(err.errno)
173
                if errno in [0x383, 0x386, 0x00B, 0x014]  : # invalid database, dropping, Unable to establish connection, Database not ready
174 175 176 177 178 179
                    # ignore
                    dummy = 0
                else:
                    print("\nCaught programming error. errno=0x{:X}, msg={} ".format(errno, err.msg))
                    raise

180
            # Fetch a task from the Thread Coordinator
181
            logger.debug( "[TRD] Worker thread [{}] about to fetch task".format(self._tid))
182
            task = tc.fetchTask()
183 184

            # Execute such a task
185
            logger.debug("[TRD] Worker thread [{}] about to execute task: {}".format(
S
Shuduo Sang 已提交
186
                    self._tid, task.__class__.__name__))
187
            task.execute(self)
188
            tc.saveExecutedTask(task)
189
            logger.debug("[TRD] Worker thread [{}] finished executing task".format(self._tid))
S
Shuduo Sang 已提交
190

191
            # self._dbInUse = False  # there may be changes between steps
192
        # print("_wtd", end=None) # worker thread died
193

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

S
Shuduo Sang 已提交
198 199
    def verifyThreadMain(self):  # ensure we are called by the main thread
        if (threading.get_ident() != threading.main_thread().ident):
S
Steven Li 已提交
200 201 202
            raise RuntimeError("Unexpectly called from other threads")

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

206
    # A gate is different from a barrier in that a thread needs to be "tapped"
S
Steven Li 已提交
207 208
    def crossStepGate(self):
        self.verifyThreadAlive()
S
Shuduo Sang 已提交
209 210
        self.verifyThreadSelf()  # only allowed by ourselves

211
        # Wait again at the "gate", waiting to be "tapped"
S
Shuduo Sang 已提交
212 213 214 215
        logger.debug(
            "[TRD] Worker thread {} about to cross the step gate".format(
                self._tid))
        self._stepGate.wait()
216
        self._stepGate.clear()
S
Shuduo Sang 已提交
217

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

S
Shuduo Sang 已提交
220
    def tapStepGate(self):  # give it a tap, release the thread waiting there
221
        # self.verifyThreadAlive()
S
Shuduo Sang 已提交
222 223
        self.verifyThreadMain()  # only allowed for main thread

224 225 226 227 228 229
        if self._thread.is_alive():
            logger.debug("[TRD] Tapping worker thread {}".format(self._tid))
            self._stepGate.set()  # wake up!
            time.sleep(0)  # let the released thread run a bit
        else:
            print("_tad", end="") # Thread already dead
230

S
Shuduo Sang 已提交
231
    def execSql(self, sql):  # TODO: expose DbConn directly
232
        return self.getDbConn().execute(sql)
233

S
Shuduo Sang 已提交
234
    def querySql(self, sql):  # TODO: expose DbConn directly
235
        return self.getDbConn().query(sql)
236 237

    def getQueryResult(self):
238
        return self.getDbConn().getQueryResult()
239

240
    def getDbConn(self) -> DbConn :
S
Shuduo Sang 已提交
241 242
        if (gConfig.per_thread_db_connection):
            return self._dbConn
243
        else:
244
            return self._tc.getDbManager().getDbConn()
245

246 247
    # def querySql(self, sql): # not "execute", since we are out side the DB context
    #     if ( gConfig.per_thread_db_connection ):
S
Shuduo Sang 已提交
248
    #         return self._dbConn.query(sql)
249 250
    #     else:
    #         return self._tc.getDbState().getDbConn().query(sql)
251

252
# The coordinator of all worker threads, mostly running in main thread
S
Shuduo Sang 已提交
253 254


255
class ThreadCoordinator:
S
Steven Li 已提交
256
    WORKER_THREAD_TIMEOUT = 60 # one minute
257

258
    def __init__(self, pool: ThreadPool, dbManager: DbManager):
S
Shuduo Sang 已提交
259
        self._curStep = -1  # first step is 0
260
        self._pool = pool
261
        # self._wd = wd
S
Shuduo Sang 已提交
262
        self._te = None  # prepare for every new step
263
        self._dbManager = dbManager
S
Shuduo Sang 已提交
264 265
        self._executedTasks: List[Task] = []  # in a given step
        self._lock = threading.RLock()  # sync access for a few things
S
Steven Li 已提交
266

S
Shuduo Sang 已提交
267 268
        self._stepBarrier = threading.Barrier(
            self._pool.numThreads + 1)  # one barrier for all threads
269
        self._execStats = ExecutionStats()
270
        self._runStatus = MainExec.STATUS_RUNNING
271
        self._initDbs()
S
Steven Li 已提交
272

273 274 275
    def getTaskExecutor(self):
        return self._te

S
Shuduo Sang 已提交
276
    def getDbManager(self) -> DbManager:
277
        return self._dbManager
278

279 280
    def crossStepBarrier(self, timeout=None):
        self._stepBarrier.wait(timeout) 
281

282 283 284 285
    def requestToStop(self):
        self._runStatus = MainExec.STATUS_STOPPING
        self._execStats.registerFailure("User Interruption")

286
    def _runShouldEnd(self, transitionFailed, hasAbortedTask, workerTimeout):
287 288 289 290 291 292 293 294 295
        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
296 297
        if workerTimeout:
            return True
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
        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
322
        self.tapAllThreads() # release all worker thread from their "gates"
323 324 325 326 327 328

    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")
329
        self.crossStepBarrier(timeout=self.WORKER_THREAD_TIMEOUT)
330 331 332 333 334 335
        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:
336 337 338 339 340 341 342 343 344 345
            for x in self._dbs:
                db = x # type: Database
                sm = db.getStateMachine()
                logger.debug("[STT] starting transitions for DB: {}".format(db.getName()))
                # at end of step, transiton the DB state
                tasksForDb = db.filterTasks(self._executedTasks)
                sm.transition(tasksForDb, self.getDbManager().getDbConn())
                logger.debug("[STT] transition ended for DB: {}".format(db.getName()))

            # Due to limitation (or maybe not) of the TD Python library,
346
            # we cannot share connections across threads
347 348 349 350 351 352
            # Here we are in main thread, we cannot operate the connections created in workers
            # Moving below to task loop
            # if sm.hasDatabase():
            #     for t in self._pool.threadList:
            #         logger.debug("[DB] use db for all worker threads")
            #         t.useDb()
353 354
                    # t.execSql("use db") # main thread executing "use
                    # db" on behalf of every worker thread
355

356 357 358 359 360 361 362 363 364 365 366
        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
S
Steven Li 已提交
367
        # return transitionFailed # Why did we have this??!!
368 369 370 371 372 373

        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 已提交
374
    def run(self):
375
        self._pool.createAndStartThreads(self)
S
Steven Li 已提交
376 377

        # Coordinate all threads step by step
S
Shuduo Sang 已提交
378
        self._curStep = -1  # not started yet
379
        
S
Shuduo Sang 已提交
380
        self._execStats.startExec()  # start the stop watch
381 382
        transitionFailed = False
        hasAbortedTask = False
383 384
        workerTimeout = False
        while not self._runShouldEnd(transitionFailed, hasAbortedTask, workerTimeout):
385
            if not gConfig.debug: # print this only if we are not in debug mode                
S
Shuduo Sang 已提交
386
                print(".", end="", flush=True)
387 388 389 390 391 392 393 394
            # if (self._curStep % 2) == 0: # print memory usage once every 10 steps
            #     memUsage = resource.getrusage(resource.RUSAGE_SELF).ru_maxrss
            #     print("[m:{}]".format(memUsage), end="", flush=True) # print memory usage
            # if (self._curStep % 10) == 3: 
            #     h = hpy()
            #     print("\n")        
            #     print(h.heap())
            
395
                        
396 397 398 399 400 401 402 403 404 405
            try:
                self._syncAtBarrier() # For now just cross the barrier
            except threading.BrokenBarrierError as err:
                logger.info("Main loop aborted, caused by worker thread time-out")
                self._execStats.registerFailure("Aborted due to worker thread timeout")
                print("\n\nWorker Thread time-out detected, important thread info:")
                ts = ThreadStacks()
                ts.print(filterInternal=True)
                workerTimeout = True
                break
406 407

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

416
            # Ending previous step
417 418 419 420
            try:
                transitionFailed = self._doTransition() # To start, we end step -1 first
            except taos.error.ProgrammingError as err:
                transitionFailed = True
421
                errno2 = Helper.convertErrno(err.errno)  # correct error scheme
S
Steven Li 已提交
422 423 424
                errMsg = "Transition failed: errno=0x{:X}, msg: {}".format(errno2, err)
                logger.info(errMsg)
                self._execStats.registerFailure(errMsg)
425

426 427
            # Then we move on to the next step
            self._releaseAllWorkerThreads(transitionFailed)                    
428

429 430
        if hasAbortedTask or transitionFailed : # abnormal ending, workers waiting at "gate"
            logger.debug("Abnormal ending of main thraed")
431 432
        elif workerTimeout:
            logger.debug("Abnormal ending of main thread, due to worker timeout")
433 434 435
        else: # regular ending, workers waiting at "barrier"
            logger.debug("Regular ending, main thread waiting for all worker threads to stop...")
            self._syncAtBarrier()
436

437 438 439
        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
440

441
        logger.debug("\r\n\n--> Main thread ready to finish up...")
442
        logger.debug("Main thread joining all threads")
S
Shuduo Sang 已提交
443
        self._pool.joinAll()  # Get all threads to finish
444
        logger.info("\nAll worker threads finished")
445 446
        self._execStats.endExec()

447 448 449 450 451 452 453 454 455 456 457 458 459
    def cleanup(self): # free resources
        self._pool.cleanup()

        self._pool = None
        self._te = None  
        self._dbManager = None
        self._executedTasks = None
        self._lock = None
        self._stepBarrier = None
        self._execStats = None
        self._runStatus = None


460 461
    def printStats(self):
        self._execStats.printStats()
S
Steven Li 已提交
462

S
Steven Li 已提交
463 464 465 466 467 468
    def isFailed(self):
        return self._execStats.isFailed()

    def getExecStats(self):
        return self._execStats

S
Shuduo Sang 已提交
469
    def tapAllThreads(self):  # in a deterministic manner
S
Steven Li 已提交
470
        wakeSeq = []
S
Shuduo Sang 已提交
471 472
        for i in range(self._pool.numThreads):  # generate a random sequence
            if Dice.throw(2) == 1:
S
Steven Li 已提交
473 474 475
                wakeSeq.append(i)
            else:
                wakeSeq.insert(0, i)
S
Shuduo Sang 已提交
476 477 478
        logger.debug(
            "[TRD] Main thread waking up worker threads: {}".format(
                str(wakeSeq)))
479
        # TODO: set dice seed to a deterministic value
S
Steven Li 已提交
480
        for i in wakeSeq:
S
Shuduo Sang 已提交
481 482 483
            # TODO: maybe a bit too deep?!
            self._pool.threadList[i].tapStepGate()
            time.sleep(0)  # yield
S
Steven Li 已提交
484

485
    def isRunning(self):
S
Shuduo Sang 已提交
486
        return self._te is not None
487

488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504
    def _initDbs(self):
        ''' Initialize multiple databases, invoked at __ini__() time '''
        self._dbs = [] # type: List[Database]
        dbc = self.getDbManager().getDbConn()
        if gConfig.max_dbs == 0:
            self._dbs.append(Database(0, dbc))
        else:
            for i in range(gConfig.max_dbs):
                self._dbs.append(Database(i, dbc))

    def pickDatabase(self):
        idxDb = 0
        if gConfig.max_dbs != 0 :
            idxDb = Dice.throw(gConfig.max_dbs) # 0 to N-1
        db = self._dbs[idxDb] # type: Database
        return db

S
Shuduo Sang 已提交
505
    def fetchTask(self) -> Task:
506 507 508
        ''' The thread coordinator (that's us) is responsible for fetching a task
            to be executed next.
        '''
S
Shuduo Sang 已提交
509
        if (not self.isRunning()):  # no task
510
            raise RuntimeError("Cannot fetch task when not running")
511

S
Shuduo Sang 已提交
512
        # pick a task type for current state
513 514 515
        db = self.pickDatabase()
        taskType = db.getStateMachine().pickTaskType() # type: Task
        return taskType(self._execStats, db)  # create a task from it
516 517

    def resetExecutedTasks(self):
S
Shuduo Sang 已提交
518
        self._executedTasks = []  # should be under single thread
519 520 521 522

    def saveExecutedTask(self, task):
        with self._lock:
            self._executedTasks.append(task)
523 524

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

526 527 528 529
class Helper:
    @classmethod
    def convertErrno(cls, errno):
        return errno if (errno > 0) else 0x80000000 + errno
S
Shuduo Sang 已提交
530

531
class ThreadPool:
532
    def __init__(self, numThreads, maxSteps):
533 534 535 536
        self.numThreads = numThreads
        self.maxSteps = maxSteps
        # Internal class variables
        self.curStep = 0
S
Shuduo Sang 已提交
537 538
        self.threadList = []  # type: List[WorkerThread]

539
    # starting to run all the threads, in locking steps
540
    def createAndStartThreads(self, tc: ThreadCoordinator):
S
Shuduo Sang 已提交
541 542
        for tid in range(0, self.numThreads):  # Create the threads
            workerThread = WorkerThread(self, tid, tc)
543
            self.threadList.append(workerThread)
S
Shuduo Sang 已提交
544
            workerThread.start()  # start, but should block immediately before step 0
545 546 547 548 549 550

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

551 552 553
    def cleanup(self):
        self.threadList = None # maybe clean up each?

554 555
# A queue of continguous POSITIVE integers, used by DbManager to generate continuous numbers
# for new table names
S
Shuduo Sang 已提交
556 557


S
Steven Li 已提交
558 559
class LinearQueue():
    def __init__(self):
560
        self.firstIndex = 1  # 1st ever element
S
Steven Li 已提交
561
        self.lastIndex = 0
S
Shuduo Sang 已提交
562 563
        self._lock = threading.RLock()  # our functions may call each other
        self.inUse = set()  # the indexes that are in use right now
S
Steven Li 已提交
564

565
    def toText(self):
S
Shuduo Sang 已提交
566 567
        return "[{}..{}], in use: {}".format(
            self.firstIndex, self.lastIndex, self.inUse)
568 569

    # Push (add new element, largest) to the tail, and mark it in use
S
Shuduo Sang 已提交
570
    def push(self):
571
        with self._lock:
S
Shuduo Sang 已提交
572 573
            # if ( self.isEmpty() ):
            #     self.lastIndex = self.firstIndex
574
            #     return self.firstIndex
575 576
            # Otherwise we have something
            self.lastIndex += 1
577 578
            self.allocate(self.lastIndex)
            # self.inUse.add(self.lastIndex) # mark it in use immediately
579
            return self.lastIndex
S
Steven Li 已提交
580 581

    def pop(self):
582
        with self._lock:
S
Shuduo Sang 已提交
583 584 585 586
            if (self.isEmpty()):
                # raise RuntimeError("Cannot pop an empty queue")
                return False  # TODO: None?

587
            index = self.firstIndex
S
Shuduo Sang 已提交
588
            if (index in self.inUse):
589 590
                return False

591 592 593 594 595 596 597
            self.firstIndex += 1
            return index

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

    def popIfNotEmpty(self):
598
        with self._lock:
599 600 601 602
            if (self.isEmpty()):
                return 0
            return self.pop()

S
Steven Li 已提交
603
    def allocate(self, i):
604
        with self._lock:
605
            # logger.debug("LQ allocating item {}".format(i))
S
Shuduo Sang 已提交
606 607 608
            if (i in self.inUse):
                raise RuntimeError(
                    "Cannot re-use same index in queue: {}".format(i))
609 610
            self.inUse.add(i)

S
Steven Li 已提交
611
    def release(self, i):
612
        with self._lock:
613
            # logger.debug("LQ releasing item {}".format(i))
S
Shuduo Sang 已提交
614
            self.inUse.remove(i)  # KeyError possible, TODO: why?
615 616 617 618

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

S
Steven Li 已提交
619
    def pickAndAllocate(self):
S
Shuduo Sang 已提交
620
        if (self.isEmpty()):
621 622
            return None
        with self._lock:
S
Shuduo Sang 已提交
623
            cnt = 0  # counting the interations
624 625
            while True:
                cnt += 1
S
Shuduo Sang 已提交
626
                if (cnt > self.size() * 10):  # 10x iteration already
627 628
                    # raise RuntimeError("Failed to allocate LinearQueue element")
                    return None
S
Shuduo Sang 已提交
629 630
                ret = Dice.throwRange(self.firstIndex, self.lastIndex + 1)
                if (ret not in self.inUse):
631 632 633
                    self.allocate(ret)
                    return ret

S
Shuduo Sang 已提交
634

635
class DbConn:
636
    TYPE_NATIVE = "native-c"
637
    TYPE_REST =   "rest-api"
638 639 640 641 642 643 644 645 646
    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 已提交
647 648
            raise RuntimeError(
                "Unexpected connection type: {}".format(connType))
649 650 651 652 653 654 655 656 657

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

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

658 659
    def __init__(self):
        self.isOpen = False
660
        self._type = self.TYPE_INVALID
661 662 663 664
        self._lastSql = None

    def getLastSql(self):
        return self._lastSql
665 666

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

670 671
        # below implemented by child classes
        self.openByType()
672

673
        logger.debug("[DB] data connection opened, type = {}".format(self._type))
674 675
        self.isOpen = True

S
Shuduo Sang 已提交
676
    def queryScalar(self, sql) -> int:
677 678
        return self._queryAny(sql)

S
Shuduo Sang 已提交
679
    def queryString(self, sql) -> str:
680 681
        return self._queryAny(sql)

S
Shuduo Sang 已提交
682 683
    def _queryAny(self, sql):  # actual query result as an int
        if (not self.isOpen):
684
            raise RuntimeError("Cannot query database until connection is open")
685
        nRows = self.query(sql)
S
Shuduo Sang 已提交
686
        if nRows != 1:
687 688 689 690
            raise taos.error.ProgrammingError(
                "Unexpected result for query: {}, rows = {}".format(sql, nRows), 
                (0x991 if nRows==0 else 0x992)
            )
691
        if self.getResultRows() != 1 or self.getResultCols() != 1:
692
            raise RuntimeError("Unexpected result set for query: {}".format(sql))
693 694
        return self.getQueryResult()[0][0]

695 696 697
    def use(self, dbName):
        self.execute("use {}".format(dbName))

698 699 700 701 702 703 704
    def existsDatabase(self, dbName: str):
        ''' Check if a certain database exists '''
        self.query("show databases")
        dbs = [v[0] for v in self.getQueryResult()] # ref: https://stackoverflow.com/questions/643823/python-list-transformation
        # ret2 = dbName in dbs
        # print("dbs = {}, str = {}, ret2={}, type2={}".format(dbs, dbName,ret2, type(dbName)))
        return dbName in dbs # TODO: super weird type mangling seen, once here
705 706 707 708

    def hasTables(self):
        return self.query("show tables") > 0

709
    def execute(self, sql):
710
        ''' Return the number of rows affected'''
711
        raise RuntimeError("Unexpected execution, should be overriden")
S
Shuduo Sang 已提交
712

713 714 715 716 717 718 719 720 721
    def safeExecute(self, sql):
        '''Safely execute any SQL query, returning True/False upon success/failure'''
        try:
            self.execute(sql)
            return True # ignore num of results, return success
        except taos.error.ProgrammingError as err:
            return False # failed, for whatever TAOS reason
        # Not possile to reach here, non-TAOS exception would have been thrown

722
    def query(self, sql) -> int: # return num rows returned
723
        ''' Return the number of rows affected'''
724 725
        raise RuntimeError("Unexpected execution, should be overriden")

726 727
    def openByType(self):
        raise RuntimeError("Unexpected execution, should be overriden")
S
Shuduo Sang 已提交
728

729 730
    def getQueryResult(self):
        raise RuntimeError("Unexpected execution, should be overriden")
S
Shuduo Sang 已提交
731

732 733
    def getResultRows(self):
        raise RuntimeError("Unexpected execution, should be overriden")
S
Shuduo Sang 已提交
734

735 736 737 738
    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 已提交
739 740


741 742 743 744
class DbConnRest(DbConn):
    def __init__(self):
        super().__init__()
        self._type = self.TYPE_REST
S
Steven Li 已提交
745
        self._url = "http://localhost:6041/rest/sql"  # fixed for now
746 747
        self._result = None

S
Shuduo Sang 已提交
748 749 750
    def openByType(self):  # Open connection
        pass  # do nothing, always open

751
    def close(self):
S
Shuduo Sang 已提交
752
        if (not self.isOpen):
753
            raise RuntimeError("Cannot clean up database until connection is open")
754 755 756 757 758
        # Do nothing for REST
        logger.debug("[DB] REST Database connection closed")
        self.isOpen = False

    def _doSql(self, sql):
759
        self._lastSql = sql # remember this, last SQL attempted
760 761 762
        try:
            r = requests.post(self._url, 
                data = sql,
763
                auth = HTTPBasicAuth('root', 'taosdata'))         
764 765 766
        except:
            print("REST API Failure (TODO: more info here)")
            raise
767 768
        rj = r.json()
        # Sanity check for the "Json Result"
S
Shuduo Sang 已提交
769
        if ('status' not in rj):
770 771
            raise RuntimeError("No status in REST response")

S
Shuduo Sang 已提交
772 773 774 775
        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
776
            # print("Raising programming error with REST return: {}".format(rj))
S
Shuduo Sang 已提交
777 778
            raise taos.error.ProgrammingError(
                rj['desc'], errno)  # todo: check existance of 'desc'
779

S
Shuduo Sang 已提交
780 781 782 783
        if rj['status'] != 'succ':  # better be this
            raise RuntimeError(
                "Unexpected REST return status: {}".format(
                    rj['status']))
784 785

        nRows = rj['rows'] if ('rows' in rj) else 0
S
Shuduo Sang 已提交
786
        self._result = rj
787 788
        return nRows

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

S
Shuduo Sang 已提交
799
    def query(self, sql):  # return rows affected
800 801 802 803 804 805 806 807 808 809 810 811 812
        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 已提交
813

814
    # Duplicate code from TDMySQL, TODO: merge all this into DbConnNative
815 816


817
class MyTDSql:
818 819 820 821 822 823 824
    # Class variables
    _clsLock = threading.Lock() # class wide locking
    longestQuery = None # type: str
    longestQueryTime = 0.0 # seconds
    lqStartTime = 0.0
    # lqEndTime = 0.0 # Not needed, as we have the two above already

825 826 827 828 829
    def __init__(self, hostAddr, cfgPath):
        # Make the DB connection
        self._conn = taos.connect(host=hostAddr, config=cfgPath) 
        self._cursor = self._conn.cursor()

830 831 832 833
        self.queryRows = 0
        self.queryCols = 0
        self.affectedRows = 0

834 835
    # def init(self, cursor, log=True):
    #     self.cursor = cursor
836 837 838 839 840
        # if (log):
        #     caller = inspect.getframeinfo(inspect.stack()[1][0])
        #     self.cursor.log(caller.filename + ".sql")

    def close(self):
841
        self._cursor.close() # can we double close?
842 843
        self._conn.close() # TODO: very important, cursor close does NOT close DB connection!
        self._cursor.close()
844

845 846 847
    def _execInternal(self, sql):
        startTime = time.time() 
        ret = self._cursor.execute(sql)
848
        # print("\nSQL success: {}".format(sql))
849 850 851 852 853 854 855 856 857 858
        queryTime =  time.time() - startTime
        # Record the query time
        cls = self.__class__
        if queryTime > (cls.longestQueryTime + 0.01) :
            with cls._clsLock:
                cls.longestQuery = sql
                cls.longestQueryTime = queryTime
                cls.lqStartTime = startTime
        return ret

859 860 861
    def query(self, sql):
        self.sql = sql
        try:
862
            self._execInternal(sql)
863
            self.queryResult = self._cursor.fetchall()
864
            self.queryRows = len(self.queryResult)
865
            self.queryCols = len(self._cursor.description)
866 867 868 869 870 871
        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
872

873 874 875
    def execute(self, sql):
        self.sql = sql
        try:
876
            self.affectedRows = self._execInternal(sql)
877 878 879 880 881 882 883
        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 已提交
884

885
class DbConnNative(DbConn):
886 887 888
    # Class variables
    _lock = threading.Lock()
    _connInfoDisplayed = False
889
    totalConnections = 0 # Not private
890

891 892
    def __init__(self):
        super().__init__()
893
        self._type = self.TYPE_NATIVE
S
Shuduo Sang 已提交
894
        self._conn = None
895
        # self._cursor = None        
S
Shuduo Sang 已提交
896

897 898 899 900 901 902 903
    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")]

904
        buildPath = None
905 906 907 908
        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 已提交
909
                    buildPath = root[:len(root) - len("/build/bin")]
910
                    break
911
        if buildPath == None:
912 913
            raise RuntimeError("Failed to determine buildPath, selfPath={}, projPath={}"
                .format(selfPath, projPath))
914 915
        return buildPath

916
    
S
Shuduo Sang 已提交
917
    def openByType(self):  # Open connection
918
        cfgPath = self.getBuildPath() + "/test/cfg"
919
        hostAddr = "127.0.0.1"
920

921 922 923 924 925 926 927 928 929 930 931
        cls = self.__class__ # Get the class, to access class variables
        with cls._lock: # force single threading for opening DB connections. # TODO: whaaat??!!!
            if not cls._connInfoDisplayed:
                cls._connInfoDisplayed = True # updating CLASS variable
                logger.info("Initiating TAOS native connection to {}, using config at {}".format(hostAddr, cfgPath))                    
            # Make the connection         
            # self._conn = taos.connect(host=hostAddr, config=cfgPath)  # TODO: make configurable
            # self._cursor = self._conn.cursor()
            # Record the count in the class
            self._tdSql = MyTDSql(hostAddr, cfgPath) # making DB connection
            cls.totalConnections += 1 
932
        
933
        self._tdSql.execute('reset query cache')
S
Shuduo Sang 已提交
934
        # self._cursor.execute('use db') # do this at the beginning of every
935 936

        # Open connection
937 938 939
        # self._tdSql = MyTDSql()
        # self._tdSql.init(self._cursor)
        
940
    def close(self):
S
Shuduo Sang 已提交
941
        if (not self.isOpen):
942
            raise RuntimeError("Cannot clean up database until connection is open")
943
        self._tdSql.close()
944 945 946 947 948
        # Decrement the class wide counter
        cls = self.__class__ # Get the class, to access class variables
        with cls._lock:
            cls.totalConnections -= 1

949
        logger.debug("[DB] Database connection closed")
950
        self.isOpen = False
S
Steven Li 已提交
951

S
Shuduo Sang 已提交
952 953
    def execute(self, sql):
        if (not self.isOpen):
954
            raise RuntimeError("Cannot execute database commands until connection is open")
955
        logger.debug("[SQL] Executing SQL: {}".format(sql))
956
        self._lastSql = sql
957
        nRows = self._tdSql.execute(sql)
S
Shuduo Sang 已提交
958 959 960
        logger.debug(
            "[SQL] Execution Result, nRows = {}, SQL = {}".format(
                nRows, sql))
961
        return nRows
S
Steven Li 已提交
962

S
Shuduo Sang 已提交
963 964 965 966
    def query(self, sql):  # return rows affected
        if (not self.isOpen):
            raise RuntimeError(
                "Cannot query database until connection is open")
967
        logger.debug("[SQL] Executing SQL: {}".format(sql))
968
        self._lastSql = sql
969
        nRows = self._tdSql.query(sql)
S
Shuduo Sang 已提交
970 971 972
        logger.debug(
            "[SQL] Query Result, nRows = {}, SQL = {}".format(
                nRows, sql))
973
        return nRows
974
        # results are in: return self._tdSql.queryResult
975

976 977 978
    def getQueryResult(self):
        return self._tdSql.queryResult

979 980
    def getResultRows(self):
        return self._tdSql.queryRows
981

982 983
    def getResultCols(self):
        return self._tdSql.queryCols
984

S
Shuduo Sang 已提交
985

986
class AnyState:
S
Shuduo Sang 已提交
987 988 989
    STATE_INVALID = -1
    STATE_EMPTY = 0  # nothing there, no even a DB
    STATE_DB_ONLY = 1  # we have a DB, but nothing else
990
    STATE_TABLE_ONLY = 2  # we have a table, but totally empty
S
Shuduo Sang 已提交
991
    STATE_HAS_DATA = 3  # we have some data in the table
992 993 994 995
    _stateNames = ["Invalid", "Empty", "DB_Only", "Table_Only", "Has_Data"]

    STATE_VAL_IDX = 0
    CAN_CREATE_DB = 1
996 997 998
    # For below, if we can "drop the DB", but strictly speaking 
    # only "under normal circumstances", as we may override it with the -b option
    CAN_DROP_DB = 2  
999 1000
    CAN_CREATE_FIXED_SUPER_TABLE = 3
    CAN_DROP_FIXED_SUPER_TABLE = 4
1001 1002 1003 1004 1005 1006 1007
    CAN_ADD_DATA = 5
    CAN_READ_DATA = 6

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

    def __str__(self):
S
Shuduo Sang 已提交
1008 1009
        # -1 hack to accomodate the STATE_INVALID case
        return self._stateNames[self._info[self.STATE_VAL_IDX] + 1]
1010

1011 1012
    # Each sub state tells us the "info", about itself, so we can determine
    # on things like canDropDB()
1013 1014 1015
    def getInfo(self):
        raise RuntimeError("Must be overriden by child classes")

S
Steven Li 已提交
1016 1017 1018 1019 1020 1021
    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 已提交
1022 1023 1024
            raise RuntimeError(
                "Unexpected comparison, type = {}".format(
                    type(other)))
S
Steven Li 已提交
1025

1026 1027 1028
    def verifyTasksToState(self, tasks, newState):
        raise RuntimeError("Must be overriden by child classes")

S
Steven Li 已提交
1029 1030 1031
    def getValIndex(self):
        return self._info[self.STATE_VAL_IDX]

1032 1033
    def getValue(self):
        return self._info[self.STATE_VAL_IDX]
S
Shuduo Sang 已提交
1034

1035 1036
    def canCreateDb(self):
        return self._info[self.CAN_CREATE_DB]
S
Shuduo Sang 已提交
1037

1038
    def canDropDb(self):
1039 1040 1041 1042
        # If user requests to run up to a number of DBs,
        # we'd then not do drop_db operations any more
        if gConfig.max_dbs > 0 : 
            return False
1043
        return self._info[self.CAN_DROP_DB]
S
Shuduo Sang 已提交
1044

1045 1046
    def canCreateFixedSuperTable(self):
        return self._info[self.CAN_CREATE_FIXED_SUPER_TABLE]
S
Shuduo Sang 已提交
1047

1048 1049
    def canDropFixedSuperTable(self):
        return self._info[self.CAN_DROP_FIXED_SUPER_TABLE]
S
Shuduo Sang 已提交
1050

1051 1052
    def canAddData(self):
        return self._info[self.CAN_ADD_DATA]
S
Shuduo Sang 已提交
1053

1054 1055 1056 1057 1058
    def canReadData(self):
        return self._info[self.CAN_READ_DATA]

    def assertAtMostOneSuccess(self, tasks, cls):
        sCnt = 0
S
Shuduo Sang 已提交
1059
        for task in tasks:
1060 1061 1062
            if not isinstance(task, cls):
                continue
            if task.isSuccess():
S
Steven Li 已提交
1063
                # task.logDebug("Task success found")
1064
                sCnt += 1
S
Shuduo Sang 已提交
1065 1066 1067
                if (sCnt >= 2):
                    raise RuntimeError(
                        "Unexpected more than 1 success with task: {}".format(cls))
1068 1069 1070 1071

    def assertIfExistThenSuccess(self, tasks, cls):
        sCnt = 0
        exists = False
S
Shuduo Sang 已提交
1072
        for task in tasks:
1073 1074
            if not isinstance(task, cls):
                continue
S
Shuduo Sang 已提交
1075
            exists = True  # we have a valid instance
1076 1077
            if task.isSuccess():
                sCnt += 1
S
Shuduo Sang 已提交
1078
        if (exists and sCnt <= 0):
S
Steven Li 已提交
1079 1080
            raise RuntimeError("Unexpected zero success for task type: {}, from tasks: {}"
                .format(cls, tasks))
1081 1082

    def assertNoTask(self, tasks, cls):
S
Shuduo Sang 已提交
1083
        for task in tasks:
1084
            if isinstance(task, cls):
S
Shuduo Sang 已提交
1085 1086
                raise CrashGenError(
                    "This task: {}, is not expected to be present, given the success/failure of others".format(cls.__name__))
1087 1088

    def assertNoSuccess(self, tasks, cls):
S
Shuduo Sang 已提交
1089
        for task in tasks:
1090 1091
            if isinstance(task, cls):
                if task.isSuccess():
S
Shuduo Sang 已提交
1092 1093
                    raise RuntimeError(
                        "Unexpected successful task: {}".format(cls))
1094 1095

    def hasSuccess(self, tasks, cls):
S
Shuduo Sang 已提交
1096
        for task in tasks:
1097 1098 1099 1100 1101 1102
            if not isinstance(task, cls):
                continue
            if task.isSuccess():
                return True
        return False

S
Steven Li 已提交
1103
    def hasTask(self, tasks, cls):
S
Shuduo Sang 已提交
1104
        for task in tasks:
S
Steven Li 已提交
1105 1106 1107 1108
            if isinstance(task, cls):
                return True
        return False

S
Shuduo Sang 已提交
1109

1110 1111 1112 1113
class StateInvalid(AnyState):
    def getInfo(self):
        return [
            self.STATE_INVALID,
S
Shuduo Sang 已提交
1114 1115 1116
            False, False,  # can create/drop Db
            False, False,  # can create/drop fixed table
            False, False,  # can insert/read data with fixed table
1117 1118 1119 1120
        ]

    # def verifyTasksToState(self, tasks, newState):

S
Shuduo Sang 已提交
1121

1122 1123 1124 1125
class StateEmpty(AnyState):
    def getInfo(self):
        return [
            self.STATE_EMPTY,
S
Shuduo Sang 已提交
1126 1127 1128
            True, False,  # can create/drop Db
            False, False,  # can create/drop fixed table
            False, False,  # can insert/read data with fixed table
1129 1130
        ]

S
Shuduo Sang 已提交
1131 1132
    def verifyTasksToState(self, tasks, newState):
        if (self.hasSuccess(tasks, TaskCreateDb)
1133
                ):  # at EMPTY, if there's succes in creating DB
S
Shuduo Sang 已提交
1134 1135 1136 1137
            if (not self.hasTask(tasks, TaskDropDb)):  # and no drop_db tasks
                # we must have at most one. TODO: compare numbers
                self.assertAtMostOneSuccess(tasks, TaskCreateDb)

1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148

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 已提交
1149 1150 1151
        if (not self.hasTask(tasks, TaskCreateDb)):
            # only if we don't create any more
            self.assertAtMostOneSuccess(tasks, TaskDropDb)
1152 1153 1154 1155 1156

        # TODO: restore the below, the problem exists, although unlikely in real-world
        # if (gSvcMgr!=None) and gSvcMgr.isRestarting():     
        # if (gSvcMgr == None) or (not gSvcMgr.isRestarting()) : 
        #     self.assertIfExistThenSuccess(tasks, TaskDropDb)       
1157

S
Shuduo Sang 已提交
1158

1159
class StateSuperTableOnly(AnyState):
1160 1161 1162 1163 1164 1165 1166 1167 1168
    def getInfo(self):
        return [
            self.STATE_TABLE_ONLY,
            False, True,
            False, True,
            True, True,
        ]

    def verifyTasksToState(self, tasks, newState):
S
Shuduo Sang 已提交
1169
        if (self.hasSuccess(tasks, TaskDropSuperTable)
1170
                ):  # we are able to drop the table
1171
            #self.assertAtMostOneSuccess(tasks, TaskDropSuperTable)
S
Shuduo Sang 已提交
1172 1173
            # we must have had recreted it
            self.hasSuccess(tasks, TaskCreateSuperTable)
1174

1175
            # self._state = self.STATE_DB_ONLY
S
Steven Li 已提交
1176 1177
        # elif ( self.hasSuccess(tasks, AddFixedDataTask) ): # no success dropping the table, but added data
        #     self.assertNoTask(tasks, DropFixedTableTask) # not true in massively parrallel cases
1178
            # self._state = self.STATE_HAS_DATA
S
Steven Li 已提交
1179 1180 1181
        # elif ( self.hasSuccess(tasks, ReadFixedDataTask) ): # no success in prev cases, but was able to read data
            # self.assertNoTask(tasks, DropFixedTableTask)
            # self.assertNoTask(tasks, AddFixedDataTask)
1182
            # self._state = self.STATE_TABLE_ONLY # no change
S
Steven Li 已提交
1183 1184 1185
        # 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!!
1186

S
Shuduo Sang 已提交
1187

1188 1189 1190 1191 1192 1193 1194 1195 1196 1197
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 已提交
1198
        if (newState.equals(AnyState.STATE_EMPTY)):
1199
            self.hasSuccess(tasks, TaskDropDb)
S
Shuduo Sang 已提交
1200 1201 1202 1203
            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)
1204
                ):  # without a create_db task
S
Shuduo Sang 已提交
1205 1206
                # we must have drop_db task
                self.assertNoTask(tasks, TaskDropDb)
1207
            self.hasSuccess(tasks, TaskDropSuperTable)
1208
            # self.assertAtMostOneSuccess(tasks, DropFixedSuperTableTask) # TODO: dicy
1209 1210 1211 1212
        # elif ( newState.equals(AnyState.STATE_TABLE_ONLY) ): # data deleted
            # self.assertNoTask(tasks, TaskDropDb)
            # self.assertNoTask(tasks, TaskDropSuperTable)
            # self.assertNoTask(tasks, TaskAddData)
S
Steven Li 已提交
1213
            # self.hasSuccess(tasks, DeleteDataTasks)
S
Shuduo Sang 已提交
1214 1215
        else:  # should be STATE_HAS_DATA
            if (not self.hasTask(tasks, TaskCreateDb)
1216
                ):  # only if we didn't create one
S
Shuduo Sang 已提交
1217 1218 1219
                # we shouldn't have dropped it
                self.assertNoTask(tasks, TaskDropDb)
            if (not self.hasTask(tasks, TaskCreateSuperTable)
1220
                    ):  # if we didn't create the table
S
Shuduo Sang 已提交
1221 1222
                # we should not have a task that drops it
                self.assertNoTask(tasks, TaskDropSuperTable)
1223
            # self.assertIfExistThenSuccess(tasks, ReadFixedDataTask)
S
Steven Li 已提交
1224

S
Shuduo Sang 已提交
1225

1226
class StateMechine:
1227 1228 1229
    def __init__(self, db: Database): 
        self._db = db
        # transitition target probabilities, indexed with value of STATE_EMPTY, STATE_DB_ONLY, etc.
1230
        self._stateWeights = [1, 2, 10, 40]
S
Shuduo Sang 已提交
1231

1232 1233 1234 1235 1236
    def init(self, dbc: DbConn): # late initailization, don't save the dbConn
        self._curState = self._findCurrentState(dbc)  # starting state
        logger.debug("Found Starting State: {}".format(self._curState))

    # TODO: seems no lnoger used, remove?
1237 1238 1239
    def getCurrentState(self):
        return self._curState

1240 1241 1242
    def hasDatabase(self):
        return self._curState.canDropDb()  # ha, can drop DB means it has one

1243
    # May be slow, use cautionsly...
S
Shuduo Sang 已提交
1244
    def getTaskTypes(self):  # those that can run (directly/indirectly) from the current state
1245 1246 1247 1248 1249 1250
        def typesToStrings(types):
            ss = []
            for t in types:
                ss.append(t.__name__)
            return ss

S
Shuduo Sang 已提交
1251
        allTaskClasses = StateTransitionTask.__subclasses__()  # all state transition tasks
1252 1253
        firstTaskTypes = []
        for tc in allTaskClasses:
S
Shuduo Sang 已提交
1254
            # t = tc(self) # create task object
1255 1256
            if tc.canBeginFrom(self._curState):
                firstTaskTypes.append(tc)
S
Shuduo Sang 已提交
1257 1258 1259 1260 1261 1262 1263 1264
        # 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?
1265
                if tc.canBeginFrom(endState) and (tc not in firstTaskTypes):
S
Shuduo Sang 已提交
1266
                    taskTypes.append(tc)  # gather it
1267 1268

        if len(taskTypes) <= 0:
S
Shuduo Sang 已提交
1269 1270 1271 1272 1273 1274 1275
            raise RuntimeError(
                "No suitable task types found for state: {}".format(
                    self._curState))
        logger.debug(
            "[OPS] Tasks found for state {}: {}".format(
                self._curState,
                typesToStrings(taskTypes)))
1276 1277
        return taskTypes

1278
    def _findCurrentState(self, dbc: DbConn):
S
Shuduo Sang 已提交
1279
        ts = time.time()  # we use this to debug how fast/slow it is to do the various queries to find the current DB state
1280 1281
        dbName =self._db.getName()
        if not dbc.existsDatabase(dbName): # dbc.hasDatabases():  # no database?!
1282
            logger.debug( "[STT] empty database found, between {} and {}".format(ts, time.time()))
1283
            return StateEmpty()
S
Shuduo Sang 已提交
1284 1285
        # did not do this when openning connection, and this is NOT the worker
        # thread, which does this on their own
1286
        dbc.use(dbName)
1287 1288
        if not dbc.hasTables():  # no tables
            logger.debug("[STT] DB_ONLY found, between {} and {}".format(ts, time.time()))
1289
            return StateDbOnly()
1290

1291 1292
        sTable = self._db.getFixedSuperTable()
        if sTable.hasRegTables(dbc, dbName):  # no regular tables
1293
            logger.debug("[STT] SUPER_TABLE_ONLY found, between {} and {}".format(ts, time.time()))
1294
            return StateSuperTableOnly()
S
Shuduo Sang 已提交
1295
        else:  # has actual tables
1296
            logger.debug("[STT] HAS_DATA found, between {} and {}".format(ts, time.time()))
1297 1298
            return StateHasData()

1299 1300
    # We transition the system to a new state by examining the current state itself
    def transition(self, tasks, dbc: DbConn):
S
Shuduo Sang 已提交
1301
        if (len(tasks) == 0):  # before 1st step, or otherwise empty
1302
            logger.debug("[STT] Starting State: {}".format(self._curState))
S
Shuduo Sang 已提交
1303
            return  # do nothing
1304

S
Shuduo Sang 已提交
1305
        # this should show up in the server log, separating steps
1306
        dbc.execute("show dnodes")
1307 1308 1309 1310

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

        if self._curState.canDropDb():
1315
            if gSvcMgr == None: # only if we are running as client-only
S
Steven Li 已提交
1316
                self._curState.assertIfExistThenSuccess(tasks, TaskDropDb)
S
Shuduo Sang 已提交
1317 1318
            # self.assertAtMostOneSuccess(tasks, DropDbTask) # not really in
            # case of drop-create-drop
1319 1320 1321

        # if self._state.canCreateFixedTable():
            # self.assertIfExistThenSuccess(tasks, CreateFixedTableTask) # Not true, DB may be dropped
S
Shuduo Sang 已提交
1322 1323
            # self.assertAtMostOneSuccess(tasks, CreateFixedTableTask) # not
            # really, in case of create-drop-create
1324 1325 1326

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

        # if self._state.canAddData():
S
Shuduo Sang 已提交
1331 1332
        # self.assertIfExistThenSuccess(tasks, AddFixedDataTask)  # not true
        # actually
1333 1334 1335 1336

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

1337
        newState = self._findCurrentState(dbc)
1338
        logger.debug("[STT] New DB state determined: {}".format(newState))
S
Shuduo Sang 已提交
1339 1340
        # can old state move to new state through the tasks?
        self._curState.verifyTasksToState(tasks, newState)
1341 1342 1343
        self._curState = newState

    def pickTaskType(self):
S
Shuduo Sang 已提交
1344 1345
        # all the task types we can choose from at curent state
        taskTypes = self.getTaskTypes()
1346 1347 1348
        weights = []
        for tt in taskTypes:
            endState = tt.getEndState()
S
Shuduo Sang 已提交
1349 1350 1351
            if endState is not None:
                # TODO: change to a method
                weights.append(self._stateWeights[endState.getValIndex()])
1352
            else:
S
Shuduo Sang 已提交
1353 1354
                # read data task, default to 10: TODO: change to a constant
                weights.append(10)
1355
        i = self._weighted_choice_sub(weights)
S
Shuduo Sang 已提交
1356
        # logger.debug(" (weighted random:{}/{}) ".format(i, len(taskTypes)))
1357 1358
        return taskTypes[i]

S
Shuduo Sang 已提交
1359 1360 1361 1362 1363
    # 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)
1364 1365 1366 1367
        for i, w in enumerate(weights):
            rnd -= w
            if rnd < 0:
                return i
1368

1369 1370 1371 1372 1373 1374
class Database:
    ''' We use this to represent an actual TDengine database inside a service instance,
        possibly in a cluster environment.

        For now we use it to manage state transitions in that database
    '''
1375 1376 1377 1378 1379
    _clsLock = threading.Lock() # class wide lock
    _lastInt = 101  # next one is initial integer
    _lastTick = 0
    _lastLaggingTick = 0 # lagging tick, for unsequenced insersions

1380 1381 1382 1383
    def __init__(self, dbNum: int, dbc: DbConn): # TODO: remove dbc
        self._dbNum = dbNum # we assign a number to databases, for our testing purpose
        self._stateMachine = StateMechine(self)
        self._stateMachine.init(dbc)
1384
          
1385
        self._lock = threading.RLock()
S
Shuduo Sang 已提交
1386

1387 1388
    def getStateMachine(self) -> StateMechine:
        return self._stateMachine
S
Shuduo Sang 已提交
1389

1390 1391
    def getDbNum(self):
        return self._dbNum
1392

1393 1394
    def getName(self):
        return "db_{}".format(self._dbNum)
1395

1396 1397 1398 1399 1400 1401
    def filterTasks(self, inTasks: List[Task]): # Pick out those belonging to us
        outTasks = []
        for task in inTasks:
            if task.getDb().isSame(self):
                outTasks.append(task)
        return outTasks
1402

1403 1404 1405 1406 1407
    def isSame(self, other):
        return self._dbNum == other._dbNum

    def exists(self, dbc: DbConn):
        return dbc.existsDatabase(self.getName())
1408

1409 1410 1411 1412 1413 1414 1415
    @classmethod
    def getFixedSuperTableName(cls):
        return "fs_table"

    @classmethod
    def getFixedSuperTable(cls) -> TdSuperTable:
        return TdSuperTable(cls.getFixedSuperTableName())
1416 1417 1418 1419 1420 1421

    # 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
1422
    # TODO: fix the error as result of above: "tsdb timestamp is out of range"
1423 1424
    @classmethod
    def setupLastTick(cls):
1425
        t1 = datetime.datetime(2020, 6, 1)
1426
        t2 = datetime.datetime.now()
S
Shuduo Sang 已提交
1427 1428 1429 1430
        # 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
1431
        # print("elSec = {}".format(elSec))
S
Shuduo Sang 已提交
1432 1433 1434
        t3 = datetime.datetime(2012, 1, 1)  # default "keep" is 10 years
        t4 = datetime.datetime.fromtimestamp(
            t3.timestamp() + elSec2)  # see explanation above
1435 1436 1437
        logger.info("Setting up TICKS to start from: {}".format(t4))
        return t4

1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449
    @classmethod
    def getNextTick(cls):        
        with cls._clsLock:  # prevent duplicate tick
            if cls._lastLaggingTick==0:
                # 10k at 1/20 chance, should be enough to avoid overlaps
                cls._lastLaggingTick = cls.setupLastTick() + datetime.timedelta(0, -10000)                 
            if cls._lastTick==0: # should be quite a bit into the future
                cls._lastTick = cls.setupLastTick()  

            if Dice.throw(20) == 0:  # 1 in 20 chance, return lagging tick
                cls._lastLaggingTick += datetime.timedelta(0, 1) # Go back in time 100 seconds
                return cls._lastLaggingTick 
S
Shuduo Sang 已提交
1450 1451
            else:  # regular
                # add one second to it
1452 1453
                cls._lastTick += datetime.timedelta(0, 1)
                return cls._lastTick
1454 1455

    def getNextInt(self):
1456 1457 1458
        with self._lock:
            self._lastInt += 1
            return self._lastInt
1459 1460

    def getNextBinary(self):
S
Shuduo Sang 已提交
1461 1462
        return "Beijing_Shanghai_Los_Angeles_New_York_San_Francisco_Chicago_Beijing_Shanghai_Los_Angeles_New_York_San_Francisco_Chicago_{}".format(
            self.getNextInt())
1463 1464

    def getNextFloat(self):
1465 1466 1467
        ret = 0.9 + self.getNextInt()
        # print("Float obtained: {}".format(ret))
        return ret
S
Shuduo Sang 已提交
1468

1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517

class DbManager():
    ''' This is a wrapper around DbConn(), to make it easier to use. 

        TODO: rename this to DbConnManager
    '''
    def __init__(self):
        self.tableNumQueue = LinearQueue() # TODO: delete?
        # self.openDbServerConnection()
        self._dbConn = DbConn.createNative() if (
            gConfig.connector_type == 'native') else DbConn.createRest()
        try:
            self._dbConn.open()  # may throw taos.error.ProgrammingError: disconnected
        except taos.error.ProgrammingError as err:
            # print("Error type: {}, msg: {}, value: {}".format(type(err), err.msg, err))
            if (err.msg == 'client disconnected'):  # cannot open DB connection
                print(
                    "Cannot establish DB connection, please re-run script without parameter, and follow the instructions.")
                sys.exit(2)
            else:
                print("Failed to connect to DB, errno = {}, msg: {}"
                    .format(Helper.convertErrno(err.errno), err.msg))
                raise
        except BaseException:
            print("[=] Unexpected exception")
            raise

        # Do this after dbConn is in proper shape
        # Moved to Database()
        # self._stateMachine = StateMechine(self._dbConn)

    def getDbConn(self):
        return self._dbConn

    # TODO: not used any more, to delete
    def pickAndAllocateTable(self):  # pick any table, and "use" it
        return self.tableNumQueue.pickAndAllocate()

    # TODO: Not used any more, to delete
    def addTable(self):
        with self._lock:
            tIndex = self.tableNumQueue.push()
        return tIndex

    # Not used any more, to delete
    def releaseTable(self, i):  # return the table back, so others can use it
        self.tableNumQueue.release(i)    

    # TODO: not used any more, delete
S
Steven Li 已提交
1518
    def getTableNameToDelete(self):
S
Shuduo Sang 已提交
1519 1520
        tblNum = self.tableNumQueue.pop()  # TODO: race condition!
        if (not tblNum):  # maybe false
1521
            return False
S
Shuduo Sang 已提交
1522

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

1525
    def cleanUp(self):
S
Shuduo Sang 已提交
1526 1527
        self._dbConn.close()

1528
class TaskExecutor():
1529
    class BoundedList:
S
Shuduo Sang 已提交
1530
        def __init__(self, size=10):
1531 1532
            self._size = size
            self._list = []
S
Steven Li 已提交
1533
            self._lock = threading.Lock()
1534

S
Shuduo Sang 已提交
1535
        def add(self, n: int):
S
Steven Li 已提交
1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561
            with self._lock:
                if not self._list:  # empty
                    self._list.append(n)
                    return
                # now we should insert
                nItems = len(self._list)
                insPos = 0
                for i in range(nItems):
                    insPos = i
                    if n <= self._list[i]:  # smaller than this item, time to insert
                        break  # found the insertion point
                    insPos += 1  # insert to the right

                if insPos == 0:  # except for the 1st item, # TODO: elimiate first item as gating item
                    return  # do nothing

                # print("Inserting at postion {}, value: {}".format(insPos, n))
                self._list.insert(insPos, n)  # insert

                newLen = len(self._list)
                if newLen <= self._size:
                    return  # do nothing
                elif newLen == (self._size + 1):
                    del self._list[0]  # remove the first item
                else:
                    raise RuntimeError("Corrupt Bounded List")
1562 1563 1564 1565 1566 1567

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

    _boundedList = BoundedList()

1568 1569 1570
    def __init__(self, curStep):
        self._curStep = curStep

1571 1572 1573 1574
    @classmethod
    def getBoundedList(cls):
        return cls._boundedList

1575 1576 1577
    def getCurStep(self):
        return self._curStep

S
Shuduo Sang 已提交
1578
    def execute(self, task: Task, wt: WorkerThread):  # execute a task on a thread
1579
        task.execute(wt)
1580

1581 1582 1583 1584
    def recordDataMark(self, n: int):
        # print("[{}]".format(n), end="", flush=True)
        self._boundedList.add(n)

1585 1586
    # def logInfo(self, msg):
    #     logger.info("    T[{}.x]: ".format(self._curStep) + msg)
1587

1588 1589
    # def logDebug(self, msg):
    #     logger.debug("    T[{}.x]: ".format(self._curStep) + msg)
1590

S
Shuduo Sang 已提交
1591

S
Steven Li 已提交
1592
class Task():
1593 1594 1595 1596
    ''' A generic "Task" to be executed. For now we decide that there is no
        need to embed a DB connection here, we use whatever the Worker Thread has
        instead. But a task is always associated with a DB
    '''
1597 1598 1599 1600
    taskSn = 100

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

1605
    def __init__(self, execStats: ExecutionStats, db: Database):
S
Shuduo Sang 已提交
1606
        self._workerThread = None
1607
        self._err = None # type: Exception
1608
        self._aborted = False
1609
        self._curStep = None
S
Shuduo Sang 已提交
1610
        self._numRows = None  # Number of rows affected
1611

S
Shuduo Sang 已提交
1612
        # Assign an incremental task serial number
1613
        self._taskNum = self.allocTaskNum()
S
Steven Li 已提交
1614
        # logger.debug("Creating new task {}...".format(self._taskNum))
1615

1616
        self._execStats = execStats
1617
        self._db = db # A task is always associated/for a specific DB
1618

1619
    def isSuccess(self):
S
Shuduo Sang 已提交
1620
        return self._err is None
1621

1622 1623 1624
    def isAborted(self):
        return self._aborted

S
Shuduo Sang 已提交
1625
    def clone(self):  # TODO: why do we need this again?
1626
        newTask = self.__class__(self._execStats, self._db)
1627 1628
        return newTask

1629 1630 1631
    def getDb(self):
        return self._db

1632
    def logDebug(self, msg):
S
Shuduo Sang 已提交
1633 1634 1635
        self._workerThread.logDebug(
            "Step[{}.{}] {}".format(
                self._curStep, self._taskNum, msg))
1636 1637

    def logInfo(self, msg):
S
Shuduo Sang 已提交
1638 1639 1640
        self._workerThread.logInfo(
            "Step[{}.{}] {}".format(
                self._curStep, self._taskNum, msg))
1641

1642
    def _executeInternal(self, te: TaskExecutor, wt: WorkerThread):
S
Shuduo Sang 已提交
1643 1644 1645
        raise RuntimeError(
            "To be implemeted by child classes, class name: {}".format(
                self.__class__.__name__))
1646

1647 1648 1649 1650
    def _isErrAcceptable(self, errno, msg):
        if errno in [
                0x05,  # TSDB_CODE_RPC_NOT_READY
                # 0x200, # invalid SQL, TODO: re-examine with TD-934
1651 1652
                0x217, # "db not selected", client side defined error code
                0x218, # "Table does not exist" client side defined error code
1653 1654 1655 1656 1657 1658 1659 1660 1661
                0x360, 0x362, 
                0x369, # tag already exists
                0x36A, 0x36B, 0x36D,
                0x381, 
                0x380, # "db not selected"
                0x383,
                0x386,  # DB is being dropped?!
                0x503,
                0x510,  # vnode not in ready state
1662
                0x14,   # db not ready, errno changed
1663 1664 1665 1666
                0x600,
                1000  # REST catch-all error
            ]: 
            return True # These are the ALWAYS-ACCEPTABLE ones
1667 1668
        elif (errno in [ 0x0B ]) and gConfig.auto_start_service:
            return True # We may get "network unavilable" when restarting service
1669 1670 1671
        elif errno == 0x200 : # invalid SQL, we need to div in a bit more
            if msg.find("invalid column name") != -1:
                return True 
1672 1673 1674 1675
            elif msg.find("tags number not matched") != -1: # mismatched tags after modification
                return True
            elif msg.find("duplicated column names") != -1: # also alter table tag issues
                return True
S
Steven Li 已提交
1676 1677 1678
        elif (gSvcMgr!=None) and gSvcMgr.isRestarting():
            logger.info("Ignoring error when service is restarting: errno = {}, msg = {}".format(errno, msg))
            return True
1679 1680 1681 1682
        
        return False # Not an acceptable error


1683 1684
    def execute(self, wt: WorkerThread):
        wt.verifyThreadSelf()
S
Shuduo Sang 已提交
1685
        self._workerThread = wt  # type: ignore
1686 1687

        te = wt.getTaskExecutor()
1688
        self._curStep = te.getCurStep()
S
Shuduo Sang 已提交
1689 1690
        self.logDebug(
            "[-] executing task {}...".format(self.__class__.__name__))
1691

1692
        self._err = None # TODO: type hint mess up?
1693 1694
        self._execStats.beginTaskType(self.__class__.__name__)  # mark beginning
        errno2 = None
1695 1696 1697

        # Now pick a database, and stick with it for the duration of the task execution
        dbName = self._db.getName()
1698
        try:
S
Shuduo Sang 已提交
1699
            self._executeInternal(te, wt)  # TODO: no return value?
1700
        except taos.error.ProgrammingError as err:
1701
            errno2 = Helper.convertErrno(err.errno)
1702
            if (gConfig.continue_on_exception):  # user choose to continue
1703
                self.logDebug("[=] Continue after TAOS exception: errno=0x{:X}, msg: {}, SQL: {}".format(
1704
                        errno2, err, wt.getDbConn().getLastSql()))
1705
                self._err = err
1706 1707
            elif self._isErrAcceptable(errno2, err.__str__()):
                self.logDebug("[=] Acceptable Taos library exception: errno=0x{:X}, msg: {}, SQL: {}".format(
1708
                        errno2, err, wt.getDbConn().getLastSql()))
1709
                print("_", end="", flush=True)
S
Shuduo Sang 已提交
1710
                self._err = err
1711
            else: # not an acceptable error
1712 1713 1714
                errMsg = "[=] Unexpected Taos library exception ({}): errno=0x{:X}, msg: {}, SQL: {}".format(
                    self.__class__.__name__,
                    errno2, err, wt.getDbConn().getLastSql())
1715
                self.logDebug(errMsg)
S
Shuduo Sang 已提交
1716
                if gConfig.debug:
1717 1718
                    # raise # so that we see full stack
                    traceback.print_exc()
1719 1720
                print(
                    "\n\n----------------------------\nProgram ABORTED Due to Unexpected TAOS Error: \n\n{}\n".format(errMsg) +
1721 1722 1723 1724
                    "----------------------------\n")
                # sys.exit(-1)
                self._err = err
                self._aborted = True
S
Shuduo Sang 已提交
1725
        except Exception as e:
S
Steven Li 已提交
1726
            self.logInfo("Non-TAOS exception encountered")
S
Shuduo Sang 已提交
1727
            self._err = e
S
Steven Li 已提交
1728
            self._aborted = True
1729
            traceback.print_exc()
1730
        except BaseException as e:
1731
            self.logInfo("Python base exception encountered")
1732
            self._err = e
1733
            self._aborted = True
S
Steven Li 已提交
1734
            traceback.print_exc()
1735
        except BaseException: # TODO: what is this again??!!
S
Shuduo Sang 已提交
1736 1737
            self.logDebug(
                "[=] Unexpected exception, SQL: {}".format(
1738
                    wt.getDbConn().getLastSql()))
1739
            raise
1740
        self._execStats.endTaskType(self.__class__.__name__, self.isSuccess())
S
Shuduo Sang 已提交
1741 1742 1743 1744

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

1747
    # TODO: refactor away, just provide the dbConn
S
Shuduo Sang 已提交
1748
    def execWtSql(self, wt: WorkerThread, sql):  # execute an SQL on the worker thread
1749
        """ Haha """
1750 1751
        return wt.execSql(sql)

S
Shuduo Sang 已提交
1752
    def queryWtSql(self, wt: WorkerThread, sql):  # execute an SQL on the worker thread
1753 1754
        return wt.querySql(sql)

S
Shuduo Sang 已提交
1755
    def getQueryResult(self, wt: WorkerThread):  # execute an SQL on the worker thread
1756 1757 1758
        return wt.getQueryResult()


1759
class ExecutionStats:
1760
    def __init__(self):
S
Shuduo Sang 已提交
1761 1762
        # total/success times for a task
        self._execTimes: Dict[str, [int, int]] = {}
1763 1764 1765
        self._tasksInProgress = 0
        self._lock = threading.Lock()
        self._firstTaskStartTime = None
1766
        self._execStartTime = None
1767
        self._errors = {}
S
Shuduo Sang 已提交
1768 1769
        self._elapsedTime = 0.0  # total elapsed time
        self._accRunTime = 0.0  # accumulated run time
1770

1771 1772 1773
        self._failed = False
        self._failureReason = None

S
Steven Li 已提交
1774
    def __str__(self):
S
Shuduo Sang 已提交
1775 1776
        return "[ExecStats: _failed={}, _failureReason={}".format(
            self._failed, self._failureReason)
S
Steven Li 已提交
1777 1778

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

1781 1782 1783 1784 1785 1786
    def startExec(self):
        self._execStartTime = time.time()

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

1787
    def incExecCount(self, klassName, isSuccess, eno=None):  # TODO: add a lock here
1788 1789
        if klassName not in self._execTimes:
            self._execTimes[klassName] = [0, 0]
S
Shuduo Sang 已提交
1790 1791
        t = self._execTimes[klassName]  # tuple for the data
        t[0] += 1  # index 0 has the "total" execution times
1792
        if isSuccess:
S
Shuduo Sang 已提交
1793
            t[1] += 1  # index 1 has the "success" execution times
1794 1795 1796 1797 1798
        if eno != None:             
            if klassName not in self._errors:
                self._errors[klassName] = {}
            errors = self._errors[klassName]
            errors[eno] = errors[eno]+1 if eno in errors else 1
1799 1800 1801

    def beginTaskType(self, klassName):
        with self._lock:
S
Shuduo Sang 已提交
1802 1803
            if self._tasksInProgress == 0:  # starting a new round
                self._firstTaskStartTime = time.time()  # I am now the first task
1804 1805 1806 1807 1808
            self._tasksInProgress += 1

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

1813 1814 1815 1816
    def registerFailure(self, reason):
        self._failed = True
        self._failureReason = reason

1817
    def printStats(self):
S
Shuduo Sang 已提交
1818 1819 1820 1821 1822 1823
        logger.info(
            "----------------------------------------------------------------------")
        logger.info(
            "| Crash_Gen test {}, with the following stats:". format(
                "FAILED (reason: {})".format(
                    self._failureReason) if self._failed else "SUCCEEDED"))
1824
        logger.info("| Task Execution Times (success/total):")
1825
        execTimesAny = 0
S
Shuduo Sang 已提交
1826
        for k, n in self._execTimes.items():
1827
            execTimesAny += n[0]
1828 1829 1830 1831 1832 1833 1834 1835
            errStr = None
            if k in self._errors:
                errors = self._errors[k]
                # print("errors = {}".format(errors))
                errStrs = ["0x{:X}:{}".format(eno, n) for (eno, n) in errors.items()]
                # print("error strings = {}".format(errStrs))
                errStr = ", ".join(errStrs) 
            logger.info("|    {0:<24}: {1}/{2} (Errors: {3})".format(k, n[1], n[0], errStr))
S
Shuduo Sang 已提交
1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849

        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))
1850
        logger.info("| Top numbers written: {}".format(TaskExecutor.getBoundedList()))
1851
        logger.info("| Active DB Native Connections (now): {}".format(DbConnNative.totalConnections))
1852 1853 1854 1855
        logger.info("| Longest native query time: {:.3f} seconds, started: {}".
            format(MyTDSql.longestQueryTime, 
                time.strftime("%x %X", time.localtime(MyTDSql.lqStartTime))) )
        logger.info("| Longest native query: {}".format(MyTDSql.longestQuery))
S
Shuduo Sang 已提交
1856 1857
        logger.info(
            "----------------------------------------------------------------------")
1858 1859 1860


class StateTransitionTask(Task):
1861 1862 1863 1864 1865
    LARGE_NUMBER_OF_TABLES = 35
    SMALL_NUMBER_OF_TABLES = 3
    LARGE_NUMBER_OF_RECORDS = 50
    SMALL_NUMBER_OF_RECORDS = 3

1866
    @classmethod
S
Shuduo Sang 已提交
1867
    def getInfo(cls):  # each sub class should supply their own information
1868 1869
        raise RuntimeError("Overriding method expected")

S
Shuduo Sang 已提交
1870
    _endState = None
1871
    @classmethod
S
Shuduo Sang 已提交
1872
    def getEndState(cls):  # TODO: optimize by calling it fewer times
1873 1874
        raise RuntimeError("Overriding method expected")

1875 1876 1877
    # @classmethod
    # def getBeginStates(cls):
    #     return cls.getInfo()[0]
1878

1879 1880 1881
    # @classmethod
    # def getEndState(cls): # returning the class name
    #     return cls.getInfo()[0]
1882 1883

    @classmethod
1884 1885 1886
    def canBeginFrom(cls, state: AnyState):
        # return state.getValue() in cls.getBeginStates()
        raise RuntimeError("must be overriden")
1887

1888 1889
    @classmethod
    def getRegTableName(cls, i):
1890
        return "reg_table_{}".format(i)
1891

1892 1893
    def execute(self, wt: WorkerThread):
        super().execute(wt)
S
Shuduo Sang 已提交
1894 1895


1896
class TaskCreateDb(StateTransitionTask):
1897
    @classmethod
1898
    def getEndState(cls):
S
Shuduo Sang 已提交
1899
        return StateDbOnly()
1900

1901 1902 1903 1904
    @classmethod
    def canBeginFrom(cls, state: AnyState):
        return state.canCreateDb()

1905
    # Actually creating the database(es)
1906
    def _executeInternal(self, te: TaskExecutor, wt: WorkerThread):
1907
        # was: self.execWtSql(wt, "create database db")
1908 1909 1910 1911 1912 1913
        repStr = ""
        if gConfig.max_replicas != 1:
            numReplica = Dice.throw(gConfig.max_replicas) + 1 # 1,2 ... N
            repStr = "replica {}".format(numReplica)
        self.execWtSql(wt, "create database {} {}"
            .format(self._db.getName(), repStr) )
1914

1915
class TaskDropDb(StateTransitionTask):
1916
    @classmethod
1917 1918
    def getEndState(cls):
        return StateEmpty()
1919

1920 1921 1922 1923
    @classmethod
    def canBeginFrom(cls, state: AnyState):
        return state.canDropDb()

1924
    def _executeInternal(self, te: TaskExecutor, wt: WorkerThread):
1925
        self.execWtSql(wt, "drop database {}".format(self._db.getName()))
S
Steven Li 已提交
1926
        logger.debug("[OPS] database dropped at {}".format(time.time()))
1927

1928
class TaskCreateSuperTable(StateTransitionTask):
1929
    @classmethod
1930 1931
    def getEndState(cls):
        return StateSuperTableOnly()
1932

1933 1934
    @classmethod
    def canBeginFrom(cls, state: AnyState):
1935
        return state.canCreateFixedSuperTable()
1936

1937
    def _executeInternal(self, te: TaskExecutor, wt: WorkerThread):
1938
        if not self._db.exists(wt.getDbConn()):
1939 1940 1941
            logger.debug("Skipping task, no DB yet")
            return

1942
        sTable = self._db.getFixedSuperTable() # type: TdSuperTable
1943
        # wt.execSql("use db")    # should always be in place
1944 1945
        sTable.create(wt.getDbConn(), self._db.getName(), 
            {'ts':'timestamp', 'speed':'int'}, {'b':'binary(200)', 'f':'float'})
1946
        # self.execWtSql(wt,"create table db.{} (ts timestamp, speed int) tags (b binary(200), f float) ".format(tblName))
S
Shuduo Sang 已提交
1947 1948
        # No need to create the regular tables, INSERT will do that
        # automatically
1949

S
Steven Li 已提交
1950

1951 1952 1953 1954
class TdSuperTable:
    def __init__(self, stName):
        self._stName = stName

1955 1956 1957
    def getName(self):
        return self._stName

1958 1959 1960 1961 1962
    # TODO: odd semantic, create() method is usually static?
    def create(self, dbc, dbName, cols: dict, tags: dict):
        '''Creating a super table'''
        sql = "CREATE TABLE {}.{} ({}) TAGS ({})".format(
            dbName,
1963 1964 1965 1966 1967 1968
            self._stName,
            ",".join(['%s %s'%(k,v) for (k,v) in cols.items()]),
            ",".join(['%s %s'%(k,v) for (k,v) in tags.items()])
            )
        dbc.execute(sql)        

1969
    def getRegTables(self, dbc: DbConn, dbName: str):
1970
        try:
1971
            dbc.query("select TBNAME from {}.{}".format(dbName, self._stName))  # TODO: analyze result set later            
1972
        except taos.error.ProgrammingError as err:                    
1973
            errno2 = Helper.convertErrno(err.errno) 
1974 1975 1976 1977 1978 1979
            logger.debug("[=] Failed to get tables from super table: errno=0x{:X}, msg: {}".format(errno2, err))
            raise

        qr = dbc.getQueryResult()
        return [v[0] for v in qr] # list transformation, ref: https://stackoverflow.com/questions/643823/python-list-transformation

1980 1981
    def hasRegTables(self, dbc: DbConn, dbName: str):
        return dbc.query("SELECT * FROM {}.{}".format(dbName, self._stName)) > 0
1982

1983 1984
    def ensureTable(self, dbc: DbConn, dbName: str, regTableName: str):
        sql = "select tbname from {}.{} where tbname in ('{}')".format(dbName, self._stName, regTableName)
1985 1986
        if dbc.query(sql) >= 1 : # reg table exists already
            return
1987 1988
        sql = "CREATE TABLE {}.{} USING {}.{} tags ({})".format(
            dbName, regTableName, dbName, self._stName, self._getTagStrForSql(dbc, dbName)
1989 1990 1991
        )
        dbc.execute(sql)

1992 1993
    def _getTagStrForSql(self, dbc, dbName: str) :
        tags = self._getTags(dbc, dbName)
1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006
        tagStrs = []
        for tagName in tags: 
            tagType = tags[tagName]
            if tagType == 'BINARY':
                tagStrs.append("'Beijing-Shanghai-LosAngeles'")
            elif tagType == 'FLOAT':
                tagStrs.append('9.9')
            elif tagType == 'INT':
                tagStrs.append('88')
            else:
                raise RuntimeError("Unexpected tag type: {}".format(tagType))
        return ", ".join(tagStrs)

2007 2008
    def _getTags(self, dbc, dbName) -> dict:
        dbc.query("DESCRIBE {}.{}".format(dbName, self._stName))
2009 2010 2011 2012 2013 2014
        stCols = dbc.getQueryResult()
        # print(stCols)
        ret = {row[0]:row[1] for row in stCols if row[3]=='TAG'} # name:type
        # print("Tags retrieved: {}".format(ret))
        return ret

2015 2016
    def addTag(self, dbc, dbName, tagName, tagType):
        if tagName in self._getTags(dbc, dbName): # already 
2017 2018
            return
        # sTable.addTag("extraTag", "int")
2019
        sql = "alter table {}.{} add tag {} {}".format(dbName, self._stName, tagName, tagType)
2020 2021
        dbc.execute(sql)

2022 2023
    def dropTag(self, dbc, dbName, tagName):
        if not tagName in self._getTags(dbc, dbName): # don't have this tag
2024
            return
2025
        sql = "alter table {}.{} drop tag {}".format(dbName, self._stName, tagName)
2026 2027
        dbc.execute(sql)

2028 2029
    def changeTag(self, dbc, dbName, oldTag, newTag):
        tags = self._getTags(dbc, dbName)
2030 2031 2032 2033
        if not oldTag in tags: # don't have this tag
            return
        if newTag in tags: # already have this tag
            return
2034
        sql = "alter table {}.{} change tag {} {}".format(dbName, self._stName, oldTag, newTag)
2035 2036
        dbc.execute(sql)

2037
class TaskReadData(StateTransitionTask):
2038
    @classmethod
2039
    def getEndState(cls):
S
Shuduo Sang 已提交
2040
        return None  # meaning doesn't affect state
2041

2042 2043 2044 2045
    @classmethod
    def canBeginFrom(cls, state: AnyState):
        return state.canReadData()

2046
    def _executeInternal(self, te: TaskExecutor, wt: WorkerThread):
2047
        sTable = self._db.getFixedSuperTable()
2048

2049 2050
        # 1 in 5 chance, simulate a broken connection. 
        if random.randrange(5) == 0:  # TODO: break connection in all situations
2051 2052
            wt.getDbConn().close()
            wt.getDbConn().open()
2053
            print("_r", end="", flush=True)
2054
        
2055
        dbc = wt.getDbConn()
2056 2057
        dbName = self._db.getName()
        for rTbName in sTable.getRegTables(dbc, dbName):  # regular tables
2058
            aggExpr = Dice.choice([
2059 2060 2061
                '*',
                'count(*)',
                'avg(speed)',
2062
                # 'twa(speed)', # TODO: this one REQUIRES a where statement, not reasonable
2063 2064
                'sum(speed)', 
                'stddev(speed)', 
2065
                # SELECTOR functions
2066 2067 2068
                'min(speed)', 
                'max(speed)', 
                'first(speed)', 
2069
                'last(speed)',
2070 2071 2072
                'top(speed, 50)', # TODO: not supported?
                'bottom(speed, 50)', # TODO: not supported?
                'apercentile(speed, 10)', # TODO: TD-1316
2073 2074 2075 2076 2077
                'last_row(speed)',
                # Transformation Functions
                # 'diff(speed)', # TODO: no supported?!
                'spread(speed)'
                ]) # TODO: add more from 'top'
2078 2079 2080
            filterExpr = Dice.choice([ # TODO: add various kind of WHERE conditions
                None
            ])
2081
            try:
2082
                # Run the query against the regular table first
2083
                dbc.execute("select {} from {}.{}".format(aggExpr, dbName, rTbName))
2084
                # Then run it against the super table
2085
                if aggExpr not in ['stddev(speed)']: #TODO: STDDEV not valid for super tables?!
2086
                    dbc.execute("select {} from {}.{}".format(aggExpr, dbName, sTable.getName()))
2087
            except taos.error.ProgrammingError as err:                    
2088
                errno2 = Helper.convertErrno(err.errno)
2089
                logger.debug("[=] Read Failure: errno=0x{:X}, msg: {}, SQL: {}".format(errno2, err, dbc.getLastSql()))
2090
                raise
S
Shuduo Sang 已提交
2091

2092
class TaskDropSuperTable(StateTransitionTask):
2093
    @classmethod
2094
    def getEndState(cls):
S
Shuduo Sang 已提交
2095
        return StateDbOnly()
2096

2097 2098
    @classmethod
    def canBeginFrom(cls, state: AnyState):
2099
        return state.canDropFixedSuperTable()
2100

2101
    def _executeInternal(self, te: TaskExecutor, wt: WorkerThread):
2102
        # 1/2 chance, we'll drop the regular tables one by one, in a randomized sequence
S
Shuduo Sang 已提交
2103
        if Dice.throw(2) == 0:
2104
            # print("_7_", end="", flush=True)
S
Shuduo Sang 已提交
2105 2106 2107 2108
            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"
2109
            isSuccess = True
S
Shuduo Sang 已提交
2110
            for i in tblSeq:
2111
                regTableName = self.getRegTableName(i)  # "db.reg_table_{}".format(i)
2112
                try:
2113 2114
                    self.execWtSql(wt, "drop table {}.{}".
                        format(self._db.getName(), regTableName))  # nRows always 0, like MySQL
S
Shuduo Sang 已提交
2115
                except taos.error.ProgrammingError as err:
2116 2117
                    # correcting for strange error number scheme                    
                    errno2 = Helper.convertErrno(err.errno)
S
Shuduo Sang 已提交
2118
                    if (errno2 in [0x362]):  # mnode invalid table name
2119
                        isSuccess = False
2120
                        logger.debug("[DB] Acceptable error when dropping a table")
S
Shuduo Sang 已提交
2121
                    continue  # try to delete next regular table
2122 2123

                if (not tickOutput):
S
Shuduo Sang 已提交
2124 2125
                    tickOutput = True  # Print only one time
                    if isSuccess:
2126 2127
                        print("d", end="", flush=True)
                    else:
S
Shuduo Sang 已提交
2128
                        print("f", end="", flush=True)
2129 2130

        # Drop the super table itself
2131 2132
        tblName = self._db.getFixedSuperTableName()
        self.execWtSql(wt, "drop table {}.{}".format(self._db.getName(), tblName))
2133

S
Shuduo Sang 已提交
2134

2135 2136 2137
class TaskAlterTags(StateTransitionTask):
    @classmethod
    def getEndState(cls):
S
Shuduo Sang 已提交
2138
        return None  # meaning doesn't affect state
2139 2140 2141

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

    def _executeInternal(self, te: TaskExecutor, wt: WorkerThread):
2145 2146
        # tblName = self._dbManager.getFixedSuperTableName()
        dbc = wt.getDbConn()
2147 2148
        sTable = self._db.getFixedSuperTable()
        dbName = self._db.getName()
2149
        dice = Dice.throw(4)
S
Shuduo Sang 已提交
2150
        if dice == 0:
2151
            sTable.addTag(dbc, dbName, "extraTag", "int")
2152
            # sql = "alter table db.{} add tag extraTag int".format(tblName)
S
Shuduo Sang 已提交
2153
        elif dice == 1:
2154
            sTable.dropTag(dbc, dbName, "extraTag")
2155
            # sql = "alter table db.{} drop tag extraTag".format(tblName)
S
Shuduo Sang 已提交
2156
        elif dice == 2:
2157
            sTable.dropTag(dbc, dbName, "newTag")
2158
            # sql = "alter table db.{} drop tag newTag".format(tblName)
S
Shuduo Sang 已提交
2159
        else:  # dice == 3
2160
            sTable.changeTag(dbc, dbName, "extraTag", "newTag")
2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176
            # sql = "alter table db.{} change tag extraTag newTag".format(tblName)

class TaskRestartService(StateTransitionTask):
    _isRunning = False
    _classLock = threading.Lock()

    @classmethod
    def getEndState(cls):
        return None  # meaning doesn't affect state

    @classmethod
    def canBeginFrom(cls, state: AnyState):
        if gConfig.auto_start_service:
            return state.canDropFixedSuperTable()  # Basicallly when we have the super table
        return False # don't run this otherwise

2177
    CHANCE_TO_RESTART_SERVICE = 200
2178 2179 2180 2181
    def _executeInternal(self, te: TaskExecutor, wt: WorkerThread):
        if not gConfig.auto_start_service: # only execute when we are in -a mode
            print("_a", end="", flush=True)
            return
2182

2183 2184 2185 2186 2187 2188
        with self._classLock:
            if self._isRunning:
                print("Skipping restart task, another running already")
                return
            self._isRunning = True

2189
        if Dice.throw(self.CHANCE_TO_RESTART_SERVICE) == 0: # 1 in N chance
2190 2191 2192
            dbc = wt.getDbConn()
            dbc.execute("show databases") # simple delay, align timing with other workers
            gSvcMgr.restart()
2193

2194
        self._isRunning = False
S
Shuduo Sang 已提交
2195

2196
class TaskAddData(StateTransitionTask):
S
Shuduo Sang 已提交
2197 2198
    # Track which table is being actively worked on
    activeTable: Set[int] = set()
2199

S
Shuduo Sang 已提交
2200 2201
    # We use these two files to record operations to DB, useful for power-off
    # tests
2202 2203 2204 2205 2206
    fAddLogReady = None
    fAddLogDone = None

    @classmethod
    def prepToRecordOps(cls):
S
Shuduo Sang 已提交
2207 2208 2209 2210
        if gConfig.record_ops:
            if (cls.fAddLogReady is None):
                logger.info(
                    "Recording in a file operations to be performed...")
2211
                cls.fAddLogReady = open("add_log_ready.txt", "w")
S
Shuduo Sang 已提交
2212
            if (cls.fAddLogDone is None):
2213 2214
                logger.info("Recording in a file operations completed...")
                cls.fAddLogDone = open("add_log_done.txt", "w")
2215

2216
    @classmethod
2217 2218
    def getEndState(cls):
        return StateHasData()
2219 2220 2221 2222

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

2224
    def _executeInternal(self, te: TaskExecutor, wt: WorkerThread):
2225 2226
        # ds = self._dbManager # Quite DANGEROUS here, may result in multi-thread client access
        db = self._db
2227
        dbc = wt.getDbConn()
2228
        tblSeq = list(range(
S
Shuduo Sang 已提交
2229 2230 2231 2232
                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
2233
                print("x", end="", flush=True) # concurrent insertion
2234
            else:
S
Shuduo Sang 已提交
2235
                self.activeTable.add(i)  # marking it active
2236
            
2237
            sTable = db.getFixedSuperTable()
2238
            regTableName = self.getRegTableName(i)  # "db.reg_table_{}".format(i)
2239
            sTable.ensureTable(wt.getDbConn(), db.getName(), regTableName)  # Ensure the table exists           
2240 2241
           
            for j in range(self.LARGE_NUMBER_OF_RECORDS if gConfig.larger_data else self.SMALL_NUMBER_OF_RECORDS):  # number of records per table
2242
                nextInt = db.getNextInt()
2243
                nextTick = db.getNextTick()
2244 2245
                if gConfig.record_ops:
                    self.prepToRecordOps()
2246
                    self.fAddLogReady.write("Ready to write {} to {}\n".format(nextInt, regTableName))
2247 2248
                    self.fAddLogReady.flush()
                    os.fsync(self.fAddLogReady)
2249 2250
                sql = "insert into {}.{} values ('{}', {});".format( # removed: tags ('{}', {})
                    db.getName(),
S
Shuduo Sang 已提交
2251
                    regTableName,
2252 2253
                    # ds.getFixedSuperTableName(),
                    # ds.getNextBinary(), ds.getNextFloat(),
2254 2255
                    nextTick, nextInt)
                dbc.execute(sql)
S
Shuduo Sang 已提交
2256 2257
                # Successfully wrote the data into the DB, let's record it
                # somehow
2258
                te.recordDataMark(nextInt)
2259
                if gConfig.record_ops:
S
Shuduo Sang 已提交
2260 2261 2262
                    self.fAddLogDone.write(
                        "Wrote {} to {}\n".format(
                            nextInt, regTableName))
2263 2264
                    self.fAddLogDone.flush()
                    os.fsync(self.fAddLogDone)
2265 2266

                # Now read it back and verify, we might encounter an error if table is dropped
2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283
                if gConfig.verify_data: # only if command line asks for it
                    try:
                        readBack = dbc.queryScalar("SELECT speed from {}.{} WHERE ts= '{}'".
                            format(db.getName(), regTableName, nextTick))
                        if readBack != nextInt :
                            raise taos.error.ProgrammingError(
                                "Failed to read back same data, wrote: {}, read: {}"
                                .format(nextInt, readBack), 0x999)
                    except taos.error.ProgrammingError as err:
                        errno = Helper.convertErrno(err.errno)
                        if errno in [0x991, 0x992]  : # not a single result
                            raise taos.error.ProgrammingError(
                                "Failed to read back same data for tick: {}, wrote: {}, read: {}"
                                .format(nextTick, nextInt, "Empty Result" if errno==0x991 else "Multiple Result"),
                                errno)
                        # Re-throw no matter what
                        raise
2284 2285
                

S
Shuduo Sang 已提交
2286
            self.activeTable.discard(i)  # not raising an error, unlike remove
2287 2288


S
Steven Li 已提交
2289 2290
# Deterministic random number generator
class Dice():
S
Shuduo Sang 已提交
2291
    seeded = False  # static, uninitialized
S
Steven Li 已提交
2292 2293

    @classmethod
S
Shuduo Sang 已提交
2294
    def seed(cls, s):  # static
S
Steven Li 已提交
2295
        if (cls.seeded):
S
Shuduo Sang 已提交
2296 2297
            raise RuntimeError(
                "Cannot seed the random generator more than once")
S
Steven Li 已提交
2298 2299 2300 2301 2302
        cls.verifyRNG()
        random.seed(s)
        cls.seeded = True  # TODO: protect against multi-threading

    @classmethod
S
Shuduo Sang 已提交
2303
    def verifyRNG(cls):  # Verify that the RNG is determinstic
S
Steven Li 已提交
2304 2305 2306 2307
        random.seed(0)
        x1 = random.randrange(0, 1000)
        x2 = random.randrange(0, 1000)
        x3 = random.randrange(0, 1000)
S
Shuduo Sang 已提交
2308
        if (x1 != 864 or x2 != 394 or x3 != 776):
S
Steven Li 已提交
2309 2310 2311
            raise RuntimeError("System RNG is not deterministic")

    @classmethod
S
Shuduo Sang 已提交
2312
    def throw(cls, stop):  # get 0 to stop-1
2313
        return cls.throwRange(0, stop)
S
Steven Li 已提交
2314 2315

    @classmethod
S
Shuduo Sang 已提交
2316 2317
    def throwRange(cls, start, stop):  # up to stop-1
        if (not cls.seeded):
S
Steven Li 已提交
2318
            raise RuntimeError("Cannot throw dice before seeding it")
2319
        return random.randrange(start, stop)
S
Steven Li 已提交
2320

2321 2322 2323 2324
    @classmethod
    def choice(cls, cList):
        return random.choice(cList)

S
Steven Li 已提交
2325

S
Steven Li 已提交
2326 2327
class LoggingFilter(logging.Filter):
    def filter(self, record: logging.LogRecord):
S
Shuduo Sang 已提交
2328 2329
        if (record.levelno >= logging.INFO):
            return True  # info or above always log
S
Steven Li 已提交
2330

S
Steven Li 已提交
2331 2332 2333 2334
        # Commenting out below to adjust...

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

S
Shuduo Sang 已提交
2337 2338

class MyLoggingAdapter(logging.LoggerAdapter):
2339 2340 2341 2342
    def process(self, msg, kwargs):
        return "[{}]{}".format(threading.get_ident() % 10000, msg), kwargs
        # return '[%s] %s' % (self.extra['connid'], msg), kwargs

S
Shuduo Sang 已提交
2343 2344

class SvcManager:
2345
    def __init__(self):
2346
        print("Starting TDengine Service Manager")
2347 2348 2349
        # signal.signal(signal.SIGTERM, self.sigIntHandler) # Moved to MainExec
        # signal.signal(signal.SIGINT, self.sigIntHandler)
        # signal.signal(signal.SIGUSR1, self.sigUsrHandler)  # different handler!
2350

2351
        self.inSigHandler = False
2352 2353
        # self._status = MainExec.STATUS_RUNNING # set inside
        # _startTaosService()
2354
        self.svcMgrThread = None # type: ServiceManagerThread
2355 2356
        self._lock = threading.Lock()
        self._isRestarting = False
2357

2358 2359 2360 2361 2362 2363 2364 2365
    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 已提交
2366
            # print("Enter Choice: ", end="", flush=True)
2367 2368 2369
            while choice == "":
                choice = input("Enter Choice: ")
                if choice != "":
S
Shuduo Sang 已提交
2370 2371 2372
                    break  # done with reading repeated input
            if choice in ["1", "2", "3"]:
                break  # we are done with whole method
2373
            print("Invalid choice, please try again.")
S
Shuduo Sang 已提交
2374
            choice = ""  # reset
2375 2376
        return choice

S
Shuduo Sang 已提交
2377
    def sigUsrHandler(self, signalNumber, frame):
2378
        print("Interrupting main thread execution upon SIGUSR1")
2379
        if self.inSigHandler:  # already
2380
            print("Ignoring repeated SIG...")
S
Shuduo Sang 已提交
2381
            return  # do nothing if it's already not running
2382
        self.inSigHandler = True
2383 2384

        choice = self._doMenu()
S
Shuduo Sang 已提交
2385 2386 2387 2388 2389
        if choice == "1":
            # TODO: can the sub-process be blocked due to us not reading from
            # queue?
            self.sigHandlerResume()
        elif choice == "2":
2390
            self.stopTaosService()
2391 2392
        elif choice == "3": # Restart
            self.restart()
2393 2394
        else:
            raise RuntimeError("Invalid menu choice: {}".format(choice))
2395

2396 2397
        self.inSigHandler = False

2398
    def sigIntHandler(self, signalNumber, frame):
2399
        print("SvcManager: INT Signal Handler starting...")
2400
        if self.inSigHandler:
2401 2402
            print("Ignoring repeated SIG_INT...")
            return
2403
        self.inSigHandler = True
2404

S
Shuduo Sang 已提交
2405
        self.stopTaosService()
2406
        print("SvcManager: INT Signal Handler returning...")
2407
        self.inSigHandler = False
2408

S
Shuduo Sang 已提交
2409
    def sigHandlerResume(self):
2410
        print("Resuming TDengine service manager thread (main thread)...\n\n")
2411

2412
    def _checkServiceManagerThread(self):
2413 2414 2415 2416
        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
2417 2418

    def _procIpcAll(self):
2419 2420 2421 2422 2423 2424
        while self.isRunning() or self.isRestarting() :  # for as long as the svc mgr thread is still here
            if self.isRunning():
                self.svcMgrThread.procIpcBatch()  # regular processing,
                self._checkServiceManagerThread()
            elif self.isRetarting():
                print("Service restarting...")
2425 2426 2427 2428 2429
            time.sleep(0.5)  # pause, before next round
        print(
            "Service Manager Thread (with subprocess) has ended, main thread now exiting...")

    def startTaosService(self):
2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440
        with self._lock:
            if self.svcMgrThread:
                raise RuntimeError("Cannot start TAOS service when one may already be running")

            # Find if there's already a taosd service, and then kill it
            for proc in psutil.process_iter():
                if proc.name() == 'taosd':
                    print("Killing an existing TAOSD process in 2 seconds... press CTRL-C to interrupe")
                    time.sleep(2.0)
                    proc.kill()
                # print("Process: {}".format(proc.name()))
2441

2442 2443
            
            self.svcMgrThread = ServiceManagerThread()  # create the object
S
Steven Li 已提交
2444
            print("Attempting to start TAOS service started, printing out output...")
2445
            self.svcMgrThread.start()            
2446
            self.svcMgrThread.procIpcBatch(trimToTarget=10, forceOutput=True)  # for printing 10 lines             
2447
            print("TAOS service started")
2448 2449

    def stopTaosService(self, outputLines=20):
2450 2451 2452 2453
        with self._lock:
            if not self.isRunning():
                logger.warning("Cannot stop TAOS service, not running")
                return
2454

2455 2456 2457 2458 2459
            print("Terminating Service Manager Thread (SMT) execution...")
            self.svcMgrThread.stop()
            if self.svcMgrThread.isStopped():
                self.svcMgrThread.procIpcBatch(outputLines)  # one last time
                self.svcMgrThread = None
2460 2461
                print("End of TDengine Service Output")
                print("----- TDengine Service (managed by SMT) is now terminated -----\n")
2462 2463
            else:
                print("WARNING: SMT did not terminate as expected")
2464 2465 2466

    def run(self):
        self.startTaosService()
2467
        self._procIpcAll()  # pump/process all the messages, may encounter SIG + restart
2468
        if self.isRunning():  # if sig handler hasn't destroyed it by now
2469 2470
            self.stopTaosService()  # should have started already

2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484
    def restart(self):
        if self._isRestarting:
            logger.warning("Cannot restart service when it's already restarting")
            return

        self._isRestarting = True
        if self.isRunning():
            self.stopTaosService()
        else:
            logger.warning("Service not running when restart requested")

        self.startTaosService()
        self._isRestarting = False

2485 2486
    def isRunning(self):
        return self.svcMgrThread != None
2487

2488 2489 2490
    def isRestarting(self):
        return self._isRestarting

2491 2492 2493 2494
class ServiceManagerThread:
    MAX_QUEUE_SIZE = 10000

    def __init__(self):
2495
        self._tdeSubProcess = None # type: TdeSubProcess
2496
        self._thread = None
2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513
        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
2514 2515
    def start(self):
        if self._thread:
2516
            raise RuntimeError("Unexpected _thread")
2517
        if self._tdeSubProcess:
2518 2519 2520 2521
            raise RuntimeError("TDengine sub process already created/running")

        self._status = MainExec.STATUS_STARTING

2522
        self._tdeSubProcess = TdeSubProcess()
2523 2524 2525
        self._tdeSubProcess.start()

        self._ipcQueue = Queue()
2526
        self._thread = threading.Thread( # First thread captures server OUTPUT
2527
            target=self.svcOutputReader,
2528
            args=(self._tdeSubProcess.getStdOut(), self._ipcQueue))
2529
        self._thread.daemon = True  # thread dies with the program
2530 2531
        self._thread.start()

2532
        self._thread2 = threading.Thread( # 2nd thread captures server ERRORs
2533 2534 2535 2536 2537
            target=self.svcErrorReader,
            args=(self._tdeSubProcess.getStdErr(), self._ipcQueue))
        self._thread2.daemon = True  # thread dies with the program
        self._thread2.start()

2538
        # wait for service to start
R
root 已提交
2539
        for i in range(0, 100):
2540 2541 2542
            time.sleep(1.0)
            # self.procIpcBatch() # don't pump message during start up
            print("_zz_", end="", flush=True)
2543
            if self._status == MainExec.STATUS_RUNNING:
2544
                logger.info("[] TDengine service READY to process requests")
2545 2546
                return  # now we've started
        # TODO: handle this better?
R
root 已提交
2547
        self.procIpcBatch(100, True) # display output before cronking out, trim to last 20 msgs, force output
2548
        raise RuntimeError("TDengine service did not start successfully")
2549 2550 2551 2552 2553 2554

    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")
2555
            return
2556 2557 2558
        if self.isStopping():
            print("Service is already being stopped")
            return
2559 2560 2561 2562
        # 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:
2563
            raise RuntimeError("sub process object missing")
2564

2565
        self._status = MainExec.STATUS_STOPPING
2566 2567
        retCode = self._tdeSubProcess.stop()
        print("Attempted to stop sub process, got return code: {}".format(retCode))
2568 2569
        if (retCode==-11): # SGV
            logger.error("[[--ERROR--]]: TDengine service SEGV fault (check core file!)")
2570

2571
        if self._tdeSubProcess.isRunning():  # still running
2572 2573
            print("FAILED to stop sub process, it is still running... pid = {}".format(
                    self._tdeSubProcess.getPid()))
2574
        else:
2575 2576 2577
            self._tdeSubProcess = None  # not running any more
            self.join()  # stop the thread, change the status, etc.

2578 2579 2580
    def join(self):
        # TODO: sanity check
        if not self.isStopping():
2581 2582 2583
            raise RuntimeError(
                "Unexpected status when ending svc mgr thread: {}".format(
                    self._status))
2584

2585
        if self._thread:
2586
            self._thread.join()
2587
            self._thread = None
2588
            self._status = MainExec.STATUS_STOPPED
2589 2590 2591
            # STD ERR thread
            self._thread2.join()
            self._thread2 = None
S
Shuduo Sang 已提交
2592
        else:
2593
            print("Joining empty thread, doing nothing")
2594 2595 2596

    def _trimQueue(self, targetSize):
        if targetSize <= 0:
2597
            return  # do nothing
2598
        q = self._ipcQueue
2599
        if (q.qsize() <= targetSize):  # no need to trim
2600 2601 2602 2603
            return

        logger.debug("Triming IPC queue to target size: {}".format(targetSize))
        itemsToTrim = q.qsize() - targetSize
2604
        for i in range(0, itemsToTrim):
2605 2606 2607
            try:
                q.get_nowait()
            except Empty:
2608 2609
                break  # break out of for loop, no more trimming

2610
    TD_READY_MSG = "TDengine is initialized successfully"
S
Shuduo Sang 已提交
2611

2612 2613
    def procIpcBatch(self, trimToTarget=0, forceOutput=False):
        self._trimQueue(trimToTarget)  # trim if necessary
S
Shuduo Sang 已提交
2614 2615
        # Process all the output generated by the underlying sub process,
        # managed by IO thread
2616
        print("<", end="", flush=True)
S
Shuduo Sang 已提交
2617 2618
        while True:
            try:
2619
                line = self._ipcQueue.get_nowait()  # getting output at fast speed
2620
                self._printProgress("_o")
2621 2622 2623
            except Empty:
                # time.sleep(2.3) # wait only if there's no output
                # no more output
2624
                print(".>", end="", flush=True)
S
Shuduo Sang 已提交
2625
                return  # we are done with THIS BATCH
2626
            else:  # got line, printing out
2627 2628 2629 2630 2631 2632 2633
                if forceOutput:
                    logger.info(line)
                else:
                    logger.debug(line)
        print(">", end="", flush=True)

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

2635 2636
    def _printProgress(self, msg):  # TODO: assuming 2 chars
        print(msg, end="", flush=True)
2637 2638 2639
        pBar = self._ProgressBars[Dice.throw(4)]
        print(pBar, end="", flush=True)
        print('\b\b\b\b', end="", flush=True)
2640

2641 2642 2643
    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...")
2644
        # for line in out :
2645 2646 2647
        for line in iter(out.readline, b''):
            # print("Finished reading a line: {}".format(line))
            # print("Adding item to queue...")
2648 2649 2650 2651 2652
            try:
                line = line.decode("utf-8").rstrip()
            except UnicodeError:
                print("\nNon-UTF8 server output: {}\n".format(line))

2653 2654
            # This might block, and then causing "out" buffer to block
            queue.put(line)
2655 2656
            self._printProgress("_i")

2657 2658
            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
S
Steven Li 已提交
2659
                    logger.info("Waiting for the service to become FULLY READY")
2660
                    time.sleep(1.0) # wait for the server to truly start. TODO: remove this
S
Steven Li 已提交
2661 2662
                    logger.info("Service is now FULLY READY")   
                    self._status = MainExec.STATUS_RUNNING                 
2663 2664

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

2667 2668 2669
            if self.isStopping():  # TODO: use thread status instead
                # WAITING for stopping sub process to finish its outptu
                print("_w", end="", flush=True)
2670 2671

            # queue.put(line)
2672 2673
        # meaning sub process must have died
        print("\nNo more output from IO thread managing TDengine service")
2674 2675
        out.close()

2676 2677
    def svcErrorReader(self, err: IO, queue):
        for line in iter(err.readline, b''):
2678
            print("\nTDengine Service (taosd) ERROR (from stderr): {}".format(line))
2679

2680 2681

class TdeSubProcess:
2682 2683 2684 2685 2686
    def __init__(self):
        self.subProcess = None

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

2688 2689 2690
    def getStdErr(self):
        return self.subProcess.stderr

2691
    def isRunning(self):
2692
        return self.subProcess is not None
2693

2694 2695 2696
    def getPid(self):
        return self.subProcess.pid

S
Shuduo Sang 已提交
2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710
    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
2711

2712
    def start(self):
2713
        ON_POSIX = 'posix' in sys.builtin_module_names
S
Shuduo Sang 已提交
2714

2715 2716 2717
        taosdPath = self.getBuildPath() + "/build/bin/taosd"
        cfgPath = self.getBuildPath() + "/test/cfg"

2718 2719 2720
        # Delete the log files
        logPath = self.getBuildPath() + "/test/log"
        # ref: https://stackoverflow.com/questions/1995373/deleting-all-files-in-a-directory-with-python/1995397
2721 2722 2723 2724
        # filelist = [ f for f in os.listdir(logPath) ] # if f.endswith(".bak") ]
        # for f in filelist:
        #     filePath = os.path.join(logPath, f)
        #     print("Removing log file: {}".format(filePath))
2725 2726 2727 2728 2729 2730
        #     os.remove(filePath)        
        if os.path.exists(logPath):
            logPathSaved = logPath + "_" + time.strftime('%Y-%m-%d-%H-%M-%S')
            logger.info("Saving old log files to: {}".format(logPathSaved))
            os.rename(logPath, logPathSaved)
        # os.mkdir(logPath) # recreate, no need actually, TDengine will auto-create with proper perms
2731
            
S
Shuduo Sang 已提交
2732
        svcCmd = [taosdPath, '-c', cfgPath]
2733
        # svcCmdSingle = "{} -c {}".format(taosdPath, cfgPath)
2734
        # svcCmd = ['vmstat', '1']
S
Shuduo Sang 已提交
2735
        if self.subProcess:  # already there
2736 2737
            raise RuntimeError("Corrupt process state")

S
Steven Li 已提交
2738
        # print("Starting service: {}".format(svcCmd))
2739
        self.subProcess = subprocess.Popen(
2740 2741
            svcCmd, shell=False,
            # svcCmdSingle, shell=True, # capture core dump?
S
Shuduo Sang 已提交
2742
            stdout=subprocess.PIPE,
2743
            stderr=subprocess.PIPE,
2744
            # bufsize=1, # not supported in binary mode
S
Steven Li 已提交
2745 2746
            close_fds=ON_POSIX
            )  # had text=True, which interferred with reading EOF
2747

2748 2749 2750
    def stop(self):
        if not self.subProcess:
            print("Sub process already stopped")
2751
            return -1
2752

2753
        retCode = self.subProcess.poll() # contains real sub process return code
S
Shuduo Sang 已提交
2754
        if retCode:  # valid return code, process ended
2755
            self.subProcess = None
S
Shuduo Sang 已提交
2756 2757
        else:  # process still alive, let's interrupt it
            print(
2758
                "Sub process is running, sending SIG_INT and waiting for it to terminate...")
S
Shuduo Sang 已提交
2759 2760 2761 2762
            # sub process should end, then IPC queue should end, causing IO
            # thread to end
            self.subProcess.send_signal(signal.SIGINT)
            try:
2763
                self.subProcess.wait(10)
2764
                retCode = self.subProcess.returncode
2765 2766
            except subprocess.TimeoutExpired as err:
                print("Time out waiting for TDengine service process to exit")
2767
                retCode = -3
2768
            else:
2769
                print("TDengine service process terminated successfully from SIG_INT")
2770
                retCode = -4
2771
                self.subProcess = None
2772
        return retCode
2773

2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801
class ThreadStacks: # stack info for all threads
    def __init__(self):
        self._allStacks = {}
        allFrames = sys._current_frames()
        for th in threading.enumerate():                        
            stack = traceback.extract_stack(allFrames[th.ident])     
            self._allStacks[th.native_id] = stack

    def print(self, filteredEndName = None, filterInternal = False):
        for thNid, stack in self._allStacks.items(): # for each thread            
            lastFrame = stack[-1]
            if filteredEndName: # we need to filter out stacks that match this name                
                if lastFrame.name == filteredEndName : # end did not match
                    continue
            if filterInternal:
                if lastFrame.name in ['wait', 'invoke_excepthook', 
                    '_wait', # The Barrier exception
                    'svcOutputReader', # the svcMgr thread
                    '__init__']: # the thread that extracted the stack
                    continue # ignore
            # Now print
            print("\n<----- Thread Info for ID: {}".format(thNid))
            for frame in stack:
                # print(frame)
                print("File {filename}, line {lineno}, in {name}".format(
                    filename=frame.filename, lineno=frame.lineno, name=frame.name))
                print("    {}".format(frame.line))
            print("-----> End of Thread Info\n")
S
Shuduo Sang 已提交
2802

2803 2804 2805
class ClientManager:
    def __init__(self):
        print("Starting service manager")
2806 2807
        # signal.signal(signal.SIGTERM, self.sigIntHandler)
        # signal.signal(signal.SIGINT, self.sigIntHandler)
2808

2809
        self._status = MainExec.STATUS_RUNNING
2810 2811
        self.tc = None

2812 2813
        self.inSigHandler = False

2814
    def sigIntHandler(self, signalNumber, frame):
2815
        if self._status != MainExec.STATUS_RUNNING:
2816 2817 2818
            print("Repeated SIGINT received, forced exit...")
            # return  # do nothing if it's already not running
            sys.exit(-1)
2819
        self._status = MainExec.STATUS_STOPPING  # immediately set our status
2820

2821
        print("ClientManager: Terminating program...")
2822 2823
        self.tc.requestToStop()

2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864
    def _doMenu(self):
        choice = ""
        while True:
            print("\nInterrupting Client Program, Choose an Action: ")
            print("1: Resume")
            print("2: Terminate")
            print("3: Show Threads")
            # Remember to update the if range below
            # print("Enter Choice: ", end="", flush=True)
            while choice == "":
                choice = input("Enter Choice: ")
                if choice != "":
                    break  # done with reading repeated input
            if choice in ["1", "2", "3"]:
                break  # we are done with whole method
            print("Invalid choice, please try again.")
            choice = ""  # reset
        return choice

    def sigUsrHandler(self, signalNumber, frame):
        print("Interrupting main thread execution upon SIGUSR1")
        if self.inSigHandler:  # already
            print("Ignoring repeated SIG_USR1...")
            return  # do nothing if it's already not running
        self.inSigHandler = True

        choice = self._doMenu()
        if choice == "1":
            print("Resuming execution...")
            time.sleep(1.0)
        elif choice == "2":
            print("Not implemented yet")
            time.sleep(1.0)
        elif choice == "3":
            ts = ThreadStacks()
            ts.print()
        else:
            raise RuntimeError("Invalid menu choice: {}".format(choice))

        self.inSigHandler = False

2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893
    # TODO: need to revise how we verify data durability
    # def _printLastNumbers(self):  # to verify data durability
    #     dbManager = DbManager()
    #     dbc = dbManager.getDbConn()
    #     if dbc.query("show databases") <= 1:  # no database (we have a default called "log")
    #         return
    #     dbc.execute("use db")
    #     if dbc.query("show tables") == 0:  # no tables
    #         return

    #     sTbName = dbManager.getFixedSuperTableName()

    #     # get all regular tables
    #     # TODO: analyze result set later
    #     dbc.query("select TBNAME from db.{}".format(sTbName))
    #     rTables = dbc.getQueryResult()

    #     bList = TaskExecutor.BoundedList()
    #     for rTbName in rTables:  # regular tables
    #         dbc.query("select speed from db.{}".format(rTbName[0]))
    #         numbers = dbc.getQueryResult()
    #         for row in numbers:
    #             # 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)
    #     dbManager = None  # release?
2894

2895
    def run(self, svcMgr):    
2896
        # self._printLastNumbers()
2897
        global gConfig
2898

S
Shuduo Sang 已提交
2899
        dbManager = DbManager()  # Regular function
2900
        thPool = ThreadPool(gConfig.num_threads, gConfig.max_steps)
2901
        self.tc = ThreadCoordinator(thPool, dbManager)
2902
        
2903
        self.tc.run()
S
Steven Li 已提交
2904 2905
        # print("exec stats: {}".format(self.tc.getExecStats()))
        # print("TC failed = {}".format(self.tc.isFailed()))
2906
        if svcMgr: # gConfig.auto_start_service:
2907
            svcMgr.stopTaosService()
2908
            svcMgr = None
2909 2910
        # Print exec status, etc., AFTER showing messages from the server
        self.conclude()
S
Steven Li 已提交
2911
        # print("TC failed (2) = {}".format(self.tc.isFailed()))
S
Shuduo Sang 已提交
2912
        # Linux return code: ref https://shapeshed.com/unix-exit-codes/
2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931
        ret = 1 if self.tc.isFailed() else 0
        self.tc.cleanup()

        # Release global variables
        gConfig = None
        gSvcMgr = None
        logger = None

        # Release variables here
        self.tc = None
        thPool = None
        dbManager = None

        gc.collect() # force garbage collection
        # h = hpy()
        # print("\n----- Final Python Heap -----\n")        
        # print(h.heap())

        return ret
2932 2933

    def conclude(self):
2934
        # self.tc.getDbManager().cleanUp() # clean up first, so we can show ZERO db connections
2935
        self.tc.printStats()
2936 2937 2938

        
        
2939 2940

class MainExec:
2941 2942 2943
    STATUS_STARTING = 1
    STATUS_RUNNING = 2
    STATUS_STOPPING = 3
2944
    STATUS_STOPPED = 4
2945

2946 2947 2948
    def __init__(self):        
        self._clientMgr = None
        self._svcMgr = None
2949

2950 2951 2952
        signal.signal(signal.SIGTERM, self.sigIntHandler)
        signal.signal(signal.SIGINT,  self.sigIntHandler)
        signal.signal(signal.SIGUSR1, self.sigUsrHandler)  # different handler!
2953

2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966
    def sigUsrHandler(self, signalNumber, frame):
        if self._clientMgr:
            self._clientMgr.sigUsrHandler(signalNumber, frame)
        elif self._svcMgr: # Only if no client mgr, we are running alone
            self._svcMgr.sigUsrHandler(signalNumber, frame)
        
    def sigIntHandler(self, signalNumber, frame):
        if self._svcMgr:
            self._svcMgr.sigIntHandler(signalNumber, frame)
        if self._clientMgr:
            self._clientMgr.sigIntHandler(signalNumber, frame)

    def runClient(self):
2967
        global gSvcMgr
2968 2969
        if gConfig.auto_start_service:
            self._svcMgr = SvcManager()
2970
            gSvcMgr = self._svcMgr # hack alert
2971 2972 2973
            self._svcMgr.startTaosService() # we start, don't run
        
        self._clientMgr = ClientManager()
2974 2975 2976 2977
        ret = None
        try: 
            ret = self._clientMgr.run(self._svcMgr) # stop TAOS service inside
        except requests.exceptions.ConnectionError as err:
S
Steven Li 已提交
2978
            logger.warning("Failed to open REST connection to DB: {}".format(err.getMessage()))
2979 2980
            # don't raise
        return ret
2981 2982

    def runService(self):
2983
        global gSvcMgr
2984
        self._svcMgr = SvcManager()
2985 2986
        gSvcMgr = self._svcMgr # save it in a global variable TODO: hack alert

2987
        self._svcMgr.run() # run to some end state
2988 2989
        self._svcMgr = None 
        gSvcMgr = None        
2990 2991

    def runTemp(self):  # for debugging purposes
2992 2993
        # # Hack to exercise reading from disk, imcreasing coverage. TODO: fix
        # dbc = dbState.getDbConn()
S
Shuduo Sang 已提交
2994
        # sTbName = dbState.getFixedSuperTableName()
2995 2996
        # dbc.execute("create database if not exists db")
        # if not dbState.getState().equals(StateEmpty()):
S
Shuduo Sang 已提交
2997
        #     dbc.execute("use db")
2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008

        # 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 已提交
3009

3010 3011 3012 3013 3014 3015 3016 3017
        # # 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 已提交
3018
        #                 rTbName[0],
3019 3020
        #                 ds.getNextTick(), ds.getNextInt())
        #             dbc.execute(sql)
S
Shuduo Sang 已提交
3021
        #         for rTbName in rTables : # regular tables
3022
        #             dbc.query("select * from db.{}".format(rTbName[0])) # TODO: check success failure
S
Shuduo Sang 已提交
3023
        #         logger.info("Initial READING operation is successful")
3024
        #     except taos.error.ProgrammingError as err:
S
Shuduo Sang 已提交
3025 3026
        #         logger.info("Initial WRITE/READ error: {}".format(err))

3027 3028 3029
        # Sandbox testing code
        # dbc = dbState.getDbConn()
        # while True:
S
Shuduo Sang 已提交
3030
        #     rows = dbc.query("show databases")
3031
        #     print("Rows: {}, time={}".format(rows, time.time()))
S
Shuduo Sang 已提交
3032 3033
        return

S
Steven Li 已提交
3034

3035
def main():
S
Shuduo Sang 已提交
3036 3037
    # Super cool Python argument library:
    # https://docs.python.org/3/library/argparse.html
3038 3039 3040 3041 3042 3043 3044 3045 3046
    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

            '''))
3047

3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068
    # 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 已提交
3069 3070 3071 3072 3073
    parser.add_argument(
        '-a',
        '--auto-start-service',
        action='store_true',
        help='Automatically start/stop the TDengine service (default: false)')
3074 3075 3076 3077 3078 3079 3080
    parser.add_argument(
        '-b',
        '--max-dbs',
        action='store',
        default=0,
        type=int,
        help='Maximum number of DBs to keep, set to disable dropping DB. (default: 0)')
S
Shuduo Sang 已提交
3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097
    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)')
3098 3099 3100 3101 3102 3103 3104
    parser.add_argument(
        '-i',
        '--max-replicas',
        action='store',
        default=1,
        type=int,
        help='Maximum number of replicas to use, when testing against clusters. (default: 1)')
S
Shuduo Sang 已提交
3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133
    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)')
3134
    parser.add_argument(
3135 3136 3137 3138 3139
        '-v',
        '--verify-data',
        action='store_true',
        help='Verify data written in a number of places by reading back (default: false)')
    parser.add_argument(
3140 3141 3142 3143
        '-x',
        '--continue-on-exception',
        action='store_true',
        help='Continue execution after encountering unexpected/disallowed errors/exceptions (default: false)')
3144

3145
    global gConfig
3146
    gConfig = parser.parse_args()
3147

3148
    # Logging Stuff
3149
    global logger
S
Shuduo Sang 已提交
3150 3151
    _logger = logging.getLogger('CrashGen')  # real logger
    _logger.addFilter(LoggingFilter())
3152 3153 3154
    ch = logging.StreamHandler()
    _logger.addHandler(ch)

S
Shuduo Sang 已提交
3155 3156
    # Logging adapter, to be used as a logger
    logger = MyLoggingAdapter(_logger, [])
3157

S
Shuduo Sang 已提交
3158 3159
    if (gConfig.debug):
        logger.setLevel(logging.DEBUG)  # default seems to be INFO
S
Steven Li 已提交
3160 3161
    else:
        logger.setLevel(logging.INFO)
S
Shuduo Sang 已提交
3162

3163 3164
    Dice.seed(0)  # initial seeding of dice

3165
    # Run server or client
3166
    mExec = MainExec()
S
Shuduo Sang 已提交
3167
    if gConfig.run_tdengine:  # run server
3168
        mExec.runService()
S
Shuduo Sang 已提交
3169
    else:
3170
        return mExec.runClient()
3171

S
Shuduo Sang 已提交
3172

3173
if __name__ == "__main__":
S
Steven Li 已提交
3174 3175 3176
    exitCode = main()
    # print("Exiting with code: {}".format(exitCode))
    sys.exit(exitCode)