Add help system to Makefile + FDM command #25028
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,6 +9,8 @@ REVISION = $(shell git rev-parse HEAD) | |
| REVSHORT = $(shell git rev-parse --short HEAD) | ||
| USER = $(shell whoami) | ||
| DOCKER_IMAGE_NAME = fleetdm/fleet | ||
| # The tool that was called on the command line (probably `make` or `fdm`). | ||
| TOOL_CMD = "make" | ||
|
|
||
| ifdef GO_BUILD_RACE_ENABLED | ||
| GO_BUILD_RACE_ENABLED_VAR := true | ||
|
|
@@ -59,47 +61,6 @@ LDFLAGS_VERSION = "\ | |
|
|
||
| all: build | ||
|
|
||
|
|
||
| .prefix: | ||
| mkdir -p build/linux | ||
|
|
@@ -115,7 +76,41 @@ help: | |
| .pre-fleetctl: | ||
| $(eval APP_NAME = fleetctl) | ||
|
|
||
| # For the build target, decide which binaries to build. | ||
| BINS_TO_BUILD = | ||
| ifeq (build,$(filter build,$(MAKECMDGOALS))) | ||
| BINS_TO_BUILD = fleet fleetctl | ||
| ifeq ($(ARG1), fleet) | ||
| BINS_TO_BUILD = fleet | ||
| else ifeq ($(ARG1), fleetctl) | ||
| BINS_TO_BUILD = fleetctl | ||
| endif | ||
| endif | ||
| .help-short--build: | ||
| @echo "Build binaries" | ||
| .help-long--build: | ||
| @echo "Builds the specified binaries (defaults to building fleet and fleetctl)" | ||
| .help-usage--build: | ||
| @echo "$(TOOL_CMD) build [binaries] [options]" | ||
| .help-options--build: | ||
| @echo "GO_BUILD_RACE_ENABLED" | ||
| @echo "Turn on data race detection when building" | ||
| @echo "EXTRA_FLEETCTL_LDFLAGS=\"--flag1 --flag2...\"" | ||
| @echo "Flags to provide to the Go linker when building fleetctl" | ||
| .help-extra--build: | ||
| @echo "AVAILABLE BINARIES:" | ||
| @echo " fleet Build the fleet binary" | ||
| @echo " fleetctl Build the fleetctl binary" | ||
| build: $(BINS_TO_BUILD) | ||
|
|
||
| .help-short--fdm: | ||
| @echo "Builds the fdm command" | ||
| fdm: | ||
| go build -o build/fdm ./tools/fdm | ||
| @if [ ! -f /usr/local/bin/fdm ]; then \ | ||
| echo "Linking to /usr/local/bin/fdm..."; \ | ||
| sudo ln -sf "$$(pwd)/build/fdm" /usr/local/bin/fdm; \ | ||
| fi | ||
|
|
||
| fleet: .prefix .pre-build .pre-fleet | ||
| CGO_ENABLED=1 go build -race=${GO_BUILD_RACE_ENABLED_VAR} -tags full,fts5,netgo -o build/${OUTPUT} -ldflags ${LDFLAGS_VERSION} ./cmd/fleet | ||
|
|
@@ -132,97 +127,155 @@ fleetctl: .prefix .pre-build .pre-fleetctl | |
| fleetctl-dev: GO_BUILD_RACE_ENABLED_VAR=true | ||
| fleetctl-dev: fleetctl | ||
|
|
||
| .help-short--lint-js: | ||
| @echo "Run the JavaScript linters" | ||
| lint-js: | ||
| yarn lint | ||
|
|
||
| .help-short--lint-go: | ||
| @echo "Run the Go linters" | ||
| lint-go: | ||
| golangci-lint run --exclude-dirs ./node_modules --timeout 15m | ||
|
|
||
| .help-short--lint: | ||
| @echo "Run linters" | ||
| .help-long--lint: | ||
| @echo "Runs the linters for Go and Javascript code. If linter type is not specified, all linters will be run." | ||
| .help-usage--lint: | ||
| @echo "$(TOOL_CMD) lint [linter-type]" | ||
| .help-extra--lint: | ||
| @echo "AVAILABLE LINTERS:" | ||
| @echo " go Lint Go files with golangci-lint" | ||
| @echo " js Lint .js, .jsx, .ts and .tsx files with eslint" | ||
|
|
||
| ifdef ARG1 | ||
| lint: lint-$(ARG1) | ||
| else | ||
| lint: lint-go lint-js | ||
| endif | ||
|
|
||
| .help-short--test-schema: | ||
| @echo "Update schema.sql from current migrations" | ||
| test-schema: | ||
| go run ./tools/dbutils ./server/datastore/mysql/schema.sql | ||
| dump-test-schema: test-schema | ||
|
|
||
| # This is the base command to run Go tests. | ||
| # Wrap this to run tests with presets (see `run-go-tests` and `test-go` targets). | ||
| # PKG_TO_TEST: Go packages to test, e.g. "server/datastore/mysql". Separate multiple packages with spaces. | ||
| # TESTS_TO_RUN: Name specific tests to run in the specified packages. Leave blank to run all tests in the specified packages. | ||
| # GO_TEST_EXTRA_FLAGS: Used to specify other arguments to `go test`. | ||
| # GO_TEST_MAKE_FLAGS: Internal var used by other targets to add arguments to `go test`. | ||
| PKG_TO_TEST := "" | ||
| go_test_pkg_to_test := $(addprefix ./,$(PKG_TO_TEST)) # set paths for packages to test | ||
| dlv_test_pkg_to_test := $(addprefix github.com/fleetdm/fleet/v4/,$(PKG_TO_TEST)) # set URIs for packages to debug | ||
|
Comment on lines
-158
to
-171
There was a problem hiding this comment. Moved this down next to the |
||
|
Comment on lines
-173
to
-174
There was a problem hiding this comment. @dantecatalfamo I think this was just for debugging? |
||
| .run-go-tests: | ||
| ifeq ($(PKG_TO_TEST), "") | ||
| @echo "Please specify one or more packages to test. See '$(TOOL_CMD) help run-go-tests' for more info."; | ||
| else | ||
| @echo Running Go tests with command: | ||
| go test -tags full,fts5,netgo -run=${TESTS_TO_RUN} ${GO_TEST_MAKE_FLAGS} ${GO_TEST_EXTRA_FLAGS} -parallel 8 -coverprofile=coverage.txt -covermode=atomic -coverpkg=github.com/fleetdm/fleet/v4/... $(go_test_pkg_to_test) | ||
| endif | ||
|
|
||
| # This is the base command to debug Go tests. | ||
| # Wrap this to run tests with presets (see `debug-go-tests`) | ||
| # DEBUG_TEST_EXTRA_FLAGS: Internal var used by other targets to add arguments to `dlv test`. | ||
| .debug-go-tests: | ||
| ifeq ($(PKG_TO_TEST), "") | ||
| @echo "Please specify one or more packages to debug. See '$(TOOL_CMD) help run-go-tests' for more info."; | ||
| else | ||
| @echo Debugging tests with command: | ||
| dlv test ${dlv_test_pkg_to_test} --api-version=2 --listen=127.0.0.1:61179 ${DEBUG_TEST_EXTRA_FLAGS} -- -test.v -test.run=${TESTS_TO_RUN} ${GO_TEST_EXTRA_FLAGS} | ||
| endif | ||
|
|
||
| .help-short--run-go-tests: | ||
| @echo "Run Go tests in specific packages" | ||
| .help-long--run-go-tests: | ||
| @echo Command to run specific tests in development. Can run all tests for one or more packages, or specific tests within packages. | ||
| .help-options--run-go-tests: | ||
| @echo "PKG_TO_TEST=\"pkg1 pkg2...\"" | ||
| @echo "Go packages to test, e.g. \"server/datastore/mysql\". Separate multiple packages with spaces." | ||
| @echo "TESTS_TO_RUN=\"test\"" | ||
| @echo Name specific tests to debug in the specified packages. Leave blank to debug all tests in the specified packages. | ||
| @echo "GO_TEST_EXTRA_FLAGS=\"--flag1 --flag2...\"" | ||
| @echo "Arguments to send to \"go test\"." | ||
| run-go-tests: | ||
| @MYSQL_TEST=1 REDIS_TEST=1 MINIO_STORAGE_TEST=1 SAML_IDP_TEST=1 NETWORK_TEST=1 make .run-go-tests GO_TEST_MAKE_FLAGS="-v" | ||
|
|
||
| .help-short--debug-go-tests: | ||
| @echo "Debug Go tests in specific packages (with Delve)" | ||
| .help-long--debug-go-tests: | ||
| @echo Command to run specific tests in the Go debugger. Can run all tests for one or more packages, or specific tests within packages. | ||
| .help-options--debug-go-tests: | ||
| @echo "PKG_TO_TEST=\"pkg1 pkg2...\"" | ||
| @echo "Go packages to test, e.g. \"server/datastore/mysql\". Separate multiple packages with spaces." | ||
| @echo "TESTS_TO_RUN=\"test\"" | ||
| @echo Name specific tests to debug in the specified packages. Leave blank to debug all tests in the specified packages. | ||
| @echo "GO_TEST_EXTRA_FLAGS=\"--flag1 --flag2...\"" | ||
| @echo "Arguments to send to \"go test\"." | ||
| debug-go-tests: | ||
| @MYSQL_TEST=1 REDIS_TEST=1 MINIO_STORAGE_TEST=1 SAML_IDP_TEST=1 NETWORK_TEST=1 make .debug-go-tests | ||
|
|
||
| # Set up packages for CI testing. | ||
| DEFAULT_PKG_TO_TEST := ./cmd/... ./ee/... ./orbit/pkg/... ./orbit/cmd/orbit ./pkg/... ./server/... ./tools/... | ||
| ifeq ($(CI_TEST_PKG), main) | ||
| CI_PKG_TO_TEST=$(shell go list ${DEFAULT_PKG_TO_TEST} | grep -v "server/datastore/mysql" | grep -v "cmd/fleetctl" | grep -v "server/vulnerabilities" | sed -e 's|github.com/fleetdm/fleet/v4/||g') | ||
| else ifeq ($(CI_TEST_PKG), integration) | ||
| CI_PKG_TO_TEST="server/service" | ||
| else ifeq ($(CI_TEST_PKG), mysql) | ||
| CI_PKG_TO_TEST="server/datastore/mysql/..." | ||
| else ifeq ($(CI_TEST_PKG), fleetctl) | ||
| CI_PKG_TO_TEST="cmd/fleetctl/..." | ||
| else ifeq ($(CI_TEST_PKG), vuln) | ||
| CI_PKG_TO_TEST="server/vulnerabilities/..." | ||
| else | ||
| CI_PKG_TO_TEST=$(DEFAULT_PKG_TO_TEST) | ||
| endif | ||
| # Command used in CI to run all tests. | ||
| .help-short--test-go: | ||
| @echo "Run Go tests for CI" | ||
| .help-long--test-go: | ||
| @echo "Run one or more bundle of Go tests. These are bundled together to try and make CI testing more parallelizable (and thus faster)." | ||
| .help-options--test-go: | ||
| @echo "CI_TEST_PKG=[test package]" | ||
| @echo "The test package bundle to run. If not specified, all Go tests will run." | ||
| .help-extra--test-go: | ||
| @echo "AVAILABLE TEST BUNDLES:" | ||
| @echo " integration" | ||
| @echo " mysql" | ||
| @echo " fleetctl" | ||
| @echo " vuln" | ||
| @echo " main (all tests not included in other bundles)" | ||
|
Comment on lines
+235
to
+248
|
||
| test-go: test-schema mock | ||
| make .run-go-tests PKG_TO_TEST="$(CI_PKG_TO_TEST)" | ||
|
|
||
| analyze-go: | ||
| go test -tags full,fts5,netgo -race -cover ./... | ||
|
|
||
| .help-short--test-js: | ||
| @echo "Run the JavaScript tests" | ||
| test-js: | ||
| yarn test | ||
|
|
||
| .help-short--test: | ||
| @echo "Run the full test suite (lint, Go and Javascript -- used in CI)" | ||
| test: lint test-go test-js | ||
|
|
||
| .help-short--generate: | ||
| @echo "Generate and bundle required Go code and Javascript code" | ||
| generate: clean-assets generate-js generate-go | ||
|
|
||
| generate-ci: | ||
| NODE_OPTIONS=--openssl-legacy-provider NODE_ENV=development yarn run webpack | ||
| make generate-go | ||
|
|
||
| .help-short--generate-js: | ||
| @echo "Generate and bundle required js code" | ||
| generate-js: clean-assets .prefix | ||
| NODE_ENV=production yarn run webpack --progress | ||
|
|
||
| .help-short--generate-go: | ||
| @echo "Generate and bundle required go code" | ||
| generate-go: .prefix | ||
| go run github.com/kevinburke/go-bindata/go-bindata -pkg=bindata -tags full \ | ||
| -o=server/bindata/generated.go \ | ||
|
|
@@ -231,20 +284,30 @@ generate-go: .prefix | |
| # we first generate the webpack bundle so that bindata knows to atch the | ||
| # output bundle file. then, generate debug bindata source file. finally, we | ||
| # run webpack in watch mode to continuously re-generate the bundle | ||
| .help-short--generate-dev: | ||
| @echo "Generate and bundle required Javascript code in a watch loop" | ||
| generate-dev: .prefix | ||
| NODE_ENV=development yarn run webpack --progress | ||
| go run github.com/kevinburke/go-bindata/go-bindata -debug -pkg=bindata -tags full \ | ||
| -o=server/bindata/generated.go \ | ||
| frontend/templates/ assets/... server/mail/templates | ||
| NODE_ENV=development yarn run webpack --progress --watch | ||
|
|
||
| .help-short--mock: | ||
| @echo "Update mock data store" | ||
| mock: .prefix | ||
| go generate github.com/fleetdm/fleet/v4/server/mock github.com/fleetdm/fleet/v4/server/mock/mockresult github.com/fleetdm/fleet/v4/server/service/mock | ||
| generate-mock: mock | ||
|
|
||
| .help-short--doc: | ||
| @echo "Generate updated API documentation for activities, osquery flags" | ||
| doc: .prefix | ||
| go generate github.com/fleetdm/fleet/v4/server/fleet | ||
| go generate github.com/fleetdm/fleet/v4/server/service/osquery_utils | ||
| generate-doc: doc | ||
|
|
||
| .help-short--deps: | ||
| @echo "Install dependent programs and libraries" | ||
| deps: deps-js deps-go | ||
|
|
||
| deps-js: | ||
|
|
@@ -263,14 +326,20 @@ check-go-cloner: | |
| update-go-cloner: | ||
| go run ./tools/cloner-check/main.go --update | ||
|
|
||
| .help-short--migration: | ||
| @echo "Create a database migration file (supply name=TheNameOfYourMigration)" | ||
| migration: | ||
| go run ./server/goose/cmd/goose -dir server/datastore/mysql/migrations/tables create $(name) | ||
| gofmt -w server/datastore/mysql/migrations/tables/*_$(name)*.go | ||
|
|
||
| .help-short--clean: | ||
| @echo "Clean all build artifacts" | ||
| clean: clean-assets | ||
| rm -rf build vendor | ||
| rm -f assets/bundle.js | ||
|
|
||
| .help-short--clean-assets: | ||
| @echo "Clean assets only" | ||
| clean-assets: | ||
| git clean -fx assets | ||
|
|
||
|
|
@@ -600,3 +669,8 @@ db-replica-reset: fleet | |
| # db-replica-run runs fleet serve with one main and one read MySQL instance. | ||
| db-replica-run: fleet | ||
| FLEET_MYSQL_ADDRESS=127.0.0.1:3308 FLEET_MYSQL_READ_REPLICA_ADDRESS=127.0.0.1:3309 FLEET_MYSQL_READ_REPLICA_USERNAME=fleet FLEET_MYSQL_READ_REPLICA_DATABASE=fleet FLEET_MYSQL_READ_REPLICA_PASSWORD=insecure ./build/fleet serve --dev --dev_license | ||
|
|
||
| include ./tools/makefile-support/helpsystem-targets | ||
|
|
||
| foo: | ||
| @echo $(MAKECMDGOALS) | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As per discussion here, this PR changes the Makefile targets:
The old targets are still there as aliases.