Merge pull request #11 from supabase/test/db

Add PostgREST stack & some simple unit tests

Author: soedirgo

.github/workflows/ci.yml

@@ -12,12 +12,22 @@ jobs:
   test:
     strategy:
       matrix:
-        platform: [ubuntu-latest, macos-latest, windows-latest]
+        # macos-latest doesn't have docker-compose, no manifest for windows-latest
+        platform: [ubuntu-latest]
     runs-on: ${{ matrix.platform }}
 
     steps:
       - uses: actions/checkout@v2
 
+      - name: Build the stack
+        run: docker-compose -f ./tests/db/docker-compose.yml up -d
+
+      # HACK: Maybe find a more reliable way to do this
+      - name: Sleep for 30 seconds
+        uses: jakejarvis/wait-action@master
+        with:
+          time: "30s"
+
       - name: Set up toolchain
         uses: actions-rs/toolchain@v1
         with:

examples/test.rs renamed to examples/minimum.rs

@@ -2,7 +2,7 @@ use postgrest::Postgrest;
 
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
-    let client = Postgrest::new("https://hacks.soedirgo.dev/postgrest");
+    let client = Postgrest::new("http://localhost:3000");
     let resp = client.from("todos").select("*").execute().await?;
     println!("{}", resp.text().await?);
     Ok(())

src/builder.rs

@@ -21,7 +21,6 @@ pub struct Builder {
     url: String,
     schema: Option<String>,
     queries: Vec<(String, String)>,
-    // TODO: Maybe change to HeaderMap in the future
     headers: HeaderMap,
     body: Option<String>,
     is_rpc: bool,

src/lib.rs

@@ -30,3 +30,23 @@ impl Postgrest {
         Builder::new(&url, self.schema.clone()).rpc(params)
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    const REST_URL: &str = "https://localhost:3000";
+
+    #[test]
+    fn initialize() {
+        assert_eq!(Postgrest::new(REST_URL).url, REST_URL);
+    }
+
+    #[test]
+    fn switch_schema() {
+        assert_eq!(
+            Postgrest::new(REST_URL).schema("private").schema,
+            Some("private".to_string())
+        );
+    }
+}

tests/db/00-schema.sql

@@ -0,0 +1,67 @@
+
+-- Create the Replication publication
+CREATE PUBLICATION supabase_realtime FOR ALL TABLES;
+
+-- Create a second schema
+CREATE SCHEMA personal;
+
+-- USERS
+CREATE TYPE public.user_status AS ENUM ('ONLINE', 'OFFLINE');
+CREATE TABLE public.users (
+  username text primary key,
+  inserted_at timestamp without time zone DEFAULT timezone('utc'::text, now()) NOT NULL,
+  updated_at timestamp without time zone DEFAULT timezone('utc'::text, now()) NOT NULL,
+  data jsonb DEFAULT null,
+  age_range int4range DEFAULT null,
+  status user_status DEFAULT 'ONLINE'::public.user_status,
+  catchphrase tsvector DEFAULT null
+);
+ALTER TABLE public.users REPLICA IDENTITY FULL; -- Send "previous data" to supabase
+COMMENT ON COLUMN public.users.data IS 'For unstructured data and prototyping.';
+
+-- CHANNELS
+CREATE TABLE public.channels (
+  id bigint GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY,
+  inserted_at timestamp without time zone DEFAULT timezone('utc'::text, now()) NOT NULL,
+  updated_at timestamp without time zone DEFAULT timezone('utc'::text, now()) NOT NULL,
+  data jsonb DEFAULT null,
+  slug text
+);
+ALTER TABLE public.users REPLICA IDENTITY FULL; -- Send "previous data" to supabase
+COMMENT ON COLUMN public.channels.data IS 'For unstructured data and prototyping.';
+
+-- MESSAGES
+CREATE TABLE public.messages (
+  id bigint GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY,
+  inserted_at timestamp without time zone DEFAULT timezone('utc'::text, now()) NOT NULL,
+  updated_at timestamp without time zone DEFAULT timezone('utc'::text, now()) NOT NULL,
+  data jsonb DEFAULT null,
+  message text,
+  username text REFERENCES users NOT NULL,
+  channel_id bigint REFERENCES channels NOT NULL
+);
+ALTER TABLE public.messages REPLICA IDENTITY FULL; -- Send "previous data" to supabase
+COMMENT ON COLUMN public.messages.data IS 'For unstructured data and prototyping.';
+
+-- STORED FUNCTION
+CREATE FUNCTION public.get_status(name_param text)
+RETURNS user_status AS $$
+  SELECT status from users WHERE username=name_param;
+$$ LANGUAGE SQL IMMUTABLE;
+
+-- SECOND SCHEMA USERS
+CREATE TYPE personal.user_status AS ENUM ('ONLINE', 'OFFLINE');
+CREATE TABLE personal.users(
+  username text primary key,
+  inserted_at timestamp without time zone DEFAULT timezone('utc'::text, now()) NOT NULL,
+  updated_at timestamp without time zone DEFAULT timezone('utc'::text, now()) NOT NULL,
+  data jsonb DEFAULT null,
+  age_range int4range DEFAULT null,
+  status user_status DEFAULT 'ONLINE'::public.user_status
+);
+
+-- SECOND SCHEMA STORED FUNCTION
+CREATE FUNCTION personal.get_status(name_param text)
+RETURNS user_status AS $$
+  SELECT status from users WHERE username=name_param;
+$$ LANGUAGE SQL IMMUTABLE;

tests/db/01-dummy-data.sql

@@ -0,0 +1,28 @@
+INSERT INTO
+    public.users (username, status, age_range, catchphrase)
+VALUES
+    ('supabot', 'ONLINE', '[1,2)'::int4range, 'fat cat'::tsvector),
+    ('kiwicopple', 'OFFLINE', '[25,35)'::int4range, 'cat bat'::tsvector),
+    ('awailas', 'ONLINE', '[25,35)'::int4range, 'bat rat'::tsvector),
+    ('dragarcia', 'ONLINE', '[20,30)'::int4range, 'rat fat'::tsvector);
+
+INSERT INTO
+    public.channels (slug)
+VALUES
+    ('public'),
+    ('random');
+
+INSERT INTO
+    public.messages (message, channel_id, username)
+VALUES
+    ('Hello World 👋', 1, 'supabot'),
+    ('Perfection is attained, not when there is nothing more to add, but when there is nothing left to take away.', 2, 'supabot');
+
+INSERT INTO
+    personal.users (username, status, age_range)
+VALUES
+    ('supabot', 'ONLINE', '[1,2)'::int4range),
+    ('kiwicopple', 'OFFLINE', '[25,35)'::int4range),
+    ('awailas', 'ONLINE', '[25,35)'::int4range),
+    ('dragarcia', 'ONLINE', '[20,30)'::int4range),
+    ('leroyjenkins', 'ONLINE', '[20,40)'::int4range);

tests/db/docker-compose.yml

@@ -0,0 +1,23 @@
+version: "3"
+services:
+  rest:
+    image: postgrest/postgrest
+    ports:
+      - "3000:3000"
+    environment:
+      PGRST_DB_URI: postgres://postgres:postgres@db:5432/postgres
+      PGRST_DB_SCHEMA: public, personal
+      PGRST_DB_ANON_ROLE: postgres
+    depends_on:
+      - db
+  db:
+    image: postgres:12
+    ports:
+      - "5432:5432"
+    volumes:
+      - .:/docker-entrypoint-initdb.d/
+    environment:
+      POSTGRES_DB: postgres
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_PORT: 5432