UnitTestBot · EgorkaKulikov · Aug 12, 2022 · Feb 27, 2022 · Jul 25, 2022 · Jul 26, 2022
diff --git a/.github/workflows/build-utbot.yml b/.github/workflows/build-utbot.yml
@@ -94,6 +94,23 @@ jobs:
           ./docker/action-scripts/build-vsix.sh
           chmod +x docker/action-scripts/integration-tests.sh
           ./docker/action-scripts/integration-tests.sh
+      - name: Setup Java for building CLion plugin
+        uses: actions/setup-java@v3
+        with:
+          distribution: zulu
+          java-version: 11
+      - name: Run CLion integration tests
+        run: |
+          chmod +x docker/action-scripts/runClionIntegrationTests.sh 
+          ./docker/action-scripts/runClionIntegrationTests.sh
+      - name: Upload logs
+        uses: actions/upload-artifact@v2
+        if: failure()
+        with:
+          name: test-report
+          path: |
+            /github/home/logs
+            clion-plugin/build/reports/tests/**/*
 
   build-utbot-and-generate-test:
     needs: matrix-prep

diff --git a/.github/workflows/publish-utbot.yml b/.github/workflows/publish-utbot.yml
@@ -65,6 +65,15 @@ jobs:
         run: |
           chmod +x docker/action-scripts/build-vsix.sh
           ./docker/action-scripts/build-vsix.sh
+      - name: Setup Java for building CLion plugin
+        uses: actions/setup-java@v3
+        with:
+          distribution: zulu
+          java-version: 11
+      - name: build CLion plugin
+        run: |
+          chmod +x docker/action-scripts/build-clion-plugin.sh
+          ./docker/action-scripts/build-clion-plugin.sh
       - name: build UTBot
         run: |
           chmod +x docker/action-scripts/build-utbot.sh

