From 03fe7e72b68ee5970b9e09d8d83ad35797d6a37b Mon Sep 17 00:00:00 2001 From: runningcode Date: Thu, 19 Mar 2026 14:43:19 +0000 Subject: [PATCH] Deployed 15a5845 with MkDocs version: 1.4.2 --- .nojekyll | 0 404.html | 433 ++ assets/images/favicon.png | Bin 0 -> 1870 bytes assets/javascripts/bundle.51d95adb.min.js | 29 + assets/javascripts/bundle.51d95adb.min.js.map | 8 + assets/javascripts/lunr/min/lunr.ar.min.js | 1 + assets/javascripts/lunr/min/lunr.da.min.js | 18 + assets/javascripts/lunr/min/lunr.de.min.js | 18 + assets/javascripts/lunr/min/lunr.du.min.js | 18 + assets/javascripts/lunr/min/lunr.es.min.js | 18 + assets/javascripts/lunr/min/lunr.fi.min.js | 18 + assets/javascripts/lunr/min/lunr.fr.min.js | 18 + assets/javascripts/lunr/min/lunr.hi.min.js | 1 + assets/javascripts/lunr/min/lunr.hu.min.js | 18 + assets/javascripts/lunr/min/lunr.it.min.js | 18 + assets/javascripts/lunr/min/lunr.ja.min.js | 1 + assets/javascripts/lunr/min/lunr.jp.min.js | 1 + assets/javascripts/lunr/min/lunr.ko.min.js | 1 + assets/javascripts/lunr/min/lunr.multi.min.js | 1 + assets/javascripts/lunr/min/lunr.nl.min.js | 18 + assets/javascripts/lunr/min/lunr.no.min.js | 18 + assets/javascripts/lunr/min/lunr.pt.min.js | 18 + assets/javascripts/lunr/min/lunr.ro.min.js | 18 + assets/javascripts/lunr/min/lunr.ru.min.js | 18 + .../lunr/min/lunr.stemmer.support.min.js | 1 + assets/javascripts/lunr/min/lunr.sv.min.js | 18 + assets/javascripts/lunr/min/lunr.ta.min.js | 1 + assets/javascripts/lunr/min/lunr.th.min.js | 1 + assets/javascripts/lunr/min/lunr.tr.min.js | 18 + assets/javascripts/lunr/min/lunr.vi.min.js | 1 + assets/javascripts/lunr/min/lunr.zh.min.js | 1 + assets/javascripts/lunr/tinyseg.js | 206 + assets/javascripts/lunr/wordcut.js | 6708 +++++++++++++++++ .../workers/search.e5c33ebb.min.js | 42 + .../workers/search.e5c33ebb.min.js.map | 8 + assets/stylesheets/main.558e4712.min.css | 1 + assets/stylesheets/main.558e4712.min.css.map | 1 + assets/stylesheets/palette.2505c338.min.css | 1 + .../stylesheets/palette.2505c338.min.css.map | 1 + authentication/index.html | 559 ++ changelog/index.html | 1666 ++++ configuration/index.html | 2472 ++++++ faq/index.html | 571 ++ index.html | 584 ++ multi-module-testing/index.html | 706 ++ quick-start/index.html | 527 ++ recipes/index.html | 630 ++ releasing/index.html | 541 ++ results/index.html | 472 ++ search/search_index.json | 1 + sitemap.xml | 58 + sitemap.xml.gz | Bin 0 -> 302 bytes snapshots/index.html | 501 ++ 53 files changed, 17007 insertions(+) create mode 100644 .nojekyll create mode 100644 404.html create mode 100644 assets/images/favicon.png create mode 100644 assets/javascripts/bundle.51d95adb.min.js create mode 100644 assets/javascripts/bundle.51d95adb.min.js.map create mode 100644 assets/javascripts/lunr/min/lunr.ar.min.js create mode 100644 assets/javascripts/lunr/min/lunr.da.min.js create mode 100644 assets/javascripts/lunr/min/lunr.de.min.js create mode 100644 assets/javascripts/lunr/min/lunr.du.min.js create mode 100644 assets/javascripts/lunr/min/lunr.es.min.js create mode 100644 assets/javascripts/lunr/min/lunr.fi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.fr.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hu.min.js create mode 100644 assets/javascripts/lunr/min/lunr.it.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ja.min.js create mode 100644 assets/javascripts/lunr/min/lunr.jp.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ko.min.js create mode 100644 assets/javascripts/lunr/min/lunr.multi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.nl.min.js create mode 100644 assets/javascripts/lunr/min/lunr.no.min.js create mode 100644 assets/javascripts/lunr/min/lunr.pt.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ro.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ru.min.js create mode 100644 assets/javascripts/lunr/min/lunr.stemmer.support.min.js create mode 100644 assets/javascripts/lunr/min/lunr.sv.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ta.min.js create mode 100644 assets/javascripts/lunr/min/lunr.th.min.js create mode 100644 assets/javascripts/lunr/min/lunr.tr.min.js create mode 100644 assets/javascripts/lunr/min/lunr.vi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.zh.min.js create mode 100644 assets/javascripts/lunr/tinyseg.js create mode 100644 assets/javascripts/lunr/wordcut.js create mode 100644 assets/javascripts/workers/search.e5c33ebb.min.js create mode 100644 assets/javascripts/workers/search.e5c33ebb.min.js.map create mode 100644 assets/stylesheets/main.558e4712.min.css create mode 100644 assets/stylesheets/main.558e4712.min.css.map create mode 100644 assets/stylesheets/palette.2505c338.min.css create mode 100644 assets/stylesheets/palette.2505c338.min.css.map create mode 100644 authentication/index.html create mode 100644 changelog/index.html create mode 100644 configuration/index.html create mode 100644 faq/index.html create mode 100644 index.html create mode 100644 multi-module-testing/index.html create mode 100644 quick-start/index.html create mode 100644 recipes/index.html create mode 100644 releasing/index.html create mode 100644 results/index.html create mode 100644 search/search_index.json create mode 100644 sitemap.xml create mode 100644 sitemap.xml.gz create mode 100644 snapshots/index.html diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/404.html b/404.html new file mode 100644 index 00000000..915d158b --- /dev/null +++ b/404.html @@ -0,0 +1,433 @@ + + + + + + + + + + + + + + + + + + + + + + Fladle + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ +

404 - Not found

