Initialize project structure

Signed-off-by: Ali Akca <[email protected]>

Author: aweris

.bingo/.gitignore

@@ -0,0 +1,12 @@
+
+# Ignore everything
+*
+
+# But not these files:
+!.gitignore
+!*.mod
+!README.md
+!Variables.mk
+!variables.env
+
+*tmp.mod

.bingo/README.md

@@ -0,0 +1,13 @@
+# Project Development Dependencies.
+
+This is directory which stores Go modules with pinned buildable package that is used within this repository, managed by https://github.com/bwplotka/bingo.
+
+* Run `bingo get` to install all tools having each own module file in this directory.
+* Run `bingo get <tool>` to install <tool> that have own module file in this directory.
+* For Makefile: Make sure to put `include .bingo/Variables.mk` in your Makefile, then use $(<upper case tool name>) variable where <tool> is the .bingo/<tool>.mod.
+* For shell: Run `source .bingo/variables.env` to source all environment variable for each tool
+* See https://github.com/bwplotka/bingo or -h on how to add, remove or change binaries dependencies.
+
+## Requirements
+
+* Go 1.14+

.bingo/Variables.mk

@@ -0,0 +1,24 @@
+# Auto generated binary variables helper managed by https://github.com/bwplotka/bingo v0.2.2. DO NOT EDIT.
+# All tools are designed to be build inside $GOBIN.
+GOPATH ?= $(shell go env GOPATH)
+GOBIN  ?= $(firstword $(subst :, ,${GOPATH}))/bin
+GO     ?= $(shell which go)
+
+# Bellow generated variables ensure that every time a tool under each variable is invoked, the correct version
+# will be used; reinstalling only if needed.
+# For example for golangci-lint variable:
+#
+# In your main Makefile (for non array binaries):
+#
+#include .bingo/Variables.mk # Assuming -dir was set to .bingo .
+#
+#command: $(GOLANGCI_LINT)
+#	@echo "Running golangci-lint"
+#	@$(GOLANGCI_LINT) <flags/args..>
+#
+GOLANGCI_LINT := $(GOBIN)/golangci-lint-v1.32.0
+$(GOLANGCI_LINT): .bingo/golangci-lint.mod
+	@# Install binary/ries using Go 1.14+ build command. This is using bwplotka/bingo-controlled, separate go module with pinned dependencies.
+	@echo "(re)installing $(GOBIN)/golangci-lint-v1.32.0"
+	@cd .bingo && $(GO) build -modfile=golangci-lint.mod -o=$(GOBIN)/golangci-lint-v1.32.0 "github.com/golangci/golangci-lint/cmd/golangci-lint"
+

.bingo/go.mod

@@ -0,0 +1 @@
+module _ // Fake go.mod auto-created by 'bingo' for go -moddir compatibility with non-Go projects. Commit this file, together with other .mod files.

.bingo/golangci-lint.mod

@@ -0,0 +1,5 @@
+module _ // Auto generated by https://github.com/bwplotka/bingo. DO NOT EDIT
+
+go 1.15
+
+require github.com/golangci/golangci-lint v1.32.0 // cmd/golangci-lint

.bingo/variables.env

@@ -0,0 +1,12 @@
+# Auto generated binary variables helper managed by https://github.com/bwplotka/bingo v0.2.2. DO NOT EDIT.
+# All tools are designed to be build inside $GOBIN.
+# Those variables will work only until 'bingo get' was invoked, or if tools were installed via Makefile's Variables.mk.
+local gobin=$(go env GOBIN)
+
+if [ -z "$gobin" ]; then
+	gobin="$(go env GOPATH)/bin"
+fi
+
+
+GOLANGCI_LINT="${gobin}/golangci-lint-v1.32.0"
+

.gitignore

@@ -0,0 +1,7 @@
+# Project Directories
+vendor/
+build/
+
+# IDE
+.idea/
+.run/

.golangci.yml

@@ -0,0 +1,17 @@
+run:
+  # default concurrency is a available CPU number
+  concurrency: 4
+  # timeout for analysis, e.g. 30s, 5m, default is 1m
+  deadline: 3m
+  tests: true
+
+linters:
+  disable:
+    - exhaustivestruct
+
+linters-settings:
+  lll:
+    line-length: 160
+  funlen:
+    lines: 110
+    statements: 60

Makefile

