TestClientCmdLine.c

#include <freerdp/config.h>
 
#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);
typedef void (*setup_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,
                            setup_settings_pr setup_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;
  }
 
  if (setup_settings)
    setup_settings(settings);
 
  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_gateway_response_timeout(rdpSettings* settings, UINT32 expected)
{
  const UINT32 val = freerdp_settings_get_uint32(settings, FreeRDP_GatewayResponseTimeout);
 
  if (val != expected)
  {
    TEST_FAILURE("Expected GatewayResponseTimeout = %" PRIu32 ", but got %" PRIu32 "!\n",
                 expected, val);
    return FALSE;
  }
 
  return TRUE;
}
 
static BOOL check_settings_gateway_response_timeout_default(rdpSettings* settings)
{
  return check_settings_gateway_response_timeout(settings, 15000);
}
 
static BOOL check_settings_gateway_response_timeout_custom(rdpSettings* settings)
{
  return check_settings_gateway_response_timeout(settings, 120000);
}
 
static const char test_aad_user_agent[] = "TestAgent/1.0 (KHTML, like Gecko)";
 
static BOOL check_settings_aad_user_agent(rdpSettings* settings)
{
  const char* ua = freerdp_settings_get_string(settings, FreeRDP_AadAuthUserAgent);
  if (!ua || (strcmp(ua, test_aad_user_agent) != 0))
  {
    TEST_FAILURE("Expected AadAuthUserAgent = \"%s\", but got %s!\n", test_aad_user_agent,
                 ua ? ua : "(null)");
    return FALSE;
  }
  return TRUE;
}
 
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;
}
 
#ifndef TEST_SOURCE_DIR
#error "TEST_SOURCE_DIR must be defined to the test source directory"
#endif
#define DISABLED_DISPLAY_OPTIONS_RDP TEST_SOURCE_DIR "/rdp-cmdline/disabled-display-options.rdp"
 
static BOOL check_settings_multimon_disabled(rdpSettings* settings)
{
  BOOL result = TRUE;
 
  if (freerdp_settings_get_bool(settings, FreeRDP_UseMultimon))
  {
    TEST_FAILURE("Expected UseMultimon = FALSE, but UseMultimon = TRUE!\n");
    result = FALSE;
  }
 
  if (freerdp_settings_get_bool(settings, FreeRDP_ForceMultimon))
  {
    TEST_FAILURE("Expected ForceMultimon = FALSE, but ForceMultimon = TRUE!\n");
    result = FALSE;
  }
 
  if (!freerdp_settings_get_bool(settings, FreeRDP_SmartSizing))
  {
    TEST_FAILURE("Expected SmartSizing = TRUE, but SmartSizing = FALSE!\n");
    result = FALSE;
  }
 
  return result;
}
 
static BOOL check_settings_smart_sizing_disabled(rdpSettings* settings)
{
  BOOL result = TRUE;
 
  if (freerdp_settings_get_bool(settings, FreeRDP_SmartSizing))
  {
    TEST_FAILURE("Expected SmartSizing = FALSE, but SmartSizing = TRUE!\n");
    result = FALSE;
  }
 
  if (!freerdp_settings_get_bool(settings, FreeRDP_DynamicResolutionUpdate))
  {
    TEST_FAILURE(
        "Expected DynamicResolutionUpdate = TRUE, but DynamicResolutionUpdate = FALSE!\n");
    result = FALSE;
  }
 
  if (!freerdp_settings_get_bool(settings, FreeRDP_UseMultimon))
  {
    TEST_FAILURE("Expected UseMultimon = TRUE, but UseMultimon = FALSE!\n");
    result = FALSE;
  }
 
  return result;
}
 
static BOOL check_settings_multimon_enabled(rdpSettings* settings)
{
  BOOL result = TRUE;
 
  if (!freerdp_settings_get_bool(settings, FreeRDP_UseMultimon))
  {
    TEST_FAILURE("Expected UseMultimon = TRUE, but UseMultimon = FALSE!\n");
    result = FALSE;
  }
 
  return result;
}
 
static void setup_settings_multimon_force(rdpSettings* settings)
{
  (void)freerdp_settings_set_bool(settings, FreeRDP_ForceMultimon, TRUE);
}
 
static BOOL check_settings_multimon_force(rdpSettings* settings)
{
  BOOL result = TRUE;
 
  if (!freerdp_settings_get_bool(settings, FreeRDP_UseMultimon))
  {
    TEST_FAILURE("Expected UseMultimon = TRUE, but UseMultimon = FALSE!\n");
    result = FALSE;
  }
 
  if (!freerdp_settings_get_bool(settings, FreeRDP_ForceMultimon))
  {
    TEST_FAILURE("Expected ForceMultimon = TRUE, but ForceMultimon = FALSE!\n");
    result = FALSE;
  }
 
  return result;
}
 
