-
Notifications
You must be signed in to change notification settings - Fork 0
/
Makefile
executable file
·218 lines (171 loc) · 8.76 KB
/
Makefile
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
.DEFAULT_GOAL := help
.PHONY: run run-help test test-core test-libc test-lint build-libc check cover
.PHONY: integration-test-stable integration-test-stable-disable-csrf
.PHONY: integration-test-live integration-test-live-wallet
.PHONY: integration-test-disable-wallet-api integration-test-disable-seed-api
.PHONY: integration-test-enable-seed-api integration-test-enable-seed-api
.PHONY: integration-test-disable-gui integration-test-disable-gui
.PHONY: install-linters format release clean-release install-deps-ui build-ui help
# Static files directory
GUI_STATIC_DIR = src/gui/static
# Electron files directory
ELECTRON_DIR = electron
# Compilation output
BUILD_DIR = build
BUILDLIB_DIR = $(BUILD_DIR)/libskycoin
LIB_DIR = lib
LIB_FILES = $(shell find ./lib/cgo -type f -name "*.go")
SRC_FILES = $(shell find ./src -type f -name "*.go")
BIN_DIR = bin
DOC_DIR = docs
INCLUDE_DIR = include
LIBSRC_DIR = lib/cgo
LIBDOC_DIR = $(DOC_DIR)/libc
# Compilation flags
CC_VERSION = $(shell $(CC) -dumpversion)
STDC_FLAG = $(python -c "if tuple(map(int, '$(CC_VERSION)'.split('.'))) < (6,): print('-std=C99'")
LIBC_LIBS = -lcriterion
LIBC_FLAGS = -I$(LIBSRC_DIR) -I$(INCLUDE_DIR) -I$(BUILD_DIR)/usr/include -L $(BUILDLIB_DIR) -L$(BUILD_DIR)/usr/lib
# Platform specific checks
OSNAME = $(TRAVIS_OS_NAME)
ifeq ($(shell uname -s),Linux)
LDLIBS=$(LIBC_LIBS) -lpthread
LDPATH=$(shell printenv LD_LIBRARY_PATH)
LDPATHVAR=LD_LIBRARY_PATH
LDFLAGS=$(LIBC_FLAGS) $(STDC_FLAG)
ifndef OSNAME
OSNAME = linux
endif
else ifeq ($(shell uname -s),Darwin)
ifndef OSNAME
OSNAME = osx
endif
LDLIBS = $(LIBC_LIBS)
LDPATH=$(shell printenv DYLD_LIBRARY_PATH)
LDPATHVAR=DYLD_LIBRARY_PATH
LDFLAGS=$(LIBC_FLAGS) -framework CoreFoundation -framework Security
else
LDLIBS = $(LIBC_LIBS)
LDPATH=$(shell printenv LD_LIBRARY_PATH)
LDPATHVAR=LD_LIBRARY_PATH
LDFLAGS=$(LIBC_FLAGS)
endif
run: ## Run the skycoin node. To add arguments, do 'make ARGS="--foo" run'.
./run.sh ${ARGS}
run-help: ## Show skycoin node help
@go run cmd/skycoin/skycoin.go --help
test: ## Run tests for Skycoin
go test ./cmd/... -timeout=5m
go test ./src/... -timeout=5m
test-386: ## Run tests for Skycoin with GOARCH=386
GOARCH=386 go test ./cmd/... -timeout=5m
GOARCH=386 go test ./src/... -timeout=5m
test-amd64: ## Run tests for Skycoin with GOARCH=amd64
GOARCH=amd64 go test ./cmd/... -timeout=5m
GOARCH=amd64 go test ./src/... -timeout=5m
configure-build:
mkdir -p $(BUILD_DIR)/usr/tmp $(BUILD_DIR)/usr/lib $(BUILD_DIR)/usr/include
mkdir -p $(BUILDLIB_DIR) $(BIN_DIR) $(INCLUDE_DIR)
$(BUILDLIB_DIR)/libskycoin.so: $(LIB_FILES) $(SRC_FILES)
rm -Rf $(BUILDLIB_DIR)/libskycoin.so
go build -buildmode=c-shared -o $(BUILDLIB_DIR)/libskycoin.so $(LIB_FILES)
mv $(BUILDLIB_DIR)/libskycoin.h $(INCLUDE_DIR)/
$(BUILDLIB_DIR)/libskycoin.a: $(LIB_FILES) $(SRC_FILES)
rm -Rf $(BUILDLIB_DIR)/libskycoin.a
go build -buildmode=c-archive -o $(BUILDLIB_DIR)/libskycoin.a $(LIB_FILES)
mv $(BUILDLIB_DIR)/libskycoin.h $(INCLUDE_DIR)/
build-libc-static: $(BUILDLIB_DIR)/libskycoin.a
build-libc-shared: $(BUILDLIB_DIR)/libskycoin.so
## Build libskycoin C client library
build-libc: configure-build build-libc-static build-libc-shared
## Build libskycoin C client library and executable C test suites
## with debug symbols. Use this target to debug the source code
## with the help of an IDE
build-libc-dbg: configure-build build-libc-static build-libc-shared
$(CC) -g -o $(BIN_DIR)/test_libskycoin_shared $(LIB_DIR)/cgo/tests/*.c -lskycoin $(LDLIBS) $(LDFLAGS)
$(CC) -g -o $(BIN_DIR)/test_libskycoin_static $(LIB_DIR)/cgo/tests/*.c $(BUILDLIB_DIR)/libskycoin.a $(LDLIBS) $(LDFLAGS)
test-libc: build-libc ## Run tests for libskycoin C client library
echo "Compiling with $(CC) $(CC_VERSION) $(STDC_FLAG)"
$(CC) -o $(BIN_DIR)/test_libskycoin_shared $(LIB_DIR)/cgo/tests/*.c $(LIB_DIR)/cgo/tests/testutils/*.c -lskycoin $(LDLIBS) $(LDFLAGS)
$(CC) -o $(BIN_DIR)/test_libskycoin_static $(LIB_DIR)/cgo/tests/*.c $(LIB_DIR)/cgo/tests/testutils/*.c $(BUILDLIB_DIR)/libskycoin.a $(LDLIBS) $(LDFLAGS)
$(LDPATHVAR)="$(LDPATH):$(BUILD_DIR)/usr/lib:$(BUILDLIB_DIR)" $(BIN_DIR)/test_libskycoin_shared
$(LDPATHVAR)="$(LDPATH):$(BUILD_DIR)/usr/lib" $(BIN_DIR)/test_libskycoin_static
docs-libc:
doxygen ./.Doxyfile
moxygen -o $(LIBDOC_DIR)/API.md $(LIBDOC_DIR)/xml/
docs: docs-libc
lint: ## Run linters. Use make install-linters first.
vendorcheck ./...
golangci-lint run --no-config --deadline=3m --concurrency=2 --disable-all --tests --skip-dirs=lib/cgo \
-E goimports \
-E golint \
-E varcheck \
-E unparam \
-E deadcode \
-E structcheck \
./...
# lib cgo can't use golint because it needs export directives in function docstrings that do not obey golint rules
golangci-lint run --no-config --deadline=3m --concurrency=2 --disable-all --tests \
-E goimports \
-E varcheck \
-E unparam \
-E structcheck \
./lib/cgo/...
check: lint test integration-test-stable integration-test-stable-disable-csrf integration-test-disable-wallet-api integration-test-disable-seed-api integration-test-enable-seed-api integration-test-disable-gui ## Run tests and linters
integration-test-stable: ## Run stable integration tests
./ci-scripts/integration-test-stable.sh -c
integration-test-stable-disable-csrf: ## Run stable integration tests with CSRF disabled
./ci-scripts/integration-test-stable.sh
integration-test-live: ## Run live integration tests
./ci-scripts/integration-test-live.sh -c
integration-test-live-wallet: ## Run live integration tests with wallet
./ci-scripts/integration-test-live.sh -w
integration-test-live-disable-csrf: ## Run live integration tests against a node with CSRF disabled
./ci-scripts/integration-test-live.sh
integration-test-disable-wallet-api: ## Run disable wallet api integration tests
./ci-scripts/integration-test-disable-wallet-api.sh
integration-test-enable-seed-api: ## Run enable seed api integration test
./ci-scripts/integration-test-enable-seed-api.sh
integration-test-disable-gui:
./ci-scripts/integration-test-disable-gui.sh
cover: ## Runs tests on ./src/ with HTML code coverage
go test -cover -coverprofile=cover.out -coverpkg=github.com/skycoin/skycoin/... ./src/...
go tool cover -html=cover.out
install-linters: ## Install linters
go get -u github.com/FiloSottile/vendorcheck
go get -u github.com/golangci/golangci-lint/cmd/golangci-lint
install-deps-libc: configure-build ## Install locally dependencies for testing libskycoin
git clone --recursive https://github.com/skycoin/Criterion $(BUILD_DIR)/usr/tmp/Criterion
mkdir $(BUILD_DIR)/usr/tmp/Criterion/build
cd $(BUILD_DIR)/usr/tmp/Criterion/build && cmake .. && cmake --build .
mv $(BUILD_DIR)/usr/tmp/Criterion/build/libcriterion.* $(BUILD_DIR)/usr/lib/
cp -R $(BUILD_DIR)/usr/tmp/Criterion/include/* $(BUILD_DIR)/usr/include/
format: ## Formats the code. Must have goimports installed (use make install-linters).
goimports -w -local github.com/skycoin/skycoin ./cmd
goimports -w -local github.com/skycoin/skycoin ./src
goimports -w -local github.com/skycoin/skycoin ./lib
install-deps-ui: ## Install the UI dependencies
cd $(GUI_STATIC_DIR) && npm install
lint-ui: ## Lint the UI code
cd $(GUI_STATIC_DIR) && npm run lint
test-ui: ## Run UI tests
cd $(GUI_STATIC_DIR) && npm run test
test-ui-e2e: ## Run UI e2e tests
./ci-scripts/ui-e2e.sh
build-ui: ## Builds the UI
cd $(GUI_STATIC_DIR) && npm run build
build-ui-travis: ## Builds the UI for travis
cd $(GUI_STATIC_DIR) && npm run build-travis
release: ## Build electron and standalone apps. Use osarch=${osarch} to specify the platform. Example: 'make release osarch=darwin/amd64', multiple platform can be supported in this way: 'make release osarch="darwin/amd64 windows/amd64"'. Supported architectures are: darwin/amd64 windows/amd64 windows/386 linux/amd64 linux/arm, the builds are located in electron/release folder.
cd $(ELECTRON_DIR) && ./build.sh ${osarch}
@echo release files are in the folder of electron/release
release-bin: ## Build standalone apps. Use osarch=${osarch} to specify the platform. Example: 'make release-bin osarch=darwin/amd64' Supported architectures are the same as 'release' command.
cd $(ELECTRON_DIR) && ./build-standalone-release.sh ${osarch}
@echo release files are in the folder of electron/release
release-gui: ## Build electron apps. Use osarch=${osarch} to specify the platform. Example: 'make release-gui osarch=darwin/amd64' Supported architectures are the same as 'release' command.
cd $(ELECTRON_DIR) && ./build-electron-release.sh ${osarch}
@echo release files are in the folder of electron/release
clean-release: ## Clean dist files and delete all builds in electron/release
rm $(ELECTRON_DIR)/release/*
help:
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'