Test multiple databases (#270)

* Everything is now scoped by one adapter at a time

* Fixed granite spec

* Changed default env to pg

* Changed travis CI and ameba fixes

* Restored granite spec location

* Update .env

* Removed log

* Fixing timestamps_spec.cr

* crystal tool format

* Testing travis config

* Travis env is not working for multiple versions

* Testing matrix option

* Added postgres to the matrix

* Removed old version that are redundant. Added sqlite

* Running with multiple docker-compose files

* Seperate docker compose files so only the needed images are build

* Changed docker folder

* typo

* Fixed the duplicate env("CURRENT_ADAPTER")

* Added documentation about the env variables

* Added more docs

* Removed graniteexample because it's not used anymore

* Setting default to sqlite

* remove extra require spec

* Only test the 2 latests versions

Author: Thellior

.env

@@ -1,3 +1,6 @@
 export PG_DATABASE_URL=postgres://granite:password@localhost:5432/granite_db
 export MYSQL_DATABASE_URL=mysql://granite:password@localhost:3306/granite_db
 export SQLITE_DATABASE_URL=sqlite3:./granite.db
+export CURRENT_ADAPTER=pg
+export PG_VERSION=10.4
+export MYSQL_VERSION=5.7

.gitignore

@@ -3,7 +3,7 @@
 /.deps/
 /.crystal/
 /doc/
-/config/*.db
+*.db
 
 # Libraries don't need dependency lock
 # Dependencies will be locked in application that uses them

.travis.yml

@@ -4,7 +4,35 @@ services:
   - docker
 
 before_install:
-  - docker-compose build spec
+  - docker-compose -f docker/docker-compose.$CURRENT_ADAPTER.yml build spec
 
 script:
-  - docker-compose run spec
+  - docker-compose -f docker/docker-compose.$CURRENT_ADAPTER.yml run spec
+
+matrix:
+  include:
+    - name: "Mysql 5.7"
+      env:
+        - CURRENT_ADAPTER=mysql
+        - MYSQL_VERSION=5.7
+        - PG_VERSION=10.4
+    - name: "Mysql 5.6"
+      env:
+        - CURRENT_ADAPTER=mysql
+        - MYSQL_VERSION=5.6
+        - PG_VERSION=10.4
+    - name: "Postgres 9.6"
+      env:
+        - CURRENT_ADAPTER=pg
+        - MYSQL_VERSION=5.7
+        - PG_VERSION=9.6
+    - name: "Postgres 10.5"
+      env:
+        - CURRENT_ADAPTER=pg
+        - MYSQL_VERSION=5.7
+        - PG_VERSION=10.5
+    - name: "Sqlite"
+      env:
+        - CURRENT_ADAPTER=sqlite
+        - MYSQL_VERSION=5.7
+        - PG_VERSION=10.4

README.md

@@ -28,28 +28,38 @@ Start by checking out the [Getting Started](docs/getting_started.md) guide to ge
    ### Docker setup
 
    There is a self-contained testing environment provided via the `docker-compose.yml` file in this repository.
+   We are testing against multiple databases so you have to specify which docker-compose file you would like to use.
+   Replace "{database_type}" with "mysql" or "pg" or "sqlite". Before you can run the docker configuration you have to set the appropriate
+   env variables. To do so you can either load them yourself or load the .env file
+
+   ```
+   $ source .env
+   ```
+
+   You can find postgres versions at https://hub.docker.com/_/postgres/
+   You can find mysql versions at https://hub.docker.com/_/mysql/
 
    After you have docker installed do the following to run tests:
 
    #### First run
 
    ```
-   $ docker-compose build spec
-   $ docker-compose run spec
+   $ docker-compose -f docker/docker-compose.{database_type}.yml build spec
+   $ docker-compose -f docker/docker-compose.{database_type}.yml run spec
    ```
 
    #### Subsequent runs
 
    ```
-   $ docker-compose run spec
+   $ docker-compose -f docker/docker-compose.{database_type}.yml run spec
    ```
 
    #### Cleanup
 
    If you're done testing and you'd like to shut down and clean up the docker dependences run the following:
 
    ```
-   $ docker-compose down
+   $ docker-compose -f docker/docker-compose.{database_type}.yml down
    ```
 
    ### Local setup
@@ -64,19 +74,19 @@ Start by checking out the [Getting Started](docs/getting_started.md) guide to ge
 
    ```sql
    CREATE USER granite WITH PASSWORD 'password';
-   
+
    CREATE DATABASE granite_db;
-   
+
    GRANT ALL PRIVILEGES ON DATABASE granite_db TO granite;
    ```
 
    #### MySQL
 
    ```sql
    CREATE USER 'granite'@'localhost' IDENTIFIED BY 'password';
-   
+
    CREATE DATABASE granite_db;
-   
+
    GRANT ALL PRIVILEGES ON granite_db.* TO 'granite'@'localhost' WITH GRANT OPTION;
    ```
 

docker-compose.yml

@@ -8,15 +8,4 @@ services:
       PG_DATABASE_URL: 'postgres://postgres:@pg:5432/postgres'
       MYSQL_DATABASE_URL: 'mysql://user:pass@mysql:3306/test'
       SQLITE_DATABASE_URL: 'sqlite3:./test.db'
-    depends_on:
-      - pg
-      - mysql
-  pg:
-    image: postgres:10.4
-  mysql:
-    image: mysql:5.7
-    environment:
-      MYSQL_ROOT_PASSWORD: pass
-      MYSQL_DATABASE: test
-      MYSQL_USER: user
-      MYSQL_PASSWORD: pass
+      CURRENT_ADAPTER: sqlite

docker/docker-compose.mysql.yml

@@ -0,0 +1,17 @@
+version: '2'
+services:
+  spec:
+    extends:
+      file: ../docker-compose.yml
+      service: spec
+    environment:
+      CURRENT_ADAPTER: mysql
+    depends_on:
+      - mysql
+  mysql:
+    image: mysql:${MYSQL_VERSION}
+    environment:
+      MYSQL_ROOT_PASSWORD: pass
+      MYSQL_DATABASE: test
+      MYSQL_USER: user
+      MYSQL_PASSWORD: pass

docker/docker-compose.pg.yml

@@ -0,0 +1,12 @@
+version: '2'
+services:
+  spec:
+    extends:
+      file: ../docker-compose.yml
+      service: spec
+    environment:
+      CURRENT_ADAPTER: pg
+    depends_on:
+      - pg
+  pg:
+    image: postgres:${PG_VERSION}

docker/docker-compose.sqlite.yml

@@ -0,0 +1,8 @@
+version: '2'
+services:
+  spec:
+    extends:
+      file: ../docker-compose.yml
+      service: spec
+    environment:
+      CURRENT_ADAPTER: sqlite

spec/granite/associations/belongs_to_spec.cr

@@ -1,72 +1,68 @@
 require "../../spec_helper"
 
-{% for adapter in GraniteExample::ADAPTERS %}
-module {{adapter.capitalize.id}}
-  describe "{{ adapter.id }} belongs_to" do
-    it "provides a getter for the foreign entity" do
-      teacher = Teacher.new
-      teacher.name = "Test teacher"
-      teacher.save
+describe "belongs_to" do
+  it "provides a getter for the foreign entity" do
+    teacher = Teacher.new
+    teacher.name = "Test teacher"
+    teacher.save
 
-      klass = Klass.new
-      klass.name = "Test klass"
-      klass.teacher_id = teacher.id
-      klass.save
+    klass = Klass.new
+    klass.name = "Test klass"
+    klass.teacher_id = teacher.id
+    klass.save
 
-      klass.teacher.id.should eq teacher.id
-    end
+    klass.teacher.id.should eq teacher.id
+  end
 
-    it "provides a setter for the foreign entity" do
-      teacher = Teacher.new
-      teacher.name = "Test teacher"
-      teacher.save
+  it "provides a setter for the foreign entity" do
+    teacher = Teacher.new
+    teacher.name = "Test teacher"
+    teacher.save
 
-      klass = Klass.new
-      klass.name = "Test klass"
-      klass.teacher = teacher
-      klass.save
+    klass = Klass.new
+    klass.name = "Test klass"
+    klass.teacher = teacher
+    klass.save
 
-      klass.teacher_id.should eq teacher.id
-    end
+    klass.teacher_id.should eq teacher.id
+  end
 
-    it "supports custom types for the join" do
-      book = Book.new
-      book.name = "Screw driver"
-      book.save
+  it "supports custom types for the join" do
+    book = Book.new
+    book.name = "Screw driver"
+    book.save
 
-      review = BookReview.new
-      review.book = book
-      review.body = "Best book ever!"
-      review.save
+    review = BookReview.new
+    review.book = book
+    review.body = "Best book ever!"
+    review.save
 
-      review.book.name.should eq "Screw driver"
-    end
+    review.book.name.should eq "Screw driver"
+  end
 
-    it "supports custom method name" do
-      author = Person.new
-      author.name = "John Titor"
-      author.save
+  it "supports custom method name" do
+    author = Person.new
+    author.name = "John Titor"
+    author.save
 
-      book = Book.new
-      book.name = "How to Time Traveling"
-      book.author = author
-      book.save
+    book = Book.new
+    book.name = "How to Time Traveling"
+    book.author = author
+    book.save
 
-      book.author.name.should eq "John Titor"
-    end
+    book.author.name.should eq "John Titor"
+  end
 
-    it "supports both custom method name and custom types for the join" do
-      publisher = Company.new
-      publisher.name = "Amber Framework"
-      publisher.save
+  it "supports both custom method name and custom types for the join" do
+    publisher = Company.new
+    publisher.name = "Amber Framework"
+    publisher.save
 
-      book = Book.new
-      book.name = "Introduction to Granite"
-      book.publisher = publisher
-      book.save
+    book = Book.new
+    book.name = "Introduction to Granite"
+    book.publisher = publisher
+    book.save
 
-      book.publisher.name.should eq "Amber Framework"
-    end
+    book.publisher.name.should eq "Amber Framework"
   end
 end
-{% end %}