+ +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/assets/images/favicon.png b/assets/images/favicon.png new file mode 100644 index 0000000000000000000000000000000000000000..1cf13b9f9d978896599290a74f77d5dbe7d1655c GIT binary patch literal 1870 zcmV-U2eJ5xP)Gc)JR9QMau)O=X#!i9;T z37kk-upj^(fsR36MHs_+1RCI)NNu9}lD0S{B^g8PN?Ww(5|~L#Ng*g{WsqleV}|#l zz8@ri&cTzw_h33bHI+12+kK6WN$h#n5cD8OQt`5kw6p~9H3()bUQ8OS4Q4HTQ=1Ol z_JAocz`fLbT2^{`8n~UAo=#AUOf=SOq4pYkt;XbC&f#7lb$*7=$na!mWCQ`dBQsO0 zLFBSPj*N?#u5&pf2t4XjEGH|=pPQ8xh7tpx;US5Cx_Ju;!O`ya-yF`)b%TEt5>eP1ZX~}sjjA%FJF?h7cX8=b!DZl<6%Cv z*G0uvvU+vmnpLZ2paivG-(cd*y3$hCIcsZcYOGh{$&)A6*XX&kXZd3G8m)G$Zz-LV z^GF3VAW^Mdv!)4OM8EgqRiz~*Cji;uzl2uC9^=8I84vNp;ltJ|q-*uQwGp2ma6cY7 z;`%`!9UXO@fr&Ebapfs34OmS9^u6$)bJxrucutf>`dKPKT%%*d3XlFVKunp9 zasduxjrjs>f8V=D|J=XNZp;_Zy^WgQ$9WDjgY=z@stwiEBm9u5*|34&1Na8BMjjgf3+SHcr`5~>oz1Y?SW^=K z^bTyO6>Gar#P_W2gEMwq)ot3; zREHn~U&Dp0l6YT0&k-wLwYjb?5zGK`W6S2v+K>AM(95m2C20L|3m~rN8dprPr@t)5lsk9Hu*W z?pS990s;Ez=+Rj{x7p``4>+c0G5^pYnB1^!TL=(?HLHZ+HicG{~4F1d^5Awl_2!1jICM-!9eoLhbbT^;yHcefyTAaqRcY zmuctDopPT!%k+}x%lZRKnzykr2}}XfG_ne?nRQO~?%hkzo;@RN{P6o`&mMUWBYMTe z6i8ChtjX&gXl`nvrU>jah)2iNM%JdjqoaeaU%yVn!^70x-flljp6Q5tK}5}&X8&&G zX3fpb3E(!rH=zVI_9Gjl45w@{(ITqngWFe7@9{mX;tO25Z_8 zQHEpI+FkTU#4xu>RkN>b3Tnc3UpWzPXWm#o55GKF09j^Mh~)K7{QqbO_~(@CVq! zS<8954|P8mXN2MRs86xZ&Q4EfM@JB94b=(YGuk)s&^jiSF=t3*oNK3`rD{H`yQ?d; ztE=laAUoZx5?RC8*WKOj`%LXEkgDd>&^Q4M^z`%u0rg-It=hLCVsq!Z%^6eB-OvOT zFZ28TN&cRmgU}Elrnk43)!>Z1FCPL2K$7}gwzIc48NX}#!A1BpJP?#v5wkNprhV** z?Cpalt1oH&{r!o3eSKc&ap)iz2BTn_VV`4>9M^b3;(YY}4>#ML6{~(4mH+?%07*qo IM6N<$f(jP3KmY&$ literal 0 HcmV?d00001 diff --git a/assets/javascripts/bundle.51d95adb.min.js b/assets/javascripts/bundle.51d95adb.min.js new file mode 100644 index 00000000..b20ec683 --- /dev/null +++ b/assets/javascripts/bundle.51d95adb.min.js @@ -0,0 +1,29 @@ +"use strict";(()=>{var Hi=Object.create;var xr=Object.defineProperty;var Pi=Object.getOwnPropertyDescriptor;var $i=Object.getOwnPropertyNames,kt=Object.getOwnPropertySymbols,Ii=Object.getPrototypeOf,Er=Object.prototype.hasOwnProperty,an=Object.prototype.propertyIsEnumerable;var on=(e,t,r)=>t in e?xr(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r,P=(e,t)=>{for(var r in t||(t={}))Er.call(t,r)&&on(e,r,t[r]);if(kt)for(var r of kt(t))an.call(t,r)&&on(e,r,t[r]);return e};var sn=(e,t)=>{var r={};for(var n in e)Er.call(e,n)&&t.indexOf(n)<0&&(r[n]=e[n]);if(e!=null&&kt)for(var n of kt(e))t.indexOf(n)<0&&an.call(e,n)&&(r[n]=e[n]);return r};var Ht=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports);var Fi=(e,t,r,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of $i(t))!Er.call(e,o)&&o!==r&&xr(e,o,{get:()=>t[o],enumerable:!(n=Pi(t,o))||n.enumerable});return e};var yt=(e,t,r)=>(r=e!=null?Hi(Ii(e)):{},Fi(t||!e||!e.__esModule?xr(r,"default",{value:e,enumerable:!0}):r,e));var fn=Ht((wr,cn)=>{(function(e,t){typeof wr=="object"&&typeof cn!="undefined"?t():typeof define=="function"&&define.amd?define(t):t()})(wr,function(){"use strict";function e(r){var n=!0,o=!1,i=null,a={text:!0,search:!0,url:!0,tel:!0,email:!0,password:!0,number:!0,date:!0,month:!0,week:!0,time:!0,datetime:!0,"datetime-local":!0};function s(T){return!!(T&&T!==document&&T.nodeName!=="HTML"&&T.nodeName!=="BODY"&&"classList"in T&&"contains"in T.classList)}function f(T){var Ke=T.type,We=T.tagName;return!!(We==="INPUT"&&a[Ke]&&!T.readOnly||We==="TEXTAREA"&&!T.readOnly||T.isContentEditable)}function c(T){T.classList.contains("focus-visible")||(T.classList.add("focus-visible"),T.setAttribute("data-focus-visible-added",""))}function u(T){T.hasAttribute("data-focus-visible-added")&&(T.classList.remove("focus-visible"),T.removeAttribute("data-focus-visible-added"))}function p(T){T.metaKey||T.altKey||T.ctrlKey||(s(r.activeElement)&&c(r.activeElement),n=!0)}function m(T){n=!1}function d(T){s(T.target)&&(n||f(T.target))&&c(T.target)}function h(T){s(T.target)&&(T.target.classList.contains("focus-visible")||T.target.hasAttribute("data-focus-visible-added"))&&(o=!0,window.clearTimeout(i),i=window.setTimeout(function(){o=!1},100),u(T.target))}function v(T){document.visibilityState==="hidden"&&(o&&(n=!0),B())}function B(){document.addEventListener("mousemove",z),document.addEventListener("mousedown",z),document.addEventListener("mouseup",z),document.addEventListener("pointermove",z),document.addEventListener("pointerdown",z),document.addEventListener("pointerup",z),document.addEventListener("touchmove",z),document.addEventListener("touchstart",z),document.addEventListener("touchend",z)}function re(){document.removeEventListener("mousemove",z),document.removeEventListener("mousedown",z),document.removeEventListener("mouseup",z),document.removeEventListener("pointermove",z),document.removeEventListener("pointerdown",z),document.removeEventListener("pointerup",z),document.removeEventListener("touchmove",z),document.removeEventListener("touchstart",z),document.removeEventListener("touchend",z)}function z(T){T.target.nodeName&&T.target.nodeName.toLowerCase()==="html"||(n=!1,re())}document.addEventListener("keydown",p,!0),document.addEventListener("mousedown",m,!0),document.addEventListener("pointerdown",m,!0),document.addEventListener("touchstart",m,!0),document.addEventListener("visibilitychange",v,!0),B(),r.addEventListener("focus",d,!0),r.addEventListener("blur",h,!0),r.nodeType===Node.DOCUMENT_FRAGMENT_NODE&&r.host?r.host.setAttribute("data-js-focus-visible",""):r.nodeType===Node.DOCUMENT_NODE&&(document.documentElement.classList.add("js-focus-visible"),document.documentElement.setAttribute("data-js-focus-visible",""))}if(typeof window!="undefined"&&typeof document!="undefined"){window.applyFocusVisiblePolyfill=e;var t;try{t=new CustomEvent("focus-visible-polyfill-ready")}catch(r){t=document.createEvent("CustomEvent"),t.initCustomEvent("focus-visible-polyfill-ready",!1,!1,{})}window.dispatchEvent(t)}typeof document!="undefined"&&e(document)})});var un=Ht(Sr=>{(function(e){var t=function(){try{return!!Symbol.iterator}catch(c){return!1}},r=t(),n=function(c){var u={next:function(){var p=c.shift();return{done:p===void 0,value:p}}};return r&&(u[Symbol.iterator]=function(){return u}),u},o=function(c){return encodeURIComponent(c).replace(/%20/g,"+")},i=function(c){return decodeURIComponent(String(c).replace(/\+/g," "))},a=function(){var c=function(p){Object.defineProperty(this,"_entries",{writable:!0,value:{}});var m=typeof p;if(m!=="undefined")if(m==="string")p!==""&&this._fromString(p);else if(p instanceof c){var d=this;p.forEach(function(re,z){d.append(z,re)})}else if(p!==null&&m==="object")if(Object.prototype.toString.call(p)==="[object Array]")for(var h=0;hd[0]?1:0}),c._entries&&(c._entries={});for(var p=0;p1?i(d[1]):"")}})})(typeof global!="undefined"?global:typeof window!="undefined"?window:typeof self!="undefined"?self:Sr);(function(e){var t=function(){try{var o=new e.URL("b","http://a");return o.pathname="c d",o.href==="http://a/c%20d"&&o.searchParams}catch(i){return!1}},r=function(){var o=e.URL,i=function(f,c){typeof f!="string"&&(f=String(f)),c&&typeof c!="string"&&(c=String(c));var u=document,p;if(c&&(e.location===void 0||c!==e.location.href)){c=c.toLowerCase(),u=document.implementation.createHTMLDocument(""),p=u.createElement("base"),p.href=c,u.head.appendChild(p);try{if(p.href.indexOf(c)!==0)throw new Error(p.href)}catch(T){throw new Error("URL unable to set base "+c+" due to "+T)}}var m=u.createElement("a");m.href=f,p&&(u.body.appendChild(m),m.href=m.href);var d=u.createElement("input");if(d.type="url",d.value=f,m.protocol===":"||!/:/.test(m.href)||!d.checkValidity()&&!c)throw new TypeError("Invalid URL");Object.defineProperty(this,"_anchorElement",{value:m});var h=new e.URLSearchParams(this.search),v=!0,B=!0,re=this;["append","delete","set"].forEach(function(T){var Ke=h[T];h[T]=function(){Ke.apply(h,arguments),v&&(B=!1,re.search=h.toString(),B=!0)}}),Object.defineProperty(this,"searchParams",{value:h,enumerable:!0});var z=void 0;Object.defineProperty(this,"_updateSearchParams",{enumerable:!1,configurable:!1,writable:!1,value:function(){this.search!==z&&(z=this.search,B&&(v=!1,this.searchParams._fromString(this.search),v=!0))}})},a=i.prototype,s=function(f){Object.defineProperty(a,f,{get:function(){return this._anchorElement[f]},set:function(c){this._anchorElement[f]=c},enumerable:!0})};["hash","host","hostname","port","protocol"].forEach(function(f){s(f)}),Object.defineProperty(a,"search",{get:function(){return this._anchorElement.search},set:function(f){this._anchorElement.search=f,this._updateSearchParams()},enumerable:!0}),Object.defineProperties(a,{toString:{get:function(){var f=this;return function(){return f.href}}},href:{get:function(){return this._anchorElement.href.replace(/\?$/,"")},set:function(f){this._anchorElement.href=f,this._updateSearchParams()},enumerable:!0},pathname:{get:function(){return this._anchorElement.pathname.replace(/(^\/?)/,"/")},set:function(f){this._anchorElement.pathname=f},enumerable:!0},origin:{get:function(){var f={"http:":80,"https:":443,"ftp:":21}[this._anchorElement.protocol],c=this._anchorElement.port!=f&&this._anchorElement.port!=="";return this._anchorElement.protocol+"//"+this._anchorElement.hostname+(c?":"+this._anchorElement.port:"")},enumerable:!0},password:{get:function(){return""},set:function(f){},enumerable:!0},username:{get:function(){return""},set:function(f){},enumerable:!0}}),i.createObjectURL=function(f){return o.createObjectURL.apply(o,arguments)},i.revokeObjectURL=function(f){return o.revokeObjectURL.apply(o,arguments)},e.URL=i};if(t()||r(),e.location!==void 0&&!("origin"in e.location)){var n=function(){return e.location.protocol+"//"+e.location.hostname+(e.location.port?":"+e.location.port:"")};try{Object.defineProperty(e.location,"origin",{get:n,enumerable:!0})}catch(o){setInterval(function(){e.location.origin=n()},100)}}})(typeof global!="undefined"?global:typeof window!="undefined"?window:typeof self!="undefined"?self:Sr)});var Qr=Ht((Lt,Kr)=>{/*! + * clipboard.js v2.0.11 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */(function(t,r){typeof Lt=="object"&&typeof Kr=="object"?Kr.exports=r():typeof define=="function"&&define.amd?define([],r):typeof Lt=="object"?Lt.ClipboardJS=r():t.ClipboardJS=r()})(Lt,function(){return function(){var e={686:function(n,o,i){"use strict";i.d(o,{default:function(){return ki}});var a=i(279),s=i.n(a),f=i(370),c=i.n(f),u=i(817),p=i.n(u);function m(j){try{return document.execCommand(j)}catch(O){return!1}}var d=function(O){var w=p()(O);return m("cut"),w},h=d;function v(j){var O=document.documentElement.getAttribute("dir")==="rtl",w=document.createElement("textarea");w.style.fontSize="12pt",w.style.border="0",w.style.padding="0",w.style.margin="0",w.style.position="absolute",w.style[O?"right":"left"]="-9999px";var k=window.pageYOffset||document.documentElement.scrollTop;return w.style.top="".concat(k,"px"),w.setAttribute("readonly",""),w.value=j,w}var B=function(O,w){var k=v(O);w.container.appendChild(k);var F=p()(k);return m("copy"),k.remove(),F},re=function(O){var w=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body},k="";return typeof O=="string"?k=B(O,w):O instanceof HTMLInputElement&&!["text","search","url","tel","password"].includes(O==null?void 0:O.type)?k=B(O.value,w):(k=p()(O),m("copy")),k},z=re;function T(j){return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?T=function(w){return typeof w}:T=function(w){return w&&typeof Symbol=="function"&&w.constructor===Symbol&&w!==Symbol.prototype?"symbol":typeof w},T(j)}var Ke=function(){var O=arguments.length>0&&arguments[0]!==void 0?arguments[0]:{},w=O.action,k=w===void 0?"copy":w,F=O.container,q=O.target,Le=O.text;if(k!=="copy"&&k!=="cut")throw new Error('Invalid "action" value, use either "copy" or "cut"');if(q!==void 0)if(q&&T(q)==="object"&&q.nodeType===1){if(k==="copy"&&q.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if(k==="cut"&&(q.hasAttribute("readonly")||q.hasAttribute("disabled")))throw new Error(`Invalid "target" attribute. You can't cut text from elements with "readonly" or "disabled" attributes`)}else throw new Error('Invalid "target" value, use a valid Element');if(Le)return z(Le,{container:F});if(q)return k==="cut"?h(q):z(q,{container:F})},We=Ke;function Ie(j){return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?Ie=function(w){return typeof w}:Ie=function(w){return w&&typeof Symbol=="function"&&w.constructor===Symbol&&w!==Symbol.prototype?"symbol":typeof w},Ie(j)}function Ti(j,O){if(!(j instanceof O))throw new TypeError("Cannot call a class as a function")}function nn(j,O){for(var w=0;w0&&arguments[0]!==void 0?arguments[0]:{};this.action=typeof F.action=="function"?F.action:this.defaultAction,this.target=typeof F.target=="function"?F.target:this.defaultTarget,this.text=typeof F.text=="function"?F.text:this.defaultText,this.container=Ie(F.container)==="object"?F.container:document.body}},{key:"listenClick",value:function(F){var q=this;this.listener=c()(F,"click",function(Le){return q.onClick(Le)})}},{key:"onClick",value:function(F){var q=F.delegateTarget||F.currentTarget,Le=this.action(q)||"copy",Rt=We({action:Le,container:this.container,target:this.target(q),text:this.text(q)});this.emit(Rt?"success":"error",{action:Le,text:Rt,trigger:q,clearSelection:function(){q&&q.focus(),window.getSelection().removeAllRanges()}})}},{key:"defaultAction",value:function(F){return yr("action",F)}},{key:"defaultTarget",value:function(F){var q=yr("target",F);if(q)return document.querySelector(q)}},{key:"defaultText",value:function(F){return yr("text",F)}},{key:"destroy",value:function(){this.listener.destroy()}}],[{key:"copy",value:function(F){var q=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body};return z(F,q)}},{key:"cut",value:function(F){return h(F)}},{key:"isSupported",value:function(){var F=arguments.length>0&&arguments[0]!==void 0?arguments[0]:["copy","cut"],q=typeof F=="string"?[F]:F,Le=!!document.queryCommandSupported;return q.forEach(function(Rt){Le=Le&&!!document.queryCommandSupported(Rt)}),Le}}]),w}(s()),ki=Ri},828:function(n){var o=9;if(typeof Element!="undefined"&&!Element.prototype.matches){var i=Element.prototype;i.matches=i.matchesSelector||i.mozMatchesSelector||i.msMatchesSelector||i.oMatchesSelector||i.webkitMatchesSelector}function a(s,f){for(;s&&s.nodeType!==o;){if(typeof s.matches=="function"&&s.matches(f))return s;s=s.parentNode}}n.exports=a},438:function(n,o,i){var a=i(828);function s(u,p,m,d,h){var v=c.apply(this,arguments);return u.addEventListener(m,v,h),{destroy:function(){u.removeEventListener(m,v,h)}}}function f(u,p,m,d,h){return typeof u.addEventListener=="function"?s.apply(null,arguments):typeof m=="function"?s.bind(null,document).apply(null,arguments):(typeof u=="string"&&(u=document.querySelectorAll(u)),Array.prototype.map.call(u,function(v){return s(v,p,m,d,h)}))}function c(u,p,m,d){return function(h){h.delegateTarget=a(h.target,p),h.delegateTarget&&d.call(u,h)}}n.exports=f},879:function(n,o){o.node=function(i){return i!==void 0&&i instanceof HTMLElement&&i.nodeType===1},o.nodeList=function(i){var a=Object.prototype.toString.call(i);return i!==void 0&&(a==="[object NodeList]"||a==="[object HTMLCollection]")&&"length"in i&&(i.length===0||o.node(i[0]))},o.string=function(i){return typeof i=="string"||i instanceof String},o.fn=function(i){var a=Object.prototype.toString.call(i);return a==="[object Function]"}},370:function(n,o,i){var a=i(879),s=i(438);function f(m,d,h){if(!m&&!d&&!h)throw new Error("Missing required arguments");if(!a.string(d))throw new TypeError("Second argument must be a String");if(!a.fn(h))throw new TypeError("Third argument must be a Function");if(a.node(m))return c(m,d,h);if(a.nodeList(m))return u(m,d,h);if(a.string(m))return p(m,d,h);throw new TypeError("First argument must be a String, HTMLElement, HTMLCollection, or NodeList")}function c(m,d,h){return m.addEventListener(d,h),{destroy:function(){m.removeEventListener(d,h)}}}function u(m,d,h){return Array.prototype.forEach.call(m,function(v){v.addEventListener(d,h)}),{destroy:function(){Array.prototype.forEach.call(m,function(v){v.removeEventListener(d,h)})}}}function p(m,d,h){return s(document.body,m,d,h)}n.exports=f},817:function(n){function o(i){var a;if(i.nodeName==="SELECT")i.focus(),a=i.value;else if(i.nodeName==="INPUT"||i.nodeName==="TEXTAREA"){var s=i.hasAttribute("readonly");s||i.setAttribute("readonly",""),i.select(),i.setSelectionRange(0,i.value.length),s||i.removeAttribute("readonly"),a=i.value}else{i.hasAttribute("contenteditable")&&i.focus();var f=window.getSelection(),c=document.createRange();c.selectNodeContents(i),f.removeAllRanges(),f.addRange(c),a=f.toString()}return a}n.exports=o},279:function(n){function o(){}o.prototype={on:function(i,a,s){var f=this.e||(this.e={});return(f[i]||(f[i]=[])).push({fn:a,ctx:s}),this},once:function(i,a,s){var f=this;function c(){f.off(i,c),a.apply(s,arguments)}return c._=a,this.on(i,c,s)},emit:function(i){var a=[].slice.call(arguments,1),s=((this.e||(this.e={}))[i]||[]).slice(),f=0,c=s.length;for(f;f{"use strict";/*! + * escape-html + * Copyright(c) 2012-2013 TJ Holowaychuk + * Copyright(c) 2015 Andreas Lubbe + * Copyright(c) 2015 Tiancheng "Timothy" Gu + * MIT Licensed + */var is=/["'&<>]/;Jo.exports=as;function as(e){var t=""+e,r=is.exec(t);if(!r)return t;var n,o="",i=0,a=0;for(i=r.index;i0&&i[i.length-1])&&(c[0]===6||c[0]===2)){r=0;continue}if(c[0]===3&&(!i||c[1]>i[0]&&c[1]=e.length&&(e=void 0),{value:e&&e[n++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")}function W(e,t){var r=typeof Symbol=="function"&&e[Symbol.iterator];if(!r)return e;var n=r.call(e),o,i=[],a;try{for(;(t===void 0||t-- >0)&&!(o=n.next()).done;)i.push(o.value)}catch(s){a={error:s}}finally{try{o&&!o.done&&(r=n.return)&&r.call(n)}finally{if(a)throw a.error}}return i}function D(e,t,r){if(r||arguments.length===2)for(var n=0,o=t.length,i;n1||s(m,d)})})}function s(m,d){try{f(n[m](d))}catch(h){p(i[0][3],h)}}function f(m){m.value instanceof Xe?Promise.resolve(m.value.v).then(c,u):p(i[0][2],m)}function c(m){s("next",m)}function u(m){s("throw",m)}function p(m,d){m(d),i.shift(),i.length&&s(i[0][0],i[0][1])}}function mn(e){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var t=e[Symbol.asyncIterator],r;return t?t.call(e):(e=typeof xe=="function"?xe(e):e[Symbol.iterator](),r={},n("next"),n("throw"),n("return"),r[Symbol.asyncIterator]=function(){return this},r);function n(i){r[i]=e[i]&&function(a){return new Promise(function(s,f){a=e[i](a),o(s,f,a.done,a.value)})}}function o(i,a,s,f){Promise.resolve(f).then(function(c){i({value:c,done:s})},a)}}function A(e){return typeof e=="function"}function at(e){var t=function(n){Error.call(n),n.stack=new Error().stack},r=e(t);return r.prototype=Object.create(Error.prototype),r.prototype.constructor=r,r}var $t=at(function(e){return function(r){e(this),this.message=r?r.length+` errors occurred during unsubscription: +`+r.map(function(n,o){return o+1+") "+n.toString()}).join(` + `):"",this.name="UnsubscriptionError",this.errors=r}});function De(e,t){if(e){var r=e.indexOf(t);0<=r&&e.splice(r,1)}}var Fe=function(){function e(t){this.initialTeardown=t,this.closed=!1,this._parentage=null,this._finalizers=null}return e.prototype.unsubscribe=function(){var t,r,n,o,i;if(!this.closed){this.closed=!0;var a=this._parentage;if(a)if(this._parentage=null,Array.isArray(a))try{for(var s=xe(a),f=s.next();!f.done;f=s.next()){var c=f.value;c.remove(this)}}catch(v){t={error:v}}finally{try{f&&!f.done&&(r=s.return)&&r.call(s)}finally{if(t)throw t.error}}else a.remove(this);var u=this.initialTeardown;if(A(u))try{u()}catch(v){i=v instanceof $t?v.errors:[v]}var p=this._finalizers;if(p){this._finalizers=null;try{for(var m=xe(p),d=m.next();!d.done;d=m.next()){var h=d.value;try{dn(h)}catch(v){i=i!=null?i:[],v instanceof $t?i=D(D([],W(i)),W(v.errors)):i.push(v)}}}catch(v){n={error:v}}finally{try{d&&!d.done&&(o=m.return)&&o.call(m)}finally{if(n)throw n.error}}}if(i)throw new $t(i)}},e.prototype.add=function(t){var r;if(t&&t!==this)if(this.closed)dn(t);else{if(t instanceof e){if(t.closed||t._hasParent(this))return;t._addParent(this)}(this._finalizers=(r=this._finalizers)!==null&&r!==void 0?r:[]).push(t)}},e.prototype._hasParent=function(t){var r=this._parentage;return r===t||Array.isArray(r)&&r.includes(t)},e.prototype._addParent=function(t){var r=this._parentage;this._parentage=Array.isArray(r)?(r.push(t),r):r?[r,t]:t},e.prototype._removeParent=function(t){var r=this._parentage;r===t?this._parentage=null:Array.isArray(r)&&De(r,t)},e.prototype.remove=function(t){var r=this._finalizers;r&&De(r,t),t instanceof e&&t._removeParent(this)},e.EMPTY=function(){var t=new e;return t.closed=!0,t}(),e}();var Or=Fe.EMPTY;function It(e){return e instanceof Fe||e&&"closed"in e&&A(e.remove)&&A(e.add)&&A(e.unsubscribe)}function dn(e){A(e)?e():e.unsubscribe()}var Ae={onUnhandledError:null,onStoppedNotification:null,Promise:void 0,useDeprecatedSynchronousErrorHandling:!1,useDeprecatedNextContext:!1};var st={setTimeout:function(e,t){for(var r=[],n=2;n0},enumerable:!1,configurable:!0}),t.prototype._trySubscribe=function(r){return this._throwIfClosed(),e.prototype._trySubscribe.call(this,r)},t.prototype._subscribe=function(r){return this._throwIfClosed(),this._checkFinalizedStatuses(r),this._innerSubscribe(r)},t.prototype._innerSubscribe=function(r){var n=this,o=this,i=o.hasError,a=o.isStopped,s=o.observers;return i||a?Or:(this.currentObservers=null,s.push(r),new Fe(function(){n.currentObservers=null,De(s,r)}))},t.prototype._checkFinalizedStatuses=function(r){var n=this,o=n.hasError,i=n.thrownError,a=n.isStopped;o?r.error(i):a&&r.complete()},t.prototype.asObservable=function(){var r=new U;return r.source=this,r},t.create=function(r,n){return new wn(r,n)},t}(U);var wn=function(e){ne(t,e);function t(r,n){var o=e.call(this)||this;return o.destination=r,o.source=n,o}return t.prototype.next=function(r){var n,o;(o=(n=this.destination)===null||n===void 0?void 0:n.next)===null||o===void 0||o.call(n,r)},t.prototype.error=function(r){var n,o;(o=(n=this.destination)===null||n===void 0?void 0:n.error)===null||o===void 0||o.call(n,r)},t.prototype.complete=function(){var r,n;(n=(r=this.destination)===null||r===void 0?void 0:r.complete)===null||n===void 0||n.call(r)},t.prototype._subscribe=function(r){var n,o;return(o=(n=this.source)===null||n===void 0?void 0:n.subscribe(r))!==null&&o!==void 0?o:Or},t}(E);var Et={now:function(){return(Et.delegate||Date).now()},delegate:void 0};var wt=function(e){ne(t,e);function t(r,n,o){r===void 0&&(r=1/0),n===void 0&&(n=1/0),o===void 0&&(o=Et);var i=e.call(this)||this;return i._bufferSize=r,i._windowTime=n,i._timestampProvider=o,i._buffer=[],i._infiniteTimeWindow=!0,i._infiniteTimeWindow=n===1/0,i._bufferSize=Math.max(1,r),i._windowTime=Math.max(1,n),i}return t.prototype.next=function(r){var n=this,o=n.isStopped,i=n._buffer,a=n._infiniteTimeWindow,s=n._timestampProvider,f=n._windowTime;o||(i.push(r),!a&&i.push(s.now()+f)),this._trimBuffer(),e.prototype.next.call(this,r)},t.prototype._subscribe=function(r){this._throwIfClosed(),this._trimBuffer();for(var n=this._innerSubscribe(r),o=this,i=o._infiniteTimeWindow,a=o._buffer,s=a.slice(),f=0;f0?e.prototype.requestAsyncId.call(this,r,n,o):(r.actions.push(this),r._scheduled||(r._scheduled=ut.requestAnimationFrame(function(){return r.flush(void 0)})))},t.prototype.recycleAsyncId=function(r,n,o){var i;if(o===void 0&&(o=0),o!=null?o>0:this.delay>0)return e.prototype.recycleAsyncId.call(this,r,n,o);var a=r.actions;n!=null&&((i=a[a.length-1])===null||i===void 0?void 0:i.id)!==n&&(ut.cancelAnimationFrame(n),r._scheduled=void 0)},t}(Ut);var On=function(e){ne(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t.prototype.flush=function(r){this._active=!0;var n=this._scheduled;this._scheduled=void 0;var o=this.actions,i;r=r||o.shift();do if(i=r.execute(r.state,r.delay))break;while((r=o[0])&&r.id===n&&o.shift());if(this._active=!1,i){for(;(r=o[0])&&r.id===n&&o.shift();)r.unsubscribe();throw i}},t}(Wt);var we=new On(Tn);var R=new U(function(e){return e.complete()});function Dt(e){return e&&A(e.schedule)}function kr(e){return e[e.length-1]}function Qe(e){return A(kr(e))?e.pop():void 0}function Se(e){return Dt(kr(e))?e.pop():void 0}function Vt(e,t){return typeof kr(e)=="number"?e.pop():t}var pt=function(e){return e&&typeof e.length=="number"&&typeof e!="function"};function zt(e){return A(e==null?void 0:e.then)}function Nt(e){return A(e[ft])}function qt(e){return Symbol.asyncIterator&&A(e==null?void 0:e[Symbol.asyncIterator])}function Kt(e){return new TypeError("You provided "+(e!==null&&typeof e=="object"?"an invalid object":"'"+e+"'")+" where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.")}function Ki(){return typeof Symbol!="function"||!Symbol.iterator?"@@iterator":Symbol.iterator}var Qt=Ki();function Yt(e){return A(e==null?void 0:e[Qt])}function Gt(e){return ln(this,arguments,function(){var r,n,o,i;return Pt(this,function(a){switch(a.label){case 0:r=e.getReader(),a.label=1;case 1:a.trys.push([1,,9,10]),a.label=2;case 2:return[4,Xe(r.read())];case 3:return n=a.sent(),o=n.value,i=n.done,i?[4,Xe(void 0)]:[3,5];case 4:return[2,a.sent()];case 5:return[4,Xe(o)];case 6:return[4,a.sent()];case 7:return a.sent(),[3,2];case 8:return[3,10];case 9:return r.releaseLock(),[7];case 10:return[2]}})})}function Bt(e){return A(e==null?void 0:e.getReader)}function $(e){if(e instanceof U)return e;if(e!=null){if(Nt(e))return Qi(e);if(pt(e))return Yi(e);if(zt(e))return Gi(e);if(qt(e))return _n(e);if(Yt(e))return Bi(e);if(Bt(e))return Ji(e)}throw Kt(e)}function Qi(e){return new U(function(t){var r=e[ft]();if(A(r.subscribe))return r.subscribe(t);throw new TypeError("Provided object does not correctly implement Symbol.observable")})}function Yi(e){return new U(function(t){for(var r=0;r=2;return function(n){return n.pipe(e?_(function(o,i){return e(o,i,n)}):me,Oe(1),r?He(t):zn(function(){return new Xt}))}}function Nn(){for(var e=[],t=0;t=2,!0))}function fe(e){e===void 0&&(e={});var t=e.connector,r=t===void 0?function(){return new E}:t,n=e.resetOnError,o=n===void 0?!0:n,i=e.resetOnComplete,a=i===void 0?!0:i,s=e.resetOnRefCountZero,f=s===void 0?!0:s;return function(c){var u,p,m,d=0,h=!1,v=!1,B=function(){p==null||p.unsubscribe(),p=void 0},re=function(){B(),u=m=void 0,h=v=!1},z=function(){var T=u;re(),T==null||T.unsubscribe()};return g(function(T,Ke){d++,!v&&!h&&B();var We=m=m!=null?m:r();Ke.add(function(){d--,d===0&&!v&&!h&&(p=jr(z,f))}),We.subscribe(Ke),!u&&d>0&&(u=new et({next:function(Ie){return We.next(Ie)},error:function(Ie){v=!0,B(),p=jr(re,o,Ie),We.error(Ie)},complete:function(){h=!0,B(),p=jr(re,a),We.complete()}}),$(T).subscribe(u))})(c)}}function jr(e,t){for(var r=[],n=2;ne.next(document)),e}function K(e,t=document){return Array.from(t.querySelectorAll(e))}function V(e,t=document){let r=se(e,t);if(typeof r=="undefined")throw new ReferenceError(`Missing element: expected "${e}" to be present`);return r}function se(e,t=document){return t.querySelector(e)||void 0}function _e(){return document.activeElement instanceof HTMLElement&&document.activeElement||void 0}function tr(e){return L(b(document.body,"focusin"),b(document.body,"focusout")).pipe(ke(1),l(()=>{let t=_e();return typeof t!="undefined"?e.contains(t):!1}),N(e===_e()),Y())}function Be(e){return{x:e.offsetLeft,y:e.offsetTop}}function Yn(e){return L(b(window,"load"),b(window,"resize")).pipe(Ce(0,we),l(()=>Be(e)),N(Be(e)))}function rr(e){return{x:e.scrollLeft,y:e.scrollTop}}function dt(e){return L(b(e,"scroll"),b(window,"resize")).pipe(Ce(0,we),l(()=>rr(e)),N(rr(e)))}var Bn=function(){if(typeof Map!="undefined")return Map;function e(t,r){var n=-1;return t.some(function(o,i){return o[0]===r?(n=i,!0):!1}),n}return function(){function t(){this.__entries__=[]}return Object.defineProperty(t.prototype,"size",{get:function(){return this.__entries__.length},enumerable:!0,configurable:!0}),t.prototype.get=function(r){var n=e(this.__entries__,r),o=this.__entries__[n];return o&&o[1]},t.prototype.set=function(r,n){var o=e(this.__entries__,r);~o?this.__entries__[o][1]=n:this.__entries__.push([r,n])},t.prototype.delete=function(r){var n=this.__entries__,o=e(n,r);~o&&n.splice(o,1)},t.prototype.has=function(r){return!!~e(this.__entries__,r)},t.prototype.clear=function(){this.__entries__.splice(0)},t.prototype.forEach=function(r,n){n===void 0&&(n=null);for(var o=0,i=this.__entries__;o0},e.prototype.connect_=function(){!zr||this.connected_||(document.addEventListener("transitionend",this.onTransitionEnd_),window.addEventListener("resize",this.refresh),xa?(this.mutationsObserver_=new MutationObserver(this.refresh),this.mutationsObserver_.observe(document,{attributes:!0,childList:!0,characterData:!0,subtree:!0})):(document.addEventListener("DOMSubtreeModified",this.refresh),this.mutationEventsAdded_=!0),this.connected_=!0)},e.prototype.disconnect_=function(){!zr||!this.connected_||(document.removeEventListener("transitionend",this.onTransitionEnd_),window.removeEventListener("resize",this.refresh),this.mutationsObserver_&&this.mutationsObserver_.disconnect(),this.mutationEventsAdded_&&document.removeEventListener("DOMSubtreeModified",this.refresh),this.mutationsObserver_=null,this.mutationEventsAdded_=!1,this.connected_=!1)},e.prototype.onTransitionEnd_=function(t){var r=t.propertyName,n=r===void 0?"":r,o=ya.some(function(i){return!!~n.indexOf(i)});o&&this.refresh()},e.getInstance=function(){return this.instance_||(this.instance_=new e),this.instance_},e.instance_=null,e}(),Jn=function(e,t){for(var r=0,n=Object.keys(t);r0},e}(),Zn=typeof WeakMap!="undefined"?new WeakMap:new Bn,eo=function(){function e(t){if(!(this instanceof e))throw new TypeError("Cannot call a class as a function.");if(!arguments.length)throw new TypeError("1 argument required, but only 0 present.");var r=Ea.getInstance(),n=new Ra(t,r,this);Zn.set(this,n)}return e}();["observe","unobserve","disconnect"].forEach(function(e){eo.prototype[e]=function(){var t;return(t=Zn.get(this))[e].apply(t,arguments)}});var ka=function(){return typeof nr.ResizeObserver!="undefined"?nr.ResizeObserver:eo}(),to=ka;var ro=new E,Ha=I(()=>H(new to(e=>{for(let t of e)ro.next(t)}))).pipe(x(e=>L(Te,H(e)).pipe(C(()=>e.disconnect()))),J(1));function de(e){return{width:e.offsetWidth,height:e.offsetHeight}}function ge(e){return Ha.pipe(S(t=>t.observe(e)),x(t=>ro.pipe(_(({target:r})=>r===e),C(()=>t.unobserve(e)),l(()=>de(e)))),N(de(e)))}function bt(e){return{width:e.scrollWidth,height:e.scrollHeight}}function ar(e){let t=e.parentElement;for(;t&&(e.scrollWidth<=t.scrollWidth&&e.scrollHeight<=t.scrollHeight);)t=(e=t).parentElement;return t?e:void 0}var no=new E,Pa=I(()=>H(new IntersectionObserver(e=>{for(let t of e)no.next(t)},{threshold:0}))).pipe(x(e=>L(Te,H(e)).pipe(C(()=>e.disconnect()))),J(1));function sr(e){return Pa.pipe(S(t=>t.observe(e)),x(t=>no.pipe(_(({target:r})=>r===e),C(()=>t.unobserve(e)),l(({isIntersecting:r})=>r))))}function oo(e,t=16){return dt(e).pipe(l(({y:r})=>{let n=de(e),o=bt(e);return r>=o.height-n.height-t}),Y())}var cr={drawer:V("[data-md-toggle=drawer]"),search:V("[data-md-toggle=search]")};function io(e){return cr[e].checked}function qe(e,t){cr[e].checked!==t&&cr[e].click()}function je(e){let t=cr[e];return b(t,"change").pipe(l(()=>t.checked),N(t.checked))}function $a(e,t){switch(e.constructor){case HTMLInputElement:return e.type==="radio"?/^Arrow/.test(t):!0;case HTMLSelectElement:case HTMLTextAreaElement:return!0;default:return e.isContentEditable}}function Ia(){return L(b(window,"compositionstart").pipe(l(()=>!0)),b(window,"compositionend").pipe(l(()=>!1))).pipe(N(!1))}function ao(){let e=b(window,"keydown").pipe(_(t=>!(t.metaKey||t.ctrlKey)),l(t=>({mode:io("search")?"search":"global",type:t.key,claim(){t.preventDefault(),t.stopPropagation()}})),_(({mode:t,type:r})=>{if(t==="global"){let n=_e();if(typeof n!="undefined")return!$a(n,r)}return!0}),fe());return Ia().pipe(x(t=>t?R:e))}function Me(){return new URL(location.href)}function ot(e){location.href=e.href}function so(){return new E}function co(e,t){if(typeof t=="string"||typeof t=="number")e.innerHTML+=t.toString();else if(t instanceof Node)e.appendChild(t);else if(Array.isArray(t))for(let r of t)co(e,r)}function M(e,t,...r){let n=document.createElement(e);if(t)for(let o of Object.keys(t))typeof t[o]!="undefined"&&(typeof t[o]!="boolean"?n.setAttribute(o,t[o]):n.setAttribute(o,""));for(let o of r)co(n,o);return n}function fr(e){if(e>999){let t=+((e-950)%1e3>99);return`${((e+1e-6)/1e3).toFixed(t)}k`}else return e.toString()}function fo(){return location.hash.substring(1)}function uo(e){let t=M("a",{href:e});t.addEventListener("click",r=>r.stopPropagation()),t.click()}function Fa(){return b(window,"hashchange").pipe(l(fo),N(fo()),_(e=>e.length>0),J(1))}function po(){return Fa().pipe(l(e=>se(`[id="${e}"]`)),_(e=>typeof e!="undefined"))}function Nr(e){let t=matchMedia(e);return Zt(r=>t.addListener(()=>r(t.matches))).pipe(N(t.matches))}function lo(){let e=matchMedia("print");return L(b(window,"beforeprint").pipe(l(()=>!0)),b(window,"afterprint").pipe(l(()=>!1))).pipe(N(e.matches))}function qr(e,t){return e.pipe(x(r=>r?t():R))}function ur(e,t={credentials:"same-origin"}){return ve(fetch(`${e}`,t)).pipe(ce(()=>R),x(r=>r.status!==200?Tt(()=>new Error(r.statusText)):H(r)))}function Ue(e,t){return ur(e,t).pipe(x(r=>r.json()),J(1))}function mo(e,t){let r=new DOMParser;return ur(e,t).pipe(x(n=>n.text()),l(n=>r.parseFromString(n,"text/xml")),J(1))}function pr(e){let t=M("script",{src:e});return I(()=>(document.head.appendChild(t),L(b(t,"load"),b(t,"error").pipe(x(()=>Tt(()=>new ReferenceError(`Invalid script: ${e}`))))).pipe(l(()=>{}),C(()=>document.head.removeChild(t)),Oe(1))))}function ho(){return{x:Math.max(0,scrollX),y:Math.max(0,scrollY)}}function bo(){return L(b(window,"scroll",{passive:!0}),b(window,"resize",{passive:!0})).pipe(l(ho),N(ho()))}function vo(){return{width:innerWidth,height:innerHeight}}function go(){return b(window,"resize",{passive:!0}).pipe(l(vo),N(vo()))}function yo(){return Q([bo(),go()]).pipe(l(([e,t])=>({offset:e,size:t})),J(1))}function lr(e,{viewport$:t,header$:r}){let n=t.pipe(X("size")),o=Q([n,r]).pipe(l(()=>Be(e)));return Q([r,t,o]).pipe(l(([{height:i},{offset:a,size:s},{x:f,y:c}])=>({offset:{x:a.x-f,y:a.y-c+i},size:s})))}(()=>{function e(n,o){parent.postMessage(n,o||"*")}function t(...n){return n.reduce((o,i)=>o.then(()=>new Promise(a=>{let s=document.createElement("script");s.src=i,s.onload=a,document.body.appendChild(s)})),Promise.resolve())}var r=class{constructor(n){this.url=n,this.onerror=null,this.onmessage=null,this.onmessageerror=null,this.m=a=>{a.source===this.w&&(a.stopImmediatePropagation(),this.dispatchEvent(new MessageEvent("message",{data:a.data})),this.onmessage&&this.onmessage(a))},this.e=(a,s,f,c,u)=>{if(s===this.url.toString()){let p=new ErrorEvent("error",{message:a,filename:s,lineno:f,colno:c,error:u});this.dispatchEvent(p),this.onerror&&this.onerror(p)}};let o=new EventTarget;this.addEventListener=o.addEventListener.bind(o),this.removeEventListener=o.removeEventListener.bind(o),this.dispatchEvent=o.dispatchEvent.bind(o);let i=document.createElement("iframe");i.width=i.height=i.frameBorder="0",document.body.appendChild(this.iframe=i),this.w.document.open(),this.w.document.write(` + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Authentication

