Manual and sonarcloud review

.github/workflows/build.yml

@@ -0,0 +1,37 @@
+name: SonarCloud
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, synchronize, reopened]
+jobs:
+  build:
+    name: Build and analyze
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: 17
+          distribution: 'zulu' # Alternative distribution options are available.
+      - name: Cache SonarCloud packages
+        uses: actions/cache@v3
+        with:
+          path: ~/.sonar/cache
+          key: ${{ runner.os }}-sonar
+          restore-keys: ${{ runner.os }}-sonar
+      - name: Cache Maven packages
+        uses: actions/cache@v3
+        with:
+          path: ~/.m2
+          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+          restore-keys: ${{ runner.os }}-m2
+      - name: Build and analyze
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        run: mvn -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=BME-MIT-IET_iet-hf-2024-nomad-szabotorok

.gitignore

@@ -1 +1,17 @@
-*.class
+target/
+pom.xml.tag
+pom.xml.releaseBackup
+pom.xml.versionsBackup
+pom.xml.next
+release.properties
+dependency-reduced-pom.xml
+buildNumber.properties
+.mvn/timing.properties
+# https://github.com/takari/maven-wrapper#usage-without-binary-jar
+.mvn/wrapper/maven-wrapper.jar
+
+# Eclipse m2e generated files
+# Eclipse Core
+.project
+# JDT-specific (Eclipse Java Development Tools)
+.classpath

.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+    "recommendations": [
+        "vscjava.vscode-java-pack",
+        "SonarSource.sonarlint-vscode"
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "sonarlint.connectedMode.project": {
+        "connectionId": "bme-mit-iet-org",
+        "projectKey": "BME-MIT-IET_iet-hf-2024-nomad-szabotorok"
+    },
+    "java.configuration.updateBuildConfiguration": "interactive"
+}

pom.xml

@@ -0,0 +1,75 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <groupId>hu.bme.mit.iet.pipe_game</groupId>
+  <artifactId>pipe_game</artifactId>
+  <version>1.0-SNAPSHOT</version>
+
+  <name>pipe_game</name>
+
+  <properties>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    <maven.compiler.source>1.8</maven.compiler.source>
+    <maven.compiler.target>1.8</maven.compiler.target>
+    <sonar.organization>bme-mit-iet-org</sonar.organization>
+	<sonar.host.url>https://sonarcloud.io</sonar.host.url>
+  </properties>
+
+  <dependencies>
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <version>4.11</version>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+
+  <build>
+    <pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
+      <plugins>
+        <!-- clean lifecycle, see https://maven.apache.org/ref/current/maven-core/lifecycles.html#clean_Lifecycle -->
+        <plugin>
+          <artifactId>maven-clean-plugin</artifactId>
+          <version>3.1.0</version>
+        </plugin>
+        <!-- default lifecycle, jar packaging: see https://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_jar_packaging -->
+        <plugin>
+          <artifactId>maven-resources-plugin</artifactId>
+          <version>3.0.2</version>
+        </plugin>
+        <plugin>
+          <artifactId>maven-compiler-plugin</artifactId>
+          <version>3.8.0</version>
+        </plugin>
+        <plugin>
+          <artifactId>maven-surefire-plugin</artifactId>
+          <version>2.22.1</version>
+        </plugin>
+        <plugin>
+          <artifactId>maven-jar-plugin</artifactId>
+          <version>3.0.2</version>
+        </plugin>
+        <plugin>
+          <artifactId>maven-install-plugin</artifactId>
+          <version>2.5.2</version>
+        </plugin>
+        <plugin>
+          <artifactId>maven-deploy-plugin</artifactId>
+          <version>2.8.2</version>
+        </plugin>
+        <!-- site lifecycle, see https://maven.apache.org/ref/current/maven-core/lifecycles.html#site_Lifecycle -->
+        <plugin>
+          <artifactId>maven-site-plugin</artifactId>
+          <version>3.7.1</version>
+        </plugin>
+        <plugin>
+          <artifactId>maven-project-info-reports-plugin</artifactId>
+          <version>3.0.0</version>
+        </plugin>
+      </plugins>
+    </pluginManagement>
+  </build>
+</project>

