Merge pull request #5 from cortze/feat/clickhouse-support

Feat/clickhouse support

Author: cortze

.clickhouse.env

@@ -0,0 +1,7 @@
+DB_DRIVER="clickhouse"
+DB_USER="test_user"
+DB_PASSWORD="password"
+DB_HOST="localhost"
+DB_PORT="8123"
+DB_DATABASE="test_database"
+DB_URL="${DB_DRIVER}://${DB_USER}:${DB_PASSWORD}@${DB_HOSTs}:${DB_PORT}/${DB_DATABASE}?x-multi-statement=true"

.env

@@ -26,18 +26,39 @@ jobs:
           POSTGRES_USER: ${{ env.PG_USER }}
           POSTGRES_PASSWORD: ${{ env.PGPASSWORD }}
           POSTGRES_DB: ${{ env.PG_DATABASE }}
+
         options: >-
           --health-cmd pg_isready
           --health-interval 10s
           --health-timeout 5s
           --health-retries 5
 
+      clickhouse:
+        image: clickhouse/clickhouse-server
+        env:
+          CLICKHOUSE_DB: ${{ env.PG_DATABASE }}
+          CLICKHOUSE_USER: ${{ env.PG_USER }}
+          CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT: 1
+          CLICKHOUSE_PASSWORD: ${{ env.PGPASSWORD }}
+        ports:
+          - "8123:8123"
+          - "9000:9000"
+
     steps:
     - uses: actions/checkout@v3
 
-    - name: Check psql mounting point
-      run: | 
-        psql -h localhost -U ${{ env.PG_USER }} -d ${{ env.PG_DATABASE }} -a -f psql/init_test_db.sql
+    # Install ClickHouse client
+    - name: Install ClickHouse client
+      run: curl https://clickhouse.com/ | sh
+
+    - name: Init psql database with .sql
+      run: |
+        psql -h localhost -U ${{ env.PG_USER }} -d ${{ env.PG_DATABASE }} -a -f sql/docker_init_postgresql_test_db.sql
+
+    - name: Init clickhouse database with .sql
+      run: |
+        ./clickhouse client --user ${{ env.PG_USER }} --password ${{ env.PGPASSWORD }} --multiquery < sql/docker_init_clickhouse_test_db.sql
+
 
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v3

.github/workflows/module_tests.yml

@@ -0,0 +1,7 @@
+DB_DRIVER="postgresql"
+DB_USER="test_user"
+DB_PASSWORD="password"
+DB_HOST="localhost"
+DB_PORT="5432"
+DB_DATABASE="test_database"
+DB_URL="${DB_DRIVER}://${DB_USER}:${DB_PASSWORD}@${DB_HOST}:${DB_PORT}/${DB_DATABASE}"

.postgresql.env

@@ -0,0 +1,7 @@
+DB_DRIVER="postgresql"
+DB_USER="test_user"
+DB_PASSWORD="password"
+DB_HOST="localhost"
+DB_PORT="5432"
+DB_DATABASE="test_database"
+DB_URL="${DB_DRIVER}://${DB_USER}:${DB_PASSWORD}@${DB_HOST}:${DB_PORT}/${DB_DATABASE}"

.template.env

@@ -44,9 +44,10 @@ from unit_db_test.testcase import DBintegrityTest
 ```
 
 3. Create a `DBintegrityTest` as if it was a `unittest.TestCase`. It is important to define the path to the `.env` that keeps the Postgres DB credentials:
+
 ```python
 class TestDBTestModule(DBintegrityTest):
-    db_config_file = '.env'
+    db_config_file = '.postgresql.env'
 ```
 
 4. Create as many `test` functions as pleased:

README.md

@@ -10,4 +10,17 @@ services:
       - POSTGRES_PASSWORD=${DB_PASSWORD}
       - POSTGRES_DB=${DB_DATABASE}
     volumes:
-      - ./psql/docker_init_test_db.sql:/docker-entrypoint-initdb.d/docker_postgres_init.sql
+      - sql/docker_init_test_db.sql:/docker-entrypoint-initdb.d/docker_postgres_init.sql
+
+  clickhouse:
+    image: clickhouse/clickhouse-server
+    environment:
+      - CLICKHOUSE_DB=${DB_DATABASE}
+      - CLICKHOUSE_USER=${DB_USER}
+      - CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT=1
+      - CLICKHOUSE_PASSWORD=${DB_PASSWORD}
+    volumes:
+      - sql/docker_init_clickhouse_test_db.sql:/docker-entrypoint-initdb.d/docker_init_test_db.sql
+    ports:
+      - "8123:8123"
+      - "9000:9000"

docker-compose.yaml

@@ -1,11 +1,30 @@
+asynch==0.2.3
+build==1.0.3
+certifi==2023.11.17
+charset-normalizer==3.3.2
+ciso8601==2.3.1
+clickhouse-connect==0.7.0
+clickhouse-driver==0.2.6
+clickhouse-sqlalchemy==0.3.0
 greenlet==2.0.2
+idna==3.6
+leb128==1.0.5
+lz4==4.3.3
 numpy==1.24.4
+packaging==23.1
 pandas==2.0.3
 psycopg2-binary==2.9.7
+pyproject_hooks==1.0.0
 python-dateutil==2.8.2
 python-dotenv==1.0.0
 pytz==2023.3.post1
+requests==2.31.0
+setuptools-scm==8.0.2
 six==1.16.0
 SQLAlchemy==2.0.21
-typing-extensions==4.8.0
+typing_extensions==4.8.0
 tzdata==2023.3
+tzlocal==5.2
+urllib3==2.2.0
+zstandard==0.22.0
+zstd==1.5.5.1

psql/init_test_db.sql

@@ -0,0 +1,47 @@
+-- Create custom tables for the testing
+CREATE TABLE test_table(
+    id            INT,
+    integer       INT NULL,
+    text_col      TEXT,
+    attribute_col TEXT NULL,
+    bool_col      BOOL
+)
+ENGINE = MergeTree
+PRIMARY KEY(id);
+
+-- Insert dummy data into test_table
+INSERT INTO test_table(
+	id,
+    integer,
+	text_col,
+	attribute_col,
+	bool_col)
+VALUES
+(1, 1, 'first', 'attr_1', false);
+
+INSERT INTO test_table(
+	id,
+    integer,
+	text_col,
+	attribute_col,
+	bool_col)
+VALUES
+(2, 2, 'second', NULL,  true);
+
+INSERT INTO test_table(
+	id,
+    integer,
+	text_col,
+	attribute_col,
+	bool_col)
+VALUES
+(3, NULL, 'third', 'attr_1', false);
+
+INSERT INTO test_table(
+	id,
+    integer,
+	text_col,
+	attribute_col,
+	bool_col)
+VALUES
+(4, 4, 'fourth', 'attr_3', true);