#109 better separation between unit tests and integration tests (#111)

* #109 stop running IT in unittest

* #109 update ddbctest to test all supported databases against containers

* install msodbcsql18 for integration tests

* use env for db ports

* add CONTRIBUTING.md file

* remove Visual Studio project files and update gitignore

Author: SingingBush

.github/workflows/dub.yml

@@ -57,38 +57,38 @@ jobs:
         run: dub build --config=full --arch=x86_64
 
       # x86 (Windows Only)
-      - name: dub test with SQLite config (x86)
+      - name: dub test with full config (x86)
         if: ${{ startsWith(matrix.os, 'windows') }}
-        run: dub test --config=SQLite --arch=x86
+        run: dub test --config=full --arch=x86
 
-      - name: dub run with test config (x86)
-        if: ${{ startsWith(matrix.os, 'windows') }}
-        run: dub run --config=test --arch=x86
+      #- name: dub run with test config (x86)
+      #  if: ${{ startsWith(matrix.os, 'windows') }}
+      #  run: dub run --config=test --arch=x86
 
       - name: run the ddbctest project (x86)
         if: ${{ startsWith(matrix.os, 'windows') }}
         working-directory: example
         run: dub build --config=SQLite --arch=x86 && ./ddbctest --connection=sqlite:ddbc-test.sqlite
 
       # x86_64 (all platforms)
-      - name: dub test with SQLite config (x86_64)
-        run: dub test --config=SQLite --arch=x86_64
+      - name: dub test with full config (x86_64)
+        run: dub test --config=full --arch=x86_64
 
-      - name: dub run with test config (x86_64)
-        run: dub run --config=test --arch=x86_64
+      #- name: dub run with test config (x86_64)
+      #  run: dub run --config=test --arch=x86_64
 
       - name: run the ddbctest project (x86_64)
         working-directory: example
         run: dub build --config=SQLite --arch=x86_64 && ./ddbctest --connection=sqlite:ddbc-test.sqlite
 
       # x86_mscoff (Windows with dmd Only)
-      - name: dub test with SQLite config (x86_mscoff)
+      - name: dub test with full config (x86_mscoff)
         if: ${{ startsWith(matrix.os, 'windows') && startsWith(matrix.compiler, 'dmd') }}
-        run: dub test --config=SQLite --arch=x86_mscoff
+        run: dub test --config=full --arch=x86_mscoff
 
-      - name: dub run with test config (x86_mscoff)
-        if: ${{ startsWith(matrix.os, 'windows') && startsWith(matrix.compiler, 'dmd') }}
-        run: dub run --config=test --arch=x86_mscoff
+      #- name: dub run with test config (x86_mscoff)
+      #  if: ${{ startsWith(matrix.os, 'windows') && startsWith(matrix.compiler, 'dmd') }}
+      #  run: dub run --config=test --arch=x86_mscoff
 
       - name: run the ddbctest project (x86_mscoff)
         if: ${{ startsWith(matrix.os, 'windows') && startsWith(matrix.compiler, 'dmd') }}
@@ -157,6 +157,16 @@ jobs:
         with:
           compiler: dmd-latest
 
+      - name: Install Microsoft ODBC
+        run: sudo ACCEPT_EULA=Y apt-get install msodbcsql18 -y
+
+      - name: Run ddbctest
+        env:
+          MYSQL_PORT: ${{ job.services.mysql.ports[3306] }}
+          POSTGRES_PORT: ${{ job.services.postgres.ports[5432] }}
+          MSSQL_PORT: ${{ job.services.mssql.ports[1433] }}
+        run: dub run --config=test
+
       - name: Build The Example Project
         working-directory: ./example
         run: dub build
@@ -185,5 +195,4 @@ jobs:
         env:
           PORT: ${{ job.services.mssql.ports[1433] }}
         run: |
-          sudo ACCEPT_EULA=Y apt-get install msodbcsql17 -y
-          ./ddbctest --connection=odbc://127.0.0.1:$PORT --database=dbo --user=SA --password=MSbbk4k77JKH88g54 --driver="ODBC Driver 17 for SQL Server" --trusted_connection=yes
+          ./ddbctest --connection=odbc://127.0.0.1:$PORT --user=SA --password=MSbbk4k77JKH88g54 --driver="ODBC Driver 18 for SQL Server" --trusted_connection=yes

.gitignore

