spotless (#277)

Author: laurit

CHANGELOG.md

@@ -62,20 +62,20 @@ exception when queried. See the corresponding Android bug: https://issuetracker.
 
 ---
 
-## Version 0.7.0 
+## Version 0.7.0
 
-- OpenTelemetry okhttp instrumentation has been updated to version 1.5.3-alpha. 
+- OpenTelemetry okhttp instrumentation has been updated to version 1.5.3-alpha.
 - For okhttp, SplunkRum now exposes a wrapper for your `OkHttpClient` which implements the `Call.Factory`
   interface. This `Call.Factory` will properly manage context propagation with asynchronous http calls.
 - The okhttp Interceptor provided by SplunkRum has been deprecated. Please use the `Call.Factory` from now on.
   The `createOkHttpRumInterceptor()` method will be removed in a future release.
-- A new class (`com.splunk.rum.StandardAttributes`) has been introduced to provide `AttributeKey`s for 
+- A new class (`com.splunk.rum.StandardAttributes`) has been introduced to provide `AttributeKey`s for
   standard RUM span attributes. Currently this class exposes the `APP_VERSION` attribute.
 - The ANR detector and Network monitor will no longer operate when the app has been put in the background.
 - A new API on the `Config.Builder` allows redacting of spans or redacting/replacing Span attributes. See
   the new `filterSpans(Consumer<SpanFilterBuilder>)` method and the corresponding `com.splunk.rum.SpanFilterBuilder` class
   for details.
-- The `os.type` Span attribute has been changed to 'linux' and `os.name` attribute is now 'Android'. 
+- The `os.type` Span attribute has been changed to 'linux' and `os.name` attribute is now 'Android'.
 
 ---
 

README.md

@@ -187,9 +187,9 @@ import android.webkit.WebView;
 import com.splunk.rum.SplunkRum;
 
 //...
-/* 
-Make sure that the WebView instance only loads pages under 
-your control and instrumented with Splunk Browser RUM. The 
+/*
+Make sure that the WebView instance only loads pages under
+your control and instrumented with Splunk Browser RUM. The
 integrateWithBrowserRum() method can expose the splunk.rumSessionId
 of your user to every site/page loaded in the WebView instance.
 */
@@ -247,11 +247,11 @@ when initializing your instance of the SplunkRum API:
   or changing the span name. See the javadoc on the `SpanFilterBuilder` class for more details.
 - `slowRenderingDetectionPollInterval(Duration)` :
   Set/change the default polling interval for slow/frozen render detection.
-  Default is 1000ms. Value must be positive. 
+  Default is 1000ms. Value must be positive.
 - `slowRenderingDetectionEnabled(boolean)` :
   Disables the detection of slow frame renders. Enabled by default.
-- `diskBufferingEnabled(boolean)` : 
-  Enables the storage-based buffering of telemetry. 
+- `diskBufferingEnabled(boolean)` :
+  Enables the storage-based buffering of telemetry.
   This setting is useful when instrumenting applications that might work offline for extended periods of time.
 - `limitDiskUsageMegabytes(int)` :
   When disk buffering is enabled, this can be used to adjust the maximum amount of storage
@@ -294,14 +294,14 @@ when initializing your instance of the SplunkRum API:
 #### Detection of slow or frozen renders
 
 By default, Splunk RUM detects and reports slow or frozen screen renders.
-To disable this feature, call `.slowRenderingDetectionEnabled(false)` on the 
+To disable this feature, call `.slowRenderingDetectionEnabled(false)` on the
 `Config.Builder`.
 
 Splunk RUM defines renders as slow or frozen following the [Android Vitals definitions](https://developer.android.com/topic/performance/vitals/frozen):
 
 | Category | Speed   | spanName      | Attribute   |
 |----------|---------|---------------|-------------|
-| Slow     | >16ms  | slowRenders    | count       | 
+| Slow     | >16ms  | slowRenders    | count       |
 | Frozen   | >700ms | frozenRenders  | count       |
 
 ## Customizing screen names
@@ -310,7 +310,7 @@ By default, the instrumentation uses the simple class name of each `Fragment`
 and `Activity` type as the value of the `screen.name` attribute. To customize the
 screen name, use the `@RumScreenName` annotation.
 
-For example, the following activity appears with the `screen.name` 
+For example, the following activity appears with the `screen.name`
 attribute set to the value "Buttercup":
 
 ```java

RELEASING.md

@@ -2,28 +2,28 @@
 
 ## Releasing a new version
 
-Releasing of splunk-otel-android is done via a private Splunk gitlab installation. 
+Releasing of splunk-otel-android is done via a private Splunk gitlab installation.
 
 This is the process to use to do a release:
 
-1) Use the _Github_ UI to create a tag for the version (by creating a pre-release, for example), 
-pointing at the commit SHA on the main branch that you want to release. 
+1) Use the _Github_ UI to create a tag for the version (by creating a pre-release, for example),
+pointing at the commit SHA on the main branch that you want to release.
 The format of the tag should be "vx.y.z" or it won't be picked
 up by gitlab as a release tag. You can also create a tag via the command line and push it to github
 if you are more comfortable with that process.
 
 2) Wait for gitlab to run the release job.
 
-3) Log in to oss.sonatype.org with a login that has permissions to see and release the `com.splunk` 
+3) Log in to oss.sonatype.org with a login that has permissions to see and release the `com.splunk`
 staging repository.
 
 4) Close the staging repository, and then release it via the oss.sonatype.org UI.
 Ideally, verify that the publishing worked by pulling down the dependency in some sample project and
 build an application against it, as a double-check that it is a working release.
 
 5) Create a PR that will update the version in the `gradle.properties` to the next one that will be being worked on.
-This PR can and probably should also include updating any documentation (CHANGELOG.md, README.md, etc) 
+This PR can and probably should also include updating any documentation (CHANGELOG.md, README.md, etc)
 that mentions the previous version.
 
 6) Once this PR is merged, create a release in Github that points at the newly created version, make sure
-to provide release notes that at least mirror the contents of the CHANGELOG.md
+to provide release notes that at least mirror the contents of the CHANGELOG.md

build.gradle.kts

@@ -11,6 +11,10 @@ buildscript {
     }
 }
 
+plugins {
+    id("splunk.spotless-conventions")
+}
+
 allprojects {
     repositories {
         google()
@@ -23,3 +27,7 @@ allprojects {
         version = "$version-SNAPSHOT"
     }
 }
+
+subprojects {
+    apply(plugin = "splunk.spotless-conventions")
+}

buildSrc/build.gradle.kts

@@ -1,12 +1,24 @@
 plugins {
     `kotlin-dsl`
+
+    // When updating, update below in dependencies too
+    id("com.diffplug.spotless") version "6.4.2"
+}
+
+spotless {
+    kotlinGradle {
+        ktlint()
+        target("* * / *.gradle.kts")
+    }
 }
 
 repositories {
     mavenCentral()
     google()
+    gradlePluginPortal()
 }
 
 dependencies {
     implementation("com.android.tools.build:gradle:7.1.2")
-}
+    implementation("com.diffplug.spotless:spotless-plugin-gradle:6.4.2")
+}

buildSrc/src/main/kotlin/splunk.android-library-conventions.gradle.kts

@@ -83,7 +83,7 @@ val sourcesJar by tasks.registering(Jar::class) {
 
 project.afterEvaluate {
 
-    //note: we need to declare this here in afterEvaluate because the android plugin doesn't
+    // note: we need to declare this here in afterEvaluate because the android plugin doesn't
     // resolve dependencies early enough to make the libraryVariants hack work until here.
     val javadoc by tasks.registering(Javadoc::class) {
         source = android.sourceSets.named("main").get().java.getSourceFiles()
@@ -113,4 +113,4 @@ project.afterEvaluate {
             }
         }
     }
-}
+}

buildSrc/src/main/kotlin/splunk.spotless-conventions.gradle.kts

@@ -0,0 +1,39 @@
+import com.diffplug.gradle.spotless.SpotlessExtension
+
+plugins {
+    id("com.diffplug.spotless")
+}
+
+extensions.configure<SpotlessExtension>("spotless") {
+    java {
+        googleJavaFormat().aosp()
+        licenseHeaderFile(rootProject.file("gradle/spotless.license.java"), "(package|import|public)")
+        target("src/**/*.java")
+    }
+    plugins.withId("org.jetbrains.kotlin.jvm") {
+        kotlin {
+            ktlint()
+            licenseHeaderFile(rootProject.file("gradle/spotless.license.java"), "(package|import|public)")
+        }
+    }
+    kotlinGradle {
+        ktlint()
+    }
+    format("misc") {
+        // not using "**/..." to help keep spotless fast
+        target(
+                ".gitignore",
+                ".gitattributes",
+                ".gitconfig",
+                ".editorconfig",
+                "*.md",
+                "src/**/*.md",
+                "docs/**/*.md",
+                "*.sh",
+                "src/**/*.properties"
+        )
+        indentWithSpaces()
+        trimTrailingWhitespace()
+        endWithNewline()
+    }
+}

docs/faq.md

@@ -1,2 +1 @@
 ## Frequently Asked Questions
-

gradle/spotless.license.java

@@ -0,0 +1,16 @@
+/*
+ * Copyright Splunk Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+

sample-app/build.gradle.kts

@@ -63,4 +63,4 @@ dependencies {
     implementation(project(":splunk-otel-android"))
 
     testImplementation("junit:junit:4.13.2")
-}
+}

sample-app/src/androidTest/java/com/splunk/android/sample/ExampleInstrumentedTest.java

@@ -1,15 +1,29 @@
+/*
+ * Copyright Splunk Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package com.splunk.android.sample;
 
-import android.content.Context;
+import static org.junit.Assert.*;
 
-import androidx.test.platform.app.InstrumentationRegistry;
+import android.content.Context;
 import androidx.test.ext.junit.runners.AndroidJUnit4;
-
+import androidx.test.platform.app.InstrumentationRegistry;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 
-import static org.junit.Assert.*;
-
 /**
  * Instrumented test, which will execute on an Android device.
  *
@@ -23,4 +37,4 @@ public void useAppContext() {
         Context appContext = InstrumentationRegistry.getInstrumentation().getTargetContext();
         assertEquals("com.splunk.android.sample", appContext.getPackageName());
     }
-}
+}