add contributing file and bootstrap

Author: tanner0101

CONTRIBUTE.md

@@ -0,0 +1,28 @@
+# Contributing to Fluent PostgreSQL
+
+👋 Welcome to the Vapor team! Join us on Slack ([http://vapor.team](http://vapor.team)) if you haven't already.
+
+## Bootstrap
+
+To prepare your computer for developing this package, you can run the bootstrap script.
+
+```sh
+./contribute_boostrap.sh
+```
+
+This script will start up a PostgreSQL docker container to test against. It will also generate and open Xcode for you.
+
+Be careful to observe the script's output, it may have errors or ask you to do additional steps manually.
+
+## Testing
+
+Once in Xcode, select the `FluentPostgreSQL-Package` scheme and use `CMD+U` to run the tests.
+
+When adding new tests (please do 😁), don't forget to add the method name to the `allTests` array. 
+If you add a new `XCTestCase` subclass, make sure to add it to the `Tests/LinuxMain.swift` file.
+
+If you are fixing a single GitHub issue in particular, you can add a test named `testGH<issue number>` to ensure
+that your fix is working. This will also help prevent regression.
+
+
+Thanks! 🙌

Tests/FluentPostgreSQLTests/FluentPostgreSQLTests.swift

@@ -2,14 +2,22 @@ import Async
 import XCTest
 import FluentBenchmark
 import FluentPostgreSQL
+import Foundation
 
 class FluentPostgreSQLTests: XCTestCase {
     var benchmarker: Benchmarker<PostgreSQLDatabase>!
     var database: PostgreSQLDatabase!
 
     override func setUp() {
         let eventLoop = MultiThreadedEventLoopGroup(numThreads: 1)
-        database = PostgreSQLDatabase(config: .default())
+        let config = PostgreSQLDatabaseConfig(
+            hostname: ProcessInfo.processInfo.environment["PSQL_HOSTNAME"] ?? "localhost",
+            port: 5432,
+            username: "vapor_username",
+            database: "vapor_database",
+            password: "vapor_password"
+        )
+        database = PostgreSQLDatabase(config: config)
         benchmarker = Benchmarker(database, on: eventLoop, onFail: XCTFail)
     }
 
@@ -101,7 +109,7 @@ class FluentPostgreSQLTests: XCTestCase {
 
     func testDefaultValue() throws {
         let conn = try benchmarker.pool.requestConnection().wait()
-        try? DefaultTest.revert(on: conn).wait()
+        defer { try? DefaultTest.revert(on: conn).wait() }
         try DefaultTest.prepare(on: conn).wait()
         let test = DefaultTest()
         // _ = try test.save(on: conn).await(on: eventLoop)
@@ -114,28 +122,26 @@ class FluentPostgreSQLTests: XCTestCase {
         } else {
             XCTFail()
         }
-        try DefaultTest.revert(on: conn).wait()
         benchmarker.pool.releaseConnection(conn)
     }
 
 
     func testUpdate() throws {
         benchmarker.database.enableLogging(using: .print)
         let conn = try benchmarker.pool.requestConnection().wait()
-        try? User.revert(on: conn).wait()
+        defer { try? User.revert(on: conn).wait() }
         try User.prepare(on: conn).wait()
         let user = User(id: nil, name: "Tanner", pet: Pet(name: "Zizek"))
         user.favoriteColors = ["pink", "blue"]
         _ = try user.save(on: conn).wait()
         try User.query(on: conn).update(["name": "Vapor"]).wait()
-        try User.revert(on: conn).wait()
         benchmarker.pool.releaseConnection(conn)
     }
 
     func testGH24() throws {
         benchmarker.database.enableLogging(using: .print)
         let conn = try benchmarker.pool.requestConnection().wait()
-        try? Allergy.revert(on: conn).wait()
+        defer { try? Allergy.revert(on: conn).wait() }
         try Allergy.prepare(on: conn).wait()
         struct Allergy: PostgreSQLModel, Migration {
             static let entity = "allergies"
@@ -165,7 +171,7 @@ class FluentPostgreSQLTests: XCTestCase {
         /// - prepare db
         benchmarker.database.enableLogging(using: .print)
         let conn = try benchmarker.pool.requestConnection().wait()
-        try? Pet.revert(on: conn).wait()
+        defer { try? Pet.revert(on: conn).wait() }
         try Pet.prepare(on: conn).wait()
 
         /// - tests
@@ -181,16 +187,14 @@ class FluentPostgreSQLTests: XCTestCase {
 
     func testPersistsDateMillisecondPart() throws {
         database.enableLogging(using: DatabaseLogger(handler: { print($0) }))
-        let conn = try database.makeConnection(on: eventLoop).await(on: eventLoop)
-        try? DefaultTest.revert(on: conn).await(on: eventLoop)
-        try DefaultTest.prepare(on: conn).await(on: eventLoop)
+        let conn = try benchmarker.pool.requestConnection().wait()
+        defer { try? DefaultTest.revert(on: conn).wait() }
+        try DefaultTest.prepare(on: conn).wait()
         var test = DefaultTest()
         test.date = PostgreSQLDate(Date(timeIntervalSinceReferenceDate: 123.456))
-        _ = try test.save(on: conn).await(on: eventLoop)
-        let fetched = try DefaultTest.query(on: conn).first().await(on: eventLoop)!
+        _ = try test.save(on: conn).wait()
+        let fetched = try DefaultTest.query(on: conn).first().wait()!
         XCTAssertEqual(123.456, fetched.date!.value!.timeIntervalSinceReferenceDate, accuracy: 1e-6)
-        try DefaultTest.revert(on: conn).await(on: eventLoop)
-        conn.close()
     }
 
     static let allTests = [
@@ -209,6 +213,7 @@ class FluentPostgreSQLTests: XCTestCase {
         ("testMinimumViableModelDeclaration", testMinimumViableModelDeclaration),
         ("testGH24", testGH24),
         ("testGH21", testGH21),
+        ("testPersistsDateMillisecondPart", testPersistsDateMillisecondPart),
     ]
 }
 

circle.yml

@@ -13,9 +13,9 @@ jobs:
       - image: norionomura/swift:swift-4.1-branch
       - image: circleci/postgres:latest
         environment:
-          POSTGRES_USER: postgres
-          POSTGRES_DB: postgres
-          POSTGRES_PASSWORD: ""
+          POSTGRES_USER: vapor_username
+          POSTGRES_DB: vapor_database
+          POSTGRES_PASSWORD: vapor_password
     steps:
       - run:
           name: Update APT

contribute_boostrap.sh

@@ -0,0 +1,23 @@
+echo "💧  starting docker..."
+docker-machine start default
+
+echo "💧  exporting docker machine environment..."
+eval $(docker-machine env default)
+
+echo "💧  cleaning previous vapor-psql dev db..."
+docker stop vapor-psql
+docker rm vapor-psql
+
+echo "💧  creating vapor-psql dev db..."
+docker run --name vapor-psql -e POSTGRES_USER=vapor_username -e POSTGRES_DB=vapor_database -e POSTGRES_PASSWORD=vapor_password -p 5432:5432 -d postgres:latest
+
+echo "💧  generating xcode proj..."
+swift package generate-xcodeproj
+
+echo "💧  add the following env variable to Xcode test scheme:"
+echo ""
+echo "    PSQL_HOSTNAME: `docker-machine ip`"
+echo ""
+
+echo "💧  opening xcode..."
+open *.xcodeproj