diff --git a/.github/workflows/ci.yml b/.github/workflows/test.yml similarity index 98% rename from .github/workflows/ci.yml rename to .github/workflows/test.yml index d25424c..5fed575 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/test.yml @@ -1,7 +1,7 @@ # This workflow will build a golang project # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go - name: ci-test + name: Run unit tests on: push: diff --git a/Dockerfile b/Dockerfile index 87de486..8e3e14a 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,14 +1,24 @@ -#Build stage -FROM golang:1.22.2-alpine3.19 AS builder +# Build stage +FROM golang:1.22-alpine3.19 AS builder WORKDIR /app COPY . . RUN go build -o main main.go +RUN apk add curl +RUN curl -L https://github.com/golang-migrate/migrate/releases/download/v4.17.0/migrate.linux-amd64.tar.gz | tar xvz -#Run stage + +# Run stage FROM alpine:3.19 WORKDIR /app COPY --from=builder /app/main . +COPY --from=builder /app/migrate ./migrate COPY app.env . +COPY start.sh . +COPY db/migration ./migration + +EXPOSE 8082 + +CMD set -e && echo "Running database migration..." && /app/migrate -path /app/migration -database "$DB_SOURCE" -verbose up && echo "Database migration complete." && /app/main +# CMD [ "/app/main" ] +# ENTRYPOINT [ "/app/start.sh" ] -EXPOSE 8081 -CMD [ "/app/main" ] diff --git a/README.md b/README.md index 359c7b3..15a94cc 100644 --- a/README.md +++ b/README.md @@ -1,196 +1 @@ -[![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/golang-migrate/migrate/ci.yaml?branch=master)](https://github.com/golang-migrate/migrate/actions/workflows/ci.yaml?query=branch%3Amaster) -[![GoDoc](https://pkg.go.dev/badge/github.com/golang-migrate/migrate)](https://pkg.go.dev/github.com/golang-migrate/migrate/v4) -[![Coverage Status](https://img.shields.io/coveralls/github/golang-migrate/migrate/master.svg)](https://coveralls.io/github/golang-migrate/migrate?branch=master) -[![packagecloud.io](https://img.shields.io/badge/deb-packagecloud.io-844fec.svg)](https://packagecloud.io/golang-migrate/migrate?filter=debs) -[![Docker Pulls](https://img.shields.io/docker/pulls/migrate/migrate.svg)](https://hub.docker.com/r/migrate/migrate/) -![Supported Go Versions](https://img.shields.io/badge/Go-1.20%2C%201.21-lightgrey.svg) -[![GitHub Release](https://img.shields.io/github/release/golang-migrate/migrate.svg)](https://github.com/golang-migrate/migrate/releases) -[![Go Report Card](https://goreportcard.com/badge/github.com/golang-migrate/migrate/v4)](https://goreportcard.com/report/github.com/golang-migrate/migrate/v4) - -# migrate - -__Database migrations written in Go. Use as [CLI](#cli-usage) or import as [library](#use-in-your-go-project).__ - -* Migrate reads migrations from [sources](#migration-sources) - and applies them in correct order to a [database](#databases). -* Drivers are "dumb", migrate glues everything together and makes sure the logic is bulletproof. - (Keeps the drivers lightweight, too.) -* Database drivers don't assume things or try to correct user input. When in doubt, fail. - -Forked from [mattes/migrate](https://github.com/mattes/migrate) - -## Databases - -Database drivers run migrations. [Add a new database?](database/driver.go) - -* [PostgreSQL](database/postgres) -* [PGX v4](database/pgx) -* [PGX v5](database/pgx/v5) -* [Redshift](database/redshift) -* [Ql](database/ql) -* [Cassandra / ScyllaDB](database/cassandra) -* [SQLite](database/sqlite) -* [SQLite3](database/sqlite3) ([todo #165](https://github.com/mattes/migrate/issues/165)) -* [SQLCipher](database/sqlcipher) -* [MySQL / MariaDB](database/mysql) -* [Neo4j](database/neo4j) -* [MongoDB](database/mongodb) -* [CrateDB](database/crate) ([todo #170](https://github.com/mattes/migrate/issues/170)) -* [Shell](database/shell) ([todo #171](https://github.com/mattes/migrate/issues/171)) -* [Google Cloud Spanner](database/spanner) -* [CockroachDB](database/cockroachdb) -* [YugabyteDB](database/yugabytedb) -* [ClickHouse](database/clickhouse) -* [Firebird](database/firebird) -* [MS SQL Server](database/sqlserver) -* [RQLite](database/rqlite) - -### Database URLs - -Database connection strings are specified via URLs. The URL format is driver dependent but generally has the form: `dbdriver://username:password@host:port/dbname?param1=true¶m2=false` - -Any [reserved URL characters](https://en.wikipedia.org/wiki/Percent-encoding#Percent-encoding_reserved_characters) need to be escaped. Note, the `%` character also [needs to be escaped](https://en.wikipedia.org/wiki/Percent-encoding#Percent-encoding_the_percent_character) - -Explicitly, the following characters need to be escaped: -`!`, `#`, `$`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `:`, `;`, `=`, `?`, `@`, `[`, `]` - -It's easiest to always run the URL parts of your DB connection URL (e.g. username, password, etc) through an URL encoder. See the example Python snippets below: - -```bash -$ python3 -c 'import urllib.parse; print(urllib.parse.quote(input("String to encode: "), ""))' -String to encode: FAKEpassword!#$%&'()*+,/:;=?@[] -FAKEpassword%21%23%24%25%26%27%28%29%2A%2B%2C%2F%3A%3B%3D%3F%40%5B%5D -$ python2 -c 'import urllib; print urllib.quote(raw_input("String to encode: "), "")' -String to encode: FAKEpassword!#$%&'()*+,/:;=?@[] -FAKEpassword%21%23%24%25%26%27%28%29%2A%2B%2C%2F%3A%3B%3D%3F%40%5B%5D -$ -``` - -## Migration Sources - -Source drivers read migrations from local or remote sources. [Add a new source?](source/driver.go) - -* [Filesystem](source/file) - read from filesystem -* [io/fs](source/iofs) - read from a Go [io/fs](https://pkg.go.dev/io/fs#FS) -* [Go-Bindata](source/go_bindata) - read from embedded binary data ([jteeuwen/go-bindata](https://github.com/jteeuwen/go-bindata)) -* [pkger](source/pkger) - read from embedded binary data ([markbates/pkger](https://github.com/markbates/pkger)) -* [GitHub](source/github) - read from remote GitHub repositories -* [GitHub Enterprise](source/github_ee) - read from remote GitHub Enterprise repositories -* [Bitbucket](source/bitbucket) - read from remote Bitbucket repositories -* [Gitlab](source/gitlab) - read from remote Gitlab repositories -* [AWS S3](source/aws_s3) - read from Amazon Web Services S3 -* [Google Cloud Storage](source/google_cloud_storage) - read from Google Cloud Platform Storage - -## CLI usage - -* Simple wrapper around this library. -* Handles ctrl+c (SIGINT) gracefully. -* No config search paths, no config files, no magic ENV var injections. - -__[CLI Documentation](cmd/migrate)__ - -### Basic usage - -```bash -$ migrate -source file://path/to/migrations -database postgres://localhost:5432/database up 2 -``` - -### Docker usage - -```bash -$ docker run -v {{ migration dir }}:/migrations --network host migrate/migrate - -path=/migrations/ -database postgres://localhost:5432/database up 2 -``` - -## Use in your Go project - -* API is stable and frozen for this release (v3 & v4). -* Uses [Go modules](https://golang.org/cmd/go/#hdr-Modules__module_versions__and_more) to manage dependencies. -* To help prevent database corruptions, it supports graceful stops via `GracefulStop chan bool`. -* Bring your own logger. -* Uses `io.Reader` streams internally for low memory overhead. -* Thread-safe and no goroutine leaks. - -__[Go Documentation](https://pkg.go.dev/github.com/golang-migrate/migrate/v4)__ - -```go -import ( - "github.com/golang-migrate/migrate/v4" - _ "github.com/golang-migrate/migrate/v4/database/postgres" - _ "github.com/golang-migrate/migrate/v4/source/github" -) - -func main() { - m, err := migrate.New( - "github://mattes:personal-access-token@mattes/migrate_test", - "postgres://localhost:5432/database?sslmode=enable") - m.Steps(2) -} -``` - -Want to use an existing database client? - -```go -import ( - "database/sql" - _ "github.com/lib/pq" - "github.com/golang-migrate/migrate/v4" - "github.com/golang-migrate/migrate/v4/database/postgres" - _ "github.com/golang-migrate/migrate/v4/source/file" -) - -func main() { - db, err := sql.Open("postgres", "postgres://localhost:5432/database?sslmode=enable") - driver, err := postgres.WithInstance(db, &postgres.Config{}) - m, err := migrate.NewWithDatabaseInstance( - "file:///migrations", - "postgres", driver) - m.Up() // or m.Step(2) if you want to explicitly set the number of migrations to run -} -``` - -## Getting started - -Go to [getting started](GETTING_STARTED.md) - -## Tutorials - -* [CockroachDB](database/cockroachdb/TUTORIAL.md) -* [PostgreSQL](database/postgres/TUTORIAL.md) - -(more tutorials to come) - -## Migration files - -Each migration has an up and down migration. [Why?](FAQ.md#why-two-separate-files-up-and-down-for-a-migration) - -```bash -1481574547_create_users_table.up.sql -1481574547_create_users_table.down.sql -``` - -[Best practices: How to write migrations.](MIGRATIONS.md) - -## Coming from another db migration tool? - -Check out [migradaptor](https://github.com/musinit/migradaptor/). -*Note: migradaptor is not affliated or supported by this project* - -## Versions - -Version | Supported? | Import | Notes ---------|------------|--------|------ -**master** | :white_check_mark: | `import "github.com/golang-migrate/migrate/v4"` | New features and bug fixes arrive here first | -**v4** | :white_check_mark: | `import "github.com/golang-migrate/migrate/v4"` | Used for stable releases | -**v3** | :x: | `import "github.com/golang-migrate/migrate"` (with package manager) or `import "gopkg.in/golang-migrate/migrate.v3"` (not recommended) | **DO NOT USE** - No longer supported | - -## Development and Contributing - -Yes, please! [`Makefile`](Makefile) is your friend, -read the [development guide](CONTRIBUTING.md). - -Also have a look at the [FAQ](FAQ.md). - ---- - -Looking for alternatives? [https://awesome-go.com/#database](https://awesome-go.com/#database). +This is a project from a tutorial by Tech School on [Youtube](https://www.youtube.com/@TECHSCHOOLGURU/featured) \ No newline at end of file diff --git a/app.env b/app.env index cd728a0..5d0a095 100644 --- a/app.env +++ b/app.env @@ -1,5 +1,5 @@ DB_DRIVER=postgres DB_SOURCE=postgresql://root:secret@localhost:5432/bank?sslmode=disable -SERVER_ADDRESS=0.0.0.0:8081 +SERVER_ADDRESS=0.0.0.0:8082 TOKEN_SYMMETRIC_KEY=29843756489082426576321435987654 ACCESS_TOKEN_DURATION=15m \ No newline at end of file diff --git a/docker-compose.yaml b/docker-compose.yaml new file mode 100644 index 0000000..5a52c90 --- /dev/null +++ b/docker-compose.yaml @@ -0,0 +1,27 @@ +version: "3.9" +services: + postgres: + image: postgres:16.2 + restart: always + environment: + - POSTGRES_USER=root + - POSTGRES_PASSWORD=secret + - POSTGRES_DB=bank + - DB_SOURCE=postgresql://root:secret@postgres:5432/bank?sslmode=disable + healthcheck: + test: ["CMD-SHELL", "pg_isready -d bank"] + interval: 5s + timeout: 5s + retries: 5 + api: + build: + context: . + dockerfile: Dockerfile + ports: + - "8082:8082" + environment: + - DB_SOURCE=postgresql://root:secret@postgres:5432/bank?sslmode=disable + - GIN_MODE=release + depends_on: + postgres: + condition: service_healthy \ No newline at end of file diff --git a/start.sh b/start.sh new file mode 100755 index 0000000..e26f85c --- /dev/null +++ b/start.sh @@ -0,0 +1,8 @@ +#!/bin/sh +set -e + +echo "run db migration" +/app/migrate -path /app/migration "$DB_SOURCE" -verbose up + +echo "start the app" +exec "$@" \ No newline at end of file diff --git a/utils/config.go b/utils/config.go index cfa3d6f..9fada27 100644 --- a/utils/config.go +++ b/utils/config.go @@ -1,8 +1,9 @@ package utils import ( - "github.com/spf13/viper" "time" + + "github.com/spf13/viper" ) // Config store all configuration of the application