-- Reading and writing files on the database host.
--
-- Everything is written under /tmp because that is the one directory the tests
-- can rely on already existing: SQL has no way to create one.

-- Error CONTEXT carries plpgsql line numbers, which would make this
-- expected output break on every unrelated edit.
\set SHOW_CONTEXT never
-- Quiet, so that the expected output is the same whether or not an earlier
-- test in the same database already created the extension.
set client_min_messages to warning;
create extension if not exists pg_statecharts_dev cascade;
reset client_min_messages;

\set dir '/tmp/pg_statecharts_test'
\set chart_a '/tmp/pg_statecharts_test_a-1.0.scxml'
\set chart_b '/tmp/pg_statecharts_test_b-1.0.scxml'

--
-- Writing files
--

-- Content has to survive the COPY based writer untouched, including
-- backslashes, dollar quotes, tabs, empty lines and a trailing newline.
select fsm.__write_file(:'dir' || '_roundtrip.txt', E'line one\n\nbackslash \\ and \\n literal\n$$ do $tag$ x $tag$ $$\ttab\nlast\n');
select pg_read_file(:'dir' || '_roundtrip.txt') = E'line one\n\nbackslash \\ and \\n literal\n$$ do $tag$ x $tag$ $$\ttab\nlast\n' as roundtrip_exact;

-- COPY terminates every row, so content that does not end in a newline gets
-- one. Documented rather than fixed: everything this extension writes ends in
-- a newline already.
select fsm.__write_file(:'dir' || '_nonewline.txt', 'abc');
select pg_read_file(:'dir' || '_nonewline.txt') = E'abc\n' as trailing_newline_added;

-- writing again replaces rather than appends
select fsm.__write_file(:'dir' || '_nonewline.txt', 'xyz');
select pg_read_file(:'dir' || '_nonewline.txt') as replaced;

-- a missing output directory is reported with the directory that is missing
select fsm.__write_file('/tmp/pg_statecharts_no_such_dir/out.sql', 'x');

-- carriage returns cannot survive the writer, so they are rejected up front
select fsm.__write_file(:'dir' || '_cr.txt', E'a\r\nb');

-- so is a line that is exactly a backslash and a dot, which COPY would quote
select fsm.__write_file(:'dir' || '_eod.txt', E'a\n\\.\nb\n');
-- a backslash-dot with anything else on the line is fine
select fsm.__write_file(:'dir' || '_eod.txt', E'a\n\\.x\nb\n');
select pg_read_file(:'dir' || '_eod.txt') = E'a\n\\.x\nb\n' as near_miss_written_exactly;

--
-- Finding files
--

select fsm.__write_file(:'chart_a',
  '<scxml xmlns="http://www.w3.org/2005/07/scxml" name="chart_a" version="1.0" initial="s">'
  '<state id="s" name="S"><onentry><script src="cb_one"/></onentry></state></scxml>');

select fsm.__write_file(:'chart_b',
  '<scxml xmlns="http://www.w3.org/2005/07/scxml" name="chart_b" version="2.1" initial="s">'
  '<state id="s" name="S"/></scxml>');

-- a single file is accepted directly
select fsm.__find_scxml_files(:'chart_a', false);

-- hidden files are skipped in a directory listing whether or not it is
-- recursive; a directory holding only a hidden chart therefore yields nothing
select fsm.__write_file('/tmp/.pg_statecharts_hidden-1.0.scxml',
  '<scxml name="hidden" version="1.0" initial="s"><state id="s"/></scxml>');
select count(*) as visible_charts_in_tmp_hidden_check
from fsm.__find_scxml_files('/tmp', false) as f
where f like '%/.pg_statecharts_hidden-1.0.scxml';
select count(*) as visible_charts_in_tmp_hidden_check_recursive
from fsm.__find_scxml_files('/tmp', true) as f
where f like '%/.pg_statecharts_hidden-1.0.scxml';

