#3523

Committed 06 Nov 2024 02:29AM UTC coverage: 55.861% (-2.4%) from 58.216%

Build # #3523

Build Type

push

travis-ci

Committed by

web-flow

Commit Message

Merge pull request #28551 from taosdata/feat/TS-5215-2

test(blob): testing & fixes for blob

Run Details

106075 of 245834 branches covered (43.15%)

Branch coverage included in aggregate %.

0 of 15 new or added lines in 2 files covered. (0.0%)

17003 existing lines in 254 files now uncovered.

181910 of 269703 relevant lines covered (67.45%)

1527639.59 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

56.25

/tools/shell/src/shellArguments.c

/*
 * Copyright (c) 2019 TAOS Data, Inc. <jhtao@taosdata.com>
 *
 * This program is free software: you can use, redistribute, and/or modify
 * it under the terms of the GNU Affero General Public License, version 3
 * or later ("AGPL"), as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

#ifdef _TD_DARWIN_64
#include <pwd.h>
#endif

#include "shellInt.h"
#include "version.h"

#if defined(CUS_NAME) || defined(CUS_PROMPT) || defined(CUS_EMAIL)
#include "cus_name.h"
#else
#ifndef CUS_PROMPT
#define CUS_PROMPT "taos"
#endif
#endif

#define TAOS_CONSOLE_PROMPT_CONTINUE "   -> "

#define SHELL_HOST     "The server FQDN to connect. The default host is localhost."
#define SHELL_PORT     "The TCP/IP port number to use for the connection."
#define SHELL_USER     "The user name to use when connecting to the server."
#define SHELL_PASSWORD "The password to use when connecting to the server."
#define SHELL_AUTH     "The auth string to use when connecting to the server."
#define SHELL_GEN_AUTH "Generate auth string from password."
#define SHELL_CFG_DIR  "Configuration directory."
#define SHELL_DMP_CFG  "Dump configuration."
#define SHELL_CMD      "Commands to run without enter the shell."
#define SHELL_RAW_TIME "Output time as uint64_t."
#define SHELL_FILE     "Script to run without enter the shell."
#define SHELL_DB       "Database to use when connecting to the server."
#define SHELL_CHECK    "Check the service status."
#define SHELL_STARTUP  "Check the details of the service status."
#define SHELL_WIDTH    "Set the default binary display width, default is 30."
#define SHELL_NET_ROLE "Net role when network connectivity test, options: client|server."
#define SHELL_PKT_LEN  "Packet length used for net test, default is 1024 bytes."
#define SHELL_PKT_NUM  "Packet numbers used for net test, default is 100."
#define SHELL_BI_MODE  "Set BI mode"
#define SHELL_VERSION  "Print program version."

#ifdef WEBSOCKET
#define SHELL_DSN     "Use dsn to connect to the cloud server or to a remote server which provides WebSocket connection."
#define SHELL_REST    "Use RESTful mode when connecting."
#define SHELL_TIMEOUT "Set the timeout for websocket query in seconds, default is 30."
#endif

static int32_t shellParseSingleOpt(int32_t key, char *arg);

void shellPrintHelp() {
  char indent[] = "  ";
  printf("Usage: %s [OPTION...] \r\n\r\n", CUS_PROMPT);
  printf("%s%s%s%s\r\n", indent, "-a,", indent, SHELL_AUTH);
  printf("%s%s%s%s\r\n", indent, "-A,", indent, SHELL_GEN_AUTH);
  printf("%s%s%s%s\r\n", indent, "-B,", indent, SHELL_BI_MODE);
  printf("%s%s%s%s\r\n", indent, "-c,", indent, SHELL_CFG_DIR);
  printf("%s%s%s%s\r\n", indent, "-C,", indent, SHELL_DMP_CFG);
  printf("%s%s%s%s\r\n", indent, "-d,", indent, SHELL_DB);
  printf("%s%s%s%s\r\n", indent, "-f,", indent, SHELL_FILE);
  printf("%s%s%s%s\r\n", indent, "-h,", indent, SHELL_HOST);
  printf("%s%s%s%s\r\n", indent, "-k,", indent, SHELL_CHECK);
  printf("%s%s%s%s\r\n", indent, "-l,", indent, SHELL_PKT_LEN);
  printf("%s%s%s%s\r\n", indent, "-n,", indent, SHELL_NET_ROLE);
  printf("%s%s%s%s\r\n", indent, "-N,", indent, SHELL_PKT_NUM);
  printf("%s%s%s%s\r\n", indent, "-p,", indent, SHELL_PASSWORD);
  printf("%s%s%s%s\r\n", indent, "-P,", indent, SHELL_PORT);
  printf("%s%s%s%s\r\n", indent, "-r,", indent, SHELL_RAW_TIME);
  printf("%s%s%s%s\r\n", indent, "-s,", indent, SHELL_CMD);
  printf("%s%s%s%s\r\n", indent, "-t,", indent, SHELL_STARTUP);
  printf("%s%s%s%s\r\n", indent, "-u,", indent, SHELL_USER);
#ifdef WEBSOCKET
  printf("%s%s%s%s\r\n", indent, "-E,", indent, SHELL_DSN);
  printf("%s%s%s%s\r\n", indent, "-R,", indent, SHELL_REST);
  printf("%s%s%s%s\r\n", indent, "-T,", indent, SHELL_TIMEOUT);
#endif
  printf("%s%s%s%s\r\n", indent, "-w,", indent, SHELL_WIDTH);
  printf("%s%s%s%s\r\n", indent, "-V,", indent, SHELL_VERSION);
#ifdef CUS_EMAIL
  printf("\r\n\r\nReport bugs to %s.\r\n", CUS_EMAIL);
#else
  printf("\r\n\r\nReport bugs to %s.\r\n", "support@taosdata.com");
#endif
}

#ifdef LINUX
#include <argp.h>
#ifdef _ALPINE
#include <termios.h>
#else
#include <termio.h>
#endif

const char *argp_program_version = td_version;
#ifdef CUS_EMAIL
const char *argp_program_bug_address = CUS_EMAIL;
#else
const char *argp_program_bug_address = "support@taosdata.com";
#endif

static struct argp_option shellOptions[] = {
    {"host", 'h', "HOST", 0, SHELL_HOST},
    {"port", 'P', "PORT", 0, SHELL_PORT},
    {"user", 'u', "USER", 0, SHELL_USER},
    {0, 'p', 0, 0, SHELL_PASSWORD},
    {"auth", 'a', "AUTH", 0, SHELL_AUTH},
    {"generate-auth", 'A', 0, 0, SHELL_GEN_AUTH},
    {"config-dir", 'c', "DIR", 0, SHELL_CFG_DIR},
    {"dump-config", 'C', 0, 0, SHELL_DMP_CFG},
    {"commands", 's', "COMMANDS", 0, SHELL_CMD},
    {"raw-time", 'r', 0, 0, SHELL_RAW_TIME},
    {"file", 'f', "FILE", 0, SHELL_FILE},
    {"database", 'd', "DATABASE", 0, SHELL_DB},
    {"check", 'k', 0, 0, SHELL_CHECK},
    {"startup", 't', 0, 0, SHELL_STARTUP},
    {"display-width", 'w', "WIDTH", 0, SHELL_WIDTH},
    {"netrole", 'n', "NETROLE", 0, SHELL_NET_ROLE},
    {"pktlen", 'l', "PKTLEN", 0, SHELL_PKT_LEN},
#ifdef WEBSOCKET
    {"dsn", 'E', "DSN", 0, SHELL_DSN},
    {"restful", 'R', 0, 0, SHELL_REST},
    {"timeout", 'T', "SECONDS", 0, SHELL_TIMEOUT},
#endif
    {"pktnum", 'N', "PKTNUM", 0, SHELL_PKT_NUM},
    {"bimode", 'B', 0, 0, SHELL_BI_MODE},
    {0},
};

static error_t shellParseOpt(int32_t key, char *arg, struct argp_state *state) { return shellParseSingleOpt(key, arg); }

static struct argp shellArgp = {shellOptions, shellParseOpt, "", ""};

static void shellParseArgsUseArgp(int argc, char *argv[]) {
  argp_program_version = shell.info.programVersion;
  argp_parse(&shellArgp, argc, argv, 0, 0, &shell.args);
}

#endif

#ifndef ARGP_ERR_UNKNOWN
#define ARGP_ERR_UNKNOWN E2BIG
#endif

static int32_t shellParseSingleOpt(int32_t key, char *arg) {
  SShellArgs *pArgs = &shell.args;

  switch (key) {
    case 'h':
      pArgs->host = arg;
#ifdef WEBSOCKET
      pArgs->cloud = false;
#endif
      break;
    case 'P':
      pArgs->port = atoi(arg);
#ifdef WEBSOCKET
      pArgs->cloud = false;
#endif
      if (pArgs->port == 0) pArgs->port = -1;
      break;
    case 'u':
      pArgs->user = arg;
      break;
    case 'p':
      break;
    case 'a':
      pArgs->auth = arg;
      break;
    case 'A':
      pArgs->is_gen_auth = true;
      break;
    case 'B':
      pArgs->is_bi_mode = true;
      break;
    case 'c':
#ifdef WEBSOCKET
      pArgs->cloud = false;
#endif
      pArgs->cfgdir = arg;
      break;
    case 'C':
      pArgs->is_dump_config = true;
      break;
    case 's':
      pArgs->commands = arg;
      break;
    case 'r':
      pArgs->is_raw_time = true;
      break;
    case 'f':
      tstrncpy(pArgs->file, arg, sizeof(pArgs->file));
      break;
    case 'd':
      pArgs->database = arg;
      break;
    case 'k':
      pArgs->is_check = true;
      break;
    case 't':
      pArgs->is_startup = true;
      break;
    case 'w':
      pArgs->displayWidth = atoi(arg);
      break;
    case 'n':
      pArgs->netrole = arg;
      break;
    case 'l':
      pArgs->pktLen = atoi(arg);
      break;
    case 'N':
      pArgs->pktNum = atoi(arg);
      break;
#ifdef WEBSOCKET
    case 'R':
      pArgs->restful = true;
      break;
    case 'E':
      pArgs->dsn = arg;
      pArgs->cloud = true;
      break;
    case 'T':
      pArgs->timeout = atoi(arg);
      break;
#endif
    case 'V':
      pArgs->is_version = true;
      break;
    case '?':
      pArgs->is_help = true;
      break;
    case 1:
      pArgs->abort = 1;
      break;
    default:
      return ARGP_ERR_UNKNOWN;
  }
  return 0;
}
#if defined(_TD_WINDOWS_64) || defined(_TD_WINDOWS_32) || defined(_TD_DARWIN_64)
int32_t shellParseArgsWithoutArgp(int argc, char *argv[]) {
  SShellArgs *pArgs = &shell.args;

  for (int i = 1; i < argc; i++) {
    if (strcmp(argv[i], "--help") == 0 || strcmp(argv[i], "--usage") == 0
            || strcmp(argv[i], "-?") == 0 || strcmp(argv[i], "/?") == 0) {
      shellParseSingleOpt('?', NULL);
      return 0;
    }

    char   *key = argv[i];
    int32_t keyLen = strlen(key);
    if (keyLen != 2) {
      fprintf(stderr, "invalid option %s\r\n", key);
      return -1;
    }
    if (key[0] != '-') {
      fprintf(stderr, "invalid option %s\r\n", key);
      return -1;
    }

    if (key[1] == 'h' || key[1] == 'P' || key[1] == 'u'
            || key[1] == 'a' || key[1] == 'c' || key[1] == 's'
            || key[1] == 'f' || key[1] == 'd' || key[1] == 'w'
            || key[1] == 'n' || key[1] == 'l' || key[1] == 'N'
#ifdef WEBSOCKET
        || key[1] == 'E' || key[1] == 'T'
#endif
    ) {
      if (i + 1 >= argc) {
        fprintf(stderr, "option %s requires an argument\r\n", key);
        return -1;
      }
      char *val = argv[i + 1];
      if (val[0] == '-') {
        fprintf(stderr, "option %s requires an argument\r\n", key);
        return -1;
      }
      shellParseSingleOpt(key[1], val);
      i++;
    } else if (key[1] == 'p' || key[1] == 'A' || key[1] == 'C'
                || key[1] == 'r' || key[1] == 'k'
                || key[1] == 't' || key[1] == 'V'
                || key[1] == '?' || key[1] == 1
#ifdef WEBSOCKET
            ||key[1] == 'R'
#endif
    ) {
      shellParseSingleOpt(key[1], NULL);
    } else {
      fprintf(stderr, "invalid option %s\r\n", key);
      return -1;
    }
  }

  return 0;
}
#endif

static void shellInitArgs(int argc, char *argv[]) {
  for (int i = 1; i < argc; i++) {
    if (strncmp(argv[i], "-p", 2) == 0) {
      // printf(shell.info.clientVersion, taos_get_client_info());
      if (strlen(argv[i]) == 2) {
        printf("Enter password: ");
        taosSetConsoleEcho(false);
        if (scanf("%128s", shell.args.password) > 1) {
          fprintf(stderr, "password reading error\n");
        }
        taosSetConsoleEcho(true);
        if (EOF == getchar()) {
          fprintf(stderr, "getchar() return EOF\r\n");
        }
      } else {
        tstrncpy(shell.args.password, (char *)(argv[i] + 2), sizeof(shell.args.password));
        strcpy(argv[i], "-p");
      }
    }
  }
  if (strlen(shell.args.password) == 0) {
    tstrncpy(shell.args.password, TSDB_DEFAULT_PASS, sizeof(shell.args.password));
  }

  SShellArgs *pArgs = &shell.args;
  pArgs->user = TSDB_DEFAULT_USER;
  pArgs->pktLen = SHELL_DEF_PKG_LEN;
  pArgs->pktNum = SHELL_DEF_PKG_NUM;
  pArgs->displayWidth = SHELL_DEFAULT_MAX_BINARY_DISPLAY_WIDTH;
}

static int32_t shellCheckArgs() {
  SShellArgs *pArgs = &shell.args;
  if (pArgs->host != NULL && (strlen(pArgs->host) <= 0 || strlen(pArgs->host) > TSDB_FQDN_LEN)) {
    printf("Invalid host:%s\r\n", pArgs->host);
    return -1;
  }

  if (pArgs->user != NULL && (strlen(pArgs->user) <= 0 || strlen(pArgs->user) > TSDB_USER_LEN)) {
    printf("Invalid user:%s\r\n", pArgs->user);
    return -1;
  }

  if (pArgs->auth != NULL && (strlen(pArgs->auth) <= 0 || strlen(pArgs->auth) > TSDB_PASSWORD_LEN)) {
    printf("Invalid auth:%s\r\n", pArgs->auth);
    return -1;
  }

  if (pArgs->database != NULL && (strlen(pArgs->database) <= 0 || strlen(pArgs->database) > TSDB_DB_NAME_LEN)) {
    printf("Invalid database:%s\r\n", pArgs->database);
    return -1;
  }

  if (pArgs->file[0] != 0) {
    char fullname[PATH_MAX] = {0};
    if (taosExpandDir(pArgs->file, fullname, PATH_MAX) == 0) {
      tstrncpy(pArgs->file, fullname, PATH_MAX);
    }
  }

  if (pArgs->cfgdir != NULL) {
    if (strlen(pArgs->cfgdir) <= 0 || strlen(pArgs->cfgdir) >= PATH_MAX) {
      printf("Invalid cfgdir:%s\r\n", pArgs->cfgdir);
      return -1;
    } else {
      if (taosExpandDir(pArgs->cfgdir, configDir, PATH_MAX) != 0) {
        tstrncpy(configDir, pArgs->cfgdir, PATH_MAX);
      }
    }
  }

  if (pArgs->commands != NULL && (strlen(pArgs->commands) <= 0)) {
    printf("Invalid commands:%s\r\n", pArgs->commands);
    return -1;
  }

  if (pArgs->netrole != NULL && !(strcmp(pArgs->netrole, "client") == 0 || strcmp(pArgs->netrole, "server") == 0)) {
    printf("Invalid netrole:%s\r\n", pArgs->netrole);
    return -1;
  }

  if (/*pArgs->password != NULL && */ (strlen(pArgs->password) <= 0)) {
    printf("Invalid password\r\n");
    return -1;
  }

  if (pArgs->port < 0 || pArgs->port > 65535) {
    printf("Invalid port\r\n");
    return -1;
  }

  if (pArgs->pktLen < SHELL_MIN_PKG_LEN || pArgs->pktLen > SHELL_MAX_PKG_LEN) {
    printf("Invalid pktLen:%d, range:[%d, %d]\r\n", pArgs->pktLen, SHELL_MIN_PKG_LEN, SHELL_MAX_PKG_LEN);
    return -1;
  }

  if (pArgs->pktNum < SHELL_MIN_PKG_NUM || pArgs->pktNum > SHELL_MAX_PKG_NUM) {
    printf("Invalid pktNum:%d, range:[%d, %d]\r\n", pArgs->pktNum, SHELL_MIN_PKG_NUM, SHELL_MAX_PKG_NUM);
    return -1;
  }

  if (pArgs->displayWidth <= 0 || pArgs->displayWidth > 10 * 1024) {
    printf("Invalid displayWidth:%d, range:[1, 10 * 1024]\r\n", pArgs->displayWidth);
    return -1;
  }

  return 0;
}