@@ -9,6 +9,10 @@ Thumbs.db
 .idea/
 *.iml
 
+#Ignore project files by Visual Studio
+*.sln
+*.visualdproj
+
 #Ignore files build by Visual Studio
 *.user
 *.aps
@@ -28,7 +32,6 @@ Thumbs.db
 obj/
 [Rr]elease*/
 _ReSharper*/
-code.visualdproj
 HibernatedTest/*
 Unittest/*
 

CONTRIBUTING.md

@@ -0,0 +1,73 @@
+DDBC aims to support a range of compiler versions across from dmd 2.097 and above across a range of databases; SQLite, MySQL/MariaDB, Postgres, SQL Server, and Oracle.
+
+## Tests
+
+To help with testing there is a *docker-compose.yml* file in the root of the project so that multiple databases can be run locally for testing. 
+
+When making changes to DDBC please ensure that unit tests (test not requiring a working database) remain in the project source and any integration tests (those running against a local database) are placed the test project (under `./test/ddbctest/`).
+
+unit tests can br run in the usual way with `dub test` and integration tests are run with `dub run --config=test`.
+
+## Requirements for developing
+
+Apart from a D compiler such as dmd or ldc and the dub package manager, you'll need to have docker and docker-compose installed. If you want to test against an Oracle container you'll also need to have a login for [container-registry.oracle.com](https://container-registry.oracle.com) and have accepted their terms & conditions. There's also some libraries you'll need to have installed.
+
+On Fedora Linux you can do this using:
+
+```
+sudo dnf install openssl-devel sqlite-devel libpq-devel -y
+```
+
+### Installing Microsoft's odbc driver
+
+On Linux you can potentially use [FreeTDS](https://www.freetds.org/) as the ODBC driver when connecting to SQL Server. However, Microsoft do provide their own odbc driver and that is what's used for testing against SQL Server during CI.
+
+On Fedora Linux you can find packages under [packages.microsoft.com/config/rhel/](https://packages.microsoft.com/config/rhel/). See the documentation [here](https://learn.microsoft.com/en-us/sql/connect/odbc/linux-mac/installing-the-microsoft-odbc-driver-for-sql-server?view=sql-server-ver16#redhat18) for more details.The basic steps are:
+
+```
+# curl https://packages.microsoft.com/config/rhel/8/prod.repo > /etc/yum.repos.d/mssql-release.repo
+
+sudo yum remove unixODBC-utf16 unixODBC-utf16-devel
+sudo ACCEPT_EULA=Y dnf install -y unixODBC unixODBC-devel msodbcsql18 mssql-tools18
+
+sudo cat /etc/odbcinst.ini
+```
+
+## Installing databases locally (non-containerised)
+
+### MySQL (local)
+
+To allow unit tests using MySQL server,
+run mysql client using admin privileges, e.g. for MySQL server on localhost:
+
+```
+> mysql -uroot
+```
+
+Create test user and test DB:
+
+```
+mysql> CREATE DATABASE IF NOT EXISTS testdb;
+mysql> CREATE USER 'testuser'@'localhost' IDENTIFIED BY 'passw0rd';
+mysql> GRANT ALL PRIVILEGES ON testdb.* TO 'testuser'@'localhost';
+
+mysql> CREATE USER 'testuser'@'localhost';
+mysql> GRANT ALL PRIVILEGES ON testdb.* TO 'testuser'@'localhost' IDENTIFIED BY 'passw0rd';
+mysql> FLUSH PRIVILEGES;
+```
+
+### Postgres (local)
+
+To allow unit tests using PostgreSQL server,
+run postgres client using admin privileges, e.g. for postgres server on localhost:
+
+```
+sudo -u postgres psql
+```
+
+Then create a user and test database:
+
+```
+postgres=# CREATE USER testuser WITH ENCRYPTED PASSWORD 'passw0rd';
+postgres=# CREATE DATABASE testdb WITH OWNER testuser ENCODING 'UTF8' LC_COLLATE = 'en_US.UTF-8' LC_CTYPE = 'en_US.UTF-8' TEMPLATE template0;
+```

README.md

@@ -138,6 +138,10 @@ ddbc:mysql://127.0.0.1:3306
 
 ```
 ddbc:postgresql://127.0.0.1:5432
+
+or
+
+ddbc:postgresql://hostname:5432/dbname
 ```
 
 ### Microsoft SQL Server (via ODBC)