Docker containerizing (#41)

* add actoins, dockerfile, golangci

* 👷 try build and push

* 💡 suggestions to readme

* Fixing Typo

Co-authored-by: Artem <[email protected]>

* 👷 add volume instruction to dockerfile

Co-authored-by: Faisal Ali <[email protected]>

Author: art-frela

.dockerignore

@@ -0,0 +1,3 @@
+build.sh
+LICENSE
+*.md

.github/workflows/ci.yml

@@ -0,0 +1,68 @@
+name: CI
+on:
+  push:
+    branches:
+      - main
+      - master
+      - docker-containerizing # for test, remove after pass
+jobs:
+  tests:
+    strategy:
+      matrix:
+        go-version: [1.16.x]
+        os: [ubuntu-latest, macos-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Install Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: ${{ matrix.go-version }}
+
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Restore Cache
+        uses: actions/cache@v2
+        with:
+          path: ~/go/pkg/mod
+          key: ${{ runner.os }}-v1-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-v1-go-
+      - name: Test
+        run: go test ./... -race -cover
+
+  codecov:
+    needs: tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 2
+      - uses: actions/setup-go@v2
+        with:
+          go-version: '1.16'
+      - name: Run coverage
+        run: go test -coverprofile=coverage.txt -covermode=atomic ./...
+      - name: Upload coverage to Codecov
+        run: bash <(curl -s https://codecov.io/bash)
+
+  push_to_registry:
+    needs: [tests]
+    name: Push docker image to GitHub Container Registry
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v2
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v1
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.CR_PAT }}
+      - name: Push to GitHub Packages
+        uses: docker/build-push-action@v2
+        with:
+          push: true
+          context: .
+          file: ./build/Dockerfile
+          tags: ghcr.io/art-frela/mock-data:latest

.github/workflows/test.yml

@@ -0,0 +1,31 @@
+name: unit tests
+on:
+  push:
+    branches-ignore:
+      - main
+      - master
+jobs:
+  tests:
+    strategy:
+      matrix:
+        go-version: [1.15.x, 1.16.x]
+        os: [ubuntu-latest, macos-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Install Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: ${{ matrix.go-version }}
+
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Restore Cache
+        uses: actions/cache@v2
+        with:
+          path: ~/go/pkg/mod
+          key: ${{ runner.os }}-v1-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-v1-go-
+      - name: Test
+        run: go test ./... -race -cover

.golangci.yml

@@ -0,0 +1,99 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+run:
+  # default: '1m'
+  timeout: '5m'
+
+  # default: []
+  build-tags:
+  - 'all'
+
+  # default: []
+  skip-dirs:
+  - 'build'
+
+  # which files to skip: they will be analyzed, but issues from them
+  # won't be reported. Default value is empty list, but there is
+  # no need to include all autogenerated files, we confidently recognize
+  # autogenerated files. If it's not please let us know.
+  skip-files:
+    - "_easyjson.go"
+    - "_test.go"
+
+  # default: true
+  skip-dirs-use-default: false
+
+  # default: ''
+  modules-download-mode: 'readonly'
+
+  # default: false
+  allow-parallel-runners: true
+
+linters:
+  enable:
+  - 'asciicheck'
+  - 'bodyclose'
+  - 'deadcode'
+  - 'depguard'
+  - 'dogsled'
+  - 'errcheck'
+  - 'errorlint'
+  - 'exportloopref'
+  - 'gofmt'
+  - 'goheader'
+  - 'goimports'
+  - 'golint'
+  - 'gomodguard'
+  - 'goprintffuncname'
+  - 'gosec'
+  - 'gosimple'
+  - 'govet'
+  - 'ineffassign'
+  - 'makezero'
+  - 'misspell'
+  - 'noctx'
+  - 'paralleltest'
+  - 'prealloc'
+  - 'predeclared'
+  - 'scopelint'
+  - 'sqlclosecheck'
+  - 'staticcheck'
+  - 'structcheck'
+  - 'stylecheck'
+  - 'typecheck'
+  - 'unconvert'
+  - 'unused'
+  - 'varcheck'
+  - 'whitespace'
+
+issues:
+  # default: []
+  exclude:
+  - '^S1023:' # staticcheck: redundant returns help with http handlers
+  - '^SA3000:' # staticcheck: not required in Go 11.4+
+  - '^G102:' # gosec: we have to bind to all ifaces
+  - '^G402:' # gosec: some services terminate at the load balancer
+  - '^G505:' # gosec: we use crypto/sha1 for some HMACs
+  - '^Range statement' # paralleltest: false positives
+
+  # default: 50
+  max-issues-per-linter: 0
+
+  # default: 3
+  max-same-issues: 0
+
+severity:
+  # default: ''
+  default-severity: error

Makefile

@@ -0,0 +1,13 @@
+IMAGE = "mock:latest"
+
+# h - help
+h help:
+	@echo "h help 	- this help"
+	@echo "docker 	- run docker image build"
+.PHONY: h
+
+
+# docker build
+docker:
+	docker build -f ./build/Dockerfile -t $(IMAGE) .
+.PHONY: docker

README.md

@@ -22,7 +22,8 @@ However, please **DO MAKE SURE TO TAKE A BACKUP** of your database before you mo
 
 Check on the "Known Issues" section below for more information about current identified bugs.
 
-# Table of Contents
+## Table of Contents
+
    * [Important information and disclaimer](#important-information-and-disclaimer)
    * [Supported database engines & data types](#supported-database-engines--data-types)
         * [Database Engine](#database-engine)
@@ -36,11 +37,11 @@ Check on the "Known Issues" section below for more information about current ide
    * [License](#license)
    * [Authors](#authors)
 
-# Important information and disclaimer
+## Important information and disclaimer
 
 Mock-data idea is to generate fake data in new test cluster and it is **NOT TO BE USED IN PRODUCTION ENVIRONMENTS**. Please ensure you have a backup of your database before running Mock-data in an environment you can't afford losing.
 
-# Supported database engines & data types
+## Supported database engines & data types
 
 ### Database Engine
 + PostgresSQL
@@ -51,7 +52,7 @@ Mock-data idea is to generate fake data in new test cluster and it is **NOT TO B
 + All datatypes that are listed on the [postgres datatype](https://www.postgresql.org/docs/9.6/static/datatype.html) website are supported
 + As Greenplum are both base from postgres, the supported postgres datatype also apply in their case
 
-# How it works
+## How it works
 
 + PARSES the CLI arguments
 + CHECKS if the database connection can be established
@@ -66,7 +67,8 @@ Mock-data idea is to generate fake data in new test cluster and it is **NOT TO B
 + CHECK constraints are ignored (coming soon?)
 + LOADS constraints that it had backed up (Mock-data can fail at this stage if its not able to fix the constraint violations)
 
-# Usage
+## Usage
+
 ```
 $ mock --help
 This program generates fake data into a postgres database cluster. 
@@ -100,7 +102,7 @@ Flags:
 Use "mock [command] --help" for more information about a command.
 ```
 
-# Installation
+## Installation
 
 [Download](https://github.com/pivotal/mock-data/releases/latest) the latest release for your OS & Architecture and you're ready to go!
 
@@ -114,7 +116,7 @@ chmod +x /usr/local/bin/mock
 
 provided `/usr/local/bin` is part of the $PATH environment variable.
 
-# Examples
+## Examples
 
 Here is a simple demo of how the tool works, provide us your table and we will load the data for you
 
@@ -129,15 +131,15 @@ For more examples how to use the tool, please check out the [wiki](https://githu
 * Read this section on how the subcommand [tables](https://github.com/pivotal-legacy/mock-data/wiki/Sub-command:-Tables) works
 
 
-# Known Issues
+## Known Issues
 
 1. We do struggle when recreating constraints, even though we do try to fix the primary key , foreign key, unique key. So there is no guarantee that the tool will fix all the constraints and manual intervention is needed in some cases.
 2. If you have a composite unique index where one column is part of foreign key column then there are chances the constraint creation would fail.
 3. Fixing CHECK constraints isn't supported due to complexity, so recreating check constraints would fail, use `custom` subcommand to control the data being inserted
 4. On Greenplum Database partition tables are not supported (due to check constraint issues defined above), so use the `custom` sub command to define the data to be inserted to the column with check constraints
 5. Custom data types are not supported, use `custom` sub command to control the data for that custom data types
 
-# Developers / Collaboration
+## Developers / Collaboration
 
 You can sumbit issues or pull request via [github](https://github.com/pivotal/mock-data) and we will try our best to fix them.
 
@@ -170,10 +172,10 @@ To customize this repository, follow the steps
     /bin/sh build.sh
     ```
 
-# License
+## License
 
 The Project is licensed under [MIT](https://github.com/pivotal-legacy/mock-data/blob/master/LICENSE)
 
-# Authors
+## Authors
 
 [![Ignacio](https://img.shields.io/badge/github-Ignacio_Elizaga-green.svg?style=social)](https://github.com/ielizaga) [![Aitor](https://img.shields.io/badge/github-Aitor_Cedres-green.svg?style=social)](https://github.com/Zerpet) [![Juan](https://img.shields.io/badge/github-Juan_Ramos-green.svg?style=social)](https://github.com/jujoramos) [![Faisal](https://img.shields.io/badge/github-Faisal_Ali-green.svg?style=social)](https://github.com/faisaltheparttimecoder) [![Adam](https://img.shields.io/badge/github-Adam_Clevy-green.svg?style=social)](https://github.com/adamclevy)

build/Dockerfile

@@ -0,0 +1,37 @@
+############################
+# STEP 0 get dependencies
+############################
+FROM golang:1.16.5 AS dependencies
+WORKDIR /go/src
+COPY go.mod .
+COPY go.sum .
+RUN go mod download
+############################
+# STEP 1 build executable binary
+############################
+FROM dependencies AS builder
+##
+ENV GO111MODULE=on \
+  CGO_ENABLED=0 \
+  GOOS=linux \
+  GOARCH=amd64
+
+WORKDIR /go/src
+COPY . .
+##
+RUN go build -o /bin/mock .
+############################
+# STEP 2 build a small image
+############################
+FROM alpine:3.12
+
+RUN addgroup -S mock; \
+    adduser -S mock -G mock -D -u 10000 -h /home/mock -s /bin/nologin; \
+    chown -R mock:mock /home/mock
+COPY --from=builder /bin/mock /usr/bin/mock
+VOLUME [ "/home/mock" ]
+
+USER 10000
+
+ENTRYPOINT [ "mock" ]
+CMD ["--help"]

cmd.go

@@ -2,6 +2,7 @@ package main
 
 import (
 	"fmt"
+
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
@@ -125,7 +126,7 @@ var tablesCmd = &cobra.Command{
 		}
 		// either create fake tables or insert mock table rows are allowed, not together
 		if cmdOptions.Tab.FakeNewTables && !IsStringEmpty(cmdOptions.Tab.FakeTablesRows) {
-			Fatalf("Cannot perform create table & mock tables together, choose one", programName)
+			Fatal("Cannot perform create table & mock tables together, choose one")
 		}
 		// if there is request for new tables and no of tables parameter is below 1 then error out
 		if cmdOptions.Tab.FakeNewTables && cmdOptions.Tab.TotalTables < 1 {
@@ -194,7 +195,7 @@ var customCmd = &cobra.Command{
 		}
 		// If both is set
 		if !IsStringEmpty(cmdOptions.Tab.FakeTablesRows) && !IsStringEmpty(cmdOptions.File) {
-			Fatalf("Cannot run the table and loading of data via file together, choose one", programName)
+			Fatalf("Cannot run the table and loading of data via file together, choose one")
 		}
 	},
 	Run: func(cmd *cobra.Command, args []string) {