Add support for parsing PostgreSQL dollar-quoted strings

[dbsrgits/SQL-Translator.git] / t / 14postgres-parser.t

#!/usr/bin/perl
# vim: set ft=perl:

use strict;
use Test::More;
use SQL::Translator;
use SQL::Translator::Schema::Constants;
use Test::SQL::Translator qw(maybe_plan);

BEGIN {
    maybe_plan(undef, 'SQL::Translator::Parser::PostgreSQL');
    SQL::Translator::Parser::PostgreSQL->import('parse');
}

my $t   = SQL::Translator->new( trace => 0 );
my $sql = q{
    -- comment on t_test1
    create table t_test1 (
        -- this is the primary key
        f_serial serial NOT NULL default '0' primary key,
        f_varchar character varying (255),
        f_double double precision,
        f_bigint bigint not null,
        f_char character(10) default 'FOO'::character(10),
        f_bool boolean,
        f_bin bytea,
        f_tz timestamp default '1970-01-01 00:00:00'::TIMESTAMP,
        f_text text default $foo$ foo
$bar$
baz $foo$,
        f_fk1 integer not null references t_test2 (f_id),
        f_dropped text,
        f_timestamp timestamp(0) with time zone,
        f_timestamp2 timestamp without time zone,
        f_json json,
        f_hstore hstore,
        f_numarray numeric(7,2) [ ],
        f_uuid uuid,
        f_time time(0) with time zone,
        f_time2 time without time zone,
        f_text2 text default $$$$,
        f_text3 text default $$$ $$
    );

    create table t_test2 (
        f_id integer NOT NULL,
        f_varchar varchar(25),
        f_int smallint,
        f_smallint smallint default (0)::smallint,
        primary key (f_id),
        check (f_int between 1 and 5)
    );

    CREATE TABLE products_1 (
        product_no integer,
        name text,
        price numeric
    );

    CREATE TEMP TABLE products_2 (
        product_no integer,
        name text,
        price numeric
    );

    CREATE TEMPORARY TABLE products_3 (
        product_no integer,
        name text,
        price numeric
    );

  CREATE TRIGGER test_trigger
    BEFORE INSERT OR UPDATE OR DELETE
    ON products_1
    FOR EACH ROW
    EXECUTE PROCEDURE foo();

    CREATE INDEX test_index1 ON t_test1 (f_varchar);
    CREATE INDEX test_index2 ON t_test1 USING hash (f_char, f_bool);
    CREATE INDEX test_index3 ON t_test1 USING hash (f_bigint, f_tz) WHERE f_bigint = '1' AND f_tz IS NULL;

    alter table t_test1 add f_fk2 integer;

    alter table only t_test1 add constraint c_u1 unique (f_varchar);

    alter table t_test1 add constraint "c_fk2" foreign key (f_fk2)
    references t_test2 (f_id) match simple
    on update no action on delete cascade deferrable;


    alter table t_test1 drop column f_dropped restrict;

    alter table t_test1 alter column f_fk2 set default 'FOO';

    alter table t_test1 alter column f_char drop default;

    -- The following are allowed by the grammar
    -- but won\'t do anything... - ky

    alter table t_text1 alter column f_char set not null;

    alter table t_text1 alter column f_char drop not null;

    alter table t_test1 alter f_char set statistics 10;

    alter table t_test1 alter f_text set storage extended;

    alter table t_test1 rename column f_text to foo;

    alter table t_test1 rename to foo;

    alter table only t_test1 drop constraint foo cascade;

    alter table t_test1 owner to foo;

    commit;
};

$| = 1;

my $data   = parse( $t, $sql );
my $schema = $t->schema;

isa_ok( $schema, 'SQL::Translator::Schema', 'Schema object' );
my @tables = $schema->get_tables;
is( scalar @tables, 5, 'Five tables' );

my $t1 = shift @tables;
is( $t1->name, 't_test1', 'Table t_test1 exists' );

is( $t1->comments, 'comment on t_test1', 'Table comment exists' );

my @t1_fields = $t1->get_fields;
is( scalar @t1_fields, 21, '21 fields in t_test1' );

