forked from semgrep/semgrep
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Makefile
505 lines (439 loc) · 17.9 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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
###############################################################################
# Prelude
###############################################################################
# Many targets in this Makefile assume some commands have been run before to
# install the correct build environment supporting the different languages
# used for Semgrep development:
# - for OCaml: 'opam' and the right OCaml switch (currently 4.14)
# - for C: the classic 'gcc', 'ld', but also some C libraries like PCRE
# - for Python: 'python3', 'pip', 'pipenv', 'python-config'
#
# You will also need obviously 'make', but also 'git', and many other
# common dev tools (e.g., 'docker').
#
# Once this basic building/development environment has been setup
# (see the different 'install-deps-XXX-yyy' targets later to assist you),
# you can then use:
#
# $ make install-deps
#
# to install the dependencies proper to semgrep (e.g., the necessary OPAM
# packages used by semgrep-core).
#
# Then to compile semgrep simply type:
#
# $ make
#
# See INSTALL.md for more information
# See also https://semgrep.dev/docs/contributing/contributing-code/
###############################################################################
# Portability tricks
###############################################################################
# Most of the targets in this Makefile should work equally under
# Linux (Alpine, Ubuntu, Arch linux), macOS, from a Dockerfile, and
# hopefully also under Windows WSL.
# The main exceptions are the install-deps-XXX-yyy targets below.
# If you really have to use platform-specific commands or flags, try to use
# macros like the one below to make the Makefile portable.
# Used to select commands with different usage under GNU/Linux and *BSD/Darwin
# such as 'sed'.
ifeq ($(shell uname -s),Linux)
LINUX = true
else
LINUX = false
endif
# :(
ifeq ($(LINUX),true)
SED = sed -i -e
else
SED = sed -i ''
endif
###############################################################################
# Build (and clean) targets
###############################################################################
# Set environment variables used by dune files to locate the
# C headers and libraries of the tree-sitter runtime library.
# This file is created by ocaml-tree-sitter-core's configure script.
#
# Because of these required environment variables, we can't call dune directly
# to build semgrep-core, unless you manually execute first
# `source src/ocaml-tree-sitter-core/tree-sitter-config.sh`
#
# I use '-include' and not 'include' because before 'make setup' this file does
# not exist but we still want 'make setup' to succeed
-include libs/ocaml-tree-sitter-core/tree-sitter-config.mk
# First (and default) target. Routine build.
# It assumes all dependencies and configuration are already in place and correct.
# It should be fast since it's called often during development.
.PHONY: build
build:
$(MAKE) core
$(MAKE) copy-core-for-cli
cd cli && pipenv install --dev
$(MAKE) -C cli build
# was the 'all' target in in semgrep-core/Makefile before
.PHONY: core
core:
rm -f bin
$(MAKE) minimal-build
dune build ./_build/default/tests/test.exe
# make executables easily accessible for manual testing:
test -e bin || ln -s _build/install/default/bin .
# Make binaries available to 'semgrep', the Python wrapper.
#
# TODO: find out and explain why we can't use symlinks
# (symlink-core-for-cli) which is faster, clearer, and less wasteful
# than full copies. It may have something to do with how we do Python
# or Homebrew packaging.
.PHONY: copy-core-for-cli
copy-core-for-cli:
# Executables
rm -f cli/src/semgrep/bin/semgrep-core
cp _build/install/default/bin/semgrep-core cli/src/semgrep/bin/
rm -f cli/src/semgrep/bin/osemgrep
cp _build/install/default/bin/osemgrep cli/src/semgrep/bin/
# Same as copy-core-for-cli but faster. This is suitable for local testing
# of semgrep.
#
# Creating symlinks is much faster than making full copies with cp
# (< 100 ms vs. 500 ms), which is significant during development.
#
.PHONY: symlink-core-for-cli
symlink-core-for-cli:
# Executables
rm -f cli/src/semgrep/bin/semgrep-core
ln -s ../../../../bin/semgrep-core \
cli/src/semgrep/bin/semgrep-core
rm -f cli/src/semgrep/bin/osemgrep
ln -s ../../../../bin/osemgrep \
cli/src/semgrep/bin/osemgrep
# Minimal build of the semgrep-core executable. Intended for the docker build.
# Requires the environment variables set by the included file above.
.PHONY: minimal-build
minimal-build:
dune build
# It is better to run this from a fresh repo or after a 'make clean',
# to not send too much data to the Docker daemon.
# For a fresh repo you will need at least to run first 'git submodule update --init'.
.PHONY: build-docker
build-docker:
docker build -t semgrep .
# Build just this executable
.PHONY: build-otarzan
build-otarzan:
rm -f bin
dune build _build/install/default/bin/otarzan
test -e bin || ln -s _build/install/default/bin .
# Remove from the project tree everything that's not under source control
# and was not created by 'make setup'.
.PHONY: clean
clean:
-$(MAKE) core-clean
-$(MAKE) -C cli clean
# was the 'clean' target in in semgrep-core/Makefile before
.PHONY: core-clean
core-clean:
dune clean
rm -f bin
###############################################################################
# Install targets
###############################################################################
# Install semgrep on a developer's machine with pip and opam installed.
.PHONY: install
install:
# Install semgrep-core into opam's bin which is in our PATH.
# This is not needed or used by the pip install.
$(MAKE) core-install
# Install semgrep and semgrep-core in a place known to pip.
python3 -m pip install ./cli
.PHONY: uninstall
uninstall:
-$(MAKE) core-uninstall
-python3 -m pip uninstall --yes semgrep
# Install the semgrep-core executable, as well as any other executable or
# library built from OCaml or C and needed for a complete semgrep install
# for a user of semgrep who builds and installs semgrep from source
# for local use.
#
# This should *not* install the open-source libraries that we maintain
# as part of the semgrep project.
.PHONY: core-install
core-install: copy-core-for-cli
# The executable created by dune doesn't have the write permission,
# causing an error when running a straight cp if a file is already
# there.
# Known alternative: use 'install -m 0644 ...' instead of cp
$(MAKE) uninstall
cp bin/semgrep-core "$$(opam var bin)"/
# Try to uninstall what was installed by 'make core-install'.
# This is a best effort.
.PHONY: core-uninstall
core-uninstall:
rm -f "$$(opam var bin)"/semgrep-core
###############################################################################
# Test target
###############################################################################
.PHONY: test
test:
$(MAKE) core-test
$(MAKE) -C cli test
# I put 'all' as a dependency because sometimes you modify a test file
# and dune runtest -f does not see this new file, probably because
# the cached file under _build/.../tests/ is still the old one.
#coupling: this is run by .github/workflow/tests.yml
.PHONY: core-test
core-test: core
# The test executable has a few options that can be useful
# in some contexts.
# The following command ensures that we can call 'test.exe --help'
# without having to chdir into the test data folder.
./_build/default/tests/test.exe --show-errors --help 2>&1 >/dev/null
$(MAKE) -C libs/spacegrep test
dune runtest -f --no-buffer
#coupling: this is run by .github/workflow/tests.yml
.PHONY: core-e2etest
core-e2etest:
SEMGREP_CORE=$(PWD)/bin/semgrep-core \
$(MAKE) -C interfaces/semgrep_interfaces test
python3 tests/e2e/test_target_file.py
###############################################################################
# External dependencies installation targets
###############################################################################
# **************************************************
# Platform-independent dependencies installation
# **************************************************
# This target is portable; it only assumes you have 'gcc', 'opam' and
# other build-essential tools and a working OCaml (e.g., ocamlc) switch setup.
# Note that this target is now called from our Dockerfile, so do not
# run 'opam update' below to not slow down things.
install-deps-for-semgrep-core:
# Fetch, build and install the tree-sitter runtime library locally.
cd libs/ocaml-tree-sitter-core \
&& ./configure \
&& ./scripts/install-tree-sitter-lib
# Install OCaml dependencies (globally).
opam install -y --deps-only ./libs/ocaml-tree-sitter-core
opam install -y --deps-only ./
# We could also add python dependencies at some point
# and an 'install-deps-for-semgrep-cli' target
install-deps: install-deps-for-semgrep-core
# **************************************************
# Platform-dependent dependencies installation
# **************************************************
# -------------------------------------------------
# Alpine
# -------------------------------------------------
# Here is why we need those external packages below:
# - pcre-dev: for ocaml-pcre now used in semgrep-core
# - python3: used also during building semgrep-core for processing lang.json
# - python3-dev: for the semgrep Python bridge to build Python C extensions
# - gmp-dev: for osemgrep and its use of cohttp
ALPINE_APK_DEPS=pcre-dev python3 python3-dev gmp-dev
# We pin to a specific version just to prevent things from breaking randomly.
# We could update to a more recent version.
# coupling: if you modify the version, please modify also .github/workflows/*
PIPENV='pipenv==2022.6.7'
#TODO: virtualenv 20.22.0 is causing the build to fail with some weird errors:
# 'AttributeError: module 'virtualenv.create.via_global_ref.builtin.cpython.mac_os' has no attribute 'CPython2macOsArmFramework'
# so I pinned an older version
VIRTENV='virtualenv==20.21.0'
# This target is used in our Dockerfile and a few GHA workflows.
# There are pros and cons of having those commands here instead
# of in the Dockerfile and GHA workflows:
# cons:
# - this requires the Makefile and so to checkout (COPY in Docker
# or actions/checkout@v3 in GHA) semgrep first,
# which prevent some caching Docker/GHA could do. This is alleviated
# a bit by the fact that anyway we use a special returntocorp/ocaml
# container with many things pre-installed.
# pro:
# - it avoids repeating yourself everywhere
# For '--ignore-installed distlib' below see
# https://stackoverflow.com/questions/63515454/why-does-pip3-install-pipenv-give-error-error-cannot-uninstall-distlib
install-deps-ALPINE-for-semgrep-core:
apk add --no-cache $(ALPINE_APK_DEPS)
pip install --no-cache-dir --ignore-installed distlib $(PIPENV) $(VIRTENV)
#TODO: deprecate scripts/install-alpine-xxx in favor of that
install-deps-and-build-ALPINE-semgrep-core:
$(MAKE) install-deps-ALPINE-for-semgrep-core
$(MAKE) install-deps
$(MAKE)
$(MAKE) install
# -------------------------------------------------
# Ubuntu
# -------------------------------------------------
# -------------------------------------------------
# macOS (brew)
# -------------------------------------------------
# Install dependencies needed for the Homebrew build.
#
# We don't use just 'make setup' because Homebrew installs its own version
# of tree-sitter, globally.
# The Homebrew package definition ("formula") lives at:
# https://github.com/Homebrew/homebrew-core/blob/master/Formula/semgrep.rb
#
# Some of this can be tested on Linux, see instructions in
# dockerfiles/linuxbrew.Dockerfile
#
.PHONY: homebrew-setup
homebrew-setup:
cd libs/ocaml-tree-sitter-core \
&& ./configure --prefix "$$(brew --prefix tree-sitter)"
# We pass --no-depexts so as to disable the check for pkg-config
# (which is present due to brew dependencies)
# because this check was failing on some platform.
# See details at https://github.com/Homebrew/homebrew-core/pull/82693.
# This workaround may no longer be necessary.
opam install -y --deps-only --no-depexts ./libs/ocaml-tree-sitter-core
opam install -y --deps-only --no-depexts ./
# -------------------------------------------------
# Arch Linux
# -------------------------------------------------
#TODO: pacman -S ...
###############################################################################
# Developer targets
###############################################################################
# This is a best effort to install some external dependencies.
# As a developer you should not run frequently 'make setup', only when
# important dependencies change.
.PHONY: setup
setup:
git submodule update --init
opam update -y
make install-deps-for-semgrep-core
# Install development dependencies in addition to build dependencies.
.PHONY: dev-setup
dev-setup:
$(MAKE) setup
opam install -y --deps-only ./dev
# Update and rebuild everything within the project.
.PHONY: rebuild
rebuild:
git submodule update --init
-$(MAKE) clean
$(MAKE) build
# Same as 'make clean' but may remove additional files, such as external
# libraries installed locally.
#
# Specifically, this removes all files that are git-ignored. New source files
# are preserved, so this command is considered safe.
#
.PHONY: gitclean
gitclean:
git clean -dfX
git submodule foreach --recursive git clean -dfX
# Prepare a release branch.
# This is mainly called by .github/workflows/start-release.yml
# It's safe to run it multiple times.
.PHONY: release
release:
./scripts/release/bump
.PHONY: update_semgrep_rules
update_semgrep_rules:
cd tests/semgrep-rules; git checkout origin/develop
# Run utop with all the semgrep-core libraries loaded.
.PHONY: utop
utop:
dune utop
.PHONY: dump
dump:
./_build/default/tests/test.bc -dump_ast tests/lint/stupid.py
# Run matching performance tests
.PHONY: perf-matching
perf-matching:
@echo "--- default settings ---"
cd ./perf/perf-matching && ./run-perf-suite
@echo "--- no caching ---"
cd ./perf/perf-matching && ./run-perf-suite --no-cache
@echo "--- maximum caching ---"
cd ./perf/perf-matching && ./run-perf-suite --max-cache
# Run matching performance tests and post them to the semgrep dashboard
# at https://dashboard.semgrep.dev/
#
# This is meant for CI, which hopefully runs on similar machines each time.
#
.PHONY: report-perf-matching
report-perf-matching:
cd ./perf/perf-matching && ./run-perf-suite --upload
###############################################################################
# Dogfood!
###############################################################################
# There are a few places where we currently dogfood Semgrep:
#
# - in this Makefile with 'make check' below, which tests semgrep in PATH
# and with 'make check_with_docker' which tests semgrep Docker image,
# and where we use semgrep.jsonnet in both targets
#
# - in pre-commit in .pre-commit-config.yaml which tests the semgrep
# Docker image used in a pre-commit 'language: docker_image' context,
# as well as semgrep official pre-commit hooks in .pre-commit-hooks.yaml
# in a 'language: python' context (which itself uses setup.py to install semgrep),
# with semgrep.jsonnet but also with p/python and p/bandit rulesets.
#
# - in circle CI in .circle/config.yml which uses the Docker image
# and where we use semgrep.jsonnet
#
# - in Github Actions (GHA) in .github/workflows/semgrep.yml where
# we use semgrep-actions and the App to get the rules
#
# Note that many of those places use semgrep.jsonnet and so would report
# the same findings, but they are useful anyway to test all the different
# places where you can plug semgrep (Makefile, pre-commit, circleCI, GHA, GHA+App).
#coupling: see also .circleci/config.yml and its 'semgrep' job
SEMGREP_ARGS=--config semgrep.jsonnet --error --exclude tests
# you can add --verbose for debugging
DOCKER_IMAGE=returntocorp/semgrep:develop
# You need to have semgrep in your PATH! do 'cd cli; pipenv shell' before
# if needed.
.PHONY: check
check:
semgrep $(SEMGREP_ARGS)
# If you get semgrep-core parsing errors while running this command, maybe you
# have an old cached version of the docker image.
# You can invalidate the cache with 'docker rmi returntocorp/semgrep:develop`
check_with_docker:
docker run --rm -v "${PWD}:/src" $(DOCKER_IMAGE) semgrep $(SEMGREP_ARGS)
# I use the docker here instead of directly semgrep, because semgrep is not always
# in my PATH.
#TODO: this will be less needed once we run semgrep with semgrep.jsonnet in pre-commit
check_for_emacs:
docker run --rm -v "${PWD}:/src" $(DOCKER_IMAGE) semgrep $(SEMGREP_ARGS) --emacs --quiet
###############################################################################
# Martin's targets
###############################################################################
# Build executables and place them where semgrep expects them.
# These are normally copied by '/cli/setup.py' but it doesn't happen if we
# run only 'dune build'.
#
# This is for development purposes only as I'm not sure if a symlink is ok
# for packaging things up on the Python side.
#
# Usage:
# $ make dev
# $ PIPENV_PIPFILE=~/semgrep/cli/Pipfile pipenv run semgrep ...
#
.PHONY: dev
dev:
$(MAKE) core
$(MAKE) symlink-core-for-cli
###############################################################################
# Pad's targets
###############################################################################
pr:
git push origin `git rev-parse --abbrev-ref HEAD`
hub pull-request -b develop -r returntocorp/pa
push:
git push origin `git rev-parse --abbrev-ref HEAD`
merge:
A=`git rev-parse --abbrev-ref HEAD` && git checkout develop && git pull && git branch -D $$A
# see https://github.com/aryx/codegraph for information on codegraph_build
index:
codegraph_build -lang cmt -derived_data .
# see https://github.com/aryx/codecheck for information on codecheck
check2:
codecheck -lang ml -with_graph_code graph_code.marshall -filter 3 .
# see https://github.com/aryx/codemap for information on codemap
visual:
codemap -screen_size 3 -filter pfff -efuns_client efuns_client -emacs_client /dev/null .
visual2:
codemap -screen_size 3 -filter pfff -efuns_client efuns_client -emacs_client /dev/null src