# Copyright 2016 The Kubernetes Authors. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. DBG_MAKEFILE ?= ifeq ($(DBG_MAKEFILE),1) $(warning ***** starting Makefile for goal(s) "$(MAKECMDGOALS)") $(warning ***** $(shell date)) else # If we're not debugging the Makefile, don't echo recipes. MAKEFLAGS += -s endif # Old-skool build tools. # # Commonly used targets (see each target for more information): # all: Build code. # test: Run tests. # clean: Clean up. # It's necessary to set this because some environments don't link sh -> bash. SHELL := /bin/bash # We don't need make's built-in rules. MAKEFLAGS += --no-builtin-rules .SUFFIXES: # Constants used throughout. .EXPORT_ALL_VARIABLES: OUT_DIR ?= _output BIN_DIR := $(OUT_DIR)/bin PRJ_SRC_PATH := k8s.io/kubernetes GENERATED_FILE_PREFIX := zz_generated. # Metadata for driving the build lives here. META_DIR := .make # Our build flags. # TODO(thockin): it would be nice to just use the native flags. Can we EOL # these "wrapper" flags? KUBE_GOFLAGS := $(GOFLAGS) KUBE_GOLDFLAGS := $(GOLDFLAGS) KUBE_GOGCFLAGS = $(GOGCFLAGS) # This controls the verbosity of the build. Higher numbers mean more output. KUBE_VERBOSE ?= 1 define ALL_HELP_INFO # Build code. # # Args: # WHAT: Directory names to build. If any of these directories has a 'main' # package, the build will produce executable files under $(OUT_DIR)/go/bin. # If not specified, "everything" will be built. # GOFLAGS: Extra flags to pass to 'go' when building. # GOLDFLAGS: Extra linking flags passed to 'go' when building. # GOGCFLAGS: Additional go compile flags passed to 'go' when building. # # Example: # make # make all # make all WHAT=cmd/kubelet GOFLAGS=-v # make all GOGCFLAGS="-N -l" # Note: Use the -N -l options to disable compiler optimizations an inlining. # Using these build options allows you to subsequently use source # debugging tools like delve. endef .PHONY: all ifeq ($(PRINT_HELP),y) all: @echo "$$ALL_HELP_INFO" else all: generated_files hack/make-rules/build.sh $(WHAT) endif define GINKGO_HELP_INFO # Build ginkgo # # Example: # make ginkgo endef .PHONY: ginkgo ifeq ($(PRINT_HELP),y) ginkgo: @echo "$$GINKGO_HELP_INFO" else ginkgo: hack/make-rules/build.sh vendor/github.com/onsi/ginkgo/ginkgo endif define VERIFY_HELP_INFO # Runs all the presubmission verifications. # # Args: # BRANCH: Branch to be passed to verify-godeps.sh script. # # Example: # make verify # make verify BRANCH=branch_x endef .PHONY: verify ifeq ($(PRINT_HELP),y) verify: @echo "$$VERIFY_HELP_INFO" else verify: verify_generated_files KUBE_VERIFY_GIT_BRANCH=$(BRANCH) hack/make-rules/verify.sh -v hack/make-rules/vet.sh endif define UPDATE_HELP_INFO # Runs all the generated updates. # # Example: # make update endef .PHONY: update ifeq ($(PRINT_HELP),y) update: @echo "$$UPDATE_HELP_INFO" else update: hack/update-all.sh endif define CHECK_TEST_HELP_INFO # Build and run tests. # # Args: # WHAT: Directory names to test. All *_test.go files under these # directories will be run. If not specified, "everything" will be tested. # TESTS: Same as WHAT. # GOFLAGS: Extra flags to pass to 'go' when building. # GOLDFLAGS: Extra linking flags to pass to 'go' when building. # GOGCFLAGS: Additional go compile flags passed to 'go' when building. # # Example: # make check # make test # make check WHAT=pkg/kubelet GOFLAGS=-v endef .PHONY: check test ifeq ($(PRINT_HELP),y) check test: @echo "$$CHECK_TEST_HELP_INFO" else check test: generated_files hack/make-rules/test.sh $(WHAT) $(TESTS) endif define TEST_IT_HELP_INFO # Build and run integration tests. # # Args: # WHAT: Directory names to test. All *_test.go files under these # directories will be run. If not specified, "everything" will be tested. # # Example: # make test-integration endef .PHONY: test-integration ifeq ($(PRINT_HELP),y) test-integration: @echo "$$TEST_IT_HELP_INFO" else test-integration: generated_files hack/make-rules/test-integration.sh $(WHAT) endif define TEST_E2E_HELP_INFO # Build and run end-to-end tests. # # Example: # make test-e2e endef .PHONY: test-e2e ifeq ($(PRINT_HELP),y) test-e2e: @echo "$$TEST_E2E_HELP_INFO" else test-e2e: ginkgo generated_files go run hack/e2e.go -v --build --up --test --down endif define TEST_E2E_NODE_HELP_INFO # Build and run node end-to-end tests. # # Args: # FOCUS: Regexp that matches the tests to be run. Defaults to "". # SKIP: Regexp that matches the tests that needs to be skipped. Defaults # to "". # RUN_UNTIL_FAILURE: If true, pass --untilItFails to ginkgo so tests are run # repeatedly until they fail. Defaults to false. # REMOTE: If true, run the tests on a remote host instance on GCE. Defaults # to false. # IMAGES: For REMOTE=true only. Comma delimited list of images for creating # remote hosts to run tests against. Defaults to a recent image. # LIST_IMAGES: If true, don't run tests. Just output the list of available # images for testing. Defaults to false. # HOSTS: For REMOTE=true only. Comma delimited list of running gce hosts to # run tests against. Defaults to "". # DELETE_INSTANCES: For REMOTE=true only. Delete any instances created as # part of this test run. Defaults to false. # ARTIFACTS: For REMOTE=true only. Local directory to scp test artifacts into # from the remote hosts. Defaults to "/tmp/_artifacts". # REPORT: For REMOTE=false only. Local directory to write juntil xml results # to. Defaults to "/tmp/". # CLEANUP: For REMOTE=true only. If false, do not stop processes or delete # test files on remote hosts. Defaults to true. # IMAGE_PROJECT: For REMOTE=true only. Project containing images provided to # IMAGES. Defaults to "kubernetes-node-e2e-images". # INSTANCE_PREFIX: For REMOTE=true only. Instances created from images will # have the name "${INSTANCE_PREFIX}-${IMAGE_NAME}". Defaults to "test". # INSTANCE_METADATA: For REMOTE=true and running on GCE only. # GUBERNATOR: For REMOTE=true only. Produce link to Gubernator to view logs. # Defaults to false. # PARALLELISM: The number of gingko nodes to run. Defaults to 8. # # Example: # make test-e2e-node FOCUS=Kubelet SKIP=container # make test-e2e-node REMOTE=true DELETE_INSTANCES=true # make test-e2e-node TEST_ARGS="--experimental-cgroups-per-qos=true" # Build and run tests. endef .PHONY: test-e2e-node ifeq ($(PRINT_HELP),y) test-e2e-node: @echo "$$TEST_E2E_NODE_HELP_INFO" else test-e2e-node: ginkgo generated_files hack/make-rules/test-e2e-node.sh endif define TEST_CMD_HELP_INFO # Build and run cmdline tests. # # Example: # make test-cmd endef .PHONY: test-cmd ifeq ($(PRINT_HELP),y) test-cmd: @echo "$$TEST_CMD_HELP_INFO" else test-cmd: generated_files hack/make-rules/test-kubeadm-cmd.sh hack/make-rules/test-cmd.sh hack/make-rules/test-federation-cmd.sh endif define CLEAN_HELP_INFO # Remove all build artifacts. # # Example: # make clean # # TODO(thockin): call clean_generated when we stop committing generated code. endef .PHONY: clean ifeq ($(PRINT_HELP),y) clean: @echo "$$CLEAN_HELP_INFO" else clean: clean_meta build/make-clean.sh rm -rf $(OUT_DIR) rm -rf Godeps/_workspace # Just until we are sure it is gone endif define CLEAN_META_HELP_INFO # Remove make-related metadata files. # # Example: # make clean_meta endef .PHONY: clean_meta ifeq ($(PRINT_HELP),y) clean_meta: @echo "$$CLEAN_META_HELP_INFO" else clean_meta: rm -rf $(META_DIR) endif define CLEAN_GENERATED_HELP_INFO # Remove all auto-generated artifacts. Generated artifacts in staging folder should not be removed as they are not # generated using generated_files. # # Example: # make clean_generated endef .PHONY: clean_generated ifeq ($(PRINT_HELP),y) clean_generated: @echo "$$CLEAN_GENERATED_HELP_INFO" else clean_generated: find . -type f -name $(GENERATED_FILE_PREFIX)\* | grep -v "[.]/staging/.*" | xargs rm -f endif define VET_HELP_INFO # Run 'go vet'. # # Args: # WHAT: Directory names to vet. All *.go files under these # directories will be vetted. If not specified, "everything" will be # vetted. # # Example: # make vet # make vet WHAT=pkg/kubelet endef .PHONY: vet ifeq ($(PRINT_HELP),y) vet: @echo "$$VET_HELP_INFO" else vet: hack/make-rules/vet.sh $(WHAT) endif define RELEASE_HELP_INFO # Build a release # # Example: # make release endef .PHONY: release ifeq ($(PRINT_HELP),y) release: @echo "$$RELEASE_HELP_INFO" else release: build/release.sh endif define RELEASE_SKIP_TESTS_HELP_INFO # Build a release, but skip tests # # Example: # make release-skip-tests endef .PHONY: release-skip-tests quick-release ifeq ($(PRINT_HELP),y) release-skip-tests quick-release: @echo "$$RELEASE_SKIP_TESTS_HELP_INFO" else release-skip-tests quick-release: KUBE_RELEASE_RUN_TESTS=n KUBE_FASTBUILD=true build/release.sh endif define CROSS_HELP_INFO # Cross-compile for all platforms # # Example: # make cross endef .PHONY: cross ifeq ($(PRINT_HELP),y) cross: @echo "$$CROSS_HELP_INFO" else cross: hack/make-rules/cross.sh endif define CMD_HELP_INFO # Add rules for all directories in cmd/ # # Example: # make kubectl kube-proxy endef #TODO: make EXCLUDE_TARGET auto-generated when there are other files in cmd/ #TODO: should we exclude the target "libs" but include "cmd/libs/go2idl/*"? EXCLUDE_TARGET=OWNERS .PHONY: $(filter-out %$(EXCLUDE_TARGET),$(notdir $(abspath $(wildcard cmd/*/)))) ifeq ($(PRINT_HELP),y) $(filter-out %$(EXCLUDE_TARGET),$(notdir $(abspath $(wildcard cmd/*/)))): @echo "$$CMD_HELP_INFO" else $(filter-out %$(EXCLUDE_TARGET),$(notdir $(abspath $(wildcard cmd/*/)))): generated_files hack/make-rules/build.sh cmd/$@ endif define PLUGIN_CMD_HELP_INFO # Add rules for all directories in plugin/cmd/ # # Example: # make kube-scheduler endef .PHONY: $(notdir $(abspath $(wildcard plugin/cmd/*/))) ifeq ($(PRINT_HELP),y) $(notdir $(abspath $(wildcard plugin/cmd/*/))): @echo "$$PLUGIN_CMD_HELP_INFO" else $(notdir $(abspath $(wildcard plugin/cmd/*/))): generated_files hack/make-rules/build.sh plugin/cmd/$@ endif define FED_CMD_HELP_INFO # Add rules for all directories in federation/cmd/ # # Example: # make federation-apiserver federation-controller-manager endef .PHONY: $(notdir $(abspath $(wildcard federation/cmd/*/))) ifeq ($(PRINT_HELP),y) $(notdir $(abspath $(wildcard federation/cmd/*/))): @echo "$$FED_CMD_HELP_INFO" else $(notdir $(abspath $(wildcard federation/cmd/*/))): generated_files hack/make-rules/build.sh federation/cmd/$@ endif define GENERATED_FILES_HELP_INFO # Produce auto-generated files needed for the build. # # Example: # make generated_files endef .PHONY: generated_files ifeq ($(PRINT_HELP),y) generated_files: @echo "$$GENERATED_FILES_HELP_INFO" else generated_files: $(MAKE) -f Makefile.generated_files $@ CALLED_FROM_MAIN_MAKEFILE=1 endif define VERIFY_GENERATED_FILES_HELP_INFO # Verify auto-generated files needed for the build. # # Example: # make verify_generated_files endef .PHONY: verify_generated_files ifeq ($(PRINT_HELP),y) verify_generated_files: @echo "$$VERIFY_GENERATED_FILES_HELP_INFO" else verify_generated_files: $(MAKE) -f Makefile.generated_files $@ CALLED_FROM_MAIN_MAKEFILE=1 endif define HELP_INFO # Print make targets and help info # # Example: # make help endef .PHONY: help ifeq ($(PRINT_HELP),y) help: @echo "$$HELP_INFO" else help: hack/make-rules/make-help.sh endif # Non-dockerized bazel rules. .PHONY: bazel-build bazel-test ifeq ($(PRINT_HELP),y) define BAZEL_BUILD_HELP_INFO # Build with bazel # # Example: # make bazel-build endef bazel-build: @echo "$$BAZEL_BUILD_HELP_INFO" else bazel-build: bazel build //cmd/... //pkg/... //federation/... //plugin/... //build/... //examples/... //test/... //third_party/... endif ifeq ($(PRINT_HELP),y) bazel-test: define BAZEL_TEST_HELP_INFO # Test with bazel # # Example: # make bazel-test endef @echo "$$BAZEL_TEST_HELP_INFO" else bazel-test: bazel test --test_output=errors //cmd/... //pkg/... //federation/... //plugin/... //build/... //third_party/... //hack/... endif