Merge branch 'master' into #685-ios-support-for-testplans

buildSrc/src/main/kotlin/Dependencies.kt

@@ -54,6 +54,8 @@ object Dependencies {
     const val KOTLIN_SERIALIZATION = "org.jetbrains.kotlinx:kotlinx-serialization-json:${Versions.KOTLIN_SERIALIZATION}"
 
     //region flank-scripts
+    const val ARCHIVE_LIB = "org.rauschig:jarchivelib:${Versions.ARCHIVE_LIB}"
+    const val TUKAANI_XZ = "org.tukaani:xz:${Versions.TUKAANI_XZ}"
     const val CLIKT = "com.github.ajalt:clikt:${Versions.CLIKT}"
     const val JCABI_GITHUB = "com.jcabi:jcabi-github:${Versions.JCABI_GITHUB}"
     const val SLF4J_NOP = "org.slf4j:slf4j-nop:${Versions.SLF4J_NOP}"

buildSrc/src/main/kotlin/Versions.kt

@@ -88,6 +88,8 @@ object Versions {
     const val PROGUARD = "7.0.0"
 
     // ============== flank-scripts ==============
+    const val ARCHIVE_LIB = "1.1.0"
+    const val TUKAANI_XZ = "1.0"
     const val KOTLIN_SERIALIZATION = "1.0.0"
     const val FUEL = "2.3.0"
     const val CLIKT = "2.8.0"

docs/index.md

@@ -145,6 +145,12 @@ gcloud:
   #   version: 12.0
   #   locale: es_ES
   #   orientation: landscape
+
+  ## A list of paths that will be copied from the device's storage to the designated results bucket after the test
+  ## is complete. These must be absolute paths under /private/var/mobile/Media or /Documents
+  ## of the app under test. If the path is under an app's /Documents, it must be prefixed with the app's bundle id and a colon
+  # directories-to-pull:
+  #   - /private/var/mobile/Media
 
   ## A list of device-path=file-path pairs that specify the paths of the test device and the files you want pushed to the device prior to testing.
   ## Device paths should either be under the Media shared folder (e.g. prefixed with /private/var/mobile/Media) or
@@ -160,6 +166,13 @@ gcloud:
   #   - gs://bucket/additional.ipa
   #   - path/to/local/ipa/file.ipa
 
+  ## A list of game-loop scenario numbers which will be run as part of the test (default: all scenarios).
+  ## A maximum of 1024 scenarios may be specified in one test matrix, but the maximum number may also be limited by the overall test --timeout setting.
+  # scenario-numbers:
+  #   - 1
+  #   - 2
+  #   - 3
+
   ## The type of iOS test to run. TYPE must be one of: xctest, game-loop. Default: xctest
   # type: xctest
 
@@ -361,6 +374,13 @@ gcloud:
   #   - local/file/path/test1.obb
   #   - local/file/path/test2.obb
 
+  ## A list of game-loop scenario numbers which will be run as part of the test (default: all scenarios).
+  ## A maximum of 1024 scenarios may be specified in one test matrix, but the maximum number may also be limited by the overall test --timeout setting.
+  # scenario-numbers:
+  #   - 1
+  #   - 2
+  #   - 3
+
   ## A list of OBB required filenames. OBB file name must conform to the format as specified by Android e.g. 
   ## [main|patch].0300110.com.example.android.obb which will be installed into <shared-storage>/Android/obb/<package-name>/ on the device.
   # obb-names:

firebase_apis/generate_java_client.bat

@@ -0,0 +1,2 @@
+SET DIR=%~dp0
+%DIR%\..\..\flank-scripts\bash\flankScripts.bat shell firebase generateJavaClient

firebase_apis/generate_java_client.sh

@@ -1,32 +1,2 @@
-#!/bin/bash
-
-# Note: Must have already installed google-apis-client-generator from the master branch. PIP release will not work!
-
-# git clone https://github.com/google/apis-client-generator.git
-# xcode-select --install
-# brew install python@2
-# export PATH="/usr/local/opt/python@2/libexec/bin:$PATH"
-# pip install --upgrade pip setuptools
-# pip install .
-
-# Generate only the testing library since the others are published officially already.
-
-#  generate_library \
-#     --input=./storage_v1.json \
-#     --language=java \
-#     --output_dir=./storage
-
-rm -rf "./test_api/src/"
-
- generate_library \
-    --input=./json/testing_v1.json \
-    --language=java \
-    --package_path=api/services \
-    --output_dir=./test_api/src/main/java
-
-mv ./test_api/src/main/java/pom.xml ./test_api/pom.xml
-
-#  generate_library \
-#     --input=./toolresults_v1beta3.json \
-#     --language=java \
-#     --output_dir=./apis/toolresults
+DIR=`dirname "$BASH_SOURCE"`
+$DIR/../flank-scripts/bash/flankScripts shell firebase generateJavaClient

firebase_apis/update_api_json.bat

@@ -0,0 +1,2 @@
+SET DIR=%~dp0
+%DIR%\..\..\flank-scripts\bash\flankScripts.bat shell firebase updateApiJson

firebase_apis/update_api_json.sh

@@ -1,18 +1,2 @@
-#!/usr/bin/env bash
-
-# npm -g install sort-json
-
-# Note: API discovery JSON is out of date. Check the gcloud CLI repo for most recent JSON.
-# https://github.com/bootstraponline/gcloud_cli/blob/master/google-cloud-sdk/lib/googlecloudsdk/third_party/apis/testing_v1.json
-
-cd json
-
-TOOL_RESULTS=toolresults_v1beta3.json
-rm "$TOOL_RESULTS"
-curl -o "$TOOL_RESULTS" https://www.googleapis.com/discovery/v1/apis/toolresults/v1beta3/rest
-sort-json "$TOOL_RESULTS"
-
-TESTING=testing_v1.json
-rm "$TESTING"
-curl -o "$TESTING" https://www.googleapis.com/discovery/v1/apis/testing/v1/rest
-sort-json "$TESTING"
+DIR=`dirname "$BASH_SOURCE"`
+$DIR/../flank-scripts/bash/flankScripts shell firebase updateApiJson

flank-scripts/README.md

@@ -163,3 +163,84 @@ All [testArtifacts](../flank-scripts/src/main/kotlin/flank/scripts/testartifacts
   #### `resolve` 
   Automatically prepare local artifacts if needed.
 
+### Shell
+
+To show all available commands for shell use: `flankScripts shell`
+
+Available commands are:
+  - `firebase`               Contains all firebase commands  
+  - `iosBuildExample`        Build example ios app
+  - `iosBuildFtl`            Build ftl ios app
+  - `iosRunFtlLocal`         Run ftl locally ios app
+  - `iosUniversalFramework`  Create Universal Framework
+  - `ops`                    Contains all ops command: android, ios, gp
+  - `updateBinaries`         Update binaries used by Flank
+  - `buildFlank`             Build Flank
+
+#### `firebase` 
+
+Contains tasks related to firebase client generation.  
+These tasks are :
+  - `updateApiJson`      Download file for generating client
+  - `generateJavaClient`   Generates Java client
+
+##### `updateApiJson`
+Download file for generating client
+
+##### `generateJavaClient`
+Generate Java Client from json schema
+
+#### `iosBuildExample` 
+Build example ios app
+
+#### `iosBuildFtl` 
+Build ftl ios app
+
+#### `iosRunFtlLocal` 
+Run ftl locally ios app
+
+| Option      | Description                                                              |
+|-------------|--------------------------------------------------------------------------|
+| --device-id | Device id. Please take it from Xcode -> Window -> Devices and Simulators |
+
+#### `iosUniversalFramework` 
+
+#### `ops` 
+Contains tasks related to building sample apps with tests.  
+These tasks are :
+  - `go`        Build go app with tests
+  - `ios`       Build ios app with tests
+  - `android`   Build android apks with tests
+
+##### `go`
+Build go app with tests
+
+##### `build_earl_grey_example`
+Build ios earl grey example app with tests
+
+| Option     | Short option | Description              |
+|------------|--------------|--------------------------|
+| --generate | -g           | Make build               |
+| --copy     | -c           | Copy output files to tmp |
+
+##### `build_flank_example`
+Build ios flank example app with tests
+
+| Option     | Short option | Description              |
+|------------|--------------|--------------------------|
+| --generate | -g           | Make build               |
+| --copy     | -c           | Copy output files to tmp |
+
+##### `android`
+Build android apks with tests
+
+| Option     | Short option | Description              |
+|------------|--------------|--------------------------|
+| --generate | -g           | Make build               |
+| --copy     | -c           | Copy output files to tmp |
+
+#### `updateBinaries` 
+Update binaries used by Flank
+
+#### `buildFlank` 
+Build Flank test runner

flank-scripts/bash/buildFlankScripts.bat

@@ -1,4 +1,3 @@
-Rem REPLACE with #1246
 SET DIR=%~dp0
 
 SET FLANK_SCRIPTS=%DIR%\..

flank-scripts/bash/flankScripts.bat

@@ -1,4 +1,8 @@
 SET DIR=%~dp0
 SET scriptsJar=%DIR%\flankScripts.jar
 
+if not exist "%scriptsJar%" {
+    %DIR%\buildFlankScripts.bat
+}
+
 java -jar "%scriptsJar%" %*

flank-scripts/build.gradle.kts

@@ -74,6 +74,8 @@ dependencies {
     implementation(Dependencies.JCABI_GITHUB)
     implementation(Dependencies.SLF4J_NOP)
     implementation(Dependencies.GLASSFISH_JSON)
+    implementation(Dependencies.ARCHIVE_LIB)
+    implementation(Dependencies.TUKAANI_XZ)
 
     detektPlugins(Dependencies.DETEKT_FORMATTING)
 

flank-scripts/src/main/kotlin/flank/scripts/Main.kt

@@ -5,6 +5,7 @@ import com.github.ajalt.clikt.core.subcommands
 import flank.scripts.ci.CiCommand
 import flank.scripts.dependencies.DependenciesCommand
 import flank.scripts.release.ReleaseCommand
+import flank.scripts.shell.ShellCommand
 import flank.scripts.testartifacts.TestArtifactsCommand
 
 class Main : CliktCommand(name = "flankScripts") {
@@ -17,6 +18,7 @@ fun main(args: Array<String>) {
         ReleaseCommand(),
         CiCommand(),
         DependenciesCommand,
-        TestArtifactsCommand()
+        TestArtifactsCommand(),
+        ShellCommand
     ).main(args)
 }

flank-scripts/src/main/kotlin/flank/scripts/exceptions/FlankScriptsExceptions.kt

@@ -16,3 +16,9 @@ class BugsnagException(val body: BugSnagResponse) : FlankScriptsExceptions() {
         return "Error while doing Bugnsag request, because of ${body.errors.joinToString()}"
     }
 }
+
+class ShellCommandException(private val errorMessage: String) : FlankScriptsExceptions() {
+    override fun toString(): String {
+        return "Error while executing shell command, details: $errorMessage"
+    }
+}

flank-scripts/src/main/kotlin/flank/scripts/shell/BuildFlank.kt

@@ -0,0 +1,35 @@
+package flank.scripts.shell
+
+import com.github.ajalt.clikt.core.CliktCommand
+import flank.scripts.shell.utils.createGradleCommand
+import flank.scripts.shell.utils.rootDirectoryPathString
+import flank.scripts.utils.runCommand
+import java.nio.file.Files
+import java.nio.file.Paths
+import java.nio.file.StandardCopyOption
+
+object BuildFlankCommand : CliktCommand(name = "buildFlank", help = "Build Flank") {
+    override fun run() {
+        buildFlank()
+    }
+}
+
+private fun buildFlank() {
+    createGradleCommand(
+        workingDir = rootDirectoryPathString,
+        "-p", rootDirectoryPathString, ":test_runner:clean", ":test_runner:assemble", ":test_runner:shadowJar"
+    )
+        .runCommand()
+
+    copyFlankOutputFile()
+}
+
+private fun copyFlankOutputFile() {
+    val flankDirectory = Paths.get(rootDirectoryPathString, "test_runner").toString()
+
+    Files.copy(
+        Paths.get(flankDirectory, "build", "libs", "flank.jar"),
+        Paths.get(flankDirectory, "bash", "flank.jar"),
+        StandardCopyOption.REPLACE_EXISTING
+    )
+}

flank-scripts/src/main/kotlin/flank/scripts/shell/ShellCommand.kt

@@ -0,0 +1,33 @@
+package flank.scripts.shell
+
+import com.github.ajalt.clikt.core.CliktCommand
+import com.github.ajalt.clikt.core.subcommands
+import flank.scripts.shell.firebase.FirebaseCommand
+import flank.scripts.shell.ios.BuildExampleCommand
+import flank.scripts.shell.ios.BuildFtlCommand
+import flank.scripts.shell.ios.InstallXcPrettyCommand
+import flank.scripts.shell.ios.RunFtlLocalCommand
+import flank.scripts.shell.ios.SetupIosEnvCommand
+import flank.scripts.shell.ios.UniversalFrameworkCommand
+import flank.scripts.shell.ops.OpsCommand
+import flank.scripts.shell.updatebinaries.UpdateBinariesCommand
+
+object ShellCommand : CliktCommand(name = "shell", help = "Task for shell commands") {
+    init {
+        subcommands(
+            FirebaseCommand,
+            BuildExampleCommand,
+            BuildFtlCommand,
+            RunFtlLocalCommand,
+            UniversalFrameworkCommand,
+            OpsCommand,
+            UpdateBinariesCommand,
+            BuildFlankCommand,
+            InstallXcPrettyCommand,
+            SetupIosEnvCommand
+        )
+    }
+
+    @Suppress("EmptyFunctionBlock")
+    override fun run() {}
+}

flank-scripts/src/main/kotlin/flank/scripts/shell/firebase/FirebaseCommand.kt

@@ -0,0 +1,18 @@
+package flank.scripts.shell.firebase
+
+import com.github.ajalt.clikt.core.CliktCommand
+import com.github.ajalt.clikt.core.subcommands
+
+object FirebaseCommand : CliktCommand(name = "firebase", help = "Contains all firebase commands") {
+
+    init {
+        subcommands(
+            UpdateApiJsonCommand,
+            GenerateJavaClientCommand
+        )
+    }
+
+    @Suppress("EmptyFunctionBlock")
+    override fun run() {
+    }
+}

flank-scripts/src/main/kotlin/flank/scripts/shell/firebase/GenerateJavaClientCommand.kt

@@ -0,0 +1,36 @@
+package flank.scripts.shell.firebase
+
+import com.github.ajalt.clikt.core.CliktCommand
+import flank.scripts.exceptions.ShellCommandException
+import flank.scripts.utils.checkIfPipInstalled
+import flank.scripts.utils.installClientGeneratorIfNeeded
+import flank.scripts.utils.runCommand
+import java.nio.file.Files
+import java.nio.file.Paths
+import java.nio.file.StandardCopyOption
+
+object GenerateJavaClientCommand : CliktCommand(name = "generateJavaClient", help = "Generate Java Client") {
+
+    override fun run() {
+        checkIfPipInstalled()
+        installClientGeneratorIfNeeded()
+        val apiPath = Paths.get("test_api").toString()
+        val outputDirectory = Paths.get(apiPath, "src", "main", "java").toString()
+        val testingJsonInput = Paths.get("json", "testing_v1.json").toString()
+        Paths.get(apiPath, "src").toFile().deleteRecursively()
+
+        val generateLibraryCommand = "generate_library " +
+            "--input=$testingJsonInput " +
+            "--language=java " +
+            "--output_dir=$outputDirectory"
+
+        val result = generateLibraryCommand.runCommand()
+        if (result != 0) throw ShellCommandException("Error when execute generate_library command")
+
+        Files.move(
+            Paths.get(outputDirectory, "pom.xml"),
+            Paths.get(apiPath, "pom.xml"),
+            StandardCopyOption.REPLACE_EXISTING
+        )
+    }
+}