Add support for postgres, mariadb/mysql databases (#23)

* Add environment variables for Database configuration. * Install postgres and mysql dependencies. * Test refactoring * Run tests for prosody with postgres and also for prosody with sqlite. * Add tests that check if postgres or sqlite is used.
2025-05-04 05:00:39 +00:00 · 2021-05-07 14:06:29 +02:00 · 2021-05-07 14:06:29 +02:00 · 80216c5fdc
commit 80216c5fdc
parent 5bcf0fd3d0
14 changed files with 153 additions and 49 deletions
--- a/tests/bats/bats-assert
+++ b/tests/bats/bats-assert
@ -1 +1 @@
-Subproject commit 0a8dd57e2cc6d4cc064b1ed6b4e79b9f7fee096f
+Subproject commit e0de84e9c011223e7f88b7ccf1c929f4327097ba
--- a/tests/bats/bats-core
+++ b/tests/bats/bats-core
@ -1 +1 @@
-Subproject commit 8fb853a6cbc0169958707381985f3cd59789ccb1
+Subproject commit 49b377a751e6f9379abfdfb3dfa3aafabd8495a1
--- a/tests/docker-compose.yml
+++ b/tests/docker-compose.yml
@ -15,10 +15,39 @@ services:
      E2E_POLICY_WHITELIST: "admin@localhost, user1@localhost"
      LOG_LEVEL: debug
      PROSODY_ADMINS: "admin@localhost, admin2@localhost"
-    extra_hosts:
-      - "conference.localhost:127.0.0.1"
-      - "pubsub.localhost:127.0.0.1"
-      - "proxy.localhost:127.0.0.1"
-      - "upload.localhost:127.0.0.1"
    volumes:
      - ./certs:/usr/local/etc/prosody/certs
+
+  prosody_postgres:
+    image: prosody
+    restart: unless-stopped
+    ports:
+      - "5000:5000"
+      - "5222:5222"
+      - "5223:5223"
+      - "5269:5269"
+      - "5281:5281"
+    environment:
+      DOMAIN: localhost
+      E2E_POLICY_WHITELIST: "admin@localhost, user1@localhost"
+      LOG_LEVEL: debug
+      PROSODY_ADMINS: "admin@localhost, admin2@localhost"
+      #DB_DRIVER: "MySQL"
+      DB_DRIVER: "PostgreSQL"
+      DB_DATABASE: "prosody"
+      DB_HOST: "postgres"
+      DB_PORT: "5432"
+      DB_USERNAME: "prosody"
+      DB_PASSWORD: "prosody"
+    volumes:
+      - ./certs:/usr/local/etc/prosody/certs
+    depends_on:
+      - postgres
+
+  postgres:
+    image: postgres:13-alpine
+    restart: unless-stopped
+    environment:
+      POSTGRES_DB: prosody
+      POSTGRES_USER: prosody
+      POSTGRES_PASSWORD: prosody
--- a/tests/requirements.txt
+++ b/tests/requirements.txt
@ -1,3 +1,3 @@
-aioxmpp==0.11.0
-pip-chill==1.0.0
-pytest-asyncio==0.14.0
+aioxmpp==0.12.2
+pip-chill==1.0.1
+pytest-asyncio==0.15.1
--- a/tests/test.bash
+++ b/tests/test.bash
@ -15,31 +15,57 @@ generateCert() {
    fi
 }

+registerTestUser() {
+    local userName="$1"
+    local containerName="$2"
+    sudo docker exec "$containerName" /bin/bash -c "/entrypoint.bash register $userName localhost 12345678"
+}
+
+registerTestUsers() {
+    local containerName="$1"
+    registerTestUser admin "$containerName"
+    registerTestUser user1 "$containerName"
+    registerTestUser user2 "$containerName"
+    registerTestUser user3 "$containerName"
+}
+
+runTests() {
+    local containerName="$1"
+    python --version \
+    && python3 --version \
+    && python3 -m venv venv \
+    && source venv/bin/activate \
+    && python --version \
+    && pip --version \
+    && pip install -r requirements.txt \
+    && pytest \
+    && deactivate \
+    && sleep 5 \
+    && sudo docker-compose logs "$containerName" \
+    && export batsContainerName="$containerName" \
+    && ./bats/bats-core/bin/bats tests.bats \
+    && ./bats/bats-core/bin/bats tests-"$containerName".bats
+}
+
 generateCert "localhost"
 generateCert "conference.localhost"
 generateCert "proxy.localhost"
 generateCert "pubsub.localhost"
 generateCert "upload.localhost"

+# Run tests for first container with postgres
+# Start postgres first and wait for 10 seconds before starting prosody.
 sudo docker-compose down \
-&& sudo docker-compose up -d \
-\
-&& sudo docker exec tests_prosody_1 /bin/bash -c "/entrypoint.sh register admin localhost 12345678" \
-&& sudo docker exec tests_prosody_1 /bin/bash -c "/entrypoint.sh register user1 localhost 12345678" \
-&& sudo docker exec tests_prosody_1 /bin/bash -c "/entrypoint.sh register user2 localhost 12345678" \
-&& sudo docker exec tests_prosody_1 /bin/bash -c "/entrypoint.sh register user3 localhost 12345678" \
-\
-&& python --version \
-&& python3 --version \
-&& python3 -m venv venv \
-&& source venv/bin/activate \
-&& python --version \
-&& pip --version \
-&& pip install -r requirements.txt \
-&& pytest \
-&& deactivate \
-&& sleep 5 \
-&& sudo docker-compose logs \
-&& ./bats/bats-core/bin/bats tests.bats
+&& sudo docker-compose up -d postgres \
+&& sleep 10 \
+&& sudo docker-compose up -d prosody_postgres

+registerTestUsers tests_prosody_postgres_1
+runTests prosody_postgres
+sudo docker-compose down
+
+# Run tests for second container with SQLite
+sudo docker-compose up -d prosody
+registerTestUsers tests_prosody_1
+runTests prosody
 sudo docker-compose down
--- a/tests/tests-prosody.bats
+++ b/tests/tests-prosody.bats
@ -0,0 +1,10 @@
+# For tests with pipes see: https://github.com/sstephenson/bats/issues/10
+
+load 'bats/bats-support/load'
+load 'bats/bats-assert/load'
+
+@test "Should use sqlite" {
+  run bash -c "sudo docker-compose logs $batsContainerName | grep -E \"Connecting to \[SQLite3\] \/usr\/local\/var\/lib\/prosody\/prosody\.sqlite\.\.\.\""
+  assert_success
+  assert_output
+}
--- a/tests/tests-prosody_postgres.bats
+++ b/tests/tests-prosody_postgres.bats
@ -0,0 +1,10 @@
+# For tests with pipes see: https://github.com/sstephenson/bats/issues/10
+
+load 'bats/bats-support/load'
+load 'bats/bats-assert/load'
+
+@test "Should use postgres" {
+  run bash -c "sudo docker-compose logs $batsContainerName | grep -E \"Connecting to \[PostgreSQL\] prosody\.\.\.\""
+  assert_success
+  assert_output
+}
--- a/tests/tests.bats
+++ b/tests/tests.bats
@ -5,91 +5,91 @@ load 'bats/bats-assert/load'

 # group alternation in regex because the xml properties switch around. sometimes 'type=...' comes after 'to=...' and sometimes before
@test "Should send 5 messages" {
-  run bash -c "sudo docker-compose logs | grep -E \"Received\[c2s\]: <message (type='chat'|to='.*@localhost'|id=':.*') (type='chat'|to='.*@localhost'|id=':.*') (type='chat'|to='.*@localhost'|id=':.*')>\" | wc -l"
+  run bash -c "sudo docker-compose logs $batsContainerName | grep -E \"Received\[c2s\]: <message (type='chat'|to='.*@localhost'|id=':.*') (type='chat'|to='.*@localhost'|id=':.*') (type='chat'|to='.*@localhost'|id=':.*')>\" | wc -l"
  assert_success
  assert_output "5"
 }

@test "Should select certificate for localhost" {
-  run bash -c "sudo docker-compose logs | grep \"Selecting certificate /usr/local/etc/prosody/certs/localhost/fullchain.pem with key /usr/local/etc/prosody/certs/localhost/privkey.pem for localhost\" | wc -l"
+  run bash -c "sudo docker-compose logs $batsContainerName | grep \"Selecting certificate /usr/local/etc/prosody/certs/localhost/fullchain.pem with key /usr/local/etc/prosody/certs/localhost/privkey.pem for localhost\" | wc -l"
  assert_success
  assert_output "3"
 }

@test "Should select certificate for conference.localhost" {
-  run bash -c "sudo docker-compose logs | grep \"Selecting certificate /usr/local/etc/prosody/certs/conference.localhost/fullchain.pem with key /usr/local/etc/prosody/certs/conference.localhost/privkey.pem for conference.localhost\" | wc -l"
+  run bash -c "sudo docker-compose logs $batsContainerName | grep \"Selecting certificate /usr/local/etc/prosody/certs/conference.localhost/fullchain.pem with key /usr/local/etc/prosody/certs/conference.localhost/privkey.pem for conference.localhost\" | wc -l"
  assert_success
  assert_output "3"
 }

@test "Should select certificate for proxy.localhost" {
-  run bash -c "sudo docker-compose logs | grep \"Selecting certificate /usr/local/etc/prosody/certs/proxy.localhost/fullchain.pem with key /usr/local/etc/prosody/certs/proxy.localhost/privkey.pem for proxy.localhost\" | wc -l"
+  run bash -c "sudo docker-compose logs $batsContainerName | grep \"Selecting certificate /usr/local/etc/prosody/certs/proxy.localhost/fullchain.pem with key /usr/local/etc/prosody/certs/proxy.localhost/privkey.pem for proxy.localhost\" | wc -l"
  assert_success
  assert_output "3"
 }

@test "Should select certificate for pubsub.localhost" {
-  run bash -c "sudo docker-compose logs | grep \"Selecting certificate /usr/local/etc/prosody/certs/pubsub.localhost/fullchain.pem with key /usr/local/etc/prosody/certs/pubsub.localhost/privkey.pem for pubsub.localhost\" | wc -l"
+  run bash -c "sudo docker-compose logs $batsContainerName | grep \"Selecting certificate /usr/local/etc/prosody/certs/pubsub.localhost/fullchain.pem with key /usr/local/etc/prosody/certs/pubsub.localhost/privkey.pem for pubsub.localhost\" | wc -l"
  assert_success
  assert_output "3"
 }

@test "Should select certificate for upload.localhost" {
-  run bash -c "sudo docker-compose logs | grep \"Selecting certificate /usr/local/etc/prosody/certs/upload.localhost/fullchain.pem with key /usr/local/etc/prosody/certs/upload.localhost/privkey.pem for upload.localhost\" | wc -l"
+  run bash -c "sudo docker-compose logs $batsContainerName | grep \"Selecting certificate /usr/local/etc/prosody/certs/upload.localhost/fullchain.pem with key /usr/local/etc/prosody/certs/upload.localhost/privkey.pem for upload.localhost\" | wc -l"
  assert_success
  assert_output "3"
 }

@test "Should log error for user with wrong password" {
-  run bash -c "sudo docker-compose logs | grep \"Session closed by remote with error: undefined-condition (user intervention: authentication failed: authentication aborted by user)\""
+  run bash -c "sudo docker-compose logs $batsContainerName | grep \"Session closed by remote with error: undefined-condition (user intervention: authentication failed: authentication aborted by user)\""
  assert_success
  assert_output
 }

@test "Should activate s2s" {
-  run bash -c "sudo docker-compose logs | grep -E \"Activated service 's2s' on (\[::\]:5269|\[\*\]:5269), (\[::\]:5269|\[\*\]:5269)\""
+  run bash -c "sudo docker-compose logs $batsContainerName | grep -E \"Activated service 's2s' on (\[::\]:5269|\[\*\]:5269), (\[::\]:5269|\[\*\]:5269)\""
  assert_success
  assert_output
 }

@test "Should activate c2s" {
-  run bash -c "sudo docker-compose logs | grep -E \"Activated service 'c2s' on (\[::\]:5222|\[\*\]:5222), (\[::\]:5222|\[\*\]:5222)\""
+  run bash -c "sudo docker-compose logs $batsContainerName | grep -E \"Activated service 'c2s' on (\[::\]:5222|\[\*\]:5222), (\[::\]:5222|\[\*\]:5222)\""
  assert_success
  assert_output
 }

@test "Should activate legacy_ssl" {
-  run bash -c "sudo docker-compose logs | grep -E \"Activated service 'legacy_ssl' on (\[::\]:5223|\[\*\]:5223), (\[::\]:5223|\[\*\]:5223)\""
+  run bash -c "sudo docker-compose logs $batsContainerName | grep -E \"Activated service 'legacy_ssl' on (\[::\]:5223|\[\*\]:5223), (\[::\]:5223|\[\*\]:5223)\""
  assert_success
  assert_output
 }

@test "Should activate proxy65" {
-  run bash -c "sudo docker-compose logs | grep -E \"Activated service 'proxy65' on (\[::\]:5000|\[\*\]:5000), (\[::\]:5000|\[\*\]:5000)\""
+  run bash -c "sudo docker-compose logs $batsContainerName | grep -E \"Activated service 'proxy65' on (\[::\]:5000|\[\*\]:5000), (\[::\]:5000|\[\*\]:5000)\""
  assert_success
  assert_output
 }

@test "Should activate http" {
-  run bash -c "sudo docker-compose logs | grep -E \"Activated service 'http' on (\[::\]:5280|\[\*\]:5280), (\[::\]:5280|\[\*\]:5280)\""
+  run bash -c "sudo docker-compose logs $batsContainerName | grep -E \"Activated service 'http' on (\[::\]:5280|\[\*\]:5280), (\[::\]:5280|\[\*\]:5280)\""
  assert_success
  assert_output
 }

@test "Should activate https" {
-  run bash -c "sudo docker-compose logs | grep -E \"Activated service 'https' on (\[::\]:5281|\[\*\]:5281), (\[::\]:5281|\[\*\]:5281)\""
+  run bash -c "sudo docker-compose logs $batsContainerName | grep -E \"Activated service 'https' on (\[::\]:5281|\[\*\]:5281), (\[::\]:5281|\[\*\]:5281)\""
  assert_success
  assert_output
 }

@test "Should load module cloud_notify" {
-  run bash -c "sudo docker-compose logs | grep \"localhost:cloud_notify.*info.*Module loaded\""
+  run bash -c "sudo docker-compose logs $batsContainerName | grep \"localhost:cloud_notify.*info.*Module loaded\""
  assert_success
  assert_output
 }

@test "Should show upload URL" {
-  run bash -c "sudo docker-compose logs | grep \"URL: <https:\/\/upload.localhost:5281\/upload> - Ensure this can be reached by users\""
+  run bash -c "sudo docker-compose logs $batsContainerName | grep \"URL: <https:\/\/upload.localhost:5281\/upload> - Ensure this can be reached by users\""
  assert_success
  assert_output
 }