pkg/sql/logictest: Test data containing multi-line values causes test to fail

[kyle-a-wong]

Describe the problem

In #91702, logic was added to formatValues to fix an issue where tab and new line characters were interfering with the tab writer output. This fix introduced an edge case where tabular data outputs containing new lines would fail equality checks erroneously.

As an example the following test data file,

statement ok
CREATE TABLE test_table (col1 string, col2 string, col3 string)

statement ok
INSERT INTO test_table (col1, col2, col3) VALUES ('r1c1', 'r1c2', 'r2c3'), ('r1c1', 'r1
nc2', 'r2c3'), ('r1c1', 'r1c2', 'r2c3');

query TTT
SELECT * FROM test_table
ORDER BY col1
----
r1c1  r1c2  r2c3
r1c1  r1    r2c3
      nc2
r1c1  r1c2  r2c3

Would fail with the following error:

    logic.go:2968: 
         
        ../../sql/logictest/testdata/testdata:8: SELECT * FROM test_table
        ORDER BY col1
        expected:
            r1c1  r1c2  r2c3
            r1c1  r1    r2c3
                  nc2
            r1c1  r1c2  r2c3
        but found (query options: "") :
            r1c1  r1c2  r2c3
            r1c1  r1    r2c3
                  nc2
            r1c1  r1c2  r2c3

The reason the test fails is because the data that is generated and written to the test data file is being formatted to neatly present multi-line data in a column. When this data is read into the test as the expected data, it doesn't know that it is a part of a multi-line column and generates an incorrect expected value.

This bug is manifesting itself in #127290 where the new system table is causing TestLogic_gen_test_objects/templates/fewer_tables_generated_than_templates to fail with the following:

/pkg/sql/logictest/testdata/logic_test/gen_test_objects:197: SELECT quote_ident(table_name), quote_ident(column_name), data_type FROM "".information_schema.columns
        WHERE table_catalog = 'newdb2' AND table_schema = 'public'
        ORDER BY table_name, column_name
        LIMIT 20
        expected:
            database_role_settings  database_id             oid
            database_role_settings  "ro'le_id"              oid
            database_role_settings  role_name               text
            database_role_settings  rowid                   bigint
            database_role_settings  settings                ARRAY
            "eventLog"              "\\xa7t̻%pimest̏am  p"  timestamp without time zone
            "eventLog"              "eventType"             text
            "eventLog"              info                    text
            "eventLog"              "reportingID"           bigint
            "eventLog"              rowid                   bigint
            "eventLog"              "targ%ve}tID"           bigint
            "eventLog"              "uniqueID"              bytea
            "j ob\\x97s"            "claim_instAnce_id"     bigint
            "j ob\\x97s"            "claim_session?_ id"    bytea
            "j ob\\x97s"            "create                 timestamp without time zone
                                    d"
            "j ob\\x97s"            created_by_id           bigint
            "j ob\\x97s"            created_by_type         text
            "j ob\\x97s"            "id.\\U000FA67C"        bigint
            "j ob\\x97s"            "j%qob_type "           text
            "j ob\\x97s"            l😲ast_ru😻n              timestamp without time zone
            
        but found (query options: "") :
            database_role_settings  database_id             oid
            database_role_settings  "ro'le_id"              oid
            database_role_settings  role_name               text
            database_role_settings  rowid                   bigint
            database_role_settings  settings                ARRAY
            "eventLog"              "\\xa7t̻%pimest̏am  p"  timestamp without time zone
            "eventLog"              "eventType"             text
            "eventLog"              info                    text
            "eventLog"              "reportingID"           bigint
            "eventLog"              rowid                   bigint
            "eventLog"              "targ%ve}tID"           bigint
            "eventLog"              "uniqueID"              bytea
            "j ob\\x97s"            "claim_instAnce_id"     bigint
            "j ob\\x97s"            "claim_session?_ id"    bytea
            "j ob\\x97s"            "create                 timestamp without time zone
                                    d"
            "j ob\\x97s"            created_by_id           bigint
            "j ob\\x97s"            created_by_type         text
            "j ob\\x97s"            "id.\\U000FA67C"        bigint
            "j ob\\x97s"            "j%qob_type "           text
            "j ob\\x97s"            l😲ast_ru😻n              timestamp without time zone

See the image below of some relevant expressions when running through a debugger:

Jira issue: CRDB-40596

[blathers-crl]

Hi @kyle-a-wong, please add branch-* labels to identify which branch(es) this C-bug affects.

_{🦉 Hoot! I am a Blathers, a bot for CockroachDB. My owner is dev-inf.}