From 59c288d574b9cdcad31064e5ed790940670ac8bb Mon Sep 17 00:00:00 2001
From: Iris De Santis <irisnk@elrant.team>
Date: Thu, 22 Feb 2024 18:36:31 +0100
Subject: [PATCH] add code inspection

---
 .github/workflows/qodana_code_quality.yml     | 19 ++++++++++++
 .idea/misc.xml                                |  5 ++-
 .idea/runConfigurations/DummyUser.xml         |  2 +-
 .idea/runConfigurations/HelloApplication.xml  |  2 +-
 .idea/runConfigurations/SimpleXMPPClient.xml  |  2 +-
 pom.xml                                       |  6 ++++
 qodana.yaml                                   | 31 +++++++++++++++++++
 src/main/java/module-info.java                |  1 +
 .../elrant/bubbles/gui/HelloApplication.java  |  2 +-
 9 files changed, 65 insertions(+), 5 deletions(-)
 create mode 100644 .github/workflows/qodana_code_quality.yml
 create mode 100644 qodana.yaml

diff --git a/.github/workflows/qodana_code_quality.yml b/.github/workflows/qodana_code_quality.yml
new file mode 100644
index 0000000..bbe62aa
--- /dev/null
+++ b/.github/workflows/qodana_code_quality.yml
@@ -0,0 +1,19 @@
+name: Qodana
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  qodana:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: 'Qodana Scan'
+        uses: JetBrains/qodana-action@v2023.3
+        env:
+          QODANA_TOKEN: ${{ secrets.QODANA_TOKEN }}
\ No newline at end of file
diff --git a/.idea/misc.xml b/.idea/misc.xml
index de4b033..dddff60 100644
--- a/.idea/misc.xml
+++ b/.idea/misc.xml
@@ -7,7 +7,10 @@
         <option value="$PROJECT_DIR$/pom.xml" />
       </list>
     </option>
-    <option name="workspaceImportForciblyTurnedOn" value="true" />
+  </component>
+  <component name="PWA">
+    <option name="enabled" value="true" />
+    <option name="wasEnabledAtLeastOnce" value="true" />
   </component>
   <component name="ProjectRootManager" version="2" languageLevel="JDK_21" default="true" project-jdk-name="21" project-jdk-type="JavaSDK">
     <output url="file://$PROJECT_DIR$/out" />
diff --git a/.idea/runConfigurations/DummyUser.xml b/.idea/runConfigurations/DummyUser.xml
index f07b08c..3ee0254 100644
--- a/.idea/runConfigurations/DummyUser.xml
+++ b/.idea/runConfigurations/DummyUser.xml
@@ -1,7 +1,7 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="DummyUser" type="Application" factoryName="Application">
     <option name="MAIN_CLASS_NAME" value="team.elrant.bubbles.xmpp.DummyUser" />
-    <module name="Bubbles" />
+    <module name="bubbles" />
     <target name="irisnk@elrant.team:22" />
     <method v="2">
       <option name="Make" enabled="true" />
diff --git a/.idea/runConfigurations/HelloApplication.xml b/.idea/runConfigurations/HelloApplication.xml
index e97db86..7209e59 100644
--- a/.idea/runConfigurations/HelloApplication.xml
+++ b/.idea/runConfigurations/HelloApplication.xml
@@ -3,7 +3,7 @@
     <option name="ALTERNATIVE_JRE_PATH" value="21" />
     <option name="ALTERNATIVE_JRE_PATH_ENABLED" value="true" />
     <option name="MAIN_CLASS_NAME" value="team.elrant.bubbles.gui.HelloApplication" />
-    <module name="Bubbles" />
+    <module name="bubbles" />
     <extension name="coverage">
       <pattern>
         <option name="PATTERN" value="team.elrant.bubbles.gui.*" />
