|
| 1 | +# Configuration |
| 2 | + |
| 3 | +## Remote Scenario |
| 4 | + |
| 5 | +If you run UTBot and CLion on different hosts, synchronization of project files is required: |
| 6 | + |
| 7 | +- If UTBot is run inside the Docker container, mount your project folder to Docker. |
| 8 | +- If UTBot is run under WSL, no additional configuration required, just |
| 9 | +specify remote path to your project in `Settings` or use `Quickstart Wizard` to |
| 10 | +fill it for you. |
| 11 | +- If server is not run locally, CLion deployment can be used for synchronization, although it won't be |
| 12 | +fully automated, look at information below: |
| 13 | + |
| 14 | +### Configuring CLion SFTP deployment for remote scenario |
| 15 | + |
| 16 | +To configure SFTP do the following: |
| 17 | + |
| 18 | +- Open `Settings -> Build, Execution, Deployment -> Deployment` |
| 19 | +- Create SFTP configuration: click `+` and choose or create SSH config with server host and port, than |
| 20 | +specify the path to your project on the remote machine in mappings, it is the same path you have specified |
| 21 | +in `Settings` for remote path |
| 22 | +- Go to `Options` and turn on upload on change: |
| 23 | + |
| 24 | + |
| 25 | + |
| 26 | +- Go to `Project view` and right-click on your project root, then |
| 27 | + choose `Deployment`, click `Upload to ...` and choose the name of your |
| 28 | + SFTP configuration: |
| 29 | + |
| 30 | + |
| 31 | + |
| 32 | +Now server can access your project files. |
| 33 | + |
| 34 | +When you change your files, CLion should upload changes to server. |
| 35 | + |
| 36 | +## Local scenario |
| 37 | + |
| 38 | +Wizard allows you to configure your project quickly without specifying different options manually in |
| 39 | +`Settings`. When you open your project for the first time, UTBot Wizard will be shown. |
| 40 | + |
| 41 | + |
| 42 | + |
| 43 | +### Connection |
| 44 | + |
| 45 | +After the first introductory step, you will be asked to |
| 46 | +fill several settings: server port, server host and remote path. |
| 47 | +Remote path specifies path to project on remote machine. |
| 48 | + |
| 49 | +If UTBot is run on WSL or Linux (on the local machine), be sure |
| 50 | +to check the checkbox that fills in default values for the path and the port. |
| 51 | + |
| 52 | + |
| 53 | + |
| 54 | +### Build Directory and CMake Options |
| 55 | + |
| 56 | +On the final Wizard step, UTBot will ask you to: |
| 57 | +- specify relative path to the build directory |
| 58 | +- set custom CMake options |
| 59 | + |
| 60 | + |
| 61 | + |
| 62 | +### Demo |
| 63 | + |
| 64 | +A demo how to go through the wizard: |
| 65 | + |
| 66 | + |
| 67 | + |
| 68 | +## Plugin settings |
| 69 | + |
| 70 | +The recommended way to configure plugin is to use UTBot Wizard. |
| 71 | + |
| 72 | +If some advanced settings are required, specify them in `Settings -> Tools -> UTBot Settings` |
| 73 | + |
| 74 | + |
| 75 | + |
| 76 | +### Remote path |
| 77 | + |
| 78 | +Remote path is a path to your project on the remote host. If UTBot is run locally, leave it empty. |
| 79 | + |
| 80 | + |
| 81 | +## Check configuration |
| 82 | + |
| 83 | +When the connection to server is established, you can check project configuration |
| 84 | +to make sure that all path are specified correctly: just invoke `Configure project` action: |
| 85 | + |
| 86 | + |
| 87 | + |
| 88 | +When project is configured, `Project is configured` notification appears: |
| 89 | + |
| 90 | + |
| 91 | + |
| 92 | +When plugin is configured and configuration is checked, you can start using plugin to generate tests. |
| 93 | +For further details how to use plugin see `USAGE.md`. |
0 commit comments