Classes

Class	Line #	Total Statements	% Filtered	Complexity	Uncovered Elements	TOTAL Coverage	Actions
MigrateEhCache2ConfigurationTask	64	58	0%	11	6	0.9292%	Show methods

Class MigrateEhCache2ConfigurationTask

Class MigrateEhCache2ConfigurationTask	Line # 64	Total Statements 58	% Filtered 0%	Complexity 11	Uncovered Elements 6	TOTAL Coverage 0.9292%
MigrateEhCache2ConfigurationTask()   MigrateEhCache2ConfigurationTask()	7373	1.01	0.00%	1.01	0.00	1.0 1.0100%
doExecute(InstallContext) : void   doExecute(InstallContext) : void	7777	51.051	0.00%	8.08	6.06	0.9047619 0.904761990.5%
getValueAndRemove(Node,String,String) : String   getValueAndRemove(Node,String,String) : String	146146	6.06	0.00%	2.02	0.00	1.0 1.0100%

 

Contributing tests

Contributing tests

Select all

	Test contribution	Test	Result	Actions
	0.88	info.magnolia.module.cache.ehcache3.setup.EhCache3ModuleVersionHandlerTest.upgradeFromEhcache2info.magnolia.module.cache.ehcache3.setup.EhCache3ModuleVersionHandlerTest.upgradeFromEhcache2	1PASS
	0.8	info.magnolia.module.cache.ehcache3.setup.EhCache3ModuleVersionHandlerTest.upgradeFromEhcache1info.magnolia.module.cache.ehcache3.setup.EhCache3ModuleVersionHandlerTest.upgradeFromEhcache1	1PASS
	0.026666667	info.magnolia.module.cache.ehcache3.setup.EhCache3ModuleVersionHandlerTest.cleanInstallinfo.magnolia.module.cache.ehcache3.setup.EhCache3ModuleVersionHandlerTest.cleanInstall	1PASS

 

Source view

1		/**
2		* This file Copyright (c) 2017-2018 Magnolia International
3		* Ltd. (http://www.magnolia-cms.com). All rights reserved.
4		*
5		*
6		* This file is dual-licensed under both the Magnolia
7		* Network Agreement and the GNU General Public License.
8		* You may elect to use one or the other of these licenses.
9		*
10		* This file is distributed in the hope that it will be
11		* useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12		* implied warranty of MERCHANTABILITY or FITNESS FOR A
13		* PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14		* Redistribution, except as permitted by whichever of the GPL
15		* or MNA you select, is prohibited.
16		*
17		* 1. For the GPL license (GPL), you can redistribute and/or
18		* modify this file under the terms of the GNU General
19		* Public License, Version 3, as published by the Free Software
20		* Foundation. You should have received a copy of the GNU
21		* General Public License, Version 3 along with this program;
22		* if not, write to the Free Software Foundation, Inc., 51
23		* Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24		*
25		* 2. For the Magnolia Network Agreement (MNA), this file
26		* and the accompanying materials are made available under the
27		* terms of the MNA which accompanies this distribution, and
28		* is available at http://www.magnolia-cms.com/mna.html
29		*
30		* Any modifications to this file must keep this entire header
31		* intact.
32		*
33		*/
34		package info.magnolia.module.cache.ehcache3.setup;
35
36		import info.magnolia.jcr.util.NodeTypes;
37		import info.magnolia.jcr.util.NodeUtil;
38		import info.magnolia.jcr.util.PropertyUtil;
39		import info.magnolia.module.InstallContext;
40		import info.magnolia.module.cache.ehcache3.EhCache3Factory;
41		import info.magnolia.module.cache.ehcache3.configuration.EhCache3ConfigurationBuilder;
42		import info.magnolia.module.cache.ehcache3.configuration.EhCache3Expiry;
43		import info.magnolia.module.cache.ehcache3.configuration.Ehcache3ResourcePoolBuilder;
44		import info.magnolia.module.cache.ehcache3.configuration.Ehcache3ResourcePoolsBuilder;
45		import info.magnolia.module.delta.AbstractRepositoryTask;
46		import info.magnolia.module.delta.RemoveNodeTask;
47		import info.magnolia.module.delta.TaskExecutionException;
48
49		import java.io.Serializable;
50
51		import javax.jcr.Node;
52		import javax.jcr.NodeIterator;
53		import javax.jcr.Property;
54		import javax.jcr.RepositoryException;
55		import javax.jcr.Session;
56
57		import org.ehcache.config.ResourceType;
58		import org.ehcache.config.units.EntryUnit;
59		import org.ehcache.config.units.MemoryUnit;
60
61		/**
62		* <code>VersionHandler</code> implementation for the EhCache3 module.
63		*/
		92% Uncovered Elements: 6 (75) Complexity: 11 Complexity Density: 0.19
64		public class MigrateEhCache2ConfigurationTask extends AbstractRepositoryTask {
65
66		private static final String[] NOT_SUPPORTED_PROPERTIES = new String[]{
67		"diskSpoolBufferSizeMB",
68		"diskExpiryThreadIntervalSeconds",
69		"memoryStoreEvictionPolicy",
70		"timeToIdleSeconds",
71		};
72
		100% Uncovered Elements: 0 (1) Complexity: 1 Complexity Density: 1
73	3	public MigrateEhCache2ConfigurationTask() {...
74	3	super("EhCache persistence settings", "Migrates Ehcache 2.x config to Ehcache 3.x");
75		}
76
		90.5% Uncovered Elements: 6 (63) Complexity: 8 Complexity Density: 0.16
77	2	@Override...
78		protected void doExecute(InstallContext ctx) throws RepositoryException, TaskExecutionException {
79	2	final Session session = ctx.getConfigJCRSession();
80	2	final Node ehCacheFactory = session.getNode("/modules/cache/config/cacheFactory/delegateFactories/ehcache/");
81	2	final Property factoryClass = PropertyUtil.getPropertyOrNull(ehCacheFactory, "class");
82	2	if (!"info.magnolia.module.cache.ehcache.EhCacheFactory".equals(factoryClass.getString())) {
83	0	ctx.warn(String.format("Cannot migrate EhCache 2.x to EhCache3.x, expected {%s/%s}} but got {%s}", "/modules/cache/config/cacheFactory/class", "info.magnolia.module.cache.ehcache.EhCacheFactory", factoryClass.getString()));
84	0	return;
85		}
86	2	factoryClass.setValue(EhCache3Factory.class.getName());
87
88	2	NodeUtil.renameNode(ehCacheFactory, "ehcache3");
89
90	2	NodeIterator cachesIterator = ehCacheFactory.getNode("caches").getNodes();
91	4	while (cachesIterator.hasNext()) {
92	2	final Node cache = cachesIterator.nextNode();
93	2	cache.setProperty("class", EhCache3ConfigurationBuilder.class.getName());
94	2	cache.setProperty("keyType", Serializable.class.getName());
95	2	cache.setProperty("valueType", Serializable.class.getName());
96
97	2	final Node expiry = cache.addNode("expiry", NodeTypes.ContentNode.NAME);
98	2	expiry.setProperty("class", EhCache3Expiry.class.getName());
99	2	final String timeToLiveSeconds = getValueAndRemove(cache, "timeToLiveSeconds", null);
100	2	final String eternal = getValueAndRemove(cache, "eternal", Boolean.FALSE.toString());
101	2	if (Boolean.FALSE.toString().equals(eternal) && timeToLiveSeconds != null) {
102	1	expiry.setProperty("create", Long.valueOf(timeToLiveSeconds));
103		}
104	2	final Node resourcePoolsBuilder = cache.addNode("resourcePoolsBuilder", NodeTypes.ContentNode.NAME);
105	2	resourcePoolsBuilder.setProperty("class", Ehcache3ResourcePoolsBuilder.class.getName());
106	2	final Node resourcePools = resourcePoolsBuilder.addNode("pools", NodeTypes.ContentNode.NAME);
107
108	2	final Node heap = resourcePools.addNode("heap", NodeTypes.ContentNode.NAME);
109	2	heap.setProperty("class", Ehcache3ResourcePoolBuilder.class.getName());
110	2	heap.setProperty("resourceType", ResourceType.Core.HEAP.name());
111	2	heap.setProperty("resourceUnit", EntryUnit.ENTRIES.name());
112	2	heap.setProperty("size", Long.valueOf(getValueAndRemove(cache, "maxElementsInMemory", "10000")));
113
114	2	final Boolean overflowToOffHeap = Boolean.valueOf(getValueAndRemove(cache, "overflowToOffHeap", Boolean.FALSE.toString()));
115	2	if (overflowToOffHeap) {
116	1	final String maxBytesLocalOffHeap = getValueAndRemove(cache, "maxBytesLocalOffHeap", null);
117	1	final Node offHeap = resourcePools.addNode("offheap", NodeTypes.ContentNode.NAME);
118	1	offHeap.setProperty("class", Ehcache3ResourcePoolBuilder.class.getName());
119	1	offHeap.setProperty("resourceType", ResourceType.Core.OFFHEAP.name());
120	1	offHeap.setProperty("resourceUnit", MemoryUnit.MB.name());
121	1	offHeap.setProperty("size", Long.valueOf(maxBytesLocalOffHeap) / 1000000);
122		}
123
124		//remove not supported properties
125	2	for (String property : NOT_SUPPORTED_PROPERTIES) {
126	8	getValueAndRemove(cache, property, null);
127		}
128
129	2	final Node persistence = cache.getNode("persistence");
130	2	final String strategy = getValueAndRemove(persistence, "strategy", "LOCALTEMPSWAP").toUpperCase();
131	2	persistence.remove();
132	2	if ("DISTRIBUTED".equals(strategy)) {
133	0	ctx.warn(String.format("You are using {DISTRIBUTED} persistence. You have to extend {%s} and set up a clustered cache manager according to {%s} to support distributed configuration.", "info.magnolia.module.cache.ehcache3.EhCache3Factory.init()", "http://www.ehcache.org/documentation/3.3/clustered-cache.html#creating-a-cache-manager-with-clustering-capabilities"));
134	2	} else if (!"NONE".equals(strategy)) {
135	2	final Node disk = resourcePools.addNode("disk", NodeTypes.ContentNode.NAME);
136	2	disk.setProperty("class", Ehcache3ResourcePoolBuilder.class.getName());
137	2	disk.setProperty("persistent", Boolean.TRUE);
138	2	disk.setProperty("resourceType", ResourceType.Core.DISK.name());
139	2	disk.setProperty("resourceUnit", MemoryUnit.MB.name());
140	2	disk.setProperty("size", Long.valueOf(getValueAndRemove(cache, "maxElementsOnDisk", "10000000")) / 10000);
141		}
142		}
143	2	new RemoveNodeTask("", "/modules/ehcache").execute(ctx);
144		}
145
		100% Uncovered Elements: 0 (8) Complexity: 2 Complexity Density: 0.33
146	21	private String getValueAndRemove(Node node, String propertyName, String defaultValue) throws RepositoryException {...
147	21	String value = defaultValue;
148	21	if (node.hasProperty(propertyName)) {
149	13	final Property maxElementsInMemoryProperty = node.getProperty(propertyName);
150	13	value = maxElementsInMemoryProperty.getString();
151	13	maxElementsInMemoryProperty.remove();
152		}
153	21	return value;
154		}
155		}