Include code format tools

.circleci/config.yml

@@ -7,14 +7,32 @@ workflows:
   version: 2
   build-test-deploy:
     jobs:
-      - build-and-unit-test
-      - functional-test
+      - validate-code
+      - build-and-unit-test:
+          requires:
+            - validate-code
+      - functional-test:
+          requires:
+            - validate-code
 
 jobs:
+  validate-code:
+    working_directory: ~/code
+    docker:
+      - image: circleci/android:api-29-node
+    environment:
+      JVM_OPTS: -Xmx3200m
+    steps:
+      - checkout
+
+      - run:
+          name: Check Code Format
+          command: make format-check
+
   build-and-unit-test:
     working_directory: ~/code
     docker:
-      - image: circleci/android:api-29
+      - image: circleci/android:api-29-node
     environment:
       JVM_OPTS: -Xmx3200m
     steps:

.githooks/pre-commit

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+make format
+git diff --cached --name-only --diff-filter=d | while read filename; do git add "$filename"; done
+

Makefile

@@ -1,4 +1,5 @@
 EXTENSION-LIBRARY-FOLDER-NAME = edgeconsent
+TEST-APP-FOLDER-NAME = app
 
 BUILD-ASSEMBLE-LOCATION = ./ci/assemble
 ROOT_DIR=$(shell git rev-parse --show-toplevel)