-- a path that is not an .scxml file is rejected
select fsm.__write_file('/tmp/pg_statecharts_test_notachart.txt', 'hello');
select fsm.__find_scxml_files('/tmp/pg_statecharts_test_notachart.txt', false);

-- a path that does not exist at all
select fsm.__find_scxml_files('/tmp/pg_statecharts_definitely_missing', false);

--
-- Importing
--

create function cb_one(event_payload fsm_event_payload) returns void language sql as $$ select $$;

select name, fsm.semver_text(version) as version from fsm.import_scxml_files(:'chart_a');

-- versions are padded on the way in
select name, fsm.semver_text(version) as version from fsm.import_scxml_files(:'chart_b');

-- importing the same chart twice is an error by default
select name from fsm.import_scxml_files(:'chart_a');

-- unless asked to skip
select count(*) as imported from fsm.import_scxml_files(:'chart_a', on_conflict_do_nothing => true);

-- a callback that does not exist is caught at import time, naming the file
delete from fsm.statechart;
select fsm.__write_file(:'dir' || '_missing_cb-1.0.scxml',
  '<scxml xmlns="http://www.w3.org/2005/07/scxml" name="missing_cb" version="1.0" initial="s">'
  '<state id="s" name="S"><onentry><script src="no_such_callback"/></onentry></state></scxml>');
select name from fsm.import_scxml_files(:'dir' || '_missing_cb-1.0.scxml');

-- nothing was left behind by the failed import
select count(*) as charts from fsm.statechart;

-- a procedure with the right name and argument type is not a usable callback:
-- the runtime invokes callbacks with SELECT, which only works for a function
create procedure proc_callback(fsm_event_payload) language sql as $$ select 1 $$;
select fsm.__write_file(:'dir' || '_proc_cb-1.0.scxml',
  '<scxml xmlns="http://www.w3.org/2005/07/scxml" name="proc_cb" version="1.0" initial="s">'
  '<state id="s" name="S"><onentry><script src="proc_callback"/></onentry></state></scxml>');
select name from fsm.import_scxml_files(:'dir' || '_proc_cb-1.0.scxml');
drop procedure proc_callback(fsm_event_payload);

-- a malformed document names the file it came from
select fsm.__write_file(:'dir' || '_broken-1.0.scxml', 'this is not xml at all');
select name from fsm.import_scxml_files(:'dir' || '_broken-1.0.scxml');

-- so does a document whose root is not <scxml>
select fsm.__write_file(:'dir' || '_wrongroot-1.0.scxml', '<html><body/></html>');
select name from fsm.import_scxml_files(:'dir' || '_wrongroot-1.0.scxml');

--
-- Generating migrations
--

-- the sqitch plan file has to exist
select fsm.gen_statechart_sqitch_migrations(:'chart_a', '/tmp/pg_statecharts_no_plan.plan');

-- and it has to look like a plan
select fsm.__write_file('/tmp/pg_statecharts_test.plan', E'not a plan\n');
select fsm.gen_statechart_sqitch_migrations(:'chart_a', '/tmp/pg_statecharts_test.plan');

-- with a real plan, all three missing output directories are reported at once
-- and nothing is written
select fsm.__write_file('/tmp/pg_statecharts_test.plan', E'%syntax-version=1.0.0\n%project=testproj\n\n');
select fsm.gen_statechart_sqitch_migrations(:'chart_a', '/tmp/pg_statecharts_test.plan');

-- the plan was not touched by the failed run
select pg_read_file('/tmp/pg_statecharts_test.plan');

-- Dots in a chart name become directory separators, so the directories that
-- need creating are deeper than <sqitch_dir>/{deploy,revert,verify}/statechart.
select fsm.__migration_name('myschema.thingflow', '1.0.0') as dotted,
       fsm.__migration_name('a.b.c', '2.1.0') as deeply_dotted;

