Classes

Class	Line #	Total Statements	% Filtered	Complexity	Uncovered Elements	TOTAL Coverage	Actions
RestToolsModuleVersionHandler	60	5	0%	1	0	1.0100%	Show methods

Class RestToolsModuleVersionHandler

Class RestToolsModuleVersionHandler	Line # 60	Total Statements 5	% Filtered 0%	Complexity 1	Uncovered Elements 0	TOTAL Coverage 1.0100%
getExtraInstallTasks(InstallContext) : List<Task>   getExtraInstallTasks(InstallContext) : List<Task>	6565	5.05	0.00%	1.01	0.00	1.0 1.0100%

 

Contributing tests

Contributing tests

Select all

	Test contribution	Test	Result	Actions
	1.0	info.magnolia.rest.tools.setup.RestToolsModuleVersionHandlerTest.testBasicInstallinfo.magnolia.rest.tools.setup.RestToolsModuleVersionHandlerTest.testBasicInstall	1PASS

 

Source view

1		/**
2		* This file Copyright (c) 2013-2015 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.rest.tools.setup;
35
36		import static info.magnolia.nodebuilder.Ops.*;
37
38		import info.magnolia.cms.security.Permission;
39		import info.magnolia.jcr.util.NodeTypes;
40		import info.magnolia.module.DefaultModuleVersionHandler;
41		import info.magnolia.module.InstallContext;
42		import info.magnolia.module.delta.AddPermissionTask;
43		import info.magnolia.module.delta.CheckAndModifyPropertyValueTask;
44		import info.magnolia.module.delta.Task;
45		import info.magnolia.nodebuilder.task.ErrorHandling;
46		import info.magnolia.nodebuilder.task.NodeBuilderTask;
47		import info.magnolia.repository.RepositoryConstants;
48		import info.magnolia.rest.tools.SwaggerRestDispatcherServlet;
49		import info.magnolia.rest.RestDispatcherServlet;
50
51		import java.util.ArrayList;
52		import java.util.List;
53
54		import com.wordnik.swagger.jaxrs.listing.ApiDeclarationProvider;
55		import com.wordnik.swagger.jaxrs.listing.ResourceListingProvider;
56
57		/**
58		* Module version handler.
59		*/
		100% Uncovered Elements: 0 (6) Complexity: 1 Complexity Density: 0.2
60		public class RestToolsModuleVersionHandler extends DefaultModuleVersionHandler {
61
62		private final static String REST_DISPATCHER_SERVLET_PATH = "/server/filters/servlets/RestDispatcherServlet";
63		private final static String PATH_TO_REST_INTEGRATION_MODULE = "/modules/rest-integration";
64
		100% Uncovered Elements: 0 (5) Complexity: 1 Complexity Density: 0.2
65	1	@Override...
66		protected List<Task> getExtraInstallTasks(InstallContext installContext) {
67	1	List<Task> list = new ArrayList<Task>();
68
69	1	list.add(new CheckAndModifyPropertyValueTask("Replace dispatcher servlet", "Replace default dispatcher servlet with API-aware dispatcher servlet", RepositoryConstants.CONFIG,
70		REST_DISPATCHER_SERVLET_PATH, "servletClass", RestDispatcherServlet.class.getName(), SwaggerRestDispatcherServlet.class.getName()));
71
72		// Allow web access to '/.rest/api-docs' in role 'rest'
73	1	list.add(new AddPermissionTask("Update 'rest' role", "Allows access to the REST API documentation interface residing under '/.rest/api-docs' in role 'rest'.", "rest", "uri", "/.rest/api-docs*", Permission.ALL, false));
74
75		// Add additional providers to integration module
76	1	list.add(new NodeBuilderTask("Add additional providers", "Adds additional providers to rest-integration module config (needed for API documentation)", ErrorHandling.logging,
77		RepositoryConstants.CONFIG, PATH_TO_REST_INTEGRATION_MODULE + "/config",
78		getNode("additionalProviders").then(
79		addNode("apiDeclarationProvider", NodeTypes.ContentNode.NAME).then(
80		addProperty("providerClass", ApiDeclarationProvider.class.getName())
81		),
82		addNode("resourceListingProvider", NodeTypes.ContentNode.NAME).then(
83		addProperty("providerClass", ResourceListingProvider.class.getName())
84		)
85		)
86		));
87
88	1	return list;
89		}
90
91		}