static BOOL check_settings_smart_sizing_size(rdpSettings* settings)
{
  BOOL result = TRUE;
 
  if (!freerdp_settings_get_bool(settings, FreeRDP_SmartSizing))
  {
    TEST_FAILURE("Expected SmartSizing = TRUE, but SmartSizing = FALSE!\n");
    result = FALSE;
  }
 
  if (freerdp_settings_get_uint32(settings, FreeRDP_SmartSizingWidth) != 1024)
  {
    TEST_FAILURE("Expected SmartSizingWidth = 1024, but SmartSizingWidth = %u!\n",
                 (unsigned)freerdp_settings_get_uint32(settings, FreeRDP_SmartSizingWidth));
    result = FALSE;
  }
 
  if (freerdp_settings_get_uint32(settings, FreeRDP_SmartSizingHeight) != 768)
  {
    TEST_FAILURE("Expected SmartSizingHeight = 768, but SmartSizingHeight = %u!\n",
                 (unsigned)freerdp_settings_get_uint32(settings, FreeRDP_SmartSizingHeight));
    result = FALSE;
  }
 
  return result;
}
 
#if defined(WITH_GFX_AV1)
static BOOL check_settings_gfx_av1(rdpSettings* settings)
{
  BOOL result = TRUE;
 
  if (!freerdp_settings_get_bool(settings, FreeRDP_GfxCodecAV1))
  {
    TEST_FAILURE("Expected GfxCodecAV1 = TRUE, but GfxCodecAV1 = FALSE!\n");
    result = FALSE;
  }
 
  return result;
}
#endif
 
static BOOL check_settings_gfx_without_h264(rdpSettings* settings)
{
  BOOL result = TRUE;
 
  if (freerdp_settings_get_uint32(settings, FreeRDP_ConnectionType) != CONNECTION_TYPE_AUTODETECT)
  {
    TEST_FAILURE("Expected ConnectionType = AUTODETECT, but ConnectionType = %u!\n",
                 (unsigned)freerdp_settings_get_uint32(settings, FreeRDP_ConnectionType));
    result = FALSE;
  }
 
  if (freerdp_settings_get_bool(settings, FreeRDP_GfxH264) ||
      freerdp_settings_get_bool(settings, FreeRDP_GfxAVC444) ||
      freerdp_settings_get_bool(settings, FreeRDP_GfxAVC444v2))
  {
    TEST_FAILURE(
        "Expected the H.264 codecs off as /gfx asked, but /network:auto turned them on!\n");
    result = FALSE;
  }
 
  if (!freerdp_settings_get_bool(settings, FreeRDP_GfxProgressive))
  {
    TEST_FAILURE("Expected GfxProgressive = TRUE, but GfxProgressive = FALSE!\n");
    result = FALSE;
  }
 
  return result;
}
 
static BOOL check_settings_network_auto_h264(rdpSettings* settings)
{
  BOOL result = TRUE;
 
  if (!freerdp_settings_get_bool(settings, FreeRDP_GfxH264) ||
      !freerdp_settings_get_bool(settings, FreeRDP_GfxAVC444))
  {
    TEST_FAILURE("Expected /network:auto alone to turn the H.264 codecs on!\n");
    result = FALSE;
  }
 
  return result;
}
 
