/
Makefile
183 lines (139 loc) · 5.51 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
#SPDX-License-Identifier: MIT
default:
@ echo "Installation Commands:"
@ echo " install Installs Augur's full stack for production"
@ echo " clean Removes potentially troublesome compiled files"
@ echo " rebuild Removes build/compiled files & binaries and reinstalls the project"
@ echo
@ echo "Development Commands:"
@ echo " db Initialize a fresh Docker database container (restarts it if it's still running)"
@ echo " dev Starts the full stack in the background"
@ echo " dev-start Runs the backend and frontend servers in the background"
@ echo " dev-stop Stops the backgrounded backend & frontend server commands"
@ echo
@ echo "Testing Commands:"
@ echo " test-data Start the testing dataset Docker database"
@ echo " test Runs all tests"
@ echo " test-api Run all API tests"
@ echo
@ echo "Documentation Commands:"
@ echo " docs Generates the documentation"
@ echo " docs-view Generates the documentation, then opens it for local viewing"
# @ echo " test-application Runs all application unit tests (including metrics)"
# @ echo " test-workers Run all worker unit tests"
#
# Installation
#
.PHONY: install
.PHONY: install-spdx install-spdx-sudo install-augur-sbom
.PHONY: clean rebuild
install:
@ ./scripts/install/install.sh dev
install-spdx:
@ ./scripts/install/install-spdx.sh
install-spdx-sudo:
@ ./scripts/install/install-spdx-sudo.sh
install-augur-sbom:
@ ./scripts/install/nomos.sh
clean:
@ scripts/control/clean.sh
rebuild:
@ scripts/control/rebuild.sh dev
#
# Development
#
.PHONY: dev-start dev-stop dev monitor-frontend monitor-backend monitor frontend backend-stop backend-start backend-restart backend clean rebuild
dev-start:
@ scripts/control/start_augur.sh
@ scripts/control/start_frontend.sh
dev-stop:
@ augur backend stop
@ scripts/control/kill_frontend.sh
dev: dev-stop dev-start
db:
@ - docker stop augur_database
@ - docker rm augur_database
@ docker run -p 5434:5432 --name augur_database augurlabs/augur:database
lint:
@ pylint augur
lint-count:
@ pylint augur | wc -l
lint-docs:
@ pylint augur | grep docstring
lint-docs-missing:
@ pylint augur | grep docstring | wc -l
lint-github-tasks-count:
@ pylint augur | grep augur/tasks/github/ | wc -l
#
# Testing
#
.PHONY: test test-data test-application test-metric-routes test-python-versions
test-data:
@ - docker stop augur_test_data
@ - docker rm augur_test_data
@ docker run -p 5434:5432 --name augur_test_data augurlabs/augur:test_data@sha256:71da12114bf28584a9a64ede2fac0cbc8dffc8e2f4a2c61231206e2f82201c2f
test:
# @ pytest tests/test_tasks/test_github_tasks/
@ python3 tests/start_server.py
@ pytest tests/test_metrics/test_metrics_functionality/ tests/test_routes/test_api_functionality/ tests/test_tasks/ tests/test_applicaton/
@ python3 tests/stop_server.py
test-api:
@ python3 tests/start_server.py
@ pytest tests/test_metrics/test_metrics_functionality/ tests/test_routes/test_api_functionality/
@ python3 tests/stop_server.py
# test-application:
# @ bash -c 'tox -e py-application'
#Worker's tests need a database from docker
#To use the docker daemon you need to be root so sudo is needed.
# test-workers:
# @ bash -c 'sudo tox -e py-workers'
# test-metric-routes:
# @ bash -c 'tox -e py-metric-routes'
# test-python-versions:
# @ bash -c 'tox -e ALL'
#
# Documentation
#
.PHONY: docs docs-view
docs:
@ bash -c 'cd docs/ && rm -rf build/ && make html;'
docs-view: docs
@ bash -c 'open docs/build/html/index.html'
#
# Docker Shortcuts
# Do not use these unless you know what they mean.
.PHONY: compose-run compose-run-database
.PHONY: build-backend run-backend build-frontend run-frontend build-database run-database
compose-run:
@ docker compose -f docker-compose.yml up --build
compose-run-database:
@ echo "**************************************************************************"
@ echo "Make sure there are no database credentials in docker_env.txt!"
@ echo "**************************************************************************"
@ echo
@ docker compose -f docker-compose.yml -f database-compose.yml up --build
docker-build: docker-build-backend docker-build-frontend docker-build-database docker-build-rabbitmq
docker-build-backend:
@ docker build -t augurlabs/augur:backend -f util/docker/backend/Dockerfile .
docker-build-frontend:
@ docker build -t augurlabs/augur:frontend -f util/docker/frontend/Dockerfile .
docker-build-database:
@ docker build -t augurlabs/augur:database -f util/docker/database/Dockerfile .
docker-build-rabbitmq:
@ docker build -t augurlabs/augur:rabbitmq -f util/docker/rabbitmq/Dockerfile .
docker-run-backend:
@ - docker stop augur_backend
@ - docker rm augur_backend
docker run -p 5000:5000 --name augur_backend --env-file docker_env.txt augurlabs/augur:backend
docker-run-frontend:
@ - docker stop augur_frontend
@ - docker rm augur_frontend
docker run -p 8080:8080 --name augur_frontend augurlabs/augur:frontend
docker-run-database:
@ - docker stop augur_database
@ - docker rm augur_database
docker run -p 5434:5432 --name augur_database augurlabs/augur:database
docker-run-rabbitmq:
@ - docker stop augur_rabbitmq
@ - docker rm augur_rabbitmq
docker run -p 5434:5432 --name augur_rabbitmq augurlabs/augur:rabbitmq