Debug method

[Sicria]

Is there a recommended way of debugging during tests?

I found myself needing to debug something and ended up using the following to achieve what I needed.

SELECT
  row_eq (
    $$
    SELECT json_agg(json_build_object(
          'user_id', user_id,
          'account_id', account_id,
          'account_role', account_role
    ))::text FROM basejump.account_user WHERE account_id = 'd126ecef-35f6-4b5d-9f28-d9f00a9fb46f';
    $$,
    ROW (json_build_object('user_id', 'log')::text),
    'LOG'
  );

This fails a test and logs the contents of the table.

# Failed test 1: "LOG"
#         have: ("[{""user_id"" : ""2ea7443e-a7b8-45e9-87c1-b40cb7f1f37d"", ""account_id"" : ""d126ecef-35f6-4b5d-9f28-d9f00a9fb46f"", ""account_role"" : ""owner""}]")
#         want: ("{""user_id"" : ""log""}")

Is there a better way to log data in tests?

[probablykabari]

https://pgtap.org/documentation.html#diag

Best way to use this is to organize your test suites into functions and run them with the do_tap() function in pgTap. Here's an example of an actual test in an application I have. When I want to debug, I add diag statements to return next so they will show up in line with the test results.

create function test_message_creation_handling_for_orgs()
returns setof text
language plpgsql
as $$
declare
  v_message messages;
  v_aggs messages_agg;
  v_messageable messages_organizations;
begin
  perform tests.authenticate_as('org_member_test_org');

  v_message := create_message('test_message_creation_handling_for_organizations', null, null, 'organization', _get_org_id());

  select * into v_aggs
    from messages_agg
    where message_id = v_message.id
    limit 1;
  select * into v_messageable
    from messages_organizations
    where message_id = v_message.id limit 1;

  return next ok(
    not (v_message is null),
    'Message has been created'
  );

  return next ok(
    not (v_aggs is null),
    'Message aggregate has been created'
  );
  
   /**********************
   *. PRINTS DEBUG INFO
   ***********************/
  return next diag(jsonb_pretty(row_to_json(v_aggs)::jsonb));

  return next is(v_message.owner_id, tests.get_supabase_uid('org_member_test_org'), 'Message is assigned to current user');
  return next ok(v_messageable is not null, 'Message join record is created');
  return next is(v_aggs.content, v_message.content, 'Message content matches aggs');
end;
$$;