@@ -10,6 +11,17 @@ LIB_VERSION = $(shell cat $(ROOT_DIR)/code/gradle.properties | grep "moduleVersi
 SOURCE_FILE_DIR =  $(ROOT_DIR)/code/$(PROJECT_NAME)
 AAR_FILE_DIR =  $(ROOT_DIR)/code/$(PROJECT_NAME)/build/outputs/aar
 
+init:
+	git config core.hooksPath .githooks
+
+format:
+	(./code/gradlew -p code/$(EXTENSION-LIBRARY-FOLDER-NAME) spotlessApply)
+	(./code/gradlew -p code/$(TEST-APP-FOLDER-NAME) spotlessApply)
+
+format-check:
+	(./code/gradlew -p code/$(EXTENSION-LIBRARY-FOLDER-NAME) spotlessCheck)
+	(./code/gradlew -p code/$(TEST-APP-FOLDER-NAME) spotlessCheck)
+
 create-ci: clean
 	(mkdir -p ci)
 
@@ -27,7 +39,7 @@ ci-build: create-ci
 	(cp -r ./code/$(EXTENSION-LIBRARY-FOLDER-NAME)/build $(BUILD-ASSEMBLE-LOCATION))
 
 ci-build-app:
-	(./code/gradlew -p code/app assemble)
+	(./code/gradlew -p code/$(TEST-APP-FOLDER-NAME) assemble)
 
 ci-unit-test: create-ci
 	(mkdir -p ci/unit-test)

README.md

@@ -38,7 +38,16 @@ Note: replace ADD_YOUR_SESSION_ID_HERE with your Assurance session identifier.
 
 Once the connection is established and the events list starts getting populated, you can filter the Edge Consent extension events by typing `Consent` in the `Search Events` search box.
 
+### Code Format
 
+This project uses the code formatting tools [Spotless](https://github.com/diffplug/spotless/tree/main/plugin-gradle) with [Prettier](https://prettier.io/). Formatting is applied when the project is built from Gradle and is checked when changes are submitted to the CI build system.
+
+Prettier requires [Node version](https://nodejs.org/en/download/releases/) 10+
+
+To enable the Git pre-commit hook to apply code formatting on each commit, run the following to update the project's git config `core.hooksPath`:
+```
+make init
+```
 
 ## Related Projects
 

code/app/build.gradle

@@ -1,4 +1,17 @@
 apply plugin: 'com.android.application'
+apply plugin: "com.diffplug.spotless"
+
+spotless {
+    java {
+        toggleOffOn("format:off", "format:on")
+        target "src/*/java/**/*.java"
+        removeUnusedImports()
+        prettier(['prettier': rootProject.ext.prettierVersion, 'prettier-plugin-java': rootProject.ext.prettierPluginJavaVersion])
+                .config(['parser': 'java', 'tabWidth': 4, 'useTabs': true, 'printWidth': 120])
+        endWithNewline()
+        licenseHeaderFile "../../config/formatter/adobe.header.txt"
+    }
+}
 
 android {
     compileSdkVersion 30

code/app/src/main/java/com/adobe/marketing/mobile/consentTestApp/ConsentTestApplication.java

@@ -13,15 +13,15 @@
 
 import android.app.Application;
 import android.util.Log;
-
-import com.adobe.marketing.mobile.edge.consent.Consent;
 import com.adobe.marketing.mobile.AdobeCallback;
 import com.adobe.marketing.mobile.Assurance;
 import com.adobe.marketing.mobile.Edge;
 import com.adobe.marketing.mobile.LoggingMode;
 import com.adobe.marketing.mobile.MobileCore;
+import com.adobe.marketing.mobile.edge.consent.Consent;
 
 public class ConsentTestApplication extends Application {
+
 	private static final String LOG_TAG = "ConsentTestApplication";
 
 	// TODO: fill in your Launch environment ID here
@@ -41,18 +41,19 @@ public void onCreate() {
 		*/
 		MobileCore.configureWithAppID(LAUNCH_ENVIRONMENT_ID);
 
-        // register AEP Mobile extensions
-        Consent.registerExtension();
-        Edge.registerExtension();
-        Assurance.registerExtension();
+		// register AEP Mobile extensions
+		Consent.registerExtension();
+		Edge.registerExtension();
+		Assurance.registerExtension();
 
 		// once all the extensions are registered, call MobileCore.start(...) to start processing the events
-		MobileCore.start(new AdobeCallback() {
-			@Override
-			public void call(final Object o) {
-				Log.d(LOG_TAG, "Mobile SDK was initialized");
+		MobileCore.start(
+			new AdobeCallback() {
+				@Override
+				public void call(final Object o) {
+					Log.d(LOG_TAG, "Mobile SDK was initialized");
+				}
 			}
-		});
+		);
 	}
-
 }

code/app/src/main/java/com/adobe/marketing/mobile/consentTestApp/MainActivity.java

@@ -10,17 +10,15 @@
 */
 
 package com.adobe.marketing.mobile.consentTestApp;
-import android.util.Log;
-import android.view.View;
 
-import androidx.appcompat.app.AppCompatActivity;
 import android.os.Bundle;
+import android.util.Log;
+import android.view.View;
 import android.widget.TextView;
-
+import androidx.appcompat.app.AppCompatActivity;
 import com.adobe.marketing.mobile.AdobeCallbackWithError;
 import com.adobe.marketing.mobile.AdobeError;
 import com.adobe.marketing.mobile.edge.consent.Consent;
-
 import java.util.HashMap;
 import java.util.Map;
 
@@ -30,58 +28,70 @@ public class MainActivity extends AppCompatActivity {
 	protected void onCreate(Bundle savedInstanceState) {
 		super.onCreate(savedInstanceState);
 		setContentView(R.layout.activity_main);
-
 	}
 
 	// Implement the OnClickListener callback
 	public void btnCollectNoClicked(View v) {
-		Map<String, Object> consents = new HashMap<String, Object>() {
+		final Map<String, String> collectValue = new HashMap<String, String>() {
+			{
+				put("val", "n");
+			}
+		};
+
+		final Map<String, Object> consentCollect = new HashMap<String, Object>() {
+			{
+				put("collect", collectValue);
+			}
+		};
+
+		final Map<String, Object> consents = new HashMap<String, Object>() {
 			{
-				put("consents", new HashMap<String, Object>() {
-					{
-						put("collect", new HashMap<String, String>() {
-							{
-								put("val", "n");
-							}
-						});
-					}
-				});
+				put("consents", consentCollect);
 			}
 		};
+
 		Consent.update(consents);
 	}
 
 	public void btnCollectYESClicked(View v) {
-		Map<String, Object> consents = new HashMap<String, Object>() {
+		final Map<String, String> collectValue = new HashMap<String, String>() {
+			{
+				put("val", "y");
+			}
+		};
+
+		final Map<String, Object> consentCollect = new HashMap<String, Object>() {
 			{
-				put("consents", new HashMap<String, Object>() {
-					{
-						put("collect", new HashMap<String, String>() {
-							{
-								put("val", "y");
-							}
-						});
-					}
-				});
+				put("collect", collectValue);
 			}
 		};
+
+		final Map<String, Object> consents = new HashMap<String, Object>() {
+			{
+				put("consents", consentCollect);
+			}
+		};
+
 		Consent.update(consents);
 	}
 
 	public void btnGetConsentsClicked(View v) {
 		final TextView txtViewConsents = (TextView) findViewById(R.id.txtViewConsents);
-		Consent.getConsents(new AdobeCallbackWithError<Map<String, Object>>() {
-			@Override
-			public void call(Map<String, Object> consents) {
-				txtViewConsents.setText(consents.toString());
-			}
+		Consent.getConsents(
+			new AdobeCallbackWithError<Map<String, Object>>() {
+				@Override
+				public void call(Map<String, Object> consents) {
+					txtViewConsents.setText(consents.toString());
+				}
 
-			@Override
-			public void fail(AdobeError adobeError) {
-				Log.d(this.getClass().getName(), String.format("GetConsents failed with error - %s", adobeError.getErrorName()));
+				@Override
+				public void fail(AdobeError adobeError) {
+					Log.d(
+						this.getClass().getName(),
+						String.format("GetConsents failed with error - %s", adobeError.getErrorName())
+					);
+				}
 			}
-		});
+		);
 	}
-
-
 }

code/build.gradle

@@ -8,6 +8,7 @@ buildscript {
     }
     dependencies {
         classpath "com.android.tools.build:gradle:4.0.1"
+        classpath "com.diffplug.spotless:spotless-plugin-gradle:5.12.5"
         // NOTE: Do not place your application dependencies here; they belong
         // in the individual module build.gradle files
     }
@@ -45,4 +46,8 @@ ext {
     buildToolsVersion = "29.0.3"
     testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
     jacocoVersion = "0.8.5"
+
+    // spotless config
+    prettierVersion = "2.3.0"
+    prettierPluginJavaVersion = "1.1.0"
 }

code/edgeconsent/build.gradle

@@ -2,11 +2,26 @@ apply plugin: 'com.android.library'
 apply plugin: 'jacoco'
 apply plugin: 'maven-publish'
 apply plugin: 'signing'
+apply plugin: "com.diffplug.spotless"
 
 jacoco {
     toolVersion = rootProject.ext.jacocoVersion
 }
 
+preBuild.dependsOn spotlessApply
+
+spotless {
+    java {
+        toggleOffOn("format:off", "format:on")
+        target "src/*/java/**/*.java"
+        removeUnusedImports()
+        prettier(['prettier': rootProject.ext.prettierVersion, 'prettier-plugin-java': rootProject.ext.prettierPluginJavaVersion])
+                .config(['parser': 'java', 'tabWidth': 4, 'useTabs': true, 'printWidth': 120])
+        endWithNewline()
+        licenseHeaderFile "../../config/formatter/adobe.header.txt"
+    }
+}
+
 android {
     compileSdkVersion rootProject.ext.compileSdkVersion
     buildToolsVersion rootProject.ext.buildToolsVersion

code/edgeconsent/src/androidTest/java/com/adobe/marketing/mobile/ADBCountDownLatch.java

@@ -16,6 +16,7 @@
 import java.util.concurrent.atomic.AtomicInteger;
 
 public class ADBCountDownLatch {
+
 	private final CountDownLatch latch;
 	private final int initialCount;
 	private final AtomicInteger currentCount;
@@ -55,5 +56,4 @@ public int getCurrentCount() {
 	public String toString() {
 		return String.format("%s, initial: %d, current: %d", latch.toString(), initialCount, currentCount.get());
 	}
-
 }