Introduce Spotless and apply formatting to entire project

.github/workflows/test.yml

@@ -5,7 +5,7 @@ on:
     branches: [master]
   pull_request:
   schedule:
-    - cron: '0 0 * * *'
+    - cron: "0 0 * * *"
 
 jobs:
   build:
@@ -34,7 +34,13 @@ jobs:
           echo BACKTRACE_CORONER_TOKEN=\"${{ secrets.BACKTRACE_CORONER_TOKEN }}\" >> ./local.properties
 
       - name: Accept Android SDK licences
-        run: yes | "${ANDROID_HOME}/cmdline-tools/latest/bin/sdkmanager" --licenses    
+        run: yes | "${ANDROID_HOME}/cmdline-tools/latest/bin/sdkmanager" --licenses
+
+      - name: Bugfix libunwindstack-ndk .clang-format symbolic link issue
+        run: rm ./backtrace-library/src/main/cpp/libbun/external/libunwindstack-ndk/.clang-format
+
+      - name: Check Code Style
+        run: ./gradlew spotlessCheck
 
       - name: Build and check
         run: ./gradlew assembleDebug assembleDebugAndroidTest build check

CONTRIBUTING.md

@@ -1,40 +1,38 @@
 # Contributing
-Thank you for considering contributing to Backtrace Android SDK library. Here are some guidelines to help you get started:
+Thank you for your interest in contributing to the Backtrace Android SDK. Please review the following guidelines to help you get started.
 
-### Getting Started
+## Getting Started
 
-1. **Clone the Repository**
-    - Clone the repository to your local machine using:
-      ```bash
-      git clone https://github.com/backtrace-labs/backtrace-android.git
-      ```
+1. **Clone the repository**
+   ```bash
+   git clone https://github.com/backtrace-labs/backtrace-android.git
+   ```
 
-2. **Create a Branch**
-    - It's good practice to create a new branch for each feature or bugfix, if you have jira ticket put ticket number as branch prefix:
-      ```bash
-      git checkout -b jira-ticket/your-feature-name
-      ```
+2. **Create a branch** - it's good practice to create a new branch for each feature or bugfix, if you have jira ticket put ticket number as branch prefix:
+   ```bash
+   git checkout -b jira-ticket/your-feature-name
+   ```
 
 3. **Update submodules**
-```bash
-git submodule update --recursive --remote
-git submodule update --init --recursive
-```
-
-### Coding Guidelines
+   ```bash
+   git submodule update --recursive --remote
+   git submodule update --init --recursive
+   ```
+   
+## Coding Guidelines
 
 1. **Code Formatting**