+

There are two authentication mechanisms for using Fladle.

+

It is recommended to use user authentication on local development machines to avoid sharing credentials and a service account on CI.

+

User authentication

+

Credentials are stored in ~/.flank.

+
    +
  1. ./gradlew flankAuth
    2. +
  2. Sign in to web browser.
    3. +
  3. Specify projectId in fladle configuration
    4. +
  4. ./gradlew runFlank
    5. +
+

Service account credentials

+
    +
  1. +

    Create a service account. Service accounts aren't subject to spam checks or captcha prompts, which could + otherwise block your CI builds. Create a service account with an Editor role in the + Google Cloud Platform console.

    +
    2. +
  2. +

    Enable required APIs. After logging in using the service account: In the Google Developers Console API Library + page, enable the Google Cloud Testing API and Cloud Tool Results API. To enable these APIs, type these API names into + the search box at the top of the console, and then click Enable API on the overview page for that API.

    +
    3. +
  3. +

    After creating the account go to Keys, click Add Key -> Create a new Key. Select JSON for the key type. This will download the json credentials.

    +
    4. +
  4. +

    Configure the Fladle extension serviceAccountCredentials to point to the credentials.

    +
    5. +
+

Above instructions are based on Google instruction for authenticating with CI.

+

See also Flank's instructions for authenticating with a service account.

+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/changelog/index.html b/changelog/index.html new file mode 100644 index 00000000..1abd54c4 --- /dev/null +++ b/changelog/index.html @@ -0,0 +1,1666 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Changelog - Fladle + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Changelog

+

Unreleased

+

0.21.0

+
    +
  • Minimum required Gradle version is now 9.1
    • +
  • Fixed support for Android Gradle Plugin version 9.0.1
    • +
+

0.20.0

+
    +
  • Botched release. Do not use.
    • +
+

0.19.0

+
    +
  • Minimum required JVM version is now 17.
    • +
  • Minimum supported Gradle version is now 7.3.
    • +
  • Fix support for Gradle 9.0.0. PR Thanks kevinguitar
    • +
+

0.18.0

+
    +
  • Use non-deprecated device models and versions in default config. PR Thanks Kaibolay
    • +
+

0.17.5

+
    +
  • Support Develocity JUnit XML Reporting PR Thanks ZacSweers
    • +
  • Min supported Gradle version is now 6.5
    • +
  • Updated Flank version to 23.10.1 +*
    • +
+

0.17.4

+
    +
  • Add support for additionalTestApks in YamlConfigWriterTask. PR. Thanks ZacSweers
    • +
  • Add abi option to support selecting a particular debug APK in projects that use ABI splits to produce multiple APKs. PR
    • +
+

0.17.2

+
    +
  • Fix configuration cache support.
    • +
+

0.17.0

+
    +
  • Fix quotes around environment variables and formatting issues.
    • +
+

0.16.3

+
    +
  • Remove deprecation warning using main in JavaExec task.
    • +
  • Conditionally declare outputs on FlankExecutionTask and mark as not up-to-date. PR
    • +
  • Fix environmentVariables not passed to flank.yml PR Thanks Sinan
    • +
+

0.16.2

+
    +
  • Fix crash accessing TestedExtension in non-android modules PR Thanks asadsalman
    • +
+

0.16.1

+
    +
  • Treat app and library modules the same in Fulladle PR Thanks asadsalman
    • +
  • Added fulladleModuleConfig to app modules PR
    • +
+
+

Breaking API Change

+

Previously, only app modules could be picked up as root-level modules in Fulladle. This has changed, now either app or library modules can be picked up (though we try app modules first). If a library module is picked up as a the root-level module, it must specifiy a debugApk through either the root fladle block or the module's own fulladleModuleConfig block.

+
+

0.16.0

+
    +
  • Allow excluding modules from Fulladle PR
    • +
  • Allow configuring extra parameters on additionalTestApks PR
    • +
+

0.15.1

+
    +
  • Allow Flank snapshot usage PR Thanks AndrewReitz
    • +
  • Fix incorrect task group name. PR
    • +
  • Snapshots are now compatible with java 8 PR
    • +
  • Configuration validation happens at task execution time. Fixes #239
    • +
  • Configure assemble dependency per variant. Fixes #233
    • +
  • Add required smartFlankGcsPath to samples Fixes #236
    • +
+

0.15.0

+
    +
  • Add support for async flag. PR.
    • +
  • Add flag for depending on assembling of debug apk and instrumentation apk automatically. dependOnAssemble PR Thanks asadsalman
    • +
  • Gradle 7.0 Compatibility
    • +
+

0.14.1

+ +

0.14.0

+ +

0.13.1

+
    +
  • Fix flankAuth task throwing exception. Fixes #195
    • +
  • Add support for newly added flank options PR#186 Thanks pawelpasterz:
      +
    • default-test-time
      • +
    • default-class-test-time
      • +
    • additional-apks
      • +
    • use-average-test-time-for-new-tests
      • +
    • disable-results-upload
      • +
    +
    • +
+

0.13.0

+ +
+

Breaking API Change

+

Use lazy properties Fixes #92 PR Thanks pawelpasterz

+
+

0.12.1

+
    +
  • Don't override debug or instrumentation apk if already specified. Fixes #172.
    • +
+

0.12.0

+
    +
  • Don't override property values in individual configurations. Fixes #158.
    • +
  • Update Flank to 20.08.3.
    • +
  • Use Github actions instead of CircleCI
    • +
  • Write Yaml file to task specific output directory and add up-to-date checks. #159 Fixes #147 Thanks CristianGM
    • +
  • Add support for full-junit-result and legacy-junit-result. #170 Fixes #157. Thanks MatthewTPage
    • +
+

0.11.0

+
    +
  • Update Flank to 20.07.0.
    • +
  • Only add additional-test-apks for modules that have tests. PR
    • +
  • Experimental configuration caching support. PR1PR2
    • +
+

0.10.2

+ +
+

Breaking API change

+

Add time units for timeout. timeoutMin has been renamed to testTimeout. PR Thanks pawelpasterz

+
+

0.10.1

+
    +
  • [Fix] Allow for specifying roboScript without specifying instrumentationApk. Fixes #128.
    • +
+

0.10.0

+ +
+

Breaking API Change

+

additionalTestApks now uses ListProperty instead of the previous Map. This is to allow for lazy configuration of the provided files.

+
+
+

Warning

+

Minimum supported Gradle version is now 5.4.

+
+

0.9.4

+ +

0.9.2

+
+

Breaking API change

+

debugApk and instrumentationApk now use Lazy Property API to avoid resolving at configuration time.

+
+

0.9.1

+
    +
  • Bugfix: ability to set flank version. PR
    • +
+
+

Breaking API Change

+

serviceAccountCredentials now uses Lazy Property API. See Configuration for details on how to set it. PR

+
+
+

Warning

+

Minimum required Gradle Version is now 5.1.

+
+
+

Warning

+

Dropped support for Flank 7.X and lower.

+
+

0.9.0

+
    +
  • Do not add flank maven repo. PR
    • +
  • Allow specifying custom flank coordinates. PR
    • +
  • Change ordering and use file provider. PR
    • +
+

0.8.1

+
    +
  • Add support for additionalTestApks. PR Thanks japplin.
    • +
  • Add support for resultsDir. PR
    • +
+

0.8.0

+
    +
  • BREAKING: devices now takes a List<Map<String, String>> instead of a List<Device>. See the [#README.md] for an example. PR Thanks zlippard.
    • +
  • Add support for keep-file-path. PR Thanks tahirhajizada.
    • +
+

0.7.0

+ +

0.6.7

+
    +
  • Allow using wildcards in debugApk or instrumentationApk path by not checking that file exists. PR
    • +
+

0.6.6

+
    +
  • Bump flank version to 7.0.0
    • +
  • Publish to mavenCentral()
    • +
+

0.6.5

+
    +
  • Add support for results-bucket gcloud config option. PR Thanks c-moss
    • +
  • Default flank version 6.2.3
    • +
  • Lower build logging level
    • +
+

0.6.4

+
    +
  • Allow setting android version number as string to allow for preview versions. PRThanks JeroenMols.
    • +
+

0.6.3

+ +

0.6.2

+ +

0.6.1

+ +

0.6.0

+
    +
  • Default flank version 5.0.1
    • +
  • Rename yaml output to match new flank version.
    • +
  • Add support for shard time.
    • +
+

0.5.2

+
    +
  • Improve error messages for missing arguments in the fladle extension.
    • +
+

0.5.1

+
    +
  • Test multipleconfig to actually write yml Thanks PR winterDroid.
    • +
  • JavaExec uses classpath instead of jar directly. Thanks PR winterDroid.
    • +
+

0.5.0

+
    +
  • Use flank as a maven artifact.
    • +
  • Group Fladle Tasks
    • +
+

0.4.1

+
    +
  • Detect AndroidX test orchestrator
    • +
  • Fix detection of debug and instrumentation apk paths.
    • +
+

0.4.0

+
    +
  • Add support for all configuration options. Thanks PR winterDroid.
    • +
+

Breaking Changes:

+

Previous users of clearPackageData = true will now need to use: +

environmentVariables = [
+  "clearPackageData": "true"
+]
+

+

0.3.8

+
    +
  • Fix broken flakyTestAttempts.
    • +
+

0.3.7

+
    +
  • Add support for flakyTestAttempts.
    • +
+

0.3.6

+
    +
  • Add support for environment variable clearPackageData. Thanks @anderssu !
    • +
+

0.3.5

+
    +
  • Automatically configure the use of test orchestrator.
    • +
+

0.3.4

+
    +
  • Add support for setting results-history-name.
    • +
  • Add support for selecting variant to test instead of apk path.
    • +
+

0.3.3

+
    +
  • Add support for setting smartFlankGcsPath
    • +
  • Capitalize task names.
    • +
+

0.3.2

+
    +
  • Actually fix gradle download task bug.
    • +
+

0.3.1

+
    +
  • Maybe fix bug similar to: https://github.com/michel-kraemer/gradle-download-task/issues/58
    • +
+

0.3.0

+
    +
  • Add support for multiple test configurations.
    • +
+

0.2.12

+
    +
  • Fix broken flankDoctor task.
    • +
+

0.2.11

+
    +
  • Add minimum Gradle version check. (4.9 is required because we use the lazy task configuration API))
    • +
+

0.2.10

+
    +
  • Add support for specifying Flank snapshot versions. See README for configuration options.
    • +
+

0.2.9

+
    +
  • Add support for multiple build targets. PR. Thanks winterDroid.
    • +
  • Add support for testShards and repeatTests flank options. See README for configuration options.
    • +
+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/configuration/index.html b/configuration/index.html new file mode 100644 index 00000000..a2ab0c55 --- /dev/null +++ b/configuration/index.html @@ -0,0 +1,2472 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Configuration - Fladle + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Configuration

+

The following configuration options must be set inside the fladle block. See the sample configuration below. There is also a groovy sample and a kotlin sample.

+

serviceAccountCredentials

+
+

User Authentication is also possible. See Authentication.

