TestClientCmdLine.c

#include <freerdp/client.h>
#include <freerdp/client/cmdline.h>
#include <freerdp/settings.h>
#include <winpr/cmdline.h>
#include <winpr/spec.h>
#include <winpr/strlst.h>
#include <winpr/collections.h>
 
typedef BOOL (*validate_settings_pr)(rdpSettings* settings);
 
#define printref() printf("%s:%d: in function %-40s:", __FILE__, __LINE__, __func__)
 
#define TEST_ERROR(format, ...)                       \
  do                                                \
  {                                                 \
    (void)fprintf(stderr, format, ##__VA_ARGS__); \
    printref();                                   \
    (void)printf(format, ##__VA_ARGS__);          \
    (void)fflush(stdout);                         \
  } while (0)
 
#define TEST_FAILURE(format, ...)            \
  do                                       \
  {                                        \
    printref();                          \
    (void)printf(" FAILURE ");           \
    (void)printf(format, ##__VA_ARGS__); \
    (void)fflush(stdout);                \
  } while (0)
 
static void print_test_title(int argc, char** argv)
{
  printf("Running test:");
 
  for (int i = 0; i < argc; i++)
  {
    printf(" %s", argv[i]);
  }
 
  printf("\n");
}
 
static INLINE BOOL testcase(const char* name, char** argv, size_t argc, int expected_return,
                            validate_settings_pr validate_settings)
{
  int status = 0;
  BOOL valid_settings = TRUE;
  rdpSettings* settings = freerdp_settings_new(0);
 
  WINPR_ASSERT(argc <= INT_MAX);
 
  print_test_title((int)argc, argv);
 
  if (!settings)
  {
    TEST_ERROR("Test %s could not allocate settings!\n", name);
    return FALSE;
  }
 
  status = freerdp_client_settings_parse_command_line(settings, (int)argc, argv, FALSE);
 
  if (validate_settings)
  {
    valid_settings = validate_settings(settings);
  }
 
  freerdp_settings_free(settings);
 
  if (status == expected_return)
  {
    if (!valid_settings)
    {
      return FALSE;
    }
  }
  else
  {
    TEST_FAILURE("Expected status %d,  got status %d\n", expected_return, status);
    return FALSE;
  }
 
  return TRUE;
}
 
#if defined(_WIN32)
#define DRIVE_REDIRECT_PATH "c:\\Windows"
#else
#define DRIVE_REDIRECT_PATH "/tmp"
#endif
 
static BOOL check_settings_smartcard_no_redirection(rdpSettings* settings)
{
  BOOL result = TRUE;
 
  if (freerdp_settings_get_bool(settings, FreeRDP_RedirectSmartCards))
  {
    TEST_FAILURE("Expected RedirectSmartCards = FALSE,  but RedirectSmartCards = TRUE!\n");
    result = FALSE;
  }
 
  if (freerdp_device_collection_find_type(settings, RDPDR_DTYP_SMARTCARD))
  {
    TEST_FAILURE("Expected no SMARTCARD device, but found at least one!\n");
    result = FALSE;
  }
 
  return result;
}
 
typedef struct
{
  int expected_status;
  validate_settings_pr validate_settings;
  const char* command_line[128];
  struct
  {
    int index;
    const char* expected_value;
  } modified_arguments[8];
} test;
 
// NOLINTBEGIN(bugprone-suspicious-missing-comma)
static const test tests[] = {
  { COMMAND_LINE_STATUS_PRINT_HELP,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "--help", 0 },
    { { 0 } } },
  { COMMAND_LINE_STATUS_PRINT_HELP,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "/help", 0 },
    { { 0 } } },
  { COMMAND_LINE_STATUS_PRINT_HELP,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "-help", 0 },
    { { 0 } } },
  { COMMAND_LINE_STATUS_PRINT_VERSION,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "--version", 0 },
    { { 0 } } },
  { COMMAND_LINE_STATUS_PRINT_VERSION,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "/version", 0 },
    { { 0 } } },
  { COMMAND_LINE_STATUS_PRINT_VERSION,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "-version", 0 },
    { { 0 } } },
  { 0,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "-v", "test.freerdp.com", 0 },
    { { 0 } } },
  { 0,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "--v", "test.freerdp.com", 0 },
    { { 0 } } },
  { 0,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "/v:test.freerdp.com", 0 },
    { { 0 } } },
  { 0,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "/sound", "/drive:media," DRIVE_REDIRECT_PATH, "/v:test.freerdp.com", 0 },
    { { 0 } } },
  { 0,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "-u", "test", "-p", "test", "-v", "test.freerdp.com", 0 },
    { { 4, "****" }, { 0 } } },
  { 0,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "/u:test", "/p:test", "/v:test.freerdp.com", 0 },
    { { 2, "/p:****" }, { 0 } } },
  { COMMAND_LINE_ERROR_NO_KEYWORD,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "-invalid", 0 },
    { { 0 } } },
  { COMMAND_LINE_ERROR_NO_KEYWORD,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "--invalid", 0 },
    { { 0 } } },