my $f1 = shift @t1_fields;
is( $f1->name, 'f_serial', 'First field is "f_serial"' );
is( $f1->data_type, 'integer', 'Field is an integer' );
is( $f1->is_nullable, 0, 'Field cannot be null' );
is( $f1->size, 11, 'Size is "11"' );
is( $f1->default_value, '0', 'Default value is "0"' );
is( $f1->is_primary_key, 1, 'Field is PK' );
is( $f1->comments, 'this is the primary key', 'Comment' );
is( $f1->is_auto_increment, 1, 'Field is auto increment' );

my $f2 = shift @t1_fields;
is( $f2->name, 'f_varchar', 'Second field is "f_varchar"' );
is( $f2->data_type, 'varchar', 'Field is a varchar' );
is( $f2->is_nullable, 1, 'Field can be null' );
is( $f2->size, 255, 'Size is "255"' );
is( $f2->default_value, undef, 'Default value is undefined' );
is( $f2->is_primary_key, 0, 'Field is not PK' );
is( $f2->is_auto_increment, 0, 'Field is not auto increment' );

my $f3 = shift @t1_fields;
is( $f3->name, 'f_double', 'Third field is "f_double"' );
is( $f3->data_type, 'float', 'Field is a float' );
is( $f3->is_nullable, 1, 'Field can be null' );
is( $f3->size, 20, 'Size is "20"' );
is( $f3->default_value, undef, 'Default value is undefined' );
is( $f3->is_primary_key, 0, 'Field is not PK' );

my $f4 = shift @t1_fields;
is( $f4->name, 'f_bigint', 'Fourth field is "f_bigint"' );
is( $f4->data_type, 'integer', 'Field is an integer' );
is( $f4->is_nullable, 0, 'Field cannot be null' );
is( $f4->size, 20, 'Size is "20"' );
is( $f4->default_value, undef, 'Default value is undefined' );
is( $f4->is_primary_key, 0, 'Field is not PK' );

my $f5 = shift @t1_fields;
is( $f5->name, 'f_char', 'Fifth field is "f_char"' );
is( $f5->data_type, 'char', 'Field is char' );
is( $f5->is_nullable, 1, 'Field can be null' );
is( $f5->size, 10, 'Size is "10"' );
is( $f5->default_value, undef, 'Default value is undefined' );
is( $f5->is_primary_key, 0, 'Field is not PK' );

my $f6 = shift @t1_fields;
is( $f6->name, 'f_bool', 'Sixth field is "f_bool"' );
is( $f6->data_type, 'boolean', 'Field is a boolean' );
is( $f6->is_nullable, 1, 'Field can be null' );
is( $f6->size, 0, 'Size is "0"' );
is( $f6->default_value, undef, 'Default value is undefined' );
is( $f6->is_primary_key, 0, 'Field is not PK' );

my $f7 = shift @t1_fields;
is( $f7->name, 'f_bin', 'Seventh field is "f_bin"' );
is( $f7->data_type, 'bytea', 'Field is bytea' );
is( $f7->is_nullable, 1, 'Field can be null' );
is( $f7->size, 0, 'Size is "0"' );
is( $f7->default_value, undef, 'Default value is undefined' );
is( $f7->is_primary_key, 0, 'Field is not PK' );

my $f8 = shift @t1_fields;
is( $f8->name, 'f_tz', 'Eighth field is "f_tz"' );
is( $f8->data_type, 'timestamp', 'Field is a timestamp' );
is( $f8->is_nullable, 1, 'Field can be null' );
is( $f8->size, 0, 'Size is "0"' );
is( $f8->default_value, '1970-01-01 00:00:00', 'Default value is 1970-01-01 00:00:00' );
is( $f8->is_primary_key, 0, 'Field is not PK' );

my $f9 = shift @t1_fields;
is( $f9->name, 'f_text', 'Ninth field is "f_text"' );
is( $f9->data_type, 'text', 'Field is text' );
is( $f9->is_nullable, 1, 'Field can be null' );
is( $f9->size, 64000, 'Size is "64,000"' );
is( $f9->default_value, " foo\n\$bar\$\nbaz ", 'Dollar-quoted default value is " foo\n$bar$\nbaz "' );
is( $f9->is_primary_key, 0, 'Field is not PK' );