@@ -0,0 +1,14 @@
+# Project directories
+ROOT_DIR := $(CURDIR)
+
+# Helper variables
+V = 0
+Q = $(if $(filter 1,$V),,@)
+M = $(shell printf "\033[34;1m▶\033[0m")
+
+# External targets
+include .bingo/Variables.mk
+include scripts/make/help.mk
+include scripts/make/lint.mk
+include scripts/make/build.mk
+include scripts/make/test.mk

README.md

@@ -1,2 +1,41 @@
-# postgres-data-dump
-Tool for dumping a sample of data from PostgreSQL
+# Postgres Data Dump
+
+This is a simple tool for dumping a sample of data from a PostgreSQL database.
+The resulting dump can be loaded back into the new database using standard tools
+(e.g. `psql(1)`). The original project belongs to: [dankeder/pg_dump_sample](https://github.com/dankeder/pg_dump_sample)
+
+## Why would I want this?
+
+It is useful if you have a huge PostgreSQL database, and you need a
+database with a small dataset for testing or development.
+
+## Usage
+
+### CLI
+
+```
+Usage of pdd:
+      --log-format string   log format to use. ('fmt', 'json') (default "fmt")
+      --log-level string    log filtering level. ('error', 'warn', 'info', 'debug') (default "error")
+  -v, --verbose             verbose output
+      --version             Prints version info
+```
+
+## Development 
+
+```
+
+Usage:
+  make <target>
+
+Targets:
+  help                    shows this help message
+  fix                     Fix found issues (if it's supported by the $(GOLANGCI_LINT))
+  fmt                     Runs gofmt
+  lint                    Runs golangci-lint analysis
+  clean                   Cleanup everything
+  vendor                  Updates vendored copy of dependencies
+  build                   Builds binary
+  version                 Shows application version
+  test                    Runs go test
+```

cmd/main.go

@@ -0,0 +1,85 @@
+package main
+
+import (
+	syslog "log"
+	"os"
+
+	"github.com/aweris/postgres-data-dump/internal/log"
+	"github.com/spf13/pflag"
+)
+
+// Version represents the software version of the
+// nolint:gochecknoglobals
+var (
+	version = "dev"
+	commit  = "none"
+	date    = "unknown"
+)
+
+func main() {
+	var (
+		// logging
+		logLevel  string
+		logFormat string
+		verbose   bool
+
+		// other
+		showVersion bool
+	)
+
+	flag := pflag.NewFlagSet("defaults", pflag.ExitOnError)
+
+	// no need to sort flags in help
+	flag.SortFlags = false
+
+	// logging flags
+	flag.StringVar(&logLevel, "log-level", log.LevelError, "log filtering level. ('error', 'warn', 'info', 'debug')")
+	flag.StringVar(&logFormat, "log-format", log.FormatFmt, "log format to use. ('fmt', 'json')")
+	flag.BoolVarP(&verbose, "verbose", "v", false, "verbose output")
+
+	// other flags
+	flag.BoolVar(&showVersion, "version", false, "Prints version info")
+
+	// bind environment variables
+	bindEnv(flag.Lookup("log-level"), "PDD_LOG_LEVEL")
+	bindEnv(flag.Lookup("log-format"), "PDD_LOG_FORMAT")
+
+	// Parse Options
+	if err := flag.Parse(os.Args); err != nil {
+		syslog.Fatalf("%#v", err)
+	}
+
+	// print application version
+	if showVersion {
+		syslog.Printf("Version    : %s\n", version)
+		syslog.Printf("Git Commit : %s\n", commit)
+		syslog.Printf("Build Date : %s\n", date)
+		os.Exit(0)
+	}
+
+	// Enable log level debug for verbose
+	if verbose {
+		logLevel = log.LevelDebug
+	}
+
+	logger, err := log.NewLogger(logLevel, logFormat, "pdd")
+	if err != nil {
+		syslog.Fatalf("%#v", err)
+	}
+
+	logger.Debug("version", version, "git commit", commit, "build date", date)
+}
+
+func bindEnv(fn *pflag.Flag, env string) {
+	if fn == nil || fn.Changed {
+		return
+	}
+
+	val := os.Getenv(env)
+
+	if len(val) > 0 {
+		if err := fn.Value.Set(val); err != nil {
+			syslog.Fatalf("failed to bind env: %v\n", err)
+		}
+	}
+}

go.mod

@@ -0,0 +1,8 @@
+module github.com/aweris/postgres-data-dump
+
+go 1.15
+
+require (
+	github.com/go-kit/kit v0.10.0
+	github.com/spf13/pflag v1.0.5
+)