+
+
+
serviceAccountCredentials = project.layout.projectDirectory.file("flank-gradle-5cf02dc90531.json")
+
+
+
+
serviceAccountCredentials.set("project.layout.projectDirectory.file("flank-gradle-5cf02dc90531.json")
+
+
+
+

Optionally, the serviceAccountCredentials can be set with environment variables but then the projectId parameter must be set.

+

See Authentication for more info.

+

variant

+
+

Note

+

variant must be set if using buildFlavors in order to automatically configure the debugApk and testApk.

+
+

Set the variant to automatically configure for testing. A build variant is a combination of buildFlavor and buildType. +This must also be set when testing against a non-default variant. +For example: 'debug' or 'freeDebug'. +Put this inside your Fladle block.

+
+
variant = "freeDebug"
+
+
+
+
variant.set("freeDebug")
+
+
+
+

Sample Configuration

+
fladle {
+    // Required parameters
+    serviceAccountCredentials = project.layout.projectDirectory.file("flank-gradle-5cf02dc90531.json")
+    variant = "freeDebug"
+
+    // Optional parameters
+    useOrchestrator = false
+    environmentVariables = [
+        "clearPackageData": "true"
+    ]
+    directoriesToPull = [
+        "/sdcard/screenshots"
+    ]
+    filesToDownload = [
+        ".*/screenshots/.*"
+    ]
+    testTargets = [
+        "class com.osacky.flank.gradle.sample.ExampleInstrumentedTest#seeView"
+    ]
+    testTimeout = "15m"
+    recordVideo = false
+    performanceMetrics = false
+    devices = [
+        [ "model": "SmallPhone.arm", "version": "28" ],
+        [ "model": "MediumPhone.arm", "version": "33" ]
+    ]
+    projectId("flank-gradle")
+    flankVersion = "23.10.1"
+    debugApk = "$buildDir/outputs/apk/debug/sample-debug.apk"
+    instrumentationApk = "$buildDir/outputs/apk/androidTest/debug/sample-debug-androidTest.apk"
+    additionalTestApks = [
+        "- app:  $buildDir/outputs/apk/debug/sample-debug.apk",
+        "  test: $buildDir/outputs/apk/androidTest/debug/sample2-debug-androidTest.apk",
+        "- test: ${rootProject.buildDir}/database/module/outputs/apk/database-module-androidTest.apk"
+    ]
+    autoGoogleLogin = true
+    maxTestShards = 8 //or numUniformShards=5 cannot use both.
+    shardTime = 120
+    smartFlankGcsPath = "gs://tmp_flank/flank/test_app_android.xml"
+    configs {
+        oranges {
+            useOrchestrator.set(false)
+            testTargets.set(project.provider { [
+                "class com.osacky.flank.gradle.sample.ExampleInstrumentedTest#runAndFail"
+            ] })
+        }
+    }
+    resultsBucket("my-results-bucket-name")
+    keepFilePath = true
+    runTimout = "45m"
+    ignoreFailedTests = false
+    disableSharding = false
+    smartFlankDisableUpload = false
+    testRunnerClass = "com.foo.TestRunner"
+    localResultsDir = "flank"
+    clientDetails = [
+      "key1": "value1",
+      "key2": "value2"
+    ]
+    testTargetsAlwaysRun = [
+      "com.example.TestSuite#test1",
+      "com.example.TestSuite#test2"
+    ]
+    otherFiles = [
+      "/sdcard/dir1/file1.txt": "/my/example/path/file1.txt",
+      "/sdcard/dir2/file2.txt": "/my/example/path/file2.txt"
+    ]
+    networkProfile = "LTE"
+    roboDirectives = [
+      ["click", "button1", ""],
+      ["ignore", "button2"],
+      ["text", "field1", "my text"],
+    ]
+    outputStyle = 'multi'
+    legacyJunitResult = false
+    fullJunitResult = false
+    additionalApks = [
+      "gs://path/to/app1.apk",
+      "localPath/to/app2.apk"
+    ]
+    defaultTestTime = 5.3
+    defaultClassTestTime = 180.5
+    useAverageTestTimeForNewTests = true
+    disableResultsUpload = true
+    grantPermissions = "none"
+    type = "game-loop"
+    scenarioLabels = [
+      "label1",
+      "label2" 
+    ]
+    scenarioNumbers = [ 1, 23, 52 ]
+    obbFiles = [
+      "local/file/path/test1.obb",
+      "local/file/path/test2.obb"
+    ]
+    obbNames = [
+      "patch.0300110.com.example.android.obb",
+      "patch.0300111.com.example.android.obb"
+    ]
+    testTargetsForShard = [
+      "package com.package1.for.shard1, com.package2.for.shard1",
+      "class com.foo.ClassForShard2#testMethod1, com.foo.ClassForShard2#testMethod2",
+      "class com.foo.ClassForShard3; package com.package.for.shard3"
+    ]
+    failFast = true
+    dependOnAssemble = true
+}
+
+

useOrchestrator

+

Whether or not we should use the android test orchestrator to run this tests. +Set this to true when the build.gradle file includes testOptions.execution 'ANDROID_TEST_ORCHESTRATOR'

+
+
useOrchestrator = true
+
+
+
+
useOrchestrator.set(true)
+
+
+
+

testTargets

+

Set multiple testTargets to be run by Flank. These are used to whitelist or blacklist test classes, test cases and test annotations. +See Google Cloud Firebase docs for more information.

+
+
testTargets = [
+        "class com.osacky.flank.gradle.sample.ExampleInstrumentedTest#seeView"
+]
+
+
+
+
testTargets.set(listOf(
+        "class com.osacky.flank.gradle.sample.ExampleInstrumentedTest#seeView"
+))
+
+
+
+

devices

+

A list of devices to run the tests against. When list is empty, a default device will be used. Each device entry is a map. The valid keys in the map are model, version, orientation, and locale. When a key is not set or is null, a default value will be used.

+
+
devices = [
+        [ "model": "MediumPhone.arm", "version": "26" ],
+        [ "model": "MediumPhone.arm", "version": "33" ]
+]
+
+
+
+
devices.set(listOf(
+    mapOf("model" to "MediumPhone.arm", "version" to "26" ),
+    mapOf("model" to "MediumPhone.arm", "version" to "33" )
+))
+
+
+
+

projectId

+

The projectId is a unique identifier which can be found in the project's URL: https://console.firebase.google.com/project/<projectId> +This is automatically discovered based on the service credential by default.

+
+
projectId = "flank-gradle"
+
+
+
+
projectId.set("flank-gradle")
+
+
+
+

flankVersion

+

Need a different Flank version? Specify it with flankVersion.

+

To use a snapshot:

+
+
flankVersion = "flank_snapshot"`
+
+
+
+
flankVersion.set("flank_snapshot")
+
+
+
+

Need more than 50 shards? Use Flank 8.1.0.

+

To use a different version:

+
+
flankVersion = "23.10.1"
+
+
+
+
flankVersion.set("23.10.1")
+
+
+
+

flankCoordinates

+

Specify custom flank maven coordinates.

+
+
flankCoordinates = "com.github.flank:flank"
+
+
+
+
flankCoordinates.set("com.github.flank:flank")
+
+
+
+

debugApk

+

This is a string representing the path to the app's debug apk. +Supports wildcard characters. +Optional, prefer to set variant.

+
+
debugApk = project.provider { "${buildDir.toString()}/outputs/apk/debug/*.apk" }
+
+
+
+
debugApk.set(project.provider { "${buildDir.toString()}/outputs/apk/debug/*.apk" })
+
+
+
+

instrumentationApk

+

This is a string representing the path to the app's instrumentaiton apk. +Supports wildcard characters. +Optional, prefer to set variant. +InstrumenationApk should not be set when using roboScript.

+
+
instrumentationApk = project.provider { "${buildDir.toString()}/outputs/apk/androidTest/debug/*.apk" }
+
+
+
+
instrumentationApk.set(project.provider { "${buildDir.toString()}/outputs/apk/androidTest/debug/*.apk" })
+
+
+
+

additionalTestApks

+

Paths to additional test configurations. +Order matters. A test apk is run with the nearest previous listed app apk. +For library modules, add them to the list with a - test: in front. For test apks which belong to an application module, add them with test:. +It is not required to list an app apk here. If there is no app apk listed in additionalTestApks, the test apks are run against the debugApk.

+
+
additionalTestApks.value(project.provider { [
+"- app: ../main/app/build/output/apk/debug/app.apk",
+"  test: ../main/app/build/output/apk/androidTest/debug/app-test.apk",
+"- app: ../sample/app/build/output/apk/debug/sample-app.apk",
+"  test: ../sample/app/build/output/apk/androidTest/debug/sample-app-test.apk",
+"- test: ../feature/room/build/output/apk/androidTest/debug/feature-room-test.apk",
+"- test: ../library/databases/build/output/apk/androidTest/debug/sample-databases-test.apk"
+]})
+
+
+
+
additionalTestApks.value(project.provider { listOf(
+"- app: ../main/app/build/output/apk/debug/app.apk",
+"  test: ../main/app/build/output/apk/androidTest/debug/app-test.apk",
+"- app: ../sample/app/build/output/apk/debug/sample-app.apk",
+"  test: ../sample/app/build/output/apk/androidTest/debug/sample-app-test.apk",
+"- test: ../feature/room/build/output/apk/androidTest/debug/feature-room-test.apk",
+"- test: ../library/databases/build/output/apk/androidTest/debug/sample-databases-test.apk"
+)})
+
+
+
+

autoGoogleLogin

+

Whether to automatically log in using a preconfigured google account. More Info

+
+
autoGoogleLogin = false
+
+
+
+
autoGoogleLogin.set(false)
+
+
+
+

environmentVariables

+

Environment variables are mirrored as extra options to the am instrument -e KEY1 VALUE1 … command and passed to your test runner (typically AndroidJUnitRunner). Examples

+
+
environmentVariables = [
+    // Whether or not to remove all shared state from your device's CPU and memory after each test. [More info](https://developer.android.com/training/testing/junit-runner)
+    "clearPackageData": "true"
+]
+
+
+
+
environmentVariables = mapOf(
+    // Whether or not to remove all shared state from your device's CPU and memory after each test. [More info](https://developer.android.com/training/testing/junit-runner)
+    "clearPackageData" to "true"
+)
+
+
+
+

testShards

+
+

Deprecated

+

Use maxTestShards instead.

+
+

The maximum number of shards. Fladle will throw an error when used together with maxTestShards or numUniformShards.

+
+
testShards = 5
+
+
+
+
testShards.set(5)
+
+
+
+

maxTestShards

+

The maximum number of shards. Fladle will throw an error when used together with testShards or numUniformShards.

+
+
maxTestShards = 8
+
+
+
+
maxTestShards.set(8)
+
+
+
+

shardTime

+

The amount of time tests within a shard should take. +When set to > 0, the shard count is dynamically set based on time up to the maximum limit defined by maxTestShards +2 minutes (120) is recommended. +default: -1 (unlimited)

+
+
shardTime = 120
+
+
+
+
shardTime.set(120)
+
+
+
+

repeatTests

+

The number of times to repeat each test. Uses Flank's default value when not specified.

+
+
repeatTests = 1
+
+
+
+
repeatTests.set(1)
+
+
+
+

configs

+

Give a name to a custom flank task and configure its options. The name is appended to the end of the flank task. For example runFlank becomes runFlank<name>.

+
+
configs {
+  repeatOneHundred {
+    // DSL sugar for container elements is missing (= syntax): https://github.com/gradle/gradle/issues/9987
+    repeatTests.set(100)
+  }
+}
+
+
+
+
configs {
+  create("repeatOneHundred") {
+    repeatTests.set(100)
+  }
+}
+
+
+
+

In the above example, the configuration is inherited from the outer fladle config but with the repeatTests property set to 100. Running runFlankRepeateOneHundred will execute this custom configuration.

+

smartFlankGcsPath

+

The cloud storage location for historical test runs. This must be set in order to use smart sharding. The amount of shards used is set by maxTestShards. The bucket (such as flank_data in the example) must already exist in order for it to be used.

+
+
smartFlankGcsPath = 'gs://flank_data/results/JUnitReport.xml'
+
+
+
+
smartFlankGcsPath.set("gs://flank_data/results/JUnitReport.xml")
+
+
+
+

resultsHistoryName

+

The history name for your test results (an arbitrary string label; default: the application's label from the APK manifest). All tests which use the same history name will have their results grouped together in the Firebase console in a time-ordered test history list.

+
+
resultsHistoryName = 'android-history'
+
+
+
+
resultsHistoryName.set("android-history")
+
+
+
+

flakyTestAttempts

+

The number of times to retry failed tests. Default is 0. Max is 10. +Setting the value to 1 will mean that test are retried once. If the test fails then succeeds after the retry the run +will be marked as "successful". The matrix with a flaky test will be marked as flaky.

+
+
flakyTestAttempts = 0
+
+
+
+
flakyTestAttempts.set(0)
+
+
+
+

abi

+

The ABI split of the application that should be tested (e.g. "x86"). Only required if the application under test uses ABI splits and the debug APK is selected automatically (via variant) instead of manually (via debugApk).

+

If the application uses ABI splits, and this property isn't specified, an arbitrary ABI split will be selected.

+
+
abi = "arm64-v8a"
+
+
+
+
abi.set("arm64-v8a")
+
+
+
+

directoriesToPull

+

A list of paths that will be copied from the device's storage to the designated results bucket after the test is complete. These must be absolute paths under /sdcard or /data/local/tmp. Path names are restricted to the characters a-zA-Z0-9_-./+. The paths /sdcard and /data will be made available and treated as implicit path substitutions. E.g. if /sdcard on a particular device does not map to external storage, the system will replace it with the external storage path prefix for that device.

+
+
directoriesToPull = [
+  '/sdcard/tempDir1', '/data/local/tmp/tempDir2'
+]
+
+
+
+
directoriesToPull.set(listOf(
+  "/sdcard/tempDir1", "/data/local/tmp/tempDir2"
+))
+
+
+
+

filesToDownload

+

List of regex that is matched against bucket paths (for example: 2019-01-09_00:13:06.106000_YCKl/shard_0/SmallPhone.arm-28-en-portrait/bugreport.txt) for files to be downloaded after a flank run. The results are downloaded to the APP_MODULE/build/fladle/RESULTS directory where RESULTS can be set by localResultsDir var otherwise defaulting to results/.

+
+
filesToDownload = [
+  '.*/sdcard/tempDir1/.*', '.*/data/local/tmp/tempDir2/.*'
+]
+
+
+
+
filesToDownload.set(listOf(
+  ".*/sdcard/tempDir1/.*", ".*/data/local/tmp/tempDir2/.*"
+))
+
+
+
+

testTimeout

+

The max time test execution can run before it is cancelled (default: 15m). It does not include any time necessary to prepare and clean up the target device. The maximum possible testing time is 45m on physical devices and 60m on virtual devices. The TIMEOUT units can be h, m, or s. If no unit is given, seconds are assumed. +Examples: +* 1h -> 1 hour +* 5m -> 5 minutes +* 200s -> 200 seconds +* 100 -> 100 seconds

+
+
testTimeout = "1h"
+
+
+
+
testTimeout.set("1h")
+
+
+
+

recordVideo

+

Enable video recording during the test. Enabled by default.

+
+
recordVideo = true
+
+
+
+
recordVideo.set(true)
+
+
+
+

performanceMetrics

+

Monitor and record performance metrics: CPU, memory, network usage, and FPS (game-loop only). Enabled by default.

+
+
performanceMetrics = true
+
+
+
+
performanceMetrics.set(true)
+
+
+
+

resultsBucket

+

The name of a Google Cloud Storage bucket where raw test results will be stored.

+
+
resultsBucket = "my-gcs-bucket-name"
+
+
+
+
resultsBucket.set("my-gcs-bucket-name")
+
+
+
+

keepFilePath

+

Keeps the full path of downloaded files from a Google Cloud Storage bucket. Required when file names are not unique. Disabled by default.

+
+
keepFilePath = false
+
+
+
+
keepFilePath.set(false)
+
+
+
+

resultsDir

+

The name of a unique Google Cloud Storage object within the results bucket where raw test results will be stored. The default is a timestamp with a random suffix.

+
+
resultsDir = "result-dir-${getTimeStamp()}"
+
+
+
+
resultsDir.set("result-dir-${getTimeStamp()}")
+
+
+
+

disableSharding

+

Disables sharding. All tests will run on the same device. Useful for parameterized tests which do not support sharding. (default: false)

+
+
disableSharding = false
+
+
+
+
disableSharding.set(false)
+
+
+
+

smartFlankDisableUpload

+

Disables smart flank JUnit XML uploading. Useful for preventing timing data from being updated. (default: false) +What is Smart Flank?

+
+
smartFlankDisableUpload = false
+
+
+
+
smartFlankDisableUpload.set(false)
+
+
+
+

testRunnerClass

+

The fully-qualified Java class name of the instrumentation test runner (default: the test manifest is parsed to determine the class name).

+
+
testRunnerClass = "com.example.MyCustomTestRunner"
+
+
+
+
testRunnerClass.set("com.example.MyCustomTestRunner")
+
+
+
+

localResultsDir

+

The local directory to store the test results. Folder is DELETED before each run to ensure only artifacts from the new run are saved. This directory is relative to the working directory of Flank which is by default build/fladle or build/fladle/<flavorname>.

+
+
localResultsDir = "my-results-dir"
+
+
+
+
localResultsDir.set("my-results-dir")
+
+
+
+

testTargetsAlwaysRun

+

Always run - these tests are inserted at the beginning of every shard. Useful if you need to grant permissions or login before other tests run

+
+
testTargetsAlwaysRun = [
+  'class com.example.MyTestClass'
+]
+
+
+
+
testTargetsAlwaysRun.set(listOf(
+  "class com.example.MyTestClass"
+))
+
+
+
+
+

The flags below are only available with Flank 20.05.0 or higher.

+
+

runTimeout

+

The max time this test run can execute before it is cancelled. s (seconds), m (minutes), h (hours) suffixes are acceptable, mixes like 1h45m are currently not supported (default: unlimited). +Examples:

+
    +
  • 20, 20s -> 20 seconds
    • +
  • 30m -> 30 minutes
    • +
  • 2h -> 2 hours
    • +
+
+
runTimeout = "15m"
+
+
+
+
runTimeout.set("15m")
+
+
+
+

ignoreFailedTests

+

Always return successful task completion even when there are failed tests. Useful when parsing JUnit XML to determine failure. (default: false)

+
+
ignoreFailedTests = false
+
+
+
+
ignoreFailedTests.set(false)
+
+
+
+

numUniformShards

+

Specifies the number of shards into which you want to evenly distribute test cases. The shards are run in parallel on separate devices. For example, if your test execution contains 20 test cases and you specify four shards, each shard executes five test cases. The number of shards should be less than the total number of test cases. The number of shards specified must be >= 1 and <= 50. This option cannot be used along maxTestShards and is not compatible with smart sharding (Smart Flank). If you want to take benefits of smart sharding use maxTestShards instead. (default: null)

+
+
numUniformShards = 50
+
+
+
+
numUniformShards.set(50)
+
+
+
+

clientDetails

+

A key-value map of additional details to attach to the test matrix.(clientDetails in Google Cloud Docs) Arbitrary key-value pairs may be attached to a test matrix to provide additional context about the tests being run. When consuming the test results, such as in Cloud Functions or a CI system, these details can add additional context such as a link to the corresponding pull request. (Access Client Details). +These can be used to provide additional context about the environment where the tests are being run.

+
+
clientDetails = [
+    "test-type": "PR",
+    "build-number": "132"
+]
+
+
+
+
clientDetails.set(mapOf(
+    "test-type" to "PR",
+    "build-number" to "132"
+))
+
+
+
+

otherFiles

+

A list of device-path: file-path pairs that indicate the device paths to push files to the device before starting tests, and the paths of files to push. Device paths must be under absolute, whitelisted paths (${EXTERNAL_STORAGE}, or ${ANDROID_DATA}/local/tmp). Source file paths may be in the local filesystem or in Google Cloud Storage (gs://…).

+
+
otherFiles = [
+    "/sdcard/dir1/file1.txt": "local/file.txt",
+    "/sdcard/dir2/file2.jpg": "gs://bucket/file.jpg",
+]
+
+
+
+
otherFiles.set(mapOf(
+    "/sdcard/dir1/file1.txt" to "local/file.txt",
+    "/sdcard/dir2/file2.jpg" to "gs://bucket/file.jpg",
+))
+
+
+
+

networkProfile

+

The name of the network traffic profile, for example LTE, HSPA, etc, which consists of a set of parameters to emulate network conditions when running the test (default: no network shaping; see available profiles listed by the flank test network-profiles list command). This feature only works on physical devices.

+
+
networkProfile = "LTE"
+
+
+
+
networkProfile.set("LTE")
+
+
+
+

roboScript

+

The path to a Robo Script JSON file. The path may be in the local filesystem or in Google Cloud Storage using gs:// notation. You can guide the Robo test to perform specific actions by recording a Robo Script in Android Studio and then specifying this argument. Learn more at DOCS.

+
+
roboScript = "my-robo-script.json"
+
+
+
+
roboScript.set("my-robo-script.json")
+
+
+
+

roboDirectives

+

List of robo_directives that you can use to customize the behavior of Robo test. The type specifies the action type of the directive, which may take on values click, text or ignore. Each directive is list of String = [type, key, value]. Each key should be the Android resource name of a target UI element and each value should be the text input for that element. Values are only permitted for text type elements, so no value should be specified for click and ignore type elements.

+
+
roboDirectives = [
+    ["test, "input_resource_name", "message"],
+    ["click, "button_resource_name", ""],
+]
+
+
+
+
roboDirectives.set(listOf(
+    listOf("test", "input_resource_name", "message"),
+    listOf("click", "button_resource_name", ""),
+))
+
+
+
+

outputStyle

+

Output style of execution status. May be one of [verbose, multi, single]. +For runs with only one test execution the default value is 'verbose', in other cases 'multi' is used as the default. The output style 'multi' is not displayed correctly on consoles which don't support ANSI codes, to avoid corrupted output use single or verbose.

+

multi displays separated status for each shard execution in separated line, lines are updated over time. Similar to gradle output when running multiple tasks in parallel. Requires ANSI codes support.

+

single displays shortened status of all executions in single line. Similar to gcloud output when running with sharding. Should work on any console.

+

Default value is single.

+
+
outputSyle = "single"
+
+
+
+
outputStyle.set("single")
+
+
+
+

legacyJunitResult

+

Flank provides two ways for parsing junit xml results. +New way uses google api instead of merging xml files, but can generate slightly different output format. +This flag allows fallback for legacy xml junit results parsing

+
+
legacyJunitResult = false
+
+
+
+
legacyJunitResult.set(false)
+
+
+
+

fullJunitResult

+

Enables creating an additional local junit result on local storage with failure nodes on passed flaky tests.

+
+
fullJunitResult = false
+
+
+
+
fullJunitResult.set(false)
+
+
+
+

sanityRobo

+

Runs a sanityRobo test. +instrumentationApk, roboDirectives, roboScript and additionalTestApks must be blank or empty.

+
+
sanityRobo = true
+
+
+
+
sanityRobo.set(true)
+
+
+
+

defaultTestTime

+

Set default test time expressed in seconds, used for calculating shards. (default: 120.0s)

+
+
defaultTestTime = 1.2
+
+
+
+
defaultTestTime.set(1.2)
+
+
+
+

defaultClassTestTime

+

Set default parameterized class test time expressed in seconds, used for calculating shards. (default: 2x defaultTestTime => 240s)

+
+
defaultClassTestTime = 245.5
+
+
+
+
defaultClassTestTime.set(245,5)
+
+
+
+

additionalApks

+

A list of up to 100 additional APKs to install, in addition to those being directly tested. The path may be in the local filesystem or in Google Cloud Storage using gs:// notation.

+
+
additionalApks = [
+  "gs://path/to/app1.apk",
+  "localPath/to/app2.apk"
+]
+
+
+
+
additionalApks.set(
+  project.provider {
+    listOf("gs://path/to/app1.apk", "localPath/to/app2.apk")
+  }
+)
+
+
+
+

useAverageTestTimeForNewTests

+

Enable using average time from previous tests duration when using SmartShard and tests did not run before. (default: false)

+
+
useAverageTestTimeForNewTests = true
+
+
+
+
useAverageTestTimeForNewTests.set(true)
+
+
+
+

disableResultsUpload

+

Disable flank results upload on gcloud storage. (default: false)

+
+
disableResultsUpload = true
+
+
+
+
disableResultsUpload.set(true)
+
+
+
+

testTargetsForShard

+

Specifies a group of packages, classes, and/or test cases to run in each shard (a group of test cases). +The shards are run in parallel on separate devices. You can use this option up to 50 times to specify multiple shards when one or more physical devices are selected, +or up to 500 times when no physical devices are selected. +Note: If you include the flags environmentVariables or testTargets when running testTargetsForShard, the flags are applied to all the shards you create. +You can also specify multiple packages, classes, or test cases in the same shard by separating each item with a comma. +To specify both package and class in the same shard, separate package and class with semi-colons.

+
+
testTargetsForShard = [
+  "package com.package1.for.shard1, com.package2.for.shard1",
+  "class com.foo.ClassForShard2#testMethod1, com.foo.ClassForShard2#testMethod2",
+  "class com.foo.ClassForShard3; package com.package.for.shard3"
+  ]
+
+
+
+
testTargetsForShard.set(
+  project.provider {
+    listOf(
+      "package com.package1.for.shard1, com.package2.for.shard1",
+      "class com.foo.ClassForShard2#testMethod1, com.foo.ClassForShard2#testMethod2",
+      "class com.foo.ClassForShard3; package com.package.for.shard3"
+    )
+  }
+)
+
+
+
+

grantPermissions

+

Whether to grant runtime permissions on the device before the test begins. By default, all permissions are granted. PERMISSIONS must be one of: all, none

+
+
grantPermissions = "none"
+
+
+
+
grantPermissions.set("none")
+
+
+
+

type

+

The type of test to run. TYPE must be one of: instrumentation, robo, game-loop. Use if you want to be sure there is only one type of tests being run (flank enables to run mixed types of test in one run).

+
+
type = "game-loop"
+
+
+
+
type.set("game-loop")
+
+
+
+

scenarioLabels

+

A list of game-loop scenario labels (default: None). Each game-loop scenario may be labeled in the APK manifest file with one or more arbitrary strings, creating logical groupings (e.g. GPU_COMPATIBILITY_TESTS). +If --scenario-numbers and --scenario-labels are specified together, Firebase Test Lab will first execute each scenario from --scenario-numbers. +It will then expand each given scenario label into a list of scenario numbers marked with that label, and execute those scenarios.

+
+
scenarioLabels = [
+  "label1",
+  "label2" 
+]
+
+
+
+
scenarioLabels.set(
+  project.provider {
+    listOf("label1", "label2")
+  }
+)
+
+
+
+

scenarioNumbers

+

A list of game-loop scenario numbers which will be run as part of the test (default: all scenarios). +A maximum of 1024 scenarios may be specified in one test matrix, but the maximum number may also be limited by the overall test --timeout setting.

+
+
scenarioNumbers = [ 1, 23, 52 ]
+
+
+
+
scenarioNumbers.set(
+  project.provider {
+    listOf(1, 23, 52)
+  }
+)
+
+
+
+

obbFiles

+

A list of one or two Android OBB file names which will be copied to each test device before the tests will run (default: None). +Each OBB file name must conform to the format as specified by Android (e.g. [main|patch].0300110.com.example.android.obb) and will be installed into <shared-storage>/Android/obb/<package-name>/ on the test device.

+
+
obbFiles = [
+  "local/file/path/test1.obb",
+  "local/file/path/test2.obb"
+]
+
+
+
+
obbFiles.set(
+  project.provider {
+    listOf(
+      "local/file/path/test1.obb",
+      "local/file/path/test2.obb"
+    )
+  }
+)
+
+
+
+

obbNames

+

A list of OBB required filenames. OBB file name must conform to the format as specified by Android e.g. +[main|patch].0300110.com.example.android.obb which will be installed into <shared-storage>/Android/obb/<package-name>/ on the device.

+
+
obbNames = [
+  "patch.0300110.com.example.android.obb",
+  "patch.0300111.com.example.android.obb"
+]
+
+
+
+
obbNames.set(
+  project.provider {
+    listOf(
+      "patch.0300110.com.example.android.obb",
+      "patch.0300111.com.example.android.obb"
+    )
+  }
+)
+
+
+
+

failFast

+

If true, only a single attempt at most will be made to run each execution/shard in the matrix. Flaky test attempts are not affected. +Normally, 2 or more attempts are made if a potential infrastructure issue is detected. +This feature is for latency sensitive workloads. The incidence of execution failures may be significantly greater for +fail-fast matrices and support is more limited because of that expectation.

+
+
failFast = true
+
+
+
+
failFast.set(true)
+
+
+
+

additionalFlankOptions

+

Appending additional option to flank root yaml. This option is useful when you would like to test options before official fladle support is added. +Multiple options are supported.

+

Single option

+
+
additionalFlankOptions = "new-property: true"
+
+
+
+
additionalFlankOptions.set("new-property: true")
+
+
+
+

Multiple options

+
+
additionalFlankOptions = """
+  new-property: true
+  other-new-property: force
+""".stripIndent()
+
+
+
+
additionalFlankOptions.set("""
+    new-property: true
+    other-new-property: force
+""".trimIndent())
+
+
+
+

additionalGcloudOptions

+

Allow appending additional config to gcloud root yaml. This option is useful when you would like to test option +before it is available on Fladle. Supports both single and multiple properties.

+

Single option

+
+
additionalGcloudOptions = "new-property: true"
+
+
+
+
additionalGcloudOptions.set("new-property: true")
+
+
+
+

Multiple options

+
+
additionalGcloudOptions = """
+    new-property: true
+    other-new-property: force
+  """.stripIndent()
+
+
+
+
additionalGcloudOptions.set("""
+    new-property: true
+    other-new-property: force
+""".trimIndent())
+
+
+
+

dependOnAssemble

+

Enable to automatically build the app and test APKs before runFlank executes. (default: false)

+
+
dependOnAssemble = true
+
+
+
+
dependOnAssemble.set(true)
+
+
+
+

async

+

Enable to return immediately after invoking tests, without waiting for results. (default: false)

+
+
async = true
+
+
+
+
async.set(true)
+
+
+
+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/faq/index.html b/faq/index.html new file mode 100644 index 00000000..2a4f4231 --- /dev/null +++ b/faq/index.html @@ -0,0 +1,571 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + FAQ - Fladle + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

FAQ

+

Error APK file not found

+

The app APK and the instrumentation APK are expected to have already been generated before calling runFlank. To generate APKs, run assembleDebug and assembleDebugAndroidTest before running runFlank.

+

You can also have Fladle build them for you by using the dependOnAssemble property.

+

No signature of method

+

If you receive an error like this, it is likely caused by invalid fladle extension confiuration. +The syntax was changed in the 0.9.X releases in order to avoid touching files during the configuration phase. +

No signature of method: flank_4vvjv7w3oopge32w1tl9cs6e4.fladle() is applicable for argument types: (flank_4vvjv7w3oopge32w1tl9cs6e4$_run_closure1) values: [flank_4vvjv7w3oopge32w1tl9cs6e4$_run_closure1@649a2315]
+            Possible solutions: file(java.lang.Object), find(), findAll(), file(java.lang.Object, org.gradle.api.PathValidation), files([Ljava.lang.Object;), findAll(groovy.lang.Closure)
+

+

If you receive a similar error, please check configuration for a sample configuration.

+

Debugging

+

./gradlew runFlank -PdumpShards Will dump shards and exit the process without running the tests.

+

./gradlew printYml Will print out the current yaml configuration to be passed to Flank.

+

More help?

+

Still having trouble? Check the #flank channel in the Firebase Community Slack

+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 00000000..3b28cdb9 --- /dev/null +++ b/index.html @@ -0,0 +1,584 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Fladle + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Welcome to Fladle

+

Github Actions

+

The Gradle Plugin for Firebase Test Lab and Flank.

+

Fladle is the easiest way to scale your instrumentation tests using Firebase Test Lab. Apply the gradle plugin and runFlank! You can easily run many hours of instrumentation tests using hundreds of devices in Test Lab and get the results in just few minutes. Fladle simplifies the configuration necessary to scale your tests using Firebase Test Lab and Flank.

+

Fladle is mentioned in Fragmented Podcast #163. Skip to ~29 minutes.

+

New? Get Started Here

+

Flank

+

Flank is a parallel test runner for Firebase Test Lab.

+

Also read this medium post.

+

Corporate Sponsors

+

Thank you Doist for your sponsorship!

+

Doist

+

Sponsor Fladle!

+

Trusted by

+

The following companies test their Android app using Fladle.

+

SoundCloud Zalando Robinhood +Yelp Salesforce Dropbox +ImmoScout24 GrubHub

+

Want to appear here? File an issue or open a PR

+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/multi-module-testing/index.html b/multi-module-testing/index.html new file mode 100644 index 00000000..2880f1f9 --- /dev/null +++ b/multi-module-testing/index.html @@ -0,0 +1,706 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Multi Module Testing - Fladle + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Multi-module testing

+

Multi module testing can be done by manually specifying additionalTestApks or applying the Fulladle plugin to automacally gather all the additional test apks. See also this article for a full setup and instructions including integration with CI.

+

Fulladle Plugin

+
    +
  1. +

    Apply the Fulladle plugin at the root of the project.

    +
    +
    plugins {
+    id 'com.osacky.fulladle' version '0.20.0'
+}
+
    +
    +
    +
    plugins {
+    id("com.osacky.fulladle") version "0.20.0"
+}
+
    +
    +
    +
    2. +
  2. +

    Configure the Fladle extension.

    +
    +
    fladle {
+    serviceAccountCredentials = project.layout.projectDirectory.file("flank-gradle-service-account.json")
+}
+
    +
    +
    +
    fladle {
+    serviceAccountCredentials.set(project.layout.projectDirectory.file("flank-gradle-service-account.json"))
+}
+
    +
    +
    +
    +

    Warning

    +

    If using buildFlavors or testing against a non default variant, you will need to specify the variant you want to test in the fulladleModuleConfig block.

    +
    +
    3. +
  3. +

    Run the tests. + First assemble all your debug apks and test apks. + 

    ./gradlew assembleDebug assembleDebugAndroidTest
+

    +
    +

    Note

    +

    When using flavors, make sure to assemble your buildVariants as well.

    +

    ./gradlew :app:assembleFreeDebug :app:assembleFreeDebugAndroidTest

    +
    +

    Run Flank! +

    ./gradlew runFlank
+

    +
    4. +
+

Overriding configurations in modules

+

Fulladle will pick Flank configurations from the fladle block in the root build.gradle file. You may want to override some of these configurations for certain modules, you can add the following block to any Android library module to override its configurations:

+
+
fulladleModuleConfig {
+  clientDetails = [
+      "test-type": "PR",
+      "build-number": "132"
+  ]
+  maxTestShards = 3
+  environmentVariables = [
+      "clearPackageData": "true"
+  ]
+  debugApk = "app.apk"
+  variant = "vanillaDebug"
+}
+
+
+
+
fulladleModuleConfig {
+  clientDetails.set(mapOf(
+    "test-type" to "PR",
+    "build-number" to "132",
+  ))
+  maxTestShards.set(3)
+  environmentVariables.set(mapOf(
+    "clearPackageData" to "true"
+  ))
+  debugApk.set("app.apk")
+  variant.set("vanillaDebug")
+}
+
+
+
+

All of the above configurations are optional, Flank will default to the top-level configurations if you don't override anything here. For details about these configurations, refer to configuration docs.

+

Disabling a module

+

You may want to exclude a library module from testing when using Fulladle. You can do so by setting the enabled configuration in the module's fulladleModuleConfig block like so:

+
+
fulladleModuleConfig {
+  enabled = false
+}
+
+
+
+
fulladleModuleConfig {
+  enabled.set(false)
+}
+
+
+
+

Overriding root-level config

+

Fulladle does not provide the ability to control which module ends up as the root-level module or as an additional module. Either one of app modules or library modules can become a root-level module. If a library module ends up as a root-level module, it needs to specify a debugApk in its fladle or fulladleModuleConfig block.

+

The root-level configuration (e.g. maxTestShards) can also be overridden in the fulladleModuleConfig block of whatever module gets picked as the root module.

+

Troubleshooting

+

Fulladle might still have some rough edges, but we'd love feedback. Please join us in the Firebase Community Slack with any feedback you may have. +You can also file Fladle Github issues.

+

When filing a bug report, please include the Flank version number, the Fladle version number and the output of the following:

+

./gradlew printYml

+

./gradlew runFlank -PdumpShards

+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/quick-start/index.html b/quick-start/index.html new file mode 100644 index 00000000..c2518f41 --- /dev/null +++ b/quick-start/index.html @@ -0,0 +1,527 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Quick Start - Fladle + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Quick Start

+

Using Fladle takes 3 steps:

+
    +
  1. +

    Apply the Fladle plugin. Follow instructions here

    +

    Root build.gradle

    +
    +
    buildscript {
+  dependencies {
+    classpath "com.osacky.flank.gradle:fladle:0.20.0"
+  }
+}
+
    +
    +
    +
    buildscript {
+  dependencies {
+    classpath("com.osacky.flank.gradle:fladle:0.20.0")
+  }
+}
+
    +
    +
    +

    Application module build.gradle

    +
    +
    apply plugin: "com.android.application"
+apply plugin: "com.osacky.fladle"
+
    +
    +
    +
    plugins {
+    id ("com.android.application")
+    id ("com.osacky.fladle")
+}
+
    +
    +
    +
    2. +
  2. +

    Configure Authentication using these steps.

    +
    +

    Warning

    +

    If using buildFlavors or testing against a non default variant, variant must also configured

    +
    +
    3. +
  3. +

    Run your tests!

    +

    First assemble your debug apk and test apk. +

    ./gradlew :app:assembleDebug :app:assembleDebugAndroidTest
+

    +
    +

    Note

    +

    When using flavors, make sure to assemble your buildVariants.

    +

    ./gradlew :app:assembleFreeDebug :app:assembleFreeDebugAndroidTest

    +
    +

    Run Flank! +

    ./gradlew runFlank
+

    +
    4. +
+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/recipes/index.html b/recipes/index.html new file mode 100644 index 00000000..22650ace --- /dev/null +++ b/recipes/index.html @@ -0,0 +1,630 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Recipes - Fladle + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Recipes

+

Here are some recipes to use to achieve various goals in flank. For additional recipes or suggestions, please file an +issue on Github.

+

Smartly shard tests in 120 second shards across a maximum of 50 shards.

+

This recipe will keep track of test durations automatically on firebase test lab and try to split up test runs in to 120 second shards up to maximum of 50 shards.

+
+
fladle {
+    maxTestShards = 50
+    shardTime = 120
+    smartFlankGcsPath = "gs://fladle-results/smart-flank/JUnitReport.xml"
+}
+
+
+
+
fladle {
+    maxTestShards.set(50)
+    shardTime.set(120)
+    smartFlankGcsPath.set("gs://fladle-results/smart-flank/JUnitReport.xml")
+}
+
+
+
+

Run different tests on different devices with different Gradle tasks.

+

./gradlew runFlankPerfTests will execute the performance tests against a MediumPhone.arm +./gradlew runFlankRegresssionTests will execute the regressions tests against a SmallPhone.arm

+
+
fladle {
+    configs {
+        perfTests {
+            devices.set([
+                ["model" : "MediumPhone.arm", "version" : "28"], 
+                ["model" : "MediumPhone.arm", "version" : "28"]
+            ])
+            testTargets.set([
+                    "class com.sample.MyPerformanceTest"
+            ])
+        }
+        regressionTests {
+            devices.set([
+                [ "model" : "SmallPhone.arm", "version" : "28"]
+            ])
+            testTargets.set([
+                "class com.sample.MyRegressionTest"
+            ])
+        }
+    }
+}
+
+
+
+
fladle {
+    configs {
+        create("perfTests") {
+            devices.set(listOf(
+                mapOf("model" to "MediumPhone.arm", "version" to "28" ), 
+                mapOf("model" to "MediumPhone.arm", "version" to "28")
+            ))
+            testTargets.set(listOf(
+                "class com.sample.MyPerformanceTest"
+            ))
+        }
+        create("regressionTests") {
+            devices.set(listOf(
+                mapOf("model" to "SmallPhone.arm", "version" to "28" )
+            ))
+            testTargets.set(listOf(
+                "class com.sample.MyRegressionTest"
+            ))
+        }
+    }
+}
+
+
+
+

Always use the latest version of Flank

+

Use Gradle's dynamic version syntax to declare a dynamic version.

+
+

Warning

+

Dynamic versions lead to non-reproducible builds since Gradle will check for new versions periodically based on how long versions are cached.

+
+
+
flankVersion = "23.+"
+
+
+
+
flankVersion.set("23.+")
+
+
+
+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/releasing/index.html b/releasing/index.html new file mode 100644 index 00000000..74ed52ad --- /dev/null +++ b/releasing/index.html @@ -0,0 +1,541 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Releasing - Fladle + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Releasing

+
    +
  • +

    Create a local release branch from master +

    git checkout master
+git pull
+git checkout -b release_0.20.1
+

    +
    • +
  • +

    Update version in fladle-plugin/build.gradle.kts (remove -SNAPSHOT) +

    version = "0.20.1"
+

    +
    • +
  • +

    Update the current version and next version in mkdocs.yml: +

    extra:
+  fladle:
+    release: '0.20.1'
+    next_release: 'REPLACE_WITH_NEXT_VERSION_NUMBER'
+

    +
    • +
  • +

    Take one last look +

    git diff
+

    +
    • +
  • +

    Commit all local changes +

    git commit -am "Prepare 0.20.1 release"
+

    +
    • +
  • +

    Create a tag and push it +

    git tag v0.20.1
+git push origin v0.20.1
+

    +
    • +
+

Pushing the tag automatically triggers the release workflow which:

+
    +
  1. Publishes to Maven Central
    2. +
  2. Publishes to Gradle Plugin Portal
    3. +
  3. +

    Creates a GitHub Release with auto-generated notes

    +
    4. +
  4. +

    Release to Maven Central

    + +
    5. +
  5. +

    Merge the release branch to master +

    git checkout master
+git pull
+git merge --no-ff release_0.20.1
+

    +
    6. +
  6. +

    Update version in fladle-plugin/build.gradle.kts (increase version and add -SNAPSHOT) +

    version = "REPLACE_WITH_NEXT_VERSION_NUMBER-SNAPSHOT"
+

    +
    7. +
  7. +

    Commit your changes +

    git commit -am "Prepare for next development iteration"
+

    +
    8. +
  8. +

    Push your changes +

    git push
+

    +
    9. +
+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/results/index.html b/results/index.html new file mode 100644 index 00000000..57133f48 --- /dev/null +++ b/results/index.html @@ -0,0 +1,472 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Results - Fladle + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Results

+

By default, results are placed in the build/fladle/results/<matrix name> directly.

+

A merged junit report is available in JUnitReport.xml

+

On failures only, an html report with links to failed shards is also generated in the results directory with the name HtmlErrorReport.html.

+

A cost report is also available CostReport.txt.

+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/search/search_index.json b/search/search_index.json new file mode 100644 index 00000000..7a94e455 --- /dev/null +++ b/search/search_index.json @@ -0,0 +1 @@ +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Welcome to Fladle","text":"

The Gradle Plugin for Firebase Test Lab and Flank.

Fladle is the easiest way to scale your instrumentation tests using Firebase Test Lab. Apply the gradle plugin and runFlank! You can easily run many hours of instrumentation tests using hundreds of devices in Test Lab and get the results in just few minutes. Fladle simplifies the configuration necessary to scale your tests using Firebase Test Lab and Flank.

Fladle is mentioned in Fragmented Podcast #163. Skip to ~29 minutes.

"},{"location":"#new-get-started-here","title":"New? Get Started Here","text":""},{"location":"#flank","title":"Flank","text":"

Flank is a parallel test runner for Firebase Test Lab.

Also read this medium post.

"},{"location":"#corporate-sponsors","title":"Corporate Sponsors","text":"

Thank you Doist for your sponsorship!

Sponsor Fladle!

"},{"location":"#trusted-by","title":"Trusted by","text":"

The following companies test their Android app using Fladle.

Want to appear here? File an issue or open a PR

"},{"location":"authentication/","title":"Authentication","text":"

There are two authentication mechanisms for using Fladle.

It is recommended to use user authentication on local development machines to avoid sharing credentials and a service account on CI.

"},{"location":"authentication/#user-authentication","title":"User authentication","text":"

Credentials are stored in ~/.flank.

  1. ./gradlew flankAuth
  2. Sign in to web browser.
  3. Specify projectId in fladle configuration
  4. ./gradlew runFlank
"},{"location":"authentication/#service-account-credentials","title":"Service account credentials","text":"

  1. Create a service account. Service accounts aren't subject to spam checks or captcha prompts, which could otherwise block your CI builds. Create a service account with an Editor role in the Google Cloud Platform console.

  2. Enable required APIs. After logging in using the service account: In the Google Developers Console API Library page, enable the Google Cloud Testing API and Cloud Tool Results API. To enable these APIs, type these API names into the search box at the top of the console, and then click Enable API on the overview page for that API.

  3. After creating the account go to Keys, click Add Key -> Create a new Key. Select JSON for the key type. This will download the json credentials.

  4. Configure the Fladle extension serviceAccountCredentials to point to the credentials.

Above instructions are based on Google instruction for authenticating with CI.

See also Flank's instructions for authenticating with a service account.

"},{"location":"changelog/","title":"Changelog","text":""},{"location":"changelog/#unreleased","title":"Unreleased","text":""},{"location":"changelog/#0210","title":"0.21.0","text":"
  • Minimum required Gradle version is now 9.1
  • Fixed support for Android Gradle Plugin version 9.0.1
"},{"location":"changelog/#0200","title":"0.20.0","text":"
  • Botched release. Do not use.
"},{"location":"changelog/#0190","title":"0.19.0","text":"
  • Minimum required JVM version is now 17.
  • Minimum supported Gradle version is now 7.3.
  • Fix support for Gradle 9.0.0. PR Thanks kevinguitar
"},{"location":"changelog/#0180","title":"0.18.0","text":"
  • Use non-deprecated device models and versions in default config. PR Thanks Kaibolay
"},{"location":"changelog/#0175","title":"0.17.5","text":"
  • Support Develocity JUnit XML Reporting PR Thanks ZacSweers
  • Min supported Gradle version is now 6.5
  • Updated Flank version to 23.10.1 *
"},{"location":"changelog/#0174","title":"0.17.4","text":"
  • Add support for additionalTestApks in YamlConfigWriterTask. PR. Thanks ZacSweers
  • Add abi option to support selecting a particular debug APK in projects that use ABI splits to produce multiple APKs. PR
"},{"location":"changelog/#0172","title":"0.17.2","text":"
  • Fix configuration cache support.
"},{"location":"changelog/#0170","title":"0.17.0","text":"
  • Fix quotes around environment variables and formatting issues.
"},{"location":"changelog/#0163","title":"0.16.3","text":"
  • Remove deprecation warning using main in JavaExec task.
  • Conditionally declare outputs on FlankExecutionTask and mark as not up-to-date. PR
  • Fix environmentVariables not passed to flank.yml PR Thanks Sinan
"},{"location":"changelog/#0162","title":"0.16.2","text":"
  • Fix crash accessing TestedExtension in non-android modules PR Thanks asadsalman
"},{"location":"changelog/#0161","title":"0.16.1","text":"
  • Treat app and library modules the same in Fulladle PR Thanks asadsalman
  • Added fulladleModuleConfig to app modules PR

Breaking API Change

Previously, only app modules could be picked up as root-level modules in Fulladle. This has changed, now either app or library modules can be picked up (though we try app modules first). If a library module is picked up as a the root-level module, it must specifiy a debugApk through either the root fladle block or the module's own fulladleModuleConfig block.

"},{"location":"changelog/#0160","title":"0.16.0","text":"
  • Allow excluding modules from Fulladle PR
  • Allow configuring extra parameters on additionalTestApks PR
"},{"location":"changelog/#0151","title":"0.15.1","text":"
  • Allow Flank snapshot usage PR Thanks AndrewReitz
  • Fix incorrect task group name. PR
  • Snapshots are now compatible with java 8 PR
  • Configuration validation happens at task execution time. Fixes #239
  • Configure assemble dependency per variant. Fixes #233
  • Add required smartFlankGcsPath to samples Fixes #236
"},{"location":"changelog/#0150","title":"0.15.0","text":"
  • Add support for async flag. PR.
  • Add flag for depending on assembling of debug apk and instrumentation apk automatically. dependOnAssemble PR Thanks asadsalman
  • Gradle 7.0 Compatibility
"},{"location":"changelog/#0141","title":"0.14.1","text":"
  • Support new Flank options without updating Fladle Fixes #146 PR Thanks piotradamczyk5
"},{"location":"changelog/#0140","title":"0.14.0","text":"
  • Bump Flank version to 21.01.1
  • Add support for test-targets-for-shard Fixes #205
  • Add support for new flank options PR#211 Thanks pawelpasterz
  • Deprecate testShards Fixes #204 PR#212 Thanks pawelpasterz
  • Write test results into a config-specific directory PR#194 Thanks pawelpasterz
"},{"location":"changelog/#0131","title":"0.13.1","text":"
  • Fix flankAuth task throwing exception. Fixes #195
  • Add support for newly added flank options PR#186 Thanks pawelpasterz:
    • default-test-time
    • default-class-test-time
    • additional-apks
    • use-average-test-time-for-new-tests
    • disable-results-upload
"},{"location":"changelog/#0130","title":"0.13.0","text":"
  • Add support for sanityRobo tests Fixes #165 PR Thanks pawelpasterz
  • Add support for user authentication.
  • Bump Flank to 20.09.3

Breaking API Change

Use lazy properties Fixes #92 PR Thanks pawelpasterz

"},{"location":"changelog/#0121","title":"0.12.1","text":"
  • Don't override debug or instrumentation apk if already specified. Fixes #172.
"},{"location":"changelog/#0120","title":"0.12.0","text":"
  • Don't override property values in individual configurations. Fixes #158.
  • Update Flank to 20.08.3.
  • Use Github actions instead of CircleCI
  • Write Yaml file to task specific output directory and add up-to-date checks. #159 Fixes #147 Thanks CristianGM
  • Add support for full-junit-result and legacy-junit-result. #170 Fixes #157. Thanks MatthewTPage
"},{"location":"changelog/#0110","title":"0.11.0","text":"
  • Update Flank to 20.07.0.
  • Only add additional-test-apks for modules that have tests. PR
  • Experimental configuration caching support. PR1PR2
"},{"location":"changelog/#0102","title":"0.10.2","text":"
  • Update Flank to 20.06.2.
  • Fix duplicated status messages in console. PR Thanks francescocervone

Breaking API change

Add time units for timeout. timeoutMin has been renamed to testTimeout. PR Thanks pawelpasterz

"},{"location":"changelog/#0101","title":"0.10.1","text":"
  • [Fix] Allow for specifying roboScript without specifying instrumentationApk. Fixes #128.
"},{"location":"changelog/#0100","title":"0.10.0","text":"
  • Allow for debugging using --dump-shards
  • Fix naming for variant discovery of apk and instrumentation apk. Instead of chocolate-debug, variant must now be set as chocolateDebug.
  • Update Flank to 20.05.2.
  • Fulladle Preview

Breaking API Change

additionalTestApks now uses ListProperty instead of the previous Map. This is to allow for lazy configuration of the provided files.

Warning

Minimum supported Gradle version is now 5.4.

"},{"location":"changelog/#094","title":"0.9.4","text":"
  • Update Flank to 20.05.1. Huge new release!
  • Add support for new flank flags. Thanks pawelpasterz PR
  • Use compileOnly for AGP version.
"},{"location":"changelog/#092","title":"0.9.2","text":"

Breaking API change

debugApk and instrumentationApk now use Lazy Property API to avoid resolving at configuration time.

"},{"location":"changelog/#091","title":"0.9.1","text":"
  • Bugfix: ability to set flank version. PR

Breaking API Change

serviceAccountCredentials now uses Lazy Property API. See Configuration for details on how to set it. PR

Warning

Minimum required Gradle Version is now 5.1.

Warning

Dropped support for Flank 7.X and lower.

"},{"location":"changelog/#090","title":"0.9.0","text":"
  • Do not add flank maven repo. PR
  • Allow specifying custom flank coordinates. PR
  • Change ordering and use file provider. PR
"},{"location":"changelog/#081","title":"0.8.1","text":"
  • Add support for additionalTestApks. PR Thanks japplin.
  • Add support for resultsDir. PR
"},{"location":"changelog/#080","title":"0.8.0","text":"
  • BREAKING: devices now takes a List<Map<String, String>> instead of a List<Device>. See the [#README.md] for an example. PR Thanks zlippard.
  • Add support for keep-file-path. PR Thanks tahirhajizada.
"},{"location":"changelog/#070","title":"0.7.0","text":"
  • Add support for Flank 8 and bump version. PR Thanks francescocervone
"},{"location":"changelog/#067","title":"0.6.7","text":"
  • Allow using wildcards in debugApk or instrumentationApk path by not checking that file exists. PR
"},{"location":"changelog/#066","title":"0.6.6","text":"
  • Bump flank version to 7.0.0
  • Publish to mavenCentral()
"},{"location":"changelog/#065","title":"0.6.5","text":"
  • Add support for results-bucket gcloud config option. PR Thanks c-moss
  • Default flank version 6.2.3
  • Lower build logging level
"},{"location":"changelog/#064","title":"0.6.4","text":"
  • Allow setting android version number as string to allow for preview versions. PRThanks JeroenMols.
"},{"location":"changelog/#063","title":"0.6.3","text":"
  • Allow service credentials to be set using environment variables. Fixes #55
  • Fix not being able to set flankVersion. Fixes #56
"},{"location":"changelog/#062","title":"0.6.2","text":"
  • Fix shardTime config property not written to flank.yml Thanks nnoel-grubhub
"},{"location":"changelog/#061","title":"0.6.1","text":"
  • Fix project id spacing Thanks andersu for reporting.
"},{"location":"changelog/#060","title":"0.6.0","text":"
  • Default flank version 5.0.1
  • Rename yaml output to match new flank version.
  • Add support for shard time.
"},{"location":"changelog/#052","title":"0.5.2","text":"
  • Improve error messages for missing arguments in the fladle extension.
"},{"location":"changelog/#051","title":"0.5.1","text":"
  • Test multipleconfig to actually write yml Thanks PR winterDroid.
  • JavaExec uses classpath instead of jar directly. Thanks PR winterDroid.
"},{"location":"changelog/#050","title":"0.5.0","text":"
  • Use flank as a maven artifact.
  • Group Fladle Tasks
"},{"location":"changelog/#041","title":"0.4.1","text":"
  • Detect AndroidX test orchestrator
  • Fix detection of debug and instrumentation apk paths.
"},{"location":"changelog/#040","title":"0.4.0","text":"
  • Add support for all configuration options. Thanks PR winterDroid.
"},{"location":"changelog/#breaking-changes","title":"Breaking Changes:","text":"

Previous users of clearPackageData = true will now need to use: 

environmentVariables = [\n  \"clearPackageData\": \"true\"\n]\n

"},{"location":"changelog/#038","title":"0.3.8","text":"
  • Fix broken flakyTestAttempts.
"},{"location":"changelog/#037","title":"0.3.7","text":"
  • Add support for flakyTestAttempts.
"},{"location":"changelog/#036","title":"0.3.6","text":"
  • Add support for environment variable clearPackageData. Thanks @anderssu !
"},{"location":"changelog/#035","title":"0.3.5","text":"
  • Automatically configure the use of test orchestrator.
"},{"location":"changelog/#034","title":"0.3.4","text":"
  • Add support for setting results-history-name.
  • Add support for selecting variant to test instead of apk path.
"},{"location":"changelog/#033","title":"0.3.3","text":"
  • Add support for setting smartFlankGcsPath
  • Capitalize task names.
"},{"location":"changelog/#032","title":"0.3.2","text":"
  • Actually fix gradle download task bug.
"},{"location":"changelog/#031","title":"0.3.1","text":"
  • Maybe fix bug similar to: https://github.com/michel-kraemer/gradle-download-task/issues/58
"},{"location":"changelog/#030","title":"0.3.0","text":"
  • Add support for multiple test configurations.
"},{"location":"changelog/#0212","title":"0.2.12","text":"
  • Fix broken flankDoctor task.
"},{"location":"changelog/#0211","title":"0.2.11","text":"
  • Add minimum Gradle version check. (4.9 is required because we use the lazy task configuration API))
"},{"location":"changelog/#0210_1","title":"0.2.10","text":"
  • Add support for specifying Flank snapshot versions. See README for configuration options.
"},{"location":"changelog/#029","title":"0.2.9","text":"
  • Add support for multiple build targets. PR. Thanks winterDroid.
  • Add support for testShards and repeatTests flank options. See README for configuration options.
"},{"location":"configuration/","title":"Configuration","text":"

The following configuration options must be set inside the fladle block. See the sample configuration below. There is also a groovy sample and a kotlin sample.

"},{"location":"configuration/#serviceaccountcredentials","title":"serviceAccountCredentials","text":"

User Authentication is also possible. See Authentication.

Groovy 
serviceAccountCredentials = project.layout.projectDirectory.file(\"flank-gradle-5cf02dc90531.json\")\n
Kotlin 
serviceAccountCredentials.set(\"project.layout.projectDirectory.file(\"flank-gradle-5cf02dc90531.json\")\n

Optionally, the serviceAccountCredentials can be set with environment variables but then the projectId parameter must be set.

See Authentication for more info.

"},{"location":"configuration/#variant","title":"variant","text":"

Note

variant must be set if using buildFlavors in order to automatically configure the debugApk and testApk.

Set the variant to automatically configure for testing. A build variant is a combination of buildFlavor and buildType. This must also be set when testing against a non-default variant. For example: 'debug' or 'freeDebug'. Put this inside your Fladle block.

Groovy 
variant = \"freeDebug\"\n
Kotlin 
variant.set(\"freeDebug\")\n
"},{"location":"configuration/#sample-configuration","title":"Sample Configuration","text":"
fladle {\n// Required parameters\nserviceAccountCredentials = project.layout.projectDirectory.file(\"flank-gradle-5cf02dc90531.json\")\nvariant = \"freeDebug\"\n\n// Optional parameters\nuseOrchestrator = false\nenvironmentVariables = [\n\"clearPackageData\": \"true\"\n]\ndirectoriesToPull = [\n\"/sdcard/screenshots\"\n]\nfilesToDownload = [\n\".*/screenshots/.*\"\n]\ntestTargets = [\n\"class com.osacky.flank.gradle.sample.ExampleInstrumentedTest#seeView\"\n]\ntestTimeout = \"15m\"\nrecordVideo = false\nperformanceMetrics = false\ndevices = [\n[ \"model\": \"SmallPhone.arm\", \"version\": \"28\" ],\n[ \"model\": \"MediumPhone.arm\", \"version\": \"33\" ]\n]\nprojectId(\"flank-gradle\")\nflankVersion = \"23.10.1\"\ndebugApk = \"$buildDir/outputs/apk/debug/sample-debug.apk\"\ninstrumentationApk = \"$buildDir/outputs/apk/androidTest/debug/sample-debug-androidTest.apk\"\nadditionalTestApks = [\n\"- app:  $buildDir/outputs/apk/debug/sample-debug.apk\",\n\"  test: $buildDir/outputs/apk/androidTest/debug/sample2-debug-androidTest.apk\",\n\"- test: ${rootProject.buildDir}/database/module/outputs/apk/database-module-androidTest.apk\"\n]\nautoGoogleLogin = true\nmaxTestShards = 8 //or numUniformShards=5 cannot use both.\nshardTime = 120\nsmartFlankGcsPath = \"gs://tmp_flank/flank/test_app_android.xml\"\nconfigs {\noranges {\nuseOrchestrator.set(false)\ntestTargets.set(project.provider { [\n\"class com.osacky.flank.gradle.sample.ExampleInstrumentedTest#runAndFail\"\n] })\n}\n}\nresultsBucket(\"my-results-bucket-name\")\nkeepFilePath = true\nrunTimout = \"45m\"\nignoreFailedTests = false\ndisableSharding = false\nsmartFlankDisableUpload = false\ntestRunnerClass = \"com.foo.TestRunner\"\nlocalResultsDir = \"flank\"\nclientDetails = [\n\"key1\": \"value1\",\n\"key2\": \"value2\"\n]\ntestTargetsAlwaysRun = [\n\"com.example.TestSuite#test1\",\n\"com.example.TestSuite#test2\"\n]\notherFiles = [\n\"/sdcard/dir1/file1.txt\": \"/my/example/path/file1.txt\",\n\"/sdcard/dir2/file2.txt\": \"/my/example/path/file2.txt\"\n]\nnetworkProfile = \"LTE\"\nroboDirectives = [\n[\"click\", \"button1\", \"\"],\n[\"ignore\", \"button2\"],\n[\"text\", \"field1\", \"my text\"],\n]\noutputStyle = 'multi'\nlegacyJunitResult = false\nfullJunitResult = false\nadditionalApks = [\n\"gs://path/to/app1.apk\",\n\"localPath/to/app2.apk\"\n]\ndefaultTestTime = 5.3\ndefaultClassTestTime = 180.5\nuseAverageTestTimeForNewTests = true\ndisableResultsUpload = true\ngrantPermissions = \"none\"\ntype = \"game-loop\"\nscenarioLabels = [\n\"label1\",\n\"label2\" ]\nscenarioNumbers = [ 1, 23, 52 ]\nobbFiles = [\n\"local/file/path/test1.obb\",\n\"local/file/path/test2.obb\"\n]\nobbNames = [\n\"patch.0300110.com.example.android.obb\",\n\"patch.0300111.com.example.android.obb\"\n]\ntestTargetsForShard = [\n\"package com.package1.for.shard1, com.package2.for.shard1\",\n\"class com.foo.ClassForShard2#testMethod1, com.foo.ClassForShard2#testMethod2\",\n\"class com.foo.ClassForShard3; package com.package.for.shard3\"\n]\nfailFast = true\ndependOnAssemble = true\n}\n
"},{"location":"configuration/#useorchestrator","title":"useOrchestrator","text":"

Whether or not we should use the android test orchestrator to run this tests. Set this to true when the build.gradle file includes testOptions.execution 'ANDROID_TEST_ORCHESTRATOR'

Groovy 
useOrchestrator = true\n
Kotlin 
useOrchestrator.set(true)\n
"},{"location":"configuration/#testtargets","title":"testTargets","text":"

Set multiple testTargets to be run by Flank. These are used to whitelist or blacklist test classes, test cases and test annotations. See Google Cloud Firebase docs for more information.

Groovy 
testTargets = [\n\"class com.osacky.flank.gradle.sample.ExampleInstrumentedTest#seeView\"\n]\n
Kotlin 
testTargets.set(listOf(\n\"class com.osacky.flank.gradle.sample.ExampleInstrumentedTest#seeView\"\n))\n
"},{"location":"configuration/#devices","title":"devices","text":"

A list of devices to run the tests against. When list is empty, a default device will be used. Each device entry is a map. The valid keys in the map are model, version, orientation, and locale. When a key is not set or is null, a default value will be used.

Groovy 
devices = [\n[ \"model\": \"MediumPhone.arm\", \"version\": \"26\" ],\n[ \"model\": \"MediumPhone.arm\", \"version\": \"33\" ]\n]\n
Kotlin 
devices.set(listOf(\nmapOf(\"model\" to \"MediumPhone.arm\", \"version\" to \"26\" ),\nmapOf(\"model\" to \"MediumPhone.arm\", \"version\" to \"33\" )\n))\n
"},{"location":"configuration/#projectid","title":"projectId","text":"

The projectId is a unique identifier which can be found in the project's URL: https://console.firebase.google.com/project/<projectId> This is automatically discovered based on the service credential by default.

Groovy 
projectId = \"flank-gradle\"\n
Kotlin 
projectId.set(\"flank-gradle\")\n
"},{"location":"configuration/#flankversion","title":"flankVersion","text":"

Need a different Flank version? Specify it with flankVersion.

To use a snapshot:

Groovy 
flankVersion = \"flank_snapshot\"`\n
Kotlin 
flankVersion.set(\"flank_snapshot\")\n

Need more than 50 shards? Use Flank 8.1.0.

To use a different version:

Groovy 
flankVersion = \"23.10.1\"\n
Kotlin 
flankVersion.set(\"23.10.1\")\n
"},{"location":"configuration/#flankcoordinates","title":"flankCoordinates","text":"

Specify custom flank maven coordinates.

Groovy 
flankCoordinates = \"com.github.flank:flank\"\n
Kotlin 
flankCoordinates.set(\"com.github.flank:flank\")\n
"},{"location":"configuration/#debugapk","title":"debugApk","text":"

This is a string representing the path to the app's debug apk. Supports wildcard characters. Optional, prefer to set variant.

Groovy 
debugApk = project.provider { \"${buildDir.toString()}/outputs/apk/debug/*.apk\" }\n
Kotlin 
debugApk.set(project.provider { \"${buildDir.toString()}/outputs/apk/debug/*.apk\" })\n
"},{"location":"configuration/#instrumentationapk","title":"instrumentationApk","text":"

This is a string representing the path to the app's instrumentaiton apk. Supports wildcard characters. Optional, prefer to set variant. InstrumenationApk should not be set when using roboScript.

Groovy 
instrumentationApk = project.provider { \"${buildDir.toString()}/outputs/apk/androidTest/debug/*.apk\" }\n
Kotlin 
instrumentationApk.set(project.provider { \"${buildDir.toString()}/outputs/apk/androidTest/debug/*.apk\" })\n
"},{"location":"configuration/#additionaltestapks","title":"additionalTestApks","text":"

Paths to additional test configurations. Order matters. A test apk is run with the nearest previous listed app apk. For library modules, add them to the list with a - test: in front. For test apks which belong to an application module, add them with test:. It is not required to list an app apk here. If there is no app apk listed in additionalTestApks, the test apks are run against the debugApk.

Groovy 
additionalTestApks.value(project.provider { [\n\"- app: ../main/app/build/output/apk/debug/app.apk\",\n\"  test: ../main/app/build/output/apk/androidTest/debug/app-test.apk\",\n\"- app: ../sample/app/build/output/apk/debug/sample-app.apk\",\n\"  test: ../sample/app/build/output/apk/androidTest/debug/sample-app-test.apk\",\n\"- test: ../feature/room/build/output/apk/androidTest/debug/feature-room-test.apk\",\n\"- test: ../library/databases/build/output/apk/androidTest/debug/sample-databases-test.apk\"\n]})\n
Kotlin 
additionalTestApks.value(project.provider { listOf(\n\"- app: ../main/app/build/output/apk/debug/app.apk\",\n\"  test: ../main/app/build/output/apk/androidTest/debug/app-test.apk\",\n\"- app: ../sample/app/build/output/apk/debug/sample-app.apk\",\n\"  test: ../sample/app/build/output/apk/androidTest/debug/sample-app-test.apk\",\n\"- test: ../feature/room/build/output/apk/androidTest/debug/feature-room-test.apk\",\n\"- test: ../library/databases/build/output/apk/androidTest/debug/sample-databases-test.apk\"\n)})\n
"},{"location":"configuration/#autogooglelogin","title":"autoGoogleLogin","text":"

Whether to automatically log in using a preconfigured google account. More Info

Groovy 
autoGoogleLogin = false\n
Kotlin 
autoGoogleLogin.set(false)\n
"},{"location":"configuration/#environmentvariables","title":"environmentVariables","text":"

Environment variables are mirrored as extra options to the am instrument -e KEY1 VALUE1 \u2026 command and passed to your test runner (typically AndroidJUnitRunner). Examples

Groovy 
environmentVariables = [\n// Whether or not to remove all shared state from your device's CPU and memory after each test. [More info](https://developer.android.com/training/testing/junit-runner)\n\"clearPackageData\": \"true\"\n]\n
Kotlin 
environmentVariables = mapOf(\n// Whether or not to remove all shared state from your device's CPU and memory after each test. [More info](https://developer.android.com/training/testing/junit-runner)\n\"clearPackageData\" to \"true\"\n)\n
"},{"location":"configuration/#testshards","title":"testShards","text":"

Deprecated

Use maxTestShards instead.

The maximum number of shards. Fladle will throw an error when used together with maxTestShards or numUniformShards.

Groovy 
testShards = 5\n
Kotlin 
testShards.set(5)\n
"},{"location":"configuration/#maxtestshards","title":"maxTestShards","text":"

The maximum number of shards. Fladle will throw an error when used together with testShards or numUniformShards.

Groovy 
maxTestShards = 8\n
Kotlin 
maxTestShards.set(8)\n
"},{"location":"configuration/#shardtime","title":"shardTime","text":"

The amount of time tests within a shard should take. When set to > 0, the shard count is dynamically set based on time up to the maximum limit defined by maxTestShards 2 minutes (120) is recommended. default: -1 (unlimited)

Groovy 
shardTime = 120\n
Kotlin 
shardTime.set(120)\n
"},{"location":"configuration/#repeattests","title":"repeatTests","text":"

The number of times to repeat each test. Uses Flank's default value when not specified.

Groovy 
repeatTests = 1\n
Kotlin 
repeatTests.set(1)\n
"},{"location":"configuration/#configs","title":"configs","text":"

Give a name to a custom flank task and configure its options. The name is appended to the end of the flank task. For example runFlank becomes runFlank<name>.

Groovy 
configs {\nrepeatOneHundred {\n// DSL sugar for container elements is missing (= syntax): https://github.com/gradle/gradle/issues/9987\nrepeatTests.set(100)\n}\n}\n
Kotlin 
configs {\ncreate(\"repeatOneHundred\") {\nrepeatTests.set(100)\n}\n}\n

In the above example, the configuration is inherited from the outer fladle config but with the repeatTests property set to 100. Running runFlankRepeateOneHundred will execute this custom configuration.

"},{"location":"configuration/#smartflankgcspath","title":"smartFlankGcsPath","text":"

The cloud storage location for historical test runs. This must be set in order to use smart sharding. The amount of shards used is set by maxTestShards. The bucket (such as flank_data in the example) must already exist in order for it to be used.

Groovy 
smartFlankGcsPath = 'gs://flank_data/results/JUnitReport.xml'\n
Kotlin 
smartFlankGcsPath.set(\"gs://flank_data/results/JUnitReport.xml\")\n
"},{"location":"configuration/#resultshistoryname","title":"resultsHistoryName","text":"

The history name for your test results (an arbitrary string label; default: the application's label from the APK manifest). All tests which use the same history name will have their results grouped together in the Firebase console in a time-ordered test history list.

Groovy 
resultsHistoryName = 'android-history'\n
Kotlin 
resultsHistoryName.set(\"android-history\")\n
"},{"location":"configuration/#flakytestattempts","title":"flakyTestAttempts","text":"

The number of times to retry failed tests. Default is 0. Max is 10. Setting the value to 1 will mean that test are retried once. If the test fails then succeeds after the retry the run will be marked as \"successful\". The matrix with a flaky test will be marked as flaky.

Groovy 
flakyTestAttempts = 0\n
Kotlin 
flakyTestAttempts.set(0)\n
"},{"location":"configuration/#abi","title":"abi","text":"

The ABI split of the application that should be tested (e.g. \"x86\"). Only required if the application under test uses ABI splits and the debug APK is selected automatically (via variant) instead of manually (via debugApk).

If the application uses ABI splits, and this property isn't specified, an arbitrary ABI split will be selected.

Groovy 
abi = \"arm64-v8a\"\n
Kotlin 
abi.set(\"arm64-v8a\")\n
"},{"location":"configuration/#directoriestopull","title":"directoriesToPull","text":"

A list of paths that will be copied from the device's storage to the designated results bucket after the test is complete. These must be absolute paths under /sdcard or /data/local/tmp. Path names are restricted to the characters a-zA-Z0-9_-./+. The paths /sdcard and /data will be made available and treated as implicit path substitutions. E.g. if /sdcard on a particular device does not map to external storage, the system will replace it with the external storage path prefix for that device.

Groovy 
directoriesToPull = [\n'/sdcard/tempDir1', '/data/local/tmp/tempDir2'\n]\n
Kotlin 
directoriesToPull.set(listOf(\n\"/sdcard/tempDir1\", \"/data/local/tmp/tempDir2\"\n))\n
"},{"location":"configuration/#filestodownload","title":"filesToDownload","text":"

List of regex that is matched against bucket paths (for example: 2019-01-09_00:13:06.106000_YCKl/shard_0/SmallPhone.arm-28-en-portrait/bugreport.txt) for files to be downloaded after a flank run. The results are downloaded to the APP_MODULE/build/fladle/RESULTS directory where RESULTS can be set by localResultsDir var otherwise defaulting to results/.

Groovy 
filesToDownload = [\n'.*/sdcard/tempDir1/.*', '.*/data/local/tmp/tempDir2/.*'\n]\n
Kotlin 
filesToDownload.set(listOf(\n\".*/sdcard/tempDir1/.*\", \".*/data/local/tmp/tempDir2/.*\"\n))\n
"},{"location":"configuration/#testtimeout","title":"testTimeout","text":"

The max time test execution can run before it is cancelled (default: 15m). It does not include any time necessary to prepare and clean up the target device. The maximum possible testing time is 45m on physical devices and 60m on virtual devices. The TIMEOUT units can be h, m, or s. If no unit is given, seconds are assumed. Examples: * 1h -> 1 hour * 5m -> 5 minutes * 200s -> 200 seconds * 100 -> 100 seconds

Groovy 
testTimeout = \"1h\"\n
Kotlin 
testTimeout.set(\"1h\")\n
"},{"location":"configuration/#recordvideo","title":"recordVideo","text":"

Enable video recording during the test. Enabled by default.

Groovy 
recordVideo = true\n
Kotlin 
recordVideo.set(true)\n
"},{"location":"configuration/#performancemetrics","title":"performanceMetrics","text":"

Monitor and record performance metrics: CPU, memory, network usage, and FPS (game-loop only). Enabled by default.

Groovy 
performanceMetrics = true\n
Kotlin 
performanceMetrics.set(true)\n
"},{"location":"configuration/#resultsbucket","title":"resultsBucket","text":"

The name of a Google Cloud Storage bucket where raw test results will be stored.

Groovy 
resultsBucket = \"my-gcs-bucket-name\"\n
Kotlin 
resultsBucket.set(\"my-gcs-bucket-name\")\n
"},{"location":"configuration/#keepfilepath","title":"keepFilePath","text":"

Keeps the full path of downloaded files from a Google Cloud Storage bucket. Required when file names are not unique. Disabled by default.

Groovy 
keepFilePath = false\n
Kotlin 
keepFilePath.set(false)\n
"},{"location":"configuration/#resultsdir","title":"resultsDir","text":"

The name of a unique Google Cloud Storage object within the results bucket where raw test results will be stored. The default is a timestamp with a random suffix.

Groovy 
resultsDir = \"result-dir-${getTimeStamp()}\"\n
Kotlin 
resultsDir.set(\"result-dir-${getTimeStamp()}\")\n
"},{"location":"configuration/#disablesharding","title":"disableSharding","text":"

Disables sharding. All tests will run on the same device. Useful for parameterized tests which do not support sharding. (default: false)

Groovy 
disableSharding = false\n
Kotlin 
disableSharding.set(false)\n
"},{"location":"configuration/#smartflankdisableupload","title":"smartFlankDisableUpload","text":"

Disables smart flank JUnit XML uploading. Useful for preventing timing data from being updated. (default: false) What is Smart Flank?

Groovy 
smartFlankDisableUpload = false\n
Kotlin 
smartFlankDisableUpload.set(false)\n
"},{"location":"configuration/#testrunnerclass","title":"testRunnerClass","text":"

The fully-qualified Java class name of the instrumentation test runner (default: the test manifest is parsed to determine the class name).

Groovy 
testRunnerClass = \"com.example.MyCustomTestRunner\"\n
Kotlin 
testRunnerClass.set(\"com.example.MyCustomTestRunner\")\n
"},{"location":"configuration/#localresultsdir","title":"localResultsDir","text":"

The local directory to store the test results. Folder is DELETED before each run to ensure only artifacts from the new run are saved. This directory is relative to the working directory of Flank which is by default build/fladle or build/fladle/<flavorname>.

Groovy 
localResultsDir = \"my-results-dir\"\n
Kotlin 
localResultsDir.set(\"my-results-dir\")\n
"},{"location":"configuration/#testtargetsalwaysrun","title":"testTargetsAlwaysRun","text":"

Always run - these tests are inserted at the beginning of every shard. Useful if you need to grant permissions or login before other tests run

Groovy 
testTargetsAlwaysRun = [\n'class com.example.MyTestClass'\n]\n
Kotlin 
testTargetsAlwaysRun.set(listOf(\n\"class com.example.MyTestClass\"\n))\n

The flags below are only available with Flank 20.05.0 or higher.

"},{"location":"configuration/#runtimeout","title":"runTimeout","text":"

The max time this test run can execute before it is cancelled. s (seconds), m (minutes), h (hours) suffixes are acceptable, mixes like 1h45m are currently not supported (default: unlimited). Examples:

  • 20, 20s -> 20 seconds
  • 30m -> 30 minutes
  • 2h -> 2 hours
Groovy 
runTimeout = \"15m\"\n
Kotlin 
runTimeout.set(\"15m\")\n
"},{"location":"configuration/#ignorefailedtests","title":"ignoreFailedTests","text":"

Always return successful task completion even when there are failed tests. Useful when parsing JUnit XML to determine failure. (default: false)

Groovy 
ignoreFailedTests = false\n
Kotlin 
ignoreFailedTests.set(false)\n
"},{"location":"configuration/#numuniformshards","title":"numUniformShards","text":"

Specifies the number of shards into which you want to evenly distribute test cases. The shards are run in parallel on separate devices. For example, if your test execution contains 20 test cases and you specify four shards, each shard executes five test cases. The number of shards should be less than the total number of test cases. The number of shards specified must be >= 1 and <= 50. This option cannot be used along maxTestShards and is not compatible with smart sharding (Smart Flank). If you want to take benefits of smart sharding use maxTestShards instead. (default: null)

Groovy 
numUniformShards = 50\n
Kotlin 
numUniformShards.set(50)\n
"},{"location":"configuration/#clientdetails","title":"clientDetails","text":"

A key-value map of additional details to attach to the test matrix.(clientDetails in Google Cloud Docs) Arbitrary key-value pairs may be attached to a test matrix to provide additional context about the tests being run. When consuming the test results, such as in Cloud Functions or a CI system, these details can add additional context such as a link to the corresponding pull request. (Access Client Details). These can be used to provide additional context about the environment where the tests are being run.

Groovy 
clientDetails = [\n\"test-type\": \"PR\",\n\"build-number\": \"132\"\n]\n
Kotlin 
clientDetails.set(mapOf(\n\"test-type\" to \"PR\",\n\"build-number\" to \"132\"\n))\n
"},{"location":"configuration/#otherfiles","title":"otherFiles","text":"

A list of device-path: file-path pairs that indicate the device paths to push files to the device before starting tests, and the paths of files to push. Device paths must be under absolute, whitelisted paths (${EXTERNAL_STORAGE}, or ${ANDROID_DATA}/local/tmp). Source file paths may be in the local filesystem or in Google Cloud Storage (gs://\u2026).

Groovy 
otherFiles = [\n\"/sdcard/dir1/file1.txt\": \"local/file.txt\",\n\"/sdcard/dir2/file2.jpg\": \"gs://bucket/file.jpg\",\n]\n
Kotlin 
otherFiles.set(mapOf(\n\"/sdcard/dir1/file1.txt\" to \"local/file.txt\",\n\"/sdcard/dir2/file2.jpg\" to \"gs://bucket/file.jpg\",\n))\n
"},{"location":"configuration/#networkprofile","title":"networkProfile","text":"

The name of the network traffic profile, for example LTE, HSPA, etc, which consists of a set of parameters to emulate network conditions when running the test (default: no network shaping; see available profiles listed by the flank test network-profiles list command). This feature only works on physical devices.

Groovy 
networkProfile = \"LTE\"\n
Kotlin 
networkProfile.set(\"LTE\")\n
"},{"location":"configuration/#roboscript","title":"roboScript","text":"

The path to a Robo Script JSON file. The path may be in the local filesystem or in Google Cloud Storage using gs:// notation. You can guide the Robo test to perform specific actions by recording a Robo Script in Android Studio and then specifying this argument. Learn more at DOCS.

Groovy 
roboScript = \"my-robo-script.json\"\n
Kotlin 
roboScript.set(\"my-robo-script.json\")\n
"},{"location":"configuration/#robodirectives","title":"roboDirectives","text":"

List of robo_directives that you can use to customize the behavior of Robo test. The type specifies the action type of the directive, which may take on values click, text or ignore. Each directive is list of String = [type, key, value]. Each key should be the Android resource name of a target UI element and each value should be the text input for that element. Values are only permitted for text type elements, so no value should be specified for click and ignore type elements.

Groovy 
roboDirectives = [\n[\"test, \"input_resource_name\", \"message\"],\n    [\"click, \"button_resource_name\", \"\"],\n]\n
Kotlin 
roboDirectives.set(listOf(\nlistOf(\"test\", \"input_resource_name\", \"message\"),\nlistOf(\"click\", \"button_resource_name\", \"\"),\n))\n
"},{"location":"configuration/#outputstyle","title":"outputStyle","text":"

Output style of execution status. May be one of [verbose, multi, single]. For runs with only one test execution the default value is 'verbose', in other cases 'multi' is used as the default. The output style 'multi' is not displayed correctly on consoles which don't support ANSI codes, to avoid corrupted output use single or verbose.

multi displays separated status for each shard execution in separated line, lines are updated over time. Similar to gradle output when running multiple tasks in parallel. Requires ANSI codes support.

single displays shortened status of all executions in single line. Similar to gcloud output when running with sharding. Should work on any console.

Default value is single.

Groovy 
outputSyle = \"single\"\n
Kotlin 
outputStyle.set(\"single\")\n
"},{"location":"configuration/#legacyjunitresult","title":"legacyJunitResult","text":"

Flank provides two ways for parsing junit xml results. New way uses google api instead of merging xml files, but can generate slightly different output format. This flag allows fallback for legacy xml junit results parsing

Groovy 
legacyJunitResult = false\n
Kotlin 
legacyJunitResult.set(false)\n
"},{"location":"configuration/#fulljunitresult","title":"fullJunitResult","text":"

Enables creating an additional local junit result on local storage with failure nodes on passed flaky tests.

Groovy 
fullJunitResult = false\n
Kotlin 
fullJunitResult.set(false)\n
"},{"location":"configuration/#sanityrobo","title":"sanityRobo","text":"

Runs a sanityRobo test. instrumentationApk, roboDirectives, roboScript and additionalTestApks must be blank or empty.

Groovy 
sanityRobo = true\n
Kotlin 
sanityRobo.set(true)\n
"},{"location":"configuration/#defaulttesttime","title":"defaultTestTime","text":"

Set default test time expressed in seconds, used for calculating shards. (default: 120.0s)

Groovy 
defaultTestTime = 1.2\n
Kotlin 
defaultTestTime.set(1.2)\n
"},{"location":"configuration/#defaultclasstesttime","title":"defaultClassTestTime","text":"

Set default parameterized class test time expressed in seconds, used for calculating shards. (default: 2x defaultTestTime => 240s)

Groovy 
defaultClassTestTime = 245.5\n
Kotlin 
defaultClassTestTime.set(245,5)\n
"},{"location":"configuration/#additionalapks","title":"additionalApks","text":"

A list of up to 100 additional APKs to install, in addition to those being directly tested. The path may be in the local filesystem or in Google Cloud Storage using gs:// notation.

Groovy 
additionalApks = [\n\"gs://path/to/app1.apk\",\n\"localPath/to/app2.apk\"\n]\n
Kotlin 
additionalApks.set(\nproject.provider {\nlistOf(\"gs://path/to/app1.apk\", \"localPath/to/app2.apk\")\n}\n)\n
"},{"location":"configuration/#useaveragetesttimefornewtests","title":"useAverageTestTimeForNewTests","text":"

Enable using average time from previous tests duration when using SmartShard and tests did not run before. (default: false)

Groovy 
useAverageTestTimeForNewTests = true\n
Kotlin 
useAverageTestTimeForNewTests.set(true)\n
"},{"location":"configuration/#disableresultsupload","title":"disableResultsUpload","text":"

Disable flank results upload on gcloud storage. (default: false)

Groovy 
disableResultsUpload = true\n
Kotlin 
disableResultsUpload.set(true)\n
"},{"location":"configuration/#testtargetsforshard","title":"testTargetsForShard","text":"

Specifies a group of packages, classes, and/or test cases to run in each shard (a group of test cases). The shards are run in parallel on separate devices. You can use this option up to 50 times to specify multiple shards when one or more physical devices are selected, or up to 500 times when no physical devices are selected. Note: If you include the flags environmentVariables or testTargets when running testTargetsForShard, the flags are applied to all the shards you create. You can also specify multiple packages, classes, or test cases in the same shard by separating each item with a comma. To specify both package and class in the same shard, separate package and class with semi-colons.

Groovy 
testTargetsForShard = [\n  \"package com.package1.for.shard1, com.package2.for.shard1\",\n  \"class com.foo.ClassForShard2#testMethod1, com.foo.ClassForShard2#testMethod2\",\n  \"class com.foo.ClassForShard3; package com.package.for.shard3\"\n  ]\n
Kotlin 
testTargetsForShard.set(\n  project.provider {\n    listOf(\n      \"package com.package1.for.shard1, com.package2.for.shard1\",\n      \"class com.foo.ClassForShard2#testMethod1, com.foo.ClassForShard2#testMethod2\",\n      \"class com.foo.ClassForShard3; package com.package.for.shard3\"\n    )\n  }\n)\n
"},{"location":"configuration/#grantpermissions","title":"grantPermissions","text":"

Whether to grant runtime permissions on the device before the test begins. By default, all permissions are granted. PERMISSIONS must be one of: all, none

Groovy 
grantPermissions = \"none\"\n
Kotlin 
grantPermissions.set(\"none\")\n
"},{"location":"configuration/#type","title":"type","text":"

The type of test to run. TYPE must be one of: instrumentation, robo, game-loop. Use if you want to be sure there is only one type of tests being run (flank enables to run mixed types of test in one run).

Groovy 
type = \"game-loop\"\n
Kotlin 
type.set(\"game-loop\")\n
"},{"location":"configuration/#scenariolabels","title":"scenarioLabels","text":"

A list of game-loop scenario labels (default: None). Each game-loop scenario may be labeled in the APK manifest file with one or more arbitrary strings, creating logical groupings (e.g. GPU_COMPATIBILITY_TESTS). If --scenario-numbers and --scenario-labels are specified together, Firebase Test Lab will first execute each scenario from --scenario-numbers. It will then expand each given scenario label into a list of scenario numbers marked with that label, and execute those scenarios.

Groovy 
scenarioLabels = [\n\"label1\",\n\"label2\" ]\n
Kotlin 
scenarioLabels.set(\nproject.provider {\nlistOf(\"label1\", \"label2\")\n}\n)\n
"},{"location":"configuration/#scenarionumbers","title":"scenarioNumbers","text":"

A list of game-loop scenario numbers which will be run as part of the test (default: all scenarios). A maximum of 1024 scenarios may be specified in one test matrix, but the maximum number may also be limited by the overall test --timeout setting.

Groovy 
scenarioNumbers = [ 1, 23, 52 ]\n
Kotlin 
scenarioNumbers.set(\nproject.provider {\nlistOf(1, 23, 52)\n}\n)\n
"},{"location":"configuration/#obbfiles","title":"obbFiles","text":"

A list of one or two Android OBB file names which will be copied to each test device before the tests will run (default: None). Each OBB file name must conform to the format as specified by Android (e.g. [main|patch].0300110.com.example.android.obb) and will be installed into <shared-storage>/Android/obb/<package-name>/ on the test device.

Groovy 
obbFiles = [\n\"local/file/path/test1.obb\",\n\"local/file/path/test2.obb\"\n]\n
Kotlin 
obbFiles.set(\nproject.provider {\nlistOf(\n\"local/file/path/test1.obb\",\n\"local/file/path/test2.obb\"\n)\n}\n)\n
"},{"location":"configuration/#obbnames","title":"obbNames","text":"

A list of OBB required filenames. OBB file name must conform to the format as specified by Android e.g. [main|patch].0300110.com.example.android.obb which will be installed into <shared-storage>/Android/obb/<package-name>/ on the device.

Groovy 
obbNames = [\n\"patch.0300110.com.example.android.obb\",\n\"patch.0300111.com.example.android.obb\"\n]\n
Kotlin 
obbNames.set(\nproject.provider {\nlistOf(\n\"patch.0300110.com.example.android.obb\",\n\"patch.0300111.com.example.android.obb\"\n)\n}\n)\n
"},{"location":"configuration/#failfast","title":"failFast","text":"

If true, only a single attempt at most will be made to run each execution/shard in the matrix. Flaky test attempts are not affected. Normally, 2 or more attempts are made if a potential infrastructure issue is detected. This feature is for latency sensitive workloads. The incidence of execution failures may be significantly greater for fail-fast matrices and support is more limited because of that expectation.

Groovy 
failFast = true\n
Kotlin 
failFast.set(true)\n
"},{"location":"configuration/#additionalflankoptions","title":"additionalFlankOptions","text":"

Appending additional option to flank root yaml. This option is useful when you would like to test options before official fladle support is added. Multiple options are supported.

Single option

Groovy 
additionalFlankOptions = \"new-property: true\"\n
Kotlin 
additionalFlankOptions.set(\"new-property: true\")\n

Multiple options

Groovy 
additionalFlankOptions = \"\"\"\n  new-property: true\n  other-new-property: force\n\"\"\".stripIndent()\n
Kotlin 
additionalFlankOptions.set(\"\"\"\n    new-property: true\n    other-new-property: force\n\"\"\".trimIndent())\n
"},{"location":"configuration/#additionalgcloudoptions","title":"additionalGcloudOptions","text":"

Allow appending additional config to gcloud root yaml. This option is useful when you would like to test option before it is available on Fladle. Supports both single and multiple properties.

Single option

Groovy 
additionalGcloudOptions = \"new-property: true\"\n
Kotlin 
additionalGcloudOptions.set(\"new-property: true\")\n

Multiple options

Groovy 
additionalGcloudOptions = \"\"\"\n    new-property: true\n    other-new-property: force\n  \"\"\".stripIndent()\n
Kotlin 
additionalGcloudOptions.set(\"\"\"\n    new-property: true\n    other-new-property: force\n\"\"\".trimIndent())\n
"},{"location":"configuration/#dependonassemble","title":"dependOnAssemble","text":"

Enable to automatically build the app and test APKs before runFlank executes. (default: false)

Groovy 
dependOnAssemble = true\n
Kotlin 
dependOnAssemble.set(true)\n
"},{"location":"configuration/#async","title":"async","text":"

Enable to return immediately after invoking tests, without waiting for results. (default: false)

Groovy 
async = true\n
Kotlin 
async.set(true)\n
"},{"location":"faq/","title":"FAQ","text":""},{"location":"faq/#error-apk-file-not-found","title":"Error APK file not found","text":"

The app APK and the instrumentation APK are expected to have already been generated before calling runFlank. To generate APKs, run assembleDebug and assembleDebugAndroidTest before running runFlank.

You can also have Fladle build them for you by using the dependOnAssemble property.

"},{"location":"faq/#no-signature-of-method","title":"No signature of method","text":"

If you receive an error like this, it is likely caused by invalid fladle extension confiuration. The syntax was changed in the 0.9.X releases in order to avoid touching files during the configuration phase. 

No signature of method: flank_4vvjv7w3oopge32w1tl9cs6e4.fladle() is applicable for argument types: (flank_4vvjv7w3oopge32w1tl9cs6e4$_run_closure1) values: [flank_4vvjv7w3oopge32w1tl9cs6e4$_run_closure1@649a2315]\nPossible solutions: file(java.lang.Object), find(), findAll(), file(java.lang.Object, org.gradle.api.PathValidation), files([Ljava.lang.Object;), findAll(groovy.lang.Closure)\n

If you receive a similar error, please check configuration for a sample configuration.

"},{"location":"faq/#debugging","title":"Debugging","text":"

./gradlew runFlank -PdumpShards Will dump shards and exit the process without running the tests.

./gradlew printYml Will print out the current yaml configuration to be passed to Flank.

"},{"location":"faq/#more-help","title":"More help?","text":"

Still having trouble? Check the #flank channel in the Firebase Community Slack

"},{"location":"multi-module-testing/","title":"Multi-module testing","text":"

Multi module testing can be done by manually specifying additionalTestApks or applying the Fulladle plugin to automacally gather all the additional test apks. See also this article for a full setup and instructions including integration with CI.

"},{"location":"multi-module-testing/#fulladle-plugin","title":"Fulladle Plugin","text":"

  1. Apply the Fulladle plugin at the root of the project.

    Groovy 
    plugins {\nid 'com.osacky.fulladle' version '0.20.0'\n}\n
    Kotlin 
    plugins {\nid(\"com.osacky.fulladle\") version \"0.20.0\"\n}\n

  2. Configure the Fladle extension.

    Groovy 
    fladle {\nserviceAccountCredentials = project.layout.projectDirectory.file(\"flank-gradle-service-account.json\")\n}\n
    Kotlin 
    fladle {\nserviceAccountCredentials.set(project.layout.projectDirectory.file(\"flank-gradle-service-account.json\"))\n}\n

    Warning

    If using buildFlavors or testing against a non default variant, you will need to specify the variant you want to test in the fulladleModuleConfig block.

  3. Run the tests. First assemble all your debug apks and test apks. 

    ./gradlew assembleDebug assembleDebugAndroidTest\n

    Note

    When using flavors, make sure to assemble your buildVariants as well.

    ./gradlew :app:assembleFreeDebug :app:assembleFreeDebugAndroidTest

    Run Flank! 

    ./gradlew runFlank\n

"},{"location":"multi-module-testing/#overriding-configurations-in-modules","title":"Overriding configurations in modules","text":"

Fulladle will pick Flank configurations from the fladle block in the root build.gradle file. You may want to override some of these configurations for certain modules, you can add the following block to any Android library module to override its configurations:

Groovy 
fulladleModuleConfig {\nclientDetails = [\n\"test-type\": \"PR\",\n\"build-number\": \"132\"\n]\nmaxTestShards = 3\nenvironmentVariables = [\n\"clearPackageData\": \"true\"\n]\ndebugApk = \"app.apk\"\nvariant = \"vanillaDebug\"\n}\n
Kotlin 
fulladleModuleConfig {\nclientDetails.set(mapOf(\n\"test-type\" to \"PR\",\n\"build-number\" to \"132\",\n))\nmaxTestShards.set(3)\nenvironmentVariables.set(mapOf(\n\"clearPackageData\" to \"true\"\n))\ndebugApk.set(\"app.apk\")\nvariant.set(\"vanillaDebug\")\n}\n

All of the above configurations are optional, Flank will default to the top-level configurations if you don't override anything here. For details about these configurations, refer to configuration docs.

"},{"location":"multi-module-testing/#disabling-a-module","title":"Disabling a module","text":"

You may want to exclude a library module from testing when using Fulladle. You can do so by setting the enabled configuration in the module's fulladleModuleConfig block like so:

Groovy 
fulladleModuleConfig {\nenabled = false\n}\n
Kotlin 
fulladleModuleConfig {\nenabled.set(false)\n}\n
"},{"location":"multi-module-testing/#overriding-root-level-config","title":"Overriding root-level config","text":"

Fulladle does not provide the ability to control which module ends up as the root-level module or as an additional module. Either one of app modules or library modules can become a root-level module. If a library module ends up as a root-level module, it needs to specify a debugApk in its fladle or fulladleModuleConfig block.

The root-level configuration (e.g. maxTestShards) can also be overridden in the fulladleModuleConfig block of whatever module gets picked as the root module.

"},{"location":"multi-module-testing/#troubleshooting","title":"Troubleshooting","text":"

Fulladle might still have some rough edges, but we'd love feedback. Please join us in the Firebase Community Slack with any feedback you may have. You can also file Fladle Github issues.

When filing a bug report, please include the Flank version number, the Fladle version number and the output of the following:

./gradlew printYml

./gradlew runFlank -PdumpShards

"},{"location":"quick-start/","title":"Quick Start","text":"

Using Fladle takes 3 steps:

  1. Apply the Fladle plugin. Follow instructions here

    Root build.gradle

    Groovy 
    buildscript {\ndependencies {\nclasspath \"com.osacky.flank.gradle:fladle:0.20.0\"\n}\n}\n
    Kotlin 
    buildscript {\ndependencies {\nclasspath(\"com.osacky.flank.gradle:fladle:0.20.0\")\n}\n}\n

    Application module build.gradle

    Groovy 
    apply plugin: \"com.android.application\"\napply plugin: \"com.osacky.fladle\"\n
    Kotlin 
    plugins {\nid (\"com.android.application\")\nid (\"com.osacky.fladle\")\n}\n

  2. Configure Authentication using these steps.

    Warning

    If using buildFlavors or testing against a non default variant, variant must also configured

  3. Run your tests!

    First assemble your debug apk and test apk. 

    ./gradlew :app:assembleDebug :app:assembleDebugAndroidTest\n

    Note

    When using flavors, make sure to assemble your buildVariants.

    ./gradlew :app:assembleFreeDebug :app:assembleFreeDebugAndroidTest

    Run Flank! 

    ./gradlew runFlank\n

"},{"location":"recipes/","title":"Recipes","text":"

Here are some recipes to use to achieve various goals in flank. For additional recipes or suggestions, please file an issue on Github.

"},{"location":"recipes/#smartly-shard-tests-in-120-second-shards-across-a-maximum-of-50-shards","title":"Smartly shard tests in 120 second shards across a maximum of 50 shards.","text":"

This recipe will keep track of test durations automatically on firebase test lab and try to split up test runs in to 120 second shards up to maximum of 50 shards.

Groovy 
fladle {\nmaxTestShards = 50\nshardTime = 120\nsmartFlankGcsPath = \"gs://fladle-results/smart-flank/JUnitReport.xml\"\n}\n
Kotlin 
fladle {\nmaxTestShards.set(50)\nshardTime.set(120)\nsmartFlankGcsPath.set(\"gs://fladle-results/smart-flank/JUnitReport.xml\")\n}\n
"},{"location":"recipes/#run-different-tests-on-different-devices-with-different-gradle-tasks","title":"Run different tests on different devices with different Gradle tasks.","text":"

./gradlew runFlankPerfTests will execute the performance tests against a MediumPhone.arm ./gradlew runFlankRegresssionTests will execute the regressions tests against a SmallPhone.arm

Groovy 
fladle {\nconfigs {\nperfTests {\ndevices.set([\n[\"model\" : \"MediumPhone.arm\", \"version\" : \"28\"], [\"model\" : \"MediumPhone.arm\", \"version\" : \"28\"]\n])\ntestTargets.set([\n\"class com.sample.MyPerformanceTest\"\n])\n}\nregressionTests {\ndevices.set([\n[ \"model\" : \"SmallPhone.arm\", \"version\" : \"28\"]\n])\ntestTargets.set([\n\"class com.sample.MyRegressionTest\"\n])\n}\n}\n}\n
Kotlin 
fladle {\nconfigs {\ncreate(\"perfTests\") {\ndevices.set(listOf(\nmapOf(\"model\" to \"MediumPhone.arm\", \"version\" to \"28\" ), mapOf(\"model\" to \"MediumPhone.arm\", \"version\" to \"28\")\n))\ntestTargets.set(listOf(\n\"class com.sample.MyPerformanceTest\"\n))\n}\ncreate(\"regressionTests\") {\ndevices.set(listOf(\nmapOf(\"model\" to \"SmallPhone.arm\", \"version\" to \"28\" )\n))\ntestTargets.set(listOf(\n\"class com.sample.MyRegressionTest\"\n))\n}\n}\n}\n
"},{"location":"recipes/#always-use-the-latest-version-of-flank","title":"Always use the latest version of Flank","text":"

Use Gradle's dynamic version syntax to declare a dynamic version.

Warning

Dynamic versions lead to non-reproducible builds since Gradle will check for new versions periodically based on how long versions are cached.

Groovy 
flankVersion = \"23.+\"\n
Kotlin 
flankVersion.set(\"23.+\")\n
"},{"location":"releasing/","title":"Releasing","text":"

  • Create a local release branch from master 

    git checkout master\ngit pull\ngit checkout -b release_0.20.1\n

  • Update version in fladle-plugin/build.gradle.kts (remove -SNAPSHOT) 

    version = \"0.20.1\"\n

  • Update the current version and next version in mkdocs.yml: 

    extra:\n  fladle:\n    release: '0.20.1'\n    next_release: 'REPLACE_WITH_NEXT_VERSION_NUMBER'\n

  • Take one last look 

    git diff\n

  • Commit all local changes 

    git commit -am \"Prepare 0.20.1 release\"\n

  • Create a tag and push it 

    git tag v0.20.1\ngit push origin v0.20.1\n

Pushing the tag automatically triggers the release workflow which:

  1. Publishes to Maven Central
  2. Publishes to Gradle Plugin Portal

  3. Creates a GitHub Release with auto-generated notes

  4. Release to Maven Central

    • Login to Maven Central Repository: https://central.sonatype.com/
    • Click on Publish

  5. Merge the release branch to master 

    git checkout master\ngit pull\ngit merge --no-ff release_0.20.1\n

  6. Update version in fladle-plugin/build.gradle.kts (increase version and add -SNAPSHOT) 

    version = \"REPLACE_WITH_NEXT_VERSION_NUMBER-SNAPSHOT\"\n

  7. Commit your changes 

    git commit -am \"Prepare for next development iteration\"\n

  8. Push your changes 

    git push\n

"},{"location":"results/","title":"Results","text":"

By default, results are placed in the build/fladle/results/<matrix name> directly.

A merged junit report is available in JUnitReport.xml

On failures only, an html report with links to failed shards is also generated in the results directory with the name HtmlErrorReport.html.

A cost report is also available CostReport.txt.

"},{"location":"snapshots/","title":"Testing Snapshot Releases","text":"

To test the Fladle snapshot release you have two options:

"},{"location":"snapshots/#traditional","title":"Traditional","text":"

Root build.gradle 

buildscript {\nrepositories {\nmaven {\nurl \"https://oss.sonatype.org/content/repositories/snapshots/\"\n}\n}\ndependencies {\nclasspath \"com.osacky.flank.gradle:fladle:0.20.1-SNAPSHOT\"\n}\n}\n

Project build.gradle 

apply plugin: \"com.osacky.fladle\"\n

"},{"location":"snapshots/#plugin-management","title":"Plugin Management","text":"

settings.gradle 

pluginManagement {\nrepositories {\nmaven {\nurl \"https://oss.sonatype.org/content/repositories/snapshots/\"\n}\ngradlePluginPortal()\n}\n}\n

Android application build.gradle 

plugins {\nid \"com.osacky.fladle\" version \"0.20.1-SNAPSHOT\"\n}\n

"}]} \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml new file mode 100644 index 00000000..0b3e1895 --- /dev/null +++ b/sitemap.xml @@ -0,0 +1,58 @@ + + + + https://runningcode.github.io/fladle/ + 2026-03-19 + daily + + + https://runningcode.github.io/fladle/authentication/ + 2026-03-19 + daily + + + https://runningcode.github.io/fladle/changelog/ + 2026-03-19 + daily + + + https://runningcode.github.io/fladle/configuration/ + 2026-03-19 + daily + + + https://runningcode.github.io/fladle/faq/ + 2026-03-19 + daily + + + https://runningcode.github.io/fladle/multi-module-testing/ + 2026-03-19 + daily + + + https://runningcode.github.io/fladle/quick-start/ + 2026-03-19 + daily + + + https://runningcode.github.io/fladle/recipes/ + 2026-03-19 + daily + + + https://runningcode.github.io/fladle/releasing/ + 2026-03-19 + daily + + + https://runningcode.github.io/fladle/results/ + 2026-03-19 + daily + + + https://runningcode.github.io/fladle/snapshots/ + 2026-03-19 + daily + + \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz new file mode 100644 index 0000000000000000000000000000000000000000..b92554c0ec41547d1dc242eceb1d1416ca23c426 GIT binary patch literal 302 zcmV+}0nz>+iwFpZ3%qFp|8r?{Wo=<_E_iKh0M(VjZi6rkhVOj}#2rFAX<8>pZ+(L8 z0kU8qT1X&v#`g9zrJ6YJFlD|ZvHtx2hg;V(fqLKrihEL2%(7L+ ze$`@^*^tB!)351NqyZcmt%&=VIPB(WeV;m~cb(~D_zykp)SNis7%iECOGgU@0TL?{ zN1mh6?*){W|J?&1f7aByiH^tJ;Qxa2w(#7Q-!uz&Vy6cH08he@ ATmS$7 literal 0 HcmV?d00001 diff --git a/snapshots/index.html b/snapshots/index.html new file mode 100644 index 00000000..ed7ce564 --- /dev/null +++ b/snapshots/index.html @@ -0,0 +1,501 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Testing Snapshots - Fladle + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Testing Snapshot Releases

+

To test the Fladle snapshot release you have two options:

+

Traditional

+

Root build.gradle +

buildscript {
+  repositories {
+    maven {
+      url "https://oss.sonatype.org/content/repositories/snapshots/"
+    }
+  }
+  dependencies {
+    classpath "com.osacky.flank.gradle:fladle:0.20.1-SNAPSHOT"
+  }
+}
+

+

Project build.gradle +

apply plugin: "com.osacky.fladle"
+

+

Plugin Management

+

settings.gradle +

pluginManagement {
+    repositories {
+        maven {
+            url "https://oss.sonatype.org/content/repositories/snapshots/"
+        }
+        gradlePluginPortal()
+    }
+}
+

+

Android application build.gradle +

plugins {
+    id "com.osacky.fladle" version "0.20.1-SNAPSHOT"
+}
+

+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file