Convert from MySQL to sqlite3

Author: parkr

.gitignore

@@ -1,3 +1,4 @@
 _vendor
 /ping
 /ping-initialize-db
+*.sqlite3

Dockerfile

@@ -3,7 +3,7 @@ WORKDIR /go/src/github.com/parkr/ping
 EXPOSE 3306
 COPY . .
 RUN go version
-RUN CGO_ENABLED=0 go install github.com/parkr/ping/...
+RUN go install github.com/parkr/ping/...
 
 FROM scratch
 HEALTHCHECK --start-period=1s --interval=30s --timeout=5s --retries=1 \

Makefile

@@ -11,10 +11,9 @@ build:
 
 testdeps:
 	go build $(PKG)/cmd/ping-initialize-db
-	script/setup-test-database
 
 test: testdeps
-	. script/test-env && go test ./...
+	. script/test-env && go test -v ./...
 
 docker-build:
 	docker build -t parkr/ping:$(REV) .

README.md

@@ -39,8 +39,7 @@ Want to run ping? No problem.
 
 ```bash
 $ go get github.com/parkr/ping
-$ mysql -e 'create database ping;'
-$ PING_DB=user:passwd@localhost/ping ping -http=:8972
+$ PING_DB=./ping_production.sqlite3 ping -http=:8972
 ```
 
 Specify a port (defaults to `8000`) and a database URL and you're off to
@@ -52,13 +51,13 @@ invoking `ping` and you're good to go.
 Prefer Docker? We got that too!
 
 ```bash
-$ mysql -e 'create database ping;'
+$ mkdir data
 $ docker run --rm \
-  -e PING_DB=user:passwd@host-ip/ping \
+  -e PING_DB=/srv/data/ping_production.sqlite3 \
+  -v $(pwd)/data:/srv/data:rw \
   parkr/ping \
   ping -http=:8972
 ```
 
-Ensure that your Docker container is given access to the server MySQL is
-running on and that MySQL's `bind-address` host is `0.0.0.0` so it can be
-accessed by others. Or, use a MySQL proxy.
+This will save all data to the specified sqlite3 database,
+mounted to the container and written back to the host.

analytics/analytics_test.go

@@ -1,17 +1,25 @@
 package analytics
 
 import (
+	"log"
 	"os"
 	"testing"
 
-	_ "github.com/go-sql-driver/mysql"
 	"github.com/jmoiron/sqlx"
+	_ "github.com/mattn/go-sqlite3"
+	"github.com/parkr/ping/database"
 )
 
-var db = sqlx.MustConnect("mysql", os.Getenv("PING_DB"))
+var db *sqlx.DB
 
 func init() {
-	db.MustExec(`INSERT INTO visits (ip, host, path, user_agent, created_at) VALUES ('127.0.0.1', 'example.org', '/root', 'go test client', NOW())`)
+	var err error
+	db, err = database.Initialize()
+	if err != nil {
+		log.Printf("Error connecting to db '%s'", os.Getenv("PING_DB"))
+		panic(err)
+	}
+	db.MustExec(`INSERT INTO visits (ip, host, path, user_agent, created_at) VALUES ('127.0.0.1', 'example.org', '/root', 'go test client', datetime('now'))`)
 }
 
 func TestVisitorsForPath(t *testing.T) {

cmd/ping-initialize-db/ping-initialize-db.go

@@ -1,42 +1,20 @@
 package main
 
 import (
+	"log"
 	"os"
 
-	_ "github.com/go-sql-driver/mysql"
-	"github.com/jmoiron/sqlx"
+	"github.com/parkr/ping/database"
 )
 
-const (
-	schema = `CREATE TABLE visits (
-		id int(11) NOT NULL AUTO_INCREMENT,
-    	ip varchar(255) NOT NULL,
-    	host text NOT NULL,
-      user_agent text NOT NULL,
-    	path text NOT NULL,
-		created_at datetime NOT NULL,
-		PRIMARY KEY (id)
-	) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;`
-	checkIfSchemaExists = `SELECT COUNT(*) as does_exist FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_NAME = 'visits'`
-)
-
-type TableCheck struct {
-	DoesExist int `db:"does_exist"`
-}
-
-func VerifySchema() {
-	db := sqlx.MustConnect("mysql", os.Getenv("PING_DB"))
-	db.Ping()
-	var check TableCheck
-	err := db.Get(&check, checkIfSchemaExists)
-	if err != nil {
-		panic(err)
-	}
-	if check.DoesExist < 1 {
-		db.MustExec(schema)
-	}
+func VerifySchema() error {
+	_, err := database.Initialize()
+	return err
 }
 
 func main() {
-	VerifySchema()
+	if err := VerifySchema(); err != nil {
+		log.Fatalf("error setting up database: %+v", err)
+	}
+	log.Printf("database setup at %s", os.Getenv("PING_DB"))
 }

database/database.go

@@ -4,24 +4,23 @@ import (
 	"fmt"
 	"os"
 
-	_ "github.com/go-sql-driver/mysql"
 	"github.com/jmoiron/sqlx"
+	_ "github.com/mattn/go-sqlite3"
 )
 
 const (
-	// This is the format for a MySQL Datetime Literal.
-	MySQLDateTimeFormat = "2006-01-02 15:04:05"
+	// This is the format for a SQL Datetime Literal.
+	SQLDateTimeFormat = "2006-01-02 15:04:05"
 
 	schema = `CREATE TABLE visits (
-		id int(11) NOT NULL AUTO_INCREMENT,
+		id integer NOT NULL PRIMARY KEY AUTOINCREMENT,
     	ip varchar(255) NOT NULL,
     	host text NOT NULL,
-      user_agent text NOT NULL,
+      	user_agent text NOT NULL,
     	path text NOT NULL,
-		created_at datetime NOT NULL,
-		PRIMARY KEY (id)
-	) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;`
-	checkIfSchemaExists = `SELECT COUNT(*) as does_exist FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_NAME = 'visits'`
+		created_at datetime NOT NULL
+	);`
+	checkIfSchemaExists = `SELECT COUNT(*) as does_exist FROM sqlite_master WHERE type='table' AND name='visits';`
 	insertVisit         = `INSERT INTO visits (ip, host, path, user_agent, created_at) VALUES (:ip, :host, :path, :user_agent, :created_at)`
 )
 
@@ -30,7 +29,7 @@ type TableCheck struct {
 }
 
 func Initialize() (*sqlx.DB, error) {
-	db, err := sqlx.Connect("mysql", os.Getenv("PING_DB"))
+	db, err := sqlx.Connect("sqlite3", os.Getenv("PING_DB"))
 	if err != nil {
 		return nil, err
 	}

docs/index.md

@@ -31,14 +31,18 @@ A single tiny JavaScript file that the user requests sends down these three
 things and that's all there is to it. As unintrusive as possible, while
 still providing insight into the site's strenghts.
 
+It also respects the [Do Not Track header](http://donottrack.us/), which
+many browsers now allow users to set for all requests. Complying with this
+header is not mandatory, but aligns nicely with our motivation for
+respecting users' privacy when they ask for it.
+
 ## Installation
 
 Want to run ping? No problem.
 
 ```bash
 $ go get github.com/parkr/ping
-$ mysql -e 'create database ping;'
-$ PING_DB=user:passwd@localhost/ping ping -http=:8972
+$ PING_DB=./ping_production.sqlite3 ping -http=:8972
 ```
 
 Specify a port (defaults to `8000`) and a database URL and you're off to
@@ -50,13 +54,13 @@ invoking `ping` and you're good to go.
 Prefer Docker? We got that too!
 
 ```bash
-$ mysql -e 'create database ping;'
+$ mkdir data
 $ docker run --rm \
-  -e PING_DB=user:passwd@host-ip/ping \
+  -e PING_DB=/srv/data/ping_production.sqlite3 \
+  -v $(pwd)/data:/srv/data:rw \
   parkr/ping \
   ping -http=:8972
 ```
 
-Ensure that your Docker container is given access to the server MySQL is
-running on and that MySQL's `bind-address` host is `0.0.0.0` so it can be
-accessed by others. Or, use a MySQL proxy.
+This will save all data to the specified sqlite3 database,
+mounted to the container and written back to the host.

go.mod

@@ -3,9 +3,8 @@ module github.com/parkr/ping
 go 1.14
 
 require (
-	github.com/go-sql-driver/mysql v1.5.0
 	github.com/jmoiron/sqlx v0.0.0-20170121103519-f980a91bdc37
 	github.com/lib/pq v1.4.0 // indirect
-	github.com/mattn/go-sqlite3 v2.0.3+incompatible // indirect
+	github.com/mattn/go-sqlite3 v2.0.3+incompatible
 	github.com/parkr/gossip v0.0.0-20170207041538-a9ea9f924daf
 )

go.sum

@@ -4,6 +4,7 @@ github.com/jmoiron/sqlx v0.0.0-20170121103519-f980a91bdc37 h1:FZc3adQBtm3UfBaJmQ
 github.com/jmoiron/sqlx v0.0.0-20170121103519-f980a91bdc37/go.mod h1:IiEW3SEiiErVyFdH8NTuWjSifiEQKUoyK3LNqr2kCHU=
 github.com/lib/pq v1.4.0 h1:TmtCFbH+Aw0AixwyttznSMQDgbR5Yed/Gg6S8Funrhc=
 github.com/lib/pq v1.4.0/go.mod h1:5WUZQaWbwv1U+lTReE5YruASi9Al49XbQIvNi/34Woo=
+github.com/mattn/go-sqlite3 v1.14.6/go.mod h1:NyWgC/yNuGj7Q9rpYnZvas74GogHl5/Z4A/KQRfk6bU=
 github.com/mattn/go-sqlite3 v2.0.3+incompatible h1:gXHsfypPkaMZrKbD5209QV9jbUTJKjyR5WD3HYQSd+U=
 github.com/mattn/go-sqlite3 v2.0.3+incompatible/go.mod h1:FPy6KqzDD04eiIsT53CuJW3U88zkxoIYsOqkbpncsNc=
 github.com/parkr/gossip v0.0.0-20170207041538-a9ea9f924daf h1:rUZlwm2L4Px9+c1V7V2Cdddj55NhfOw8kcILdFHt1eQ=