From e9b2a9cbffb25076d9e0de5d2910c7bdf54776da Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Janek=20G=C3=B3ral?= Date: Wed, 17 Mar 2021 12:34:40 +0100 Subject: [PATCH 01/11] Add cli class diagram --- docs/hld/cli/cli-class-diagram.puml | 224 ++++++++++++++++++++++++++++ 1 file changed, 224 insertions(+) create mode 100644 docs/hld/cli/cli-class-diagram.puml diff --git a/docs/hld/cli/cli-class-diagram.puml b/docs/hld/cli/cli-class-diagram.puml new file mode 100644 index 0000000000..ccf2b043c3 --- /dev/null +++ b/docs/hld/cli/cli-class-diagram.puml @@ -0,0 +1,224 @@ +@startuml +'https://plantuml.com/activity-diagram-beta + +left to right direction + +class MainCommand [[../../../test_runner/src/main/kotlin/ftl/Main.kt]] { + flank.jar +} + +class AuthCommand [[../../../test_runner/src/main/kotlin/ftl/cli/AuthCommand.kt]] { + auth +} +class FirebaseCommand [[../../../test_runner/src/main/kotlin/ftl/cli/FirebaseCommand.kt]] { + firebase +} + +class LoginCommand [[../../../test_runner/src/main/kotlin/ftl/cli/auth/LoginCommand.kt]] { + login +} + +class CancelCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/CancelCommand.kt]] { + cancel +} +class RefreshCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/RefreshCommand.kt]] { + refresh +} +class TestCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/TestCommand.kt]] { + test +} + +class AndroidCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/AndroidCommand.kt]] { + android +} +class IosCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/IosCommand.kt]] { + ios +} +class IPBlocksCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/IPBlocksCommand.kt]] { + ip-blocks +} +class NetworkProfilesCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/NetworkProfilesCommand.kt]] { + network-profiles +} +class ProvidedSoftwareCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ProvidedSoftwareCommand.kt]] { + provided-software +} + + +class AndroidDoctorCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidDoctorCommand.kt]] { + doctor +} +class AndroidLocalesCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidLocalesCommand.kt]] { + locales +} +class AndroidModelsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidModelsCommand.kt]] { + models +} +class AndroidOrientationsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidOrientationsCommand.kt]] { + screen-orientations +} +class AndroidRunCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidRunCommand.kt]] { + run +} +class AndroidTestEnvironmentCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidTestEnvironmentCommand.kt]] { + test-environment +} +class AndroidVersionsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidVersionsCommand.kt]] { + versions +} + +class AndroidLocalesListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesListCommand.kt]] { + list +} +class AndroidLocalesDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesDescribeCommand.kt]] { + describe +} + +class AndroidModelsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelsListCommand.kt]] { + list +} +class AndroidModelDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelDescribeCommand.kt]] { + describe +} + +class AndroidOrientationsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/orientations/AndroidOrientationsListCommand.kt]] { + list +} + +class AndroidVersionsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsListCommand.kt]] { + list +} +class AndroidVersionsDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsDescribeCommand.kt]] { + describe +} + + +class IosDoctorCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosDoctorCommand.kt]] { + doctor +} +class IosLocalesCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosLocalesCommand.kt]] { + locales +} +class IosModelsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosModelsCommand.kt]] { + models +} +class IosOrientationsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosOrientationsCommand.kt]] { + screen-orientations +} +class IosRunCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosRunCommand.kt]] { + run +} +class IosTestEnvironmentCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosTestEnvironmentCommand.kt]] { + test-environment +} +class IosVersionsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosVersionsCommand.kt]] { + versions +} + +class IosLocalesListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesListCommand.kt]] { + list +} +class IosLocalesDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesDescribeCommand.kt]] { + describe +} + +class IosModelsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelsListCommand.kt]] { + list +} +class IosModelDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelDescribeCommand.kt]] { + describe +} + +class IosOrientationsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/orientations/IosOrientationsListCommand.kt]] { + list +} + +class IosVersionsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsListCommand.kt]] { + list +} +class IosVersionsDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsDescribeCommand.kt]] { + describe +} + +class IPBlocksListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ipblocks/IPBlocksListCommand.kt]] { + list +} + +class NetworkProfilesDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesDescribeCommand.kt]] { + describe +} +class NetworkProfilesListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesListCommand.kt]] { + list +} + +class ProvidedSoftwareListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/providedsoftware/ProvidedSoftwareListCommand.kt]] { + list +} + +MainCommand --> RefreshCommand +MainCommand --> CancelCommand +MainCommand --> ProvidedSoftwareCommand +MainCommand --> NetworkProfilesCommand +MainCommand --> IPBlocksCommand +MainCommand --> AuthCommand +MainCommand --> IosCommand +MainCommand --> AndroidCommand +MainCommand --> FirebaseCommand + +AuthCommand --> LoginCommand + +IPBlocksCommand --> IPBlocksListCommand + +IosCommand --> IosRunCommand +IosCommand --> IosDoctorCommand +IosCommand --> IosModelsCommand +IosCommand --> IosVersionsCommand +IosCommand --> IosLocalesCommand +IosCommand --> IosOrientationsCommand +IosCommand --> IosTestEnvironmentCommand + +IosModelsCommand --> IosModelsListCommand +IosModelsCommand --> IosModelDescribeCommand + +IosVersionsCommand --> IosVersionsListCommand +IosVersionsCommand --> IosVersionsDescribeCommand + +IosLocalesCommand --> IosLocalesListCommand +IosLocalesCommand --> IosLocalesDescribeCommand + +IosOrientationsCommand --> IosOrientationsListCommand + +AndroidCommand --> AndroidRunCommand +AndroidCommand --> AndroidDoctorCommand +AndroidCommand --> AndroidModelsCommand +AndroidCommand --> AndroidVersionsCommand +AndroidCommand --> AndroidLocalesCommand +AndroidCommand --> AndroidOrientationsCommand +AndroidCommand --> AndroidTestEnvironmentCommand + +AndroidModelsCommand --> AndroidModelsListCommand +AndroidModelsCommand --> AndroidModelDescribeCommand + +AndroidVersionsCommand --> AndroidVersionsListCommand +AndroidVersionsCommand --> AndroidVersionsDescribeCommand + +AndroidLocalesCommand --> AndroidLocalesListCommand +AndroidLocalesCommand --> AndroidLocalesDescribeCommand + +AndroidOrientationsCommand --> AndroidOrientationsListCommand + +FirebaseCommand --> TestCommand +FirebaseCommand --> RefreshCommand +FirebaseCommand --> CancelCommand + +TestCommand --> AndroidCommand +TestCommand --> IosCommand +TestCommand --> NetworkProfilesCommand +TestCommand --> ProvidedSoftwareCommand +TestCommand --> IPBlocksCommand + +NetworkProfilesCommand --> NetworkProfilesDescribeCommand +NetworkProfilesCommand --> NetworkProfilesListCommand + +ProvidedSoftwareCommand --> ProvidedSoftwareListCommand +@enduml From 363af1941c9ac551e2664f8c3678fcd5934d51e9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Janek=20G=C3=B3ral?= Date: Wed, 17 Mar 2021 12:48:30 +0100 Subject: [PATCH 02/11] Add readme.md --- docs/hld/cli/readme.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 docs/hld/cli/readme.md diff --git a/docs/hld/cli/readme.md b/docs/hld/cli/readme.md new file mode 100644 index 0000000000..1f707cbb3d --- /dev/null +++ b/docs/hld/cli/readme.md @@ -0,0 +1,5 @@ +# CLI + +## Class diagram + +![cli_class_diagram](http://www.plantuml.com/plantuml/proxy?cache=no&fmt=svg&src=https://raw.githubusercontent.com/Flank/flank/1493-add-cli-class-diagram/docs/hld/cli/cli-class-diagram.puml) \ No newline at end of file From 17bf6bfd8b19b719209c13142b53ed735b4783ae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Janek=20G=C3=B3ral?= Date: Wed, 17 Mar 2021 14:17:10 +0100 Subject: [PATCH 03/11] Add cli-class-package-diagram.puml --- docs/hld/cli/cli-class-package-diagram.puml | 268 ++++++++++++++++++++ 1 file changed, 268 insertions(+) create mode 100644 docs/hld/cli/cli-class-package-diagram.puml diff --git a/docs/hld/cli/cli-class-package-diagram.puml b/docs/hld/cli/cli-class-package-diagram.puml new file mode 100644 index 0000000000..b3e22ff3ab --- /dev/null +++ b/docs/hld/cli/cli-class-package-diagram.puml @@ -0,0 +1,268 @@ +@startuml +'https://plantuml.com/activity-diagram-beta + +left to right direction + +package "ftl" { + +class MainCommand [[../../../test_runner/src/main/kotlin/ftl/Main.kt]] { + flank.jar +} + +package "cli" { + +class AuthCommand [[../../../test_runner/src/main/kotlin/ftl/cli/AuthCommand.kt]] { + auth +} +class FirebaseCommand [[../../../test_runner/src/main/kotlin/ftl/cli/FirebaseCommand.kt]] { + firebase +} + +package "auth" { +class LoginCommand [[../../../test_runner/src/main/kotlin/ftl/cli/auth/LoginCommand.kt]] { + login +} +} + + +package "firebase" { + +class CancelCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/CancelCommand.kt]] { + cancel +} +class RefreshCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/RefreshCommand.kt]] { + refresh +} +class TestCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/TestCommand.kt]] { + test +} + +package "test" { + +class AndroidCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/AndroidCommand.kt]] { + android +} +class IosCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/IosCommand.kt]] { + ios +} +class IPBlocksCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/IPBlocksCommand.kt]] { + ip-blocks +} +class NetworkProfilesCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/NetworkProfilesCommand.kt]] { + network-profiles +} +class ProvidedSoftwareCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ProvidedSoftwareCommand.kt]] { + provided-software +} + +package "android" { + +class AndroidDoctorCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidDoctorCommand.kt]] { + doctor +} +class AndroidLocalesCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidLocalesCommand.kt]] { + locales +} +class AndroidModelsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidModelsCommand.kt]] { + models +} +class AndroidOrientationsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidOrientationsCommand.kt]] { + screen-orientations +} +class AndroidRunCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidRunCommand.kt]] { + run +} +class AndroidTestEnvironmentCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidTestEnvironmentCommand.kt]] { + test-environment +} +class AndroidVersionsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidVersionsCommand.kt]] { + versions +} + +package "android.locales" { +class AndroidLocalesListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesListCommand.kt]] { + list +} +class AndroidLocalesDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesDescribeCommand.kt]] { + describe +} +} + +package "android.models" { +class AndroidModelsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelsListCommand.kt]] { + list +} +class AndroidModelDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelDescribeCommand.kt]] { + describe +} +} + +package "android.orientations" { +class AndroidOrientationsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/orientations/AndroidOrientationsListCommand.kt]] { + list +} +} + +package "android.versions" { +class AndroidVersionsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsListCommand.kt]] { + list +} +class AndroidVersionsDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsDescribeCommand.kt]] { + describe +} +} +} + + +package "ios" { + +class IosDoctorCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosDoctorCommand.kt]] { + doctor +} + +class IosLocalesCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosLocalesCommand.kt]] { + locales +} +class IosModelsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosModelsCommand.kt]] { + models +} +class IosOrientationsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosOrientationsCommand.kt]] { + screen-orientations +} +class IosRunCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosRunCommand.kt]] { + run +} +class IosTestEnvironmentCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosTestEnvironmentCommand.kt]] { + test-environment +} +class IosVersionsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosVersionsCommand.kt]] { + versions +} + +package "ios.locales" { +class IosLocalesListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesListCommand.kt]] { + list +} +class IosLocalesDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesDescribeCommand.kt]] { + describe +} +} + +package "ios.models" { +class IosModelsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelsListCommand.kt]] { + list +} +class IosModelDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelDescribeCommand.kt]] { + describe +} +} + +package "ios.orientations" { +class IosOrientationsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/orientations/IosOrientationsListCommand.kt]] { + list +} +} + +package "ios.versions" { +class IosVersionsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsListCommand.kt]] { + list +} +class IosVersionsDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsDescribeCommand.kt]] { + describe +} +} + +} + +package "ipblocks" { +class IPBlocksListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ipblocks/IPBlocksListCommand.kt]] { + list +} +} + +package "networkprofiles" { +class NetworkProfilesDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesDescribeCommand.kt]] { + describe +} +class NetworkProfilesListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesListCommand.kt]] { + list +} +} + +package "providedsoftware" { +class ProvidedSoftwareListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/providedsoftware/ProvidedSoftwareListCommand.kt]] { + list +} +} +} +} +} +} + +MainCommand --> RefreshCommand +MainCommand --> CancelCommand +MainCommand --> ProvidedSoftwareCommand +MainCommand --> NetworkProfilesCommand +MainCommand --> IPBlocksCommand +MainCommand --> AuthCommand +MainCommand --> IosCommand +MainCommand --> AndroidCommand +MainCommand --> FirebaseCommand + +AuthCommand --> LoginCommand + +IPBlocksCommand --> IPBlocksListCommand + +IosCommand --> IosRunCommand +IosCommand --> IosDoctorCommand +IosCommand --> IosModelsCommand +IosCommand --> IosVersionsCommand +IosCommand --> IosLocalesCommand +IosCommand --> IosOrientationsCommand +IosCommand --> IosTestEnvironmentCommand + +IosModelsCommand --> IosModelsListCommand +IosModelsCommand --> IosModelDescribeCommand + +IosVersionsCommand --> IosVersionsListCommand +IosVersionsCommand --> IosVersionsDescribeCommand + +IosLocalesCommand --> IosLocalesListCommand +IosLocalesCommand --> IosLocalesDescribeCommand + +IosOrientationsCommand --> IosOrientationsListCommand + +AndroidCommand --> AndroidRunCommand +AndroidCommand --> AndroidDoctorCommand +AndroidCommand --> AndroidModelsCommand +AndroidCommand --> AndroidVersionsCommand +AndroidCommand --> AndroidLocalesCommand +AndroidCommand --> AndroidOrientationsCommand +AndroidCommand --> AndroidTestEnvironmentCommand + +AndroidModelsCommand --> AndroidModelsListCommand +AndroidModelsCommand --> AndroidModelDescribeCommand + +AndroidVersionsCommand --> AndroidVersionsListCommand +AndroidVersionsCommand --> AndroidVersionsDescribeCommand + +AndroidLocalesCommand --> AndroidLocalesListCommand +AndroidLocalesCommand --> AndroidLocalesDescribeCommand + +AndroidOrientationsCommand --> AndroidOrientationsListCommand + +FirebaseCommand --> TestCommand +FirebaseCommand --> RefreshCommand +FirebaseCommand --> CancelCommand + +TestCommand --> AndroidCommand +TestCommand --> IosCommand +TestCommand --> NetworkProfilesCommand +TestCommand --> ProvidedSoftwareCommand +TestCommand --> IPBlocksCommand + +NetworkProfilesCommand --> NetworkProfilesDescribeCommand +NetworkProfilesCommand --> NetworkProfilesListCommand + +ProvidedSoftwareCommand --> ProvidedSoftwareListCommand +@enduml From 2fd91776f9b5e268b388ceacdb453033b13ecd43 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Janek=20G=C3=B3ral?= Date: Thu, 18 Mar 2021 11:44:09 +0100 Subject: [PATCH 04/11] Mark important actions with lightblue color --- docs/hld/cli/cli-class-diagram.puml | 224 -------------------- docs/hld/cli/cli-class-package-diagram.puml | 54 ++--- 2 files changed, 27 insertions(+), 251 deletions(-) delete mode 100644 docs/hld/cli/cli-class-diagram.puml diff --git a/docs/hld/cli/cli-class-diagram.puml b/docs/hld/cli/cli-class-diagram.puml deleted file mode 100644 index ccf2b043c3..0000000000 --- a/docs/hld/cli/cli-class-diagram.puml +++ /dev/null @@ -1,224 +0,0 @@ -@startuml -'https://plantuml.com/activity-diagram-beta - -left to right direction - -class MainCommand [[../../../test_runner/src/main/kotlin/ftl/Main.kt]] { - flank.jar -} - -class AuthCommand [[../../../test_runner/src/main/kotlin/ftl/cli/AuthCommand.kt]] { - auth -} -class FirebaseCommand [[../../../test_runner/src/main/kotlin/ftl/cli/FirebaseCommand.kt]] { - firebase -} - -class LoginCommand [[../../../test_runner/src/main/kotlin/ftl/cli/auth/LoginCommand.kt]] { - login -} - -class CancelCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/CancelCommand.kt]] { - cancel -} -class RefreshCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/RefreshCommand.kt]] { - refresh -} -class TestCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/TestCommand.kt]] { - test -} - -class AndroidCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/AndroidCommand.kt]] { - android -} -class IosCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/IosCommand.kt]] { - ios -} -class IPBlocksCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/IPBlocksCommand.kt]] { - ip-blocks -} -class NetworkProfilesCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/NetworkProfilesCommand.kt]] { - network-profiles -} -class ProvidedSoftwareCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ProvidedSoftwareCommand.kt]] { - provided-software -} - - -class AndroidDoctorCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidDoctorCommand.kt]] { - doctor -} -class AndroidLocalesCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidLocalesCommand.kt]] { - locales -} -class AndroidModelsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidModelsCommand.kt]] { - models -} -class AndroidOrientationsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidOrientationsCommand.kt]] { - screen-orientations -} -class AndroidRunCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidRunCommand.kt]] { - run -} -class AndroidTestEnvironmentCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidTestEnvironmentCommand.kt]] { - test-environment -} -class AndroidVersionsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidVersionsCommand.kt]] { - versions -} - -class AndroidLocalesListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesListCommand.kt]] { - list -} -class AndroidLocalesDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesDescribeCommand.kt]] { - describe -} - -class AndroidModelsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelsListCommand.kt]] { - list -} -class AndroidModelDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelDescribeCommand.kt]] { - describe -} - -class AndroidOrientationsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/orientations/AndroidOrientationsListCommand.kt]] { - list -} - -class AndroidVersionsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsListCommand.kt]] { - list -} -class AndroidVersionsDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsDescribeCommand.kt]] { - describe -} - - -class IosDoctorCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosDoctorCommand.kt]] { - doctor -} -class IosLocalesCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosLocalesCommand.kt]] { - locales -} -class IosModelsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosModelsCommand.kt]] { - models -} -class IosOrientationsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosOrientationsCommand.kt]] { - screen-orientations -} -class IosRunCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosRunCommand.kt]] { - run -} -class IosTestEnvironmentCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosTestEnvironmentCommand.kt]] { - test-environment -} -class IosVersionsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosVersionsCommand.kt]] { - versions -} - -class IosLocalesListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesListCommand.kt]] { - list -} -class IosLocalesDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesDescribeCommand.kt]] { - describe -} - -class IosModelsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelsListCommand.kt]] { - list -} -class IosModelDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelDescribeCommand.kt]] { - describe -} - -class IosOrientationsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/orientations/IosOrientationsListCommand.kt]] { - list -} - -class IosVersionsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsListCommand.kt]] { - list -} -class IosVersionsDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsDescribeCommand.kt]] { - describe -} - -class IPBlocksListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ipblocks/IPBlocksListCommand.kt]] { - list -} - -class NetworkProfilesDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesDescribeCommand.kt]] { - describe -} -class NetworkProfilesListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesListCommand.kt]] { - list -} - -class ProvidedSoftwareListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/providedsoftware/ProvidedSoftwareListCommand.kt]] { - list -} - -MainCommand --> RefreshCommand -MainCommand --> CancelCommand -MainCommand --> ProvidedSoftwareCommand -MainCommand --> NetworkProfilesCommand -MainCommand --> IPBlocksCommand -MainCommand --> AuthCommand -MainCommand --> IosCommand -MainCommand --> AndroidCommand -MainCommand --> FirebaseCommand - -AuthCommand --> LoginCommand - -IPBlocksCommand --> IPBlocksListCommand - -IosCommand --> IosRunCommand -IosCommand --> IosDoctorCommand -IosCommand --> IosModelsCommand -IosCommand --> IosVersionsCommand -IosCommand --> IosLocalesCommand -IosCommand --> IosOrientationsCommand -IosCommand --> IosTestEnvironmentCommand - -IosModelsCommand --> IosModelsListCommand -IosModelsCommand --> IosModelDescribeCommand - -IosVersionsCommand --> IosVersionsListCommand -IosVersionsCommand --> IosVersionsDescribeCommand - -IosLocalesCommand --> IosLocalesListCommand -IosLocalesCommand --> IosLocalesDescribeCommand - -IosOrientationsCommand --> IosOrientationsListCommand - -AndroidCommand --> AndroidRunCommand -AndroidCommand --> AndroidDoctorCommand -AndroidCommand --> AndroidModelsCommand -AndroidCommand --> AndroidVersionsCommand -AndroidCommand --> AndroidLocalesCommand -AndroidCommand --> AndroidOrientationsCommand -AndroidCommand --> AndroidTestEnvironmentCommand - -AndroidModelsCommand --> AndroidModelsListCommand -AndroidModelsCommand --> AndroidModelDescribeCommand - -AndroidVersionsCommand --> AndroidVersionsListCommand -AndroidVersionsCommand --> AndroidVersionsDescribeCommand - -AndroidLocalesCommand --> AndroidLocalesListCommand -AndroidLocalesCommand --> AndroidLocalesDescribeCommand - -AndroidOrientationsCommand --> AndroidOrientationsListCommand - -FirebaseCommand --> TestCommand -FirebaseCommand --> RefreshCommand -FirebaseCommand --> CancelCommand - -TestCommand --> AndroidCommand -TestCommand --> IosCommand -TestCommand --> NetworkProfilesCommand -TestCommand --> ProvidedSoftwareCommand -TestCommand --> IPBlocksCommand - -NetworkProfilesCommand --> NetworkProfilesDescribeCommand -NetworkProfilesCommand --> NetworkProfilesListCommand - -ProvidedSoftwareCommand --> ProvidedSoftwareListCommand -@enduml diff --git a/docs/hld/cli/cli-class-package-diagram.puml b/docs/hld/cli/cli-class-package-diagram.puml index b3e22ff3ab..098f765700 100644 --- a/docs/hld/cli/cli-class-package-diagram.puml +++ b/docs/hld/cli/cli-class-package-diagram.puml @@ -19,7 +19,7 @@ class FirebaseCommand [[../../../test_runner/src/main/kotlin/ftl/cli/FirebaseCom } package "auth" { -class LoginCommand [[../../../test_runner/src/main/kotlin/ftl/cli/auth/LoginCommand.kt]] { +class LoginCommand [[../../../test_runner/src/main/kotlin/ftl/cli/auth/LoginCommand.kt]] #lightblue { login } } @@ -27,10 +27,10 @@ class LoginCommand [[../../../test_runner/src/main/kotlin/ftl/cli/auth/LoginComm package "firebase" { -class CancelCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/CancelCommand.kt]] { +class CancelCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/CancelCommand.kt]] #lightblue { cancel } -class RefreshCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/RefreshCommand.kt]] { +class RefreshCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/RefreshCommand.kt]] #lightblue { refresh } class TestCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/TestCommand.kt]] { @@ -57,7 +57,7 @@ class ProvidedSoftwareCommand [[../../../test_runner/src/main/kotlin/ftl/cli/fir package "android" { -class AndroidDoctorCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidDoctorCommand.kt]] { +class AndroidDoctorCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidDoctorCommand.kt]] #lightblue { doctor } class AndroidLocalesCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidLocalesCommand.kt]] { @@ -69,10 +69,10 @@ class AndroidModelsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/fireba class AndroidOrientationsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidOrientationsCommand.kt]] { screen-orientations } -class AndroidRunCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidRunCommand.kt]] { +class AndroidRunCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidRunCommand.kt]] #lightblue { run } -class AndroidTestEnvironmentCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidTestEnvironmentCommand.kt]] { +class AndroidTestEnvironmentCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidTestEnvironmentCommand.kt]] #lightblue { test-environment } class AndroidVersionsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidVersionsCommand.kt]] { @@ -80,34 +80,34 @@ class AndroidVersionsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/fire } package "android.locales" { -class AndroidLocalesListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesListCommand.kt]] { +class AndroidLocalesListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesListCommand.kt]] #lightblue { list } -class AndroidLocalesDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesDescribeCommand.kt]] { +class AndroidLocalesDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesDescribeCommand.kt]] #lightblue { describe } } package "android.models" { -class AndroidModelsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelsListCommand.kt]] { +class AndroidModelsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelsListCommand.kt]] #lightblue { list } -class AndroidModelDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelDescribeCommand.kt]] { +class AndroidModelDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelDescribeCommand.kt]] #lightblue { describe } } package "android.orientations" { -class AndroidOrientationsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/orientations/AndroidOrientationsListCommand.kt]] { +class AndroidOrientationsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/orientations/AndroidOrientationsListCommand.kt]] #lightblue { list } } package "android.versions" { -class AndroidVersionsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsListCommand.kt]] { +class AndroidVersionsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsListCommand.kt]] #lightblue { list } -class AndroidVersionsDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsDescribeCommand.kt]] { +class AndroidVersionsDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsDescribeCommand.kt]] #lightblue { describe } } @@ -116,7 +116,7 @@ class AndroidVersionsDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/ package "ios" { -class IosDoctorCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosDoctorCommand.kt]] { +class IosDoctorCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosDoctorCommand.kt]] #lightblue { doctor } @@ -129,10 +129,10 @@ class IosModelsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/t class IosOrientationsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosOrientationsCommand.kt]] { screen-orientations } -class IosRunCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosRunCommand.kt]] { +class IosRunCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosRunCommand.kt]] #lightblue { run } -class IosTestEnvironmentCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosTestEnvironmentCommand.kt]] { +class IosTestEnvironmentCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosTestEnvironmentCommand.kt]] #lightblue { test-environment } class IosVersionsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosVersionsCommand.kt]] { @@ -140,34 +140,34 @@ class IosVersionsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase } package "ios.locales" { -class IosLocalesListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesListCommand.kt]] { +class IosLocalesListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesListCommand.kt]] #lightblue { list } -class IosLocalesDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesDescribeCommand.kt]] { +class IosLocalesDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesDescribeCommand.kt]] #lightblue { describe } } package "ios.models" { -class IosModelsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelsListCommand.kt]] { +class IosModelsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelsListCommand.kt]] #lightblue { list } -class IosModelDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelDescribeCommand.kt]] { +class IosModelDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelDescribeCommand.kt]] #lightblue { describe } } package "ios.orientations" { -class IosOrientationsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/orientations/IosOrientationsListCommand.kt]] { +class IosOrientationsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/orientations/IosOrientationsListCommand.kt]] #lightblue { list } } package "ios.versions" { -class IosVersionsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsListCommand.kt]] { +class IosVersionsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsListCommand.kt]] #lightblue { list } -class IosVersionsDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsDescribeCommand.kt]] { +class IosVersionsDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsDescribeCommand.kt]] #lightblue { describe } } @@ -175,22 +175,22 @@ class IosVersionsDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/ } package "ipblocks" { -class IPBlocksListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ipblocks/IPBlocksListCommand.kt]] { +class IPBlocksListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ipblocks/IPBlocksListCommand.kt]] #lightblue { list } } package "networkprofiles" { -class NetworkProfilesDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesDescribeCommand.kt]] { +class NetworkProfilesDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesDescribeCommand.kt]] #lightblue { describe } -class NetworkProfilesListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesListCommand.kt]] { +class NetworkProfilesListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesListCommand.kt]] #lightblue { list } } package "providedsoftware" { -class ProvidedSoftwareListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/providedsoftware/ProvidedSoftwareListCommand.kt]] { +class ProvidedSoftwareListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/providedsoftware/ProvidedSoftwareListCommand.kt]] #lightblue { list } } From 3f50ea34bbf174369c90842a5ea24464fc906929 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Janek=20G=C3=B3ral?= Date: Thu, 18 Mar 2021 18:16:11 +0100 Subject: [PATCH 05/11] Add github links --- docs/hld/cli/cli-class-package-diagram.puml | 44 +++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/docs/hld/cli/cli-class-package-diagram.puml b/docs/hld/cli/cli-class-package-diagram.puml index 098f765700..131d5884fa 100644 --- a/docs/hld/cli/cli-class-package-diagram.puml +++ b/docs/hld/cli/cli-class-package-diagram.puml @@ -7,20 +7,24 @@ package "ftl" { class MainCommand [[../../../test_runner/src/main/kotlin/ftl/Main.kt]] { flank.jar + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/Main.kt github link]] } package "cli" { class AuthCommand [[../../../test_runner/src/main/kotlin/ftl/cli/AuthCommand.kt]] { auth + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/AuthCommand.kt github link]] } class FirebaseCommand [[../../../test_runner/src/main/kotlin/ftl/cli/FirebaseCommand.kt]] { firebase + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/FirebaseCommand.kt github link]] } package "auth" { class LoginCommand [[../../../test_runner/src/main/kotlin/ftl/cli/auth/LoginCommand.kt]] #lightblue { login + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/auth/LoginCommand.kt github link]] } } @@ -29,86 +33,108 @@ package "firebase" { class CancelCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/CancelCommand.kt]] #lightblue { cancel + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/CancelCommand.kt github link]] } class RefreshCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/RefreshCommand.kt]] #lightblue { refresh + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/RefreshCommand.kt github link]] } class TestCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/TestCommand.kt]] { test + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/TestCommand.kt github link]] } package "test" { class AndroidCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/AndroidCommand.kt]] { android + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/AndroidCommand.kt github link]] } class IosCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/IosCommand.kt]] { ios + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/IosCommand.kt github link]] } class IPBlocksCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/IPBlocksCommand.kt]] { ip-blocks + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/IPBlocksCommand.kt github link]] } class NetworkProfilesCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/NetworkProfilesCommand.kt]] { network-profiles + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/NetworkProfilesCommand.kt github link]] } class ProvidedSoftwareCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ProvidedSoftwareCommand.kt]] { provided-software + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ProvidedSoftwareCommand.kt github link]] } package "android" { class AndroidDoctorCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidDoctorCommand.kt]] #lightblue { doctor + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidDoctorCommand.kt github link]] } class AndroidLocalesCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidLocalesCommand.kt]] { locales + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidLocalesCommand.kt github link]] } class AndroidModelsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidModelsCommand.kt]] { models + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidModelsCommand.kt github link]] } class AndroidOrientationsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidOrientationsCommand.kt]] { screen-orientations + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidOrientationsCommand.kt github link]] } class AndroidRunCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidRunCommand.kt]] #lightblue { run + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidRunCommand.kt github link]] } class AndroidTestEnvironmentCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidTestEnvironmentCommand.kt]] #lightblue { test-environment + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidTestEnvironmentCommand.kt github link]] } class AndroidVersionsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidVersionsCommand.kt]] { versions + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidVersionsCommand.kt github link]] } package "android.locales" { class AndroidLocalesListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesListCommand.kt]] #lightblue { list + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesListCommand.kt github link]] } class AndroidLocalesDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesDescribeCommand.kt]] #lightblue { describe + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesDescribeCommand.kt github link]] } } package "android.models" { class AndroidModelsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelsListCommand.kt]] #lightblue { list + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelsListCommand.kt github link]] } class AndroidModelDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelDescribeCommand.kt]] #lightblue { describe + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelDescribeCommand.kt github link]] } } package "android.orientations" { class AndroidOrientationsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/orientations/AndroidOrientationsListCommand.kt]] #lightblue { list + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/orientations/AndroidOrientationsListCommand.kt github link]] } } package "android.versions" { class AndroidVersionsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsListCommand.kt]] #lightblue { list + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsListCommand.kt github link]] } class AndroidVersionsDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsDescribeCommand.kt]] #lightblue { describe + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsDescribeCommand.kt github link]] } } } @@ -118,57 +144,71 @@ package "ios" { class IosDoctorCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosDoctorCommand.kt]] #lightblue { doctor + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosDoctorCommand.kt github link]] } class IosLocalesCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosLocalesCommand.kt]] { locales + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosLocalesCommand.kt github link]] } class IosModelsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosModelsCommand.kt]] { models + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosModelsCommand.kt github link]] } class IosOrientationsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosOrientationsCommand.kt]] { screen-orientations + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosOrientationsCommand.kt github link]] } class IosRunCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosRunCommand.kt]] #lightblue { run + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosRunCommand.kt github link]] } class IosTestEnvironmentCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosTestEnvironmentCommand.kt]] #lightblue { test-environment + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosTestEnvironmentCommand.kt github link]] } class IosVersionsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosVersionsCommand.kt]] { versions + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosVersionsCommand.kt github link]] } package "ios.locales" { class IosLocalesListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesListCommand.kt]] #lightblue { list + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesListCommand.kt github link]] } class IosLocalesDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesDescribeCommand.kt]] #lightblue { describe + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesDescribeCommand.kt github link]] } } package "ios.models" { class IosModelsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelsListCommand.kt]] #lightblue { list + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelsListCommand.kt github link]] } class IosModelDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelDescribeCommand.kt]] #lightblue { describe + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelDescribeCommand.kt github link]] } } package "ios.orientations" { class IosOrientationsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/orientations/IosOrientationsListCommand.kt]] #lightblue { list + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/orientations/IosOrientationsListCommand.kt github link]] } } package "ios.versions" { class IosVersionsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsListCommand.kt]] #lightblue { list + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsListCommand.kt github link]] } class IosVersionsDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsDescribeCommand.kt]] #lightblue { describe + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsDescribeCommand.kt github link]] } } @@ -177,21 +217,25 @@ class IosVersionsDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/ package "ipblocks" { class IPBlocksListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ipblocks/IPBlocksListCommand.kt]] #lightblue { list + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ipblocks/IPBlocksListCommand.kt github link]] } } package "networkprofiles" { class NetworkProfilesDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesDescribeCommand.kt]] #lightblue { describe + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesDescribeCommand.kt github link]] } class NetworkProfilesListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesListCommand.kt]] #lightblue { list + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesListCommand.kt github link]] } } package "providedsoftware" { class ProvidedSoftwareListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/providedsoftware/ProvidedSoftwareListCommand.kt]] #lightblue { list + [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/providedsoftware/ProvidedSoftwareListCommand.kt github link]] } } } From 02363e3c57e98563396bc71830825b73eb114953 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Janek=20G=C3=B3ral?= Date: Thu, 18 Mar 2021 18:40:29 +0100 Subject: [PATCH 06/11] Replace github links with local links --- docs/hld/cli/cli-class-package-diagram.puml | 178 ++++++++++---------- 1 file changed, 89 insertions(+), 89 deletions(-) diff --git a/docs/hld/cli/cli-class-package-diagram.puml b/docs/hld/cli/cli-class-package-diagram.puml index 131d5884fa..9ac618000d 100644 --- a/docs/hld/cli/cli-class-package-diagram.puml +++ b/docs/hld/cli/cli-class-package-diagram.puml @@ -1,140 +1,140 @@ @startuml 'https://plantuml.com/activity-diagram-beta - +'https://github.com/Flank/flank/blob/master left to right direction package "ftl" { -class MainCommand [[../../../test_runner/src/main/kotlin/ftl/Main.kt]] { +class MainCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/Main.kt]] { flank.jar - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/Main.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/Main.kt local link]] } package "cli" { -class AuthCommand [[../../../test_runner/src/main/kotlin/ftl/cli/AuthCommand.kt]] { +class AuthCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/AuthCommand.kt]] { auth - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/AuthCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/AuthCommand.kt local link]] } -class FirebaseCommand [[../../../test_runner/src/main/kotlin/ftl/cli/FirebaseCommand.kt]] { +class FirebaseCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/FirebaseCommand.kt]] { firebase - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/FirebaseCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/FirebaseCommand.kt local link]] } package "auth" { -class LoginCommand [[../../../test_runner/src/main/kotlin/ftl/cli/auth/LoginCommand.kt]] #lightblue { +class LoginCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/auth/LoginCommand.kt]] #lightblue { login - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/auth/LoginCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/auth/LoginCommand.kt local link]] } } package "firebase" { -class CancelCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/CancelCommand.kt]] #lightblue { +class CancelCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/CancelCommand.kt]] #lightblue { cancel - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/CancelCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/CancelCommand.kt local link]] } -class RefreshCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/RefreshCommand.kt]] #lightblue { +class RefreshCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/RefreshCommand.kt]] #lightblue { refresh - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/RefreshCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/RefreshCommand.kt local link]] } -class TestCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/TestCommand.kt]] { +class TestCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/TestCommand.kt]] { test - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/TestCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/TestCommand.kt local link]] } package "test" { -class AndroidCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/AndroidCommand.kt]] { +class AndroidCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/AndroidCommand.kt]] { android - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/AndroidCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/AndroidCommand.kt local link]] } -class IosCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/IosCommand.kt]] { +class IosCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/IosCommand.kt]] { ios - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/IosCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/IosCommand.kt local link]] } -class IPBlocksCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/IPBlocksCommand.kt]] { +class IPBlocksCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/IPBlocksCommand.kt]] { ip-blocks - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/IPBlocksCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/IPBlocksCommand.kt local link]] } -class NetworkProfilesCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/NetworkProfilesCommand.kt]] { +class NetworkProfilesCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/NetworkProfilesCommand.kt]] { network-profiles - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/NetworkProfilesCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/NetworkProfilesCommand.kt local link]] } -class ProvidedSoftwareCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ProvidedSoftwareCommand.kt]] { +class ProvidedSoftwareCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ProvidedSoftwareCommand.kt]] { provided-software - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ProvidedSoftwareCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ProvidedSoftwareCommand.kt local link]] } package "android" { -class AndroidDoctorCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidDoctorCommand.kt]] #lightblue { +class AndroidDoctorCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidDoctorCommand.kt]] #lightblue { doctor - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidDoctorCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidDoctorCommand.kt local link]] } -class AndroidLocalesCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidLocalesCommand.kt]] { +class AndroidLocalesCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidLocalesCommand.kt]] { locales - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidLocalesCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidLocalesCommand.kt local link]] } -class AndroidModelsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidModelsCommand.kt]] { +class AndroidModelsCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidModelsCommand.kt]] { models - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidModelsCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidModelsCommand.kt local link]] } -class AndroidOrientationsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidOrientationsCommand.kt]] { +class AndroidOrientationsCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidOrientationsCommand.kt]] { screen-orientations - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidOrientationsCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidOrientationsCommand.kt local link]] } -class AndroidRunCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidRunCommand.kt]] #lightblue { +class AndroidRunCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidRunCommand.kt]] #lightblue { run - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidRunCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidRunCommand.kt local link]] } -class AndroidTestEnvironmentCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidTestEnvironmentCommand.kt]] #lightblue { +class AndroidTestEnvironmentCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidTestEnvironmentCommand.kt]] #lightblue { test-environment - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidTestEnvironmentCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidTestEnvironmentCommand.kt local link]] } -class AndroidVersionsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidVersionsCommand.kt]] { +class AndroidVersionsCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidVersionsCommand.kt]] { versions - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidVersionsCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidVersionsCommand.kt local link]] } package "android.locales" { -class AndroidLocalesListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesListCommand.kt]] #lightblue { +class AndroidLocalesListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesListCommand.kt]] #lightblue { list - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesListCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesListCommand.kt local link]] } -class AndroidLocalesDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesDescribeCommand.kt]] #lightblue { +class AndroidLocalesDescribeCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesDescribeCommand.kt]] #lightblue { describe - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesDescribeCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesDescribeCommand.kt local link]] } } package "android.models" { -class AndroidModelsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelsListCommand.kt]] #lightblue { +class AndroidModelsListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelsListCommand.kt]] #lightblue { list - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelsListCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelsListCommand.kt local link]] } -class AndroidModelDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelDescribeCommand.kt]] #lightblue { +class AndroidModelDescribeCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelDescribeCommand.kt]] #lightblue { describe - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelDescribeCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelDescribeCommand.kt local link]] } } package "android.orientations" { -class AndroidOrientationsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/orientations/AndroidOrientationsListCommand.kt]] #lightblue { +class AndroidOrientationsListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/orientations/AndroidOrientationsListCommand.kt]] #lightblue { list - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/orientations/AndroidOrientationsListCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/orientations/AndroidOrientationsListCommand.kt local link]] } } package "android.versions" { -class AndroidVersionsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsListCommand.kt]] #lightblue { +class AndroidVersionsListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsListCommand.kt]] #lightblue { list - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsListCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsListCommand.kt local link]] } -class AndroidVersionsDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsDescribeCommand.kt]] #lightblue { +class AndroidVersionsDescribeCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsDescribeCommand.kt]] #lightblue { describe - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsDescribeCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsDescribeCommand.kt local link]] } } } @@ -142,100 +142,100 @@ class AndroidVersionsDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/ package "ios" { -class IosDoctorCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosDoctorCommand.kt]] #lightblue { +class IosDoctorCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosDoctorCommand.kt]] #lightblue { doctor - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosDoctorCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosDoctorCommand.kt local link]] } -class IosLocalesCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosLocalesCommand.kt]] { +class IosLocalesCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosLocalesCommand.kt]] { locales - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosLocalesCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosLocalesCommand.kt local link]] } -class IosModelsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosModelsCommand.kt]] { +class IosModelsCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosModelsCommand.kt]] { models - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosModelsCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosModelsCommand.kt local link]] } -class IosOrientationsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosOrientationsCommand.kt]] { +class IosOrientationsCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosOrientationsCommand.kt]] { screen-orientations - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosOrientationsCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosOrientationsCommand.kt local link]] } -class IosRunCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosRunCommand.kt]] #lightblue { +class IosRunCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosRunCommand.kt]] #lightblue { run - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosRunCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosRunCommand.kt local link]] } -class IosTestEnvironmentCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosTestEnvironmentCommand.kt]] #lightblue { +class IosTestEnvironmentCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosTestEnvironmentCommand.kt]] #lightblue { test-environment - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosTestEnvironmentCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosTestEnvironmentCommand.kt local link]] } -class IosVersionsCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosVersionsCommand.kt]] { +class IosVersionsCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosVersionsCommand.kt]] { versions - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosVersionsCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosVersionsCommand.kt local link]] } package "ios.locales" { -class IosLocalesListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesListCommand.kt]] #lightblue { +class IosLocalesListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesListCommand.kt]] #lightblue { list - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesListCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesListCommand.kt local link]] } -class IosLocalesDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesDescribeCommand.kt]] #lightblue { +class IosLocalesDescribeCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesDescribeCommand.kt]] #lightblue { describe - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesDescribeCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesDescribeCommand.kt local link]] } } package "ios.models" { -class IosModelsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelsListCommand.kt]] #lightblue { +class IosModelsListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelsListCommand.kt]] #lightblue { list - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelsListCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelsListCommand.kt local link]] } -class IosModelDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelDescribeCommand.kt]] #lightblue { +class IosModelDescribeCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelDescribeCommand.kt]] #lightblue { describe - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelDescribeCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelDescribeCommand.kt local link]] } } package "ios.orientations" { -class IosOrientationsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/orientations/IosOrientationsListCommand.kt]] #lightblue { +class IosOrientationsListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/orientations/IosOrientationsListCommand.kt]] #lightblue { list - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/orientations/IosOrientationsListCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/orientations/IosOrientationsListCommand.kt local link]] } } package "ios.versions" { -class IosVersionsListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsListCommand.kt]] #lightblue { +class IosVersionsListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsListCommand.kt]] #lightblue { list - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsListCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsListCommand.kt local link]] } -class IosVersionsDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsDescribeCommand.kt]] #lightblue { +class IosVersionsDescribeCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsDescribeCommand.kt]] #lightblue { describe - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsDescribeCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsDescribeCommand.kt local link]] } } } package "ipblocks" { -class IPBlocksListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ipblocks/IPBlocksListCommand.kt]] #lightblue { +class IPBlocksListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ipblocks/IPBlocksListCommand.kt]] #lightblue { list - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ipblocks/IPBlocksListCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ipblocks/IPBlocksListCommand.kt local link]] } } package "networkprofiles" { -class NetworkProfilesDescribeCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesDescribeCommand.kt]] #lightblue { +class NetworkProfilesDescribeCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesDescribeCommand.kt]] #lightblue { describe - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesDescribeCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesDescribeCommand.kt local link]] } -class NetworkProfilesListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesListCommand.kt]] #lightblue { +class NetworkProfilesListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesListCommand.kt]] #lightblue { list - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesListCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesListCommand.kt local link]] } } package "providedsoftware" { -class ProvidedSoftwareListCommand [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/providedsoftware/ProvidedSoftwareListCommand.kt]] #lightblue { +class ProvidedSoftwareListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/providedsoftware/ProvidedSoftwareListCommand.kt]] #lightblue { list - [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/providedsoftware/ProvidedSoftwareListCommand.kt github link]] + [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/providedsoftware/ProvidedSoftwareListCommand.kt local link]] } } } From b63367621e43a034f2a273dcee5fdd4d069bea69 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Janek=20G=C3=B3ral?= Date: Fri, 19 Mar 2021 02:07:16 +0100 Subject: [PATCH 07/11] update cli readme.md & cli-class-diagram.puml --- docs/hld/cli/cli-class-package-diagram.puml | 312 -------------- docs/hld/cli/readme.md | 5 - .../presentation/cli/cli-class-diagram.puml | 388 ++++++++++++++++++ docs/hld/presentation/cli/readme.md | 41 ++ 4 files changed, 429 insertions(+), 317 deletions(-) delete mode 100644 docs/hld/cli/cli-class-package-diagram.puml delete mode 100644 docs/hld/cli/readme.md create mode 100644 docs/hld/presentation/cli/cli-class-diagram.puml create mode 100644 docs/hld/presentation/cli/readme.md diff --git a/docs/hld/cli/cli-class-package-diagram.puml b/docs/hld/cli/cli-class-package-diagram.puml deleted file mode 100644 index 9ac618000d..0000000000 --- a/docs/hld/cli/cli-class-package-diagram.puml +++ /dev/null @@ -1,312 +0,0 @@ -@startuml -'https://plantuml.com/activity-diagram-beta -'https://github.com/Flank/flank/blob/master -left to right direction - -package "ftl" { - -class MainCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/Main.kt]] { - flank.jar - [[../../../test_runner/src/main/kotlin/ftl/Main.kt local link]] -} - -package "cli" { - -class AuthCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/AuthCommand.kt]] { - auth - [[../../../test_runner/src/main/kotlin/ftl/cli/AuthCommand.kt local link]] -} -class FirebaseCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/FirebaseCommand.kt]] { - firebase - [[../../../test_runner/src/main/kotlin/ftl/cli/FirebaseCommand.kt local link]] -} - -package "auth" { -class LoginCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/auth/LoginCommand.kt]] #lightblue { - login - [[../../../test_runner/src/main/kotlin/ftl/cli/auth/LoginCommand.kt local link]] -} -} - - -package "firebase" { - -class CancelCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/CancelCommand.kt]] #lightblue { - cancel - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/CancelCommand.kt local link]] -} -class RefreshCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/RefreshCommand.kt]] #lightblue { - refresh - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/RefreshCommand.kt local link]] -} -class TestCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/TestCommand.kt]] { - test - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/TestCommand.kt local link]] -} - -package "test" { - -class AndroidCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/AndroidCommand.kt]] { - android - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/AndroidCommand.kt local link]] -} -class IosCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/IosCommand.kt]] { - ios - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/IosCommand.kt local link]] -} -class IPBlocksCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/IPBlocksCommand.kt]] { - ip-blocks - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/IPBlocksCommand.kt local link]] -} -class NetworkProfilesCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/NetworkProfilesCommand.kt]] { - network-profiles - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/NetworkProfilesCommand.kt local link]] -} -class ProvidedSoftwareCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ProvidedSoftwareCommand.kt]] { - provided-software - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ProvidedSoftwareCommand.kt local link]] -} - -package "android" { - -class AndroidDoctorCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidDoctorCommand.kt]] #lightblue { - doctor - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidDoctorCommand.kt local link]] -} -class AndroidLocalesCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidLocalesCommand.kt]] { - locales - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidLocalesCommand.kt local link]] -} -class AndroidModelsCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidModelsCommand.kt]] { - models - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidModelsCommand.kt local link]] -} -class AndroidOrientationsCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidOrientationsCommand.kt]] { - screen-orientations - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidOrientationsCommand.kt local link]] -} -class AndroidRunCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidRunCommand.kt]] #lightblue { - run - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidRunCommand.kt local link]] -} -class AndroidTestEnvironmentCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidTestEnvironmentCommand.kt]] #lightblue { - test-environment - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidTestEnvironmentCommand.kt local link]] -} -class AndroidVersionsCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidVersionsCommand.kt]] { - versions - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidVersionsCommand.kt local link]] -} - -package "android.locales" { -class AndroidLocalesListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesListCommand.kt]] #lightblue { - list - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesListCommand.kt local link]] -} -class AndroidLocalesDescribeCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesDescribeCommand.kt]] #lightblue { - describe - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesDescribeCommand.kt local link]] -} -} - -package "android.models" { -class AndroidModelsListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelsListCommand.kt]] #lightblue { - list - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelsListCommand.kt local link]] -} -class AndroidModelDescribeCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelDescribeCommand.kt]] #lightblue { - describe - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelDescribeCommand.kt local link]] -} -} - -package "android.orientations" { -class AndroidOrientationsListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/orientations/AndroidOrientationsListCommand.kt]] #lightblue { - list - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/orientations/AndroidOrientationsListCommand.kt local link]] -} -} - -package "android.versions" { -class AndroidVersionsListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsListCommand.kt]] #lightblue { - list - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsListCommand.kt local link]] -} -class AndroidVersionsDescribeCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsDescribeCommand.kt]] #lightblue { - describe - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsDescribeCommand.kt local link]] -} -} -} - - -package "ios" { - -class IosDoctorCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosDoctorCommand.kt]] #lightblue { - doctor - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosDoctorCommand.kt local link]] -} - -class IosLocalesCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosLocalesCommand.kt]] { - locales - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosLocalesCommand.kt local link]] -} -class IosModelsCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosModelsCommand.kt]] { - models - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosModelsCommand.kt local link]] -} -class IosOrientationsCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosOrientationsCommand.kt]] { - screen-orientations - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosOrientationsCommand.kt local link]] -} -class IosRunCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosRunCommand.kt]] #lightblue { - run - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosRunCommand.kt local link]] -} -class IosTestEnvironmentCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosTestEnvironmentCommand.kt]] #lightblue { - test-environment - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosTestEnvironmentCommand.kt local link]] -} -class IosVersionsCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosVersionsCommand.kt]] { - versions - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosVersionsCommand.kt local link]] -} - -package "ios.locales" { -class IosLocalesListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesListCommand.kt]] #lightblue { - list - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesListCommand.kt local link]] -} -class IosLocalesDescribeCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesDescribeCommand.kt]] #lightblue { - describe - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesDescribeCommand.kt local link]] -} -} - -package "ios.models" { -class IosModelsListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelsListCommand.kt]] #lightblue { - list - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelsListCommand.kt local link]] -} -class IosModelDescribeCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelDescribeCommand.kt]] #lightblue { - describe - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelDescribeCommand.kt local link]] -} -} - -package "ios.orientations" { -class IosOrientationsListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/orientations/IosOrientationsListCommand.kt]] #lightblue { - list - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/orientations/IosOrientationsListCommand.kt local link]] -} -} - -package "ios.versions" { -class IosVersionsListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsListCommand.kt]] #lightblue { - list - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsListCommand.kt local link]] -} -class IosVersionsDescribeCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsDescribeCommand.kt]] #lightblue { - describe - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsDescribeCommand.kt local link]] -} -} - -} - -package "ipblocks" { -class IPBlocksListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ipblocks/IPBlocksListCommand.kt]] #lightblue { - list - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ipblocks/IPBlocksListCommand.kt local link]] -} -} - -package "networkprofiles" { -class NetworkProfilesDescribeCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesDescribeCommand.kt]] #lightblue { - describe - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesDescribeCommand.kt local link]] -} -class NetworkProfilesListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesListCommand.kt]] #lightblue { - list - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesListCommand.kt local link]] -} -} - -package "providedsoftware" { -class ProvidedSoftwareListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/providedsoftware/ProvidedSoftwareListCommand.kt]] #lightblue { - list - [[../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/providedsoftware/ProvidedSoftwareListCommand.kt local link]] -} -} -} -} -} -} - -MainCommand --> RefreshCommand -MainCommand --> CancelCommand -MainCommand --> ProvidedSoftwareCommand -MainCommand --> NetworkProfilesCommand -MainCommand --> IPBlocksCommand -MainCommand --> AuthCommand -MainCommand --> IosCommand -MainCommand --> AndroidCommand -MainCommand --> FirebaseCommand - -AuthCommand --> LoginCommand - -IPBlocksCommand --> IPBlocksListCommand - -IosCommand --> IosRunCommand -IosCommand --> IosDoctorCommand -IosCommand --> IosModelsCommand -IosCommand --> IosVersionsCommand -IosCommand --> IosLocalesCommand -IosCommand --> IosOrientationsCommand -IosCommand --> IosTestEnvironmentCommand - -IosModelsCommand --> IosModelsListCommand -IosModelsCommand --> IosModelDescribeCommand - -IosVersionsCommand --> IosVersionsListCommand -IosVersionsCommand --> IosVersionsDescribeCommand - -IosLocalesCommand --> IosLocalesListCommand -IosLocalesCommand --> IosLocalesDescribeCommand - -IosOrientationsCommand --> IosOrientationsListCommand - -AndroidCommand --> AndroidRunCommand -AndroidCommand --> AndroidDoctorCommand -AndroidCommand --> AndroidModelsCommand -AndroidCommand --> AndroidVersionsCommand -AndroidCommand --> AndroidLocalesCommand -AndroidCommand --> AndroidOrientationsCommand -AndroidCommand --> AndroidTestEnvironmentCommand - -AndroidModelsCommand --> AndroidModelsListCommand -AndroidModelsCommand --> AndroidModelDescribeCommand - -AndroidVersionsCommand --> AndroidVersionsListCommand -AndroidVersionsCommand --> AndroidVersionsDescribeCommand - -AndroidLocalesCommand --> AndroidLocalesListCommand -AndroidLocalesCommand --> AndroidLocalesDescribeCommand - -AndroidOrientationsCommand --> AndroidOrientationsListCommand - -FirebaseCommand --> TestCommand -FirebaseCommand --> RefreshCommand -FirebaseCommand --> CancelCommand - -TestCommand --> AndroidCommand -TestCommand --> IosCommand -TestCommand --> NetworkProfilesCommand -TestCommand --> ProvidedSoftwareCommand -TestCommand --> IPBlocksCommand - -NetworkProfilesCommand --> NetworkProfilesDescribeCommand -NetworkProfilesCommand --> NetworkProfilesListCommand - -ProvidedSoftwareCommand --> ProvidedSoftwareListCommand -@enduml diff --git a/docs/hld/cli/readme.md b/docs/hld/cli/readme.md deleted file mode 100644 index 1f707cbb3d..0000000000 --- a/docs/hld/cli/readme.md +++ /dev/null @@ -1,5 +0,0 @@ -# CLI - -## Class diagram - -![cli_class_diagram](http://www.plantuml.com/plantuml/proxy?cache=no&fmt=svg&src=https://raw.githubusercontent.com/Flank/flank/1493-add-cli-class-diagram/docs/hld/cli/cli-class-diagram.puml) \ No newline at end of file diff --git a/docs/hld/presentation/cli/cli-class-diagram.puml b/docs/hld/presentation/cli/cli-class-diagram.puml new file mode 100644 index 0000000000..4b50fa6a09 --- /dev/null +++ b/docs/hld/presentation/cli/cli-class-diagram.puml @@ -0,0 +1,388 @@ +@startuml +'https://plantuml.com/activity-diagram-beta +'https://github.com/Flank/flank/blob/master +left to right direction + +package "ftl" { + +class MainCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/Main.kt]] { + flank.jar + [[../../../../test_runner/src/main/kotlin/ftl/Main.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_.adoc github adoc]] + [[]] +} + +package "cli" { + +class AuthCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/AuthCommand.kt]] { + auth + [[../../../../test_runner/src/main/kotlin/ftl/cli/AuthCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-auth.adoc github adoc]] +} + +package "auth" { +class LoginCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/auth/LoginCommand.kt]] #lightblue { + login + [[../../../../test_runner/src/main/kotlin/ftl/cli/auth/LoginCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-auth-login.adoc github adoc]] +} +} + +class FirebaseCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/FirebaseCommand.kt]] { + firebase + [[../../../../test_runner/src/main/kotlin/ftl/cli/FirebaseCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase gcloud equivalent]] +} + + +package "firebase" { + +class RefreshCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/RefreshCommand.kt]] #lightblue { + refresh + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/RefreshCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-refresh.adoc github adoc]] +} +class CancelCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/CancelCommand.kt]] #lightblue { + cancel + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/CancelCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-cancel.adoc github adoc]] +} +class TestCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/TestCommand.kt]] { + test + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/TestCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test gcloud equivalent]] +} + +package "test" { + +class AndroidCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/AndroidCommand.kt]] { + android + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/AndroidCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-android.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test/android gcloud equivalent]] +} +class IosCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/IosCommand.kt]] { + ios + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/IosCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-ios.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test/ios gcloud equivalent]] +} +class IPBlocksCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/IPBlocksCommand.kt]] { + ip-blocks + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/IPBlocksCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-ip-blocks.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test/ip-blocks gcloud equivalent]] +} +class NetworkProfilesCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/NetworkProfilesCommand.kt]] { + network-profiles + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/NetworkProfilesCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-network-profiles.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test/network-profiles gcloud equivalent]] +} +class ProvidedSoftwareCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ProvidedSoftwareCommand.kt]] { + provided-software + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ProvidedSoftwareCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-provided-software.adoc github adoc]] +} + + +package "android" { + +class AndroidDoctorCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidDoctorCommand.kt]] #lightblue { + doctor + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidDoctorCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-android-doctor.adoc github adoc]] +} +class AndroidLocalesCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidLocalesCommand.kt]] { + locales + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidLocalesCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-android-locales.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test/android/locales gcloud equivalent]] +} +class AndroidModelsCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidModelsCommand.kt]] { + models + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidModelsCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-android-models.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test/android/models gcloud equivalent]] +} +class AndroidOrientationsCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidOrientationsCommand.kt]] { + screen-orientations + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidOrientationsCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-android-orientations.adoc github adoc]] +} +class AndroidRunCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidRunCommand.kt]] #lightblue { + run + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidRunCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-android-run.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test/android/run gcloud equivalent]] +} +class AndroidTestEnvironmentCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidTestEnvironmentCommand.kt]] #lightblue { + test-environment + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidTestEnvironmentCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-android-test-environment.adoc github adoc]] +} +class AndroidVersionsCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidVersionsCommand.kt]] { + versions + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidVersionsCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-android-versions.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test/android/versions gcloud equivalent]] +} + +package "android.locales" { +class AndroidLocalesListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesListCommand.kt]] #lightblue { + list + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesListCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-android-localeslist.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test/android/locales/list gcloud equivalent]] +} +class AndroidLocalesDescribeCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesDescribeCommand.kt]] #lightblue { + describe + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesDescribeCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-android-locales-describe.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test/android/locales/describe gcloud equivalent]] +} +} + +package "android.models" { +class AndroidModelsListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelsListCommand.kt]] #lightblue { + list + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelsListCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test_android-models-list.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test/android/models/list gcloud equivalent]] +} +class AndroidModelDescribeCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelDescribeCommand.kt]] #lightblue { + describe + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/models/AndroidModelDescribeCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-android-models-describe.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test/android/models/describe gcloud equivalent]] +} +} + +package "android.orientations" { +class AndroidOrientationsListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/orientations/AndroidOrientationsListCommand.kt]] #lightblue { + list + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/orientations/AndroidOrientationsListCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-android-orientations-list.adoc github adoc]] +} +} + +package "android.versions" { +class AndroidVersionsListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsListCommand.kt]] #lightblue { + list + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsListCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-android-versions-list.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test/android/versions/list gcloud equivalent]] +} +class AndroidVersionsDescribeCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsDescribeCommand.kt]] #lightblue { + describe + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/versions/AndroidVersionsDescribeCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-android-versions-describe.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test/android/versions/describe gcloud equivalent]] +} +} +} + + +package "ios" { + +class IosDoctorCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosDoctorCommand.kt]] #lightblue { + doctor + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosDoctorCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-ios-doctor.adoc github adoc]] +} +class IosOrientationsCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosOrientationsCommand.kt]] { + screen-orientations + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosOrientationsCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-ios-orientations.adoc github adoc]] +} +class IosLocalesCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosLocalesCommand.kt]] { + locales + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosLocalesCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-ios-locales.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test/ios gcloud equivalent]] +} +class IosRunCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosRunCommand.kt]] #lightblue { + run + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosRunCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-ios-run.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test/ios gcloud equivalent]] +} +class IosModelsCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosModelsCommand.kt]] { + models + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosModelsCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-ios-models.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test/ios gcloud equivalent]] +} +class IosTestEnvironmentCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosTestEnvironmentCommand.kt]] #lightblue { + test-environment + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosTestEnvironmentCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-ios-test-environment.adoc github adoc]] +} +class IosVersionsCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosVersionsCommand.kt]] { + versions + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosVersionsCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-ios-versions.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test/ios gcloud equivalent]] +} + +package "ios.locales" { +class IosLocalesListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesListCommand.kt]] #lightblue { + list + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesListCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-ios-locales-list.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test/ios/locales/list gcloud equivalent]] +} +class IosLocalesDescribeCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesDescribeCommand.kt]] #lightblue { + describe + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/configuration/IosLocalesDescribeCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-ios-locales-describe.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test/ios/locales/describe gcloud equivalent]] +} +} + +package "ios.models" { +class IosModelsListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelsListCommand.kt]] #lightblue { + list + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelsListCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-ios-models-list.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test/ios/models/list gcloud equivalent]] +} +class IosModelDescribeCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelDescribeCommand.kt]] #lightblue { + describe + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/models/IosModelDescribeCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-ios-model-describe.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test/ios/models/describe gcloud equivalent]] +} +} + +package "ios.orientations" { +class IosOrientationsListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/orientations/IosOrientationsListCommand.kt]] #lightblue { + list + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/orientations/IosOrientationsListCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-ios-orientations-list.adoc github adoc]] +} +} + +package "ios.versions" { +class IosVersionsListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsListCommand.kt]] #lightblue { + list + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsListCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-ios-versions-list.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test/ios/versions/list gcloud equivalent]] +} +class IosVersionsDescribeCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsDescribeCommand.kt]] #lightblue { + describe + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/versions/IosVersionsDescribeCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-ios-versions-describe.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test/ios/versions/describe gcloud equivalent]] +} +} + +} + +package "ipblocks" { +class IPBlocksListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/ipblocks/IPBlocksListCommand.kt]] #lightblue { + list + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/ipblocks/IPBlocksListCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-ip-blocks-list.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test/ip-blocks/list gcloud equivalent]] +} +} + +package "networkprofiles" { +class NetworkProfilesDescribeCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesDescribeCommand.kt]] #lightblue { + describe + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesDescribeCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-network-profiles-describe.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test/network-profiles/describe gcloud equivalent]] +} +class NetworkProfilesListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesListCommand.kt]] #lightblue { + list + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/networkprofiles/NetworkProfilesListCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-network-profiles-list.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test/network-profiles/list gcloud equivalent]] +} +} + +package "providedsoftware" { +class ProvidedSoftwareListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/providedsoftware/ProvidedSoftwareListCommand.kt]] #lightblue { + list + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/providedsoftware/ProvidedSoftwareListCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-provided-software-list.adoc github adoc]] +} +} +} +} +} +} + +MainCommand --> FirebaseCommand +MainCommand --> AuthCommand + +'MainCommand --> RefreshCommand +'MainCommand --> CancelCommand +'MainCommand --> ProvidedSoftwareCommand +'MainCommand --> NetworkProfilesCommand +'MainCommand --> IPBlocksCommand +'MainCommand --> IosCommand +'MainCommand --> AndroidCommand + +AuthCommand --> LoginCommand + +IPBlocksCommand --> IPBlocksListCommand + +IosCommand --> IosRunCommand +IosCommand --> IosDoctorCommand +IosCommand --> IosModelsCommand +IosCommand --> IosVersionsCommand +IosCommand --> IosLocalesCommand +IosCommand --> IosOrientationsCommand +IosCommand --> IosTestEnvironmentCommand + +IosModelsCommand --> IosModelsListCommand +IosModelsCommand --> IosModelDescribeCommand + +IosVersionsCommand --> IosVersionsListCommand +IosVersionsCommand --> IosVersionsDescribeCommand + +IosLocalesCommand --> IosLocalesListCommand +IosLocalesCommand --> IosLocalesDescribeCommand + +IosOrientationsCommand --> IosOrientationsListCommand + +AndroidCommand --> AndroidRunCommand +AndroidCommand --> AndroidDoctorCommand +AndroidCommand --> AndroidModelsCommand +AndroidCommand --> AndroidVersionsCommand +AndroidCommand --> AndroidLocalesCommand +AndroidCommand --> AndroidOrientationsCommand +AndroidCommand --> AndroidTestEnvironmentCommand + +AndroidModelsCommand --> AndroidModelsListCommand +AndroidModelsCommand --> AndroidModelDescribeCommand + +AndroidVersionsCommand --> AndroidVersionsListCommand +AndroidVersionsCommand --> AndroidVersionsDescribeCommand + +AndroidLocalesCommand --> AndroidLocalesListCommand +AndroidLocalesCommand --> AndroidLocalesDescribeCommand + +AndroidOrientationsCommand --> AndroidOrientationsListCommand + +FirebaseCommand --> TestCommand +FirebaseCommand --> RefreshCommand +FirebaseCommand --> CancelCommand + +TestCommand --> AndroidCommand +TestCommand --> IosCommand +TestCommand --> NetworkProfilesCommand +TestCommand --> ProvidedSoftwareCommand +TestCommand --> IPBlocksCommand + +NetworkProfilesCommand --> NetworkProfilesDescribeCommand +NetworkProfilesCommand --> NetworkProfilesListCommand + +ProvidedSoftwareCommand --> ProvidedSoftwareListCommand +@enduml diff --git a/docs/hld/presentation/cli/readme.md b/docs/hld/presentation/cli/readme.md new file mode 100644 index 0000000000..a12e6a1831 --- /dev/null +++ b/docs/hld/presentation/cli/readme.md @@ -0,0 +1,41 @@ +# CLI + +Flank command line interface layer. + +## Basics +From the: +* higher level of view is a bridge between end user and business logic. +* implementation perspective it's just wrapper for the domain function. + +## Package + +[`ftl.cli`](https://github.com/Flank/flank/tree/master/test_runner/src/main/kotlin/ftl/cli) and nested. + +## Libraries + +Flank command line interface is build upon the [picocli](https://picocli.info/). + +## Design + +The commands design is based on [gcloud firebase](https://cloud.google.com/sdk/gcloud/reference/alpha/firebase), also the +goal is to keep flanks CLI compatible with gcloud. + +## Responsibilities + +The class which represents the CLI command: + +* MUST + * specify name + * run dedicated domain function or + * display help if only groups subcommands +* SHOULD + * specify information required for help / manual / documentation +* CAN + * specify subcommands + * specify options and flags +* CAN'T + * define logical operations + +## Class diagram + +![cli_class_diagram](http://www.plantuml.com/plantuml/proxy?cache=no&fmt=svg&src=https://raw.githubusercontent.com/Flank/flank/1493-add-cli-class-diagram/docs/hld/cli/cli-class-diagram.puml) \ No newline at end of file From 8a71381e51e3cbec98ae768d1dd6b8fd2923b9c7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Janek=20G=C3=B3ral?= Date: Fri, 19 Mar 2021 03:04:12 +0100 Subject: [PATCH 08/11] update cli readme.md --- docs/hld/presentation/cli/readme.md | 43 ++++++++++++++++++++++------- 1 file changed, 33 insertions(+), 10 deletions(-) diff --git a/docs/hld/presentation/cli/readme.md b/docs/hld/presentation/cli/readme.md index a12e6a1831..653be4834b 100644 --- a/docs/hld/presentation/cli/readme.md +++ b/docs/hld/presentation/cli/readme.md @@ -1,11 +1,13 @@ # CLI -Flank command line interface layer. +Flank command line interface layer. ## Basics + From the: -* higher level of view is a bridge between end user and business logic. -* implementation perspective it's just wrapper for the domain function. + +* higher level of view CLI layer is a bridge between end user and business logic. +* implementation perspective it is just adapter for domain function call. ## Package @@ -17,17 +19,18 @@ Flank command line interface is build upon the [picocli](https://picocli.info/). ## Design -The commands design is based on [gcloud firebase](https://cloud.google.com/sdk/gcloud/reference/alpha/firebase), also the -goal is to keep flanks CLI compatible with gcloud. +The commands design is based on [gcloud firebase](https://cloud.google.com/sdk/gcloud/reference/alpha/firebase), also +the goal is to keep flanks CLI compatible with gcloud. ## Responsibilities The class which represents the CLI command: * MUST - * specify name - * run dedicated domain function or - * display help if only groups subcommands + * specify command name + * override run method for + * running dedicated domain function or + * displaying help if only groups subcommands * SHOULD * specify information required for help / manual / documentation * CAN @@ -35,7 +38,27 @@ The class which represents the CLI command: * specify options and flags * CAN'T * define logical operations - + ## Class diagram -![cli_class_diagram](http://www.plantuml.com/plantuml/proxy?cache=no&fmt=svg&src=https://raw.githubusercontent.com/Flank/flank/1493-add-cli-class-diagram/docs/hld/cli/cli-class-diagram.puml) \ No newline at end of file +![cli_class_diagram](http://www.plantuml.com/plantuml/proxy?cache=no&fmt=svg&src=https://raw.githubusercontent.com/Flank/flank/1493-add-cli-class-diagram/docs/hld/presentation/cli/cli-class-diagram.puml) + +## Shortcuts + +Flank also specifies shortcuts to some commands. +Those relations are not shown on the diagram, because are producing a more complicated graph. +Down below, you can read the list of commands that are missing on the diagram. + +| Class | Command | +|:-------:|:-------:| +| RefreshCommand | `refresh`| +| CancelCommand | `cancel`| +| ProvidedSoftwareCommand | `provided-software`| +| NetworkProfilesCommand | `network-profiles`| +| IPBlocksCommand | `ip-blocks`| +| IosCommand | `ios`| +| AndroidCommand | `android`| + +Be aware that +* for preceding commands you can omit the `firebase test` prefix, just call the command name. +* shortcuts are working also with subcommands chaining. From 48d36796dae3a6c7e4d7f1b9016a3c46093d4db7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Janek=20G=C3=B3ral?= Date: Fri, 19 Mar 2021 03:40:16 +0100 Subject: [PATCH 09/11] update cli readme.md --- .../presentation/cli/cli-class-diagram.puml | 2 +- docs/hld/presentation/cli/readme.md | 27 ++++++++++++------- 2 files changed, 19 insertions(+), 10 deletions(-) diff --git a/docs/hld/presentation/cli/cli-class-diagram.puml b/docs/hld/presentation/cli/cli-class-diagram.puml index 4b50fa6a09..8d27071e60 100644 --- a/docs/hld/presentation/cli/cli-class-diagram.puml +++ b/docs/hld/presentation/cli/cli-class-diagram.puml @@ -134,7 +134,7 @@ package "android.locales" { class AndroidLocalesListCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesListCommand.kt]] #lightblue { list [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesListCommand.kt local link]] - [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-android-localeslist.adoc github adoc]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test-android-locales-list.adoc github adoc]] [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test/android/locales/list gcloud equivalent]] } class AndroidLocalesDescribeCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/configuration/AndroidLocalesDescribeCommand.kt]] #lightblue { diff --git a/docs/hld/presentation/cli/readme.md b/docs/hld/presentation/cli/readme.md index 653be4834b..2f60c2a5e0 100644 --- a/docs/hld/presentation/cli/readme.md +++ b/docs/hld/presentation/cli/readme.md @@ -19,8 +19,8 @@ Flank command line interface is build upon the [picocli](https://picocli.info/). ## Design -The commands design is based on [gcloud firebase](https://cloud.google.com/sdk/gcloud/reference/alpha/firebase), also -the goal is to keep flanks CLI compatible with gcloud. +* The commands design is based on [gcloud firebase](https://cloud.google.com/sdk/gcloud/reference/alpha/firebase), +* The goal is to keep flanks CLI compatible with gcloud. ## Responsibilities @@ -39,15 +39,22 @@ The class which represents the CLI command: * CAN'T * define logical operations -## Class diagram +## Class & relations diagram ![cli_class_diagram](http://www.plantuml.com/plantuml/proxy?cache=no&fmt=svg&src=https://raw.githubusercontent.com/Flank/flank/1493-add-cli-class-diagram/docs/hld/presentation/cli/cli-class-diagram.puml) +### Notes + +* Click on the class name will navigate to `kt` source file on github. +* Click on the `local link` is compatible with intellij PlantUML plugin. +* Click on `github adoc` will navigate to command documentation on github. +* Click on `gcloud equivalent` will navigate to documentation page of gcloud command equivalent. +* Classes that are calling domain functions by overridden `run` are marked with `#lightblue` background. + ## Shortcuts -Flank also specifies shortcuts to some commands. -Those relations are not shown on the diagram, because are producing a more complicated graph. -Down below, you can read the list of commands that are missing on the diagram. +Flank also specifies shortcuts to some commands. Those relations are not shown on the diagram, because are producing a +more complicated graph. Down below, you can read the list of commands that are missing on the diagram. | Class | Command | |:-------:|:-------:| @@ -59,6 +66,8 @@ Down below, you can read the list of commands that are missing on the diagram. | IosCommand | `ios`| | AndroidCommand | `android`| -Be aware that -* for preceding commands you can omit the `firebase test` prefix, just call the command name. -* shortcuts are working also with subcommands chaining. +### Notes + +* For preceding commands you can omit the `firebase test` prefix, just type the command name as first argument + like `$ flank.jar refresh`. +* Shortcuts are working also with subcommands chaining like `$ flank.jar ip-blocks list` From 32f1bc693df2f5fccaed38cdd69dca8e78a18f20 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Janek=20G=C3=B3ral?= Date: Fri, 19 Mar 2021 12:26:21 +0100 Subject: [PATCH 10/11] Update readme.md --- docs/hld/presentation/cli/readme.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/hld/presentation/cli/readme.md b/docs/hld/presentation/cli/readme.md index 2f60c2a5e0..af127affc7 100644 --- a/docs/hld/presentation/cli/readme.md +++ b/docs/hld/presentation/cli/readme.md @@ -11,7 +11,7 @@ From the: ## Package -[`ftl.cli`](https://github.com/Flank/flank/tree/master/test_runner/src/main/kotlin/ftl/cli) and nested. +All CLI commands are placed in [`ftl.cli`](https://github.com/Flank/flank/tree/master/test_runner/src/main/kotlin/ftl/cli) or inside nested packages. ## Libraries @@ -20,7 +20,7 @@ Flank command line interface is build upon the [picocli](https://picocli.info/). ## Design * The commands design is based on [gcloud firebase](https://cloud.google.com/sdk/gcloud/reference/alpha/firebase), -* The goal is to keep flanks CLI compatible with gcloud. +* The goal is to have implemented equivalent for each gcloud command in firebase scope, so Flank will keep CLI parity with gcloud. ## Responsibilities From 825da61e6ce76bfb51623f3dfa4888ddd2167d9b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Janek=20G=C3=B3ral?= Date: Tue, 23 Mar 2021 08:32:33 +0100 Subject: [PATCH 11/11] Separate main function from MainCommand --- .../presentation/cli/cli-class-diagram.puml | 31 ++++++++++++------- 1 file changed, 19 insertions(+), 12 deletions(-) diff --git a/docs/hld/presentation/cli/cli-class-diagram.puml b/docs/hld/presentation/cli/cli-class-diagram.puml index 8d27071e60..f14d040481 100644 --- a/docs/hld/presentation/cli/cli-class-diagram.puml +++ b/docs/hld/presentation/cli/cli-class-diagram.puml @@ -5,15 +5,18 @@ left to right direction package "ftl" { -class MainCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/Main.kt]] { - flank.jar +object main [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/Main.kt]] { [[../../../../test_runner/src/main/kotlin/ftl/Main.kt local link]] - [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_.adoc github adoc]] - [[]] } package "cli" { +class MainCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/MainCommand.kt]] { + flank.jar + [[../../../../test_runner/src/main/kotlin/ftl/cli/MainCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_.adoc github adoc]] +} + class AuthCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/AuthCommand.kt]] { auth [[../../../../test_runner/src/main/kotlin/ftl/cli/AuthCommand.kt local link]] @@ -38,6 +41,13 @@ class FirebaseCommand [[https://github.com/Flank/flank/blob/master/test_runner/s package "firebase" { +class TestCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/TestCommand.kt]] { + test + [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/TestCommand.kt local link]] + [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test.adoc github adoc]] + [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test gcloud equivalent]] +} + class RefreshCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/RefreshCommand.kt]] #lightblue { refresh [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/RefreshCommand.kt local link]] @@ -48,12 +58,6 @@ class CancelCommand [[https://github.com/Flank/flank/blob/master/test_runner/src [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/CancelCommand.kt local link]] [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-cancel.adoc github adoc]] } -class TestCommand [[https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/TestCommand.kt]] { - test - [[../../../../test_runner/src/main/kotlin/ftl/cli/firebase/TestCommand.kt local link]] - [[https://github.com/Flank/flank/blob/master/docs/ascii/flank.jar_-firebase-test.adoc github adoc]] - [[https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test gcloud equivalent]] -} package "test" { @@ -318,8 +322,12 @@ class ProvidedSoftwareListCommand [[https://github.com/Flank/flank/blob/master/t } } -MainCommand --> FirebaseCommand +main --> MainCommand + MainCommand --> AuthCommand +AuthCommand --> LoginCommand + +MainCommand --> FirebaseCommand 'MainCommand --> RefreshCommand 'MainCommand --> CancelCommand @@ -329,7 +337,6 @@ MainCommand --> AuthCommand 'MainCommand --> IosCommand 'MainCommand --> AndroidCommand -AuthCommand --> LoginCommand IPBlocksCommand --> IPBlocksListCommand