Normalize structure following other projects

1 files changed, 165 insertions, 13 deletions

diff --git a/Makefile b/Makefile
index e035e63..f3d80f9 100644
--- a/Makefile
+++ b/Makefile
@@ -1,18 +1,170 @@
-BRANCH=`git rev-parse --abbrev-ref HEAD`
-COMMIT=`git rev-parse --short HEAD`
-GOLDFLAGS="-X main.branch $(BRANCH) -X main.commit $(COMMIT)"
+.POSIX:
+DATE         = 1970-01-01
+VERSION      = 0.1.0
+NAME         = gkv
+NAME_UC      = $(NAME)
+LANGUAGES    = en
+## Installation prefix.  Defaults to "/usr".
+PREFIX       = /usr
+BINDIR       = $(PREFIX)/bin
+LIBDIR       = $(PREFIX)/lib
+GOLIBDIR     = $(LIBDIR)/go
+INCLUDEDIR   = $(PREFIX)/include
+SRCDIR       = $(PREFIX)/src/$(NAME)
+SHAREDIR     = $(PREFIX)/share
+LOCALEDIR    = $(SHAREDIR)/locale
+MANDIR       = $(SHAREDIR)/man
+EXEC         = ./
+## Where to store the installation.  Empty by default.
+DESTDIR      =
+LDLIBS       = --static
+GOCFLAGS     = -I $(GOLIBDIR)
+GOLDFLAGS    = -L $(GOLIBDIR)
 
-default: build
 
-race:
-	@go test -v -race -test.run="TestSimulate_(100op|1000op)"
 
-# go get github.com/kisielk/errcheck
-errcheck:
-	@errcheck -ignorepkg=bytes -ignore=os:Remove github.com/boltdb/bolt
+.SUFFIXES:
+.SUFFIXES: .go .a .bin .bin-check
 
-test: 
-	@go test -v -cover .
-	@go test -v ./cmd/bolt
+.go.a:
+	go tool compile $(GOCFLAGS)  -I $(@D) -o $@ -p $(*F) \
+		`find $< $$(if [ $(*F) != main ]; then \
+			echo src/$(NAME).go src/version.go; fi) | uniq`
 
-.PHONY: fmt test
+.a.bin:
+	go tool link    $(GOLDFLAGS) -L $(@D) -o $@ --extldflags '$(LDLIBS)' $<
+
+
+
+all:
+include deps.mk
+
+
+libs.a                 = $(libs.go:.go=.a)
+mains.a                = $(mains.go:.go=.a)
+mains.bin              = $(mains.go:.go=.bin)
+functional-tests/lib.a = $(functional-tests/lib.go:.go=.a)
+fuzz-targets/lib.a     = $(fuzz-targets/lib.go:.go=.a)
+benchmarks/lib.a       = $(benchmarks/lib.go:.go=.a)
+
+sources = \
+	src/$(NAME).go                 \
+	src/version.go                 \
+	src/main.go                    \
+
+
+derived-assets = \
+	src/version.go                 \
+	$(libs.a)                      \
+	$(mains.a)                     \
+	$(mains.bin)                   \
+	$(NAME).bin                    \
+
+side-assets = \
+	tests/fuzz/corpus/             \
+	tests/benchmarks/*/main.txt    \
+
+
+
+## Default target.  Builds all artifacts required for testing
+## and installation.
+all: $(derived-assets)
+
+
+$(libs.a): Makefile deps.mk
+$(libs.a): src/$(NAME).go src/version.go
+
+
+$(fuzz-targets/lib.a):
+	go tool compile $(GOCFLAGS) -o $@ -p $(NAME) -d=libfuzzer \
+		$*.go src/$(NAME).go src/version.go
+
+src/version.go: Makefile
+	echo 'package $(NAME); const Version = "$(VERSION)"' > $@
+
+$(NAME).bin: src/main.bin
+	ln -fs $? $@
+
+
+
+tests.bin-check = \
+	tests/main.bin-check \
+	$(functional-tests/main.go:.go=.bin-check) \
+
+$(tests.bin-check):
+	$(EXEC)$*.bin
+
+check-unit: $(tests.bin-check)
+
+
+integration-tests = \
+	tests/cli-opts.sh              \
+	tests/integration.sh           \
+
+.PRECIOUS: $(integration-tests)
+$(integration-tests): $(NAME).bin
+$(integration-tests): ALWAYS
+	sh $@
+
+check-integration: $(integration-tests)
+check-integration: fuzz
+
+
+## Run all tests.  Each test suite is isolated, so that a parallel
+## build can run tests at the same time.  The required artifacts
+## are created if missing.
+check: check-unit check-integration
+
+
+
+FUZZSEC=1
+fuzz-targets/main.bin-check = $(fuzz-targets/main.go:.go=.bin-check)
+$(fuzz-targets/main.bin-check):
+	$(EXEC)$*.bin --test.fuzztime=$(FUZZSEC)s \
+		--test.fuzz='.*' --test.fuzzcachedir=tests/fuzz/corpus
+
+fuzz: $(fuzz-targets/main.bin-check)
+
+
+
+benchmarks/main.bin-check = $(benchmarks/main.go:.go=.bin-check)
+$(benchmarks/main.bin-check):
+	rm -f $*.txt
+	printf '%s\n' '$(EXEC)$*.bin'           >> $*.txt
+	LANG=POSIX.UTF-8 time -p $(EXEC)$*.bin 2>> $*.txt
+	printf '%s\n' '$*.txt'
+
+bench: $(benchmarks/main.bin-check)
+
+
+
+## Remove *all* derived artifacts produced during the build.
+## A dedicated test asserts that this is always true.
+clean:
+	rm -rf $(derived-assets) $(side-assets)
+
+
+## Installs into $(DESTDIR)$(PREFIX).  Its dependency target
+## ensures that all installable artifacts are crafted beforehand.
+install: all
+	mkdir -p \
+		'$(DESTDIR)$(BINDIR)'     \
+		'$(DESTDIR)$(GOLIBDIR)'   \
+		'$(DESTDIR)$(SRCDIR)'     \
+
+	cp $(NAME).bin       '$(DESTDIR)$(BINDIR)'/$(NAME)
+	cp src/$(NAME).a     '$(DESTDIR)$(GOLIBDIR)'
+	cp $(sources)        '$(DESTDIR)$(SRCDIR)'
+
+## Uninstalls from $(DESTDIR)$(PREFIX).  This is a perfect mirror
+## of the "install" target, and removes *all* that was installed.
+## A dedicated test asserts that this is always true.
+uninstall:
+	rm -rf \
+		'$(DESTDIR)$(BINDIR)'/$(NAME)         \
+		'$(DESTDIR)$(GOLIBDIR)'/$(NAME).a     \
+		'$(DESTDIR)$(SRCDIR)'                 \
+
+
+
+ALWAYS: