Configure sonar build (#1)

* Configure sonar build * Rename project to luava --------- Co-authored-by: kaklakariada <[email protected]>
itsallcode · Sep 22, 2024 · 818cbde · 818cbde
1 parent ae027ff
commit 818cbde
Show file tree

Hide file tree

Showing 15 changed files with 85 additions and 49 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -27,5 +27,9 @@
     "search.exclude": {
         "build/generated/jextract": false,
     },
-    "java.compile.nullAnalysis.mode": "automatic"
+    "java.compile.nullAnalysis.mode": "automatic",
+    "sonarlint.connectedMode.project": {
+        "connectionId": "kaklakariada-github",
+        "projectKey": "luava"
+    }
 }
diff --git a/README.md b/README.md
@@ -1,3 +1,30 @@
-# java-lua
+# luava
 
 An experimental Java library for embedding a Lua VM.
+
+[![Build](https://github.com/kaklakariada/java-lua/actions/workflows/build.yml/badge.svg)](https://github.com/kaklakariada/java-lua/actions/workflows/build.yml)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aluava&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aluava)
+[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aluava&metric=bugs)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aluava)
+[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aluava&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aluava)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aluava&metric=coverage)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aluava)
+[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aluava&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aluava)
+[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aluava&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aluava)
+[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aluava&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aluava)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aluava&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aluava)
+[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aluava&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aluava)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aluava&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aluava)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aluava&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aluava)
+
+## Development
+
+### Check for Dependency Updates
+
+```sh
+./gradlew dependencyUpdates
+```
+
+### Run Tests
+
+```sh
+./gradlew check
+```
diff --git a/build.gradle b/build.gradle
@@ -1,8 +1,13 @@
 plugins {
     id 'java-library'
+    id 'jacoco'
     id "com.github.ben-manes.versions" version "0.51.0"
+    id "org.sonarqube" version "5.1.0.4882"
 }
 
+version = '0.0.1'
+group = 'org.itsallcode'
+
 repositories {
     mavenCentral()
 }
@@ -19,6 +24,29 @@ java {
     }
 }
 
