Skip to content

Commit

Permalink
Don't check in generated conversion code
Browse files Browse the repository at this point in the history 
Conversion is now generated by Makefile, on demand, rather than all at once.
Manually verified no net change in generated code.
  • Loading branch information
@thockin
thockin committed Jul 13, 2016
1 parent db42d52 commit 9eb42ff
Show file tree
Hide file tree
Showing 20 changed files with 195 additions and 12,826 deletions.
3 changes: 3 additions & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,3 +100,6 @@ kubernetes.tar.gz

# generated files in any directory
zz_generated.*

# make-related metadata
.make.*
216 changes: 192 additions & 24 deletions Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ OUT_DIR = _output
BIN_DIR := $(OUT_DIR)/bin
PRJ_SRC_PATH := k8s.io/kubernetes
GENERATED_FILE_PREFIX := zz_generated.
MAKE_METAFILE_PREFIX := .make.

KUBE_GOFLAGS = $(GOFLAGS)
export KUBE_GOFLAGS
Expand All @@ -44,7 +45,9 @@ export KUBE_GOLDFLAGS
# make
# make all
# make all WHAT=cmd/kubelet GOFLAGS=-v
all: gen_deepcopy build
#
# TODO: It's a not ideal that we build the tools on every invocation.
all: gen_deepcopy gen_conversion build
.PHONY: all

# Build ginkgo
Expand All @@ -55,7 +58,7 @@ ginkgo:
hack/make-rules/build.sh vendor/github.com/onsi/ginkgo/ginkgo
.PHONY: ginkgo

# This is a helper to break circular dependencies.
# This is a helper to break circular dependencies with recursive `make` calls.
build:
@hack/make-rules/build.sh $(WHAT)
.PHONY: build
Expand Down Expand Up @@ -85,23 +88,23 @@ verify:
# make check
# make test
# make check WHAT=pkg/kubelet GOFLAGS=-v
check test: gen_deepcopy
check test: gen_deepcopy gen_conversion
@hack/make-rules/test.sh $(WHAT) $(TESTS)
.PHONY: check test

# Build and run integration tests.
#
# Example:
# make test-integration
test-integration: gen_deepcopy
test-integration: gen_deepcopy gen_conversion
@hack/make-rules/test-integration.sh
.PHONY: test-integration

# Build and run end-to-end tests.
#
# Example:
# make test-e2e
test-e2e: ginkgo gen_deepcopy
test-e2e: ginkgo gen_deepcopy gen_conversion
@go run hack/e2e.go -v --build --up --test --down
.PHONY: test-e2e

Expand All @@ -126,9 +129,9 @@ test-e2e: ginkgo gen_deepcopy
# make test-e2e-node FOCUS=kubelet SKIP=container
# make test-e2e-node REMOTE=true DELETE_INSTANCES=true
# Build and run tests.
test-e2e-node: ginkgo gen_deepcopy
@hack/make-rules/test-e2e-node.sh
.PHONY: test-e2e-node
test-e2e_node: ginkgo gen_deepcopy gen_conversion
@hack/make-rules/test-e2e_node.sh
.PHONY: test-e2e_node

# Build and run cmdline tests.
#
Expand All @@ -142,12 +145,20 @@ test-cmd:
#
# Example:
# make clean
clean: clean_generated
clean: clean_generated clean_meta
build/make-clean.sh
rm -rf $(OUT_DIR)
rm -rf Godeps/_workspace # Just until we are sure it is gone
.PHONY: clean

# Remove make-related metadata files.
#
# Example:
# make clean_meta
clean_meta:
find . -type f -name $(MAKE_METAFILE_PREFIX)\* | xargs rm -f
.PHONE: clean_meta

# Remove all auto-generated artifacts.
#
# Example:
Expand All @@ -174,35 +185,79 @@ vet:
#
# Example:
# make release
release: gen_deepcopy
release: gen_deepcopy gen_conversion
@build/release.sh
.PHONY: release

# Build a release, but skip tests
#
# Example:
# make release-skip-tests
release-skip-tests quick-release: gen_deepcopy
release-skip-tests quick-release: gen_deepcopy gen_conversion
@KUBE_RELEASE_RUN_TESTS=n KUBE_FASTBUILD=true build/release.sh
.PHONY: release-skip-tests quick-release

#
# Code-generation logic.
#

# This variable holds a list of every directory that contains Go files in this
# project. Other rules and variables can use this as a starting point to
# reduce filesystem accesses.
ALL_GO_DIRS := $(shell \
find . \
-not \( \
\( \
-path ./vendor -o \
-path ./_\* -o \
-path ./.\* \
\) -prune \
\) \
-type f -name \*.go \
| sed 's|^./||' \
| xargs dirname \
| sort -u \
)