diff --git a/.idea/runConfigurations/SimpleXMPPClient.xml b/.idea/runConfigurations/SimpleXMPPClient.xml
index ab60d77..38d8cd7 100644
--- a/.idea/runConfigurations/SimpleXMPPClient.xml
+++ b/.idea/runConfigurations/SimpleXMPPClient.xml
@@ -3,7 +3,7 @@
     <option name="ALTERNATIVE_JRE_PATH" value="21" />
     <option name="ALTERNATIVE_JRE_PATH_ENABLED" value="true" />
     <option name="MAIN_CLASS_NAME" value="team.elrant.bubbles.xmpp.SimpleXMPPClient" />
-    <module name="Bubbles" />
+    <module name="bubbles" />
     <method v="2">
       <option name="Make" enabled="true" />
     </method>
diff --git a/pom.xml b/pom.xml
index a4c1388..2131f40 100644
--- a/pom.xml
+++ b/pom.xml
@@ -99,6 +99,12 @@
       <artifactId>smack-java8</artifactId>
       <version>4.4.7</version>
     </dependency>
+      <dependency>
+          <groupId>org.jetbrains</groupId>
+          <artifactId>annotations</artifactId>
+          <version>RELEASE</version>
+          <scope>compile</scope>
+      </dependency>
   </dependencies>
 
   <build>
diff --git a/qodana.yaml b/qodana.yaml
new file mode 100644
index 0000000..ebc500e
--- /dev/null
+++ b/qodana.yaml
@@ -0,0 +1,31 @@
+#-------------------------------------------------------------------------------#
+#               Qodana analysis is configured by qodana.yaml file               #
+#             https://www.jetbrains.com/help/qodana/qodana-yaml.html            #
+#-------------------------------------------------------------------------------#
+version: "1.0"
+
+#Specify inspection profile for code analysis
+profile:
+  name: qodana.starter
+
+#Enable inspections
+#include:
+#  - name: <SomeEnabledInspectionId>
+
+#Disable inspections
+#exclude:
+#  - name: <SomeDisabledInspectionId>
+#    paths:
+#      - <path/where/not/run/inspection>
+
+projectJDK: 21 #(Applied in CI/CD pipeline)
+
+#Execute shell command before Qodana execution (Applied in CI/CD pipeline)
+#bootstrap: sh ./prepare-qodana.sh
+
+#Install IDE plugins before Qodana execution (Applied in CI/CD pipeline)
+#plugins:
+#  - id: <plugin.id> #(plugin id can be found at https://plugins.jetbrains.com)
+
+#Specify Qodana linter for analysis (Applied in CI/CD pipeline)
+linter: jetbrains/qodana-jvm:latest
diff --git a/src/main/java/module-info.java b/src/main/java/module-info.java
index 403a645..0afaf38 100644
--- a/src/main/java/module-info.java
+++ b/src/main/java/module-info.java
@@ -13,6 +13,7 @@
     requires smack.extensions;
     requires smack.tcp;
     requires smack.core;
+    requires org.jetbrains.annotations;
 
     opens team.elrant.bubbles.gui to javafx.fxml;
     exports team.elrant.bubbles.gui;
diff --git a/src/main/java/team/elrant/bubbles/gui/HelloApplication.java b/src/main/java/team/elrant/bubbles/gui/HelloApplication.java
index 5add267..85faf65 100644
--- a/src/main/java/team/elrant/bubbles/gui/HelloApplication.java
+++ b/src/main/java/team/elrant/bubbles/gui/HelloApplication.java
@@ -9,7 +9,7 @@
 
 public class HelloApplication extends Application {
     @Override
-    public void start(Stage stage) throws IOException {
+    public void start(@org.jetbrains.annotations.NotNull Stage stage) throws IOException {
         FXMLLoader fxmlLoader = new FXMLLoader(HelloApplication.class.getResource("hello-view.fxml"));
         Scene scene = new Scene(fxmlLoader.load(), 320, 240);
         stage.setTitle("Hello!");