-- The hint has to name the real missing directories rather than assume one
-- level, because following it is supposed to fix the error.
select fsm.__write_file(:'dir' || '_dotted-1.0.scxml',
  '<scxml xmlns="http://www.w3.org/2005/07/scxml" name="myschema.thingflow" version="1.0" initial="s">'
  '<state id="s" name="S"/></scxml>');
select fsm.gen_statechart_sqitch_migrations(:'dir' || '_dotted-1.0.scxml', '/tmp/pg_statecharts_test.plan');

-- Chart names are only length checked, so a path can contain characters that
-- would not survive being pasted into a shell. Those get quoted.
select fsm.__write_file(:'dir' || '_spaced-1.0.scxml',
  '<scxml xmlns="http://www.w3.org/2005/07/scxml" name="two words.flow" version="1.0" initial="s">'
  '<state id="s" name="S"/></scxml>');
select fsm.gen_statechart_sqitch_migrations(:'dir' || '_spaced-1.0.scxml', '/tmp/pg_statecharts_test.plan');

-- The generator runs every chart through the real tables in a rolled back
-- subtransaction, so anything the runtime's triggers or constraints would
-- refuse at deploy time is refused now, with the same message plus the file.
-- Parsing alone cannot see these.
--
-- The trigger messages quote the statechart id, so pin the sequence to keep
-- this output stable regardless of what ran before.
alter sequence fsm.statechart_id_seq restart with 1000;

-- a transition between states with different parents
select fsm.__write_file(:'dir' || '_crossing-1.0.scxml',
  '<scxml xmlns="http://www.w3.org/2005/07/scxml" name="crossing" version="1.0" initial="p">'
  '<state id="p"><initial><transition target="p1"/></initial>'
  '<state id="p1"><transition event="jump" target="q1"/></state></state>'
  '<state id="q"><initial><transition target="q1"/></initial><state id="q1"/></state>'
  '</scxml>');
select fsm.gen_statechart_sqitch_migrations(:'dir' || '_crossing-1.0.scxml', '/tmp/pg_statecharts_test.plan');

-- a transition to a state that does not exist
select fsm.__write_file(:'dir' || '_dangling-1.0.scxml',
  '<scxml xmlns="http://www.w3.org/2005/07/scxml" name="dangling" version="1.0" initial="a">'
  '<state id="a"><transition event="go" target="nowhere"/></state></scxml>');
select fsm.gen_statechart_sqitch_migrations(:'dir' || '_dangling-1.0.scxml', '/tmp/pg_statecharts_test.plan');

-- two transitions on the same event out of one state
select fsm.__write_file(:'dir' || '_twice-1.0.scxml',
  '<scxml xmlns="http://www.w3.org/2005/07/scxml" name="twice" version="1.0" initial="a">'
  '<state id="a"><transition event="go" target="b"/><transition event="go" target="c"/></state>'
  '<state id="b"/><state id="c"/></scxml>');
select fsm.gen_statechart_sqitch_migrations(:'dir' || '_twice-1.0.scxml', '/tmp/pg_statecharts_test.plan');

-- and the dry run leaves nothing behind, even when the same chart is already
-- in the database under its real name
select name, fsm.semver_text(version) as version from fsm.import_scxml_files(:'chart_b');
select fsm.__check_chart_deploys(fsm.__read_scxml(:'chart_b'), '2.1');
select count(*) as charts, count(*) filter (where name like '__pg_statecharts_dry_run%') as dry_run_leftovers
from fsm.statechart;

-- A chart with no transitions still produces a migration that runs, rather
-- than a NULL body that silently writes nothing.
select fsm.__migration_deploy(
  '<scxml xmlns="http://www.w3.org/2005/07/scxml" name="lonely" version="1.0" initial="s">'
  '<state id="s" name="S"/></scxml>'::xml, 'proj', 'lonely', '1.0');

-- and a null body is refused loudly rather than silently skipped
select fsm.__write_file('/tmp/pg_statecharts_test_null.txt', null);

drop function cb_one(fsm_event_payload);