my $f10 = shift @t1_fields;
is( $f10->name, 'f_fk1', 'Tenth field is "f_fk1"' );
is( $f10->data_type, 'integer', 'Field is an integer' );
is( $f10->is_nullable, 0, 'Field cannot be null' );
is( $f10->size, 10, 'Size is "10"' );
is( $f10->default_value, undef, 'Default value is undefined' );
is( $f10->is_primary_key, 0, 'Field is not PK' );
is( $f10->is_foreign_key, 1, 'Field is a FK' );
my $fk_ref1 = $f10->foreign_key_reference;
isa_ok( $fk_ref1, 'SQL::Translator::Schema::Constraint', 'FK' );
is( $fk_ref1->reference_table, 't_test2', 'FK is to "t_test2" table' );

my $f11 = shift @t1_fields;
is( $f11->name, 'f_timestamp', 'Eleventh field is "f_timestamp"' );
is( $f11->data_type, 'timestamp with time zone', 'Field is a timestamp with time zone' );
is( $f11->is_nullable, 1, 'Field can be null' );
is( $f11->size, 0, 'Size is "0"' );
is( $f11->default_value, undef, 'Default value is "undef"' );
is( $f11->is_primary_key, 0, 'Field is not PK' );
is( $f11->is_foreign_key, 0, 'Field is not FK' );

my $f12 = shift @t1_fields;
is( $f12->name, 'f_timestamp2', '12th field is "f_timestamp2"' );
is( $f12->data_type, 'timestamp without time zone', 'Field is a timestamp without time zone' );
is( $f12->is_nullable, 1, 'Field can be null' );
is( $f12->size, 0, 'Size is "0"' );
is( $f12->default_value, undef, 'Default value is "undef"' );
is( $f12->is_primary_key, 0, 'Field is not PK' );
is( $f12->is_foreign_key, 0, 'Field is not FK' );

my $f13 = shift @t1_fields;
is( $f13->name, 'f_json', '13th field is "f_json"' );
is( $f13->data_type, 'json', 'Field is Json' );
is( $f13->is_nullable, 1, 'Field can be null' );
is( $f13->size, 0, 'Size is "0"' );
is( $f13->default_value, undef, 'Default value is "undef"' );
is( $f13->is_primary_key, 0, 'Field is not PK' );
is( $f13->is_foreign_key, 0, 'Field is not FK' );

my $f14 = shift @t1_fields;
is( $f14->name, 'f_hstore', '14th field is "f_hstore"' );
is( $f14->data_type, 'hstore', 'Field is hstore' );
is( $f14->is_nullable, 1, 'Field can be null' );
is( $f14->size, 0, 'Size is "0"' );
is( $f14->default_value, undef, 'Default value is "undef"' );
is( $f14->is_primary_key, 0, 'Field is not PK' );
is( $f14->is_foreign_key, 0, 'Field is not FK' );

my $f15 = shift @t1_fields;
is( $f15->name, 'f_numarray', '15th field is "f_numarray"' );
is( $f15->data_type, 'numeric[]', 'Field is numeric[]' );
is( $f15->is_nullable, 1, 'Field can be null' );
is_deeply( [$f15->size], [7,2] , 'Size is "7,2"' );
is( $f15->default_value, undef, 'Default value is "undef"' );
is( $f15->is_primary_key, 0, 'Field is not PK' );
is( $f15->is_foreign_key, 0, 'Field is not FK' );

my $f16 = shift @t1_fields;
is( $f16->name, 'f_uuid', '16th field is "f_uuid"' );
is( $f16->data_type, 'uuid', 'Field is a UUID' );
is( $f16->is_nullable, 1, 'Field can be null' );
is( $f16->size, 0, 'Size is "0"' );
is( $f16->default_value, undef, 'Default value is "undef"' );
is( $f16->is_primary_key, 0, 'Field is not PK' );
is( $f16->is_foreign_key, 0, 'Field is not FK' );

