Open platform to collect and prioritize feedback
refactor: replace Make with Mage (#534)
Guilherme Oenning587adbe287c7
diff --git a/.circleci/config.yml b/.circleci/config.ymlindex a30f5e72a..10437cc87 100644--- a/.circleci/config.yml+++ b/.circleci/config.yml@@ -1,7 +1,7 @@version: 2references:builder: &builder- getfider/circleci:0.0.12+ getfider/circleci:0.0.13workdir: &workdir/go/src/github.com/getfider/fider@@ -33,10 +33,9 @@ jobs:- restore_cache:keys:- fider-v1-npm-{{ checksum "package-lock.json" }}- - run: make lint- - run: CGO_ENABLED=0 GOOS=linux GOARCH=amd64 make build+ - run: mage lint- setup_remote_docker- - run: docker build -t getfider/fider .+ - run: mage build:docker- run: docker save -o ./docker-image.tar getfider/fider- persist_to_workspace:root: ./@@ -70,7 +69,7 @@ jobs:name: testcommand: |mkdir ./dist- DATABASE_URL=postgres://fider_ci:fider_ci_pw@localhost:5432/fider_ci?sslmode=disable make coverage+ DATABASE_URL=postgres://fider_ci:fider_ci_pw@localhost:5432/fider_ci?sslmode=disable mage test:coveragebash <(curl -s https://codecov.io/bash)test-ui:@@ -84,7 +83,7 @@ jobs:- fider-v1-npm-{{ checksum "package-lock.json" }}- run:name: test- command: make test-ui+ command: mage test:uipush:docker:diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdindex 31f746708..202963732 100644--- a/CONTRIBUTING.md+++ b/CONTRIBUTING.md@@ -20,7 +20,12 @@ Install the following tools:- Go 1.10+ (https://golang.org/)- Node.js 10+ (https://nodejs.org/)- Docker (https://www.docker.com/)++We also use the following Go CLI tools, so install them using `go get <url>`:+- cosmtrek/air (https://github.com/cosmtrek/air/)+- joho/godotenv (https://github.com/joho/godotenv/)+- magefile/mage (https://github.com/magefile/mage/)To setup your development workspace:@@ -28,10 +33,12 @@ To setup your development workspace:2) run `npm install` to install front end packages3) run `docker-compose up -d pgdev` to start a local PostgreSQL database on Docker.4) run `cp .example.env .env` to create a local environment configuration file.-5) run `make watch` to start the application.+5) run `mage watch:all` to start the application.6) Navigate to `http://localhost:3000/` and 🎉! You should see the sign up page of Fider!To run the unit tests:1) run `docker-compose up -d pgtest` to start a test-only PostgreSQL database on Docker.-2) run `make test`.+2) run `mage test:all`.++**NOTE:** It's currently not possible to build and develop Fider on **Windows**, if you're a Windows user and want to contribute to Fider, please help us resolve this [issue](https://github.com/getfider/fider/issues/434) first.\ No newline at end of filediff --git a/Makefile b/Makefiledeleted file mode 100644index e752a4d82..000000000--- a/Makefile+++ /dev/null@@ -1,59 +0,0 @@-BUILD_TIME=$(shell date +"%Y.%m.%d.%H%M%S")-BUILD_NUMBER = $(shell echo $$CIRCLE_BUILD_NUM)--# Building-build-ui:- rm -rf dist- NODE_ENV=production npx webpack -p--build-server:- go build -ldflags='-s -w -X main.buildtime=${BUILD_TIME} -X main.buildnumber=${BUILD_NUMBER}' -o fider .--build : build-server build-ui--lint:- npx tslint -c tslint.json 'public/**/*.{ts,tsx}' 'tests/**/*.{ts,tsx}'--lint-fix:- npx tslint -c tslint.json 'public/**/*.{ts,tsx}' 'tests/**/*.{ts,tsx}' --fix--# Testing-test-ui:- TZ='GMT' npx jest ./public--test-server: build-server- godotenv -f .test.env ./fider migrate- godotenv -f .test.env go test ./... -race--test : test-server test-ui--coverage: build-server- godotenv -f .test.env ./fider migrate- godotenv -f .test.env go test ./... -coverprofile=cover.out -coverpkg=all -race--e2e-single:- ./scripts/e2e.sh single--e2e-multi:- ./scripts/e2e.sh multi--e2e-build:- ./scripts/e2e.sh build--e2e:- ./scripts/e2e.sh--# Development-kill-dev:- ps aux | grep ./fider | grep -v grep | awk '{print $$2}' | xargs kill--watch: kill-dev- rm -rf ./dist- mkdir ./dist- air -c air.conf &- npx webpack -w--run: kill-dev- godotenv -f .env ./fider--.DEFAULT_GOAL := builddiff --git a/app/cmd/server.go b/app/cmd/server.goindex 26415fcc7..8d0fb5478 100644--- a/app/cmd/server.go+++ b/app/cmd/server.go@@ -1,12 +1,8 @@package cmdimport (- "bytes"- "fmt""os""os/signal"- "runtime"- "runtime/pprof""syscall""github.com/getfider/fider/app/models"@@ -31,7 +27,7 @@ func RunServer(settings *models.SystemSettings) int {func listenSignals(e *web.Engine, settings *models.SystemSettings) int {signals := make(chan os.Signal, 1)- signal.Notify(signals, syscall.SIGTERM, syscall.SIGINT, syscall.SIGUSR1)+ signal.Notify(signals, append([]os.Signal{syscall.SIGTERM, syscall.SIGINT}, extraSignals...)...)for {s := <-signalsswitch s {@@ -42,20 +38,11 @@ func listenSignals(e *web.Engine, settings *models.SystemSettings) int {return 1}return 0- case syscall.SIGUSR1:- e.Logger().Info("SIGUSR1 received")- e.Logger().Info("Dumping process status")- buf := new(bytes.Buffer)- pprof.Lookup("goroutine").WriteTo(buf, 1)- pprof.Lookup("heap").WriteTo(buf, 1)- buf.WriteString("\n")- buf.WriteString(fmt.Sprintf("# FIDER v%s\n", settings.Version))- buf.WriteString(fmt.Sprintf("# BuildTime: %s\n", settings.BuildTime))- buf.WriteString(fmt.Sprintf("# Compiler: %s\n", settings.Compiler))- buf.WriteString(fmt.Sprintf("# Environment: %s\n", settings.Environment))- buf.WriteString(fmt.Sprintf("# Worker Queue: %d\n", e.Worker().Length()))- buf.WriteString(fmt.Sprintf("# Num Goroutines: %d\n", runtime.NumGoroutine()))- e.Logger().Info(buf.String())+ default:+ ret := handleExtraSignal(s, e, settings)+ if ret >= 0 {+ return ret+ }}}}diff --git a/app/cmd/signals_unix.go b/app/cmd/signals_unix.gonew file mode 100644index 000000000..604ce7661--- /dev/null+++ b/app/cmd/signals_unix.go@@ -0,0 +1,37 @@+// +build !windows++package cmd++import (+ "bytes"+ "fmt"+ "os"+ "runtime"+ "runtime/pprof"+ "syscall"++ "github.com/getfider/fider/app/models"+ "github.com/getfider/fider/app/pkg/web"+)++var extraSignals = []os.Signal{syscall.SIGUSR1}++func handleExtraSignal(s os.Signal, e *web.Engine, settings *models.SystemSettings) int {+ switch s {+ case syscall.SIGUSR1:+ e.Logger().Info("SIGUSR1 received")+ e.Logger().Info("Dumping process status")+ buf := new(bytes.Buffer)+ pprof.Lookup("goroutine").WriteTo(buf, 1)+ pprof.Lookup("heap").WriteTo(buf, 1)+ buf.WriteString("\n")+ buf.WriteString(fmt.Sprintf("# FIDER v%s\n", settings.Version))+ buf.WriteString(fmt.Sprintf("# BuildTime: %s\n", settings.BuildTime))+ buf.WriteString(fmt.Sprintf("# Compiler: %s\n", settings.Compiler))+ buf.WriteString(fmt.Sprintf("# Environment: %s\n", settings.Environment))+ buf.WriteString(fmt.Sprintf("# Worker Queue: %d\n", e.Worker().Length()))+ buf.WriteString(fmt.Sprintf("# Num Goroutines: %d\n", runtime.NumGoroutine()))+ e.Logger().Info(buf.String())+ }+ return -1+}diff --git a/app/cmd/signals_windows.go b/app/cmd/signals_windows.gonew file mode 100644index 000000000..eb1659c50--- /dev/null+++ b/app/cmd/signals_windows.go@@ -0,0 +1,16 @@+// +build windows++package cmd++import (+ "os"++ "github.com/getfider/fider/app/models"+ "github.com/getfider/fider/app/pkg/web"+)++var extraSignals = []os.Signal{}++func handleExtraSignal(s os.Signal, e *web.Engine, settings *models.SystemSettings) int {+ return -1+}diff --git a/magefile.go b/magefile.gonew file mode 100644index 000000000..3c259fe19--- /dev/null+++ b/magefile.go@@ -0,0 +1,112 @@+// +build mage++package main++import (+ "os"+ "runtime"+ "time"++ "github.com/magefile/mage/mg"+ "github.com/magefile/mage/sh"+)++var buildTime = time.Now().Format("2006.01.02.150405")+var buildNumber = os.Getenv("CIRCLE_BUILD_NUM")+var exeName = "fider"++func init() {+ os.Setenv("MAGEFILE_VERBOSE", "true")+ if runtime.GOOS == "windows" {+ exeName = "fider.exe"+ }+}++func Run() error {+ return sh.Run("godotenv", "-f", ".env", "./"+exeName)+}++func Lint() error {+ return sh.Run("npx", "tslint", "-c", "tslint.json", "'public/**/*.{ts,tsx}'", "'tests/**/*.{ts,tsx}'")+}++func Clean() error {+ os.RemoveAll("./dist")+ return os.Mkdir("./dist", 0777)+}++type Watch mg.Namespace++func (Watch) All() {+ Clean()+ mg.Deps(Watch.Server, Watch.UI)+}++func (Watch) UI() error {+ return sh.Run("npx", "webpack", "-w")+}++func (Watch) Server() error {+ return sh.Run("air", "-c", "air.conf")+}++type Build mg.Namespace++func (Build) All() {+ mg.Deps(Build.Server, Build.UI)+}++func (Build) Docker() error {+ mg.Deps(Build.UI)+ if err := buildServer(map[string]string{+ "CGO_ENABLED": "0",+ "GOOS": "linux",+ "GOARCH": "amd64",+ }); err != nil {+ return err+ }++ return sh.Run("docker", "build", "-t", "getfider/fider", ".")+}++func (Build) Server() error {+ return buildServer(map[string]string{+ "GOOS": runtime.GOOS,+ "GOARCH": runtime.GOARCH,+ })+}++func (Build) UI() error {+ mg.Deps(Clean)+ env := map[string]string{"NODE_ENV": "production"}+ return sh.RunWith(env, "npx", "webpack", "-p")+}++type Test mg.Namespace++func (Test) All() {+ mg.Deps(Test.Server, Test.UI)+}++func (Test) Coverage() error {+ mg.Deps(Build.Server)+ sh.Run("godotenv", "-f", ".test.env", "./"+exeName, "migrate")+ return sh.Run("godotenv", "-f", ".test.env", "go", "test", "./...", "-coverprofile=cover.out", "-coverpkg=all", "-race")+}++func (Test) Server() error {+ mg.Deps(Build.Server)+ sh.Run("godotenv", "-f", ".test.env", "./"+exeName, "migrate")+ return sh.Run("godotenv", "-f", ".test.env", "go", "test", "./...", "-race")+}++func (Test) UI() error {+ env := map[string]string{"TZ": "GMT"}+ return sh.RunWith(env, "npx", "jest", "./public")+}++// Utils+func buildServer(env map[string]string) error {+ ldflags := "-s -w -X main.buildtime=" + buildTime + " -X main.buildnumber=" + buildNumber+ return sh.RunWith(env, "go", "build", "-ldflags='"+ldflags+"'", "-o", exeName, ".")+}diff --git a/scripts/e2e.sh b/scripts/e2e.shindex b178190a3..1ef51dce4 100755--- a/scripts/e2e.sh+++ b/scripts/e2e.sh@@ -27,8 +27,8 @@ run_e2e () {if [[ $1 == 'build' ]] || [ -z $1 ]then- CGO_ENABLED=0 GOOS=linux GOARCH=amd64 make build- docker build -t getfider/fider:e2e .+ mage build:docker+ docker tag getfider/fider getfider/fider:e2efiif [[ $1 == 'single' ]] || [ -z $1 ]