-    - Make sure that your code is properly formatted using the default Android Studio formatter.
-        - In Android Studio, you can format your code by selecting `Code` > `Reformat Code` or by using the shortcut `Ctrl + Alt + L` (Windows/Linux) or `Cmd + Option + L` (macOS).
-
-2. **Optimize Imports**
-    - Run 'Optimize imports' to remove unused imports and reorder them.
-        - In Android Studio, you can optimize imports by selecting `Code` > `Optimize Imports`. You can also enable this option to run it automatically in `Settings` -> `Editor` -> `General` -> `Auto Import`
-
-3. **Write Tests**
+    - Make sure that your code is properly formatted using the [**Spotless**](https://github.com/diffplug/spotless) formatter.
+        - From the command line, you can format the code by running:
+          ```bash
+          ./gradlew spotlessApply
+          ```
+        - In Android Studio, you can also use the **Spotless Gradle** plugin to run formatting directly from the IDE.
+
+2. **Write Tests**
     - Ensure that you write tests for the new functionality or changes made. This helps maintain the integrity of the project.
 
-### Commit and Push
+## Commit and Push
 
 1. **Commit Your Changes**
     - Write clear and concise commit messages. Follow the convention of using the imperative mood in the subject line.
@@ -48,7 +46,7 @@ git submodule update --init --recursive
       git push origin jira-ticket/your-feature-name
       ```
 
-### Create a Pull Request
+## Create a Pull Request
 
 1. **Submit a Pull Request**
     - Go to the repository on GitHub and click on the `New Pull Request` button.
@@ -57,8 +55,26 @@ git submodule update --init --recursive
 2. **Review Process**
     - One of the project maintainers will review your pull request. Please be responsive to any comments or suggestions made.
 
-### Additional Notes
+## Additional Notes
 
 - Ensure that your code follows the existing code style and structure.
 - Keep your branch up to date with the latest changes from the `master` branch to avoid merge conflicts.
 
+
+## Code Formatting
+
+This project uses **[Spotless](https://github.com/diffplug/spotless)** to ensure consistent code style.
+
+### Setup Instructions
+
+1. Run Spotless check
+This verifies that your code meets the project’s formatting standards.
+   ```bash
+   ./gradlew spotlessCheck
+   ```
+
+2. (Optional) Automatically reformat code
+If formatting issues are found, you can automatically fix them with:
+   ```bash
+   ./gradlew spotlessApply   
+   ```

backtrace-library/src/androidTest/java/backtraceio/library/ApplicationMetadataTest.java

@@ -5,16 +5,13 @@
 import android.content.Context;
 import android.content.pm.PackageInfo;
 import android.content.pm.PackageManager;
-
 import androidx.test.ext.junit.runners.AndroidJUnit4;
 import androidx.test.platform.app.InstrumentationRegistry;
-
+import backtraceio.library.common.ApplicationMetadataCache;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 
-import backtraceio.library.common.ApplicationMetadataCache;
-
 @RunWith(AndroidJUnit4.class)
 public class ApplicationMetadataTest {
     private Context context;
@@ -44,5 +41,4 @@ public void shouldCorrectlyRetrieveApplicationVersion() throws PackageManager.Na
         PackageInfo packageInfo = context.getPackageManager().getPackageInfo(context.getOpPackageName(), 0);
         assertEquals(cache.getApplicationVersion(), String.valueOf(packageInfo.versionCode));
     }
-
 }

backtrace-library/src/androidTest/java/backtraceio/library/BacktraceClientAttachmentsTest.java

@@ -6,25 +6,20 @@
 import static org.junit.Assert.assertNotNull;
 
 import android.content.Context;
-
 import androidx.test.ext.junit.runners.AndroidJUnit4;
 import androidx.test.platform.app.InstrumentationRegistry;
-
-import net.jodah.concurrentunit.Waiter;
-
-import org.junit.Before;
-import org.junit.Test;
-import org.junit.runner.RunWith;
-
-import java.util.ArrayList;
-import java.util.List;
-import java.util.concurrent.TimeUnit;
-
 import backtraceio.library.events.OnServerResponseEventListener;
 import backtraceio.library.events.RequestHandler;
 import backtraceio.library.models.BacktraceData;
 import backtraceio.library.models.BacktraceResult;
 import backtraceio.library.models.types.BacktraceResultStatus;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.concurrent.TimeUnit;
+import net.jodah.concurrentunit.Waiter;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
 
 @RunWith(AndroidJUnit4.class)
 public class BacktraceClientAttachmentsTest {
@@ -50,43 +45,44 @@ public void sendBacktraceExceptionAttachments() {
         // GIVEN
         final String attachment0 = "/someDir/someFile.log";
         final String attachment1 = "/someDir/someOtherFile.log";
-        List<String> attachments = new ArrayList<String>() {{
-            add(attachment0);
-            add(attachment1);
-        }};
+        List<String> attachments = new ArrayList<String>() {
+            {
+                add(attachment0);
+                add(attachment1);
+            }
+        };
 
         BacktraceClient backtraceClient = new BacktraceClient(context, credentials, database, attachments);
 
         final Waiter waiter = new Waiter();
         RequestHandler rh = new RequestHandler() {
             @Override
             public BacktraceResult onRequest(BacktraceData data) {
-                return new BacktraceResult(data.getReport(), data.getReport().exception.getMessage(),
-                        BacktraceResultStatus.Ok);
+                return new BacktraceResult(
+                        data.getReport(), data.getReport().exception.getMessage(), BacktraceResultStatus.Ok);
             }
         };
         backtraceClient.setOnRequestHandler(rh);
 
         // WHEN
-        backtraceClient.send(new Exception(resultMessage), new
-                OnServerResponseEventListener() {
-                    @Override
-                    public void onEvent(BacktraceResult backtraceResult) {
-                        // THEN
-                        assertEquals(resultMessage, backtraceResult.message);
-                        assertEquals(BacktraceResultStatus.Ok, backtraceResult.status);
-                        assertNotNull(backtraceResult.getBacktraceReport());
-                        assertNotNull(backtraceResult.getBacktraceReport().exception);
-
-                        // We should have the file attachment paths included
-                        assertEquals(2, backtraceResult.getBacktraceReport().attachmentPaths.size());
-                        assertTrue(backtraceResult.getBacktraceReport().attachmentPaths.contains(attachment0));
-                        assertTrue(backtraceResult.getBacktraceReport().attachmentPaths.contains(attachment1));
-
-                        waiter.resume();
-                    }
-                }
-        );
+        backtraceClient.send(new Exception(resultMessage), new OnServerResponseEventListener() {
+            @Override
+            public void onEvent(BacktraceResult backtraceResult) {
+                // THEN
+                assertEquals(resultMessage, backtraceResult.message);
+                assertEquals(BacktraceResultStatus.Ok, backtraceResult.status);
+                assertNotNull(backtraceResult.getBacktraceReport());
+                assertNotNull(backtraceResult.getBacktraceReport().exception);
+
+                // We should have the file attachment paths included
+                assertEquals(
+                        2, backtraceResult.getBacktraceReport().attachmentPaths.size());
+                assertTrue(backtraceResult.getBacktraceReport().attachmentPaths.contains(attachment0));
+                assertTrue(backtraceResult.getBacktraceReport().attachmentPaths.contains(attachment1));
+
+                waiter.resume();
+            }
+        });
         // WAIT FOR THE RESULT FROM ANOTHER THREAD
         try {
             waiter.await(5, TimeUnit.SECONDS);
@@ -104,30 +100,29 @@ public void sendBacktraceExceptionNoAttachments() {
         RequestHandler rh = new RequestHandler() {
             @Override
             public BacktraceResult onRequest(BacktraceData data) {
-                return new BacktraceResult(data.getReport(), data.getReport().exception.getMessage(),
-                        BacktraceResultStatus.Ok);
+                return new BacktraceResult(
+                        data.getReport(), data.getReport().exception.getMessage(), BacktraceResultStatus.Ok);
             }
         };
         backtraceClient.setOnRequestHandler(rh);
 
         // WHEN
-        backtraceClient.send(new Exception(resultMessage), new
-                OnServerResponseEventListener() {
-                    @Override
-                    public void onEvent(BacktraceResult backtraceResult) {
-                        // THEN
-                        assertEquals(resultMessage, backtraceResult.message);
-                        assertEquals(BacktraceResultStatus.Ok, backtraceResult.status);
-                        assertNotNull(backtraceResult.getBacktraceReport());
-                        assertNotNull(backtraceResult.getBacktraceReport().exception);
-
-                        // We should NOT have any attachment paths included by default
-                        assertEquals(0, backtraceResult.getBacktraceReport().attachmentPaths.size());
-
-                        waiter.resume();
-                    }
-                }
-        );
+        backtraceClient.send(new Exception(resultMessage), new OnServerResponseEventListener() {
+            @Override
+            public void onEvent(BacktraceResult backtraceResult) {
+                // THEN
+                assertEquals(resultMessage, backtraceResult.message);
+                assertEquals(BacktraceResultStatus.Ok, backtraceResult.status);
+                assertNotNull(backtraceResult.getBacktraceReport());
+                assertNotNull(backtraceResult.getBacktraceReport().exception);
+
+                // We should NOT have any attachment paths included by default
+                assertEquals(
+                        0, backtraceResult.getBacktraceReport().attachmentPaths.size());
+
+                waiter.resume();
+            }
+        });
         // WAIT FOR THE RESULT FROM ANOTHER THREAD
         try {
             waiter.await(5, TimeUnit.SECONDS);

backtrace-library/src/androidTest/java/backtraceio/library/BacktraceClientAttributeTests.java

@@ -5,26 +5,21 @@
 import static org.junit.Assert.assertNotNull;
 
 import android.content.Context;
-
 import androidx.test.ext.junit.runners.AndroidJUnit4;
 import androidx.test.platform.app.InstrumentationRegistry;
-
+import backtraceio.library.events.RequestHandler;
+import backtraceio.library.models.BacktraceResult;
+import backtraceio.library.models.types.BacktraceResultStatus;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.concurrent.TimeUnit;
 import net.jodah.concurrentunit.Waiter;
-
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 
-import java.util.Collections;
-import java.util.HashMap;
-import java.util.Map;
-import java.util.concurrent.TimeUnit;
-
-import backtraceio.library.events.RequestHandler;
-import backtraceio.library.models.BacktraceResult;
-import backtraceio.library.models.types.BacktraceResultStatus;
-
 @RunWith(AndroidJUnit4.class)
 public class BacktraceClientAttributeTests {
     private Context context;
@@ -142,21 +137,19 @@ public void attributesShouldBeAvailableInReport() {
             Object value = data.getAttributes().get(attributeKey);
             assertNotNull(value);
             assertEquals(value, attributeValue);
-            return new BacktraceResult(data.getReport(), data.getReport().exception.getMessage(),
-                    BacktraceResultStatus.Ok);
+            return new BacktraceResult(
+                    data.getReport(), data.getReport().exception.getMessage(), BacktraceResultStatus.Ok);
         };
         backtraceClient.setOnRequestHandler(rh);
         final Waiter waiter = new Waiter();
 
         // WHEN
-        backtraceClient.send(new Exception(errorMessage), backtraceResult -> waiter.resume()
-        );
+        backtraceClient.send(new Exception(errorMessage), backtraceResult -> waiter.resume());
         // WAIT FOR THE RESULT FROM ANOTHER THREAD
         try {
             waiter.await(5, TimeUnit.SECONDS);
         } catch (Exception ex) {
             fail(ex.getMessage());
         }
     }
-
 }