diff --git a/clion-plugin/.gitignore b/clion-plugin/.gitignore
@@ -0,0 +1,37 @@
+# Compiled class file
+*.class
+
+# Log file
+*.log
+
+# BlueJ files
+*.ctxt
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files #
+*.war
+*.nar
+*.ear
+*.zip
+*.tar.gz
+*.rar
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+
+# gradle directory
+.gradle
+
+# idea settings
+.idea
+
+# quadana settings
+.qodana
+
+# build files
+build
+
+#macos files
+.DS_Store
diff --git a/clion-plugin/.run/Run IDE for UI Tests.run.xml b/clion-plugin/.run/Run IDE for UI Tests.run.xml
@@ -0,0 +1,22 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Run IDE for UI Tests" type="GradleRunConfiguration" factoryName="Gradle">
+    <log_file alias="idea.log" path="$PROJECT_DIR$/build/idea-sandbox/system/log/idea.log" />
+    <ExternalSystemSettings>
+      <option name="executionName" />
+      <option name="externalProjectPath" value="$PROJECT_DIR$" />
+      <option name="externalSystemIdString" value="GRADLE" />
+      <option name="scriptParameters" value="runIdeForUiTests" />
+      <option name="taskDescriptions">
+        <list />
+      </option>
+      <option name="taskNames">
+        <list />
+      </option>
+      <option name="vmOptions" />
+    </ExternalSystemSettings>
+    <ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
+    <ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
+    <DebugAllEnabled>false</DebugAllEnabled>
+    <method v="2" />
+  </configuration>
+</component>
diff --git a/clion-plugin/.run/Run IDE with Plugin.run.xml b/clion-plugin/.run/Run IDE with Plugin.run.xml
@@ -0,0 +1,24 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Run Plugin" type="GradleRunConfiguration" factoryName="Gradle">
+    <log_file alias="idea.log" path="$PROJECT_DIR$/build/idea-sandbox/system/log/idea.log" />
+    <ExternalSystemSettings>
+      <option name="executionName" />
+      <option name="externalProjectPath" value="$PROJECT_DIR$" />
+      <option name="externalSystemIdString" value="GRADLE" />
+      <option name="scriptParameters" value="--info" />
+      <option name="taskDescriptions">
+        <list />
+      </option>
+      <option name="taskNames">
+        <list>
+          <option value="runIde" />
+        </list>
+      </option>
+      <option name="vmOptions" value="" />
+    </ExternalSystemSettings>
+    <ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
+    <ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
+    <DebugAllEnabled>false</DebugAllEnabled>
+    <method v="2" />
+  </configuration>
+</component>
diff --git a/clion-plugin/.run/Run Plugin Tests.run.xml b/clion-plugin/.run/Run Plugin Tests.run.xml
@@ -0,0 +1,24 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Run Tests" type="GradleRunConfiguration" factoryName="Gradle">
+    <log_file alias="idea.log" path="$PROJECT_DIR$/build/idea-sandbox/system/log/idea.log" />
+    <ExternalSystemSettings>
+      <option name="executionName" />
+      <option name="externalProjectPath" value="$PROJECT_DIR$" />
+      <option name="externalSystemIdString" value="GRADLE" />
+      <option name="scriptParameters" value="" />
+      <option name="taskDescriptions">
+        <list />
+      </option>
+      <option name="taskNames">
+        <list>
+          <option value="test" />
+        </list>
+      </option>
+      <option name="vmOptions" value="" />
+    </ExternalSystemSettings>
+    <ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
+    <ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
+    <DebugAllEnabled>false</DebugAllEnabled>
+    <method v="2" />
+  </configuration>
+</component>
diff --git a/clion-plugin/.run/Run Plugin Verification.run.xml b/clion-plugin/.run/Run Plugin Verification.run.xml
@@ -0,0 +1,26 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Run Verifications" type="GradleRunConfiguration" factoryName="Gradle">
+    <log_file alias="idea.log" path="$PROJECT_DIR$/build/idea-sandbox/system/log/idea.log" />
+    <ExternalSystemSettings>
+      <option name="executionName" />
+      <option name="externalProjectPath" value="$PROJECT_DIR$" />
+      <option name="externalSystemIdString" value="GRADLE" />
+      <option name="scriptParameters" value="" />
+      <option name="taskDescriptions">
+        <list />
+      </option>
+      <option name="taskNames">
+        <list>
+          <option value="runPluginVerifier" />
+        </list>
+      </option>
+      <option name="vmOptions" value="" />
+    </ExternalSystemSettings>
+    <ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
+    <ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
+    <DebugAllEnabled>false</DebugAllEnabled>
+    <method v="2">
+      <option name="Gradle.BeforeRunTask" enabled="true" tasks="clean" externalProjectPath="$PROJECT_DIR$" vmOptions="" scriptParameters="" />
+    </method>
+  </configuration>
+</component>
diff --git a/clion-plugin/.run/Run Qodana.run.xml b/clion-plugin/.run/Run Qodana.run.xml
@@ -0,0 +1,26 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Run Qodana" type="GradleRunConfiguration" factoryName="Gradle">
+    <ExternalSystemSettings>
+      <option name="env">
+        <map>
+          <entry key="QODANA_SHOW_REPORT" value="true" />
+        </map>
+      </option>
+      <option name="executionName" />
+      <option name="externalProjectPath" value="$PROJECT_DIR$" />
+      <option name="externalSystemIdString" value="GRADLE" />
+      <option name="scriptParameters" value="cleanInspections runInspections" />
+      <option name="taskDescriptions">
+        <list />
+      </option>
+      <option name="taskNames">
+        <list />
+      </option>
+      <option name="vmOptions" />
+    </ExternalSystemSettings>
+    <ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
+    <ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
+    <DebugAllEnabled>false</DebugAllEnabled>
+    <method v="2" />
+  </configuration>
+</component>
diff --git a/clion-plugin/CHANGELOG.md b/clion-plugin/CHANGELOG.md
@@ -0,0 +1,7 @@
+<!-- Keep a Changelog guide -> https://keepachangelog.com -->
+
+# UTBotCppClion Changelog
+
+## [Unreleased]
+### Added
+- Initial scaffold created from [IntelliJ Platform Plugin Template](https://github.com/JetBrains/intellij-platform-plugin-template)
diff --git a/clion-plugin/CONFIGURATION.md b/clion-plugin/CONFIGURATION.md
@@ -0,0 +1,93 @@
+# Configuration
+
+## Remote Scenario 
+
+If you run UTBot and CLion on different hosts, synchronization of project files is required:
+
+- If UTBot is run inside the Docker container, mount your project folder to Docker. 
+- If UTBot is run under WSL, no additional configuration required, just 
+specify remote path to your project in `Settings` or use `Quickstart Wizard` to 
+fill it for you.
+- If server is not run locally, CLion deployment can be used for synchronization, although it won't be 
+fully automated, look at information below:
+
+### Configuring CLion SFTP deployment for remote scenario
+
+To configure SFTP do the following:
+
+- Open `Settings -> Build, Execution, Deployment -> Deployment`
+- Create SFTP configuration: click `+` and choose or create SSH config with server host and port, than
+specify the path to your project on the remote machine in mappings, it is the same path you have specified
+in `Settings` for remote path
+- Go to `Options` and turn on upload on change:
+
+![](images/plugin_usage/sftp/sftp-config.gif)
+
+- Go to `Project view` and right-click on your project root, then
+  choose `Deployment`, click `Upload to ...` and choose the name of your
+  SFTP configuration:
+
+![](images/plugin_usage/sftp/upload.gif)
+
+Now server can access your project files. 
+
+When you change your files, CLion should upload changes to server. 
+
+## Local scenario
+
+Wizard allows you to  configure your project quickly without specifying different options manually in 
+`Settings`. When you open your project for the first time, UTBot Wizard will be shown.
+
+![](images/plugin_usage/wizard/wizard-welcome.png)
+
+### Connection
+
+After the first introductory step, you will be asked to
+fill several settings: server port, server host and remote path.
+Remote path specifies path to project on remote machine.
+
+If UTBot is run on WSL or Linux (on the local machine), be sure 
+to check the checkbox that fills in default values for the path and the port. 
+
+![](images/plugin_usage/wizard/wizard-connection.png)
+
+### Build Directory and CMake Options
+
+On the final Wizard step, UTBot will ask you to:
+- specify relative path to the build directory
+- set custom CMake options
+
+![](images/plugin_usage/wizard/wizard-build-options.png)
+
+### Demo
+
+A demo how to go through the wizard:
+
+![](images/plugin_usage/wizard/wizard-demo.gif)
+
+## Plugin settings
+
+The recommended way to configure plugin is to use UTBot Wizard. 
+
+If some advanced settings are required, specify them in  `Settings -> Tools -> UTBot Settings`
+
+![](images/plugin_usage/settings-demo.gif)
+
+### Remote path
+
+Remote path is a path to your project on the remote host. If UTBot is run locally, leave it empty.
+
+
+## Check configuration
+
+When the connection to server is established, you can check project configuration 
+to make sure that all path are specified correctly: just invoke `Configure project` action:
+
+![](images/check-config/check-not.gif)
+
+When project is configured, `Project is configured` notification appears:
+
+![](images/check-config/check-ok.gif)
+
+When plugin is configured and configuration is checked, you can start using plugin to generate tests.
+For further details how to use plugin see `USAGE.md`.
diff --git a/clion-plugin/LICENSE b/clion-plugin/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Software-Analysis-Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/clion-plugin/README.md b/clion-plugin/README.md
@@ -0,0 +1,15 @@
+# UTBotCpp-CLion-plugin
+<!-- Plugin description -->
+Plugin to communicate with [UTBotCpp](https://github.com/UnitTestBot/UTBotCpp) server in CLion.
+<!-- Plugin description end -->
+
+### Installation
+
+1. Open CLion. Go to `Settings -> plugins`
+2. Uninstall the previous version of plugin. Skip this step if you install it for the first time
+3. Click on `Settings` icon and then choose `Install from disk`
+![](images/install/install-from-disk.png)
+4. Choose plugin's zip file: `clion_plugin.zip`
+5. Restart CLion
+
+See `CONFIGURATION.md` to configure the plugin before use.