Support roboTest without roboScript (sanityRobo)

buildSrc/src/main/java/com/osacky/flank/gradle/FladleConfig.kt

@@ -18,6 +18,19 @@ interface FladleConfig {
   @get:Optional
   val serviceAccountCredentials: RegularFileProperty
 
+  /**
+   * debugApk and instrumentationApk are [Property<String>] and not [RegularFileProperty] because we support wildcard characters.
+   */
+  @get:Input
+  @get:Optional
+  val debugApk: Property<String>
+  @get:Input
+  @get:Optional
+  val instrumentationApk: Property<String>
+
+  @get:Input
+  val sanityRobo: Property<Boolean>
+
   @get:Input
   val useOrchestrator: Property<Boolean>
 

buildSrc/src/main/java/com/osacky/flank/gradle/FladleConfigImpl.kt

@@ -9,6 +9,9 @@ data class FladleConfigImpl(
   internal val name: String,
   override val projectId: Property<String>,
   override val serviceAccountCredentials: RegularFileProperty,
+  override val debugApk: Property<String>,
+  override val instrumentationApk: Property<String>,
+  override val sanityRobo: Property<Boolean>,
   override val useOrchestrator: Property<Boolean>,
   override val autoGoogleLogin: Property<Boolean>,
   override val devices: ListProperty<Map<String, String>>,
@@ -45,4 +48,19 @@ data class FladleConfigImpl(
   override val outputStyle: Property<String>,
   override val legacyJunitResult: Property<Boolean>,
   override val fullJunitResult: Property<Boolean>
-) : FladleConfig
+) : FladleConfig {
+  /**
+   * Prepare config to run sanity robo.
+   *
+   * Sets [sanityRobo] property as `true`.
+   *
+   * Cleans [instrumentationApk], [additionalTestApks], [roboDirectives], [roboScript] properties.
+   */
+  fun clearPropertiesForSanityRobo() {
+    sanityRobo.set(true)
+    additionalTestApks.empty()
+    instrumentationApk.set("")
+    roboDirectives.empty()
+    roboScript.set("")
+  }
+}

buildSrc/src/main/java/com/osacky/flank/gradle/FladlePluginDelegate.kt

@@ -40,6 +40,9 @@ class FladlePluginDelegate {
       // Must be done afterEvaluate otherwise extension values will not be set.
       project.dependencies.add(FLADLE_CONFIG, "${base.flankCoordinates.get()}:${base.flankVersion.get()}")
 
+      checkIfSanityAndValidateConfigs(base)
+      base.configs.forEach(::checkIfSanityAndValidateConfigs)
+
       // Only use automatic apk path detection for 'com.android.application' projects.
       project.pluginManager.withPlugin("com.android.application") {
         if (!base.debugApk.isPresent || !base.instrumentationApk.isPresent) {

buildSrc/src/main/java/com/osacky/flank/gradle/FlankGradleExtension.kt

@@ -19,6 +19,8 @@ open class FlankGradleExtension @Inject constructor(objects: ObjectFactory) : Fl
   @get:Input
   val flankCoordinates: Property<String> = objects.property(String::class.java).convention("com.github.flank:flank")
 
+  override val sanityRobo: Property<Boolean> = objects.property<Boolean>().convention(false)
+
   @get:Input
   val flankVersion: Property<String> = objects.property(String::class.java).convention("20.09.3")
   // Project id is automatically discovered by default. Use this to override the project id.
@@ -50,12 +52,9 @@ open class FlankGradleExtension @Inject constructor(objects: ObjectFactory) : Fl
   /**
    * debugApk and instrumentationApk are [Property<String>] and not [RegularFileProperty] because we support wildcard characters.
    */
-  @get:Input
-  @get:Optional
-  val debugApk: Property<String> = objects.property()
-  @get:Input
-  @get:Optional
-  val instrumentationApk: Property<String> = objects.property()
+  override val debugApk: Property<String> = objects.property()
+
+  override val instrumentationApk: Property<String> = objects.property()
 
   override val directoriesToPull: ListProperty<String> = objects.listProperty()
 
@@ -115,6 +114,9 @@ open class FlankGradleExtension @Inject constructor(objects: ObjectFactory) : Fl
       name = it,
       projectId = objects.property<String>().convention(projectId),
       serviceAccountCredentials = objects.fileProperty().convention(serviceAccountCredentials),
+      debugApk = objects.property<String>().convention(debugApk),
+      instrumentationApk = objects.property<String>().convention(instrumentationApk),
+      sanityRobo = objects.property<Boolean>().convention(false),
       useOrchestrator = objects.property<Boolean>().convention(useOrchestrator),
       autoGoogleLogin = objects.property<Boolean>().convention(autoGoogleLogin),
       devices = objects.listProperty<Map<String, String>>().convention(devices),

buildSrc/src/main/java/com/osacky/flank/gradle/SanityConfigValidation.kt

@@ -0,0 +1,32 @@
+package com.osacky.flank.gradle
+
+import org.gradle.api.GradleException
+import org.gradle.api.provider.ListProperty
+import org.gradle.api.provider.Property
+
+@Throws(GradleException::class)
+fun checkIfSanityAndValidateConfigs(config: FladleConfig) = when (config) {
+  is FlankGradleExtension -> config.checkAndValidateConfig() { option, _ ->
+    "Incorrect [base] configuration. [$option] can't be used together with sanityRobo."
+  }
+  is FladleConfigImpl -> config.checkAndValidateConfig(config.name) { option, name ->
+    "Incorrect [$name] configuration. [$option] can't be used together with sanityRobo. " +
+      "If you want to launch robo test run without robo script place only clearPropertiesForSanityRobo() into [$name] configuration"
+  }
+  else -> throw GradleException("Unable to check for sanity, check config type")
+}
+
+private fun FladleConfig.checkAndValidateConfig(name: String = "base", message: (String, String) -> String) {
+  if (sanityRobo.getOrElse(false)) when {
+    roboDirectives.isNotPresentOrEmpty -> throw GradleException(message("roboDirectives", name))
+    roboScript.isNotPresentOrBlank -> throw GradleException(message("roboScript", name))
+    instrumentationApk.isNotPresentOrBlank -> throw GradleException(message("instrumentationApk", name))
+    additionalTestApks.isNotPresentOrEmpty -> throw GradleException(message("additionalTestApks", name))
+  }
+}
+
+private val Property<String>.isNotPresentOrBlank
+  get() = orNull.isNullOrBlank().not()
+
+private val <T> ListProperty<T>.isNotPresentOrEmpty
+  get() = getOrElse(emptyList()).isEmpty().not()

buildSrc/src/main/java/com/osacky/flank/gradle/YamlWriter.kt

@@ -12,27 +12,31 @@ internal class YamlWriter {
       check(base.serviceAccountCredentials.isPresent) { "ServiceAccountCredentials in fladle extension not set. https://github.com/runningcode/fladle#serviceaccountcredentials" }
     }
     check(base.debugApk.isPresent) { "debugApk must be specified" }
-    check(base.instrumentationApk.isPresent xor !base.roboScript.orNull.isNullOrBlank()) {
-      val prefix = if (base.instrumentationApk.isPresent && !base.roboScript.orNull.isNullOrBlank()) {
-        "Both instrumentationApk file and roboScript file were specified, but only one is expected."
-      } else {
-        "Must specify either a instrumentationApk file or a roboScript file."
-      }
-      """
+    if (config.sanityRobo.get() == false) {
+      check(config.instrumentationApk.isPresent xor !config.roboScript.orNull.isNullOrBlank()) {
+        val prefix = if (base.instrumentationApk.isPresent && !config.roboScript.orNull.isNullOrBlank()) {
+          "Both instrumentationApk file and roboScript file were specified, but only one is expected."
+        } else {
+          "Must specify either a instrumentationApk file or a roboScript file."
+        }
+        """
       $prefix
-      instrumentationApk=${base.instrumentationApk.orNull}
-      roboScript=${base.roboScript.orNull}
-      """.trimIndent()
+      instrumentationApk=${config.instrumentationApk.orNull}
+      roboScript=${config.roboScript.orNull}
+        """.trimIndent()
+      }
     }
 
+    val shouldPrintTestAndRobo = config.sanityRobo.get().not()
     val additionalProperties = writeAdditionalProperties(config)
     val flankProperties = writeFlankProperties(config)
 
     return buildString {
       appendln("gcloud:")
-      appendln("  app: ${base.debugApk.get()}")
-      if (base.instrumentationApk.isPresent) {
-        appendln("  test: ${base.instrumentationApk.get()}")
+      appendln("  app: ${config.debugApk.get()}")
+      // We don't want to print instrumentation apks if sanityRobo == true
+      if (shouldPrintTestAndRobo && config.instrumentationApk.isPresent) {
+        appendln("  test: ${config.instrumentationApk.get()}")
       }
       if (config.devices.isPresentAndNotEmpty) appendln(createDeviceString(config.devices.get()))
       appendln(additionalProperties)
@@ -50,7 +54,8 @@ internal class YamlWriter {
     appendProperty(config.projectId, name = "project")
     appendProperty(config.keepFilePath, name = "keep-file-path")
     appendListProperty(config.filesToDownload, name = "files-to-download") { appendln("  - $it") }
-    appendListProperty(config.additionalTestApks, name = "additional-app-test-apks") { appendln("    $it") }
+    if (!config.sanityRobo.get())
+      appendListProperty(config.additionalTestApks, name = "additional-app-test-apks") { appendln("    $it") }
     appendProperty(config.runTimeout, name = "run-timeout")
     appendProperty(config.ignoreFailedTests, name = "ignore-failed-tests")
     appendProperty(config.disableSharding, name = "disable-sharding")
@@ -82,10 +87,12 @@ internal class YamlWriter {
     appendMapProperty(config.clientDetails, name = "client-details") { appendln("    ${it.key}: ${it.value}") }
     appendMapProperty(config.otherFiles, name = "other-files") { appendln("    ${it.key}: ${it.value}") }
     appendProperty(config.networkProfile, name = "network-profile")
-    appendProperty(config.roboScript, name = "robo-script")
-    appendListProperty(config.roboDirectives, name = "robo-directives") {
-      val value = it.getOrElse(2) { "" }.let { stringValue -> if (stringValue.isBlank()) "\"\"" else stringValue }
-      appendln("    ${it[0]}:${it[1]}: $value")
+    if (!config.sanityRobo.get()) {
+      appendProperty(config.roboScript, name = "robo-script")
+      appendListProperty(config.roboDirectives, name = "robo-directives") {
+        val value = it.getOrElse(2) { "" }.let { stringValue -> if (stringValue.isBlank()) "\"\"" else stringValue }
+        appendln("    ${it[0]}:${it[1]}: $value")
+      }
     }
   }