chore: split sql into modules

Author: tobyhede

src/common.sql

@@ -0,0 +1,29 @@
+-- AUTOMATICALLY GENERATED FILE
+-- REQUIRE: src/schema.sql
+
+
+
+--
+-- Convenience function to log a message
+--
+DROP FUNCTION IF EXISTS eql_v1.log(text);
+CREATE FUNCTION eql_v1.log(s text)
+    RETURNS void
+AS $$
+  BEGIN
+    RAISE NOTICE '[LOG] %', s;
+END;
+$$ LANGUAGE plpgsql;
+
+
+--
+-- Convenience function to describe a test
+--
+DROP FUNCTION IF EXISTS eql_v1.log(text, text);
+CREATE FUNCTION eql_v1.log(ctx text, s text)
+    RETURNS void
+AS $$
+  BEGIN
+    RAISE NOTICE '[LOG] % %', ctx, s;
+END;
+$$ LANGUAGE plpgsql;

src/config/config_test.sql

@@ -0,0 +1,295 @@
+\set ON_ERROR_STOP on
+
+
+--
+-- Helper function for assertions
+--
+DROP FUNCTION IF EXISTS _index_exists(text, text, text, text);
+CREATE FUNCTION _index_exists(table_name text, column_name text, index_name text, state text DEFAULT 'pending')
+  RETURNS boolean
+LANGUAGE sql STRICT PARALLEL SAFE
+BEGIN ATOMIC
+  SELECT EXISTS (SELECT id FROM eql_v1_configuration c
+    WHERE c.state = state AND
+    c.data #> array['tables', table_name, column_name, 'indexes'] ? index_name);
+END;
+
+
+-- -----------------------------------------------
+-- Add and remove multiple indexes
+--
+-- -----------------------------------------------
+TRUNCATE TABLE eql_v1_configuration;
+
+
+DO $$
+  BEGIN
+
+    -- Add indexes
+    PERFORM eql_v1.add_index('users', 'name', 'match');
+    ASSERT (SELECT _index_exists('users', 'name', 'match'));
+
+    -- -- Add index with cast
+    -- PERFORM eql_v1.add_index('users', 'name', 'unique', 'int');
+    -- ASSERT (SELECT _index_exists('users', 'name', 'unique'));
+
+    -- ASSERT (SELECT EXISTS (SELECT id FROM eql_v1_configuration c
+    --         WHERE c.state = 'pending' AND
+    --         c.data #> array['tables', 'users', 'name'] ? 'cast_as'));
+
+    -- -- Match index removed
+    -- PERFORM eql_v1.remove_index('users', 'name', 'match');
+    -- ASSERT NOT (SELECT _index_exists('users', 'name', 'match'));
+
+    -- -- All indexes removed, delete the emtpty pending config
+    -- PERFORM eql_v1.remove_index('users', 'name', 'unique');
+    -- ASSERT (SELECT NOT EXISTS (SELECT FROM eql_v1_configuration c WHERE c.state = 'pending'));
+
+  END;
+$$ LANGUAGE plpgsql;
+
+
+
+-- -----------------------------------------------
+-- Add and remove multiple indexes from multiple tables
+--
+-- -----------------------------------------------
+TRUNCATE TABLE eql_v1_configuration;
+
+
+DO $$
+  BEGIN
+
+    -- Add indexes
+    PERFORM eql_v1.add_index('users', 'name', 'match');
+    ASSERT (SELECT _index_exists('users', 'name', 'match'));
+
+    ASSERT (SELECT EXISTS (SELECT id FROM eql_v1_configuration c
+            WHERE c.state = 'pending' AND
+            c.data #> array['tables', 'users', 'name', 'indexes'] ? 'match'));
+
+    -- Add index with cast
+    PERFORM eql_v1.add_index('blah', 'vtha', 'unique', 'int');
+    ASSERT (SELECT _index_exists('blah', 'vtha', 'unique'));
+
+    ASSERT (SELECT EXISTS (SELECT id FROM eql_v1_configuration c
+            WHERE c.state = 'pending' AND
+            c.data #> array['tables', 'users', 'name', 'indexes'] ? 'match'));
+
+
+    ASSERT (SELECT EXISTS (SELECT id FROM eql_v1_configuration c
+            WHERE c.state = 'pending' AND
+            c.data #> array['tables', 'blah', 'vtha', 'indexes'] ? 'unique'));
+
+
+    -- Match index removed
+    PERFORM eql_v1.remove_index('users', 'name', 'match');
+    ASSERT NOT (SELECT _index_exists('users', 'name', 'match'));
+
+    -- Match index removed
+    PERFORM eql_v1.remove_index('blah', 'vtha', 'unique');
+    ASSERT NOT (SELECT _index_exists('users', 'vtha', 'unique'));
+
+    -- All indexes removed, delete the emtpty pending config
+    ASSERT (SELECT NOT EXISTS (SELECT FROM eql_v1_configuration c WHERE c.state = 'pending'));
+
+  END;
+$$ LANGUAGE plpgsql;
+
+SELECT FROM eql_v1_configuration c WHERE c.state = 'pending';
+
+
+-- -----------------------------------------------
+-- Add & modify index
+-- Pending configuration created and contains the path `user/name.match.option`
+-- -----------------------------------------------
+-- TRUNCATE TABLE eql_v1_configuration;
+
+
+DO $$
+  BEGIN
+    PERFORM eql_v1.add_index('users', 'name', 'match');
+    ASSERT (SELECT _index_exists('users', 'name', 'match'));
+
+    -- Pending configuration contains the path `user/name.match.option`
+    PERFORM eql_v1.modify_index('users', 'name', 'match', 'int', '{"option": "value"}'::jsonb);
+    ASSERT (SELECT _index_exists('users', 'name', 'match'));
+
+    ASSERT (SELECT EXISTS (SELECT id FROM eql_v1_configuration c
+            WHERE c.state = 'pending' AND
+            c.data #> array['tables', 'users', 'name', 'indexes', 'match'] ? 'option'));
+
+    ASSERT (SELECT EXISTS (SELECT id FROM eql_v1_configuration c
+            WHERE c.state = 'pending' AND
+            c.data #> array['tables', 'users', 'name'] ? 'cast_as'));
+
+    -- All indexes removed, delete the emtpty pending config
+    PERFORM eql_v1.remove_index('users', 'name', 'match');
+    ASSERT (SELECT NOT EXISTS (SELECT FROM eql_v1_configuration c WHERE c.state = 'pending'));
+  END;
+$$ LANGUAGE plpgsql;
+
+
+-- -- -----------------------------------------------
+-- -- With existing active config
+-- -- Adding an index creates a new pending configuration
+-- -- -----------------------------------------------
+TRUNCATE TABLE eql_v1_configuration;
+
+-- create an active configuration
+INSERT INTO eql_v1_configuration (state, data) VALUES (
+  'active',
+  '{
+    "v": 1,
+    "tables": {
+      "users": {
+        "blah": {
+           "cast_as": "text",
+           "indexes": {
+              "match": {}
+           }
+        },
+        "vtha": {
+           "cast_as": "text",
+           "indexes": {}
+        }
+      }
+    }
+  }'::jsonb
+);
+
+-- An encrypting config should exist
+DO $$
+  BEGIN
+    ASSERT (SELECT _index_exists('users', 'blah', 'match', 'active'));
+
+    PERFORM eql_v1.add_index('users', 'name', 'match');
+
+    -- index added to name
+    ASSERT (SELECT _index_exists('users', 'name', 'match' ));
+
+    -- pending is a copy of the active config
+    -- and the active index still exists
+    ASSERT (SELECT _index_exists('users', 'blah', 'match'));
+
+  END;
+$$ LANGUAGE plpgsql;
+
+
+-- -- -----------------------------------------------
+-- -- Add and remove column
+-- --
+-- -- -----------------------------------------------
+TRUNCATE TABLE eql_v1_configuration;
+DO $$
+  BEGIN
+    -- Create pending configuration
+    PERFORM eql_v1.add_column('user', 'name');
+    ASSERT (SELECT EXISTS (SELECT FROM eql_v1_configuration c WHERE c.state = 'pending'));
+
+    PERFORM eql_v1.remove_column('user', 'name');
+
+    -- Config now empty and removed
+    ASSERT (SELECT NOT EXISTS (SELECT FROM eql_v1_configuration c WHERE c.state = 'pending'));
+  END;
+$$ LANGUAGE plpgsql;
+
+-- -----------------------------------------------
+---
+-- eql_v1_configuration tyoe
+-- Validate configuration schema
+-- Try and insert many invalid configurations
+-- None should exist
+--
+-- -----------------------------------------------
+TRUNCATE TABLE eql_v1_configuration;
+
+\set ON_ERROR_STOP off
+\set ON_ERROR_ROLLBACK on
+
+DO $$
+  BEGIN
+    RAISE NOTICE '------------------------------------------------------';
+    RAISE NOTICE 'eql_v1_configuration constraint tests: 4 errors follow';
+  END;
+$$ LANGUAGE plpgsql;
+--
+-- No schema version
+INSERT INTO eql_v1_configuration (data) VALUES (
+  '{
+    "tables": {
+      "users": {
+        "blah": {
+          "cast_as": "text",
+          "indexes": {}
+        }
+      }
+    }
+  }'::jsonb
+);
+
+--
+-- Empty tables
+INSERT INTO eql_v1_configuration (data) VALUES (
+  '{
+    "v": 1,
+    "tables": {}
+  }'::jsonb
+);
+
+
+--
+-- invalid cast
+INSERT INTO eql_v1_configuration (data) VALUES (
+  '{
+    "v": 1,
+    "tables": {
+      "users": {
+        "blah": {
+          "cast_as": "regex"
+        }
+      }
+    }
+  }'::jsonb
+);
+
+--
+-- invalid index
+INSERT INTO eql_v1_configuration (data) VALUES (
+  '{
+    "v": 1,
+    "tables": {
+      "users": {
+        "blah": {
+          "cast_as": "text",
+          "indexes": {
+            "blah": {}
+          }
+        }
+      }
+    }
+  }'::jsonb
+);
+
+
+-- Pending configuration should not be created;
+DO $$
+  BEGIN
+    ASSERT (SELECT NOT EXISTS (SELECT FROM eql_v1_configuration c WHERE c.state = 'pending'));
+  END;
+$$ LANGUAGE plpgsql;
+
+DO $$
+  BEGIN
+    RAISE NOTICE 'eql_v1_configuration constraint tests: OK';
+    RAISE NOTICE '------------------------------------------------------';
+  END;
+$$ LANGUAGE plpgsql;
+
+
+\set ON_ERROR_STOP on
+\set ON_ERROR_ROLLBACK off
+
+
+
+