my $f17 = shift @t1_fields;
is( $f17->name, 'f_time', '17th field is "f_time"' );
is( $f17->data_type, 'time with time zone', 'Field is a time with time zone' );
is( $f17->is_nullable, 1, 'Field can be null' );
is( $f17->size, 0, 'Size is "0"' );
is( $f17->default_value, undef, 'Default value is "undef"' );
is( $f17->is_primary_key, 0, 'Field is not PK' );
is( $f17->is_foreign_key, 0, 'Field is not FK' );

my $f18 = shift @t1_fields;
is( $f18->name, 'f_time2', '18th field is "f_time2"' );
is( $f18->data_type, 'time without time zone', 'Field is a time without time zone' );
is( $f18->is_nullable, 1, 'Field can be null' );
is( $f18->size, 0, 'Size is "0"' );
is( $f18->default_value, undef, 'Default value is "undef"' );
is( $f18->is_primary_key, 0, 'Field is not PK' );
is( $f18->is_foreign_key, 0, 'Field is not FK' );

my $f19 = shift @t1_fields;
is( $f19->name, 'f_text2', '19th field is "f_text2"' );
is( $f19->data_type, 'text', 'Field is text' );
is( $f19->is_nullable, 1, 'Field can be null' );
is( $f19->size, 64000, 'Size is "64,000"' );
is( $f19->default_value, '', 'Dollar-quoted default value is empty' );
is( $f19->is_primary_key, 0, 'Field is not PK' );

my $f20 = shift @t1_fields;
is( $f20->name, 'f_text3', '20th field is "f_text3"' );
is( $f20->data_type, 'text', 'Field is text' );
is( $f20->is_nullable, 1, 'Field can be null' );
is( $f20->size, 64000, 'Size is "64,000"' );
is( $f20->default_value, '$ ', 'Dollar-quoted default value is "$ "' );
is( $f20->is_primary_key, 0, 'Field is not PK' );

# my $fk_ref2 = $f11->foreign_key_reference;
# isa_ok( $fk_ref2, 'SQL::Translator::Schema::Constraint', 'FK' );
# is( $fk_ref2->reference_table, 't_test2', 'FK is to "t_test2" table' );

my @t1_constraints = $t1->get_constraints;
is( scalar @t1_constraints, 8, '8 constraints on t_test1' );

my $c1 = $t1_constraints[0];
is( $c1->type, PRIMARY_KEY, 'First constraint is PK' );
is( join(',', $c1->fields), 'f_serial', 'Constraint is on field "f_serial"' );

my $c2 = $t1_constraints[4];
is( $c2->type, FOREIGN_KEY, 'Second constraint is foreign key' );
is( join(',', $c2->fields), 'f_fk1', 'Constraint is on field "f_fk1"' );
is( $c2->reference_table, 't_test2', 'Constraint is to table "t_test2"' );
is( join(',', $c2->reference_fields), 'f_id', 'Constraint is to field "f_id"' );

my $c3 = $t1_constraints[5];
is( $c3->type, UNIQUE, 'Third constraint is unique' );
is( join(',', $c3->fields), 'f_varchar', 'Constraint is on field "f_varchar"' );

my $c4 = $t1_constraints[6];
is( $c4->type, FOREIGN_KEY, 'Fourth constraint is foreign key' );
is( join(',', $c4->fields), 'f_fk2', 'Constraint is on field "f_fk2"' );
is( $c4->reference_table, 't_test2', 'Constraint is to table "t_test2"' );
is( join(',', $c4->reference_fields), 'f_id', 'Constraint is to field "f_id"' );
is( $c4->on_delete, 'cascade', 'On delete: cascade' );
is( $c4->on_update, 'no_action', 'On delete: no action' );
is( $c4->match_type, 'simple', 'Match type: simple' );
is( $c4->deferrable, 1, 'Deferrable detected' );

my $t2 = shift @tables;
is( $t2->name, 't_test2', 'Table t_test2 exists' );

my @t2_fields = $t2->get_fields;
is( scalar @t2_fields, 4, '4 fields in t_test2' );

my $t2_f1 = shift @t2_fields;
is( $t2_f1->name, 'f_id', 'First field is "f_id"' );
is( $t2_f1->data_type, 'integer', 'Field is an integer' );
is( $t2_f1->is_nullable, 0, 'Field cannot be null' );
is( $t2_f1->size, 10, 'Size is "10"' );
is( $t2_f1->default_value, undef, 'Default value is undefined' );
is( $t2_f1->is_primary_key, 1, 'Field is PK' );

