From 119aeb49ca3810cf095590fd65fdfc74a6efc27e Mon Sep 17 00:00:00 2001 From: Pa1NarK <69745008+pixincreate@users.noreply.github.com> Date: Mon, 4 Sep 2023 13:03:39 +0530 Subject: [PATCH] docs(postman): Update documentation for postman tests (#2057) --- .github/secrets/connector_auth.toml.gpg | Bin 3194 -> 3190 bytes crates/test_utils/README.md | 48 +++++++++++++++++++++--- crates/test_utils/src/main.rs | 7 ++++ 3 files changed, 49 insertions(+), 6 deletions(-) diff --git a/.github/secrets/connector_auth.toml.gpg b/.github/secrets/connector_auth.toml.gpg index c8987ccabbec90f082085ffdbf1ed533a5884106..85a17bcb931c1bde2cfba629d4cccf073e272dc7 100644 GIT binary patch literal 3190 zcmV-+42koM4Fm@R0xe25@O)sI`u5W60n*xn?@0zLq1MDOcOe*~ZlB8`4{zZGc>d2SWq}0ltDroO{J>WeA0Q2oy2mQo!i) zm)~DpDfFg~$`Z`(7e=eU8b)EMH#9E*{i4!%LQX?A3ik>#xQg}tJV1;^iDSK`19D?; z?@&=lTp0h4nUJTz02)9bqp8mB?062Z{ zDCjYQID{jL86b68A{GA#Ve%h@ByEQ0ph-3B5@uHHm%G=-GL0tGfJSH#I$^luF?uON zu2&!^a)u=1MbURWz(M2^6~dl8o;XV+O3LJUjpl|jF;H2|V`So%vI4l;t@_->-F6^3 zMB^;WXy4$cy1UtY$R4VVJ&8BegfeH>pIa6YoA}5Ykrnjpcs_oO;TmXKGP*m#6QQdx z+MV4pjf%YXH`rQ6K+)sqxp};m$uGa9OwN@7vE6Ct8bQuK?uL*Jta0MB?fJP&hWe4@ zv9U5+EKe+x!RmBi7xr7(8oi1dbi^U$o0AC>->iVo{me+FC&p1Yr|l^o8an`w9qro+ zq;Vo30#yhwh0lIZ-xNF<#i79$`|z%WbI%X<<0Ee_(J=FM3a^yQ#%9v|AE*(q8`VC^ z$EruHL{6df-k8)BZYOO6De7~5+Fv5D(w+sk21W7&b?%ib463LcT{mmaImko&X*L68 zIsd$!6+C;a{X|pw=@>qd#d>^$COBbz=>$8VkiNf4uB>fcz%n5ppnWOx46lK-+Bi>L z1%Ea>%p2{?fT&$~3OF@bii}vfc;e@Cqx}EazJ9^X5+#2y>Oq{LrD{`DFFJL-c6rr|s=6PtSnwRmYC4%_R3L%jd@473VXq{`$* zg0}}d&B>c_htQlNelfB-0;m_DbMIzOUG8c z7-1lHbZQo|&s|H4tulk`Dt8B7+BA~6&FWI`=E{1+2*@ClRc+eu=>?g{Wz)(4ylUEh z#zhIvGf5vj1TdWFOE?#gQO*Jt;<0BoG5>TIDJM&OV%8yph@Tfz2vTU?L8pDJ(H)uz z+=*Ehw8HHhEVs83=HyHOgVD}g@rd+!{i$}SgDtbLqkN*!OR^w8`>AL_^yWlw!|hh5 zYK6_ZMXX!~!lf8MkfxQq5Bi!jbu5$S~5(RGZBkNWhs7o#JA8qLW zT@~hLeAGu*>P>(Q#26O%2@^yp2+P`mK@dd7j5Rd-yHhi(l<+S&);2UJqr}Kkts6(R zM1MBG*RGt6mf%zIGYZD*qUUgh9-U@~+%sN*a8-DK-a>t60rBL*C~?@cM251S+_i3D zJz->ajx9q6a)pGySM3Z$wK&q5m{etR9E4RkGD7>#TO85#>%!(>*afdp=M{pri|4KN z2fD2P=sZK!tQer|l&}i`X4DoJt|4e+lX##4#Hf0zPDaP}hUAo>ShecY5rdM}?==o7 zp#ym)j}4)`zpipVCv-?0xlB@bZ8FX`aBe8mlw?4|&c?nF-WKhH7>go28tQqWLeF;Acy$RaW?^v!0K9U>Z zMK~l`d>u^+k=)_t)-WF4WFQN^MzZC)J!4hGgJmOP*?!O2*H|!l&nbbsS+hxc%L}q$k zV0NQpq!88}1>@0A6`a$OW;??#!#dYP5lx&n2sFXcFF|9=7VN9O>Nc`JOS1#l4VJ6} zeMUrG6gRHL#zCqB_9fG#a}DLN7d|@Jrxz-k}JCM{=T1{b^HJ+8V2zrh>|< zf+q|nm=3rjRK>G#^n7y5*sKZ!Z1T6XnrC^lqSdvx8u7xSHM9ygc%_y(b-S~i7$Avq ziCJe6^{5yz_?G3Hkn6|IBtL3=iDcGU!Rx!%{vJ@D@^p1UZBz&X2D$oD|LBsM7BcaK z)@!K(3Qg(gD(xmeq>g*xY==DK$v6JwKbsiRfVvHrT`TDx*vHC)!QETgzoeI)#)i5Q z0NM)(@DJ7+PNU2anv4Wtj1yBtd2G|FQYM|Zq8aFmamHq@CmeW}-|*8I>b&cPnEEw)dLDjbx1`lO7->wge#_`*6cv&XR~FQp+#Rc$v1>tsP$ z^ht{!~YNZ|?iYyjx3NSj`6W)0J_BSM4Lpbxu-uBw`#(xmy(}ToQ zG8X5{k`mx(lAu@KY~omSXiD4LrDwetkQ*NHZ3Rt;b8^_#EG ztNmb^!rrQS)B6W2!)V4)#AU`uiTt912!92=97 z7L8oyC#uHp8Fy-GZ!0!-&}_*Tez@-uziFpf`w*A z!KZvZ^Pjm^%ee=M*!KP21MN*3^0I972WKl=;tW(Yuw3KXVt_=K^Ju5vbU069Hn&cW z)1}GHvS=X3zOBQ6UTS#eR8G5W21Q)&AjnrlCJ;;yLf_76@Q9YRWbo}M(!xDX7dr?G z%5e{)%oC%*it27DmnVUMpNmDEz=3l!Y~n>yrSC13#SI0nY9wYAHBgA3;0tvgn2dPg zh4`w*$uY7!YRob?z>N0#e1};>qG_~E(D1?*oV;j4T2%W9zQyrlE4N9PuXt4Uy!Lu% zNsK|W|DMOFBwy~iIH9_C_K;N$06Vp8a|5yTq-mAW$(%|HOB1MRs9K2MqGuGr;Ox#H$%aOLg@M-@80v5m-M1A^+joRaPGJd!)KbD{;ZwIPr3>T7TIsN&``1i&4&-jd03X{$ z=WVw?4Diyi?4f;VXiw}qpF__pQ`pt)igU+mta_}0co;?|52kfUidz1LZ#&6@9Fn*L zLjFAgZ|UlGn}>cAeHwKWEkP2+&u#}b`NM|#$zuoD@iAqUJbxBs1|Sw!B$GF(l(*_e zXWhAD`q#k*eCANfpUcB=QhOza`!XHSDaRYD%nIUX-1=u*%3q@lrAJFz01u5S1AcD} c`9yU0y@U&J%aHovog6y{ir-kwFTN5Qe+k+y_5c6? literal 3194 zcmV-=42AQI4Fm@R0tkYC$S~X2X7ZGt~7?X#TQ$M5P_7o1icgmCuHneBu$FpaW@+;x$*@r`$Yd z7PJ+}qvIt3Anqf=fce});rt4%R2tD4YL@n#4=Lnh95_3H|7hlF*viFI%eDS{3zC>hbk=5V%-P@r0Ubq zzpLuk#BC|0F~1&NI0tA_Om`?Jk7etibJ`N_7%ScA7kX~|)=5A$v?XC0I}*Uw@-0Dj zHF)-)gpOe&U!t+S%&4megqkK>?22pwe9aAcb$mnIK0nggh#6IttDQ0^w;KMKp`SbFT#ns-O`5B>`V3I0+~BuGK8=r<>tBLDVe?V`(9p?8~h*yM)Njs#})nWAB`j zF87z*vW?7Z5@|zl$Mn}ZE(5D)fRp(gpm4khJ zd6r;LfARbG=$jPcLty456?pD$@&8XQ`oG<>``3Yv{SDmju&2;P_%13!Erw<9?TP)j zO~Kzn=n65iImP}E*jDYh5i(RHZL+o!yJGA+!_V$jK-OZ~Czuyz;<@8+-K|Ie6Zq&KT_m%c$FglP9FqzN(tGu5A2IVr- zmAM!0583_SGD%->8M#VDHiH{R;YbyhK|&$Rwiin_iTysf|$FV9%R;uPSJf zpWE_;a!W0QjIC|Erhj7D>cH#$BT%0l%A#B#M8-HVY87R-BFCjxugcSA&)aHHo&oD}EwhZ?4%H3Q zq_bNV^J!U--j`^?2qvbqh%Sln_8=vj0KEP(V)YOrhM@8-820Ex&hT*UtNx2V%_IdD zNd_==3~8FJfB=g)4FJd(J=;R%zCR9;CeZ~2jRRywntsM2BsaZkVB;fC+M>!l#46Nd zaa8SfxRDa(xW!uBS*uWdc1JTKdR#&VUqE8Z+>KtcLdEf{2cT<5B|eHYESeHvGKnGQ zcTisjB(Hr!Oq3W$ab>P~&gBg$Zbtx7mxyYt7E6W)6aPiuzMoDHc+9c_Iyy8mvDFM7 z4LNMSw=r3!snGl1Nq7R8YELCfbDYYiN_Cp2hu|8WwVbfvFMfhIPB~xF26)o)|Az3W z6X1Gmr0j)wes@^ zR!LwI3AH)$={XU75)(}=7*Ji8G5Sw&{n~a-Z)C7>?UI^Opp6+7{a;xagad3I8@dDP zIja?Qd3)Zh5cQu)3MyFDk1oLO97at>YXQ?V$?IEp``1?TO(_B+vK(vV#>D$W9 z-1rdq-_0PpXe)E)!FA}+CrBV!w=fPo6-?6d6IVzGhN33ZUoT-cX=clZn*5YtW(x06 zpzt5p2^(mv5j9L#WoK4o2Y5|$e#P(a5w#~2CHiRJbjxFAZtN%X-7#ZTG_vG~nV0#d z8v@Hl;(Kw`Jw#rA&~b*4hE3>{Id%0c7;U&7>^3BDm;8GWg#2%P_3_MulyI&UQVO4q-Wg?DxOdU+lgBs2MBrNK{!ft0z$A;^)|RV+l`QWoN>&K!;jJz;EK zFf3}x0>OegeObyzu`!p-TxP0f202iIxfhImvgxV{duUYMr?97*49skJGtP4v=pjFA zNyZ9clsnX-3l;+gVI`eL#x@pO;niA-Pc?A9@MX~qyFnp%wcDT-+%2(!Fn9l>V~FOQ--3j z+Aj`TSve?rrO}8BK$@capsm1n+a0((JF`(?*_mJr5n_(9%~7Dv)%Z@rX7P6o2Pw1r z*oPc@oA30Kf}XGmBtF7lWd1hI?%?*Xpl;?ii@W2IWo)Y%bECI&_^WAI&wxIQ&%;kG z6T5mVxb@R|^L{|Rs4z!nG(=I(OIYu>;cTOau90%*y^z^}C0*N52Hjp^P<`Iij%(+Z zMEx6I;M%c*z#YpdV)VuUMdZ zZ>TqYhE*AEz&kZpik9MwdHW2q_E=!X+&q;ta7GMEWabaB4I41+9#P!P<~%d9hN}1q zH#$Oy?YBD5Y2MD102@|UxtU^frCrENyhL=~hg#q)c)XNE{qoO@@Ye9c8hs2j#Jt1e z9)l!ERM0Q?4?v~vV}3_Hz2|}f68<_$u)Hcp~*#Vbg> zq;AGfK$6(cOn$V^MI4}>w*Dei8vm~)(%Uqe+%*Q41)k7{*~9Iv`{O_?H?vp-RTrQ8 zIqz>?SkSw9s!V9Js45OduwtqxO?v9t^r>K8D_1Cr$*@(q$Z*mEER`5iR>eAqa%}g2 zjO0d}A2UvapF2LA(*fk>q5AxHWF>*gLv_pLb^UI2v&)=I9tGPjDS~0L{Gsv<`{0ZL zbZPT8OPt4Eh`N0E*J9SuFGILj(2^~3NF(|vZM+fUI}gORw@^vby@7LY!IblugyGA z?ND(XO0RlZlL%f?MQR_AmFghx4gMyftgzj5M5^rfBAKfmwMxo2MA`-5?MrJCIHUdq z{054?hH6se)TphK$V6?@8rzR)=|jPA+tojwwmj*x<34JP$_gm5j=J@e@yH(hte*Y4 ze8$M%*Izm?ppQYqonUk232tMDO($s&N(M+a>gKka8skc$xFe5I-CrI>BlUfPKG$Jp ztz?--UHY2LGLI92p@Yqve!ur|pCdK{%e?YMi~WwzXd>@qJHHDt$|)x`2Q*bk>hn-c zc5Si!rilWQ-A93?ciA5sMy3jt+Ta%$k-^(7T7kyS$b65-QBc;SswvH6)fnwEnNG_=%Tva{fiGVbangbB}LRiIxuxp@J*b?## g!dRX#*x(lKVd6gy2#ScS7sUe(.postman_collection.json` +- Make sure you that you've _**do not**_ have the official newman installed but rather the `newman` fork with directory support + - `newman` can be installed by running `npm install -g 'https://github.com/knutties/newman.git#feature/newman-dir'` + - To see the features that the fork of `newman` supports, click [_**here**_](https://github.com/knutties/newman/blob/feature/newman-dir/DIR_COMMANDS.md) - Add the connector credentials to the `connector_auth.toml` / `auth.toml` -- In terminal, execute: - ```zsh +- Export the auth file path as an environment variable: + ```shell export CONNECTOR_AUTH_FILE_PATH=/path/to/auth.toml + ``` +- Run the tests: + ```shell cargo run --package test_utils --bin test_utils -- --connector_name= --base_url= --admin_api_key= ``` + +**Note:** You can optionally pass `--verbose` to see the logs of the tests. But make sure you that passing `--verbose` will also print the API-Keys in the logs. So, make sure you don't push the logs to any public repository. Below is an example: +```shell +cargo run --package test_utils --bin test_utils -- --connector_name= --base_url= --admin_api_key= --verbose +``` + +### Running newman locally + +Execute the following commands: +```shell +export CONNECTOR_AUTH_FILE_PATH=/path/to/auth.toml +cargo run --package test_utils --bin test_utils -- --connector_name= --base_url=http://127.0.0.1:8080 --admin_api_key=test_admin +# Optionally, you can add `--verbose` in the end +``` +## UI tests + +To run the UI tests, run the following command: +```shell +cargo test --package test_utils --test connectors -- :: --test-threads=1 +``` +### Example + +Below is an example to run UI test to only run the `GooglePay` payment test for `adyen` connector: +```shell +cargo test --package test_utils --test connectors -- adyen_uk_ui::should_make_gpay_payment_test --test-threads=1 +``` + +Below is an example to run all the UI tests for `adyen` connector: +```shell +cargo test --package test_utils --test connectors -- adyen_uk_ui:: --test-threads=1 +``` \ No newline at end of file diff --git a/crates/test_utils/src/main.rs b/crates/test_utils/src/main.rs index 87e3a13847..155870ee2c 100644 --- a/crates/test_utils/src/main.rs +++ b/crates/test_utils/src/main.rs @@ -26,6 +26,9 @@ struct Args { /// Admin API Key of the environment #[arg(short, long = "admin_api_key")] admin_api_key: String, + /// Optional Verbose logs + #[arg(short, long)] + verbose: bool, } fn main() { @@ -130,6 +133,10 @@ fn main() { newman_command.arg("--color").arg("on"); + if args.verbose { + newman_command.arg("--verbose"); + } + // Execute the newman command let output = newman_command.spawn(); let mut child = match output {