static BOOL check_settings_modem_with_fonts(rdpSettings* settings)
{
  BOOL result = TRUE;
 
  if (freerdp_settings_get_uint32(settings, FreeRDP_ConnectionType) != CONNECTION_TYPE_MODEM)
  {
    TEST_FAILURE("Expected ConnectionType = MODEM, but ConnectionType = %u!\n",
                 (unsigned)freerdp_settings_get_uint32(settings, FreeRDP_ConnectionType));
    result = FALSE;
  }
 
  if (!freerdp_settings_get_bool(settings, FreeRDP_AllowFontSmoothing))
  {
    TEST_FAILURE("Expected AllowFontSmoothing = TRUE as +fonts asked, but /network:modem "
                 "turned it off!\n");
    result = FALSE;
  }
 
  if (!freerdp_settings_get_bool(settings, FreeRDP_DisableWallpaper))
  {
    TEST_FAILURE("Expected DisableWallpaper = TRUE, the default of /network:modem!\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];
  setup_settings_pr setup_settings;
} test;
 
// NOLINTBEGIN(bugprone-suspicious-missing-comma)
static const test tests[] = {
  { COMMAND_LINE_STATUS_PRINT_HELP,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "--help", nullptr },
    { WINPR_C_ARRAY_INIT } },
  { COMMAND_LINE_STATUS_PRINT_HELP,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "/help", nullptr },
    { WINPR_C_ARRAY_INIT } },
  { COMMAND_LINE_STATUS_PRINT_HELP,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "-help", nullptr },
    { WINPR_C_ARRAY_INIT } },
  { COMMAND_LINE_STATUS_PRINT_VERSION,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "--version", nullptr },
    { WINPR_C_ARRAY_INIT } },
  { COMMAND_LINE_STATUS_PRINT_VERSION,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "/version", nullptr },
    { WINPR_C_ARRAY_INIT } },
  { COMMAND_LINE_STATUS_PRINT_VERSION,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "-version", nullptr },
    { WINPR_C_ARRAY_INIT } },
  { 0,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "-v", "test.freerdp.com", nullptr },
    { WINPR_C_ARRAY_INIT } },
  { 0,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "--v", "test.freerdp.com", nullptr },
    { WINPR_C_ARRAY_INIT } },
  { 0,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "/v:test.freerdp.com", nullptr },
    { WINPR_C_ARRAY_INIT } },
  { 0,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "/sound", "/drive:media," DRIVE_REDIRECT_PATH, "/v:test.freerdp.com",
      nullptr },
    { WINPR_C_ARRAY_INIT } },
  { 0,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "-u", "test", "-p", "test", "-v", "test.freerdp.com", nullptr },
    { { 4, "****" }, WINPR_C_ARRAY_INIT } },
  { 0,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "/u:test", "/p:test", "/v:test.freerdp.com", nullptr },
    { { 2, "/p:****" }, WINPR_C_ARRAY_INIT } },
  { COMMAND_LINE_ERROR_NO_KEYWORD,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "-invalid", nullptr },
    { WINPR_C_ARRAY_INIT } },
  { COMMAND_LINE_ERROR_NO_KEYWORD,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "--invalid", nullptr },
    { WINPR_C_ARRAY_INIT } },
#if defined(WITH_FREERDP_DEPRECATED_CMDLINE)
  { COMMAND_LINE_STATUS_PRINT,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "/kbd-list", 0 },
    { WINPR_C_ARRAY_INIT } },
  { COMMAND_LINE_STATUS_PRINT,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "/monitor-list", 0 },
    { WINPR_C_ARRAY_INIT } },
