-
Notifications
You must be signed in to change notification settings - Fork 236
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
replace bou.ke/monkey with bytedance/mockey (#570)
* replace monkey with gomonkey * add more tests * replace gomonkey with mockey * restore wait function * change the TestOpenLogFail case to work without monkey patching * use the TempDir to avoid messing with Unix/Windows --------- Co-authored-by: Pantelis Roditis <[email protected]>
- Loading branch information
1 parent
f5aea0f
commit 1ccb321
Showing
52 changed files
with
280 additions
and
79 deletions.
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
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
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
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
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 |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| /* | ||
| * Copyright (c) 2022, MegaEase | ||
| * All rights reserved. | ||
| * | ||
| * 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. | ||
| */ | ||
|
|
||
| // Package monkey is a library to patch functions and methods at runtime for testing | ||
| package monkey | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "log" | ||
| "reflect" | ||
| "runtime" | ||
| "sync" | ||
| "time" | ||
|
|
||
| "github.com/bytedance/mockey" | ||
| ) | ||
|
|
||
| var ( | ||
| patchesMap sync.Map | ||
| ) | ||
|
|
||
| // Patch replaces a function with another | ||
| func Patch(target, replacement interface{}) *mockey.Mocker { | ||
| key := fmt.Sprintf("%v", target) | ||
|
|
||
| // If an existing patch exists, reset and delete it | ||
| if existingPatches, ok := patchesMap.Load(key); ok { | ||
| existingPatches.(*mockey.Mocker).UnPatch() | ||
| patchesMap.Delete(key) | ||
| } | ||
|
|
||
| // Apply the new patch | ||
| patches := mockey.Mock(target).To(replacement).Build() | ||
| patchesMap.Store(key, patches) | ||
| wait() | ||
| return patches | ||
| } | ||
|
|
||
| // Unpatch removes a patch | ||
| func Unpatch(target interface{}) bool { | ||
| key := fmt.Sprintf("%v", target) | ||
|
|
||
| patches, ok := patchesMap.Load(key) | ||
| if !ok { | ||
| return false | ||
| } | ||
| patches.(*mockey.Mocker).UnPatch() | ||
| patchesMap.Delete(key) | ||
| wait() | ||
| return true | ||
| } | ||
|
|
||
| // PatchInstanceMethod replaces an instance method methodName for the type target with replacement | ||
| func PatchInstanceMethod(target reflect.Type, methodName string, replacement interface{}) *mockey.Mocker { | ||
| key := fmt.Sprintf("%v:%v", target, methodName) | ||
|
|
||
| // If an existing patch exists, reset and delete it | ||
| if existingPatches, ok := patchesMap.Load(key); ok { | ||
| existingPatches.(*mockey.Mocker).UnPatch() | ||
| patchesMap.Delete(key) | ||
| } | ||
|
|
||
| // Get the method | ||
| method, ok := target.MethodByName(methodName) | ||
| if !ok { | ||
| log.Fatalf("failed to patch by method %s not found", methodName) | ||
| return nil | ||
| } | ||
|
|
||
| // Check if the method is a function | ||
| methodValue := method.Func | ||
| if methodValue.Kind() != reflect.Func { | ||
| log.Fatalf("failed to patch by method %s is not a function", methodName) | ||
| return nil | ||
| } | ||
|
|
||
| // Apply the new patch | ||
| patches := mockey.Mock(methodValue.Interface()).To(replacement).Build() | ||
| patchesMap.Store(key, patches) | ||
| wait() | ||
| return patches | ||
| } | ||
|
|
||
| // UnpatchInstanceMethod removes a patch from an instance method | ||
| func UnpatchInstanceMethod(target reflect.Type, methodName string) bool { | ||
| key := fmt.Sprintf("%v:%v", target, methodName) | ||
|
|
||
| patches, ok := patchesMap.Load(key) | ||
| if !ok { | ||
| return false | ||
| } | ||
| patches.(*mockey.Mocker).UnPatch() | ||
| patchesMap.Delete(key) | ||
| wait() | ||
| return true | ||
| } | ||
|
|
||
| // UnpatchAll removes all patches | ||
| func UnpatchAll() { | ||
| patchesMap.Range(func(key, value interface{}) bool { | ||
| value.(*mockey.Mocker).UnPatch() | ||
| patchesMap.Delete(key) | ||
| return true | ||
| }) | ||
| wait() | ||
| } | ||
|
|
||
| // wait ensures that the patches for darwin/arm64 are applied to prevent test failures and runtime errors, such as invalid memory address or nil pointer dereference | ||
| func wait() { | ||
| if runtime.GOOS == "darwin" { | ||
| time.Sleep(100 * time.Millisecond) | ||
| } | ||
| } |
Oops, something went wrong.