int32_t shellParseArgs(int32_t argc, char *argv[]) {
  shellInitArgs(argc, argv);
  shell.info.clientVersion =
      "Welcome to the %s Command Line Interface, Client Version:%s\r\n"
      "Copyright (c) 2023 by %s, all rights reserved.\r\n\r\n";
#ifdef CUS_NAME
  strcpy(shell.info.cusName, CUS_NAME);
#else
  strcpy(shell.info.cusName, "TDengine");
#endif
  char promptContinueFormat[32] = {0};
#ifdef CUS_PROMPT
  sprintf(shell.info.promptHeader, "%s> ", CUS_PROMPT);
  sprintf(promptContinueFormat, "%%%zus> ", strlen(CUS_PROMPT));
#else
  sprintf(shell.info.promptHeader, "taos> ");
  sprintf(promptContinueFormat, "%%%zus> ", strlen("taos"));
#endif
  sprintf(shell.info.promptContinue, promptContinueFormat, " ");
  shell.info.promptSize = strlen(shell.info.promptHeader);
#ifdef TD_ENTERPRISE
  snprintf(shell.info.programVersion, sizeof(shell.info.programVersion),
           "%s\n%s version: %s compatible_version: %s\ngit: %s\ngitOfInternal: %s\nbuild: %s", TD_PRODUCT_NAME,
           CUS_PROMPT, td_version, td_compatible_version, td_gitinfo, td_gitinfoOfInternal, td_buildinfo);
#else
  snprintf(shell.info.programVersion, sizeof(shell.info.programVersion),
           "%s\n%s version: %s compatible_version: %s\ngit: %s\nbuild: %s", TD_PRODUCT_NAME, CUS_PROMPT, td_version,
           td_compatible_version, td_gitinfo, td_buildinfo);
#endif

#if defined(_TD_WINDOWS_64) || defined(_TD_WINDOWS_32)
  shell.info.osname = "Windows";
  snprintf(shell.history.file, TSDB_FILENAME_LEN, "C:/TDengine/%s", SHELL_HISTORY_FILE);
  if (shellParseArgsWithoutArgp(argc, argv) != 0) return -1;
#elif defined(_TD_DARWIN_64)
  shell.info.osname = "Darwin";
  snprintf(shell.history.file, TSDB_FILENAME_LEN, "%s/%s", getpwuid(getuid())->pw_dir, SHELL_HISTORY_FILE);
  if (shellParseArgsWithoutArgp(argc, argv) != 0) return -1;
#else
  shell.info.osname = "Linux";
  snprintf(shell.history.file, TSDB_FILENAME_LEN, "%s/%s", getenv("HOME"), SHELL_HISTORY_FILE);
  shellParseArgsUseArgp(argc, argv);
  // if (shellParseArgsWithoutArgp(argc, argv) != 0) return -1;
  if (shell.args.abort) {
    return -1;
  }
#endif

  return shellCheckArgs();
}

