From 6528ab56fe304d2a01dc60e7e376931bf7d1db30 Mon Sep 17 00:00:00 2001 From: piotradamczyk5 <65554637+piotradamczyk5@users.noreply.github.com> Date: Thu, 18 Mar 2021 17:45:32 +0100 Subject: [PATCH] docs: Desktop POC SDD (#1709) --- docs/desktop/flank_desktop.md | 44 ++++++++++++++++++++++++++++++++++ docs/desktop/flank_mock.png | Bin 0 -> 99001 bytes 2 files changed, 44 insertions(+) create mode 100644 docs/desktop/flank_desktop.md create mode 100644 docs/desktop/flank_mock.png diff --git a/docs/desktop/flank_desktop.md b/docs/desktop/flank_desktop.md new file mode 100644 index 0000000000..294763db60 --- /dev/null +++ b/docs/desktop/flank_desktop.md @@ -0,0 +1,44 @@ +# Flank desktop prototype + +## Prototype Flank options + +The prototype will run a simple Android test on a given apk and test the apk with options to specify some flanks flags, as well +as max tests shards. Those flags are the most popular one based on [mixpanel analytics](https://mixpanel.com/report/2288623/view/2835119/dashboards#id=879189) + +- Flags + - disable sharding + - disable results upload + - fail fast + - disable usage statistics + - auto Google login + +- Input + - Max tests shards + - apk path + - test apk path + +## Prototype design + +The mockup of the design is shown below: + +![mock](flank_mock.png) + +### Design elements + +- At the top left side there are some small buttons to toggle state of boolean options +- Below there is text field to input `maxTestsShards` +- Below there are two text fields with buttons placed at the right to open file chooser/provide a path to files +- At the very bottom of left column there is a button to start Flank test run. +- On the right side there is a big window which is responsible for displaying output + +## Setup + +Please follow [getting started guide](https://github.com/JetBrains/compose-jb/tree/master/tutorials/Getting_Started) to set up new module for a prototype. +There is also a [gradle plugin](https://github.com/JetBrains/compose-jb/tree/master/gradle-plugins) for simplifying usage of Jetbrains compose. +More info on [project page](https://github.com/JetBrains/compose-jb/). + +### Additional resources +- [IntelliJ Idea plugin](https://github.com/JetBrains/compose-jb/tree/master/examples/intelliJPlugin) +- [Tutorial](https://developer.android.com/jetpack/compose/layout) +- [Latest build](https://developer.android.com/jetpack/compose/layout) +- [Template to use without gradle](https://github.com/JetBrains/compose-jb/tree/master/templates) diff --git a/docs/desktop/flank_mock.png b/docs/desktop/flank_mock.png new file mode 100644 index 0000000000000000000000000000000000000000..5e3aa3479c8dfbed6c4646c1b1e7b3b36a03d0c0 GIT binary patch literal 99001 zcmeFZhgVbC8!j9X3yM0*P%MZQm99t^5gb9ODm{S^RBC7vLT^gZ5dj^fcM+682rYC7 zWq^?`7($PT5F|h-(%an!49@(%`xkucp0!4XaLz7oectEYCx716R5`Hk*ghBxcHqwK zKkma|`-EYzUGsZ)gHL9h+;qVYHiz4W7#M6n2lU?#SWFxb_;3g2zKRkotL4OZ@C&Pj zqJ|<2mJ_;v)pQqZ$5YKae<
?ilaadZnZ9ePLNUKccOp{AMdMY46>?oA%{rpB>qu
z<=)C++U44_qpW%V{wc>}@463U|0d+yjSY%1d?665ztf+LWS6d%*Wz*IFcsBt756^<
z{O+YRTdVGVOBuc9HFL)x#GUmFTxRC#?9$(HA8<{vv;>byjc+-m=@sEOr{d9^qk?
z2W8xUj4JH_i-ayz+Qg-;|AYR0cq)JI_HQo(+RkkMBF3c@wEat^!CqmO?cW}r{(lc`
z3giC?;-^jgKSBKeSrF68JCrB8^DKs!W@&ip0)uLD@Z>dv`H5cr?T|1M-F8NpLNF0M
zbn=?zn)lbg|8yK~2(KRLFUGv@tMDrIT
zDJcv&NiN>#=-0dG_!oXH)JKTA5!;vwj-m|C1tcbjdaN%#f`&qQKw&6~d#kJ(CEy+x
zfyI|CO}Lm% WfZBeWaZ}W4Bb&(TiqIFpGs4L-Uu_8#D0%j*5T$YP4-@AkA4fxV-zbS2tQ%?_ml
z1~O||ZUepmKH=Q!PW&3X@OzP~JMS;d`cBn3F=LjmuHJhwKA}=`=L;>ZD}k=SI3;mZ
zI^;Mdq%UK*M5LeNdEc~iB8THfkdj1ylUG%Cv|P>9M$-1u&kbi2ZpTCsEH&rd3>v#C
z)z&>MBi(-)#`^@|yH;x;*>i<#6m)O6=us+m!bd$usXF?+iSz?mK9ebLS(K~gy96hy
z5
5Hz?8=$t?Cv`~epi%Aph(Goy
z7?>W2{Ae(eM$a_4RJ0g>+#?@%(A%MK*TQv3=g?yZw-#RfK|X(7(qKoO#-L;i_}ur(
z+o`?`#J+(>&l#tT;{kgVeC`c;^tvbuzdbID`I-|E?GZ4SadyDIJC^JB3ht<3yAol$
zMra}6*%xN);Kz-;7*0Eis8NwaA6ehTcFze1-(;6STi5E%n_yy26Y?WNz%G5gIkyNQ
zOJrlUZBLp;Y$hJxJW1N{-rDizkWVsep`Tat3c)$)!n?X$pr33HozDdC!r#Z{C~q)K
zOfGK?%x=8Vs;B~j6>OP%lS}a3f$GdO?ELiUZ~*6fjaYN=N)F^iKQA83E0A*}rSCeu
zF$Z1*O8N2?oR*(hrV|Pu57iwN5Vxt}_~|{#XvSqe=+Pe;;Hz)I&q`RztFK_emhVIE7btvF&k5+Hka!n-O!)&Mz=Qa
z(#^InNgdX`!eU>dI74cbWG}+wCFDydOwD5GY`pp}u3e`^2ao=&sQ2u}B6OAYP!8)&
z(hJ-3TW#XchIXQg(pNJOJ5=bvVwHnS*AxY9FPeNDC(eaOjTOr*R`i{u1^z6sYH%ai
zMUd8D4cD`cq}`GINm9?T!ua5^i+K%nWHW5r;X$BchBSeGu;tm}E3#cbiR`*izAoME
zE7+eS9j3JN-eG}OB`uEbpkcn!uARk3Z9`q7mRV^Wm~4}?gq$MFM&t{KvUY>ATVcSXSFb{@*3##fNP5=d+78Mt&3vr
z=dg`ef@{g$r!CQzTb%-n&KH;2lG1IrGbgD2ptWSb*>a}2t35OU+IViEM`Uq23yh~#
zEA2A^Tb?!IL83*wp)VJEFEny;9+6x&1{cSf7D-iHhT~Uvqwux0YPN;_y
zX=OexYQp`o#LAmn4cX63O8Rgp@~$QceslcQ{mrnFu34icS*a3@ASLD=tz4@LbIBph
z*{Yuy&RA|ED3d6CepG=54y@vz>r`sXjr3>H-22aa_;g*>ABbZ4wHX@vEWSerbKkV~
z?U{Fjvb0)n(mh5R&3WGZD=CvxmBlro!I4i+Zf_b^g}QHjzPI;U0UKY
#GB~Jte