+javadoc {
+    enabled = true
+    failOnError = true
+    excludes = ["org/itsallcode/luava/ffi/**"]
+    options.addBooleanOption('html5', true)
+    options.addStringOption('Xwerror', '-quiet')
+}
+
+jacocoTestReport {
+    reports {
+        xml.required = true
+    }
+}
+
+sonarqube {
+    properties {
+        property "sonar.host.url", "https://sonarcloud.io"
+        property "sonar.organization", "kaklakariada-github"
+    }
+}
+
+tasks.sonarqube.dependsOn([tasks.jacocoTestReport])
+
 testing {
     suites {
         test {
@@ -113,7 +141,7 @@ task generateNativeInterface(type: Exec, dependsOn: [tasks.unpackJextract]) {
     commandLine jextractBinary,
                 '--include-dir', includeDir,
                 '--output', generatedSrc,
-                '--target-package', 'org.itsallcode.jlua.ffi',
+                '--target-package', 'org.itsallcode.luava.ffi',
                 '--library', 'lua',
                 '--header-class-name', 'Lua',
                 "$includeDir/all_lua.h"

diff --git a/settings.gradle b/settings.gradle
@@ -3,4 +3,4 @@ plugins {
     id 'org.gradle.toolchains.foojay-resolver-convention' version '0.8.0'
 }
 
-rootProject.name = 'jlua'
+rootProject.name = 'luava'
diff --git a/...tsallcode/jlua/FunctionCallException.java → ...sallcode/luava/FunctionCallException.java b/...tsallcode/jlua/FunctionCallException.java → ...sallcode/luava/FunctionCallException.java
@@ -1,4 +1,4 @@
-package org.itsallcode.jlua;
+package org.itsallcode.luava;
 
 public class FunctionCallException extends LuaException {
     private static final long serialVersionUID = 1L;

diff --git a/...java/org/itsallcode/jlua/LowLevelLua.java → ...ava/org/itsallcode/luava/LowLevelLua.java b/...java/org/itsallcode/jlua/LowLevelLua.java → ...ava/org/itsallcode/luava/LowLevelLua.java
@@ -1,11 +1,11 @@
-package org.itsallcode.jlua;
+package org.itsallcode.luava;
 
 import java.lang.foreign.Arena;
 import java.lang.foreign.MemorySegment;
 
-import org.itsallcode.jlua.ffi.Lua;
-import org.itsallcode.jlua.ffi.lua_KFunction;
-import org.itsallcode.jlua.ffi.lua_KFunction.Function;
+import org.itsallcode.luava.ffi.Lua;
+import org.itsallcode.luava.ffi.lua_KFunction;
+import org.itsallcode.luava.ffi.lua_KFunction.Function;
 
 class LowLevelLua implements AutoCloseable {
     private final Arena arena;
@@ -30,13 +30,13 @@ void openLibs() {
 
     void pcall(final int nargs, final int nresults, final int errfunc, final long ctx) {
         final Function function = (final MemorySegment l, final int status, final long ctx1) -> {
-            System.out.println("Upcall callback");
             return 0;
         };
         pcall(nargs, nresults, errfunc, ctx, function);
     }
 
-    void pcall(final int nargs, final int nresults, final int errfunc, final long ctx, final Function upcallFunction) {
+    void pcall(final int nargs, final int nresults, final int errfunc, final long ctx,
+            final lua_KFunction.Function upcallFunction) {
         final MemorySegment k = lua_KFunction.allocate(upcallFunction, arena);
         final int error = Lua.lua_pcallk(state, nargs, nresults, errfunc, ctx, k);
         if (error != 0) {

diff --git a/...ava/org/itsallcode/jlua/LuaException.java → ...va/org/itsallcode/luava/LuaException.java b/...ava/org/itsallcode/jlua/LuaException.java → ...va/org/itsallcode/luava/LuaException.java
@@ -1,4 +1,4 @@
-package org.itsallcode.jlua;
+package org.itsallcode.luava;
 
 public class LuaException extends RuntimeException {
     private static final long serialVersionUID = 1L;

diff --git a/...java/org/itsallcode/jlua/LuaFunction.java → ...ava/org/itsallcode/luava/LuaFunction.java b/...java/org/itsallcode/jlua/LuaFunction.java → ...ava/org/itsallcode/luava/LuaFunction.java
@@ -1,9 +1,9 @@
-package org.itsallcode.jlua;
+package org.itsallcode.luava;
 
 import java.lang.foreign.Arena;
 import java.lang.foreign.MemorySegment;
 
-import org.itsallcode.jlua.ffi.Lua;
+import org.itsallcode.luava.ffi.Lua;
 
 public class LuaFunction {
 

diff --git a/...a/org/itsallcode/jlua/LuaInterpreter.java → .../org/itsallcode/luava/LuaInterpreter.java b/...a/org/itsallcode/jlua/LuaInterpreter.java → .../org/itsallcode/luava/LuaInterpreter.java
@@ -1,4 +1,4 @@
-package org.itsallcode.jlua;
+package org.itsallcode.luava;
 
 public class LuaInterpreter implements AutoCloseable {
 

diff --git a/...in/java/org/itsallcode/jlua/LuaStack.java → ...n/java/org/itsallcode/luava/LuaStack.java b/...in/java/org/itsallcode/jlua/LuaStack.java → ...n/java/org/itsallcode/luava/LuaStack.java
@@ -1,10 +1,10 @@
-package org.itsallcode.jlua;
+package org.itsallcode.luava;
 
 import java.lang.foreign.Arena;
 import java.lang.foreign.MemorySegment;
 import java.nio.charset.StandardCharsets;
 
-import org.itsallcode.jlua.ffi.Lua;
+import org.itsallcode.luava.ffi.Lua;
 
 class LuaStack {
     private final MemorySegment state;

diff --git a/...in/java/org/itsallcode/jlua/LuaTable.java → ...n/java/org/itsallcode/luava/LuaTable.java b/...in/java/org/itsallcode/jlua/LuaTable.java → ...n/java/org/itsallcode/luava/LuaTable.java
@@ -1,9 +1,9 @@
-package org.itsallcode.jlua;
+package org.itsallcode.luava;
 
 import java.lang.foreign.Arena;
 import java.lang.foreign.MemorySegment;
 
-import org.itsallcode.jlua.ffi.Lua;
+import org.itsallcode.luava.ffi.Lua;
 
 public class LuaTable {
     private final LuaStack stack;

diff --git a/...ain/java/org/itsallcode/jlua/LuaType.java → ...in/java/org/itsallcode/luava/LuaType.java b/...ain/java/org/itsallcode/jlua/LuaType.java → ...in/java/org/itsallcode/luava/LuaType.java
@@ -1,8 +1,8 @@
-package org.itsallcode.jlua;
+package org.itsallcode.luava;
 
 import java.util.Arrays;
 
-import org.itsallcode.jlua.ffi.Lua;
+import org.itsallcode.luava.ffi.Lua;
 
 public enum LuaType {
     NONE(Lua.LUA_TNONE()), NIL(Lua.LUA_TNIL()), BOOLEAN(Lua.LUA_TBOOLEAN()), LIGHT_USERDATA(Lua.LUA_TLIGHTUSERDATA()),

diff --git a/src/test/java/org/itsallcode/jlua/LowLevelLuaTest.java b/src/test/java/org/itsallcode/jlua/LowLevelLuaTest.java
diff --git a/...g/itsallcode/jlua/LuaInterpreterTest.java → .../itsallcode/luava/LuaInterpreterTest.java b/...g/itsallcode/jlua/LuaInterpreterTest.java → .../itsallcode/luava/LuaInterpreterTest.java
@@ -1,13 +1,11 @@
-package org.itsallcode.jlua;
+package org.itsallcode.luava;
 
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.equalTo;
 import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 
-import org.junit.jupiter.api.AfterEach;
-import org.junit.jupiter.api.BeforeEach;
-import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.*;
 import org.junit.jupiter.api.function.Executable;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.ValueSource;

diff --git a/...ava/org/itsallcode/jlua/LuaStackTest.java → ...va/org/itsallcode/luava/LuaStackTest.java b/...ava/org/itsallcode/jlua/LuaStackTest.java → ...va/org/itsallcode/luava/LuaStackTest.java
@@ -1,14 +1,13 @@
-package org.itsallcode.jlua;
+package org.itsallcode.luava;
 
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.equalTo;
 
-import org.junit.jupiter.api.AfterEach;
-import org.junit.jupiter.api.BeforeEach;
-import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.*;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.ValueSource;
 
+
 class LuaStackTest {
     private LowLevelLua lua;
     private LuaStack stack;