refactor: Investigate and create proposal

docs/refactor/diagram.md

@@ -0,0 +1,27 @@
+# Flank Activity Diagram 
+
+![activity_diagram](http://www.plantuml.com/plantuml/proxy?cache=no&fmt=svg&src=https://raw.githubusercontent.com/Flank/flank/1317-flank-run-refactor/docs/refactor/uml/flank_activity_diagram.puml)
+
+![ios_sharding](http://www.plantuml.com/plantuml/proxy?cache=no&fmt=svg&src=https://raw.githubusercontent.com/Flank/flank/1317-flank-run-refactor/docs/refactor/uml/flank_ios_sharding_diagram.puml)
+
+![android_sharding](http://www.plantuml.com/plantuml/proxy?cache=no&fmt=svg&src=https://raw.githubusercontent.com/Flank/flank/1317-flank-run-refactor/docs/refactor/uml/flank_android_sharding_diagram.puml)
+
+## Description
+
+The diagram shows abstract view of all possible flank activities.
+
+* The `#LightGreen` color relates to CLI commands.
+* The `#LightBlue` color relates to domain scope.
+* The default yellow color reserved for top-level functions that are not atomic and can be converted to `frame`.
+* Frame can represent a package or rather the top-level function composed of other functions.
+* The `#snow` color relates to low-level functions
+* Low-level functions should be atomic ( can import only non-domain utils and third-party libraries? - consider ).
+* Low-level functions cannot be converted to frame
+
+The complete activity diagram will contain only low-level activities represented by `#snow` color.
+All top-level functions represented by yellow activities contains hidden complexity and should be converted to frames.  
+
+# Layers
+```
+presentation (CLI) -> domain -> utils -> data
+```

docs/refactor/flank_run/flank_run.md

@@ -0,0 +1,13 @@
+# Flank run refactor
+
+## References
+
+* https://github.com/Flank/flank/issues/1317 
+
+# Insights
+
+## Fix import dependencies
+
+Only the cli commands can be aware of run package.
+So any code inside the run package which is imported somewhere else then cli, 
+must be reorganized and moved outside the run package.

docs/refactor/flank_run/flank_run_refactor_sdd.md

@@ -0,0 +1,174 @@
+# Flank run refactor [Not complete]
+
+# References
+
+* `https://github.com/Flank/flank/issues/1317` 
+
+# Motivation
+
+Flank run is getting bigger over the time. 
+Currently, the amount of code related to test run is large, 
+so it could be hard to understand and keep in mind the whole process.
+To make the work more convenient, faster and scalable, we should re-think
+and reorganize the code between packages and files.
+
+# Goals
+
+* `All logic related to flank run grouped in one root package` 
+* `Package structure flat as possible.`
+* `Flank run process simplified to sequence of synchronous atomic steps.`
+* `Packages and code are easy to identify as steps.`
+
+# Non-Goals
+
+* `Refactor code related to other commands than flank run`
+
+# Design
+
+> Explain and diagram the technical design
+>
+> Identify risks and edge cases
+
+# API
+
+> What will the proposed API look like?
+
+# Results
+
+> What was the outcome of the project?
+
+# Dependencies
+
+> What is the project blocked on?
+
+> What will be impacted by the project?
+
+## Files
+
+## ftl/run
+
+```
+ftl/run/
+├── CancelLastRun.kt
+├── DumpShards.kt
+├── NewTestRun.kt
+├── RefreshLastRun.kt
+├── common
+│   ├── FetchArtifacts.kt
+│   ├── GetLastArgs.kt
+│   ├── GetLastGcsPath.kt
+│   ├── GetLastMatrices.kt
+│   ├── PollMatrices.kt
+│   ├── PrettyPrint.kt
+│   ├── SaveSessionId.kt
+│   └── UpdateMatrixFile.kt
+├── exception
+│   ├── ExceptionHandler.kt
+│   ├── FlankException.kt
+│   └── FlankExitCodes.kt
+├── model
+│   ├── AndroidMatrixTestShards.kt
+│   ├── AndroidTestContext.kt
+│   ├── AndroidTestShards.kt
+│   ├── IosTestContext.kt
+│   └── TestResult.kt
+├── platform
+│   ├── RunAndroidTests.kt
+│   ├── RunIosTests.kt
+│   ├── android
+│   │   ├── AndroidTestConfig.kt
+│   │   ├── CreateAndroidLoopConfig.kt
+│   │   ├── CreateAndroidTestConfig.kt
+│   │   ├── CreateAndroidTestContext.kt
+│   │   ├── CreateInstrumentationConfig.kt
+│   │   ├── CreateRoboConfig.kt
+│   │   ├── GetAndroidMatrixShards.kt
+│   │   ├── ResolveApks.kt
+│   │   ├── UploadApks.kt
+│   │   └── UploadOtherFiles.kt
+│   ├── common
+│   │   ├── AfterRunTests.kt
+│   │   ├── BeforeRunMessage.kt
+│   │   └── BeforeRunTests.kt
+│   └── ios
+│       ├── CreateGameloopTestContext.kt
+│       ├── CreateIosTestContext.kt
+│       └── CreateXcTestContext.kt
+└── status
+    ├── ExecutionStatus.kt
+    ├── ExecutionStatusListPrinter.kt
+    ├── ExecutionStatusPrinter.kt
+    ├── OutputStyle.kt
+    └── TestMatrixStatusPrinter.kt
+
+
+```
+
+## Dependencies
+
+* `ftl/args/AndroidArgs.kt`
+* `ftl/args/AndroidArgsCompanion.kt`
+* `ftl/args/ArgsHelper.kt`
+* `ftl/args/CalculateShardsResult.kt`
+* `ftl/args/FlankRoboDirective.kt`
+* `ftl/args/IArgs.kt`
+* `ftl/args/IgnoredTestCases.kt`
+* `ftl/args/IosArgs.kt`
+* `ftl/args/IosArgsCompanion.kt`
+* `ftl/args/ShardChunks.kt`
+* `ftl/args/ValidateAndroidArgs.kt`
+* `ftl/args/ValidateIosArgs.kt`
+* `ftl/args/yml/AppTestPair.kt`
+* `ftl/config/FtlConstants.kt`
+* `ftl/filter/TestFilters.kt`
+* `ftl/gc/GcAndroidDevice.kt`
+* `ftl/gc/GcAndroidTestMatrix.kt`
+* `ftl/gc/GcIosMatrix.kt`
+* `ftl/gc/GcIosTestMatrix.kt`
+* `ftl/gc/GcStorage.kt`
+* `ftl/gc/GcTesting.kt`
+* `ftl/gc/GcTestMatrix.kt`
+* `ftl/gc/GcToolResults.kt`
+* `ftl/http/ExecuteWithRetry.kt`
+* `ftl/ios/xctest/XcTestData.kt`
+* `ftl/ios/xctest/XcTestRunFlow.kt`
+* `ftl/ios/xctest/common/Util.kt`
+* `ftl/json/MatrixMap.kt`
+* `ftl/json/SavedMatrix.kt`
+* `ftl/reports/output/OutputReport.kt`
+* `ftl/reports/output/OutputReportLoggers.kt`
+* `ftl/reports/util/ReportManager.kt`
+* `ftl/shard/Chunk.kt`
+* `ftl/shard/Shard.kt`
+* `ftl/shard/TestCasesCreator.kt`
+* `ftl/util/Artifacts.kt`
+* `ftl/util/CrashReporter.kt`
+* `ftl/util/FileReference.kt`
+* `ftl/util/FlankTestMethod.kt`
+* `ftl/util/FlowExt.kt`
+* `ftl/util/MatrixState.kt`
+* `ftl/util/ObfuscationGson.kt`
+* `ftl/util/ShardCounter.kt`
+* `ftl/util/StopWatch.kt`
+* `ftl/util/TestMatrixExtension.kt`
+
+
+# Testing
+
+> How will the project be tested?
+
+# Alternatives Considered [optional]
+
+> Summarize alternative designs (pros & cons)
+
+# Timeline [optional for regular tigers]
+
+> Document milestones and deadlines.
+
+DONE:
+
+  -
+
+NEXT:
+
+  -

docs/refactor/important_cli_commands.md

@@ -0,0 +1,29 @@
+The list of Flank CLI commands that calls domain use cases
+
+* `auth/LoginCommand.kt`
+* `firebase/CancelCommand.kt`
+* `firebase/RefreshCommand.kt`
+* `firebase/test/android/configuration/AndroidLocalesDescribeCommand.kt`
+* `firebase/test/android/configuration/AndroidLocalesListCommand.kt`
+* `firebase/test/android/models/AndroidModelDescribeCommand.kt`
+* `firebase/test/android/models/AndroidModelsListCommand.kt`
+* `firebase/test/android/orientations/AndroidOrientationsListCommand.kt`
+* `firebase/test/android/versions/AndroidVersionsDescribeCommand.kt`
+* `firebase/test/android/versions/AndroidVersionsListCommand.kt`
+* `firebase/test/android/AndroidDoctorCommand.kt`
+* `firebase/test/android/AndroidRunCommand.kt`
+* `firebase/test/android/AndroidTestEnvironmentCommand.kt`
+* `firebase/test/ios/configuration/IosLocalesDescribeCommand.kt`
+* `firebase/test/ios/configuration/IosLocalesListCommand.kt`
+* `firebase/test/ios/models/IosModelDescribeCommand.kt`
+* `firebase/test/ios/models/IosModelsListCommand.kt`
+* `firebase/test/ios/orientations/IosOrientationsListCommand.kt`
+* `firebase/test/ios/versions/IosVersionsDescribeCommand.kt`
+* `firebase/test/ios/versions/IosVersionsListCommand.kt`
+* `firebase/test/ios/IosDoctorCommand.kt`
+* `firebase/test/ios/IosRunCommand.kt`
+* `firebase/test/ios/IosTestEnvironmentCommand.kt`
+* `firebase/test/ipblocks/IPBlocksListCommand.kt`
+* `firebase/test/networkprofiles/NetworkProfilesDescribeCommand.kt`
+* `firebase/test/networkprofiles/NetworkProfilesListCommand.kt`
+* `firebase/test/providedsoftware/ProvidedSoftwareListCommand.kt`