#endif
  { COMMAND_LINE_STATUS_PRINT,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "/list:kbd", nullptr },
    { WINPR_C_ARRAY_INIT } },
  { COMMAND_LINE_STATUS_PRINT,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "/list:monitor", nullptr },
    { WINPR_C_ARRAY_INIT } },
  { 0,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "/sound", "/drive:media:" DRIVE_REDIRECT_PATH, "/v:test.freerdp.com",
      nullptr },
    { WINPR_C_ARRAY_INIT } },
  { 0,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "/sound", "/drive:media,/foo/bar/blabla", "/v:test.freerdp.com", nullptr },
    { WINPR_C_ARRAY_INIT } },
  { 0,
    check_settings_gateway_response_timeout_default,
    { "testfreerdp", "/gateway:type:arm,g:gw.contoso.com", "/v:test.freerdp.com", nullptr },
    { WINPR_C_ARRAY_INIT } },
  { 0,
    check_settings_gateway_response_timeout_custom,
    { "testfreerdp", "/gateway:type:arm,g:gw.contoso.com,timeout:120000", "/v:test.freerdp.com",
      nullptr },
    { WINPR_C_ARRAY_INIT } },
  { 0,
    check_settings_gateway_response_timeout_custom,
    { "testfreerdp", "/gateway:type:http,g:gw.contoso.com,timeout:120000", "/v:test.freerdp.com",
      nullptr },
    { WINPR_C_ARRAY_INIT } },
  { COMMAND_LINE_ERROR,
    check_settings_gateway_response_timeout_default,
    { "testfreerdp", "/gateway:type:arm,g:gw.contoso.com,timeout:0", "/v:test.freerdp.com",
      nullptr },
    { WINPR_C_ARRAY_INIT } },
  { COMMAND_LINE_ERROR,
    check_settings_gateway_response_timeout_default,
    { "testfreerdp", "/gateway:type:arm,g:gw.contoso.com,timeout:abc", "/v:test.freerdp.com",
      nullptr },
    { WINPR_C_ARRAY_INIT } },
  { 0,
    check_settings_aad_user_agent,
    { "testfreerdp", "/azure:tenantid:common,\"user-agent:TestAgent/1.0 (KHTML, like Gecko)\"",
      "/v:test.freerdp.com", nullptr },
    { WINPR_C_ARRAY_INIT } },
  { 0,
    check_settings_multimon_disabled,
    { "testfreerdp", DISABLED_DISPLAY_OPTIONS_RDP, "/multimon:off", nullptr },
    { WINPR_C_ARRAY_INIT },
    setup_settings_multimon_force },
  { 0,
    check_settings_multimon_disabled,
    { "testfreerdp", DISABLED_DISPLAY_OPTIONS_RDP, "-multimon", nullptr },
    { WINPR_C_ARRAY_INIT },
    setup_settings_multimon_force },
  { 0,
    check_settings_smart_sizing_disabled,
    { "testfreerdp", DISABLED_DISPLAY_OPTIONS_RDP, "-smart-sizing", nullptr },
    { WINPR_C_ARRAY_INIT } },
  { 0,
    check_settings_smart_sizing_disabled,
    { "testfreerdp", DISABLED_DISPLAY_OPTIONS_RDP, "/smart-sizing:off", nullptr },
    { WINPR_C_ARRAY_INIT } },
  { 0,
    check_settings_multimon_force,
    { "testfreerdp", "--multimon", "force", nullptr },
    { WINPR_C_ARRAY_INIT } },
  { 0,
    check_settings_smart_sizing_size,
    { "testfreerdp", "--smart-sizing", "1024x768", nullptr },
    { WINPR_C_ARRAY_INIT } },
  { COMMAND_LINE_ERROR_UNEXPECTED_VALUE,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "/multimon:garbage", nullptr },
    { WINPR_C_ARRAY_INIT } },
  { COMMAND_LINE_ERROR_UNEXPECTED_VALUE,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "/smart-sizing:garbage", nullptr },
    { WINPR_C_ARRAY_INIT } },
  { COMMAND_LINE_ERROR_UNEXPECTED_VALUE,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "/multimon:", nullptr },
    { WINPR_C_ARRAY_INIT } },
  { COMMAND_LINE_ERROR_UNEXPECTED_VALUE,
    check_settings_smartcard_no_redirection,
    { "testfreerdp", "/smart-sizing:", nullptr },
    { WINPR_C_ARRAY_INIT } },
  { 0,
    check_settings_multimon_enabled,
    { "testfreerdp", "+multimon", nullptr },
    { WINPR_C_ARRAY_INIT } },
#if defined(WITH_GFX_H264)
  { 0,
    check_settings_gfx_without_h264,
    { "testfreerdp", "/gfx:progressive,AVC420:off,AVC444:off", "/network:auto",
      "/v:test.freerdp.com", nullptr },
    { WINPR_C_ARRAY_INIT } },
  { 0,
    check_settings_gfx_without_h264,
    { "testfreerdp", "/network:auto", "/gfx:progressive,AVC420:off,AVC444:off",
      "/v:test.freerdp.com", nullptr },
    { WINPR_C_ARRAY_INIT } },
  { 0,
    check_settings_network_auto_h264,
    { "testfreerdp", "/network:auto", "/v:test.freerdp.com", nullptr },
    { WINPR_C_ARRAY_INIT } },
#endif
#if defined(WITH_GFX_AV1)
  { 0,
    check_settings_gfx_av1,
    { "testfreerdp", "/gfx:AV1", "/v:test.freerdp.com", nullptr },
    { WINPR_C_ARRAY_INIT } },
  { 0,
    check_settings_gfx_av1,
    { "testfreerdp", "/gfx:AV1:on", "/v:test.freerdp.com", nullptr },
    { WINPR_C_ARRAY_INIT } },
#endif
  { 0,
    check_settings_modem_with_fonts,
    { "testfreerdp", "+fonts", "/network:modem", "/v:test.freerdp.com", nullptr },
    { WINPR_C_ARRAY_INIT } },
};
// NOLINTEND(bugprone-suspicious-missing-comma)
 
static void check_modified_arguments(const test* test, char** command_line, int* rc)
{
  const char* expected_argument = nullptr;
 
  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 < ARRAYSIZE(tests); i++)
  {
    const test* current = &tests[i];
    int failure = 0;
    char** command_line = string_list_copy(current->command_line);
 
    const int len = string_list_length((const char* const*)command_line);
    if (!testcase(__func__, command_line, WINPR_ASSERTING_INT_CAST(size_t, len),
                  current->expected_status, current->validate_settings,
                  current->setup_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;
}