gullerya / db-setup-action

GitHub Action to automate local DB setup (Docker based)

DB Setup action

db-setup-action automates setup of the chosen DB (Docker based, on host machine).

Currently supported (in alphabetical order):

• MariaDB
• MySQL
• PostgreSQL
• SQLServer

Installation uses official Docker images, see the links in per-DB sections below.

Purpose of this action:

• provide an easy and maximum possibly uniform setup of the DB server/s for tests automation
• enable relevant extensibility for the outstanders
• ensure the safest / best-practice defaults OOTB

Attention: please review legal information links in per-DB sections below to ensure correct images usage.

Inputs

Key	Description
image	the exact Docker image per DB (see the lists below, under each supported DB section)
port	port of your choice, that your application will be connecting to the DB through
username	sets up DB's admin username
password	sets up DB's admin password
database	database name, that will be created for your application's use

Attention: please review the per-DB sections below for any specifics or deviations of each.

---

MariaDB

Legal

Images/tags list

Usage example

name: Setup local MariaDB
uses: gullerya/db-setup-action@v1.1.0
with:
  image: 'mariadb:latest'
  port: 3306
  username: mariadbuser
  password: mariadbpass
  database: testdb

Specific remarks

MariaDB provides a superuser OOTB, root. I've deliberately decided to NOT allow to use it, setting it's password to a random value. Please, let me know if this is limiting a usage of the MariaDB essentially and should be reconsidered.

---

MySQL

Legal

Images/tags list

Usage example

name: Setup local MySQL
uses: gullerya/db-setup-action@v1.1.0
with:
  image: 'mysql:latest'
  port: 3306
  username: mysqluser
  password: mysqlpass
  database: testdb

Specific remarks

MySQL provides a superuser OOTB, root. I've deliberately decided to NOT allow to use it, setting it's password to a random value. Please, let me know if this is limiting a usage of the MySQL essentially and should be reconsidered.

---

PostgreSQL

Legal

Images/tags list

Usage example

name: Setup local PostgreSQL
uses: gullerya/db-setup-action@v1.1.0
with:
  image: 'postgres:alpine'
  port: 5432
  username: postgres
  password: postgres
  database: testdb

---

SQLServer

Legal - see the License section at the bottom

Images/tags list.

Usage example

name: Setup SQLServer
uses: gullerya/db-setup-action@v1.1.0
env:
  ACCEPT_EULA: 'Y'
with:
  image: 'mcr.microsoft.com/mssql/server:2019-latest'
  port: 1433
  username: sa
  password: Passw0rd
  database: testdb

Specific remarks

In case of SQLServer please pay attention to the following:

• you MUST set environment variable ACCEPT_EULA=Y to express your awareness of it
• SQLServer is explicitly and deliberately set up as 'Developer' edition, see more in the Legal link above
• the username MUST be sa
• the password MUST meet strength requirements as per this documentation (scroll to the SA_PASSWORD section)

Note: while the password strength may lead to use some special characters, it is better to avoid chars like $, @ since they may cause misinterpretation issues during the docker execution. Let me know of any issue encounterd with this.