# The name of the make metadata file listing Go files.
GOFILES_METAFILE := $(MAKE_METAFILE_PREFIX)gofiles

# Establish a dependency between the deps file and the dir. Whenever a dir
# changes (files added or removed) the deps file will be considered stale.
#
# This is looser than we really need (e.g. we don't really care about non *.go
# files or even *_test.go files), but this is much easier to represent.
#
# Because we 'sinclude' the deps file, it is considered for rebuilding, as part
# of make's normal evaluation.
#
# The '$(eval)' is needed because this has a different RHS for each LHS, and
# would otherwise produce results that make can't parse.
$(foreach dir, $(ALL_GO_DIRS), $(eval \
$(dir)/$(GOFILES_METAFILE): $(dir) \
))

# How to rebuild a deps file. When make determines that the deps file is stale
# (see above), it executes this rule, and then re-loads the deps file.
#
# This is looser than we really need (e.g. we don't really care about test
# files), but this is MUCH faster than calling `go list`.
$(foreach dir, $(ALL_GO_DIRS), $(dir)/$(GOFILES_METAFILE)):
@FILES=$$(ls $(@D)/*.go | grep -v $(GENERATED_FILE_PREFIX)); \
echo "gofiles__$(@D) := $$(echo $${FILES})" >$@

# Include any deps files as additional Makefile rules. This triggers make to
# consider the deps files for rebuild, which makes the whole
# dependency-management logic work. 'sinclude' is "silent include" which does
# not fail if the file does not exist.
$(foreach dir, $(ALL_GO_DIRS), $(eval sinclude $(dir)/$(GOFILES_METAFILE)))

# Generate a list of all files that have a `+k8s:` comment-tag. This will be
# used to derive lists of files/dirs for generation tools.
ALL_K8S_TAG_FILES := $(shell \
find . \
-not \( \
\( \
-path ./vendor -o \
-path ./$(OUT_DIR) -o \
-path ./.git \
\) -prune \
\) \
-type f -name \*.go | xargs grep -l '^// \?+k8s:' \
)
ALL_K8S_TAG_FILES := $(shell \
find $(ALL_GO_DIRS) -maxdepth 1 -type f -name \*.go \
| xargs grep -l '^// *+k8s:' \
)

#
# Deep-copy generation
Expand Down Expand Up @@ -242,8 +297,10 @@ gen_deepcopy:
#
# The '$(eval)' is needed because this has a different RHS for each LHS, and
# would otherwise produce results that make can't parse.
$(foreach dir, $(DEEP_COPY_DIRS), \
$(eval $(dir)/$(DEEP_COPY_FILENAME): $(shell ls $(dir)/*.go | grep -v $(GENERATED_FILE_PREFIX))))
$(foreach dir, $(DEEP_COPY_DIRS), $(eval \
$(dir)/$(DEEP_COPY_FILENAME): $(dir)/$(GOFILES_METAFILE) \
$(gofiles__$(dir)) \
))

# For each dir in DEEP_COPY_DIRS, handle deep-copy generation.
# This has to be done in two steps because wildcards don't seem to work in
Expand All @@ -253,3 +310,114 @@ $(addsuffix /$(DEEP_COPY_FILENAME), $(DEEP_COPY_DIRS)):
-i $(PRJ_SRC_PATH)/$$(dirname $@) \
--bounding-dirs $(PRJ_SRC_PATH) \
-O $(DEEP_COPY_BASENAME)

#
# Conversion generation
#
# Any package that wants conversion functions generated must include one or
# more comment-tags in any .go file, in column 0, of the form:
# // +k8s:conversion-gen=<CONVERSION_TARGET_DIR>
#
# The CONVERSION_TARGET_DIR is a project-local path to another directory which
# should be considered when evaluating peer types for conversions. Types which
# are found in the source package (where conversions are being generated)
# but do not have a peer in one of the target directories will not have
# conversions generated.
#
# TODO: it might be better in the long term to make peer-types explicit in the
# IDL.

# All directories that request any form of conversion generation.
CONVERSION_DIRS := $(shell \
grep '^// *+k8s:conversion-gen=' $(ALL_K8S_TAG_FILES) \
| cut -f1 -d: \
| xargs dirname \
| sort -u \
)

# The result file, in each pkg, of conversion generation.
CONVERSION_BASENAME := $(GENERATED_FILE_PREFIX)conversion
CONVERSION_FILENAME := $(CONVERSION_BASENAME).go

# The name of the make metadata file controlling conversions.
CONVERSIONS_METAFILE := $(MAKE_METAFILE_PREFIX)conversions

# Unfortunately there's not a good way to use Go's build tools to check
# if a binary needs to be rebuilt. We just have to try it.
gen_conversion:
@$(MAKE) -s build WHAT=cmd/libs/go2idl/conversion-gen
@$(MAKE) -s $(addsuffix /$(CONVERSION_FILENAME), $(CONVERSION_DIRS))

# Establish a dependency between the deps file and the dir. Whenever a dir
# changes (files added or removed) the deps file will be considered stale.
#
# This is looser than we really need (e.g. we don't really care about non *.go
# files or even *_test.go files), but this is much easier to represent.
#
# Because we 'sinclude' the deps file, it is considered for rebuilding, as part
# of make's normal evaluation.
#
# The '$(eval)' is needed because this has a different RHS for each LHS, and
# would otherwise produce results that make can't parse.
$(foreach dir, $(CONVERSION_DIRS), $(eval $(dir)/$(CONVERSIONS_METAFILE): $(dir)))

# How to rebuild a deps file. When make determines that the deps file is stale
# (see above), it executes this rule, and then re-loads the deps file.
#
# This is looser than we really need (e.g. we don't really care about test
# files), but this is MUCH faster than calling `go list`.
$(foreach dir, $(CONVERSION_DIRS), $(dir)/$(CONVERSIONS_METAFILE)):
@TAGS=$$(grep -h '^// *+k8s:conversion-gen=' $(@D)/*.go \
| cut -f2- -d= \
| sed 's|$(PRJ_SRC_PATH)/||'); \
echo "conversions__$(@D) := $$(echo $${TAGS})" >$@

# Include any deps files as additional Makefile rules. This triggers make to
# consider the deps files for rebuild, which makes the whole
# dependency-management logic work. 'sinclude' is "silent include" which does
# not fail if the file does not exist.
$(foreach dir, $(CONVERSION_DIRS), $(eval sinclude $(dir)/$(CONVERSIONS_METAFILE)))

# For each dir in CONVERSION_DIRS, this generates a statement of the form:
# path/to/dir/$(CONVERSION_FILENAME): path/to/dir/$(GOFILES_METAFILE) \
# $(gofiles__path/to/dir)
# The variable value was set in $(GOFILES_METAFILE) and included as part of the
# dependency management logic.
#
# Note that this is a deps-only statement, not a full rule (see below).
# This has to be done in a distinct step because wildcards don't seem to work
# in static pattern rules.
#
# The '$(eval)' is needed because this has a different RHS for each LHS, and
# would otherwise produce results that make can't parse.
$(foreach dir, $(CONVERSION_DIRS), $(eval \
$(dir)/$(CONVERSION_FILENAME): $(dir)/$(GOFILES_METAFILE) \
$(gofiles__$(dir)) \
))

# For each dir in CONVERSION_DIRS, for each target in $(conversions__$(dir)),
# this generates a statement of the form:
# path/to/dir/$(CONVERSION_FILENAME): /path/to/target/$(GOFILES_METAFILE) \
# $(gofiles__path/to/target/)
# The variable value was set in $(GOFILES_METAFILE) and included as part of the
# dependency management logic.
#
# Note that this is a deps-only statement, not a full rule (see below).
# This has to be done in a distinct step because wildcards don't seem to work
# in static pattern rules.
#
# The '$(eval)' is needed because this has a different RHS for each LHS, and
# would otherwise produce results that make can't parse.
$(foreach dir, $(CONVERSION_DIRS), \
$(foreach tgt, $(conversions__$(dir)), $(eval \
$(dir)/$(CONVERSION_FILENAME): $(tgt)/$(GOFILES_METAFILE) \
$(gofiles__$(tgt)) \
)) \
)

# For each dir in CONVERSION_DIRS, this generates a rule to auto-generate
# conversion code. Dependencies of the target have been populated above.
$(addsuffix /$(CONVERSION_FILENAME), $(CONVERSION_DIRS)):
@$(BIN_DIR)/conversion-gen \
-i $(PRJ_SRC_PATH)/$(@D) \
-O $(CONVERSION_BASENAME)
56 changes: 0 additions & 56 deletions federation/apis/core/conversion.go
View file

This file was deleted.

3 changes: 0 additions & 3 deletions federation/apis/core/register.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,4 @@ func AddToScheme(scheme *runtime.Scheme) {
&unversioned.APIGroup{},
&unversioned.APIResourceList{},
)

addDefaultingFuncs(scheme)
addConversionFuncs(scheme)
}
Loading

0 comments on commit 9eb42ff

Please sign in to comment.