1 |
|
|
2 |
|
|
3 |
|
|
4 |
|
|
5 |
|
|
6 |
|
|
7 |
|
|
8 |
|
|
9 |
|
|
10 |
|
|
11 |
|
|
12 |
|
|
13 |
|
|
14 |
|
|
15 |
|
|
16 |
|
|
17 |
|
|
18 |
|
|
19 |
|
|
20 |
|
|
21 |
|
|
22 |
|
|
23 |
|
|
24 |
|
|
25 |
|
|
26 |
|
|
27 |
|
|
28 |
|
|
29 |
|
|
30 |
|
|
31 |
|
|
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.Delta; |
45 |
|
import info.magnolia.module.delta.DeltaBuilder; |
46 |
|
import info.magnolia.module.delta.PropertyValueDelegateTask; |
47 |
|
import info.magnolia.module.delta.RemovePermissionTask; |
48 |
|
import info.magnolia.module.delta.RenameNodeTask; |
49 |
|
import info.magnolia.module.delta.SetPropertyTask; |
50 |
|
import info.magnolia.module.delta.Task; |
51 |
|
import info.magnolia.nodebuilder.task.ErrorHandling; |
52 |
|
import info.magnolia.nodebuilder.task.NodeBuilderTask; |
53 |
|
import info.magnolia.repository.RepositoryConstants; |
54 |
|
import info.magnolia.rest.RestDispatcherServlet; |
55 |
|
import info.magnolia.rest.tools.SwaggerRestDispatcherServlet; |
56 |
|
|
57 |
|
import java.util.ArrayList; |
58 |
|
import java.util.List; |
59 |
|
|
60 |
|
import io.swagger.jaxrs.listing.ApiListingResource; |
61 |
|
import io.swagger.jaxrs.listing.SwaggerSerializers; |
62 |
|
|
63 |
|
|
64 |
|
|
65 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (11) |
Complexity: 3 |
Complexity Density: 0.38 |
|
66 |
|
public class RestToolsModuleVersionHandler extends DefaultModuleVersionHandler { |
67 |
|
|
68 |
|
private final static String REST_DISPATCHER_SERVLET_PATH = "/server/filters/servlets/RestDispatcherServlet"; |
69 |
|
private final static String PATH_TO_REST_INTEGRATION_MODULE = "/modules/rest-integration"; |
70 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (2) |
Complexity: 1 |
Complexity Density: 0.5 |
|
71 |
2 |
public RestToolsModuleVersionHandler() {... |
72 |
2 |
super(); |
73 |
|
|
74 |
2 |
register(getDeltaFor1_2_0()); |
75 |
|
} |
76 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (1) |
Complexity: 1 |
Complexity Density: 1 |
|
77 |
2 |
private Delta getDeltaFor1_2_0() {... |
78 |
2 |
return DeltaBuilder.update("1.2.0", "Update to 1.2.0") |
79 |
|
.addTask(new SetPropertyTask("Update apiDeclarationProvider class for new Swagger version", |
80 |
|
RepositoryConstants.CONFIG, PATH_TO_REST_INTEGRATION_MODULE + "/config/additionalProviders/apiDeclarationProvider", "providerClass", ApiListingResource.class.getName())) |
81 |
|
.addTask(new SetPropertyTask("Update resourceListingProvider class for new Swagger version", |
82 |
|
RepositoryConstants.CONFIG, PATH_TO_REST_INTEGRATION_MODULE + "/config/additionalProviders/resourceListingProvider", "providerClass", SwaggerSerializers.class.getName())) |
83 |
|
.addTask(new RenameNodeTask("Rename additional provider node 'apiDeclarationProvider' to 'apiListingResource'", |
84 |
|
RepositoryConstants.CONFIG, PATH_TO_REST_INTEGRATION_MODULE + "/config/additionalProviders", "apiDeclarationProvider", "apiListingResource", true)) |
85 |
|
.addTask(new RenameNodeTask("Rename additional provider node 'resourceListingProvider' to 'swaggerSerializers'", |
86 |
|
RepositoryConstants.CONFIG, PATH_TO_REST_INTEGRATION_MODULE + "/config/additionalProviders", "resourceListingProvider", "swaggerSerializers", true)) |
87 |
|
.addTask(new PropertyValueDelegateTask("Update Swagger API version in configuration", "/modules/rest-tools/config", "apiVersion", "1.0.0", true, |
88 |
|
new SetPropertyTask(RepositoryConstants.CONFIG, "/modules/rest-tools/config", "apiVersion", "1.5.4"))) |
89 |
|
.addTask(new RemovePermissionTask("Remove old swagger doc access in 'rest' role (/.rest/api-docs*)", "rest", "uri", "/.rest/api-docs*", Permission.ALL)) |
90 |
|
.addTask(new AddPermissionTask("Enable swagger doc access in 'rest' role (/.rest/swagger*)", "rest", "uri", "/.rest/swagger*", Permission.ALL, false)) |
91 |
|
.addTask(new SetPropertyTask(RepositoryConstants.CONFIG, "/modules/rest-tools/apps/restTools/subApps/apiDocs", "url", "/.resources/rest-tools/webresources/swagger-ui/index.html")); |
92 |
|
} |
93 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (5) |
Complexity: 1 |
Complexity Density: 0.2 |
|
94 |
1 |
@Override... |
95 |
|
protected List<Task> getExtraInstallTasks(InstallContext installContext) { |
96 |
1 |
List<Task> list = new ArrayList<Task>(); |
97 |
|
|
98 |
1 |
list.add(new CheckAndModifyPropertyValueTask("Replace dispatcher servlet", "Replace default dispatcher servlet with API-aware dispatcher servlet", RepositoryConstants.CONFIG, |
99 |
|
REST_DISPATCHER_SERVLET_PATH, "servletClass", RestDispatcherServlet.class.getName(), SwaggerRestDispatcherServlet.class.getName())); |
100 |
|
|
101 |
|
|
102 |
1 |
list.add(new AddPermissionTask("Update 'rest' role", "Allows access to the REST API documentation interface residing under '/.rest/swagger' in role 'rest'.", "rest", "uri", "/.rest/swagger*", Permission.ALL, false)); |
103 |
|
|
104 |
|
|
105 |
1 |
list.add(new NodeBuilderTask("Add additional providers", "Adds additional providers to rest-integration module config (needed for API documentation)", ErrorHandling.logging, |
106 |
|
RepositoryConstants.CONFIG, PATH_TO_REST_INTEGRATION_MODULE + "/config", |
107 |
|
getNode("additionalProviders").then( |
108 |
|
addNode("apiListingResource", NodeTypes.ContentNode.NAME).then( |
109 |
|
addProperty("providerClass", ApiListingResource.class.getName()) |
110 |
|
), |
111 |
|
addNode("swaggerSerializers", NodeTypes.ContentNode.NAME).then( |
112 |
|
addProperty("providerClass", SwaggerSerializers.class.getName()) |
113 |
|
) |
114 |
|
) |
115 |
|
)); |
116 |
|
|
117 |
1 |
return list; |
118 |
|
} |
119 |
|
|
120 |
|
} |