Makefile

# serpapi-golang release package
#
version=`grep VERSION serpapi.go | cut -d'"' -f2`

.PHONY: test oobt

all: version lint test doc ready

# lint source code using go tools
lint: vet format

vet: 
	@echo "Run go vet"
	go vet .
	$(foreach file, $(wildcard ./demo/*), go vet $(file);)
	go vet ./test

format: 
	go fmt .
	go fmt ./test
	$(foreach file, $(wildcard ./demo/*), go fmt $(file);)

# run integration test suite
test:
	go test -v . ./test

# run code coverage (not working)
coverage:
	@echo "Run code coverage"
	go test -cover -covermode=count -coverpkg=./... -coverprofile=coverage.out ./test
	go tool cover -html=coverage.out -o coverage.html
	@echo "Coverage report generated: coverage.html"

# run examples 
regression: 
	@echo "run regression tests"
	go test -v ./examples/*.go

# create documentation
doc:
	go doc

# check that everything is pushed
ready:
	@echo "check if repository has changes"
	git status | grep "Nothing"

# out of box testing 
#  validate the pre-released library
oobt:
	mkdir -p /tmp/oobt
	cp oobt/demo.go /tmp/oobt
	cd /tmp/oobt ; \
		go mod init serpapi.com/golang/oobt ; \
		go get -u github.com/serpapi/serpapi-golang ; \
		go run demo.go

# show current version for golang and library
version:
  @echo "golang: " `go --version`
	@echo "current version: ${version}"

# display the current release information
# tags are prefixed with v (vX.Y.Z) as required by the go module resolver
release: oobt version
	git tag -a v${version}
	git push origin v${version}
	@echo "create release: v${version}"

clean:
	rm coverage.out
	rm coverage.html
	go clean