commit 80602afe58ec5f49da4af2484a026386e120dcd1 Author: brajkovic Date: Thu Jul 6 11:29:06 2023 +0000 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1110d50 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +.idea/** +template +.env \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..f8c9352 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# go-web-app-template + +Basic template for creating go applications + +Includes: + * dotenv + * pq + * sqlx + * gin + * google.uuid + +To start using make sure to setup either environment variables listed +below, or create .env file and copy variables below +``` +PSQL_HOST=localhost +PSQL_PORT=5432 +PSQL_USER=template +PSQL_PASSWORD=templatePassword +PSQL_DB=template +``` + +Also, database is required for template to start, so you can start it with `docker compose up -d` \ No newline at end of file diff --git a/db.go b/db.go new file mode 100644 index 0000000..85fa139 --- /dev/null +++ b/db.go @@ -0,0 +1,39 @@ +package main + +import ( + "fmt" + "github.com/jmoiron/sqlx" + _ "github.com/lib/pq" + "os" +) + +func envMustExist(env string) string { + if value, exists := os.LookupEnv(env); !exists { + panic(fmt.Sprintf("env variable '%s' not defined", env)) + } else { + return value + } +} + +func connectToDb() (*sqlx.DB, error) { + host := envMustExist("PSQL_HOST") + port := envMustExist("PSQL_PORT") + user := envMustExist("PSQL_USER") + password := envMustExist("PSQL_PASSWORD") + dbname := envMustExist("PSQL_DB") + + psqlInfo := fmt.Sprintf("host=%s port=%s user=%s password=%s dbname=%s sslmode=disable", + host, port, user, password, dbname) + + db, err := sqlx.Open("postgres", psqlInfo) + if err != nil { + return nil, err + } + + err = db.Ping() + if err != nil { + return nil, err + } + + return db, nil +} diff --git a/db/dev/v1_0.sql b/db/dev/v1_0.sql new file mode 100644 index 0000000..e69de29 diff --git a/db/prod/v1_0.sql b/db/prod/v1_0.sql new file mode 100644 index 0000000..956632f --- /dev/null +++ b/db/prod/v1_0.sql @@ -0,0 +1 @@ +package prod diff --git a/docker-compose-deploy.yml b/docker-compose-deploy.yml new file mode 100644 index 0000000..bdaa228 --- /dev/null +++ b/docker-compose-deploy.yml @@ -0,0 +1,28 @@ +version: '3.1' + +services: + backend: + image: registry.bbr-dev.info/template/backend:latest + restart: on-failure + depends_on: + - database + ports: + - "5281:5281" + networks: + - template + env_file: + - .env.docker + + database: + image: postgres:14 + ports: + - "5432:5432" + environment: + - POSTGRES_USER=template + - POSTGRES_PASSWORD=templatePassword + - POSTGRES_DB=template + networks: + - template + +networks: + template: \ No newline at end of file diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..cfa85ef --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,11 @@ +version: '3.1' + +services: + database: + image: postgres:14 + ports: + - "5432:5432" + environment: + - POSTGRES_USER=template + - POSTGRES_PASSWORD=templatePassword + - POSTGRES_DB=template \ No newline at end of file diff --git a/dockerfile b/dockerfile new file mode 100644 index 0000000..b3cc11b --- /dev/null +++ b/dockerfile @@ -0,0 +1,19 @@ +### STAGE 1.a: Prepare certs ### +FROM alpine:latest as certs +RUN apk --update add ca-certificates + +### STAGE 1.b: Build ### +FROM golang as go-build +WORKDIR /root +COPY go.mod go.sum ./ +# install packages +RUN go mod download +COPY . . +ENV CGO_ENABLED=0 +RUN go build -tags timetzdata template + +### Stage 2: Run ### +FROM scratch +COPY --from=certs /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/ca-certificates.crt +COPY --from=go-build /root/template /usr/bin/template +ENTRYPOINT ["template"] diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..3471004 --- /dev/null +++ b/go.mod @@ -0,0 +1,38 @@ +module template + +go 1.19 + +require ( + github.com/gin-gonic/gin v1.9.1 + github.com/google/uuid v1.3.0 + github.com/jmoiron/sqlx v1.3.5 + github.com/joho/godotenv v1.5.1 + github.com/lib/pq v1.10.9 +) + +require ( + github.com/bytedance/sonic v1.9.1 // indirect + github.com/chenzhuoyu/base64x v0.0.0-20221115062448-fe3a3abad311 // indirect + github.com/gabriel-vasile/mimetype v1.4.2 // indirect + github.com/gin-contrib/sse v0.1.0 // indirect + github.com/go-playground/locales v0.14.1 // indirect + github.com/go-playground/universal-translator v0.18.1 // indirect + github.com/go-playground/validator/v10 v10.14.0 // indirect + github.com/goccy/go-json v0.10.2 // indirect + github.com/json-iterator/go v1.1.12 // indirect + github.com/klauspost/cpuid/v2 v2.2.4 // indirect + github.com/leodido/go-urn v1.2.4 // indirect + github.com/mattn/go-isatty v0.0.19 // indirect + github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect + github.com/modern-go/reflect2 v1.0.2 // indirect + github.com/pelletier/go-toml/v2 v2.0.8 // indirect + github.com/twitchyliquid64/golang-asm v0.15.1 // indirect + github.com/ugorji/go/codec v1.2.11 // indirect + golang.org/x/arch v0.3.0 // indirect + golang.org/x/crypto v0.9.0 // indirect + golang.org/x/net v0.10.0 // indirect + golang.org/x/sys v0.8.0 // indirect + golang.org/x/text v0.9.0 // indirect + google.golang.org/protobuf v1.30.0 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..3d776a3 --- /dev/null +++ b/go.sum @@ -0,0 +1,98 @@ +github.com/bytedance/sonic v1.5.0/go.mod h1:ED5hyg4y6t3/9Ku1R6dU/4KyJ48DZ4jPhfY1O2AihPM= +github.com/bytedance/sonic v1.9.1 h1:6iJ6NqdoxCDr6mbY8h18oSO+cShGSMRGCEo7F2h0x8s= +github.com/bytedance/sonic v1.9.1/go.mod h1:i736AoUSYt75HyZLoJW9ERYxcy6eaN6h4BZXU064P/U= +github.com/chenzhuoyu/base64x v0.0.0-20211019084208-fb5309c8db06/go.mod h1:DH46F32mSOjUmXrMHnKwZdA8wcEefY7UVqBKYGjpdQY= +github.com/chenzhuoyu/base64x v0.0.0-20221115062448-fe3a3abad311 h1:qSGYFH7+jGhDF8vLC+iwCD4WpbV1EBDSzWkJODFLams= +github.com/chenzhuoyu/base64x v0.0.0-20221115062448-fe3a3abad311/go.mod h1:b583jCggY9gE99b6G5LEC39OIiVsWj+R97kbl5odCEk= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/gabriel-vasile/mimetype v1.4.2 h1:w5qFW6JKBz9Y393Y4q372O9A7cUSequkh1Q7OhCmWKU= +github.com/gabriel-vasile/mimetype v1.4.2/go.mod h1:zApsH/mKG4w07erKIaJPFiX0Tsq9BFQgN3qGY5GnNgA= +github.com/gin-contrib/sse v0.1.0 h1:Y/yl/+YNO8GZSjAhjMsSuLt29uWRFHdHYUb5lYOV9qE= +github.com/gin-contrib/sse v0.1.0/go.mod h1:RHrZQHXnP2xjPF+u1gW/2HnVO7nvIa9PG3Gm+fLHvGI= +github.com/gin-gonic/gin v1.9.1 h1:4idEAncQnU5cB7BeOkPtxjfCSye0AAm1R0RVIqJ+Jmg= +github.com/gin-gonic/gin v1.9.1/go.mod h1:hPrL7YrpYKXt5YId3A/Tnip5kqbEAP+KLuI3SUcPTeU= +github.com/go-playground/assert/v2 v2.2.0 h1:JvknZsQTYeFEAhQwI4qEt9cyV5ONwRHC+lYKSsYSR8s= +github.com/go-playground/locales v0.14.1 h1:EWaQ/wswjilfKLTECiXz7Rh+3BjFhfDFKv/oXslEjJA= +github.com/go-playground/locales v0.14.1/go.mod h1:hxrqLVvrK65+Rwrd5Fc6F2O76J/NuW9t0sjnWqG1slY= +github.com/go-playground/universal-translator v0.18.1 h1:Bcnm0ZwsGyWbCzImXv+pAJnYK9S473LQFuzCbDbfSFY= +github.com/go-playground/universal-translator v0.18.1/go.mod h1:xekY+UJKNuX9WP91TpwSH2VMlDf28Uj24BCp08ZFTUY= +github.com/go-playground/validator/v10 v10.14.0 h1:vgvQWe3XCz3gIeFDm/HnTIbj6UGmg/+t63MyGU2n5js= +github.com/go-playground/validator/v10 v10.14.0/go.mod h1:9iXMNT7sEkjXb0I+enO7QXmzG6QCsPWY4zveKFVRSyU= +github.com/go-sql-driver/mysql v1.6.0 h1:BCTh4TKNUYmOmMUcQ3IipzF5prigylS7XXjEkfCHuOE= +github.com/go-sql-driver/mysql v1.6.0/go.mod h1:DCzpHaOWr8IXmIStZouvnhqoel9Qv2LBy8hT2VhHyBg= +github.com/goccy/go-json v0.10.2 h1:CrxCmQqYDkv1z7lO7Wbh2HN93uovUHgrECaO5ZrCXAU= +github.com/goccy/go-json v0.10.2/go.mod h1:6MelG93GURQebXPDq3khkgXZkazVtN9CRI+MGFi0w8I= +github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk= +github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU= +github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg= +github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I= +github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/jmoiron/sqlx v1.3.5 h1:vFFPA71p1o5gAeqtEAwLU4dnX2napprKtHr7PYIcN3g= +github.com/jmoiron/sqlx v1.3.5/go.mod h1:nRVWtLre0KfCLJvgxzCsLVMogSvQ1zNJtpYr2Ccp0mQ= +github.com/joho/godotenv v1.5.1 h1:7eLL/+HRGLY0ldzfGMeQkb7vMd0as4CfYvUVzLqw0N0= +github.com/joho/godotenv v1.5.1/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4= +github.com/json-iterator/go v1.1.12 h1:PV8peI4a0ysnczrg+LtxykD8LfKY9ML6u2jnxaEnrnM= +github.com/json-iterator/go v1.1.12/go.mod h1:e30LSqwooZae/UwlEbR2852Gd8hjQvJoHmT4TnhNGBo= +github.com/klauspost/cpuid/v2 v2.0.9/go.mod h1:FInQzS24/EEf25PyTYn52gqo7WaD8xa0213Md/qVLRg= +github.com/klauspost/cpuid/v2 v2.2.4 h1:acbojRNwl3o09bUq+yDCtZFc1aiwaAAxtcn8YkZXnvk= +github.com/klauspost/cpuid/v2 v2.2.4/go.mod h1:RVVoqg1df56z8g3pUjL/3lE5UfnlrJX8tyFgg4nqhuY= +github.com/leodido/go-urn v1.2.4 h1:XlAE/cm/ms7TE/VMVoduSpNBoyc2dOxHs5MZSwAN63Q= +github.com/leodido/go-urn v1.2.4/go.mod h1:7ZrI8mTSeBSHl/UaRyKQW1qZeMgak41ANeCNaVckg+4= +github.com/lib/pq v1.2.0/go.mod h1:5WUZQaWbwv1U+lTReE5YruASi9Al49XbQIvNi/34Woo= +github.com/lib/pq v1.10.9 h1:YXG7RB+JIjhP29X+OtkiDnYaXQwpS4JEWq7dtCCRUEw= +github.com/lib/pq v1.10.9/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o= +github.com/mattn/go-isatty v0.0.19 h1:JITubQf0MOLdlGRuRq+jtsDlekdYPia9ZFsB8h/APPA= +github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/mattn/go-sqlite3 v1.14.6 h1:dNPt6NO46WmLVt2DLNpwczCmdV5boIZ6g/tlDrlRUbg= +github.com/mattn/go-sqlite3 v1.14.6/go.mod h1:NyWgC/yNuGj7Q9rpYnZvas74GogHl5/Z4A/KQRfk6bU= +github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= +github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd h1:TRLaZ9cD/w8PVh93nsPXa1VrQ6jlwL5oN8l14QlcNfg= +github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= +github.com/modern-go/reflect2 v1.0.2 h1:xBagoLtFs94CBntxluKeaWgTMpvLxC4ur3nMaC9Gz0M= +github.com/modern-go/reflect2 v1.0.2/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjYzDa0/r8luk= +github.com/pelletier/go-toml/v2 v2.0.8 h1:0ctb6s9mE31h0/lhu+J6OPmVeDxJn+kYnJc2jZR9tGQ= +github.com/pelletier/go-toml/v2 v2.0.8/go.mod h1:vuYfssBdrU2XDZ9bYydBu6t+6a6PYNcZljzZR9VXg+4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= +github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= +github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= +github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= +github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= +github.com/stretchr/testify v1.8.2/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= +github.com/stretchr/testify v1.8.3 h1:RP3t2pwF7cMEbC1dqtB6poj3niw/9gnV4Cjg5oW5gtY= +github.com/stretchr/testify v1.8.3/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= +github.com/twitchyliquid64/golang-asm v0.15.1 h1:SU5vSMR7hnwNxj24w34ZyCi/FmDZTkS4MhqMhdFk5YI= +github.com/twitchyliquid64/golang-asm v0.15.1/go.mod h1:a1lVb/DtPvCB8fslRZhAngC2+aY1QWCk3Cedj/Gdt08= +github.com/ugorji/go/codec v1.2.11 h1:BMaWp1Bb6fHwEtbplGBGJ498wD+LKlNSl25MjdZY4dU= +github.com/ugorji/go/codec v1.2.11/go.mod h1:UNopzCgEMSXjBc6AOMqYvWC1ktqTAfzJZUZgYf6w6lg= +golang.org/x/arch v0.0.0-20210923205945-b76863e36670/go.mod h1:5om86z9Hs0C8fWVUuoMHwpExlXzs5Tkyp9hOrfG7pp8= +golang.org/x/arch v0.3.0 h1:02VY4/ZcO/gBOH6PUaoiptASxtXU10jazRCP865E97k= +golang.org/x/arch v0.3.0/go.mod h1:5om86z9Hs0C8fWVUuoMHwpExlXzs5Tkyp9hOrfG7pp8= +golang.org/x/crypto v0.9.0 h1:LF6fAI+IutBocDJ2OT0Q1g8plpYljMZ4+lty+dsqw3g= +golang.org/x/crypto v0.9.0/go.mod h1:yrmDGqONDYtNj3tH8X9dzUun2m2lzPa9ngI6/RUPGR0= +golang.org/x/net v0.10.0 h1:X2//UzNDwYmtCLn7To6G58Wr6f5ahEAQgKNzv9Y951M= +golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg= +golang.org/x/sys v0.0.0-20220704084225-05e143d24a9e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.8.0 h1:EBmGv8NaZBZTWvrbjNoL6HVt+IVy3QDQpJs7VRIw3tU= +golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/text v0.9.0 h1:2sjJmO8cDvYveuX97RDLsxlyUxLl+GHoLxBiRdHllBE= +golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8= +golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4= +golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw= +google.golang.org/protobuf v1.30.0 h1:kPPoIgf3TsEvrm0PFe15JQ+570QVxYzEvvHqChK+cng= +google.golang.org/protobuf v1.30.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +rsc.io/pdf v0.1.1/go.mod h1:n8OzWcQ6Sp37PL01nO98y4iUCRdTGarVfzxY20ICaU4= diff --git a/main.go b/main.go new file mode 100644 index 0000000..1aef89e --- /dev/null +++ b/main.go @@ -0,0 +1,44 @@ +package main + +import ( + "embed" + "github.com/gin-gonic/gin" + "github.com/joho/godotenv" + "log" + "net/http" + "template/migration" + "time" +) + +//go:embed db/dev/*.sql +var devMigrations embed.FS + +func init() { + godotenv.Load() + log.SetPrefix("") + log.SetFlags(log.Ldate | log.Ltime | log.Lshortfile) +} + +func main() { + client, err := connectToDb() + if err != nil { + log.Fatalf("couldn't connect to db: %v", err) + } + if err := migration.InitializeMigrations(client, devMigrations); err != nil { + log.Fatalf("couldn't execute migrations: %v", err) + } + + g := gin.Default() + + g.NoRoute(func(c *gin.Context) { + c.JSON(http.StatusNotFound, gin.H{"message": "no action on given url", "created": time.Now()}) + }) + g.NoMethod(func(c *gin.Context) { + c.JSON(http.StatusMethodNotAllowed, gin.H{"message": "no action on given method", "created": time.Now()}) + }) + g.GET("/", func(c *gin.Context) { + c.JSON(http.StatusOK, gin.H{"message": "hello world", "created": time.Now()}) + }) + + log.Fatal(http.ListenAndServe(":5281", g)) +} diff --git a/makefile b/makefile new file mode 100644 index 0000000..02434d2 --- /dev/null +++ b/makefile @@ -0,0 +1,33 @@ +# scripts for building app +# requires go 1.19+ and git installed + +VERSION := 0.0.1 + +serve: + go run ./... + +setup: + go get + +docker-dev: + docker image build -t registry.bbr-dev.info/template/backend:$(VERSION)-dev . + docker tag registry.bbr-dev.info/template/backend:$(VERSION)-dev registry.bbr-dev.info/template/backend:latest-dev + docker image push registry.bbr-dev.info/template/backend:$(VERSION)-dev + docker image push registry.bbr-dev.info/template/backend:latest-dev + + +docker-prod: + docker image build -t registry.bbr-dev.info/template/backend:$(VERSION) . + docker tag registry.bbr-dev.info/template/backend:$(VERSION) registry.bbr-dev.info/template/backend:latest + docker image push registry.bbr-dev.info/template/backend:$(VERSION) + docker image push registry.bbr-dev.info/template/backend:latest + +release: + git tag $(VERSION) + git push origin $(VERSION) + +test: + go test ./... + +clean: + rm -rf template diff --git a/migration/migration.go b/migration/migration.go new file mode 100644 index 0000000..64f48de --- /dev/null +++ b/migration/migration.go @@ -0,0 +1,151 @@ +package migration + +import ( + "context" + "crypto/sha256" + "encoding/base64" + "fmt" + "github.com/jmoiron/sqlx" + "io/fs" + "log" + "sort" + "strings" + "time" +) + +const migrationsTable = ` +CREATE TABLE IF NOT EXISTS migration ( + filename varchar, + hash varchar, + created timestamp, + should_validate boolean +);` +const fetchMigrationsTable = `SELECT * FROM "migration";` +const createMigration = `INSERT INTO "migration" (filename, hash, created, should_validate) VALUES ($1, $2, current_timestamp, TRUE);` + +type Migration struct { + Filename string `db:"filename"` + Hash string `db:"hash"` + Created time.Time `db:"created"` + ShouldValidate bool `db:"should_validate"` +} + +func InitializeMigrations(db *sqlx.DB, migrationFiles fs.FS) error { + // create table if it doesn't exist already + if _, err := db.Exec(migrationsTable); err != nil { + return err + } + + // fetch current migrations + var entries []Migration + if err := db.Select(&entries, fetchMigrationsTable); err != nil { + return err + } + + migrations := map[string]Migration{} + for _, entry := range entries { + migrations[entry.Filename] = entry + } + return validateMigrations(db, migrations, migrationFiles) +} + +type version struct { + major int + minor int +} + +func validateMigrations(db *sqlx.DB, migrations map[string]Migration, migrationFiles fs.FS) error { + scripts := map[string]string{} + var scriptNames []string + + // fetch scripts + err := fs.WalkDir(migrationFiles, ".", func(path string, d fs.DirEntry, outerErr error) error { + if !d.IsDir() { + if bytearr, err := fs.ReadFile(migrationFiles, path); err == nil { + scripts[d.Name()] = strings.TrimSpace(string(bytearr)) + scriptNames = append(scriptNames, d.Name()) + } + } + return nil + }) + if err != nil { + return err + } + + // sort scripts by version + sort.Slice(scriptNames, func(i, j int) bool { + return isLessThan(parseVersion(scriptNames[i]), parseVersion(scriptNames[j])) + }) + + for _, name := range scriptNames { + if _, exists := migrations[name]; exists { + if err := validateMigration(name, migrations[name], scripts[name]); err != nil { + return err + } + } else { + if err := executeMigration(db, name, scripts[name]); err != nil { + return err + } + } + } + return nil +} + +func executeMigration(db *sqlx.DB, name string, script string) error { + log.Printf("[INFO] script='%s' | migrations - executing", name) + tx := db.MustBeginTx(context.Background(), nil) + var err error = nil + if _, e := tx.Exec(script); e != nil { + err = e + } + if _, e := tx.Exec(createMigration, name, hash(script)); e != nil { + err = e + } + if err != nil { + log.Printf("[ERROR] script='%s' | migrations - failed executing", name) + tx.Rollback() + } else { + log.Printf("[INFO] script='%s' | migrations - succesfully executed", name) + tx.Commit() + } + return err +} + +func validateMigration(name string, migration Migration, script string) error { + if !migration.ShouldValidate { + return nil + } + + calculatedHash := hash(script) + + if calculatedHash != migration.Hash { + err := fmt.Sprintf("migrations - mismatch in hash for %s (expected '%s', calculated '%s')", name, migration.Hash, calculatedHash) + log.Printf("[ERROR] script='%s' err='%s' | migrations - failed executing", script, err) + return fmt.Errorf("migrations - mismatch in hashes for %s", name) + } + return nil +} + +func hash(script string) string { + hash := sha256.New() + hash.Write([]byte(script)) + return base64.StdEncoding.EncodeToString(hash.Sum(nil)) +} + +func isLessThan(v1 version, v2 version) bool { + if v1.major > v2.major { + return false + } + if v1.major == v2.major && v1.minor > v2.minor { + return false + } + return true +} + +func parseVersion(filename string) version { + ver := version{} + if _, err := fmt.Sscanf(filename, "v%d_%d", &ver.major, &ver.minor); err != nil { + panic(err) + } + return ver +} diff --git a/render.go b/render.go new file mode 100644 index 0000000..2f8a72e --- /dev/null +++ b/render.go @@ -0,0 +1,21 @@ +package main + +import ( + "encoding/json" + "log" + "net/http" +) + +func render[T any](w http.ResponseWriter, r *http.Request, status int, response T) error { + if body, err := json.MarshalIndent(response, "", " "); err == nil { + w.Header().Add("content-type", "application/json") + w.WriteHeader(status) + _, err = w.Write(body) + return err + } else { + w.WriteHeader(http.StatusInternalServerError) + log.Printf("couldn't parse response") + _, err = w.Write([]byte{}) + return err + } +}