1	/*
2	* Copyright (c) 2019 TAOS Data, Inc. <jhtao@taosdata.com>
3	*
4	* This program is free software: you can use, redistribute, and/or modify
5	* it under the terms of the GNU Affero General Public License, version 3
6	* or later ("AGPL"), as published by the Free Software Foundation.
7	*
8	* This program is distributed in the hope that it will be useful, but WITHOUT
9	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10	* FITNESS FOR A PARTICULAR PURPOSE.
11	*
12	* You should have received a copy of the GNU Affero General Public License
13	* along with this program. If not, see <http://www.gnu.org/licenses/>.
14	*/
15
16	#ifdef _TD_DARWIN_64
17	#include <pwd.h>
18	#endif
19
20	#include "shellInt.h"
21	#include "version.h"
22
23	#if defined(CUS_NAME) \|\| defined(CUS_PROMPT) \|\| defined(CUS_EMAIL)
24	#include "cus_name.h"
25	#else
26	#ifndef CUS_PROMPT
27	#define CUS_PROMPT "taos"
28	#endif
29	#endif
30
31	#define TAOS_CONSOLE_PROMPT_CONTINUE " -> "
32
33	#define SHELL_HOST "The server FQDN to connect. The default host is localhost."
34	#define SHELL_PORT "The TCP/IP port number to use for the connection."
35	#define SHELL_USER "The user name to use when connecting to the server."
36	#define SHELL_PASSWORD "The password to use when connecting to the server."
37	#define SHELL_AUTH "The auth string to use when connecting to the server."
38	#define SHELL_GEN_AUTH "Generate auth string from password."
39	#define SHELL_CFG_DIR "Configuration directory."
40	#define SHELL_DMP_CFG "Dump configuration."
41	#define SHELL_CMD "Commands to run without enter the shell."
42	#define SHELL_RAW_TIME "Output time as uint64_t."
43	#define SHELL_FILE "Script to run without enter the shell."
44	#define SHELL_DB "Database to use when connecting to the server."
45	#define SHELL_CHECK "Check the service status."
46	#define SHELL_STARTUP "Check the details of the service status."
47	#define SHELL_WIDTH "Set the default binary display width, default is 30."
48	#define SHELL_NET_ROLE "Net role when network connectivity test, options: client\|server."
49	#define SHELL_PKT_LEN "Packet length used for net test, default is 1024 bytes."
50	#define SHELL_PKT_NUM "Packet numbers used for net test, default is 100."
51	#define SHELL_BI_MODE "Set BI mode"
52	#define SHELL_VERSION "Print program version."
53
54	#ifdef WEBSOCKET
55	#define SHELL_DSN "Use dsn to connect to the cloud server or to a remote server which provides WebSocket connection."
56	#define SHELL_REST "Use RESTful mode when connecting."
57	#define SHELL_TIMEOUT "Set the timeout for websocket query in seconds, default is 30."
58	#endif
59
60	static int32_t shellParseSingleOpt(int32_t key, char *arg);
61
62	void shellPrintHelp() {	×
63	char indent[] = " ";	×
64	printf("Usage: %s [OPTION...] \r\n\r\n", CUS_PROMPT);	×
65	printf("%s%s%s%s\r\n", indent, "-a,", indent, SHELL_AUTH);	×
66	printf("%s%s%s%s\r\n", indent, "-A,", indent, SHELL_GEN_AUTH);	×
67	printf("%s%s%s%s\r\n", indent, "-B,", indent, SHELL_BI_MODE);	×
68	printf("%s%s%s%s\r\n", indent, "-c,", indent, SHELL_CFG_DIR);	×
69	printf("%s%s%s%s\r\n", indent, "-C,", indent, SHELL_DMP_CFG);	×
70	printf("%s%s%s%s\r\n", indent, "-d,", indent, SHELL_DB);	×
71	printf("%s%s%s%s\r\n", indent, "-f,", indent, SHELL_FILE);	×
72	printf("%s%s%s%s\r\n", indent, "-h,", indent, SHELL_HOST);	×
73	printf("%s%s%s%s\r\n", indent, "-k,", indent, SHELL_CHECK);	×
74	printf("%s%s%s%s\r\n", indent, "-l,", indent, SHELL_PKT_LEN);	×
75	printf("%s%s%s%s\r\n", indent, "-n,", indent, SHELL_NET_ROLE);	×
76	printf("%s%s%s%s\r\n", indent, "-N,", indent, SHELL_PKT_NUM);	×
77	printf("%s%s%s%s\r\n", indent, "-p,", indent, SHELL_PASSWORD);	×
78	printf("%s%s%s%s\r\n", indent, "-P,", indent, SHELL_PORT);	×
79	printf("%s%s%s%s\r\n", indent, "-r,", indent, SHELL_RAW_TIME);	×
80	printf("%s%s%s%s\r\n", indent, "-s,", indent, SHELL_CMD);	×
81	printf("%s%s%s%s\r\n", indent, "-t,", indent, SHELL_STARTUP);	×
82	printf("%s%s%s%s\r\n", indent, "-u,", indent, SHELL_USER);	×
83	#ifdef WEBSOCKET
84	printf("%s%s%s%s\r\n", indent, "-E,", indent, SHELL_DSN);
85	printf("%s%s%s%s\r\n", indent, "-R,", indent, SHELL_REST);
86	printf("%s%s%s%s\r\n", indent, "-T,", indent, SHELL_TIMEOUT);
87	#endif
88	printf("%s%s%s%s\r\n", indent, "-w,", indent, SHELL_WIDTH);	×
89	printf("%s%s%s%s\r\n", indent, "-V,", indent, SHELL_VERSION);	×
90	#ifdef CUS_EMAIL
91	printf("\r\n\r\nReport bugs to %s.\r\n", CUS_EMAIL);
92	#else
93	printf("\r\n\r\nReport bugs to %s.\r\n", "support@taosdata.com");	×
94	#endif
95	}	×
96
97	#ifdef LINUX
98	#include <argp.h>
99	#ifdef _ALPINE
100	#include <termios.h>
101	#else
102	#include <termio.h>
103	#endif
104
105	const char *argp_program_version = td_version;
106	#ifdef CUS_EMAIL
107	const char *argp_program_bug_address = CUS_EMAIL;
108	#else
109	const char *argp_program_bug_address = "support@taosdata.com";
110	#endif
111
112	static struct argp_option shellOptions[] = {
113	{"host", 'h', "HOST", 0, SHELL_HOST},
114	{"port", 'P', "PORT", 0, SHELL_PORT},
115	{"user", 'u', "USER", 0, SHELL_USER},
116	{0, 'p', 0, 0, SHELL_PASSWORD},
117	{"auth", 'a', "AUTH", 0, SHELL_AUTH},
118	{"generate-auth", 'A', 0, 0, SHELL_GEN_AUTH},
119	{"config-dir", 'c', "DIR", 0, SHELL_CFG_DIR},
120	{"dump-config", 'C', 0, 0, SHELL_DMP_CFG},
121	{"commands", 's', "COMMANDS", 0, SHELL_CMD},
122	{"raw-time", 'r', 0, 0, SHELL_RAW_TIME},
123	{"file", 'f', "FILE", 0, SHELL_FILE},
124	{"database", 'd', "DATABASE", 0, SHELL_DB},
125	{"check", 'k', 0, 0, SHELL_CHECK},
126	{"startup", 't', 0, 0, SHELL_STARTUP},
127	{"display-width", 'w', "WIDTH", 0, SHELL_WIDTH},
128	{"netrole", 'n', "NETROLE", 0, SHELL_NET_ROLE},
129	{"pktlen", 'l', "PKTLEN", 0, SHELL_PKT_LEN},
130	#ifdef WEBSOCKET
131	{"dsn", 'E', "DSN", 0, SHELL_DSN},
132	{"restful", 'R', 0, 0, SHELL_REST},
133	{"timeout", 'T', "SECONDS", 0, SHELL_TIMEOUT},
134	#endif
135	{"pktnum", 'N', "PKTNUM", 0, SHELL_PKT_NUM},
136	{"bimode", 'B', 0, 0, SHELL_BI_MODE},
137	{0},
138	};
139
140	static error_t shellParseOpt(int32_t key, char arg, struct argp_state state) { return shellParseSingleOpt(key, arg); }	4,616✔
141
142	static struct argp shellArgp = {shellOptions, shellParseOpt, "", ""};
143
144	static void shellParseArgsUseArgp(int argc, char *argv[]) {	717✔
145	argp_program_version = shell.info.programVersion;	717✔
146	argp_parse(&shellArgp, argc, argv, 0, 0, &shell.args);	717✔
147	}	707✔
148
149	#endif
150
151	#ifndef ARGP_ERR_UNKNOWN
152	#define ARGP_ERR_UNKNOWN E2BIG
153	#endif
154
155	static int32_t shellParseSingleOpt(int32_t key, char *arg) {	4,616✔
156	SShellArgs *pArgs = &shell.args;	4,616✔
157
158	switch (key) {	4,616!
159	case 'h':	259✔
160	pArgs->host = arg;	259✔
161	#ifdef WEBSOCKET
162	pArgs->cloud = false;
163	#endif
164	break;	259✔
165	case 'P':	57✔
166	pArgs->port = atoi(arg);	57✔
167	#ifdef WEBSOCKET
168	pArgs->cloud = false;
169	#endif
170	if (pArgs->port == 0) pArgs->port = -1;	57✔
171	break;	57✔
172	case 'u':	4✔
173	pArgs->user = arg;	4✔
174	break;	4✔
175	case 'p':	3✔
176	break;	3✔
177	case 'a':	2✔
178	pArgs->auth = arg;	2✔
179	break;	2✔
180	case 'A':	1✔
181	pArgs->is_gen_auth = true;	1✔
182	break;	1✔
183	case 'B':	×
184	pArgs->is_bi_mode = true;	×
185	break;	×
186	case 'c':	53✔
187	#ifdef WEBSOCKET
188	pArgs->cloud = false;
189	#endif
190	pArgs->cfgdir = arg;	53✔
191	break;	53✔
192	case 'C':	×
193	pArgs->is_dump_config = true;	×
194	break;	×
195	case 's':	458✔
196	pArgs->commands = arg;	458✔
197	break;	458✔
198	case 'r':	×
199	pArgs->is_raw_time = true;	×
200	break;	×
201	case 'f':	228✔
202	tstrncpy(pArgs->file, arg, sizeof(pArgs->file));	228✔
203	break;	228✔
UNCOV 204	case 'd':	×
UNCOV 205	pArgs->database = arg;	×
UNCOV 206	break;	×
207	case 'k':	3✔
208	pArgs->is_check = true;	3✔
209	break;	3✔
210	case 't':	×
211	pArgs->is_startup = true;	×
212	break;	×
213	case 'w':	×
214	pArgs->displayWidth = atoi(arg);	×
215	break;	×
216	case 'n':	1✔
217	pArgs->netrole = arg;	1✔
218	break;	1✔
219	case 'l':	1✔
220	pArgs->pktLen = atoi(arg);	1✔
221	break;	1✔
222	case 'N':	1✔
223	pArgs->pktNum = atoi(arg);	1✔
224	break;	1✔
225	#ifdef WEBSOCKET
226	case 'R':
227	pArgs->restful = true;
228	break;
229	case 'E':
230	pArgs->dsn = arg;
231	pArgs->cloud = true;
232	break;
233	case 'T':
234	pArgs->timeout = atoi(arg);
235	break;
236	#endif
237	case 'V':	×
238	pArgs->is_version = true;	×
239	break;	×
240	case '?':	×
241	pArgs->is_help = true;	×
242	break;	×
243	case 1:	×
244	pArgs->abort = 1;	×
245	break;	×
246	default:	3,545✔
247	return ARGP_ERR_UNKNOWN;	3,545✔
248	}
249	return 0;	1,071✔
250	}
251	#if defined(_TD_WINDOWS_64) \|\| defined(_TD_WINDOWS_32) \|\| defined(_TD_DARWIN_64)
252	int32_t shellParseArgsWithoutArgp(int argc, char *argv[]) {
253	SShellArgs *pArgs = &shell.args;
254
255	for (int i = 1; i < argc; i++) {
256	if (strcmp(argv[i], "--help") == 0 \|\| strcmp(argv[i], "--usage") == 0
257	\|\| strcmp(argv[i], "-?") == 0 \|\| strcmp(argv[i], "/?") == 0) {
258	shellParseSingleOpt('?', NULL);
259	return 0;
260	}
261
262	char *key = argv[i];
263	int32_t keyLen = strlen(key);
264	if (keyLen != 2) {
265	fprintf(stderr, "invalid option %s\r\n", key);
266	return -1;
267	}
268	if (key[0] != '-') {
269	fprintf(stderr, "invalid option %s\r\n", key);
270	return -1;
271	}
272
273	if (key[1] == 'h' \|\| key[1] == 'P' \|\| key[1] == 'u'
274	\|\| key[1] == 'a' \|\| key[1] == 'c' \|\| key[1] == 's'
275	\|\| key[1] == 'f' \|\| key[1] == 'd' \|\| key[1] == 'w'
276	\|\| key[1] == 'n' \|\| key[1] == 'l' \|\| key[1] == 'N'
277	#ifdef WEBSOCKET
278	\|\| key[1] == 'E' \|\| key[1] == 'T'
279	#endif
280	) {
281	if (i + 1 >= argc) {
282	fprintf(stderr, "option %s requires an argument\r\n", key);
283	return -1;
284	}
285	char *val = argv[i + 1];
286	if (val[0] == '-') {
287	fprintf(stderr, "option %s requires an argument\r\n", key);
288	return -1;
289	}
290	shellParseSingleOpt(key[1], val);
291	i++;
292	} else if (key[1] == 'p' \|\| key[1] == 'A' \|\| key[1] == 'C'
293	\|\| key[1] == 'r' \|\| key[1] == 'k'
294	\|\| key[1] == 't' \|\| key[1] == 'V'
295	\|\| key[1] == '?' \|\| key[1] == 1
296	#ifdef WEBSOCKET
297	\|\|key[1] == 'R'
298	#endif
299	) {
300	shellParseSingleOpt(key[1], NULL);
301	} else {
302	fprintf(stderr, "invalid option %s\r\n", key);
303	return -1;
304	}
305	}
306
307	return 0;
308	}
309	#endif
310
311	static void shellInitArgs(int argc, char *argv[]) {	717✔
312	for (int i = 1; i < argc; i++) {	2,855✔
313	if (strncmp(argv[i], "-p", 2) == 0) {	2,138✔
314	// printf(shell.info.clientVersion, taos_get_client_info());
315	if (strlen(argv[i]) == 2) {	3!
316	printf("Enter password: ");	×
317	taosSetConsoleEcho(false);	×
318	if (scanf("%128s", shell.args.password) > 1) {	×
319	fprintf(stderr, "password reading error\n");	×
320	}
321	taosSetConsoleEcho(true);	×
322	if (EOF == getchar()) {	×
323	fprintf(stderr, "getchar() return EOF\r\n");	×
324	}
325	} else {
326	tstrncpy(shell.args.password, (char *)(argv[i] + 2), sizeof(shell.args.password));	3✔
327	strcpy(argv[i], "-p");	3✔
328	}
329	}
330	}
331	if (strlen(shell.args.password) == 0) {	717✔
332	tstrncpy(shell.args.password, TSDB_DEFAULT_PASS, sizeof(shell.args.password));	714✔
333	}
334
335	SShellArgs *pArgs = &shell.args;	717✔
336	pArgs->user = TSDB_DEFAULT_USER;	717✔
337	pArgs->pktLen = SHELL_DEF_PKG_LEN;	717✔
338	pArgs->pktNum = SHELL_DEF_PKG_NUM;	717✔
339	pArgs->displayWidth = SHELL_DEFAULT_MAX_BINARY_DISPLAY_WIDTH;	717✔
340	}	717✔
341
342	static int32_t shellCheckArgs() {	707✔
343	SShellArgs *pArgs = &shell.args;	707✔
344	if (pArgs->host != NULL && (strlen(pArgs->host) <= 0 \|\| strlen(pArgs->host) > TSDB_FQDN_LEN)) {	707!
345	printf("Invalid host:%s\r\n", pArgs->host);	×
346	return -1;	×
347	}
348
349	if (pArgs->user != NULL && (strlen(pArgs->user) <= 0 \|\| strlen(pArgs->user) > TSDB_USER_LEN)) {	707!
350	printf("Invalid user:%s\r\n", pArgs->user);	×
351	return -1;	×
352	}
353
354	if (pArgs->auth != NULL && (strlen(pArgs->auth) <= 0 \|\| strlen(pArgs->auth) > TSDB_PASSWORD_LEN)) {	707!
355	printf("Invalid auth:%s\r\n", pArgs->auth);	×
356	return -1;	×
357	}
358
359	if (pArgs->database != NULL && (strlen(pArgs->database) <= 0 \|\| strlen(pArgs->database) > TSDB_DB_NAME_LEN)) {	707!
360	printf("Invalid database:%s\r\n", pArgs->database);	×
361	return -1;	×
362	}
363
364	if (pArgs->file[0] != 0) {	707✔
365	char fullname[PATH_MAX] = {0};	228✔
366	if (taosExpandDir(pArgs->file, fullname, PATH_MAX) == 0) {	228!
367	tstrncpy(pArgs->file, fullname, PATH_MAX);	228✔
368	}
369	}
370
371	if (pArgs->cfgdir != NULL) {	707✔
372	if (strlen(pArgs->cfgdir) <= 0 \|\| strlen(pArgs->cfgdir) >= PATH_MAX) {	53!
373	printf("Invalid cfgdir:%s\r\n", pArgs->cfgdir);	×
374	return -1;	×
375	} else {
376	if (taosExpandDir(pArgs->cfgdir, configDir, PATH_MAX) != 0) {	53!
377	tstrncpy(configDir, pArgs->cfgdir, PATH_MAX);	×
378	}
379	}
380	}
381
382	if (pArgs->commands != NULL && (strlen(pArgs->commands) <= 0)) {	707!
383	printf("Invalid commands:%s\r\n", pArgs->commands);	×
384	return -1;	×
385	}
386
387	if (pArgs->netrole != NULL && !(strcmp(pArgs->netrole, "client") == 0 \|\| strcmp(pArgs->netrole, "server") == 0)) {	707!
388	printf("Invalid netrole:%s\r\n", pArgs->netrole);	×
389	return -1;	×
390	}
391
392	if (/pArgs->password != NULL && / (strlen(pArgs->password) <= 0)) {	707!
393	printf("Invalid password\r\n");	×
394	return -1;	×
395	}
396
397	if (pArgs->port < 0 \|\| pArgs->port > 65535) {	707!
398	printf("Invalid port\r\n");	2✔
399	return -1;	2✔
400	}
401
402	if (pArgs->pktLen < SHELL_MIN_PKG_LEN \|\| pArgs->pktLen > SHELL_MAX_PKG_LEN) {	705!
403	printf("Invalid pktLen:%d, range:[%d, %d]\r\n", pArgs->pktLen, SHELL_MIN_PKG_LEN, SHELL_MAX_PKG_LEN);	×
404	return -1;	×
405	}
406
407	if (pArgs->pktNum < SHELL_MIN_PKG_NUM \|\| pArgs->pktNum > SHELL_MAX_PKG_NUM) {	705!
408	printf("Invalid pktNum:%d, range:[%d, %d]\r\n", pArgs->pktNum, SHELL_MIN_PKG_NUM, SHELL_MAX_PKG_NUM);	×
409	return -1;	×
410	}
411
412	if (pArgs->displayWidth <= 0 \|\| pArgs->displayWidth > 10 * 1024) {	705!
413	printf("Invalid displayWidth:%d, range:[1, 10 * 1024]\r\n", pArgs->displayWidth);	×
414	return -1;	×
415	}
416
417	return 0;	705✔
418	}
419
420	int32_t shellParseArgs(int32_t argc, char *argv[]) {	717✔
421	shellInitArgs(argc, argv);	717✔
422	shell.info.clientVersion =	717✔
423	"Welcome to the %s Command Line Interface, Client Version:%s\r\n"
424	"Copyright (c) 2023 by %s, all rights reserved.\r\n\r\n";
425	#ifdef CUS_NAME
426	strcpy(shell.info.cusName, CUS_NAME);
427	#else
428	strcpy(shell.info.cusName, "TDengine");	717✔
429	#endif
430	char promptContinueFormat[32] = {0};	717✔
431	#ifdef CUS_PROMPT
432	sprintf(shell.info.promptHeader, "%s> ", CUS_PROMPT);	717✔
433	sprintf(promptContinueFormat, "%%%zus> ", strlen(CUS_PROMPT));	717✔
434	#else
435	sprintf(shell.info.promptHeader, "taos> ");
436	sprintf(promptContinueFormat, "%%%zus> ", strlen("taos"));
437	#endif
438	sprintf(shell.info.promptContinue, promptContinueFormat, " ");	717✔
439	shell.info.promptSize = strlen(shell.info.promptHeader);	717✔
440	#ifdef TD_ENTERPRISE
441	snprintf(shell.info.programVersion, sizeof(shell.info.programVersion),	717✔
442	"%s\n%s version: %s compatible_version: %s\ngit: %s\ngitOfInternal: %s\nbuild: %s", TD_PRODUCT_NAME,
443	CUS_PROMPT, td_version, td_compatible_version, td_gitinfo, td_gitinfoOfInternal, td_buildinfo);
444	#else
445	snprintf(shell.info.programVersion, sizeof(shell.info.programVersion),
446	"%s\n%s version: %s compatible_version: %s\ngit: %s\nbuild: %s", TD_PRODUCT_NAME, CUS_PROMPT, td_version,
447	td_compatible_version, td_gitinfo, td_buildinfo);
448	#endif
449
450	#if defined(_TD_WINDOWS_64) \|\| defined(_TD_WINDOWS_32)
451	shell.info.osname = "Windows";
452	snprintf(shell.history.file, TSDB_FILENAME_LEN, "C:/TDengine/%s", SHELL_HISTORY_FILE);
453	if (shellParseArgsWithoutArgp(argc, argv) != 0) return -1;
454	#elif defined(_TD_DARWIN_64)
455	shell.info.osname = "Darwin";
456	snprintf(shell.history.file, TSDB_FILENAME_LEN, "%s/%s", getpwuid(getuid())->pw_dir, SHELL_HISTORY_FILE);
457	if (shellParseArgsWithoutArgp(argc, argv) != 0) return -1;
458	#else
459	shell.info.osname = "Linux";	717✔
460	snprintf(shell.history.file, TSDB_FILENAME_LEN, "%s/%s", getenv("HOME"), SHELL_HISTORY_FILE);	717✔
461	shellParseArgsUseArgp(argc, argv);	717✔
462	// if (shellParseArgsWithoutArgp(argc, argv) != 0) return -1;
463	if (shell.args.abort) {	707!
464	return -1;	×
465	}
466	#endif
467
468	return shellCheckArgs();	707✔
469	}

taosdata / TDengine / #3523

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous