From 6269764196d35f2737cf62b7cb1c9007400dfc16 Mon Sep 17 00:00:00 2001 From: Robert Scott Date: Wed, 29 Aug 2018 20:10:21 +0100 Subject: [PATCH v1 2/2] tests: add new tests exercising handling of plugins that advertise multiple versions for compatibility --- test/data/__files/plugin/qux_plugin.v345.jar | Bin 0 -> 3919 bytes test/data/__files/plugin/qux_plugin.v346.jar | Bin 0 -> 3918 bytes test/data/__files/plugin/qux_plugin.v432.jar | Bin 0 -> 3918 bytes test/data/__files/plugin/qux_plugin.v435.jar | Bin 0 -> 3919 bytes .../plugin/PluginPreferenceHighLevelTest.java | 126 +++++++++++- .../josm/plugins/PluginHandlerJOSMTooOldTest.java | 76 ++++++++ .../plugins/PluginHandlerMultiVersionTest.java | 215 +++++++++++++++++++++ 7 files changed, 416 insertions(+), 1 deletion(-) create mode 100644 test/data/__files/plugin/qux_plugin.v345.jar create mode 100644 test/data/__files/plugin/qux_plugin.v346.jar create mode 100644 test/data/__files/plugin/qux_plugin.v432.jar create mode 100644 test/data/__files/plugin/qux_plugin.v435.jar create mode 100644 test/unit/org/openstreetmap/josm/plugins/PluginHandlerMultiVersionTest.java diff --git a/test/data/__files/plugin/qux_plugin.v345.jar b/test/data/__files/plugin/qux_plugin.v345.jar new file mode 100644 index 0000000000000000000000000000000000000000..4d8b0710cfd10535c74bd0cca9e94d2c642fea47 GIT binary patch literal 3919 zcmeH}c|4T+9>*U`ne1VZC1s+zvP⋙TRF4i7ERq7-L*!n6ZqwugcO%93k78ELSFk zknK`R$r2%Lvg_a!SrZY;ea1GEGwS?%U$67b>-RjbXI|gW=lAu!(@OjZlQXxrq_n z5~YMNa){ACS-VFtd=jxBqxGKcK<}MylHKdb2+3aeDhUgmUFo*OjI6IgBe}H{*{Z<) zLB1gD%ubay+*Ho3Si>UOr{!<26#M0lUoceUmn?5BN#%mRNkE@d`bvc=J6l@peO!0X zY8-II-77(dKX!cE`AEgDtL@(Nw}VG~do>VLTK1V&r-cGS4dQDTqHVaghjKwONnSR9gDYoQZ&4p~L(H(R29W)j`)T_%0y!LB5gLwL9mWdQ9Vr1rIBF*b>sh zVifk~9nRy~xs2t$H>)}w9QX6UL}_3WP2ge1(9-^tT@d@!TQjvuT^j9(X0N-YFEZZ) zmC<5D*uzOsM}Jb5X?=sBVjK#a_D84K`ey_H3$AoirVkEqfiHM33=T_H-a3en5rlUk z5|~2`E=qi}g2J0a)ifw-8cg0NHw}Oj6c9AB&waXTQ_?Uoi0Tqih&JR+bU|l}M$}mEP#f zXlC*=+}sjQ{y1mlP2#nHK>VgZ_?`irt*V`@l$drBJq6ldI27lx13(toBtY$23aqZ~ z>XLyYR`Mp`*s|DdzC<9+kMnU$fSVTJGch)_0H5OY2H6hY-vk_;2Oped0}~Vkyn-RF zm%#TO-o`d$0N}5sH?{-?eo64pUA}N@UrVB!Zvcjb1p)#Bl<pBW|=ixJP5exu*I(>#4s6mqLQZ_3-d%pJF-3gQpUWPaTlsYKq{{)>Fha zJ>!=$3G?3*7B5@o9|THomXiN%GA!sX>ag`v!y ziq;{vW;M8~8jha&Nufo3`1=5;ri(JQEu6qRpd*2NP&}}x8$DoIsaFKd`S3_0ZR*cy zMn~j+!tK-HMa*9shc)gCXP+22RG&nWI&%5ZFDmHLQK9;!25mXjGxkfdwA-%zMN(eL z%JMe_j`;99sx3*j!LkaImLgL^pEzH?(-sj)iG*q?O^o??^b4R|gq4P{M+=ij{`vWf zXT9lIt970*%ptw(wz(kQ4n4z3ZBx!g3{rCj3Pq)BfUe_$ZzSbi4iaeXZq9@*^g;38 z5>6d4Avtx^+i=Y3&QDas`9PX&=0C+$3LYM&?#=!9yMW z4tw8$uxW#2qms7lL{ju@Md*vBU_Bvsh28hDw9c1rc+oEVbDe=tHeP<=9Kw z`XJ+bVGD~q>P3RehB_yqjN0KO*Q-BHF+_1pF zDP;Wsg8=kX=`W->xTpS3@xN32|1!ntJd`3PQC0@BPyh!2sDT@SUPr&Jk}Fkjy@1h6 z$SFSxa;2Urxp-p8X$}$rE5N&buF>(h*hh65>L7*6=8WT+c{q3wq~W)f$_9JVhQReFT`@= z-i%L8{Ll<(d}g1>NNiJIV`dmE_3`c}LrAx-#j8#&slzEnpQ~+UE|Wi$Ysn;yshg8+ zYCew687B|s_nKvST-pCh?OFQEn4;yUfrAE-Uv|)rosN5*fw_tq+1Z}Ou3DROMc7!Y z2=1TnUnYisOPX%643xKnv_YmS!gnV^BCVoIp1BxLj@7mMpZ`PjOwoysis;&&8B~*y z+rLd^W93CdBYSSfBg?{JzM0c-JD(W*;C3^ZrSdWqW1upPt_ka%9Tqsz@O$#MIw8VT z_G}*eH1|}eEAf{v+}#T=aQ%AePv&Bt7DZi*y3;6WEso0wx05rKR(DtDI(fcZxZrh) zCANDh zxIX>40m-X8y)I=<)N}#;qFqn`?;BDkzGm*66-=(kS2`zwnYn?M>)rmDK!`_)vVu*9v}Ut(9X%Natl*Pj@DVgvMbWJlbQonQpddc|dDAg}qRlz1?&+TdZg zhPsStt%^36e1^ym6m8A8%s#Bpf#G8f0xt`nHIQKTVRb$;d~|lON}L~^)=1NBbl?UA Oz~5(ZMtVH-xBmf_r$P1r literal 0 HcmV?d00001 diff --git a/test/data/__files/plugin/qux_plugin.v346.jar b/test/data/__files/plugin/qux_plugin.v346.jar new file mode 100644 index 0000000000000000000000000000000000000000..7b0a7ab71e0def48c20c64f806991a8dde9edfd9 GIT binary patch literal 3918 zcmWIWW@h1HVBlb2SP?Dl%YXzp8CV#6T|*poJ^kGD|D9rB2!JZ(U|0@R+P|E4rwAhh z!zLgW0cwLQ^>y^~baM?3(erhSop8|qu!6+V_rAaE3$8E+OvusR9;vUUw<}|hRM7sd z8QeT8R{q~x5}Z_~wCDX_x%bJ-d+Z!Keu&mwxaM)hBUCKkBpoW3v=hV<3kFc2y?VlA4JwrTz|8NcjC^n4|M^;_xh9B2D?{*s8D zFy&vHF!RJ!lSSoU21zg9HFIbF^s=fDS(a6oRRi?W^j>V5Y#eK5cRXdH$A?WC-SV(d zWMBwlpYM$n-VE$OPG)XmdTOygZbiHZMVZO@dB{qg+N4k-P#9gQkx7M-36k0VXbxZj zYRE52$D=|Bsv^H2HLtj&C^fYtH?aVZdU34kv+|2`ku*7=xmzB$rh=T(^h^{_&uKyR zv@&7MNr_c>Y$w8i!qN)30UY3Hbp4k<3*=W221TQfr?abHuxs(>@8JbSJV6{BrJp{Q zgfS$A?@tKVL&`{?ByjC=?55RB3=GSFSPG~Yngk%R3yCtIi}ecf(ixXAMgHv!@N?(o zk^<&g23}7OmmnZ50m2+?K=MJk?GGTuQtadz!T|&|94Q?@K4*bPWHAE+-w_aIoT|+y z4HT3tag8Vm&QB{TPb^AhC@(M9%goCzPEIUH)dMDi+3#$Cj$u;vba4#v=v;a&Hlr_5 zg8jq&oMW?kYqoGyzjerT{ZzO~HC{7tnn$39D*LHUW=jX%^ivo4WIS8S6k4VzZOv#k zur#=D$Yabt$HQ{Ry{ns#f8O){%>H@v?!Dgk?)R@9>;M0+)PAy9P&c9}%I8q}o9R{5k#E7QA2I>)9L$(VN?Za0YA@>=NFpW~LQhG8*(CN9~Sa({zN?hJjkmHg&~ zeDOwqq%SBhTR;6z_nhX_NsD$}=Z{n8Ds3d1$WyFWN?(dcBeIci(7yCcqd0twf(lPCboXzfHEpym)ylG(zoz@|_+GXsMWFe8BK zQPf%zTO~5_-4aMPn07ZMJ-uvSe%ih_H-Daw zXE56!v#9U3@128p+1|D8=x1jXW3o}X5}&>JuG+(=UMZU+ZcH@Vd3s9GN|{dO*~^or zh-@_5c|-T@wx1cBL#%Rr|G$)5`0W^<=t9}d#rH&C?mK07;%|%c+!JyqQvB0y{hpj~ zR`%7L4d3=h&F>QaxX(gz`Ws`v;>bh4u2!p@DZCb@7QFTBShLUwa^sR1_V#A-eCfZEXWyxTvxZ=d$-O}oP zEb^`4lJY-Ek3$=d>*_q@O#G@PRD3yD(|g8O-AgdaC}duDd?c z<_S_WtA6Tp3O7ysE~NHmolAXy72k0k4Y9&r`?c|+6T%zLt5wf_6Mo~`eB1wwzryyl z*R-XYq+BVzci@i&x9%N{$X7EQXIoY<-I-Ic_vsw1+t12FtgZ%M`L`^)_~y+?>&*T3 zEXZEeY`N^?_UM|=zGdED{^SREGct)V<8DBM%0vbR0fx7ZAR69AhBT*PTCq2%K^j0{ zNuxH9glk1=UL#wMtuYDK4z|1ym@?r_OPIBoEl^P75}|1tLKCd1iO`Czv5C-n5M3** z>4`7^TjLX9z$c&qkftbZ9iYZ2LWc;j`GlG2kb?-_Mo?o7q2C3oerQt_;RtMvRfHjx zxDA2jd}J44YrG;1+eX+hNK+QK>p+cJgn{1)8whFI!VJXTxP=+Hq|pLc*g>1R2ya0& zp;!3`O(j50xZAkM=3r|&Aj}B|Hh8g^18qnkn}e-H)r0>%I0gB_)c*_VVK~-RhuGi+n>1gdKvSi4JLaMPj9-x zazXIki?`R$tdIPv6*h^>QBSTpuS!8$d=Iyk+TYYjo3F{)I(M^@?dyHRuZK=mue|!m zE3M#iwu@^_#>~$NhHMQM8RzfG@|~IQaiZ_>k+R1n*HYffCJ6WRKmT*>C?At$&$gKp z+qqrqjFFlkG)bCVg39 z@!v3AOzFD1mhC4?GvC6^&-Tr{JkxP|!<{AkMLTCaX*xf5PpY$w8i!qN)30UY3Hbp4k<3*=W221TQfr?abHuxs(>@8JbSJV6{BrJp{Q zgfS$A?@tKVL&`{?ByjC=?55RB3=GSFSPG~Yngk%R3yCtIi}ecf(ixXAMgHv!@N?(o zk^<&g23}7OmmnZ50m2+?K=MJk?GGTuQtadz!T|&|94Q?@K4*bPWHAE+-w_aIoT|+y z4HT3tag8Vm&QB{TPb^AhC@(M9%goCzPEIUH)dMDi+3#$Cj$u;vba4#v=v;a&Hlr_5 zg8jq&oMW?kYqoGyzjerT{ZzO~HC{7tnn$39D*LHUW=jX%^ivo4WIS8S6k4VzZOv#k zur#=D$Yabt$HQ{Ry{ns#f8O){%>H@v?!Dgk?)R@9>;M0+)PAy9P&c9}%I8q}o9R{5k#E7QA2I>)9L$(VN?Za0YA@>=NFpW~LQhG8*(CN9~Sa({zN?hJjkmHg&~ zeDOwqq%SBhTR;6z_nhX_NsD$}=Z{n8Ds3d1$WyFWN?(dcBeIci(7yCcqd0twf(lPCboXzfHEOx;qxoqyJ6Yy~!j%9$A$jDQ&d zRF9(8lHghoR)K-4kigQ40C0V#mz#$Y0tk{3WZMW>9?yo1(Hf~T(Et;)&K&r?*pOwVbRkx$V`wq&#)+WOq(?tBJPLPA)vN<-7X9 zS=JXV6F=8)wG(;%D7Vl~?`Ha(XPa8qzW(kp|oPTA)hX3a)A3Jsb zMPI_dht#L0;-1+Oh*GCZ=PU)aN9gKOEEvaRBo&x$^s4X#v+=D5J|VMnXnG>-1@ zp3N7NJ>KX1{u$QrR4i#a0VO{}^5&dMnPTU(V&7JqV$E}W40 zn9WBySpUChqLaa=xI-;>zrNu2I{t75>rtV+56i!cWcbI?r z`-JlwdfIw+os^D{NMG0*t?DgnoMFuF-*8)a-Ss)aski?$c`g4Xx^@4{TQOzZmb~s2 z)_*zcMM7WZpWJ!*`%dO{#{J+8@MdHZVaDBn29=2n3<3;q9YHj_jSOi{!?a>=P=hpp zz>-F7APLus)VxNv99v@&tQ~B5Auwgao0c$ZF0Jg>_!hlae10YRN+&VywQG^Z=VDkwx(;){Dx{aX58bZGdR{hYXD#8)i8mkCH zDsdYE%lXJI!q#|27`BbDVUVUQZr6btvj_vf6E+aiw1pXny>SaOa!I2Fu&{$RbrIfz zXhN^@5t>SXnsB#qkIB4s7sZF$da^KsEG$t^T| zwMrgat48Nn+0A@BZ2SUlPjBo#I&tS@&YOj^ZsyH8KXb}n=A6A{56|T1yf`@daLO%L zNrs6B*0_m#-rb*Y$9vKy0bX6HsB8L3s;iyEM5C{!?l~<|^*Z_VW$!Z0?+ebhtJHGv zsXn(qJG1e?)stTRH3ydony0?I-RjrBius9E-Gu2^W5Q}~o}8&CIp2B9k;g6#How_m z!N|Z6#6I5}DZm-nft<|T#Prl+ecXz85sEUC^Yf6EI<-lm#Go*`QX`WJBNHUE{m~r2 z0@RRSl#WM*5L88eL26!cNl|KQNp4~R9`)i_)o0}w=OSrxKy$Y|ZcPO_rRkX{o}SZ! z>S<-dnv)W%@Yqg-0fnU%a058N(dhawe-_BEAPkB|A5UjjzhKwm&)>rfig zPZ}sFS>hT|5}cn_Ql40p%1~Zju9umYU7Va)kg5kv1he1S03E}m?CIhd;?cSET5LvN zq6GVg`#HyE_10|RsDA5^>H4W~lWM$X;53gw4ORA2oy?XFy6LAb^2vC%lqs}KQQDf( zYG7$_-;l?ceU69aj(b-(AOF1P{h9sq=G}X}@7?cTJJ$dIU#b0Mv7l~5QZl~$&Ak93YrFOo6uI^1p$x8=3au|LNxRSm;p{!Co5G3EXSncNxrYAgB8 z3;E)W{zzX?UbcSvpYA!$r;`@#y3pBO(JgAB_wG$$)_wkvWMRE0skZB9ytMoIH|Lo5 zn{yGXg_UFHZ{6r8kQp8Kg=N+S{Z+n?XRUa&UQG57!!37#2hwWEnt4mEr6uLviqn*s zIW^EUE%in;EBmDzS`~(Cj(2}>+@jIRW^>fGWXZK(hN{X36x5b6i+s>ITq(XTY3hVl z6{({ROAJE`dsYh_llpU}U|ySfMNrM88;#nM)m#`SU#<&@9U1{%cp7_gfg_{_N6YldF265T(Y`a%8!u5r8D-# z>727#5hEQ{7%=6o@~_|A#v26mU99~@-~N|L;MnTqwTwIVmGBbn-}#UDlN&P6&517( z1EwhkPgg&ebxsLQumX&O0aPjxk;H*{YBY(DCh;Me#QS2TeQzFlszL%wD+0jvnO<^EVsY`*pxb%Eh61*eTXHtFEL-BcQ|!|0kOiw$ zGv+t_Y6@AI)ZNwe>z!HJ>#Xa1yYF546#juhh`)wGzEvWB5!XVcpy*E($BNILk@@+2 z{d;?coJ3t0+45OCx~qBb@PB0BXVzh>a9Oecira44L*J@WHb>l;XteY6l%ka~ox!u0 zCruIAXtvWrG zIpOTw7jriJ+#e<1Rs3n!7&BvijAp8eN=!Wx|I4=PMsO zb^qmDVjnu``ohG?i7y4OEn_k~vZ7zu!(xML*_yJg;+fBiKAjD&REy@g!0};6tK2k> z?(m+?7n42S=e#~z*6>s;Y=hU09eqdcd$ykzi6V9!Kb)GEqA}Z;P*QIa0cs9p}Y^vzpiHb#P#83N`CuauG_yZr{8y& zfBO4`^Ba2FdUlMz$PVV-l<#Yi`z6JY?h#wWsn&p-npO;OxBK#fs^4pCt92{Y3n2NAlBpvD?PzbjV#(55QF5!f25 z2t%rH8v@Ju$S%Uxctsetov>k$rYvsPff}<21Ah=U5Yn`T8Hl}c3o~*_qb0DggEn;$ z-hyaCuksO^N`abiw{elp!Pay@m=ghP@M19s+K@mt2V41!Fvpq`Tf!k!S_gQuf*RZm O{6P2<=pzSi5Dx$(mo^sw literal 0 HcmV?d00001 diff --git a/test/unit/org/openstreetmap/josm/gui/preferences/plugin/PluginPreferenceHighLevelTest.java b/test/unit/org/openstreetmap/josm/gui/preferences/plugin/PluginPreferenceHighLevelTest.java index de22b0332..e78ddf742 100644 --- a/test/unit/org/openstreetmap/josm/gui/preferences/plugin/PluginPreferenceHighLevelTest.java +++ b/test/unit/org/openstreetmap/josm/gui/preferences/plugin/PluginPreferenceHighLevelTest.java @@ -803,7 +803,6 @@ public class PluginPreferenceHighLevelTest { TestUtils.syncEDTAndWorkerThreads(); assertEquals(1, jopsMocker.getInvocationLog().size()); - org.openstreetmap.josm.tools.Logging.error(jopsMocker.getInvocationLog().get(0)[0].toString()); Object[] invocationLogEntry = jopsMocker.getInvocationLog().get(0); assertEquals(JOptionPane.OK_OPTION, (int) invocationLogEntry[0]); assertEquals("Warning", invocationLogEntry[2]); @@ -817,6 +816,11 @@ public class PluginPreferenceHighLevelTest { // dummy_plugin was fetched this.pluginServerRule.verify(1, WireMock.getRequestedFor(WireMock.urlEqualTo("/plugin/dummy_plugin.v31772.jar"))); + // the dummy_plugin jar has been installed + TestUtils.assertFileContentsEqual(this.referenceDummyJarNew, this.targetDummyJar); + // the baz_plugin jar has not + assertFalse(this.targetBazJar.exists()); + // loadPlugins(...) was called (with expected parameters) assertTrue(loadPluginsCalled[0]); @@ -826,4 +830,124 @@ public class PluginPreferenceHighLevelTest { // questionably correct assertEquals("999", Config.getPref().get("pluginmanager.lastupdate", "111")); } + + /** + * Tests installing a single plugin which has multiple versions advertised, with our JOSM version + * preventing us from using the latest version + * @throws Exception on failure + */ + @JOSMTestRules.OverrideAssumeRevision("Revision: 7000\n") + @Test + public void testInstallMultiVersion() throws Exception { + TestUtils.assumeWorkingJMockit(); + + final String bazOldServePath = "/baz/old.jar"; + final PluginServer pluginServer = new PluginServer( + new PluginServer.RemotePlugin(this.referenceDummyJarNew), + new PluginServer.RemotePlugin(this.referenceBazJarNew, ImmutableMap.of( + "6800_Plugin-Url", "6;http://localhost:" + this.pluginServerRule.port() + bazOldServePath + )) + ); + pluginServer.applyToWireMockServer(this.pluginServerRule); + // need to actually serve this older jar from somewhere + this.pluginServerRule.stubFor( + WireMock.get(WireMock.urlEqualTo(bazOldServePath)).willReturn( + WireMock.aResponse().withStatus(200).withHeader("Content-Type", "application/java-archive").withBodyFile( + "plugin/baz_plugin.v6.jar" + ) + ) + ); + Config.getPref().putList("plugins", ImmutableList.of()); + + final HelpAwareOptionPaneMocker haMocker = new HelpAwareOptionPaneMocker(ImmutableMap.of( + "The following plugin has been downloaded successfully:" + + "
  • baz_plugin (6)
" + + "You have to restart JOSM for some settings to take effect.

" + + "Would you like to restart now?", + "Cancel" + )); + final JOptionPaneSimpleMocker jopsMocker = new JOptionPaneSimpleMocker(); + + final PreferenceTabbedPane tabbedPane = new PreferenceTabbedPane(); + + tabbedPane.buildGui(); + // PluginPreference is already added to PreferenceTabbedPane by default + tabbedPane.selectTabByPref(PluginPreference.class); + + GuiHelper.runInEDTAndWait( + () -> ((javax.swing.JButton) TestUtils.getComponentByName(tabbedPane, "downloadListButton")).doClick() + ); + + TestUtils.syncEDTAndWorkerThreads(); + + this.pluginServerRule.verify(1, WireMock.getRequestedFor(WireMock.urlEqualTo("/plugins"))); + WireMock.resetAllRequests(); + + final PluginPreferencesModel model = (PluginPreferencesModel) TestUtils.getPrivateField( + tabbedPane.getPluginPreference(), + "model" + ); + + assertTrue(model.getNewlyActivatedPlugins().isEmpty()); + assertTrue(model.getNewlyDeactivatedPlugins().isEmpty()); + assertTrue(model.getPluginsScheduledForUpdateOrDownload().isEmpty()); + assertEquals(model.getDisplayedPlugins(), model.getAvailablePlugins()); + + assertEquals( + ImmutableList.of("baz_plugin", "dummy_plugin"), + model.getAvailablePlugins().stream().map((pi) -> pi.getName()).collect(ImmutableList.toImmutableList()) + ); + assertTrue(model.getSelectedPlugins().isEmpty()); + assertEquals( + ImmutableList.of("(null)", "(null)"), + model.getAvailablePlugins().stream().map( + (pi) -> pi.localversion == null ? "(null)" : pi.localversion + ).collect(ImmutableList.toImmutableList()) + ); + assertEquals( + ImmutableList.of("6", "31772"), + model.getAvailablePlugins().stream().map((pi) -> pi.version).collect(ImmutableList.toImmutableList()) + ); + + // now we select dummy_plugin + model.setPluginSelected("baz_plugin", true); + + // model should now reflect this + assertEquals( + ImmutableList.of("baz_plugin"), + model.getNewlyActivatedPlugins().stream().map( + pi -> pi.getName() + ).collect(ImmutableList.toImmutableList()) + ); + assertTrue(model.getNewlyDeactivatedPlugins().isEmpty()); + + tabbedPane.savePreferences(); + + TestUtils.syncEDTAndWorkerThreads(); + + assertEquals(1, haMocker.getInvocationLog().size()); + Object[] invocationLogEntry = haMocker.getInvocationLog().get(0); + assertEquals(1, (int) invocationLogEntry[0]); + assertEquals("Restart", invocationLogEntry[2]); + + assertTrue(jopsMocker.getInvocationLog().isEmpty()); + + // any .jar.new files should have been deleted + assertFalse(targetDummyJarNew.exists()); + assertFalse(targetBazJarNew.exists()); + + // dummy_plugin was fetched + this.pluginServerRule.verify(1, WireMock.getRequestedFor(WireMock.urlEqualTo(bazOldServePath))); + + // the "old" baz_plugin jar has been installed + TestUtils.assertFileContentsEqual(this.referenceBazJarOld, this.targetBazJar); + // the dummy_plugin jar has not + assertFalse(this.targetDummyJar.exists()); + + // pluginmanager.version has been set to the current version + assertEquals(7000, Config.getPref().getInt("pluginmanager.version", 111)); + // pluginmanager.lastupdate hasn't been updated + // questionably correct + assertEquals("999", Config.getPref().get("pluginmanager.lastupdate", "111")); + } } diff --git a/test/unit/org/openstreetmap/josm/plugins/PluginHandlerJOSMTooOldTest.java b/test/unit/org/openstreetmap/josm/plugins/PluginHandlerJOSMTooOldTest.java index ec880aee1..dd3785f1c 100644 --- a/test/unit/org/openstreetmap/josm/plugins/PluginHandlerJOSMTooOldTest.java +++ b/test/unit/org/openstreetmap/josm/plugins/PluginHandlerJOSMTooOldTest.java @@ -66,23 +66,37 @@ public class PluginHandlerJOSMTooOldTest { this.referenceDummyJarNew = new File(TestUtils.getTestDataRoot(), "__files/plugin/dummy_plugin.v31772.jar"); this.referenceBazJarOld = new File(TestUtils.getTestDataRoot(), "__files/plugin/baz_plugin.v6.jar"); this.referenceBazJarNew = new File(TestUtils.getTestDataRoot(), "__files/plugin/baz_plugin.v7.jar"); + this.referenceQuxJarOld = new File(TestUtils.getTestDataRoot(), "__files/" + referencePathQuxJarOld); + this.referenceQuxJarNew = new File(TestUtils.getTestDataRoot(), "__files/" + referencePathQuxJarNew); + this.referenceQuxJarNewer = new File(TestUtils.getTestDataRoot(), "__files/" + referencePathQuxJarNewer); this.pluginDir = Preferences.main().getPluginsDirectory(); this.targetDummyJar = new File(this.pluginDir, "dummy_plugin.jar"); this.targetDummyJarNew = new File(this.pluginDir, "dummy_plugin.jar.new"); this.targetBazJar = new File(this.pluginDir, "baz_plugin.jar"); this.targetBazJarNew = new File(this.pluginDir, "baz_plugin.jar.new"); + this.targetQuxJar = new File(this.pluginDir, "qux_plugin.jar"); + this.targetQuxJarNew = new File(this.pluginDir, "qux_plugin.jar.new"); this.pluginDir.mkdirs(); } + private static final String referencePathQuxJarOld = "plugin/qux_plugin.v345.jar"; + private static final String referencePathQuxJarNew = "plugin/qux_plugin.v346.jar"; + private static final String referencePathQuxJarNewer = "plugin/qux_plugin.v432.jar"; + private File pluginDir; private File referenceDummyJarOld; private File referenceDummyJarNew; private File referenceBazJarOld; private File referenceBazJarNew; + private File referenceQuxJarOld; + private File referenceQuxJarNew; + private File referenceQuxJarNewer; private File targetDummyJar; private File targetDummyJarNew; private File targetBazJar; private File targetBazJarNew; + private File targetQuxJar; + private File targetQuxJarNew; private final String bazPluginVersionReqString = "JOSM version 8,001 required for plugin baz_plugin."; private final String dummyPluginVersionReqString = "JOSM version 7,001 required for plugin dummy_plugin."; @@ -282,4 +296,66 @@ public class PluginHandlerJOSMTooOldTest { assertEquals(Config.getPref().getInt("pluginmanager.version", 111), 6000); assertNotEquals(Config.getPref().get("pluginmanager.lastupdate", "999"), "999"); } + + /** + * When a plugin advertises several versions for compatibility with older JOSMs, but even the + * oldest of those is newer than our JOSM version, the user is prompted to upgrade to the newest + * version anyway. + * + * While this behaviour is not incorrect, it's probably less helpful than it could be - the + * version that's most likely to work best in this case will be the "oldest" still-available + * version, however this test documents the behaviour. + * @throws IOException never + */ + @Test + @JOSMTestRules.OverrideAssumeRevision("Revision: 7200\n") + public void testUpdatePluginsMultiVersionInsufficient() throws Exception { + TestUtils.assumeWorkingJMockit(); + + final String quxNewServePath = "/qux/new.jar"; + final PluginServer pluginServer = new PluginServer( + new PluginServer.RemotePlugin(this.referenceBazJarOld), + new PluginServer.RemotePlugin(this.referenceQuxJarNewer, ImmutableMap.of( + "7499_Plugin-Url", "346;http://localhost:" + this.pluginServerRule.port() + "/dont/bother.jar" + )) + ); + pluginServer.applyToWireMockServer(this.pluginServerRule); + Config.getPref().putList("plugins", ImmutableList.of("qux_plugin", "baz_plugin")); + + new ExtendedDialogMocker(ImmutableMap.of("JOSM version 7,500 required for plugin qux_plugin.", "Download Plugin")); + + Files.copy(this.referenceQuxJarOld.toPath(), this.targetQuxJar.toPath()); + Files.copy(this.referenceBazJarOld.toPath(), this.targetBazJar.toPath()); + + final List updatedPlugins = PluginHandler.updatePlugins( + MainApplication.getMainFrame(), + null, + null, + false + ).stream().sorted((a, b) -> a.name.compareTo(b.name)).collect(ImmutableList.toImmutableList()); + + assertEquals(2, updatedPlugins.size()); + + assertEquals("baz_plugin", updatedPlugins.get(0).name); + assertEquals("6", updatedPlugins.get(0).localversion); + + assertEquals("qux_plugin", updatedPlugins.get(1).name); + // questionably correct + assertEquals("432", updatedPlugins.get(1).localversion); + + assertFalse(targetQuxJarNew.exists()); + + TestUtils.assertFileContentsEqual(this.referenceBazJarOld, this.targetBazJar); + // questionably correct + TestUtils.assertFileContentsEqual(this.referenceQuxJarNewer, this.targetQuxJar); + + assertEquals(2, WireMock.getAllServeEvents().size()); + this.pluginServerRule.verify(1, WireMock.getRequestedFor(WireMock.urlEqualTo("/plugins"))); + // questionably correct + this.pluginServerRule.verify(1, WireMock.getRequestedFor(WireMock.urlEqualTo("/plugin/qux_plugin.v432.jar"))); + + assertEquals(7200, Config.getPref().getInt("pluginmanager.version", 111)); + // not mocking the time so just check it's not its original value + assertNotEquals("999", Config.getPref().get("pluginmanager.lastupdate", "999")); + } } diff --git a/test/unit/org/openstreetmap/josm/plugins/PluginHandlerMultiVersionTest.java b/test/unit/org/openstreetmap/josm/plugins/PluginHandlerMultiVersionTest.java new file mode 100644 index 000000000..6ca9e853a --- /dev/null +++ b/test/unit/org/openstreetmap/josm/plugins/PluginHandlerMultiVersionTest.java @@ -0,0 +1,215 @@ +// License: GPL. For details, see LICENSE file. +package org.openstreetmap.josm.plugins; + +import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.options; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertNotEquals; + +import java.io.File; +import java.nio.file.Files; +import java.util.List; + +import org.junit.Before; +import org.junit.Rule; +import org.junit.Test; +import org.openstreetmap.josm.TestUtils; +import org.openstreetmap.josm.data.Preferences; +import org.openstreetmap.josm.gui.MainApplication; +import org.openstreetmap.josm.spi.preferences.Config; +import org.openstreetmap.josm.testutils.JOSMTestRules; +import org.openstreetmap.josm.testutils.PluginServer; +import org.openstreetmap.josm.testutils.mockers.ExtendedDialogMocker; + +import com.github.tomakehurst.wiremock.client.WireMock; +import com.github.tomakehurst.wiremock.junit.WireMockRule; +import com.google.common.collect.ImmutableList; +import com.google.common.collect.ImmutableMap; + +import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; + +/** + * Test parts of {@link PluginHandler} class with plugins that advertise multiple versions for compatibility. + */ +public class PluginHandlerMultiVersionTest { + /** + * Setup test. + */ + @Rule + @SuppressFBWarnings(value = "URF_UNREAD_PUBLIC_OR_PROTECTED_FIELD") + public JOSMTestRules test = new JOSMTestRules().preferences().main(); + + /** + * Plugin server mock. + */ + @Rule + public WireMockRule pluginServerRule = new WireMockRule( + options().dynamicPort().usingFilesUnderDirectory(TestUtils.getTestDataRoot()) + ); + + /** + * Setup test. + */ + @Before + public void setUp() { + Config.getPref().putInt("pluginmanager.version", 999); + Config.getPref().put("pluginmanager.lastupdate", "999"); + Config.getPref().putList("pluginmanager.sites", + ImmutableList.of(String.format("http://localhost:%s/plugins", this.pluginServerRule.port())) + ); + + this.referenceBazJarOld = new File(TestUtils.getTestDataRoot(), "__files/plugin/baz_plugin.v6.jar"); + this.referenceBazJarNew = new File(TestUtils.getTestDataRoot(), "__files/plugin/baz_plugin.v7.jar"); + this.referenceQuxJarOld = new File(TestUtils.getTestDataRoot(), "__files/" + referencePathQuxJarOld); + this.referenceQuxJarNew = new File(TestUtils.getTestDataRoot(), "__files/" + referencePathQuxJarNew); + this.referenceQuxJarNewer = new File(TestUtils.getTestDataRoot(), "__files/" + referencePathQuxJarNewer); + this.referenceQuxJarNewest = new File(TestUtils.getTestDataRoot(), "__files/" + referencePathQuxJarNewest); + this.pluginDir = Preferences.main().getPluginsDirectory(); + this.targetBazJar = new File(this.pluginDir, "baz_plugin.jar"); + this.targetBazJarNew = new File(this.pluginDir, "baz_plugin.jar.new"); + this.targetQuxJar = new File(this.pluginDir, "qux_plugin.jar"); + this.targetQuxJarNew = new File(this.pluginDir, "qux_plugin.jar.new"); + this.pluginDir.mkdirs(); + } + + private static final String referencePathQuxJarOld = "plugin/qux_plugin.v345.jar"; + private static final String referencePathQuxJarNew = "plugin/qux_plugin.v346.jar"; + private static final String referencePathQuxJarNewer = "plugin/qux_plugin.v432.jar"; + private static final String referencePathQuxJarNewest = "plugin/qux_plugin.v435.jar"; + + private File pluginDir; + private File referenceBazJarOld; + private File referenceBazJarNew; + private File referenceQuxJarOld; + private File referenceQuxJarNew; + private File referenceQuxJarNewer; + private File referenceQuxJarNewest; + private File targetBazJar; + private File targetBazJarNew; + private File targetQuxJar; + private File targetQuxJarNew; + + /** + * test update of plugins when our current JOSM version prevents us from using the latest version, + * but an additional version is listed which *does* support our version + * @throws Exception on failure + */ + @JOSMTestRules.OverrideAssumeRevision("Revision: 7501\n") + @Test + public void testUpdatePluginsOneMultiVersion() throws Exception { + TestUtils.assumeWorkingJMockit(); + + final String quxNewerServePath = "/qux/newer.jar"; + final PluginServer pluginServer = new PluginServer( + new PluginServer.RemotePlugin(this.referenceBazJarOld), + new PluginServer.RemotePlugin(this.referenceQuxJarNewest, ImmutableMap.of( + "7500_Plugin-Url", "432;http://localhost:" + this.pluginServerRule.port() + quxNewerServePath, + "7499_Plugin-Url", "346;http://localhost:" + this.pluginServerRule.port() + "/not/served.jar", + "6999_Plugin-Url", "345;http://localhost:" + this.pluginServerRule.port() + "/not/served/either.jar" + )) + ); + pluginServer.applyToWireMockServer(this.pluginServerRule); + // need to actually serve this older jar from somewhere + this.pluginServerRule.stubFor( + WireMock.get(WireMock.urlEqualTo(quxNewerServePath)).willReturn( + WireMock.aResponse().withStatus(200).withHeader("Content-Type", "application/java-archive").withBodyFile( + referencePathQuxJarNewer + ) + ) + ); + Config.getPref().putList("plugins", ImmutableList.of("qux_plugin", "baz_plugin")); + + // catch any (unexpected) attempts to show us an ExtendedDialog + new ExtendedDialogMocker(); + + Files.copy(this.referenceQuxJarOld.toPath(), this.targetQuxJar.toPath()); + Files.copy(this.referenceBazJarOld.toPath(), this.targetBazJar.toPath()); + + final List updatedPlugins = PluginHandler.updatePlugins( + MainApplication.getMainFrame(), + null, + null, + false + ).stream().sorted((a, b) -> a.name.compareTo(b.name)).collect(ImmutableList.toImmutableList()); + + assertEquals(2, updatedPlugins.size()); + + assertEquals("baz_plugin", updatedPlugins.get(0).name); + assertEquals("6", updatedPlugins.get(0).localversion); + + assertEquals("qux_plugin", updatedPlugins.get(1).name); + assertEquals("432", updatedPlugins.get(1).localversion); + + assertFalse(targetBazJarNew.exists()); + assertFalse(targetQuxJarNew.exists()); + + TestUtils.assertFileContentsEqual(this.referenceBazJarOld, this.targetBazJar); + TestUtils.assertFileContentsEqual(this.referenceQuxJarNewer, this.targetQuxJar); + + assertEquals(2, WireMock.getAllServeEvents().size()); + this.pluginServerRule.verify(1, WireMock.getRequestedFor(WireMock.urlEqualTo("/plugins"))); + this.pluginServerRule.verify(1, WireMock.getRequestedFor(WireMock.urlEqualTo(quxNewerServePath))); + + assertEquals(7501, Config.getPref().getInt("pluginmanager.version", 111)); + // not mocking the time so just check it's not its original value + assertNotEquals("999", Config.getPref().get("pluginmanager.lastupdate", "999")); + } + + /** + * test update of plugins when our current JOSM version prevents us from using all but the version + * we already have, which is still listed. + * @throws Exception on failure + */ + @JOSMTestRules.OverrideAssumeRevision("Revision: 7000\n") + @Test + public void testUpdatePluginsExistingVersionLatestPossible() throws Exception { + TestUtils.assumeWorkingJMockit(); + + final PluginServer pluginServer = new PluginServer( + new PluginServer.RemotePlugin(this.referenceBazJarOld), + new PluginServer.RemotePlugin(this.referenceQuxJarNewest, ImmutableMap.of( + "7500_Plugin-Url", "432;http://localhost:" + this.pluginServerRule.port() + "/dont.jar", + "7499_Plugin-Url", "346;http://localhost:" + this.pluginServerRule.port() + "/even.jar", + "6999_Plugin-Url", "345;http://localhost:" + this.pluginServerRule.port() + "/bother.jar" + )) + ); + pluginServer.applyToWireMockServer(this.pluginServerRule); + Config.getPref().putList("plugins", ImmutableList.of("qux_plugin", "baz_plugin")); + + // catch any (unexpected) attempts to show us an ExtendedDialog + new ExtendedDialogMocker(); + + Files.copy(this.referenceQuxJarOld.toPath(), this.targetQuxJar.toPath()); + Files.copy(this.referenceBazJarOld.toPath(), this.targetBazJar.toPath()); + + final List updatedPlugins = PluginHandler.updatePlugins( + MainApplication.getMainFrame(), + null, + null, + false + ).stream().sorted((a, b) -> a.name.compareTo(b.name)).collect(ImmutableList.toImmutableList()); + + assertEquals(2, updatedPlugins.size()); + + assertEquals("baz_plugin", updatedPlugins.get(0).name); + assertEquals("6", updatedPlugins.get(0).localversion); + + assertEquals("qux_plugin", updatedPlugins.get(1).name); + assertEquals("345", updatedPlugins.get(1).localversion); + + assertFalse(targetBazJarNew.exists()); + assertFalse(targetQuxJarNew.exists()); + + // should be as before + TestUtils.assertFileContentsEqual(this.referenceBazJarOld, this.targetBazJar); + TestUtils.assertFileContentsEqual(this.referenceQuxJarOld, this.targetQuxJar); + + // only the plugins list should have been downloaded + assertEquals(1, WireMock.getAllServeEvents().size()); + this.pluginServerRule.verify(1, WireMock.getRequestedFor(WireMock.urlEqualTo("/plugins"))); + + assertEquals(7000, Config.getPref().getInt("pluginmanager.version", 111)); + // not mocking the time so just check it's not its original value + assertNotEquals("999", Config.getPref().get("pluginmanager.lastupdate", "999")); + } +} -- 2.11.0