my $t2_f2 = shift @t2_fields;
is( $t2_f2->name, 'f_varchar', 'Second field is "f_varchar"' );
is( $t2_f2->data_type, 'varchar', 'Field is an varchar' );
is( $t2_f2->is_nullable, 1, 'Field can be null' );
is( $t2_f2->size, 25, 'Size is "25"' );
is( $t2_f2->default_value, undef, 'Default value is undefined' );
is( $t2_f2->is_primary_key, 0, 'Field is not PK' );

my $t2_f3 = shift @t2_fields;
is( $t2_f3->name, 'f_int', 'Third field is "f_int"' );
is( $t2_f3->data_type, 'integer', 'Field is an integer' );
is( $t2_f3->is_nullable, 1, 'Field can be null' );
is( $t2_f3->size, 5, 'Size is "5"' );
is( $t2_f3->default_value, undef, 'Default value is undefined' );
is( $t2_f3->is_primary_key, 0, 'Field is not PK' );

my $t2_f4 = shift @t2_fields;
is( $t2_f4->name, 'f_smallint', 'Fourth field is "f_smallint"' );
is( $t2_f4->data_type, 'integer', 'Field is an integer' );
is( $t2_f4->is_nullable, 1, 'Field can be null' );
is( $t2_f4->size, 5, 'Size is "5"' );
is( $t2_f4->default_value, 0, 'Default value is 0' );
is( $t2_f4->is_primary_key, 0, 'Field is not PK' );


my @t2_constraints = $t2->get_constraints;
is( scalar @t2_constraints, 3, "Three constraints on table" );

my $t2_c1 = shift @t2_constraints;
is( $t2_c1->type, NOT_NULL, "Constraint is NOT NULL" );

my $t2_c2 = shift @t2_constraints;
is( $t2_c2->type, PRIMARY_KEY, "Constraint is a PK" );

my $t2_c3 = shift @t2_constraints;
is( $t2_c3->type, CHECK_C, "Constraint is a 'CHECK'" );

# test temporary tables
is( exists $schema->get_table('products_1')->extra()->{'temporary'}, "", "Table is NOT temporary");
is( $schema->get_table('products_2')->extra('temporary'), 1,"Table is TEMP");
is( $schema->get_table('products_3')->extra('temporary'), 1,"Table is TEMPORARY");

# test trigger
my $trigger = $schema->get_trigger('test_trigger');
is( $trigger->on_table, 'products_1', "Trigger is on correct table");
is_deeply( scalar $trigger->database_events, [qw(insert update delete)], "Correct events for trigger");

is( $trigger->perform_action_when, 'before', "Correct time for trigger");
is( $trigger->scope, 'row', "Correct scope for trigger");
is( $trigger->action, 'EXECUTE PROCEDURE foo()', "Correct action for trigger");

# test index
my @indices = $t1->get_indices;
is(scalar @indices, 3, 'got three indexes');

my $t1_i1 = $indices[0];
is( $t1_i1->name, 'test_index1', 'First index is "test_index1"' );
is( join(',', $t1_i1->fields), 'f_varchar', 'Index is on field "f_varchar"' );
is_deeply( [ $t1_i1->options ], [], 'Index is has no options' );

my $t1_i2 = $indices[1];
is( $t1_i2->name, 'test_index2', 'Second index is "test_index2"' );
is( join(',', $t1_i2->fields), 'f_char,f_bool', 'Index is on fields "f_char, f_bool"' );
is_deeply( [ $t1_i2->options ], [ { using => 'hash' } ], 'Index is using hash method' );

my $t1_i3 = $indices[2];
is( $t1_i3->name, 'test_index3', 'Third index is "test_index3"' );
is( join(',', $t1_i3->fields), 'f_bigint,f_tz', 'Index is on fields "f_bigint, f_tz"' );
is_deeply(
    [ $t1_i3->options ],
    [ { using => 'hash' }, { where => "f_bigint = '1' AND f_tz IS NULL" } ],
    'Index is using hash method and has predicate right'
);

done_testing;