#if defined(WITH_FREERDP_DEPRECATED_CMDLINE)
  { COMMAND_LINE_STATUS_PRINT,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "/kbd-list", 0 },
    { { 0 } } },
  { COMMAND_LINE_STATUS_PRINT,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "/monitor-list", 0 },
    { { 0 } } },
#endif
  { COMMAND_LINE_STATUS_PRINT,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "/list:kbd", 0 },
    { { 0 } } },
  { COMMAND_LINE_STATUS_PRINT,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "/list:monitor", 0 },
    { { 0 } } },
  { 0,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "/sound", "/drive:media:" DRIVE_REDIRECT_PATH, "/v:test.freerdp.com", 0 },
    { { 0 } } },
  { 0,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "/sound", "/drive:media,/foo/bar/blabla", "/v:test.freerdp.com", 0 },
    { { 0 } } },
 
#if 0
  {
    COMMAND_LINE_STATUS_PRINT, check_settings_smartcard_no_redirection,
    {"testfreerdp", "-z", "--plugin", "cliprdr", "--plugin", "rdpsnd", "--data", "alsa", "latency:100", "--", "--plugin", "rdpdr", "--data", "disk:w7share:/home/w7share", "--", "--plugin", "drdynvc", "--data", "tsmf:decoder:gstreamer", "--", "-u", "test", "host.example.com", 0},
    {{0}}
  },
#endif
};
// NOLINTEND(bugprone-suspicious-missing-comma)
 
static void check_modified_arguments(const test* test, char** command_line, int* rc)
{
  const char* expected_argument = NULL;
 
  for (int k = 0; (expected_argument = test->modified_arguments[k].expected_value); k++)
  {
    int index = test->modified_arguments[k].index;
    char* actual_argument = command_line[index];
 
    if (0 != strcmp(actual_argument, expected_argument))
    {
      printref();
      printf("Failure: overridden argument %d is %s but it should be %s\n", index,
             actual_argument, expected_argument);
      (void)fflush(stdout);
      *rc = -1;
    }
  }
}
 
int TestClientCmdLine(int argc, char* argv[])
{
  int rc = 0;
 
  WINPR_UNUSED(argc);
  WINPR_UNUSED(argv);
  for (size_t i = 0; i < sizeof(tests) / sizeof(tests[0]); i++)
  {
    const test* current = &tests[i];
    int failure = 0;
    char** command_line = string_list_copy(current->command_line);
 
    if (!testcase(__func__, command_line, string_list_length((const char* const*)command_line),
                  current->expected_status, current->validate_settings))
    {
      TEST_FAILURE("parsing arguments.\n");
      failure = 1;
    }
 
    check_modified_arguments(current, command_line, &failure);
 
    if (failure)
    {
      string_list_print(stdout, (const char* const*)command_line);
      rc = -1;
    }
 
    string_list_free(command_line);
  }
 
  return rc;
}