Skip to content
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

Child process and utbot-instrumentation module design documentation #932

Open
sergeypospelov opened this issue Sep 15, 2022 · 0 comments
Open
Assignees
Labels
ctg-documentation Improvements or additions to documentation

Comments

@sergeypospelov
Copy link
Member

sergeypospelov commented Sep 15, 2022

Description

Add a documentation on the child process working pipeline and whole utbot-instrumentation module, as well as on a UtExecutionInstrumentation class.

Maybe we could create a draft page and add more aspects to it over time.

Details

What to include:

  • The base concept
  • API
    • Passing paths to user and dependency classes
  • Inter-process communication: RD
  • Kryo and serializing
  • Pipeline of loading a new class into JVM
  • Logging and errors file
  • A simple usage example
  • UtExecutionInstrumentation
    • API
    • MockValueConstructor
      • Mocks (Mockito, our own mocks)
    • Timeouts and ThreadBasedExecutor
    • UtModelConstructor
  • How to create your own instrumentations
@sergeypospelov sergeypospelov added the ctg-documentation Improvements or additions to documentation label Sep 15, 2022
@korifey korifey moved this to Todo in UTBot Java Sep 15, 2022
@sergeypospelov sergeypospelov mentioned this issue Sep 15, 2022
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ctg-documentation Improvements or additions to documentation
Projects
Status: Todo
Development

No branches or pull requests

2 participants