Skip to content

Commit 07d0997

Browse files
vdarulisrobskillington
vdarulis
authored and
robskillington
committed
[ci] Use gofmt to rename generated identifiers (#2883)
1 parent 9509c82 commit 07d0997

File tree

8 files changed

+91
-60
lines changed

8 files changed

+91
-60
lines changed

‎Makefile

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -171,19 +171,19 @@ all: test-ci-unit test-ci-integration services tools
171171
.PHONY: install-tools
172172
install-tools:
173173
@echo "Installing build tools"
174-
GOBIN=$(tools_bin_path) go install github.com/fossas/fossa-cli/cmd/fossa
175-
GOBIN=$(tools_bin_path) go install github.com/golang/mock/mockgen
176-
GOBIN=$(tools_bin_path) go install github.com/google/go-jsonnet/cmd/jsonnet
177-
GOBIN=$(tools_bin_path) go install github.com/m3db/build-tools/utilities/genclean
178-
GOBIN=$(tools_bin_path) go install github.com/m3db/tools/update-license
179-
GOBIN=$(tools_bin_path) go install github.com/golangci/golangci-lint/cmd/golangci-lint
180-
GOBIN=$(tools_bin_path) go install github.com/mauricelam/genny
181-
GOBIN=$(tools_bin_path) go install github.com/mjibson/esc
182-
GOBIN=$(tools_bin_path) go install github.com/pointlander/peg
183-
GOBIN=$(tools_bin_path) go install github.com/robskillington/gorename
184-
GOBIN=$(tools_bin_path) go install github.com/rakyll/statik
185-
GOBIN=$(tools_bin_path) go install github.com/garethr/kubeval
186-
GOBIN=$(tools_bin_path) go install github.com/wjdp/htmltest
174+
GOBIN=$(tools_bin_path) go install \
175+
github.com/fossas/fossa-cli/cmd/fossa \
176+
github.com/golang/mock/mockgen \
177+
github.com/google/go-jsonnet/cmd/jsonnet \
178+
github.com/m3db/build-tools/utilities/genclean \
179+
github.com/m3db/tools/update-license \
180+
github.com/golangci/golangci-lint/cmd/golangci-lint \
181+
github.com/mauricelam/genny \
182+
github.com/mjibson/esc \
183+
github.com/pointlander/peg \
184+
github.com/rakyll/statik \
185+
github.com/garethr/kubeval \
186+
github.com/wjdp/htmltest
187187

188188
.PHONY: check-for-goreleaser-github-token
189189
check-for-goreleaser-github-token:
@@ -298,14 +298,12 @@ asset-gen-$(SUBDIR): install-tools
298298
@[ ! -d src/$(SUBDIR)/$(assets_rules_dir) ] || \
299299
PATH=$(combined_bin_paths):$(PATH) PACKAGE=$(m3_package) $(auto_gen) src/$(SUBDIR)/$(assets_output_dir) src/$(SUBDIR)/$(assets_rules_dir)
300300

301-
# NB(schallert): gorename (used by our genny process) doesn't work with go
302-
# modules https://github.com/golang/go/issues/34222
303301
.PHONY: genny-gen-$(SUBDIR)
304302
genny-gen-$(SUBDIR): install-tools
305303
@echo "--- Generating genny files $(SUBDIR)"
306304
@[ ! -f $(SELF_DIR)/src/$(SUBDIR)/generated-source-files.mk ] || \
307-
PATH=$(combined_bin_paths):$(PATH) GO111MODULE=off make -f $(SELF_DIR)/src/$(SUBDIR)/generated-source-files.mk $(genny_target)
308-
@PATH=$(combined_bin_paths):$(PATH) GO111MODULE=off bash -c "source ./scripts/auto-gen-helpers.sh && gen_cleanup_dir '*_gen.go' $(SELF_DIR)/src/$(SUBDIR)/ && gen_cleanup_dir '*_gen_test.go' $(SELF_DIR)/src/$(SUBDIR)/"
305+
PATH=$(combined_bin_paths):$(PATH) make -f $(SELF_DIR)/src/$(SUBDIR)/generated-source-files.mk $(genny_target)
306+
@PATH=$(combined_bin_paths):$(PATH) bash -c "source ./scripts/auto-gen-helpers.sh && gen_cleanup_dir '*_gen.go' $(SELF_DIR)/src/$(SUBDIR)/ && gen_cleanup_dir '*_gen_test.go' $(SELF_DIR)/src/$(SUBDIR)/"
309307

310308
.PHONY: license-gen-$(SUBDIR)
311309
license-gen-$(SUBDIR): install-tools

‎go.mod

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,6 @@ require (
9090
github.com/rakyll/statik v0.1.6
9191
github.com/remeh/sizedwaitgroup v1.0.0 // indirect
9292
github.com/rhysd/go-github-selfupdate v1.2.2 // indirect
93-
github.com/robskillington/gorename v0.0.0-20180424020013-52c7307cddd2
9493
github.com/rveen/ogdl v0.0.0-20200522080342-eeeda1a978e7 // indirect
9594
github.com/satori/go.uuid v1.2.0
9695
github.com/sergi/go-diff v1.1.0

‎go.sum

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -755,8 +755,6 @@ github.com/remeh/sizedwaitgroup v1.0.0 h1:VNGGFwNo/R5+MJBf6yrsr110p0m4/OX4S3DCy7
755755
github.com/remeh/sizedwaitgroup v1.0.0/go.mod h1:3j2R4OIe/SeS6YDhICBy22RWjJC5eNCJ1V+9+NVNYlo=
756756
github.com/rhysd/go-github-selfupdate v1.2.2 h1:G+mNzkc1wEtpmM6sFS/Ghkeq+ad4Yp6EZEHyp//wGEo=
757757
github.com/rhysd/go-github-selfupdate v1.2.2/go.mod h1:khesvSyKcXDUxeySCedFh621iawCks0dS/QnHPcpCws=
758-
github.com/robskillington/gorename v0.0.0-20180424020013-52c7307cddd2 h1:t+C9QFlvAI+evRn96lz7eKyzo1CgDx3YVx3N/GJIetk=
759-
github.com/robskillington/gorename v0.0.0-20180424020013-52c7307cddd2/go.mod h1:CVTJ4xwzb/4H98jrd7NFgNoTAiL63scr2Pl7kqOcQAQ=
760758
github.com/rogpeppe/fastuuid v0.0.0-20150106093220-6724a57986af/go.mod h1:XWv6SoW27p1b0cqNHllgS5HIMJraePCO15w5zCzIWYg=
761759
github.com/rogpeppe/fastuuid v1.1.0/go.mod h1:jVj6XXZzXRy/MSR5jhDC/2q6DgLz+nrA6LYCDYWNEvQ=
762760
github.com/rogpeppe/fastuuid v1.2.0/go.mod h1:jVj6XXZzXRy/MSR5jhDC/2q6DgLz+nrA6LYCDYWNEvQ=

‎src/dbnode/storage/id_list_gen.go

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/x/context/finalizeable_list_gen.go

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/x/generated-source-files.mk

Lines changed: 71 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@ gopath_prefix := $(GOPATH)/src
22
m3x_package := github.com/m3db/m3/src/x
33
m3x_package_path := $(gopath_prefix)/$(m3x_package)
44
temp_suffix := _temp
5-
gorename_package := github.com/robskillington/gorename
6-
gorename_package_version := 52c7307cddd221bb98f0a3215216789f3c821b10
75

86
# Tests that all currently generated types match their contents if they were regenerated
97
.PHONY: test-genny-all
@@ -53,25 +51,6 @@ ifneq ($(rename_type_prefix),)
5351
make hashmap-gen-rename rename_nogen_key="true"
5452
endif
5553

56-
.PHONY: hashmap-gen-rename-helper
57-
hashmap-gen-rename-helper:
58-
gorename -from '"$(target_package)$(temp_suffix)".Map' -to $(rename_type_prefix)Map
59-
gorename -from '"$(target_package)$(temp_suffix)".MapHash' -to $(rename_type_prefix)MapHash
60-
gorename -from '"$(target_package)$(temp_suffix)".HashFn' -to $(rename_type_prefix)MapHashFn
61-
gorename -from '"$(target_package)$(temp_suffix)".EqualsFn' -to $(rename_type_prefix)MapEqualsFn
62-
gorename -from '"$(target_package)$(temp_suffix)".CopyFn' -to $(rename_type_prefix)MapCopyFn
63-
gorename -from '"$(target_package)$(temp_suffix)".FinalizeFn' -to $(rename_type_prefix)MapFinalizeFn
64-
gorename -from '"$(target_package)$(temp_suffix)".MapEntry' -to $(rename_type_prefix)MapEntry
65-
gorename -from '"$(target_package)$(temp_suffix)".SetUnsafeOptions' -to $(rename_type_prefix)MapSetUnsafeOptions
66-
gorename -from '"$(target_package)$(temp_suffix)".mapAlloc' -to _$(rename_type_prefix)MapAlloc
67-
gorename -from '"$(target_package)$(temp_suffix)".mapOptions' -to _$(rename_type_prefix)MapOptions
68-
gorename -from '"$(target_package)$(temp_suffix)".mapKey' -to _$(rename_type_prefix)MapKey
69-
gorename -from '"$(target_package)$(temp_suffix)".mapKeyOptions' -to _$(rename_type_prefix)MapKeyOptions
70-
[ "$(rename_constructor)" = "" ] || \
71-
gorename -from '"$(target_package)$(temp_suffix)".NewMap' -to '$(rename_constructor)'
72-
[ "$(rename_constructor_options)" = "" ] || \
73-
gorename -from '"$(target_package)$(temp_suffix)".MapOptions' -to '$(rename_constructor_options)'
74-
7554
key_type_alias ?= $(key_type)
7655
value_type_alias ?= $(value_type)
7756
.PHONY: hashmap-gen-rename
@@ -95,11 +74,55 @@ ifeq ($(rename_nogen_value),)
9574
test "$(value_type_alias)" = "struct*" || echo 'type $(value_type_alias) interface{}' >> $(temp_outdir)/value.go
9675
endif
9776
mv $(out_dir)/map_gen.go $(temp_outdir)/map_gen.go
98-
make hashmap-gen-rename-helper
77+
78+
gofmt -w -r 'Map -> $(rename_type_prefix)Map' $(temp_outdir)/*_gen.go
79+
sed -i'tmp' 's#^// Map# // $(rename_type_prefix)Map#g' $(temp_outdir)/*_gen.go
80+
81+
gofmt -w -r 'MapHash -> $(rename_type_prefix)MapHash' $(temp_outdir)/*_gen.go
82+
sed -i'tmp' 's#^// MapHash# // $(rename_type_prefix)MapHash#g' $(temp_outdir)/*_gen.go
83+
84+
gofmt -w -r 'HashFn -> $(rename_type_prefix)MapHashFn' $(temp_outdir)/*_gen.go
85+
sed -i'tmp' 's#^// HashFn# // $(rename_type_prefix)MapHashFn#g' $(temp_outdir)/*_gen.go
86+
87+
gofmt -w -r 'EqualsFn -> $(rename_type_prefix)MapEqualsFn' $(temp_outdir)/*_gen.go
88+
sed -i'tmp' 's#^// EqualsFn# // $(rename_type_prefix)MapEqualsFn#g' $(temp_outdir)/*_gen.go
89+
90+
gofmt -w -r 'CopyFn -> $(rename_type_prefix)MapCopyFn' $(temp_outdir)/*_gen.go
91+
sed -i'tmp' 's#^// CopyFn# // $(rename_type_prefix)MapCopyFn#g' $(temp_outdir)/*_gen.go
92+
93+
gofmt -w -r 'FinalizeFn -> $(rename_type_prefix)MapFinalizeFn' $(temp_outdir)/*_gen.go
94+
sed -i'tmp' 's#^// FinalizeFn# // $(rename_type_prefix)MapFinalizeFn#g' $(temp_outdir)/*_gen.go
95+
96+
gofmt -w -r 'MapEntry -> $(rename_type_prefix)MapEntry' $(temp_outdir)/*_gen.go
97+
sed -i'tmp' 's#^// MapEntry# // $(rename_type_prefix)MapEntry#g' $(temp_outdir)/*_gen.go
98+
99+
gofmt -w -r 'SetUnsafeOptions -> $(rename_type_prefix)MapSetUnsafeOptions' $(temp_outdir)/*_gen.go
100+
sed -i'tmp' 's#^// SetUnsafeOptions# // $(rename_type_prefix)MapSetUnsafeOptions#g' $(temp_outdir)/*_gen.go
101+
102+
gofmt -w -r 'mapAlloc -> _$(rename_type_prefix)MapAlloc' $(temp_outdir)/*_gen.go
103+
sed -i'tmp' 's#^// mapAlloc#// _$(rename_type_prefix)MapAlloc#g' $(temp_outdir)/*_gen.go
104+
105+
gofmt -w -r 'mapOptions -> _$(rename_type_prefix)MapOptions' $(temp_outdir)/*_gen.go
106+
sed -i'tmp' 's#^// mapOptions#// _$(rename_type_prefix)MapOptions#g' $(temp_outdir)/*_gen.go
107+
108+
gofmt -w -r 'mapKey -> _$(rename_type_prefix)MapKey' $(temp_outdir)/*_gen.go
109+
sed -i'tmp' 's#^// mapKey#// _$(rename_type_prefix)MapKey#g' $(temp_outdir)/*_gen.go
110+
111+
gofmt -w -r 'mapKeyOptions -> _$(rename_type_prefix)MapKeyOptions' $(temp_outdir)/*_gen.go
112+
sed -i'tmp' 's#^// mapKeyOptions#// _$(rename_type_prefix)MapKeyOptions#g' $(temp_outdir)/*_gen.go
113+
114+
[ "$(rename_constructor)" = "" ] || \
115+
gofmt -w -r 'NewMap -> $(rename_constructor)' $(temp_outdir)/*_gen.go && \
116+
sed -i'tmp' 's#^// NewMap#// $(rename_constructor)#g' $(temp_outdir)/*_gen.go
117+
[ "$(rename_constructor_options)" = "" ] || \
118+
gofmt -w -r 'MapOptions -> $(rename_constructor_options)' $(temp_outdir)/*_gen.go && \
119+
sed -i'tmp' 's#^// MapOptions#// $(rename_constructor_options)#g' $(temp_outdir)/*_gen.go
120+
99121
mv $(temp_outdir)/map_gen.go $(out_dir)/map_gen.go
100122
! test -f $(temp_outdir)/new_map_gen.go || mv $(temp_outdir)/new_map_gen.go $(out_dir)/new_map_gen.go
101123
rm -f $(temp_outdir)/key.go
102124
rm -f $(temp_outdir)/value.go
125+
rm -f $(temp_outdir)/*.gotmp
103126
rmdir $(temp_outdir)
104127

105128
# Generation rule for all generated lists
@@ -150,6 +173,7 @@ ifneq ($(rename_type_prefix),)
150173
mv $(out_dir)/$(out_file) $(temp_outdir)/$(out_file)
151174
make arraypool-gen-rename out_dir=$(out_dir)
152175
mv $(temp_outdir)/$(out_file) $(out_dir)/$(out_file)
176+
rm -f $(temp_outdir)/*.gotmp
153177
rmdir $(temp_outdir)
154178
endif
155179

@@ -163,13 +187,19 @@ ifneq ($(rename_gen_types),)
163187
echo '' >> $(temp_outdir)/types.go
164188
echo "type $(elem_type_alias) interface{}" >> $(temp_outdir)/types.go
165189
endif
166-
gorename -from '"$(target_package)$(temp_suffix)".elemArrayPool' -to $(rename_type_prefix)ArrayPool
167-
gorename -from '"$(target_package)$(temp_suffix)".elemArr' -to $(rename_type_prefix)Arr
168-
gorename -from '"$(target_package)$(temp_suffix)".elemArrPool' -to $(rename_type_prefix)ArrPool
169-
gorename -from '"$(target_package)$(temp_suffix)".elemArrayPoolOpts' -to $(rename_type_prefix)ArrayPoolOpts
170-
gorename -from '"$(target_package)$(temp_suffix)".elemFinalizeFn' -to $(rename_type_prefix)FinalizeFn
171-
gorename -from '"$(target_package)$(temp_suffix)".newElemArrayPool' -to $(rename_constructor)
172-
gorename -from '"$(target_package)$(temp_suffix)".defaultElemFinalizerFn' -to default$(rename_type_middle)FinalizerFn
190+
gofmt -w -r 'elemArrayPool -> $(rename_type_prefix)ArrayPool' $(temp_outdir)/*.go
191+
gofmt -w -r 'elemArr -> $(rename_type_prefix)Arr' $(temp_outdir)/*.go
192+
gofmt -w -r 'elemArrPool -> $(rename_type_prefix)ArrPool' $(temp_outdir)/*.go
193+
gofmt -w -r 'elemArrayPoolOpts -> $(rename_type_prefix)ArrayPoolOpts' $(temp_outdir)/*.go
194+
gofmt -w -r 'elemFinalizeFn -> $(rename_type_prefix)FinalizeFn' $(temp_outdir)/*.go
195+
gofmt -w -r 'newElemArrayPool -> $(rename_constructor)' $(temp_outdir)/*.go
196+
gofmt -w -r 'defaultElemFinalizerFn -> default$(rename_type_middle)FinalizerFn' $(temp_outdir)/*.go
197+
198+
# best effort comment rename
199+
sed -i'tmp' 's#^// elemArr#// $(rename_type_prefix)Arr#g' $(temp_outdir)/*.go
200+
sed -i'tmp' 's#^// elemFinalizeFn#// $(rename_type_prefix)FinalizeFn#g' $(temp_outdir)/*.go
201+
sed -i'tmp' 's#^// newElemArrayPool#// $(rename_constructor)#g' $(temp_outdir)/*.go
202+
sed -i'tmp' 's#^// defaultElemFinalizerFn#// default$(rename_type_middle)FinalizerFn#g' $(temp_outdir)/*.go
173203
ifneq ($(rename_gen_types),)
174204
rm $(temp_outdir)/types.go
175205
endif
@@ -192,6 +222,7 @@ ifneq ($(rename_type_prefix),)
192222
mv $(out_dir)/list_gen.go $(temp_outdir)/list_gen.go
193223
make list-gen-rename out_dir=$(out_dir)
194224
mv $(temp_outdir)/list_gen.go $(out_dir)/list_gen.go
225+
rm -f $(temp_outdir)/*.gotmp
195226
rmdir $(temp_outdir)
196227
endif
197228

@@ -205,11 +236,17 @@ ifneq ($(rename_gen_types),)
205236
echo '' >> $(temp_outdir)/types.go
206237
echo "type $(elem_type_alias) interface{}" >> $(temp_outdir)/types.go
207238
endif
208-
gorename -from '"$(target_package)$(temp_suffix)".Element' -to $(rename_type_prefix)Element
209-
gorename -from '"$(target_package)$(temp_suffix)".List' -to $(rename_type_prefix)List
210-
gorename -from '"$(target_package)$(temp_suffix)".ElementPool' -to $(rename_type_prefix)ElementPool
211-
gorename -from '"$(target_package)$(temp_suffix)".newElementPool' -to new$(rename_type_middle)ElementPool
212-
gorename -from '"$(target_package)$(temp_suffix)".newList' -to new$(rename_type_middle)List
239+
gofmt -w -r 'Element -> $(rename_type_prefix)Element' $(temp_outdir)/*.go
240+
gofmt -w -r 'List -> $(rename_type_prefix)List' $(temp_outdir)/*.go
241+
gofmt -w -r 'ElementPool -> $(rename_type_prefix)ElementPool' $(temp_outdir)/*.go
242+
gofmt -w -r 'newElementPool -> new$(rename_type_middle)ElementPool' $(temp_outdir)/*.go
243+
gofmt -w -r 'newList -> new$(rename_type_middle)List' $(temp_outdir)/*.go
244+
# best-effort comment fixup
245+
sed -i'tmp' 's#^// Element#// $(rename_type_prefix)Element#g' $(temp_outdir)/*.go
246+
sed -i'tmp' 's#^// List#// $(rename_type_prefix)List#g' $(temp_outdir)/*.go
247+
sed -i'tmp' 's#^// ElementPool#// $(rename_type_prefix)ElementPool#g' $(temp_outdir)/*.go
248+
sed -i'tmp' 's#^// newElementPool#// new$(rename_type_middle)ElementPool#g' $(temp_outdir)/*.go
249+
sed -i'tmp' 's#^// newList#// new$(rename_type_middle)List#g' $(temp_outdir)/*.go
213250
ifneq ($(rename_gen_types),)
214251
rm $(temp_outdir)/types.go
215252
endif

‎src/x/generics/list/list.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ func (e *Element) Prev() *Element {
9999
}
100100

101101
// List represents a doubly linked list.
102-
// The zero value for List is an empty list ready to use.
102+
// The zero value is an empty, ready to use list.
103103
type List struct {
104104
root Element // sentinel list element, only &root, root.prev, and root.next are used
105105
len int // current list length excluding (this) sentinel element

‎tools.go

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,5 @@ import (
1313
_ "github.com/mjibson/esc"
1414
_ "github.com/pointlander/peg"
1515
_ "github.com/rakyll/statik"
16-
_ "github.com/robskillington/gorename"
1716
_ "github.com/wjdp/htmltest"
1817
)

0 commit comments

Comments
 (0)