-
-
Notifications
You must be signed in to change notification settings - Fork 4.2k
fix(cmd): preserve protobuf raw descriptor blocks during template copy #3805
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
NepetaLemon
wants to merge
3
commits into
go-kratos:main
Choose a base branch
from
NepetaLemon:fix/avoid-corrupting-protobuf-generated-files
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+148
−8
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| package base | ||
|
|
||
| import ( | ||
| "strings" | ||
| "testing" | ||
| ) | ||
|
|
||
| func TestReplaceTemplateContentPreservesProtobufRawDesc(t *testing.T) { | ||
| const oldMod = "github.com/example/template" | ||
| const newMod = "github.com/example/service" | ||
|
|
||
| input := strings.Join([]string{ | ||
| "package conf", | ||
| "", | ||
| "import dep \"" + oldMod + "/api/greeter/v1\"", | ||
| "", | ||
| "const file_conf_conf_proto_rawDesc = \"\" +", | ||
| "\t\"\\n\" +", | ||
| "\t\"\\x0fconf/conf.proto\\x12\\n\" +", | ||
| "\t\"kratos.apiB7Z5" + oldMod + "/internal/conf;confb\\x06proto3\"", | ||
| "", | ||
| "var wireImport = \"" + oldMod + "/internal/server\"", | ||
| "", | ||
| }, "\n") | ||
|
|
||
| got := string(replaceTemplateContent([]byte(input), []string{oldMod, newMod})) | ||
|
|
||
| if !strings.Contains(got, `import dep "`+newMod+`/api/greeter/v1"`) { | ||
| t.Fatalf("expected import path to be replaced, got:\n%s", got) | ||
| } | ||
| if !strings.Contains(got, `var wireImport = "`+newMod+`/internal/server"`) { | ||
| t.Fatalf("expected regular string to be replaced, got:\n%s", got) | ||
| } | ||
| if !strings.Contains(got, `B7Z5`+oldMod+`/internal/conf;confb\x06proto3"`) { | ||
| t.Fatalf("expected protobuf raw descriptor to stay untouched, got:\n%s", got) | ||
| } | ||
| if strings.Contains(got, `B7Z5`+newMod+`/internal/conf;confb\x06proto3"`) { | ||
| t.Fatalf("protobuf raw descriptor was unexpectedly rewritten:\n%s", got) | ||
| } | ||
| } | ||
|
|
||
| func TestReplaceTemplateContentWithoutRawDescReplacesEverywhere(t *testing.T) { | ||
| const oldMod = "github.com/example/template" | ||
| const newMod = "github.com/example/service" | ||
|
|
||
| input := []byte(`package main | ||
|
|
||
| import _ "` + oldMod + `/internal/biz" | ||
|
|
||
| var modulePath = "` + oldMod + `" | ||
| `) | ||
|
|
||
| got := string(replaceTemplateContent(input, []string{oldMod, newMod})) | ||
|
|
||
| if strings.Contains(got, oldMod) { | ||
| t.Fatalf("expected all occurrences to be replaced, got:\n%s", got) | ||
| } | ||
| if !strings.Contains(got, newMod) { | ||
| t.Fatalf("expected replacement to be applied, got:\n%s", got) | ||
| } | ||
| } | ||
|
|
||
| func TestReplaceTemplateContentPreservesProtobufRawDescWithCRLF(t *testing.T) { | ||
| const oldMod = "github.com/example/template" | ||
| const newMod = "github.com/example/service" | ||
|
|
||
| input := strings.Join([]string{ | ||
| "package conf", | ||
| "", | ||
| "import dep \"" + oldMod + "/api/greeter/v1\"", | ||
| "", | ||
| "const file_conf_conf_proto_rawDesc = \"\" +", | ||
| "\t\"\\n\" +", | ||
| "\t\"\\x0fconf/conf.proto\\x12\\n\" +", | ||
| "\t\"kratos.apiB7Z5" + oldMod + "/internal/conf;confb\\x06proto3\"", | ||
| "", | ||
| "var wireImport = \"" + oldMod + "/internal/server\"", | ||
| "", | ||
| }, "\r\n") | ||
|
|
||
| got := string(replaceTemplateContent([]byte(input), []string{oldMod, newMod})) | ||
|
|
||
| if !strings.Contains(got, "import dep \""+newMod+"/api/greeter/v1\"\r\n") { | ||
| t.Fatalf("expected CRLF import path to be replaced, got:\n%s", got) | ||
| } | ||
| if !strings.Contains(got, "var wireImport = \""+newMod+"/internal/server\"\r\n") { | ||
| t.Fatalf("expected CRLF regular string to be replaced, got:\n%s", got) | ||
| } | ||
| if !strings.Contains(got, `B7Z5`+oldMod+`/internal/conf;confb\x06proto3"`) { | ||
| t.Fatalf("expected CRLF protobuf raw descriptor to stay untouched, got:\n%s", got) | ||
| } | ||
| if strings.Contains(got, `B7Z5`+newMod+`/internal/conf;confb\x06proto3"`) { | ||
| t.Fatalf("CRLF protobuf raw descriptor was unexpectedly rewritten:\n%s", got) | ||
| } | ||
| } | ||
|
|
||
| func TestReplaceTemplateContentReplacesLegacyProtobufByteDesc(t *testing.T) { | ||
| const oldMod = "github.com/example/template" | ||
| const newMod = "github.com/example/service" | ||
|
|
||
| input := strings.Join([]string{ | ||
| "package conf", | ||
| "", | ||
| "var file_conf_conf_proto_rawDesc = []byte{", | ||
| "\t0x42, 0x37, 0x5a, 0x35, // B7Z5", | ||
| "}", | ||
| "", | ||
| "const legacyPath = \"" + oldMod + "/internal/conf;conf\"", | ||
| "", | ||
| }, "\n") | ||
|
|
||
| got := string(replaceTemplateContent([]byte(input), []string{oldMod, newMod})) | ||
|
|
||
| if !strings.Contains(got, `const legacyPath = "`+newMod+`/internal/conf;conf"`) { | ||
| t.Fatalf("expected legacy protobuf file content to still be replaced, got:\n%s", got) | ||
| } | ||
| if strings.Contains(got, `const legacyPath = "`+oldMod+`/internal/conf;conf"`) { | ||
| t.Fatalf("legacy protobuf replacement did not occur, got:\n%s", got) | ||
| } | ||
| } | ||
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.
Uh oh!
There was an error while loading. Please reload this page.