Update UnitTestBot Go docs #2283
Merged
Conversation
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
egiptipavel
added
ctg-documentation
Markoutte
approved these changes
Jun 13, 2023
docs/GoSupport.md
Outdated
| @@ -15,14 +15,14 @@ inserts these values into the user functions, and executes the resulting test ca | |||
|
|
|||
| ### Supported types for function parameters | |||
|
|
|||
| Now UnitTestBot Go can generate values for _primitive types_, _arrays_, _slices_ and _structs_. | |||
| Now UnitTestBot Go can generate values for _primitive types_, _arrays_, _slices_, _maps_, _structs_, _channels_, _interfaces_ and _pointers_. | |||
There was a problem hiding this comment.
Now UnitTestBot Go can generate values for primitive types, arrays, slices, maps, structs, channels, interfaces, and pointers.
docs/GoSupport.md
Outdated
| * `-f, --function TEXT`: specifies a function name to generate tests for. Can be used multiple times to select multiple functions. | ||
| * `-m, --method TEXT`: specifies a method name to generate tests for. Can be used multiple times to select multiple methods. | ||
| * `-go TEXT`, _required_: specifies a path to a Go executable. For example, `/usr/local/go/bin/go`. | ||
| * `-gopath TEXT`, _required_: specifies a path the location of your workspace. It defaults to a directory named `go` inside your home directory, so `$HOME/go` on Unix, `$home/go` on Plan 9, and `%USERPROFILE%\go` (usually `C:\Users\YourName\go`) on Windows. |
There was a problem hiding this comment.
-gopath TEXT, required: specifies a path to your workspace location. It defaults to a directory namedgoin your home directory:$HOME/gofor Unix,$home/gofor Plan 9, and%USERPROFILE%\go(usuallyC:\Users\YourName\go) for Windows.
docs/GoSupport.md
Outdated
| * `-m, --method TEXT`: specifies a method name to generate tests for. Can be used multiple times to select multiple methods. | ||
| * `-go TEXT`, _required_: specifies a path to a Go executable. For example, `/usr/local/go/bin/go`. | ||
| * `-gopath TEXT`, _required_: specifies a path the location of your workspace. It defaults to a directory named `go` inside your home directory, so `$HOME/go` on Unix, `$home/go` on Plan 9, and `%USERPROFILE%\go` (usually `C:\Users\YourName\go`) on Windows. | ||
| * `-parallel INT`: specifies the number of fuzzing processes running at once, default 8. |
There was a problem hiding this comment.
-parallel INT: specifies the number of fuzzing processes running at once (eight by default).
docs/GoSupport.md
Outdated
| * `-et, --each-execution-timeout INT`: specifies a timeout in milliseconds for each target function execution. | ||
| The default timeout is 1,000 ms. | ||
| * `-at, --all-execution-timeout INT`: specifies a timeout in milliseconds for all target function executions. | ||
| The default timeout is 60,000 ms. | ||
| * `-p, --print-test`: specifies whether a test should be printed out to `StdOut`. Disabled by default. | ||
| * `-w, --overwrite`: specifies whether to overwrite the output test file if it already exists. Disabled by default. | ||
| * `-fm, --fuzzing-mode`: stops test generation when a panic, error or timeout occurs (only one test will be generated for one of these cases). |
There was a problem hiding this comment.
-fm, --fuzzing-mode: stops test generation when apanicsituation, an error, or timeout occurs (only one test will be generated for one of these cases).
utbot-go/docs/DEVELOPER_GUIDE.md
Outdated
| ### Code instrumentation | ||
|
|
||
| UnitTestBot Go adds logging about the passage of a given line during the execution | ||
| after each line in functions. |
There was a problem hiding this comment.
After each line in a function, UnitTestBot Go adds logging about this line traversal during the execution.
utbot-go/docs/DEVELOPER_GUIDE.md
Outdated
| UnitTestBot Go collects information about the target functions: | ||
| * signatures and type information (in the basic version); | ||
| * constants in the function bodies (to be implemented). | ||
| UnitTestBot Go collects the size in bits of an int or uint value and information about the target functions: |
There was a problem hiding this comment.
UnitTestBot Go gains information about the int or uint value size in bits, and information about the target functions:
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Update UnitTestBot Go docs.
How to test
The PR introduces no code changes.
Manual scenario: the text itself has been previewed in the IntelliJ IDEA viewer.
Self-check list