src/Cistern.java → src/main/java/hu/bme/mit/iet/pipe_game/Cistern.java

@@ -1,3 +1,5 @@
+package hu.bme.mit.iet.pipe_game;
+
 //
 //
 //  Generated by StarUML(tm) Java Add-In
@@ -24,6 +26,7 @@ public class Cistern extends SystemPart {
 	private boolean hasPipe = false;
 	private int pCount = 0;
 	private int timeLeft = 2;
+	private Random rand = new Random();
 
 	/**
 	 * Konstruktor, ami beállítja az id-t az osztály nevére és egy eltérő számra
@@ -37,13 +40,13 @@ public Cistern() {
 	 * A csőnek mindkét szomszégjának magát állítja be,
 	 * hogy ne legyen szabad és ne folyon ki belőle a víz
 	 */
-	public void CreatePipe() {
+	public void createPipe() {
 		Pipe p = new Pipe();
-		Control.AddPipe(p);
-		p.AddNeighbour(this);
-		p.AddNeighbour(this);
-		AddNeighbour(p);
-		AddNeighbour(p);
+		Control.addPipe(p);
+		p.addNeighbour(this);
+		p.addNeighbour(this);
+		addNeighbour(p);
+		addNeighbour(p);
 		pipe = p;
 		hasPipe = true;
 		pCount++;
@@ -52,17 +55,17 @@ public void CreatePipe() {
 	/**
 	 * Létrehoz egy új pumpát és eltárolja azt a tagváltozójába
 	 */
-	public void CreatePump() {
+	public void createPump() {
 		pump = new Pump();
-		Control.AddPump(pump);
+		Control.addPump(pump);
 	}
 
 	/**
 	 * A tagváltozóban eltárolt pumpa felvétele
 	 * @return visszadjuk a pumpát
 	 */
 	@Override
-	public Pump CarryPump() {
+	public Pump carryPump() {
 
 		Pump p = pump;
 		pump = null;
@@ -76,12 +79,12 @@ public Pump CarryPump() {
 	 * @return visszadja hogy mennyi vizet gyűjtött össze
 	 */
 	@Override
-	public int PullWater() {
+	public int pullWater() {
 
 		int points = 0;
-		for (SystemPart pipe: neighbours) {
-			points += pipe.getWater();
-			pipe.setWater(0);
+		for (SystemPart _pipe: neighbours) {
+			points += _pipe.getWater();
+			_pipe.setWater(0);
 		}
 		return points;
 	}
@@ -90,16 +93,15 @@ public int PullWater() {
 	 * A control minden körben meghívja,
 	 * ha letelik az idő akkor generál egy pumpát vagy csövet
 	 */
-	public void Generate() {
-		Random rand = new Random();
+	public void generate() {
 		int coin = rand.nextInt(2);
 
 		if (--timeLeft == 0) {
 			if (coin ==  1 ) {
-				CreatePump();
+				createPump();
 			}
 			else {
-				CreatePipe();
+				createPipe();
 			}
 			timeLeft = 2;
 		}

src/CisternView.java → src/main/java/hu/bme/mit/iet/pipe_game/CisternView.java

@@ -1,3 +1,5 @@
+package hu.bme.mit.iet.pipe_game;
+
 import javax.swing.*;
 import java.awt.*;
 import java.awt.event.ActionEvent;
@@ -29,7 +31,7 @@ public CisternView(View view, Cistern cistern) {
      * frissíti a part JButtont a jelenlegi állapotoknak megfelelően
      */
     @Override
-    public void Update() {
+    public void update() {
         button.setBounds(x,y,50,50);
         button.setBackground(Color.RED);
 
@@ -40,7 +42,7 @@ public void Update() {
          */
         view.getPanel().remove(button);
 
-        while (players.size() > 0){
+        while (!players.isEmpty()){
             view.getPanel().remove(players.get(0));
             players.remove(0);
         }
@@ -77,6 +79,7 @@ public void Update() {
      * getter fügvény ID-re
      * @return ID-t adja vissza
      */
+    @Override
     public String getID(){
         return cistern.getId();
     }